Home > Configuration > NS

Use this method to adds an extended ACL rule to the Citrix ADC. To commit this operation, you must apply the extended ACLs. Extended ACL rules filter data packets on the basis of various parameters, such as IP address, source port, action, and protocol.

Use this method to adds an ACL6 rule to the Citrix ADC. To commit this operation, you must apply the ACL6s. ACL6 rules filter data packets on the basis of various parameters, such as IP address, source port, action, and protocol.

Use this method to add a new AppFlow collector.
NOTE: This method is deprecated.
This method is deprecated in favor of 'add appflow collector'

Use this method to creates an assignment of a value to a variable. The variable (the left hand side) may be a singleton variable or a map with a key expression. The value (the right hand side) is computed from an expression and may be used to set the variable or may be added to or subtracted from the current value of a ulong variable or appended to a text variable. The key expression, if present, is evaluated before the value expression. The left hand side variable value may also be cleared, in which case there is no value expression.

Use this method to adds a centralmgmtserver server profile and verifies the configuration to ensure that it is correct. Also registers the device on the central management server.

Use this method to create a key to be used in ENCRYPT() and DECRYPT() policy functions.

Use this method to add the specified extension object.

Use this method to create a key to be used in HMAC() policy functions.

Use this method to adds an HTTP profile to the Citrix ADC.

Use this method to adds an ICAP profile to the Citrix ADC.

Use this method to creates an IPv4 address on the Citrix ADC.

Use this method to creates an IPv6 address on the Citrix ADC.

Use this method to adds Key Manager proxy server config to the appliance.

Use this method to adds License proxy server config to the appliance.

Use this method to adds License server config to the appliance.

Use this method to adds a limit identifier to check if the amount of traffic exceeds a specified value, within a particular time interval.

NOTE: This method is deprecated.
Replaced by "stream selector"

Use this method to creates a new admin partition

Use this method to adds a policy based route (PBR) to the Citrix ADC. To commit this operation, you must apply the PBRs.
A PBR specifies criteria for selecting outgoing IPv4 packets and, typically, a next hop to which to send the selected packets. For example, you can configure the Citrix ADC to route outgoing packets from a specific IP address or range to a particular next hop router.

Note: The Citrix ADC process PBRs before processing the RNAT rules.

Use this method to adds an IPv6 policy based route (PBR6) to the Citrix ADC. To commit this operation, you must apply the PBR6s.
A PBR6 specifies criteria for selecting outgoing IPv6 packets and, typically, a next hop to which to send the selected packets. For example, you can configure the Citrix ADC to route outgoing packets from a specific IP address or range to a particular next hop router.

Note: The Citrix ADC process PBR6s before processing the RNAT rules.

Use this method to add a service function.

Use this method to creates a Servicepath.

Use this method to adds a simple ACL rule to the Citrix ADC. Simple ACL rules filter IPv4 packets on the basis of their source IP addresses and, optionally, the destination port and/or protocol. Any packet with the characteristics specified in the simple ACL rule is dropped.

Use this method to adds a simple ACL6 rule to the Citrix ADC. Simple ACL6 rules filter IPv6 packets on the basis of their source IP addresses and, optionally, the destination port and/or protocol. Any packet with the characteristics specified in the simple ACL6 rule is dropped.

Use this method to adds a TCP profile to the Citrix ADC.

Use this method to create a Timer.

Use this method to configure Traffic Domain on the system.

Use this method to create a variable for use in assignments and expressions.

Use this method to adds a mapping between an XML prefix and a namespace URI (Uniform Resource Identifier).

Use this method to updates the extended ACL rule's memory tree (lookup table), adding any new extended ACL rules and applying any modifications to existing ACL rules. The lookup table includes the configuration of all the extended ACL rules on the Citrix ADC. The Citrix ADC appliance uses the lookup table (not the configuration file) to filter the incoming IPv4 packets.

Use this method to updates the ACL6 rules' memory tree (lookup table), adding any new ACL6 rules and applying any modifications to existing ACL rules. The lookup table includes the configuration of all the ACL6 rules on the Citrix ADC. The Citrix ADC appliance uses the lookup table (not the configuration file) to filter the incoming IPv4 packets.

Use this method to apply laslicense
Use this method to apply las license available at a path.

Use this method to updates the PBR6's memory tree (lookup table), adding any new PBR6 and applying any modifications to the existing PBR6s. The lookup table includes the configuration of all the extended PBR6s on the Citrix ADC. The Citrix ADC appliance uses the lookup table (not the configuration file) to filter the outgoing IPv6 packets.

Use this method to updates the PBR's memory tree (lookup table), adding any new PBR and applying any modifications to existing PBRs. The lookup table includes the configuration of all the extended PBRs on the Citrix ADC. The Citrix ADC appliance uses the lookup table (not the configuration file) to filter the outgoing IPv4 packets.

Use this method to apply test license
Use this method to apply license(s) tested using "show ns testlicense" method.

Use this method to bind bridgegroup to ns partition.

Use this method to bind vlan to ns partition.

Use this method to bind vxlan to ns partition.

Use this method to bind servicefunction to ns servicePath.

Use this method to bind policy to ns timer.

Use this method to bind bridgegroup to ns trafficDomain.

Use this method to bind vlan to ns trafficDomain.

Use this method to removes all simple ACL rules from the Citrix ADC. This operation does not require an explicit apply.

Use this method to removes all simple ACL6 rules from the Citrix ADC. This operation does not require an explicit apply.

Use this method to clears the Citrix ADC running configurations based on different levels.

Use this method to clears the rate limit sessions available on the appliance.

Use this method to clear all config for NextGen API

Use this method to removes all PBR6s from the Citrix ADC. This operation does not require an explicit apply.

Use this method to removes all PBRs from the Citrix ADC. This operation does not require an explicit apply.

Use this method to removes all simple ACL rules from the Citrix ADC.

Use this method to removes all simple ACL6 rules from the Citrix ADC.

Use this method to remove Traffic Domain configuration.
NOTE: This method is deprecated.
This is deprecated as it is similar to rm traffidomain

Use this method to force complete the Migration Operation, with cleanup of current active 'migrated connection'

Use this method to converts CLI methods specified in a config file into NITRO object Graph.

Use this method to difference between two configuration

Use this method to disables an extended ACL rule. To commit this operation, you must apply the extended ACLs. After you apply the ACL rules, the Citrix ADC does not compare incoming packets against the disabled extended ACL rules.

Use this method to disables an ACL6 rule. To commit this operation, you must apply the ACL6s.After you apply the ACL6 rules, the Citrix ADC does not compare incoming IPv6 packets to the disabled ACL6 rules.

Use this method to disables Citrix ADC feature(s).

Use this method to disables the specified VIP address configured on the Citrix ADC.

Use this method to disables Citrix ADC mode(s).

Use this method to disables NextGen API

Use this method to disables a PBR. To commit this operation, you must apply the PBRs. After you apply the PBRs, the Citrix ADC does not compare outgoing packets against the disabled PBRs

Use this method to disables a PBR6. To commit this operation, you must apply the PBR6s.After you apply the PBR6s, the Citrix ADC does not compare outgoing packets to the disabled PBR6s.

Use this method to disable TrafficDomain.

Use this method to enables an extended ACL rule. To commit this operation, you must apply the extended ACLs. After you apply the extended ACL rules, the Citrix ADC compares incoming packets against the enabled extended ACL rules.

Use this method to enables an ACL6 rule. To commit this operation, you must apply the ACL6s.After you apply the ACL6 rules, the Citrix ADC compares incoming IPv6 packets to the enabled ACL6 rules.

Use this method to enables Citrix ADC feature(s).

Use this method to enables the specified VIP address configured on the Citrix ADC.

Use this method to enables Citrix ADC mode(s).

Use this method to enables NextGen API

Use this method to enables a PBR. To commit this operation, you must apply the PBRs. After you apply the PBRs, the Citrix ADC compares outgoing packets to the enabled PBRs.

Use this method to enables a PBR6. To commit this operation, you must apply the PBR6s.After you apply the PBR6s, the Citrix ADC compares outgoing packets to the enabled PBR6.

Use this method to enable TrafficDomain.

Use this method to terminates all established IPv4 connections that match any of the newly configured simple ACL rules.

Note: If you plan to create more than one simple ACL rule and flush existing connections that match any of them, you can minimize the affect on performance by first creating all of the simple ACL rules and then running flush only once.

Use this method to terminates all established IPv6 connections that match any of the newly configured simple ACL6 rules.

Note: If you plan to create more than one simple ACL6 rule and flush existing connections that match any of them, you can minimize the affect on performance by first creating all of the simple ACL6 rules and then running flush only once.

Use this method to flushes the current Source route cache table.

Use this method to flushes the connections that are waiting in SurgeQ. SurgeQ contains the client connections waiting for a server connection.

Use this method to get settings related to the extended ACL rules. To display settings of all the extended ACL rules, run the method without any parameters. To display settings of a particular extended ACL rule, specify the name of the extended ACL rule.

