ADC CLI Commands

ns-ip

May 28, 2024

Contributed by:

The following operations can be performed on “ns-ip”:

set ns ip

Modifies the parameters of an IPv4 address configured on the Citrix ADC.

Synopsis

set ns ip (@ \[-td <positive\_integer>]) \[-netmask ] \[-arp \( ENABLED | DISABLED )] \[-icmp \( ENABLED | DISABLED )] \[-vServer \( ENABLED | DISABLED )] \[-telnet \( ENABLED | DISABLED )] \[-ftp \( ENABLED | DISABLED )] \[-gui ] \[-ssh \( ENABLED | DISABLED )] \[-snmp \( ENABLED | DISABLED )] \[-mgmtAccess \( ENABLED | DISABLED )] \[-restrictAccess \( ENABLED | DISABLED )] \[-decrementTTL \( ENABLED | DISABLED )] \[-dynamicRouting \( ENABLED | DISABLED )] \[-hostRoute \( ENABLED | DISABLED )] \[-advertiseOnDefaultPartition \( ENABLED | DISABLED )] \[-networkRoute \( ENABLED | DISABLED )] \[-hostRtGw <ip\_addr>] \[-metric ] \[-vserverRHILevel ] \[-ospfLSAType \( TYPE1 | TYPE5 ) \[-ospfArea <positive\_integer>]] \[-tag <positive\_integer>] \[-vrID <positive\_integer>] \[-icmpResponse ] \[-arpResponse ] \[-ownerDownResponse \( YES | NO )] \[-arpOwner <positive\_integer>] \[-mptcpAdvertise \( YES | NO )]

Arguments

IPAddress IPv4 address whose parameters you want to modify.

td Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0. TD id 4095 is used reserved for LSN use Minimum value: 0 Maximum value: 4095

netmask Subnet mask associated with the IP address.

arp Respond to ARP requests for this IP address.

Possible values: ENABLED, DISABLED Default value: ENABLED

icmp Respond to ICMP requests for this IP address.

Possible values: ENABLED, DISABLED Default value: ENABLED

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

Possible values: ENABLED, DISABLED Default value: ENABLED

telnet Allow Telnet access to this IP address.

Possible values: ENABLED, DISABLED Default value: ENABLED

ftp Allow File Transfer Protocol (FTP) access to this IP address.

Possible values: ENABLED, DISABLED Default value: ENABLED

gui Allow graphical user interface (GUI) access to this IP address.

Possible values: ENABLED, SECUREONLY, DISABLED Default value: ENABLED

ssh Allow secure shell (SSH) access to this IP address.

Possible values: ENABLED, DISABLED Default value: ENABLED

snmp Allow Simple Network Management Protocol (SNMP) access to this IP address.

Possible values: ENABLED, DISABLED Default value: ENABLED

mgmtAccess Allow access to management applications on this IP address.

Possible values: ENABLED, DISABLED Default value: DISABLED

restrictAccess 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.

Possible values: ENABLED, DISABLED Default value: DISABLED

decrementTTL Decrement TTL by 1 when ENABLED.This setting is applicable only for UDP traffic.

Possible values: ENABLED, DISABLED Default value: DISABLED

dynamicRouting Allow dynamic routing on this IP address. Specific to Subnet IP (SNIP) address.

Possible values: ENABLED, DISABLED Default value: DISABLED

hostRoute Option to push the VIP to ZebOS routing table for Kernel route redistribution through dynamic routing protocols

Possible values: ENABLED, DISABLED

advertiseOnDefaultPartition Advertise VIPs from Shared VLAN on Default Partition.

Possible values: ENABLED, DISABLED Default value: DISABLED

networkRoute Option to push the SNIP subnet to ZebOS routing table for Kernel route redistribution through dynamic routing protocol.

Possible values: ENABLED, DISABLED

hostRtGw IP address of the gateway of the route for this VIP address. Default value: -1

metric Integer value to add to or subtract from the cost of the route advertised for the VIP address. Minimum value: -16777215

