diff --git a/docs/Add-FGTUserTACACS.md b/docs/Add-FGTUserTACACS.md new file mode 100644 index 000000000..343eb3219 --- /dev/null +++ b/docs/Add-FGTUserTACACS.md @@ -0,0 +1,311 @@ +--- +external help file: PowerFGT-help.xml +Module Name: PowerFGT +online version: +schema: 2.0.0 +--- + +# Add-FGTUserTACACS + +## SYNOPSIS +Add a FortiGate TACACS+ Server + +## SYNTAX + +``` +Add-FGTUserTACACS [-name] [-server] [-key] [[-secondary_server] ] + [[-secondary_key] ] [[-tertiary_server] ] [[-tertiary_key] ] + [[-port] ] [[-authen_type] ] [-authorization] [[-visibility] ] [[-data] ] + [[-vdom] ] [[-connection] ] [-ProgressAction ] [] +``` + +## DESCRIPTION +Add a FortiGate TACACS+ Server + +## EXAMPLES + +### EXAMPLE 1 +``` +$mykey = ConvertTo-SecureString mykey -AsPlainText -Force +PS C:\>Add-FGTUserTACACS -Name PowerFGT -server tacacs.powerfgt -key $mykey +``` + +Add a TACACS+ Server with tacacs.powerfgt as server and key + +### EXAMPLE 2 +``` +$mykey = ConvertTo-SecureString mykey -AsPlainText -Force +PS C:\>Add-FGTUserTACACS -Name PowerFGT -server tacacs.powerfgt -key $mykey -secondary_server tacacs2.powerfgt -secondary_key $mykey -tertiary_server tacacs3.powerfgt -tertiary_key $mykey +``` + +Add a TACACS+ Server with tacacs.powerfgt as server and key, and secondary and tertiary servers + +### EXAMPLE 3 +``` +$mykey = ConvertTo-SecureString mykey -AsPlainText -Force +PS C:\>Add-FGTUserTACACS -Name PowerFGT -server tacacs.powerfgt -key $mykey -port 49 +``` + +Add a TACACS+ Server with tacacs.powerfgt as server and key and port set to 49 + +### EXAMPLE 4 +``` +$mykey = ConvertTo-SecureString mykey -AsPlainText -Force +PS C:\>Add-FGTUserTACACS -Name PowerFGT -server tacacs.powerfgt -key $mykey -authen_type chap +``` + +Add a TACACS+ Server with tacacs.powerfgt as server and key and CHAP as authentication type + +### EXAMPLE 5 +``` +$mykey = ConvertTo-SecureString mykey -AsPlainText -Force +PS C:\>Add-FGTUserTACACS -Name PowerFGT -server tacacs.powerfgt -key $mykey -authen_type auto +``` + +Add a TACACS+ Server with tacacs.powerfgt as server and key and PAP, MSCHAP and CHAP as authentication type in that order + +### EXAMPLE 6 +``` +$mykey = ConvertTo-SecureString mykey -AsPlainText -Force +PS C:\>Add-FGTUserTACACS -Name PowerFGT -server tacacs.powerfgt -key $mykey -authorization +``` + +Add a TACACS+ Server with tacacs.powerfgt as server and key and authorization enable + +## PARAMETERS + +### -name +{{ Fill name Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -server +{{ Fill server Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -key +{{ Fill key Description }} + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -secondary_server +{{ Fill secondary_server Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -secondary_key +{{ Fill secondary_key Description }} + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -tertiary_server +{{ Fill tertiary_server Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -tertiary_key +{{ Fill tertiary_key Description }} + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -port +{{ Fill port Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -authen_type +{{ Fill authen_type Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -authorization +{{ Fill authorization Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -visibility +{{ Fill visibility Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -data +{{ Fill data Description }} + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 11 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -vdom +{{ Fill vdom Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 12 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -connection +{{ Fill connection Description }} + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: 13 +Default value: $DefaultFGTConnection +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Confirm-FGTUserTACACS.md b/docs/Confirm-FGTUserTACACS.md new file mode 100644 index 000000000..214798da4 --- /dev/null +++ b/docs/Confirm-FGTUserTACACS.md @@ -0,0 +1,75 @@ +--- +external help file: PowerFGT-help.xml +Module Name: PowerFGT +online version: +schema: 2.0.0 +--- + +# Confirm-FGTUserTACACS + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Confirm-FGTUserTACACS [-argument] [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -argument +{{ Fill argument Description }} + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/Get-FGTUserTACACS.md b/docs/Get-FGTUserTACACS.md new file mode 100644 index 000000000..e4ea2d931 --- /dev/null +++ b/docs/Get-FGTUserTACACS.md @@ -0,0 +1,221 @@ +--- +external help file: PowerFGT-help.xml +Module Name: PowerFGT +online version: +schema: 2.0.0 +--- + +# Get-FGTUserTACACS + +## SYNOPSIS +Get list of all TACACS servers + +## SYNTAX + +### default (Default) +``` +Get-FGTUserTACACS [-filter_attribute ] [-filter_type ] [-filter_value ] [-meta] + [-skip] [-vdom ] [-connection ] [-ProgressAction ] [] +``` + +### name +``` +Get-FGTUserTACACS [[-name] ] [-filter_attribute ] [-filter_type ] + [-filter_value ] [-meta] [-skip] [-vdom ] [-connection ] + [-ProgressAction ] [] +``` + +### filter +``` +Get-FGTUserTACACS [-filter_attribute ] [-filter_type ] [-filter_value ] [-meta] + [-skip] [-vdom ] [-connection ] [-ProgressAction ] [] +``` + +## DESCRIPTION +Get list of all TACACS servers + +## EXAMPLES + +### EXAMPLE 1 +``` +Get-FGTUserTACACS +``` + +Display all TACACS servers + +### EXAMPLE 2 +``` +Get-FGTUserTACACS -name FGT -filter_type contains +``` + +Get TACACS servers that contains *FGT* + +### EXAMPLE 3 +``` +Get-FGTUserTACACS -meta +``` + +Display all TACACS servers with metadata (q_...) like usage (q_ref) + +### EXAMPLE 4 +``` +Get-FGTUserTACACS -skip +``` + +Display all TACACS servers (but only relevant attributes) + +### EXAMPLE 5 +``` +Get-FGTUserTACACS -vdom vdomX +``` + +Display all TACACS servers on vdomX + +## PARAMETERS + +### -name +{{ Fill name Description }} + +```yaml +Type: String +Parameter Sets: name +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -filter_attribute +{{ Fill filter_attribute Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -filter_type +{{ Fill filter_type Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Equal +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -filter_value +{{ Fill filter_value Description }} + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -meta +{{ Fill meta Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -skip +Ignores the specified number of objects and then gets the remaining objects. +Enter the number of objects to skip. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -vdom +{{ Fill vdom Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -connection +{{ Fill connection Description }} + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: $DefaultFGTConnection +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Remove-FGTUserTACACS.md b/docs/Remove-FGTUserTACACS.md new file mode 100644 index 000000000..2c8527910 --- /dev/null +++ b/docs/Remove-FGTUserTACACS.md @@ -0,0 +1,143 @@ +--- +external help file: PowerFGT-help.xml +Module Name: PowerFGT +online version: +schema: 2.0.0 +--- + +# Remove-FGTUserTACACS + +## SYNOPSIS +Remove a FortiGate TACACS Server + +## SYNTAX + +``` +Remove-FGTUserTACACS [-usertacacs] [-vdom ] [-connection ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Remove a TACACS Server on the FortiGate + +## EXAMPLES + +### EXAMPLE 1 +``` +$MyFGTUserTACACS = Get-FGTUserTACACS -name PowerFGT +PS C:\>$MyFGTUserTACACS | Remove-FGTUserTACACS +``` + +Remove user object $MyFGTUserTACACS + +### EXAMPLE 2 +``` +$MyFGTUserTACACS = Get-FGTUserTACACS -name MyFGTUserTACACS +PS C:\>$MyFGTUserTACACS | Remove-FGTUserTACACS -confirm:$false +``` + +Remove UserTACACS object $MyFGTUserTACACS with no confirmation + +## PARAMETERS + +### -usertacacs +{{ Fill usertacacs Description }} + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -vdom +{{ Fill vdom Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -connection +{{ Fill connection Description }} + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: $DefaultFGTConnection +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Set-FGTUserTACACS.md b/docs/Set-FGTUserTACACS.md new file mode 100644 index 000000000..a1bc210ea --- /dev/null +++ b/docs/Set-FGTUserTACACS.md @@ -0,0 +1,338 @@ +--- +external help file: PowerFGT-help.xml +Module Name: PowerFGT +online version: +schema: 2.0.0 +--- + +# Set-FGTUserTACACS + +## SYNOPSIS +Change a FortiGate TACACS Server + +## SYNTAX + +``` +Set-FGTUserTACACS [-usertacacs] [-name ] [-server ] [-key ] + [-secondary_server ] [-secondary_key ] [-tertiary_server ] + [-tertiary_key ] [-port ] [-authen_type ] [-authorization ] + [-data ] [-vdom ] [-connection ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +Change a FortiGate TACACS Server + +## EXAMPLES + +### EXAMPLE 1 +``` +$MyFGTUserTACACS = Get-FGTUserTACACS -name MyFGTUserTACACS +PS C:\>$MyFGTUserTACACS | Set-FGTUserTACACS -server mynewTACACSserver +``` + +Change server name from MyFGTUserTACACS to mynewTACACSserver + +### EXAMPLE 2 +``` +$MyFGTUserTACACS = Get-FGTUserTACACS -name MyFGTUserTACACS +PS C:\>$mykey = ConvertTo-SecureString mykey -AsPlainText -Force +PS C:\>$MyFGTUserTACACS | Set-FGTUserTACACS -secondary_server tacacs2.powerfgt -secondary_key $mykey +``` + +Change secondary server and key + +### EXAMPLE 3 +``` +$MyFGTUserTACACS = Get-FGTUserTACACS -name MyFGTUserTACACS +PS C:\>$mykey = ConvertTo-SecureString mykey -AsPlainText -Force +PS C:\>$MyFGTUserTACACS | Set-FGTUserTACACS -tertiary_server tacacs3.powerfgt -tertiary_key $mykey +``` + +Change tertiary server and key + +### EXAMPLE 4 +``` +$MyFGTUserTACACS = Get-FGTUserTACACS -name MyFGTUserTACACS +PS C:\>$MyFGTUserTACACS | Set-FGTUserTACACS -authorization disable +``` + +Change authorization to disable + +### EXAMPLE 5 +``` +$data = @{ "port" = "10049" } +PS C:\>$MyFGTUserTACACS = Get-FGTUserTACACS -name MyFGTUserTACACS +PS C:\>$MyFGTUserTACACS | Set-FGTUserTACACS -data $data +``` + +Change port to 10049 + +## PARAMETERS + +### -usertacacs +{{ Fill usertacacs Description }} + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -name +{{ Fill name Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -server +{{ Fill server Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -key +{{ Fill key Description }} + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -secondary_server +{{ Fill secondary_server Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -secondary_key +{{ Fill secondary_key Description }} + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -tertiary_server +{{ Fill tertiary_server Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -tertiary_key +{{ Fill tertiary_key Description }} + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -port +{{ Fill port Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -authen_type +{{ Fill authen_type Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -authorization +{{ Fill authorization Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -data +{{ Fill data Description }} + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -vdom +{{ Fill vdom Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -connection +{{ Fill connection Description }} + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: $DefaultFGTConnection +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS