Invoke-ADCUpdateNsparam

SYNOPSIS

Update NS configuration Object.

SYNTAX

Invoke-ADCUpdateNsparam [[-Httpport] <Int32[]>] [[-Maxconn] <Double>] [[-Maxreq] <Double>] [[-Cip] <String>]
 [[-Cipheader] <String>] [[-Cookieversion] <String>] [[-Securecookie] <String>] [[-Pmtumin] <Double>]
 [[-Pmtutimeout] <Double>] [[-Ftpportrange] <String>] [[-Crportrange] <String>] [[-Timezone] <String>]
 [[-Grantquotamaxclient] <Double>] [[-Exclusivequotamaxclient] <Double>] [[-Grantquotaspillover] <Double>]
 [[-Exclusivequotaspillover] <Double>] [[-Useproxyport] <String>] [[-Internaluserlogin] <String>]
 [[-Aftpallowrandomsourceport] <String>] [[-Icaports] <Int32[]>] [[-Tcpcip] <String>]
 [[-Servicepathingressvlan] <Double>] [[-Secureicaports] <Int32[]>] [[-Mgmthttpport] <Int32>]
 [[-Mgmthttpsport] <Int32>] [[-Proxyprotocol] <String>] [[-Advancedanalyticsstats] <String>]
 [[-Ipttl] <Double>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for Citrix ADC parameters resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCUpdateNsparam

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

PARAMETERS

-Httpport

HTTP ports on the web server. This allows the system to perform connection off-load for any client request that has a destination port matching one of these configured ports.

Type: Int32[]
Parameter Sets: (All)
Aliases:

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

-Maxconn

Maximum number of connections that will be made from the appliance to the web server(s) attached to it. The value entered here is applied globally to all attached servers.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Maxreq

Maximum number of requests that the system can pass on a particular connection between the appliance and a server attached to it. Setting this value to 0 allows an unlimited number of requests to be passed. This value is overridden by the maximum number of requests configured on the individual service.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Cip

Enable or disable the insertion of the actual client IP address into the HTTP header request passed from the client to one, some, or all servers attached to the system. The passed address can then be accessed through a minor modification to the server.

If the CIP header is specified, it will be used as the client IP header.
If the CIP header is not specified, the value that has been set will be used as the client IP header. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Cipheader

Text that will be used as the client IP address header.

Type: String
Parameter Sets: (All)
Aliases:

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

-Cookieversion

Version of the cookie inserted by the system. Possible values = 0, 1

Type: String
Parameter Sets: (All)
Aliases:

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

-Securecookie

Enable or disable secure flag for persistence cookie. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Pmtumin

Minimum path MTU value that Citrix ADC will process in the ICMP fragmentation needed message. If the ICMP message contains a value less than this value, then this value is used instead.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Pmtutimeout

Interval, in minutes, for flushing the PMTU entries.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Ftpportrange

Minimum and maximum port (port range) that FTP services are allowed to use.

Type: String
Parameter Sets: (All)
Aliases:

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

-Crportrange

Port range for cache redirection services.

Type: String
Parameter Sets: (All)
Aliases:

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

-Timezone

Time zone for the Citrix ADC. Name of the time zone should be specified as argument.

Type: String
Parameter Sets: (All)
Aliases:

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

-Grantquotamaxclient

Percentage of shared quota to be granted at a time for maxClient.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Exclusivequotamaxclient

Percentage of maxClient to be given to PEs.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Grantquotaspillover

Percentage of shared quota to be granted at a time for spillover.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Exclusivequotaspillover

Percentage of maximum limit to be given to PEs.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Useproxyport

Enable/Disable use_proxy_port setting. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Internaluserlogin

Enables/disables the internal user from logging in to the appliance. Before disabling internal user login, you must have key-based authentication set up on the appliance. The file name for the key pair must be "ns_comm_key". Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Aftpallowrandomsourceport

Allow the FTP server to come from a random source port for active FTP data connections. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Icaports

The ICA ports on the Web server. This allows the system to perform connection off-load for any client request that has a destination port matching one of these configured ports.

Type: Int32[]
Parameter Sets: (All)
Aliases:

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

-Tcpcip

Enable or disable the insertion of the client TCP/IP header in TCP payload passed from the client to one, some, or all servers attached to the system. The passed address can then be accessed through a minor modification to the server. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Servicepathingressvlan

VLAN on which the subscriber traffic arrives on the appliance.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Secureicaports

The Secure ICA ports on the Web server. This allows the system to perform connection off-load for any client request that has a destination port matching one of these configured ports.

Type: Int32[]
Parameter Sets: (All)
Aliases:

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

-Mgmthttpport

This allow the configuration of management HTTP port.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Mgmthttpsport

This allows the configuration of management HTTPS port.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Proxyprotocol

Disable/Enable v1 or v2 proxy protocol header for client info insertion. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Advancedanalyticsstats

Disable/Enable advanace analytics stats. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Ipttl

Set the IP Time to Live (TTL) and Hop Limit value for all outgoing packets from Citrix ADC.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 29
Default value: 0
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-ADCUpdateNsparam Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/ns/nsparam/ Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.