From 08cd97537f57ef20d35099cef751f4143897a0b6 Mon Sep 17 00:00:00 2001 From: FortiPower GitHub Actions Bot <> Date: Tue, 17 Sep 2024 03:06:03 +0000 Subject: [PATCH] Update doc via platyPS and GitHub Actions --- docs/Add-FGTUserRADIUS.md | 319 +++++++++++++++++++++++++++++++ docs/Confirm-FGTUserRADIUS.md | 75 ++++++++ docs/Remove-FGTUserRADIUS.md | 143 ++++++++++++++ docs/Set-FGTUserRADIUS.md | 345 ++++++++++++++++++++++++++++++++++ 4 files changed, 882 insertions(+) create mode 100644 docs/Add-FGTUserRADIUS.md create mode 100644 docs/Confirm-FGTUserRADIUS.md create mode 100644 docs/Remove-FGTUserRADIUS.md create mode 100644 docs/Set-FGTUserRADIUS.md diff --git a/docs/Add-FGTUserRADIUS.md b/docs/Add-FGTUserRADIUS.md new file mode 100644 index 000000000..d8edf1ae0 --- /dev/null +++ b/docs/Add-FGTUserRADIUS.md @@ -0,0 +1,319 @@ +--- +external help file: PowerFGT-help.xml +Module Name: PowerFGT +online version: +schema: 2.0.0 +--- + +# Add-FGTUserRADIUS + +## SYNOPSIS +Add a FortiGate RADIUS Server + +## SYNTAX + +``` +Add-FGTUserRADIUS [-name] [-server] [-secret] [[-secondary_server] ] + [[-secondary_secret] ] [[-tertiary_server] ] [[-tertiary_secret] ] + [[-timeout] ] [[-nas_ip] ] [[-auth_type] ] [[-nas_id] ] [[-data] ] + [[-vdom] ] [[-connection] ] [-ProgressAction ] [] +``` + +## DESCRIPTION +Add a FortiGate RADIUS Server + +## EXAMPLES + +### EXAMPLE 1 +``` +$mysecret = ConvertTo-SecureString mysecret -AsPlainText -Force +PS C:\>Add-FGTUserRADIUS -Name PowerFGT -server radius.powerfgt -secret $mysecret +``` + +Add a RADIUS Server with radius.powerfgt as server and secret + +### EXAMPLE 2 +``` +$mysecret = ConvertTo-SecureString mysecret -AsPlainText -Force +PS C:\>Add-FGTUserRADIUS -Name PowerFGT -server radius.powerfgt -secret $mysecret -secondary_server radius2.powerfgt -secondary_secret $mysecret -tertiary_server radius3.powerfgt -tertiary_secret $mysecret +``` + +Add a RADIUS Server with radius.powerfgt as server and secret, and secondary and tertiary servers + +### EXAMPLE 3 +``` +$mysecret = ConvertTo-SecureString mysecret -AsPlainText -Force +PS C:\>Add-FGTUserRADIUS -Name PowerFGT -server radius.powerfgt -secret $mysecret -timeout 5 +``` + +Add a RADIUS Server with radius.powerfgt as server and secret and timeout to 5 seconds + +### EXAMPLE 4 +``` +$mysecret = ConvertTo-SecureString mysecret -AsPlainText -Force +PS C:\>Add-FGTUserRADIUS -Name PowerFGT -server radius.powerfgt -secret $mysecret -nas_ip 192.0.2.1 +``` + +Add a RADIUS Server with radius.powerfgt as server and secret and NAS IP as 192.0.2.1 + +### EXAMPLE 5 +``` +$mysecret = ConvertTo-SecureString mysecret -AsPlainText -Force +PS C:\>Add-FGTUserRADIUS -Name PowerFGT -server radius.powerfgt -secret $mysecret -nas_id PowerFGT_RADIUS +``` + +Add a RADIUS Server with radius.powerfgt as server and secret and NAS ID as PowerFGT_RADIUS + +### EXAMPLE 6 +``` +$mysecret = ConvertTo-SecureString mysecret -AsPlainText -Force +PS C:\>Add-FGTUserRADIUS -Name PowerFGT -server radius.powerfgt -secret $mysecret -auth_type ms_chap_v2 +``` + +Add a RADIUS Server with radius.powerfgt as server and secret and auth_type as ms_chap_v2 + +### EXAMPLE 7 +``` +$data = @{ "password-renewal" = "enable" } +PS C:\>Add-FGTUserRADIUS -Name PowerFGT -server radius.powerfgt -secret $mysecret -data $data +``` + +Add a RADIUS Server with radius.powerfgt as server and secret and password renewal enabled + +## 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 +``` + +### -secret +{{ Fill secret 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_secret +{{ Fill secondary_secret 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_secret +{{ Fill tertiary_secret Description }} + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -timeout +{{ Fill timeout Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -nas_ip +{{ Fill nas_ip Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -auth_type +{{ Fill auth_type Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -nas_id +{{ Fill nas_id Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 11 +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: 12 +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: 13 +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: 14 +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-FGTUserRADIUS.md b/docs/Confirm-FGTUserRADIUS.md new file mode 100644 index 000000000..442b2b70e --- /dev/null +++ b/docs/Confirm-FGTUserRADIUS.md @@ -0,0 +1,75 @@ +--- +external help file: PowerFGT-help.xml +Module Name: PowerFGT +online version: +schema: 2.0.0 +--- + +# Confirm-FGTUserRADIUS + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Confirm-FGTUserRADIUS [-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/Remove-FGTUserRADIUS.md b/docs/Remove-FGTUserRADIUS.md new file mode 100644 index 000000000..8a890aa1b --- /dev/null +++ b/docs/Remove-FGTUserRADIUS.md @@ -0,0 +1,143 @@ +--- +external help file: PowerFGT-help.xml +Module Name: PowerFGT +online version: +schema: 2.0.0 +--- + +# Remove-FGTUserRADIUS + +## SYNOPSIS +Remove a FortiGate RADIUS Server + +## SYNTAX + +``` +Remove-FGTUserRADIUS [-userradius] [-vdom ] [-connection ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Remove a RADIUS Server on the FortiGate + +## EXAMPLES + +### EXAMPLE 1 +``` +$MyFGTUserRADIUS = Get-FGTUserRADIUS -name PowerFGT +PS C:\>$MyFGTUserRADIUS | Remove-FGTUserRADIUS +``` + +Remove user object $MyFGTUserRADIUS + +### EXAMPLE 2 +``` +$MyFGTUserRADIUS = Get-FGTUserRADIUS -name MyFGTUserRADIUS +PS C:\>$MyFGTUserRADIUS | Remove-FGTUserRADIUS -confirm:$false +``` + +Remove UserRADIUS object $MyFGTUserRADIUS with no confirmation + +## PARAMETERS + +### -userradius +{{ Fill userradius 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-FGTUserRADIUS.md b/docs/Set-FGTUserRADIUS.md new file mode 100644 index 000000000..b070793a3 --- /dev/null +++ b/docs/Set-FGTUserRADIUS.md @@ -0,0 +1,345 @@ +--- +external help file: PowerFGT-help.xml +Module Name: PowerFGT +online version: +schema: 2.0.0 +--- + +# Set-FGTUserRADIUS + +## SYNOPSIS +Change a FortiGate RADIUS Server + +## SYNTAX + +``` +Set-FGTUserRADIUS [-userradius] [-name ] [-server ] [-secret ] + [-secondary_server ] [-secondary_secret ] [-tertiary_server ] + [-tertiary_secret ] [-timeout ] [-nas_ip ] [-auth_type ] + [-nas_id ] [-data ] [-vdom ] [-connection ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Change a FortiGate RADIUS Server + +## EXAMPLES + +### EXAMPLE 1 +``` +$MyFGTUserRADIUS = Get-FGTUserRADIUS -name MyFGTUserRADIUS +PS C:\>$MyFGTUserRADIUS | Set-FGTUserRADIUS -server mynewRADIUSserver +``` + +Change server name from MyFGTUserRADIUS to mynewRADIUSserver + +### EXAMPLE 2 +``` +$MyFGTUserRADIUS = Get-FGTUserRADIUS -name MyFGTUserRADIUS +PS C:\>$mysecret = ConvertTo-SecureString mysecret -AsPlainText -Force +PS C:\>$MyFGTUserRADIUS | Set-FGTUserRADIUS -secondary_server radius2.powerfgt -secondary_secret $mysecret +``` + +Change secondary server and secret + +### EXAMPLE 3 +``` +$MyFGTUserRADIUS = Get-FGTUserRADIUS -name MyFGTUserRADIUS +PS C:\>$mysecret = ConvertTo-SecureString mysecret -AsPlainText -Force +PS C:\>$MyFGTUserRADIUS | Set-FGTUserRADIUS -tertiary_server radius2.powerfgt -tertiary_secret $mysecret +``` + +Change tertiary server and secret + +### EXAMPLE 4 +``` +$data = @{ "timeout" = "200" } +PS C:\>$MyFGTUserRADIUS = Get-FGTUserRADIUS -name MyFGTUserRADIUS +PS C:\>$MyFGTUserRADIUS | Set-FGTUserRADIUS -data $data +``` + +Change timeout to 200sec + +## PARAMETERS + +### -userradius +{{ Fill userradius 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 +``` + +### -secret +{{ Fill secret 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_secret +{{ Fill secondary_secret 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_secret +{{ Fill tertiary_secret Description }} + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -timeout +{{ Fill timeout Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -nas_ip +{{ Fill nas_ip Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -auth_type +{{ Fill auth_type Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -nas_id +{{ Fill nas_id 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