Invoke ADCAddTmtrafficaction - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCAddTmtrafficaction

SYNOPSIS

Add Traffic Management configuration Object.

SYNTAX

Invoke-ADCAddTmtrafficaction [-Name] <String> [[-Apptimeout] <Double>] [[-Sso] <String>]
 [[-Formssoaction] <String>] [[-Persistentcookie] <String>] [[-Initiatelogout] <String>]
 [[-Kcdaccount] <String>] [[-Samlssoprofile] <String>] [[-Forcedtimeout] <String>]
 [[-Forcedtimeoutval] <Double>] [[-Userexpression] <String>] [[-Passwdexpression] <String>] [-PassThru]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for TM traffic action resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCAddTmtrafficaction -name <string>

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

PARAMETERS

-Name

Name for the traffic action. 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 a traffic action is created.

Type: String
Parameter Sets: (All)
Aliases:

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

-Apptimeout

Time interval, in minutes, of user inactivity after which the connection is closed.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Sso

Use single sign-on for the resource that the user is accessing now. Possible values = ON, OFF

Type: String
Parameter Sets: (All)
Aliases:

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

-Formssoaction

Name of the configured form-based single sign-on profile.

Type: String
Parameter Sets: (All)
Aliases:

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

-Persistentcookie

Use persistent cookies for the traffic session. A persistent cookie remains on the user device and is sent with each HTTP request. The cookie becomes stale if the session ends. Possible values = ON, OFF

Type: String
Parameter Sets: (All)
Aliases:

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

-Initiatelogout

Initiate logout for the traffic management (TM) session if the policy evaluates to true. The session is then terminated after two minutes. Possible values = ON, OFF

Type: String
Parameter Sets: (All)
Aliases:

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

-Kcdaccount

Kerberos constrained delegation account name.

Type: String
Parameter Sets: (All)
Aliases:

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

-Samlssoprofile

Profile to be used for doing SAML SSO to remote relying party.

Type: String
Parameter Sets: (All)
Aliases:

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

-Forcedtimeout

Setting to start, stop or reset TM session force timer. Possible values = START, STOP, RESET

Type: String
Parameter Sets: (All)
Aliases:

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

-Forcedtimeoutval

Time interval, in minutes, for which force timer should be set.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Userexpression

expression that will be evaluated to obtain username for SingleSignOn.

Type: String
Parameter Sets: (All)
Aliases:

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

-Passwdexpression

expression that will be evaluated to obtain password for SingleSignOn.

Type: String
Parameter Sets: (All)
Aliases:

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

-PassThru

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