vserverRHILevel 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.

Possible values: ONE_VSERVER, ALL_VSERVERS, NONE, VSVR_CNTRLD Default value: ONE_VSERVER

ospfLSAType Type of LSAs to be used by the OSPF protocol, running on the Citrix ADC, for advertising the route for this VIP address.

Possible values: TYPE1, TYPE5 Default value: TYPE5

ospfArea 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. Default value: -1 Minimum value: 0 Maximum value: 4294967294LU

tag Tag value for the network/host route associated with this IP. Default value: 0 Minimum value: 0

vrID 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. Minimum value: 1 Maximum value: 255

icmpResponse 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.

Possible values: NONE, ONE_VSERVER, ALL_VSERVERS, VSVR_CNTRLD Default value: 5

arpResponse 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.

Possible values: NONE, ONE_VSERVER, ALL_VSERVERS Default value: 5

ownerDownResponse in cluster system, if the owner node is down, whether should it respond to icmp/arp

Possible values: YES, NO Default value: YES

arpOwner The arp owner in a Cluster for this IP address. It can vary from 0 to 31. Default value: 255 Minimum value: 0

mptcpAdvertise If enabled, this IP will be advertised by Citrix ADC to MPTCP enabled clients as part of ADD_ADDR option.

Possible values: YES, NO Default value: NO

Example

set ns ip 10.102.4.123 -arp ENABLED

show ns ip

Displays 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 command without any parameters. To display settings of a particular IPv4 address, specify the IPv4 address.

Synopsis

show ns ip [ [-td ]] [-type ]

Arguments

IPAddress IPv4 address whose details you want the Citrix ADC to display.

type Display the settings of all IPv4 addresses of a particular type.

Possible values: SNIP, VIP, NSIP, HostIP, GSLBsiteIP, CLIP Default value: 0

Output

netmask The netmask of this IP.

flags The flags for this entry.

ipAttribute arp Whether arp is enabled or disabled.

icmp Whether icmp is enabled or disabled.

vServer Whether vserver is enabled or disabled.

telnet Whether telnet is enabled or disabled.

ssh Whether ssh is enabled or disabled.

gui Whether gui is (enabled|SecureOnly|disabled).

snmp Whether snmp is enabled or disabled.

ftp Whether ftp is enabled or disabled.

mgmtAccess Whether management access is enabled or disabled.

restrictAccess Blocking of all ports not used for management access enabled or disabled

decrementTTL Decrement TTL by 1 when ENABLED.This setting is applicable only for UDP traffic.

dynamicRouting Whether dynamic routing is enabled or disabled.

bgp Whether bgp is enabled or disabled.

ospf Whether ospf is enabled or disabled.

rip Whether rip is enabled or disabled.

hostRoute Option to push the VIP to ZebOS routing table for Kernel route redistribution through dynamic routing protocols

advertiseOnDefaultPartition Whether advertisment of VIPs of Shared VLAN is enabled or disabled.

networkRoute Option to push the SNIP subnet to ZebOS routing table for Kernel route redistribution through dynamic routing protocol.

tag Tag value for the network/host route associated with this IP.

hostRtGw Gateway used for advertising host route.

hostRtGwAct Actual Gateway used for advertising host route.

metric The metric value added or subtracted from the cost of the route.

ospfArea The area ID of the area in which OSPF Type1 LSAs are advertised. When ospfArea if not set, LSAs are advertised on all areas.

ospfAreaval The area ID of the area in which OSPF Type1 LSAs are advertised.

vserverRHILevel The rhi level for this IP.

VIPrtadv2BSD Whether this route is advertised to FreeBSD

VIPvserCount Number of vservers bound to this VIP

VIPvserDownCount Number of vservers bound to this VIP, which are down

VIPvsrvrRHIActiveCount Number of vservers that have RHI state ACTIVE

VIPvsrvrRHIActiveUpCount Number of vservers that have RHI state ACTIVE, which are UP