Use this method to get settings related to the ACL6 rules. To display settings of all the ACL6 rules, run the method without any parameters. To display settings of a particular ACL6 rule, specify the name of the ACL6 rule.

Use this method to get details of all the AppFlow collectors configured on the system. Alternatively, to view the details of a particular AppFlow collector, specify its name.
NOTE: This method is deprecated.
This method is deprecated in favor of 'show appflow collector'

Use this method to get AppFlow parameters.
NOTE: This method is deprecated.
This method is deprecated in favor of 'show appflow param'

Use this method to get configured assignements.

Use this method to get the running capacity of the system.

Use this method to get the current configuration of a central management server profile.

Use this method to get VF autorecover mode

Use this method to get the following details of the Citrix ADC:

Use this method to get configview setting for the client

Use this method to get the current TCP/IP connection table.

Use this method to get the values configured for CQA on the appliance.

Use this method to get the parameters configured for the DHCP client.

Use this method to get the diameter parameters configured on the Citrix ADC.

Use this method to get configured encryption keys

Use this method to get the encryption method configured on the Citrix ADC.

Use this method to get events that occur on the appliance.

Use this method to get the specified extension object.

Use this method to get the current state of Citrix ADC features.

Use this method to get details of the appliance hardware and information such as the host ID and the serial number.

Use this method to get configured HMAC keys

Use this method to get the host name of the system.

Use this method to get the HTTP parameters configured on the Citrix ADC.

Use this method to get information about HTTP profiles configured on the appliance.

Use this method to get ICAP profile/s configured on Citrix ADC

Use this method to get the global setting of pcb/natpcb idletimeout.
NOTE: This method is deprecated.
This method is deprecated in favour of 'set ns timeout'

Use this method to get settings of all the IPv4 addresses or of the specified IPv4 address configured on the Citrix ADC. To display settings of all the IPv4 addresses, run the method without any parameters. To display settings of a particular IPv4 address, specify the IPv4 address.

Use this method to get settings of all the IPv6 addresses or of the specified IPv6 address configured on the Citrix ADC. To display settings of all the IPv6 addresses, run the method without any parameters. To display settings of a particular IPv6 address, specify the IPv6 address.

Use this method to get the Job Details.

Use this method to get information about an Key Manager proxy server. You can specify the server by IP address or by name.

Use this method to get laslicense

Use this method to get the state of all the licensed features.

Use this method to get license activation data

Use this method to get information about the license parameters.

Use this method to get information about an License proxy server. You can specify the server by IP address or by name.

Use this method to get information about an License server. You can specify the server by IP address or by name.

Use this method to get details of the appliance pooled license inventory.

Use this method to get information about a rate limit identifier.

NOTE: This method is deprecated.
Replaced by "stream selector"

Use this method to get the rate limit sessions available on the appliance.

Use this method to get the information of the parameters that were set by using the 'set mgmtparam' method.

Use this method to get the status of ISSU migration for the current node

Use this method to get the current state of Citrix ADC modes.

Use this method to get the NextGen API parameters.

Use this method to get the saved configurations.

Use this method to get the information of the parameters of the Citrix ADC that were set by using the 'set ns param' method.

Use this method to get all the partitions configured

Use this method to get all configured MACs for partitions

Use this method to get settings related to the PBRs. To display settings of all the PBRs, run the method without any parameters. To display settings of a particular PBR, specify the name of the PBR.

Use this method to get settings related to the PBR6s. To display settings of all the PBR6s, run the method without any parameters. To display settings of a particular PBR6, specify the name of the PBR6.

Use this method to get the values configured for rate control on the appliance.

Use this method to get the method(s) that can be used to roll back the method(s) that are specified in an input file.

Use this method to get a list of nodes currently communicating by using Remote Procedure Calls (RPC).

Use this method to get the saved configurations.

Use this method to get specified service function.

Use this method to get ServicePath.

Use this method to get settings of all the simple ACL rules or of the specified simple ACL rule. To display settings of all the simple ACL rules, run the method without any parameters. To display settings of a particular simple ACL rule, specify the name of the simple ACL rule.

Use this method to get settings of all the simple ACL6 rules or of the specified simple ACL6 rule. To display settings of all the simple ACL6 rules, run the method without any parameters. To display settings of a particular simple ACL6 rule, specify the name of the simple ACL6 rule.

Use this method to get the current source route cache table.

Use this method to get the surge protection configuration on the appliance. Surge protection parameters are set by using the 'set ns spParams' method.

Use this method to get the TCP buffering configuration on the appliance.

Use this method to get the TCP parameters configured on the Citrix ADC.

Use this method to get information about TCP profiles configured on the appliance.

Use this method to get the state of test license features.

Use this method to get the timeouts configured for various Citrix ADC entities.

Use this method to get the Timer entities.

Use this method to get all the available timezone option

Use this method to get Traffic Domain configuration.

Use this method to get configured variables

Use this method to get the runtime values stores in the global scope variable.

Use this method to get the version and build number of the appliance.

Use this method to get the vpx configuration setting for the vpx.

Use this method to get the Weblog parameters.

Use this method to get the mappings between XML prefixes to namespace URIs.

Use this method to imports the specified extension to the Citrix ADC, assigns it the specified name, and stores it in the list of extension objects.

Use this method to queries NS config

Use this method to restarts the Citrix ADC.
Note:
* When a standalone Citrix ADC is rebooted, the unsaved configurations (configurations performed since the last 'save ns config' method was issued) are lost.
* In the high availability mode, when the primary appliance is rebooted, the secondary system takes over and becomes the primary. The unsaved configurations from the old primary are available on the new primary appliance.
* In a cluster setup, this method can be executed only through the cluster IP address and it reboots only the configuration coordinator.

Use this method to releases the IP address acquired by the DHCP client.

Use this method to renames an extended ACL rule.

Use this method to renames an ACL6 rule. To commit this operation, you must apply the ACL6s.

Use this method to renames an assignment.

Use this method to rename a timer.

Use this method to renumbers the priorities of extended ACL rules to multiples of 10. To commit this operation, you must apply the extended ACLs.
Enables you to assign a new extended ACL rule a priority that is between two existing, consecutively numbered priorities. For example, if two extended ACLs, ACL1 and ACL2, have priorities 2 and 3 renumbering changes those priorities to 20 and 30. You can then add ACL3 with priority 25.

Use this method to renumbers the priorities of ACL6 rules to multiples of 10. To commit this operation, you must apply the ACL6s.
Enables you to assign a new ACL6 rule a priority that is between two existing, consecutively numbered priorities. For example, if two ACL6s, ACL6-1 and ACL6-2, have priorities 2 and 3 renumbering changes those priorities to 20 and 30. You can then add ACL6-3 with priority 25.

Use this method to renumbers the priorities of PBR6s to multiples of 10.To commit this operation, you must apply the PBR6s.
Enables you to assign a new PBR6 a priority that is between two existing, consecutively numbered priorities. For example, if two PBR6s, PBR6-1 and PBR6-2, have priorities 2 and 3 renumbering changes those priorities to 20 and 30. You can then add PBR6-3 with priority 25.

Use this method to renumbers the priorities of PBRs to multiples of 10.To commit this operation, you must apply the PBRs.
Enables you to assign a new PBR a priority that is between two existing, consecutively numbered priorities. For example, if two PBRs, PBR1 and PBR2, have priorities 2 and 3 renumbering changes those priorities to 20 and 30. You can then add PBR3 with priority 25.

Use this method to reset Nextgen API by clearing builtin config, disabling nextgenapi and restoring system to default state

Use this method to removes an extended ACL rule from the Citrix ADC. To commit this operation, you must apply the extended ACLs.

Use this method to removes an ACL6 rule from the Citrix ADC. To commit this operation, you must apply the ACL6s.

Use this method to remove an AppFlow collector.
NOTE: This method is deprecated.
This method is deprecated in favor of 'rm appflow collector'

Use this method to removes a rewrite action.

Use this method to removes a central management server profile and the associated configuration.

Use this method to remove an encryption key. There can be no existing ENCRYPT() or DECRYPT() functions that use the key.

Use this method to removes the specified extension object.

Use this method to remove an HMACkey. There can be no existing HMAC() functions that use the key.

Use this method to removes an HTTP profile from the appliance.

Use this method to removes an ICAP profile.

Use this method to removes an IPv4 address configured on the Citrix ADC.

Use this method to removes an IPv6 address configured on the Citrix ADC.

Use this method to removes the Key Manager proxy server. You can specify the server by IP address or by name.

Use this method to removes the License proxy server. You can specify the server by IP address or by name.

Use this method to removes the License server. You can specify the server by IP address or by name.

Use this method to removes a rate limit identifier from the appliance.

NOTE: This method is deprecated.
Replaced by "stream selector"

Use this method to deletes a admin partition

Use this method to removes a PBR from the Citrix ADC. To commit this operation, you must apply the PBRs.

Use this method to removes a PBR6 from the Citrix ADC. To commit this operation, you must apply the PBR6s.

Use this method to removes specified service function.

Use this method to removes a ServicePath.

