Invoke ADCAddTmformssoaction - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCAddTmformssoaction

SYNOPSIS

Add Traffic Management configuration Object.

SYNTAX

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

DESCRIPTION

Configuration for Form sso action resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCAddTmformssoaction -name <string> -actionurl <string> -userfield <string> -passwdfield <string> -ssosuccessrule <string>

An example how to add tmformssoaction configuration Object(s).

PARAMETERS

-Name

Name for the new form-based single sign-on profile. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after an SSO action is created.

Type: String
Parameter Sets: (All)
Aliases:

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

-Actionurl

URL to which the completed form is submitted.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
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: True
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: True
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Ssosuccessrule

Expression, that checks to see if single sign-on is successful.

Type: String
Parameter Sets: (All)
Aliases:

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

-Namevaluepair

Name-value pair attributes to send to the server in addition to sending the username and password. Value names are separated by an ampersand (;) (for example, name1=value1;name2=value2).

Type: String
Parameter Sets: (All)
Aliases:

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

-Responsesize

Number of bytes, in the response, to parse for extracting the forms.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Nvtype

Type of processing of the name-value pair. If you specify STATIC, the values configured by the administrator are used. For DYNAMIC, the response is parsed, and the form is extracted and then submitted. Possible values = STATIC, DYNAMIC

Type: String
Parameter Sets: (All)
Aliases:

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

-Submitmethod

HTTP method used by the single sign-on form to send the logon credentials to the logon server. Applies only to STATIC name-value type. Possible values = GET, POST

Type: String
Parameter Sets: (All)
Aliases:

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

-PassThru

Return details about the created tmformssoaction 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-ADCAddTmformssoaction Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/tm/tmformssoaction/ 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** ⚠️