ospfLSAType The ospf lsa type to use while advertising this IP.

state Whether this ip is enabled or disabled.

freePorts Number of free Ports available on this IP

vrID 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.

ipType icmpResponse 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.

ownerNode The owner node in a Cluster for this IP address. Owner node can vary from 0 to 31. If ownernode is not specified then the IP is treated as Striped IP.

arpResponse 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.

stateflag ownerDownResponse in cluster system, if the owner node is down, whether should it respond to icmp/arp

cfgflags This contains the flags for IP in DB

ipRefcount Used to keep reference count of IP

arpOwner The arp owner in a Cluster for this IP address. It can vary from 0 to 31.

operationalarpOwner Run time operational Arp Owner

mptcpAdvertise If enabled, this IP will be advertised by Citrix ADC to MPTCP enabled clients as part of ADD_ADDR option.

devno count

Example

show ns ip Ipaddress Type Mode Arp Icmp Vserver State Owner ——— —- —- — —- ——- —– —– 1)10.102.169.16 Cluster IP Active Enabled Enabled NA Enabled Configuration Coordinator 2)10.102.169.18 NetScaler IP Active Enabled Enabled NA Enabled 1 3)10.102.169.19 NetScaler IP Active Enabled Enabled NA Enabled 2 4)10.102.169.17 VIP Active Enabled Enabled Enabled Enabled ALL

add ns ip

Creates an IPv4 address on the Citrix ADC.

Synopsis

add ns ip @ \[-type \[-hostRoute \( ENABLED | DISABLED ) \[-tag <positive\_integer>] \[-hostRtGw <ip\_addr>] \[-metric ] \[-vserverRHILevel ] \[-ospfLSAType \( TYPE1 | TYPE5 ) \[-ospfArea <positive\_integer>]]] ] \[-arp \( ENABLED | DISABLED )] \[-icmp \( ENABLED | DISABLED )] \[-vServer \( ENABLED | DISABLED )] \[-telnet \( ENABLED | DISABLED )] \[-ftp \( ENABLED | DISABLED )] \[-gui ] \[-ssh \( ENABLED | DISABLED )] \[-snmp \( ENABLED | DISABLED )] \[-mgmtAccess \( ENABLED | DISABLED )] \[-restrictAccess \( ENABLED | DISABLED )] \[-dynamicRouting \( ENABLED | DISABLED )] \[-decrementTTL \( ENABLED | DISABLED )] \[-advertiseOnDefaultPartition \( ENABLED | DISABLED )] \[-networkRoute \( ENABLED | DISABLED )] \[-state \( ENABLED | DISABLED )] \[-vrID <positive\_integer>] \[-icmpResponse ] \[-ownerNode <positive\_integer>] \[-arpResponse ] \[-ownerDownResponse \( YES | NO )] \[-td <positive\_integer>] \[-arpOwner <positive\_integer>] \[-mptcpAdvertise \( YES | NO )]

Arguments

IPAddress IPv4 address to create on the Citrix ADC. Cannot be changed after the IP address is created.

netmask Subnet mask associated with the IP address.

type Type of the IP address to create on the Citrix ADC. Cannot be changed after the IP address is created. The following are the different types of Citrix ADC owned IP addresses:

A Subnet IP (SNIP) address is used by the Citrix ADC to communicate with the servers. The Citrix ADC also uses the subnet IP address when generating its own packets, such as packets related to dynamic routing protocols, or to send monitor probes to check the health of the servers.
A Virtual IP (VIP) address is the IP address associated with a virtual server. It is the IP address to which clients connect. An appliance managing a wide range of traffic may have many VIPs configured. Some of the attributes of the VIP address are customized to meet the requirements of the virtual server.
A GSLB site IP (GSLBIP) address is associated with a GSLB site. It is not mandatory to specify a GSLBIP address when you initially configure the Citrix ADC. A GSLBIP address is used only when you create a GSLB site.
A Cluster IP (CLIP) address is the management address of the cluster. All cluster configurations must be performed by accessing the cluster through this IP address.