Use this method to removes a simple ACL rule from the Citrix ADC.

Use this method to removes a simple ACL6 rule from the Citrix ADC.

Use this method to removes a TCP profile from the appliance.

Use this method to remove a Timer.

Use this method to remove Traffic Domain configured.

Use this method to remove a variable and its value(s).

Use this method to removes the mapping between an XML prefix and a namespace URI.

Use this method to save the configurations to the appliances FLASH memory in the /nsconfig/ns.conf file. Backup configuration files are named ns.conf.n. The most recent backup file has the smallest value for n.

Use this method to set action to perform on incoming IPv4 packets that match the extended ACL rule.
Available settings function as follows:
* ALLOW - The Citrix ADC processes the packet.
* BRIDGE - The Citrix ADC bridges the packet to the destination without processing it.
* DENY - The Citrix ADC drops the packet.

Use this method to set iP address or range of IP addresses to match against the destination IP address of an incoming IPv4 packet. In the method line interface, separate the range with a hyphen. For example: 10.102.29.30-10.102.29.189.

Use this method to set port number or range of port numbers to match against the destination port number of an incoming IPv4 packet. In the method line interface, separate the range with a hyphen. For example: 40-90.

Note: The destination port can be specified only for TCP and UDP protocols.

Use this method to set specifies the type hashmethod to be applied, to steer the packet to the FP of the packet.

Use this method to set allow only incoming TCP packets that have the ACK or RST bit set, if the action set for the ACL rule is ALLOW and these packets match the other conditions in the ACL rule.

Use this method to set iCMP Message type to match against the message type of an incoming ICMP packet. For example, to block DESTINATION UNREACHABLE messages, you must specify 3 as the ICMP type.

Note: This parameter can be specified only for the ICMP protocol.

Use this method to set iD of an interface. The Citrix ADC applies the ACL rule only to the incoming packets from the specified interface. If you do not specify any value, the appliance applies the ACL rule to the incoming packets of all interfaces.

Use this method to set enable or disable logging of events related to the extended ACL rule. The log messages are stored in the configured syslog or auditlog server.

Use this method to set specifies the NodeId to steer the packet to the provided FP.

Use this method to set priority for the extended ACL rule that determines the order in which it is evaluated relative to the other extended ACL rules. If you do not specify priorities while creating extended ACL rules, the ACL rules are evaluated in the order in which they are created.

Use this method to set protocol to match against the protocol of an incoming IPv4 packet.

Use this method to set protocol to match against the protocol of an incoming IPv4 packet.

Use this method to set iP address or range of IP addresses to match against the source IP address of an incoming IPv4 packet. In the method line interface, separate the range with a hyphen. For example: 10.102.29.30-10.102.29.189.

Use this method to set mAC address to match against the source MAC address of an incoming IPv4 packet.

Use this method to set port number or range of port numbers to match against the source port number of an incoming IPv4 packet. In the method line interface, separate the range with a hyphen. For example: 40-90.

Use this method to set if stateful option is enabled, transparent sessions are created for the traffic hitting this ACL and not hitting any other features like LB, INAT etc.

Use this method to set iD of the VLAN. The Citrix ADC applies the ACL rule only to the incoming packets of the specified VLAN. If you do not specify a VLAN ID, the appliance applies the ACL rule to the incoming packets on all VLANs.

Use this method to set action associated with the ACL6.

Use this method to set iP address or range of IP addresses to match against the destination IP address of an incoming IPv6 packet. In the method line interface, separate the range with a hyphen.

Use this method to set destination Port (range).

Use this method to set specifies the type of hashmethod to be applied, to steer the packet to the FP of the packet.

Use this method to set hashprefix to be applied to SIP/DIP to generate rsshash FP.eg 128 => hash calculated on the complete IP

Use this method to set allow only incoming TCP packets that have the ACK or RST bit set if the action set for the ACL6 rule is ALLOW and these packets match the other conditions in the ACL6 rule.

Use this method to set iCMP Message type to match against the message type of an incoming IPv6 ICMP packet. For example, to block DESTINATION UNREACHABLE messages, you must specify 3 as the ICMP type.

Note: This parameter can be specified only for the ICMP protocol.

Use this method to set iD of an interface. The Citrix ADC applies the ACL6 rule only to the incoming packets from the specified interface. If you do not specify any value, the appliance applies the ACL6 rule to the incoming packets from all interfaces.

Use this method to set enable or disable logging of events related to the ACL6 rule. The log messages are stored in the configured syslog or auditlog server.

Use this method to set specifies the NodeId to steer the packet to the provided FP.

Use this method to set priority for the ACL6 rule, which determines the order in which it is evaluated relative to the other ACL6 rules. If you do not specify priorities while creating ACL6 rules, the ACL6 rules are evaluated in the order in which they are created.

Use this method to set protocol, identified by protocol name, to match against the protocol of an incoming IPv6 packet.

Use this method to set protocol, identified by protocol number, to match against the protocol of an incoming IPv6 packet.

Use this method to set maximum number of log messages to be generated per second. If you set this parameter, you must enable the Log State parameter.

Use this method to set iP address or range of IP addresses to match against the source IP address of an incoming IPv6 packet. In the method line interface, separate the range with a hyphen.

Use this method to set mAC address to match against the source MAC address of an incoming IPv6 packet.

Use this method to set source Port (range).

Use this method to set if stateful option is enabled, transparent sessions are created for the traffic hitting this ACL6 and not hitting any other features like LB, INAT etc.

Use this method to set iD of the VLAN. The Citrix ADC applies the ACL6 rule only to the incoming packets on the specified VLAN. If you do not specify a VLAN ID, the appliance applies the ACL6 rule to the incoming packets on all VLANs.

Use this method to set control whether AppFlow records should be generated only for client-side traffic.

Use this method to set enable AppFlow HTTP cookie logging.

Use this method to set enable AppFlow HTTP host logging.

Use this method to set enable AppFlow HTTP method logging.

Use this method to set enable AppFlow HTTP referer logging.

Use this method to set enable AppFlow HTTP URL logging.

Use this method to set enable AppFlow HTTP user-agent logging.

Use this method to set iPFIX template refresh interval (in seconds).

Use this method to set mTU to be used for IPFIX UDP packets.

Use this method to set right hand side of the assignment. The expression is evaluated and added to the left hand variable.

Use this method to set right hand side of the assignment. The expression is evaluated and appended to the left hand variable.

Use this method to set clear the variable value. Deallocates a text value, and for a map, the text key.

Use this method to set comment. Can be used to preserve information about this rewrite action.

Use this method to set right hand side of the assignment. The expression is evaluated and assigned to the left hand variable.

Use this method to set right hand side of the assignment. The expression is evaluated and subtracted from the left hand variable.

Use this method to set left hand side of the assigment, of the form $variable-name (for a singleton variabled) or $variable-name[key-expression], where key-expression is an expression that evaluates to a text string and provides the key to select a map entry

Use this method to set system bandwidth limit.

Use this method to set product edition.

Use this method to set password to use when authenticating with ADM Agent for LAS licensing.

Use this method to set appliance platform type.

Use this method to set bandwidth unit.

Use this method to set username to authenticate with ADM Agent for LAS licensing. Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at (@), equals (=), colon (:), and underscore characters.

Use this method to set licensed using vcpu pool.

Use this method to set vF autorecover mode.
This is mandatory parameter.

