Invoke ADCUpdateVpnformssoaction - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCUpdateVpnformssoaction

SYNOPSIS

Update SSL VPN configuration Object.

SYNTAX

Invoke-ADCUpdateVpnformssoaction [-Name] <String> [[-Actionurl] <String>] [[-Userfield] <String>]
 [[-Passwdfield] <String>] [[-Ssosuccessrule] <String>] [[-Responsesize] <Double>] [[-Namevaluepair] <String>]
 [[-Nvtype] <String>] [[-Submitmethod] <String>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for Form sso action resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCUpdateVpnformssoaction -name <string>

An example how to update vpnformssoaction configuration Object(s).

PARAMETERS

-Name

Name for the form based single sign-on profile.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Actionurl

Root-relative URL to which the completed form is submitted.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Userfield

Name of the form field in which the user types in the user ID.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Passwdfield

Name of the form field in which the user types in the password.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Ssosuccessrule

Expression that defines the criteria for SSO success. Expression such as checking for cookie in the response is a common example.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Responsesize

Maximum number of bytes to allow in the response size. Specifies the number of bytes in the response to be parsed for extracting the forms.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Namevaluepair

Other name-value pair attributes to send to the server, in addition to sending the user name and password. Value names are separated by an ampersand (;), such as in name1=value1;name2=value2.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Nvtype

How to process the name-value pair. Available settings function as follows:

  • STATIC - The administrator-configured values are used.
  • DYNAMIC - The response is parsed, the form is extracted, and then submitted. Possible values = STATIC, DYNAMIC
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Submitmethod

HTTP method (GET or POST) used by the single sign-on form to send the logon credentials to the logon server. Possible values = GET, POST

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

Return details about the created vpnformssoaction item.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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.

INPUTS

OUTPUTS

NOTES

File Name : Invoke-ADCUpdateVpnformssoaction Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/vpn/vpnformssoaction/ Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.

RELATED LINKS

https://blog.j81.nl

⚠️ **GitHub.com Fallback** ⚠️