Possible values: SNIP, VIP, NSIP, HostIP, GSLBsiteIP, CLIP Default value: SNIP

arp Respond to ARP requests for this IP address.

Possible values: ENABLED, DISABLED Default value: ENABLED

icmp Respond to ICMP requests for this IP address.

Possible values: ENABLED, DISABLED Default value: ENABLED

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

Possible values: ENABLED, DISABLED Default value: ENABLED

telnet Allow Telnet access to this IP address.

Possible values: ENABLED, DISABLED Default value: ENABLED

ftp Allow File Transfer Protocol (FTP) access to this IP address.

Possible values: ENABLED, DISABLED Default value: ENABLED

gui Allow graphical user interface (GUI) access to this IP address.

Possible values: ENABLED, SECUREONLY, DISABLED Default value: ENABLED

ssh Allow secure shell (SSH) access to this IP address.

Possible values: ENABLED, DISABLED Default value: ENABLED

snmp Allow Simple Network Management Protocol (SNMP) access to this IP address.

Possible values: ENABLED, DISABLED Default value: ENABLED

mgmtAccess Allow access to management applications on this IP address.

Possible values: ENABLED, DISABLED Default value: DISABLED

dynamicRouting Allow dynamic routing on this IP address. Specific to Subnet IP (SNIP) address.

Possible values: ENABLED, DISABLED Default value: DISABLED

decrementTTL Decrement TTL by 1 when ENABLED.This setting is applicable only for UDP traffic.

Possible values: ENABLED, DISABLED Default value: DISABLED

hostRoute Option to push the VIP to ZebOS routing table for Kernel route redistribution through dynamic routing protocols

Possible values: ENABLED, DISABLED

advertiseOnDefaultPartition Advertise VIPs from Shared VLAN on Default Partition.

Possible values: ENABLED, DISABLED Default value: DISABLED

networkRoute Option to push the SNIP subnet to ZebOS routing table for Kernel route redistribution through dynamic routing protocol.

Possible values: ENABLED, DISABLED

tag Tag value for the network/host route associated with this IP. Default value: 0 Minimum value: 0

hostRtGw IP address of the gateway of the route for this VIP address. Default value: -1

metric Integer value to add to or subtract from the cost of the route advertised for the VIP address. Minimum value: -16777215

vserverRHILevel 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.

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.

Possible values: ONE_VSERVER, ALL_VSERVERS, NONE, VSVR_CNTRLD Default value: ONE_VSERVER

ospfLSAType Type of LSAs to be used by the OSPF protocol, running on the Citrix ADC, for advertising the route for this VIP address.

Possible values: TYPE1, TYPE5 Default value: TYPE5

state Enable or disable the IP address.

Possible values: ENABLED, DISABLED Default value: ENABLED

icmpResponse 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.

Possible values: NONE, ONE_VSERVER, ALL_VSERVERS, VSVR_CNTRLD Default value: 5

ownerNode The owner node in a Cluster for this IP address. Owner node can vary from 0 to 31. If ownernode is not specified then the IP is treated as Striped IP. Default value: 255 Minimum value: 0

arpResponse 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.

Possible values: NONE, ONE_VSERVER, ALL_VSERVERS Default value: 5

ownerDownResponse in cluster system, if the owner node is down, whether should it respond to icmp/arp

Possible values: YES, NO Default value: YES

disable ns ip (@ [-td ])

Arguments

IPAddress IP address that you want to disable.

Example

disable ns ip 10.10.10.10

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

ns-ip

May 28, 2024

Contributed by:

May 28, 2024

Contributed by:

ns-ip

set ns ip

Synopsis

Arguments

Example

show ns ip

Synopsis

Arguments

Output

Example

add ns ip

Synopsis

Arguments

Example

unset ns ip

Synopsis

Example

enable ns ip

Synopsis

Arguments

Example

rm ns ip

Synopsis

Arguments

Example

disable ns ip

Synopsis

Arguments

Example

In this article