Use this method to set the option to control (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.
l If cipHeader is specified, it will be used as the client IP header.
l If it is not specified, then the value that has been set by the set ns config CLI method will be used as the client IP header.
NOTE: This attribute is deprecated.
Deprecated to support Cluster mode. Use nsparam method.

Use this method to set the version of the cookie inserted by system.
NOTE: This attribute is deprecated.
Deprecated to support Cluster mode. Use nsparam method.

Use this method to set port range for cache redirection services.
NOTE: This attribute is deprecated.
Deprecated to support Cluster mode. Use nsparam method.

Use this method to set the percentage of maxClient to be given to PEs
NOTE: This attribute is deprecated.
Deprecated to support Cluster mode. Use nsparam method.

Use this method to set the percentage of spillover threshold to be given to PEs
NOTE: This attribute is deprecated.
Deprecated to support Cluster mode. Use nsparam method.

Use this method to set port range configured for FTP services.
NOTE: This attribute is deprecated.
Deprecated to support Cluster mode. Use nsparam method.

Use this method to set the percentage of shared quota to be granted at a time for maxClient
NOTE: This attribute is deprecated.
Deprecated to support Cluster mode. Use nsparam method.

Use this method to set the percentage of shared quota to be granted at a time for spillover
NOTE: This attribute is deprecated.
Deprecated to support Cluster mode. Use nsparam method.

Use this method to set the 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.
NOTE: This attribute is deprecated.
Deprecated to support Cluster mode. Use nsparam method.

Use this method to set iP address of the Citrix ADC. Commonly referred to as NSIP address. This parameter is mandatory to bring up the appliance.

Use this method to set the maximum number of connections that will be made from the system to the web server(s) attached to it. The value entered here is applied globally to all attached servers.
NOTE: This attribute is deprecated.
Deprecated to support Cluster mode. Use nsparam method.

Use this method to set the maximum number of requests that the system can pass on a particular connection between the system and a server attached to it. Setting this value to 0 allows an unlimited number of requests to be passed.
NOTE: This attribute is deprecated.
Deprecated to support Cluster mode. Use nsparam method.

Use this method to set vLAN (NSVLAN) for the subnet on which the IP address resides.

Use this method to set the minimum Path MTU.
NOTE: This attribute is deprecated.
Deprecated to support Cluster mode. Use nsparam method.

Use this method to set the timeout value in minutes.
NOTE: This attribute is deprecated.
Deprecated to support Cluster mode. Use nsparam method.

Use this method to set enable/disable secure flag for persistence cookie
NOTE: This attribute is deprecated.
Deprecated to support Cluster mode. Use nsparam method.

Use this method to set this positive integer identifies Management traffic domain. If not specified, defaults to 4094

Use this method to set this enabled secure management traffic handling.

Use this method to set name of the timezone
NOTE: This attribute is deprecated.
Deprecated to support Cluster mode. Use nsparam method.

Use this method to set console login prompt string

Use this method to set hARQ retransmission delay (in ms).

Use this method to set coefficients values for Label1.

Use this method to set probability threshold values for LR model to differentiate between NET1 and reset(NET2 and NET3).

Use this method to set coefficients values for Label 2.

Use this method to set probability threshold values for LR model to differentiate between NET2 and NET3.

Use this method to set mIN RTT (in ms) for the first network.

Use this method to set mIN RTT (in ms) for the second network.

Use this method to set mIN RTT (in ms) for the third network.

Use this method to set three congestion level scores limits corresponding to None, Low, Medium.

Use this method to set three signal quality level scores limits corresponding to Excellent, Good, Fair.

Use this method to set name of the network label.

Use this method to set connection quality ranking Log coefficients of network 1.

Use this method to set three congestion level scores limits corresponding to None, Low, Medium.

Use this method to set three signal quality level scores limits corresponding to Excellent, Good, Fair.

Use this method to set name of the network label 2.

Use this method to set connnection quality ranking Log coefficients of network 2.

Use this method to set three congestion level scores limits corresponding to None, Low, Medium.

Use this method to set three signal quality level scores limits corresponding to Excellent, Good, Fair.

Use this method to set name of the network label 3.

Use this method to set connection quality ranking Log coefficients of network 3.

Use this method to set enables DHCP client to acquire IP address from the DHCP server in the next boot. When set to OFF, disables the DHCP client in the next boot.

Use this method to set dHCP acquired routes are saved on the Citrix ADC.

Use this method to set diameterIdentity to be used by NS. DiameterIdentity is used to identify a Diameter node uniquely. Before setting up diameter configuration, Citrix ADC (as a Diameter node) MUST be assigned a unique DiameterIdentity.
example =>
set ns diameter -identity netscaler.com
Now whenever Citrix ADC needs to use identity in diameter messages. It will use 'netscaler.com' as Origin-Host AVP as defined in RFC3588

Use this method to set diameter Realm to be used by NS.
example =>
set ns diameter -realm com
Now whenever Citrix ADC system needs to use realm in diameter messages. It will use 'com' as Origin-Realm AVP as defined in RFC3588

Use this method to set when a Server connection goes down, whether to close the corresponding client connection if there were requests pending on the server.

Use this method to set comments associated with this encryption key.

Use this method to set the initalization voector (IV) for a block cipher, one block of data used to initialize the encryption. The best practice is to not specify an IV, in which case a new random IV will be generated for each encryption. The format must be iv_data or keyid_iv_data to include the generated IV in the encrypted data. The IV should only be specified if it cannot be included in the encrypted data. The IV length is the cipher block size:
RC4 - not used (error if IV is specified)
DES - 8 bytes (all modes)
DES3 - 8 bytes (all modes)
AES128 - 16 bytes (all modes)
AES192 - 16 bytes (all modes)
AES256 - 16 bytes (all modes)

Use this method to set cipher method to be used to encrypt and decrypt content.
NONE - no encryption or decryption is performed The output of ENCRYPT() and DECRYPT() is the same as the input.
RC4 - the RC4 stream cipher with a 128 bit (16 byte) key; RC4 is now considered insecure and should only be used if required by existing applciations.
DES[-] - the Data Encryption Standard (DES) block cipher with a 64-bit (8 byte) key, with 56 data bits and 8 parity bits. DES is considered less secure than DES3 or AES so it should only be used if required by an existing applicastion. The optional mode is described below; DES without a mode is equivalent to DES-CBC.
DES3[-] - the Triple Data Encryption Standard (DES) block cipher with a 192-bit (24 byte) key. The optional mode is described below; DES3 without a mode is equivalent to DES3-CBC.
AES[-] - the Advanced Encryption Standard block cipher, available with 128 bit (16 byte), 192 bit (24 byte), and 256 bit (32 byte) keys. The optional mode is described below; AES without a mode is equivalent to AES-CBC.

For a block cipher, the specifies how multiple blocks of plaintext are encrypted and how the Initialization Vector (IV) is used. Choices are
CBC (Cipher Block Chaining) - Each block of plaintext is XORed with the previous ciphertext block, or IV for the first block, before being encrypted. Padding is required if the plaintext is not a multiple of the cipher block size.
CFB (Cipher Feedback) - The previous ciphertext block, or the IV for the first block, is encrypted and the output is XORed with the current plaintext block to create the current ciphertext block. The 128-bit version of CFB is provided. Padding is not required.
OFB (Output Feedback) - A keystream is generated by applying the cipher successfully to the IV and XORing the keystream blocks with the plaintext. Padding is not required.
ECB (Electronic Codebook) - Each block of plaintext is independently encrypted. An IV is not used. Padding is required. This mode is considered less secure than the other modes because the same plaintext always produces the same encrypted text and should only be used if required by an existing application.

Use this method to set enables or disables the padding of plaintext to meet the block size requirements of block ciphers:
ON - For encryption, PKCS5/7 padding is used, which appends n bytes of value n on the end of the plaintext to bring it to the cipher block lnegth. If the plaintext length is alraady a multiple of the block length, an additional block with bytes of value block_length will be added. For decryption, ISO 10126 padding is accepted, which expects the last byte of the block to be the number of added pad bytes. Note that this accepts PKCS5/7 padding, as well as ANSI_X923 padding. Padding ON is the default for the ECB and CBD modes.
OFF - No padding. An Undef error will occur with the ECB or CBC modes if the plaintext length is not a multitple of the cipher block size. This can be used with the CFB and OFB modes, and with the ECB and CBC modes if the plaintext will always be an integral number of blocks, or if custom padding is implemented using a policy extension function. Padding OFf is the default for CFB and OFB modes.

Use this method to set the base64-encoded key generation number, method, and key value.
Note:
* Do not include this argument if you are changing the encryption method.
* To generate a new key value for the current encryption method, specify an empty string \(""\) as the value of this parameter. The parameter is passed implicitly, with its automatically generated value, to the Citrix ADC packet engines even when it is not included in the method. Passing the parameter to the packet engines enables the appliance to save the key value to the configuration file and to propagate the key value to the secondary appliance in a high availability setup.

Use this method to set cipher method (and key length) to be used to encrypt and decrypt content. The default value is AES256.
This is mandatory parameter.

Use this method to set any comments to preserve information about the extension object.

Use this method to set enables tracing to the NS log file of extension execution:
off - turns off tracing (equivalent to unset ns extension -trace)
calls - traces extension function calls with arguments and function returns with the first return value
lines - traces the above plus line numbers for executed extension lines
all - traces the above plus local variables changed by executed extension lines
Note that the DEBUG log level must be enabled to see extension tracing.
This can be done by set audit syslogParams -loglevel ALL or -loglevel DEBUG.

Use this method to set comma-separated list of extension functions to trace. By default, all extension functions are traced.

Use this method to set comma-separated list of variables (in traced extension functions) to trace. By default, all variables are traced.

Use this method to set comments associated with this encryption key.

Use this method to set digest (hash) function to be used in the HMAC computation.

Use this method to set host name for the Citrix ADC.
This is mandatory parameter.

Use this method to set reuse server connections for requests from more than one client connections.

Use this method to set drop invalid HTTP requests or responses.

Use this method to set enable/Disable HTTP/2 on server side

Use this method to set ignore Coding scheme in CONNECT request.

Use this method to set enable or disable Citrix ADC server header insertion for Citrix ADC generated HTTP responses.

Use this method to set server header value to be inserted.

Use this method to set mark CONNECT requests as invalid.

Use this method to set mark HTTP/0.9 requests as invalid.

Use this method to set maximum limit on the number of connections, from the Citrix ADC to a particular server that are kept in the reuse pool. This setting is helpful for optimal memory utilization and for reducing the idle connections to the server just after the peak time.

Use this method to set adapts the configured request timeout based on flow conditions. The timeout is increased or decreased internally and applied on the flow.

Use this method to set when enabled allows only the word characters [A-Za-z0-9_] and hyphen [-] in the request/response header names and the connection will be reset for the other characters. When disabled allows any visible (printing) characters (%21-%7E) except delimiters (double quotes and "(),/:;<=>?@[]{}").

Use this method to set choose whether to enable support for Alternative Services.

Use this method to set configure a custom Alternative Services header value that should be inserted in the response to advertise a HTTP/SSL/HTTP_QUIC vserver.

Use this method to set this option sets the satisfactory threshold (T) for client response time in milliseconds to be used for APDEX calculations. This means a transaction responding in less than this threshold is considered satisfactory. Transaction responding between T and 4*T is considered tolerable. Any transaction responding in more than 4*T time is considered frustrating. Citrix ADC maintains stats for such tolerable and frustrating transcations. And client response time related apdex counters are only updated on a vserver which receives clients traffic.

Use this method to set name of the header that contains the real client IP address.

Use this method to set start data compression on receiving a TCP packet with PUSH flag set.

Use this method to set reuse server connections for requests from more than one client connections.

Use this method to set drop any extra 'CR' and 'LF' characters present after the header.

Use this method to set drop any extra data when server sends more data than the specified content-length.

Use this method to set drop invalid HTTP requests or responses.

Use this method to set maximum size in bytes allowed to buffer gRPC packets till trailer is received

Use this method to set maximum time in milliseconds allowed to buffer gRPC packets till trailer is received. The value should be in multiples of 100

Use this method to set set to DISABLED for gRPC without a length delimitation.

Use this method to set validates the length of the Host header and its syntax. Also includes validation of the port number if specified

Use this method to set choose whether to enable support for HTTP/2.

Use this method to set choose whether to enable support for sending HTTP/2 ALTSVC frames. When enabled, the ADC sends HTTP/2 ALTSVC frames to HTTP/2 clients, instead of the Alt-Svc response header field. Not applicable to servers.

Use this method to set choose whether to enable support for Direct HTTP/2.

Use this method to set choose whether to enable HTTP/2 Extended CONNECT mechanism.

Use this method to set maximum size of the header compression table used to decode header blocks, in bytes.

Use this method to set initial window size for connection level flow control, in bytes.

Use this method to set initial window size for stream level flow control, in bytes.

Use this method to set maximum number of concurrent streams that is allowed per connection.

Use this method to set maximum number of empty frames allowed in HTTP2 connection per minute

Use this method to set maximum size of the frame payload that the Citrix ADC is willing to receive, in bytes.

Use this method to set maximum size of header list that the Citrix ADC is prepared to accept, in bytes. NOTE: The actual plain text header size that the Citrix ADC accepts is limited by maxHeaderLen. Please change maxHeaderLen parameter as well when modifying http2MaxHeaderListSize.

Use this method to set maximum number of PING frames allowed in HTTP2 connection per minute

Use this method to set maximum number of outgoing RST_STREAM frames allowed in HTTP/2 connection per minute

Use this method to set maximum number of incoming RST_STREAM frames allowed in HTTP/2 connection per minute

Use this method to set maximum number of SETTINGS frames allowed in HTTP2 connection per minute

Use this method to set minimum number of HTTP2 connections established to backend server, on receiving HTTP requests from client before multiplexing the streams into the available HTTP/2 connections.

Use this method to set choose whether to enable strict HTTP/2 cipher selection

Use this method to set choose whether to enable support for HTTP/3.

Use this method to set maximum number of HTTP/3 streams that can be blocked while HTTP/3 headers are being decoded.

Use this method to set maximum size of the HTTP/3 header field section, in bytes.

Use this method to set maximum size of the HTTP/3 QPACK dynamic header table, in bytes.

Use this method to set minimum number of HTTP/3 connections established to backend server, on receiving HTTP requests from client before multiplexing the streams into the available HTTP/3 connections.

Use this method to set choose whether to enable support for WebTransport over HTTP/3.

Use this method to set application pipeline request buffering size, in bytes.

Use this method to set maximum time to wait, in milliseconds, between incomplete header packets. If the header packets take longer to arrive at Citrix ADC, the connection is silently dropped.

Use this method to set mark CONNECT requests as invalid.

Use this method to set mark HTTP/0.9 requests as invalid.

Use this method to set mark Http header with extra white space as invalid

Use this method to set mark RFC7230 non-compliant transaction as invalid

Use this method to set mark TRACE requests as invalid.

Use this method to set maximum number of allowed occurrences of header fields that share the same field name. This threshold is enforced only for well-known header field names recognized by NetScaler. If the value is set to 0, then it will be similar to previous behavior, Where we store only 15 duplicate headers and rest are parsed and send to the server.

Use this method to set number of bytes allowed for header field for HTTP header. If number of bytes exceeds beyond configured value, then request will be marked invalid

Use this method to set number of bytes to be queued to look for complete header before returning error. If complete header is not obtained after queuing these many bytes, request will be marked as invalid and no L7 processing will be done for that TCP connection.

Use this method to set maximum number of requests allowed on a single connection. Zero implies no limit on the number of requests.

Use this method to set maximum limit on the number of connections, from the Citrix ADC to a particular server that are kept in the reuse pool. This setting is helpful for optimal memory utilization and for reducing the idle connections to the server just after the peak time. Zero implies no limit on reuse pool size. If non-zero value is given, it has to be greater than or equal to the number of running Packet Engines.

Use this method to set minimum limit on the number of connections, from the Citrix ADC to a particular server that are kept in the reuse pool. This setting is helpful for optimal memory utilization and for reducing the idle connections to the server just after the peak time. Zero implies no limit on reuse pool size.

Use this method to set pass protocol upgrade request to the server.

Use this method to set generate the persistent Citrix ADC specific ETag for the HTTP response with ETag header.

Use this method to set time, in seconds, within which the HTTP request must complete. If the request does not complete within this time, the specified request timeout action is executed. Zero disables the timeout.

Use this method to set action to take when the HTTP request does not complete within the specified request timeout duration. You can configure the following actions:
* RESET - Send RST (reset) to client when timeout occurs.
* DROP - Drop silently when timeout occurs.
* Custom responder action - Name of the responder action to trigger when timeout occurs, used to send custom message.

Use this method to set idle timeout (in seconds) for server connections in re-use pool. Connections in the re-use pool are flushed, if they remain idle for the configured timeout.

Use this method to set allow RTSP tunnel in HTTP. Once application/x-rtsp-tunnelled is seen in Accept or Content-Type header, Citrix ADC does not process Layer 7 traffic on this connection.

Use this method to set enable or disable web logging.

Use this method to set hTTP connection to be upgraded to a web socket connection. Once upgraded, Citrix ADC does not process Layer 7 traffic on this connection.

Use this method to set enable or Disable sending Allow: 204 header in ICAP request.

Use this method to set if enabled, Citrix ADC keeps the ICAP connection alive after a transaction to reuse it to send next ICAP request.

Use this method to set iCAP Host Header

Use this method to set exact HTTP request, in the form of an expression, which the Citrix ADC encapsulates and sends to the ICAP server. If you set this parameter, the ICAP request is sent using only this header. This can be used when the HTTP header is not available to send or ICAP server only needs part of the incoming HTTP request. The request expression is constrained by the feature for which it is used.
The Citrix ADC does not check the validity of this request. You must manually validate the request.

Use this method to set insert custom ICAP headers in the ICAP request to send to ICAP server. The headers can be static or can be dynamically constructed using PI Policy Expression. For example, to send static user agent and Client's IP address, the expression can be specified as "User-Agent: NS-ICAP-Client/V1.0\r\nX-Client-IP: "+CLIENT.IP.SRC+"\r\n".
The Citrix ADC does not check the validity of the specified header name-value. You must manually validate the specified header syntax.

Use this method to set enable or Disable ICAP inspection for HTTP/2 traffic.

Use this method to set name of the audit message action which would be evaluated on receiving the ICAP response to emit the logs.

Use this method to set iCAP Mode of operation. It is a mandatory argument while creating an icapprofile.

Use this method to set enable or Disable preview header with ICAP request. This feature allows an ICAP server to see the beginning of a transaction, then decide if it wants to opt-out of the transaction early instead of receiving the remainder of the request message.

Use this method to set value of Preview Header field. Citrix ADC uses the minimum of this set value and the preview size received on OPTIONS response.

Use this method to set query parameters to be included with ICAP request URI. Entered values should be in arg=value format. For more than one parameters, add & separated values. e.g.: arg1=val1&arg2=val2.

Use this method to set time, in seconds, within which the remote server should respond to the ICAP-request. If the Netscaler does not receive full response with this time, the specified request timeout action is performed. Zero value disables this timeout functionality.

Use this method to set name of the action to perform if the Vserver/Server representing the remote service does not respond with any response within the timeout value configured. The Supported actions are
* BYPASS - This Ignores the remote server response and sends the request/response to Client/Server.
* If the ICAP response with Encapsulated headers is not received within the request-timeout value configured, this Ignores the remote ICAP server response and sends the Full request/response to Server/Client.
* RESET - Reset the client connection by closing it. The client program, such as a browser, will handle this and may inform the user. The client may then resend the request if desired.
* DROP - Drop the request without sending a response to the user.

Use this method to set uRI representing icap service. It is a mandatory argument while creating an icapprofile.

Use this method to set iCAP User Agent Header String

Use this method to set set the idletimeout for natpcb.

Use this method to set set the idletimeout for client side pcb.

Use this method to set set the idletimeout for server side pcb.

Use this method to set advertise VIPs from Shared VLAN on Default Partition.

Use this method to set respond to ARP requests for this IP address.

Use this method to set the arp owner in a Cluster for this IP address. It can vary from 0 to 31.

Use this method to set respond to ARP requests for a Virtual IP (VIP) address on the basis of the states of the virtual servers associated with that VIP. Available settings function as follows:

* NONE - The Citrix ADC responds to any ARP request for the VIP address, irrespective of the states of the virtual servers associated with the address.
* ONE VSERVER - The Citrix ADC responds to any ARP request for the VIP address if at least one of the associated virtual servers is in UP state.
* ALL VSERVER - The Citrix ADC responds to any ARP request for the VIP address if all of the associated virtual servers are in UP state.

Use this method to set the state of BGP on this IP address for the entity.
NOTE: This attribute is deprecated.
Replaced by -dynamicRouting

Use this method to set decrement TTL by 1 when ENABLED.This setting is applicable only for UDP traffic.

Use this method to set allow dynamic routing on this IP address. Specific to Subnet IP (SNIP) address.

Use this method to set allow File Transfer Protocol (FTP) access to this IP address.

Use this method to set allow graphical user interface (GUI) access to this IP address.

Use this method to set option to push the VIP to ZebOS routing table for Kernel route redistribution through dynamic routing protocols

Use this method to set iP address of the gateway of the route for this VIP address.

Use this method to set respond to ICMP requests for this IP address.

Use this method to set respond to ICMP requests for a Virtual IP (VIP) address on the basis of the states of the virtual servers associated with that VIP. Available settings function as follows:
* NONE - The Citrix ADC responds to any ICMP request for the VIP address, irrespective of the states of the virtual servers associated with the address.
* ONE VSERVER - The Citrix ADC responds to any ICMP request for the VIP address if at least one of the associated virtual servers is in UP state.
* ALL VSERVER - The Citrix ADC responds to any ICMP request for the VIP address if all of the associated virtual servers are in UP state.
* VSVR_CNTRLD - The behavior depends on the ICMP VSERVER RESPONSE setting on all the associated virtual servers.

The following settings can be made for the ICMP VSERVER RESPONSE parameter on a virtual server:
* If you set ICMP VSERVER RESPONSE to PASSIVE on all virtual servers, Citrix ADC always responds.
* If you set ICMP VSERVER RESPONSE to ACTIVE on all virtual servers, Citrix ADC responds if even one virtual server is UP.
* When you set ICMP VSERVER RESPONSE to ACTIVE on some and PASSIVE on others, Citrix ADC responds if even one virtual server set to ACTIVE is UP.

Use this method to set integer value to add to or subtract from the cost of the route advertised for the VIP address.

Use this method to set allow access to management applications on this IP address.

Use this method to set if enabled, this IP will be advertised by Citrix ADC to MPTCP enabled clients as part of ADD_ADDR option.

Use this method to set subnet mask associated with the IP address.

Use this method to set option to push the SNIP subnet to ZebOS routing table for Kernel route redistribution through dynamic routing protocol.

Use this method to set the state of OSPF on this IP address for the entity.
NOTE: This attribute is deprecated.
Replaced by -dynamicRouting

Use this method to set iD of the area in which the type1 link-state advertisements (LSAs) are to be advertised for this virtual IP (VIP) address by the OSPF protocol running on the Citrix ADC. When this parameter is not set, the VIP is advertised on all areas.

Use this method to set type of LSAs to be used by the OSPF protocol, running on the Citrix ADC, for advertising the route for this VIP address.

Use this method to set in cluster system, if the owner node is down, whether should it respond to icmp/arp

Use this method to set block access to nonmanagement applications on this IP. This option is applicable for MIPs, SNIPs, and NSIP, and is disabled by default. Nonmanagement applications can run on the underlying Citrix ADC Free BSD operating system.

Use this method to set the state of RIP on this IP address for the entity.
NOTE: This attribute is deprecated.
Replaced by -dynamicRouting

Use this method to set allow Simple Network Management Protocol (SNMP) access to this IP address.

Use this method to set allow secure shell (SSH) access to this IP address.

Use this method to set tag value for the network/host route associated with this IP.

Use this method to set allow Telnet access to this IP address.

Use this method to set a positive integer that uniquely identifies a VMAC address for binding to this VIP address. This binding is used to set up Citrix ADCs in an active-active configuration using VRRP.

Use this method to set use this option to set (enable or disable) the virtual server attribute for this IP address.

Use this method to set advertise the route for the Virtual IP (VIP) address on the basis of the state of the virtual servers associated with that VIP.
* NONE - Advertise the route for the VIP address, regardless of the state of the virtual servers associated with the address.
* ONE VSERVER - Advertise the route for the VIP address if at least one of the associated virtual servers is in UP state.
* ALL VSERVER - Advertise the route for the VIP address if all of the associated virtual servers are in UP state.
* VSVR_CNTRLD - Advertise the route for the VIP address according to the RHIstate (RHI STATE) parameter setting on all the associated virtual servers of the VIP address along with their states.

When Vserver RHI Level (RHI) parameter is set to VSVR_CNTRLD, the following are different RHI behaviors for the VIP address on the basis of RHIstate (RHI STATE) settings on the virtual servers associated with the VIP address:
* If you set RHI STATE to PASSIVE on all virtual servers, the Citrix ADC always advertises the route for the VIP address.
* If you set RHI STATE to ACTIVE on all virtual servers, the Citrix ADC advertises the route for the VIP address if at least one of the associated virtual servers is in UP state.
*If you set RHI STATE to ACTIVE on some and PASSIVE on others, the Citrix ADC advertises the route for the VIP address if at least one of the associated virtual servers, whose RHI STATE set to ACTIVE, is in UP state.

Use this method to set advertise VIPs from Shared VLAN on Default Partition

Use this method to set decrement Hop Limit by 1 when ENABLED.This setting is applicable only for UDP traffic.

Use this method to set allow dynamic routing on this IP address. Specific to Subnet IPv6 (SNIP6) address.

Use this method to set the state of ftp access to this IP entity.

Use this method to set the state of GUI access to this IP entity.

Use this method to set option to push the VIP6 to ZebOS routing table for Kernel route redistribution through dynamic routing protocols.

Use this method to set the state of ICMP responses for the entity.

Use this method to set respond to ICMPv6 requests for a Virtual IP (VIP) address on the basis of the states of the virtual servers associated with that VIP

Use this method to set iPv6 address of the gateway for the route. If Gateway is not set, VIP uses :: as the gateway.

Use this method to set mapped IPV4 address for the IPV6 address.

Use this method to set integer value to add to or subtract from the cost of the route advertised for the VIP6 address.

Use this method to set the state of management access to this IP entity.

Use this method to set if enabled, this IP will be advertised by Citrix ADC to MPTCP enabled clients as part of ADD_ADDR option.

Use this method to set the state of ND responses for the entity.

Use this method to set ndOwner in Cluster for VIPS and Striped SNIPS

Use this method to set option to push the SNIP6 subnet to ZebOS routing table for Kernel route redistribution through dynamic routing protocol.

Use this method to set type of LSAs to be used by the IPv6 OSPF protocol, running on the Citrix ADC, for advertising the route for the VIP6 address.

Use this method to set iD of the area in which the Intra-Area-Prefix LSAs are to be advertised for the VIP6 address by the IPv6 OSPF protocol running on the Citrix ADC. When ospfArea is not set, VIP6 is advertised on all areas.

Use this method to set in cluster system, if the owner node is down, whether should it respond to icmp/arp

Use this method to set status of ports not used for management access (blocked/open) for the entity.

Use this method to set the state of SNMP access to this IP entity.

Use this method to set the state of SSH access to this IP entity.

Use this method to set enable or disable the IP address.

Use this method to set tag value for the network/host route associated with this IP.

Use this method to set the state of telnet access to this IP entity.

Use this method to set a positive integer that uniquely identifies a VMAC address for binding to this VIP address. This binding is used to set up Citrix ADCs in an active-active configuration using VRRP.

Use this method to set the state of vserver attribute for this IP entity.

Use this method to set advertise or do not advertise the route for the Virtual IP (VIP6) address on the basis of the state of the virtual servers associated with that VIP6.
* NONE - Advertise the route for the VIP6 address, irrespective of the state of the virtual servers associated with the address.
* ONE VSERVER - Advertise the route for the VIP6 address if at least one of the associated virtual servers is in UP state.
* ALL VSERVER - Advertise the route for the VIP6 address if all of the associated virtual servers are in UP state.
* VSVR_CNTRLD. Advertise the route for the VIP address according to the RHIstate (RHI STATE) parameter setting on all the associated virtual servers of the VIP address along with their states.

When Vserver RHI Level (RHI) parameter is set to VSVR_CNTRLD, the following are different RHI behaviors for the VIP address on the basis of RHIstate (RHI STATE) settings on the virtual servers associated with the VIP address:
* If you set RHI STATE to PASSIVE on all virtual servers, the Citrix ADC always advertises the route for the VIP address.
* If you set RHI STATE to ACTIVE on all virtual servers, the Citrix ADC advertises the route for the VIP address if at least one of the associated virtual servers is in UP state.
*If you set RHI STATE to ACTIVE on some and PASSIVE on others, the Citrix ADC advertises the route for the VIP address if at least one of the associated virtual servers, whose RHI STATE set to ACTIVE, is in UP state.

Use this method to set if ADC remains in grace for the configured hours then first grace alert will be raised

Use this method to set if ADC remains in grace for the configured hours then major grace alert will be raised

Use this method to set heartbeat between ADC and Licenseserver is configurable and applicable in case of pooled licensing

Use this method to set inventory refresh interval between ADC and Licenseserver is configurable and applicable in case of pooled licensing

Use this method to set if ADC license contract expiry date is nearer then GUI/SNMP license expiry alert will be raised

Use this method to set license proxy server port.
This is mandatory parameter.

Use this method to set this paramter indicates type of license customer interested while configuring add/set licenseserver

Use this method to set license server port.

Use this method to set maximum bandwidth permitted, in kbps.

Use this method to set defines the type of traffic to be tracked.
* REQUEST_RATE - Tracks requests/timeslice.
* CONNECTION - Tracks active transactions.

Examples

1. To permit 20 requests in 10 ms and 2 traps in 10 ms:
add limitidentifier limit_req -mode request_rate -limitType smooth -timeslice 1000 -Threshold 2000 -trapsInTimeSlice 200

2. To permit 50 requests in 10 ms:
set limitidentifier limit_req -mode request_rate -timeslice 1000 -Threshold 5000 -limitType smooth

3. To permit 1 request in 40 ms:
set limitidentifier limit_req -mode request_rate -timeslice 2000 -Threshold 50 -limitType smooth

4. To permit 1 request in 200 ms and 1 trap in 130 ms:
set limitidentifier limit_req -mode request_rate -timeslice 1000 -Threshold 5 -limitType smooth -trapsInTimeSlice 8

5. To permit 5000 requests in 1000 ms and 200 traps in 1000 ms:
set limitidentifier limit_req -mode request_rate -timeslice 1000 -Threshold 5000 -limitType BURSTY

Use this method to set name of the rate limit selector. If this argument is NULL, rate limiting will be applied on all traffic received by the virtual server or the Citrix ADC (depending on whether the limit identifier is bound to a virtual server or globally) without any filtering.

Use this method to set maximum number of requests that are allowed in the given timeslice when requests (mode is set as REQUEST_RATE) are tracked per timeslice.
When connections (mode is set as CONNECTION) are tracked, it is the total number of connections that would be let through.

Use this method to set time interval, in milliseconds, specified in multiples of 10, during which requests are tracked to check if they cross the threshold. This argument is needed only when the mode is set to REQUEST_RATE.

Use this method to set number of traps to be sent in the timeslice configured. A value of 0 indicates that traps are disabled.

Use this method to set .

Use this method to set this enables setting the HTTPD Max Clients value in the httpd.conf file. You can configure either Max Clients or Max Request Workers. The allowable range is from a minimum of 1 to a maximum of 255

Use this method to set this enables setting the HTTPD Max Request Workers value in the httpd.conf file. You can configure either Max Clients or Max Request Workers. The allowable range is from a minimum of 1 to a maximum of 255

Use this method to set this allow the configuration of management HTTP port.

Use this method to set this allows the configuration of management HTTPS port.

Use this method to set disable/Enable advanace analytics stats

Use this method to set allow the FTP server to come from a random source port for active FTP data connections

Use this method to set 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.

Use this method to set version of the cookie inserted by the system.

Use this method to set port range for cache redirection services.

Use this method to set percentage of maxClient threshold to be divided equally among PEs.

Use this method to set percentage of spillover threshold to be divided equally among PEs.

Use this method to set minimum and maximum port (port range) that FTP services are allowed to use.

Use this method to set percentage of shared pool value granted to PE once PE exhausts the local exclusive quota. Where shared pool is the remaining maxclient quota after distribution of exclusive quota to PEs.

Example: In a 2 PE NetScaler system if configured maxclient is 100 and exclusive quota is 80 percent then each PE will get 40 as local exclusive quota and 20 will be in shared pool. If configured grantQuota is 20 percent, then after exhausting its local exclusive quota PE borrows from shared pool in chunks of 4 i.e. 20 percent of 20.

Use this method to set percentage of shared pool value granted to PE once PE exhausts the local exclusive quota. Where shared pool is the remaining spillover quota after distribution of exclusive quota to PEs.

Example: In a 2 PE NetScaler system if configured spillover is 100 and exclusive quota is 80 percent then each PE will get 40 as local exclusive quota and 20 will be in shared pool. If configured grantQuota is 20 percent, then after exhausting its local exclusive quota PE borrows from shared pool in chunks of 4 i.e. 20 percent of 20.

Use this method to set 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.

Use this method to set 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.

Use this method to set 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".

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

Use this method to set 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.

Use this method to set 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.

Use this method to set this allow the configuration of management HTTP port.
NOTE: This attribute is deprecated.
Deprecated, Use set mgmtParam method

Use this method to set this allows the configuration of management HTTPS port.
NOTE: This attribute is deprecated.
Deprecated, Use set mgmtParam method

Use this method to set 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.

Use this method to set interval, in minutes, for flushing the PMTU entries.

Use this method to set disable/Enable v1 or v2 proxy protocol header for client info insertion

Use this method to set enable or disable secure flag for persistence cookie.

Use this method to set 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.

Use this method to set vLAN on which the subscriber traffic arrives on the appliance.

Use this method to set 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.

Use this method to set time zone for the Citrix ADC. Name of the time zone should be specified as argument.

Use this method to set enable/Disable use_proxy_port setting

Use this method to set maximum bandwidth, in Kbps, that the partition can consume. A zero value indicates the bandwidth is unrestricted on the partition and it can consume up to the system limits.

Use this method to set maximum number of concurrent connections that can be open in the partition. A zero value indicates no limit on number of open connections.

Use this method to set maximum memory, in megabytes, allocated to the partition. A zero value indicates the memory is unlimited on the partition and it can consume up to the system limits.

Use this method to set minimum bandwidth, in Kbps, that the partition can consume. A zero value indicates the bandwidth is unrestricted on the partition and it can consume up to the system limits
NOTE: This attribute is deprecated.
Minimum bandwith can alternatively be achieved by either judicously configuring maximum bandwidth paramater or by assigning dedicated interface(s) to each partition.

Use this method to set special MAC address for the partition which is used for communication over shared vlans in this partition. If not specified, the MAC address is auto-generated.

Use this method to set action to perform on the outgoing IPv4 packets that match the PBR.

Available settings function as follows:
* ALLOW - The Citrix ADC sends the packet to the designated next-hop router.
* DENY - The Citrix ADC applies the routing table for normal destination-based routing.

Use this method to set iP address or range of IP addresses to match against the destination IP address of an outgoing IPv4 packet. In the method line interface, separate the range with a hyphen. For example: 10.102.29.30-10.102.29.189.

Use this method to set port number or range of port numbers to match against the destination port number of an outgoing IPv4 packet. In the method line interface, separate the range with a hyphen. For example: 40-90.

Note: The destination port can be specified only for TCP and UDP protocols.

Use this method to set iD of an interface. The Citrix ADC compares the PBR only to the outgoing packets on the specified interface. If you do not specify any value, the appliance compares the PBR to the outgoing packets on all interfaces.

Use this method to set the Tunnel name.

Use this method to set monitor the route specified byte Next Hop parameter. This parameter is not applicable if you specify a link load balancing (LLB) virtual server name with the Next Hop parameter.

Use this method to set iP address of the next hop router or the name of the link load balancing virtual server to which to send matching packets if action is set to ALLOW.
If you specify a link load balancing (LLB) virtual server, which can provide a backup if a next hop link fails, first make sure that the next hops bound to the LLB virtual server are actually next hops that are directly connected to the Citrix ADC. Otherwise, the Citrix ADC throws an error when you attempt to create the PBR. The next hop can be null to represent null routes

Use this method to set priority of the PBR, which determines the order in which it is evaluated relative to the other PBRs. If you do not specify priorities while creating PBRs, the PBRs are evaluated in the order in which they are created.

Use this method to set protocol, identified by protocol name, to match against the protocol of an outgoing IPv4 packet.

Use this method to set protocol, identified by protocol number, to match against the protocol of an outgoing IPv4 packet.

Use this method to set iP address or range of IP addresses to match against the source IP address of an outgoing IPv4 packet. In the method line interface, separate the range with a hyphen. For example: 10.102.29.30-10.102.29.189.

Use this method to set mAC address to match against the source MAC address of an outgoing IPv4 packet.

Use this method to set port number or range of port numbers to match against the source port number of an outgoing IPv4 packet. In the method line interface, separate the range with a hyphen. For example: 40-90.

Note: The destination port can be specified only for TCP and UDP protocols.

Use this method to set integer value that uniquely identifies the traffic domain to which you want to send packet to.

Use this method to set iD of the VLAN. The Citrix ADC compares the PBR only to the outgoing packets on the specified VLAN. If you do not specify any interface ID, the appliance compares the PBR to the outgoing packets on all VLANs.

Use this method to set action to perform on the outgoing IPv6 packets that match the PBR6.

Available settings function as follows:
* ALLOW - The Citrix ADC sends the packet to the designated next-hop router.
* DENY - The Citrix ADC applies the routing table for normal destination-based routing.

Use this method to set iP address or range of IP addresses to match against the destination IP address of an outgoing IPv6 packet. In the method line interface, separate the range with a hyphen.

Use this method to set destination Port (range).

Use this method to set iD of an interface. The Citrix ADC compares the PBR6 only to the outgoing packets on the specified interface. If you do not specify a value, the appliance compares the PBR6 to the outgoing packets on all interfaces.

Use this method to set the iptunnel name where packets need to be forwarded upon.

Use this method to set monitor the route specified by the Next Hop parameter.

Use this method to set iP address of the next hop router to which to send matching packets if action is set to ALLOW. This next hop should be directly reachable from the appliance.

Use this method to set vLAN number to be used for link local nexthop .

Use this method to set priority of the PBR6, which determines the order in which it is evaluated relative to the other PBR6s. If you do not specify priorities while creating PBR6s, the PBR6s are evaluated in the order in which they are created.

Use this method to set protocol, identified by protocol name, to match against the protocol of an outgoing IPv6 packet.

Use this method to set protocol, identified by protocol number, to match against the protocol of an outgoing IPv6 packet.

Use this method to set iP address or range of IP addresses to match against the source IP address of an outgoing IPv6 packet. In the method line interface, separate the range with a hyphen.

Use this method to set mAC address to match against the source MAC address of an outgoing IPv6 packet.

Use this method to set source Port (range).

Use this method to set iD of the VLAN. The Citrix ADC compares the PBR6 only to the outgoing packets on the specified VLAN. If you do not specify an interface ID, the appliance compares the PBR6 to the outgoing packets on all VLANs.

Use this method to set number of ICMP packets permitted per 10 milliseconds.

Use this method to set the number of TCP RST packets permitted per 10 milli second. zero means rate control is disabled and 0xffffffff means every thing is rate controlled

Use this method to set number of SYNs permitted per 10 milliseconds.

Use this method to set number of UDP packets permitted per 10 milliseconds.

Use this method to set password to be used in authentication with the peer system node.

Use this method to set state of the channel when talking to the node.

Use this method to set source IP address to be used to communicate with the peer system node. The default value is 0, which means that the appliance uses the NSIP address as the source IP address.

Use this method to set validate the server certificate for secure SSL connections

Use this method to set vLAN ID on which the traffic from service function reaches Citrix ADC.

Use this method to set maximum number of server connections that can be opened before surge protection is activated.

Use this method to set rate at which the system opens connections to the server.

Use this method to set maximum memory, in megabytes, that can be used for buffering.

Use this method to set tCP buffering size per connection, in kilobytes.

Use this method to set send immediate positive acknowledgement (ACK) on receipt of TCP packets with PUSH flag.

Use this method to set timeout for the server to function in syncookie mode after the synattack. This is valid if TCP syncookie is disabled on the profile and server acts in non syncookie mode by default.

Use this method to set if enabled, non-negotiated TCP options are removed from the received packet while proxying it. By default, non-negotiated TCP options would be replaced by NOPs in the proxied packets. This option is not applicable for Citrix ADC generated packets.

Use this method to set flush an existing connection if no memory can be obtained for new connection.

HALF_CLOSED_AND_IDLE: Flush a connection that is closed by us but not by peer, or failing that, a connection that is past configured idle time. New connection fails if no such connection can be found.

FIFO: If no half-closed or idle connection can be found, flush the oldest non-management connection, even if it is active. New connection fails if the oldest few connections are management connections.

Note: If you enable this setting, you should also consider lowering the zombie timeout and half-close timeout, while setting the Citrix ADC timeout.

See Also: connFlushThres argument below.

Use this method to set flush an existing connection (as configured through -connFlushIfNoMem FIFO) if the system has more than specified number of connections, and a new connection is to be established. Note: This value may be rounded down to be a whole multiple of the number of packet engines running.

Use this method to set timeout for TCP delayed ACK, in milliseconds.

Use this method to set if enabled, Delink client and server connection, when there is outstanding data to be sent to the other side.

Use this method to set flag to switch on RST on down services.

Use this method to set if enabled, increase the ISN variation in SYN-ACKs sent by the NetScaler

Use this method to set initial maximum upper limit on the number of TCP packets that can be outstanding on the TCP link to the server.

Use this method to set update last activity for KA probes
NOTE: This attribute is deprecated.
This option has been moved tcpProfile

Use this method to set enable or disable maximum segment size (MSS) learning for virtual servers.

Use this method to set limit the number of persist (zero window) probes.

Use this method to set maximum number of TCP segments allowed in a burst.

Use this method to set maximum number of probes that Citrix ADC can send out in 10 milliseconds, to dynamically learn a service. Citrix ADC probes for the existence of the origin in case of wildcard virtual server or services.

Use this method to set maximum number of TCP packets allowed per maximum segment size (MSS).

Use this method to set when 'syncookie' is disabled in the TCP profile that is bound to the virtual server or service, and the number of TCP SYN+ACK retransmission by Citrix ADC for that virtual server or service crosses this threshold, the Citrix ADC responds by using the TCP SYN-Cookie mechanism.

Use this method to set limit the number of client connections (SYN) waiting for status of probe system wide. Any new SYN packets will be dropped.

Use this method to set limit the number of client connections (SYN) waiting for status of single probe. Any new SYN packets will be dropped.

Use this method to set maximum number of connections to hold in the TCP TIME_WAIT state on a packet engine. New connections entering TIME_WAIT state are proactively cleaned up.

Use this method to set minimum retransmission timeout, in milliseconds, specified in 10-millisecond increments (value must yield a whole number if divided by 10).

Use this method to set use MPTCP DSS checksum

Use this method to set allow to send DATA FIN or FAST CLOSE on mptcp connection while sending FIN or RST on the last subflow.

Use this method to set accept DATA_FIN/FAST_CLOSE on passive subflow

Use this method to set allow to select option ACK or RESET to force the closure of an MPTCP connection abruptly.

Use this method to set allow subflows to close immediately on FIN before the DATA_FIN exchange is completed at mptcp level.

Use this method to set maximum number of subflow connections supported in pending join state per mptcp connection.

Use this method to set maximum number of subflow connections supported in established state per mptcp connection.

Use this method to set maximum system level pending join connections allowed.

Use this method to set if enabled, Citrix ADC retransmits MPTCP ADD-ADDR option if echo response is not received within the timeout interval. The retransmission is attempted only once.

Use this method to set number of RTO's at subflow level, after which MPCTP should start using other subflow.

Use this method to set allow MPTCP subflows to send TCP RST Reason (MP_TCPRST) Option while sending TCP RST.

Use this method to set the minimum idle time value in seconds for idle mptcp subflows after which the sublow is replaced by new incoming subflow if maximum subflow limit is reached. The priority for replacement is given to those subflow without any transaction

Use this method to set the timeout value in seconds for idle mptcp subflows. If this timeout is not set, idle subflows are cleared after cltTimeout of vserver

Use this method to set when enabled, if NS receives a DSS on a backup subflow, NS will start using that subflow to send data. And if disabled, NS will continue to transmit on current chosen subflow. In case there is some error on a subflow (like RTO's/RST etc.) then NS can choose a backup subflow irrespective of this tunable.

Use this method to set frequency, in seconds, at which the virtual servers learn the Maximum segment size (MSS) from the services. The argument to enable maximum segment size (MSS) for virtual servers must be enabled.

Use this method to set duration, in seconds, to sample the Maximum Segment Size (MSS) of the services. The Citrix ADC determines the best MSS to set for the virtual server based on this sampling. The argument to enable maximum segment size (MSS) for virtual servers must be enabled.

Use this method to set enable or disable the Nagle algorithm on TCP connections.

Use this method to set maximum size of out-of-order packets queue. A value of 0 means no limit.

Use this method to set maximum limit on the number of packets that should be retransmitted on receiving a partial ACK.

Use this method to set tCP Receive buffer size
NOTE: This attribute is deprecated.
This option is deprecated in favour of -buffersize

Use this method to set limits number of Challenge ACK sent per second, as recommended in RFC 5961(Improving TCP's Robustness to Blind In-Window Attacks)