ADC CLI Commands

ns-ip6

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

unset rm add show set

unset ns ip6

Modifies the parameters of an IPv6 address configured on the Citrix ADC..Refer to the set ns ip6 command for meanings of the arguments.

Synopsis

unset ns ip6 @ [-td ] [-ospfArea] [-nd] [-icmp] [-vServer] [-telnet] [-ftp] [-gui] [-ssh] [-snmp] [-mgmtAccess] [-ownerDownResponse] [-restrictAccess] [-state] [-map] [-decrementHopLimit] [-dynamicRouting] [-hostRoute] [-advertiseOnDefaultPartition] [-networkRoute] [-ip6hostRtGw] [-metric] [-vserverRHILevel] [-ospf6LSAType] [-tag] [-vrID6] [-ndOwner] [-mptcpAdvertise]

Example

unset ns ip6 2001::a -ospfArea

rm ns ip6

Removes an IPv6 address configured on the Citrix ADC.

Synopsis

rm ns ip6 @ [-td ]

Arguments

IPv6Address IPv6 address that you want to remove.

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. Minimum value: 0 Maximum value: 4094

Example

rm ns ip6 2002::5

add ns ip6

Creates an IPv6 address on the Citrix ADC.

Synopsis

add ns ip6 @ [-scope ( global | link-local )] [-type [-hostRoute ( ENABLED | DISABLED ) [-tag ] [-ip6hostRtGw <ipv6_addr|*>] [-metric ] [-vserverRHILevel ] [-ospf6LSAType ( INTRA_AREA | EXTERNAL ) [-ospfArea ]]] ] [-vlan ] [-nd ( 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 )] [-decrementHopLimit ( ENABLED | DISABLED )] [-advertiseOnDefaultPartition ( ENABLED | DISABLED )] [-networkRoute ( ENABLED | DISABLED )] [-state ( DISABLED | ENABLED )] [-map ] [-vrID6 ] [-ownerNode ] [-ownerDownResponse ( YES | NO )] [-td ] [-ndOwner ] [-mptcpAdvertise ( YES | NO )]

Arguments

IPv6Address IPv6 address to create on the Citrix ADC.

scope Scope of the IPv6 address to be created. Cannot be changed after the IP address is created.

Possible values: global, link-local Default value: global

type Type of IP address to be created on the Citrix ADC. Cannot be changed after the IP address is created.

Possible values: NSIP, VIP, SNIP, GSLBsiteIP, ADNSsvcIP, RADIUSListenersvcIP, CLIP Default value: SNIP

vlan The VLAN number. Default value: 0 Minimum value: 0 Maximum value: 4094

nd Respond to Neighbor Discovery (ND) 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 Enable or disable the state of all the virtual servers associated with this VIP6 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 address. This option is applicable forMIP6s, SNIP6s, and NSIP6s, 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

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

Possible values: ENABLED, DISABLED Default value: DISABLED

decrementHopLimit Decrement Hop Limit by 1 when ENABLED.This setting is applicable only for UDP traffic.

Possible values: ENABLED, DISABLED Default value: DISABLED

hostRoute Option to push the VIP6 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 SNIP6 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

ip6hostRtGw IPv6 address of the gateway for the route. If Gateway is not set, VIP uses :: as the gateway. Default value: 0

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

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

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

ospf6LSAType Type of LSAs to be used by the IPv6 OSPF protocol, running on the Citrix ADC, for advertising the route for the VIP6 address.

Possible values: INTRA_AREA, EXTERNAL Default value: EXTERNAL

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

state Enable or disable the IP address.

Possible values: DISABLED, ENABLED Default value: ENABLED

map Mapped IPV4 address for the IPV6 address.

vrID6 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

ownerNode ID of the cluster node for which you are adding the IP address. Must be used if you want the IP address to be active only on the specific node. Can be configured only through the cluster IP address. Cannot be changed after the IP address is created. Default value: 255 Minimum value: 0

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

Possible values: YES, NO Default value: YES

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. Minimum value: 0 Maximum value: 4094

ndOwner NdOwner in Cluster for VIPS and Striped SNIPS 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

add ns ip6 2001::a/96 -scope GLOBAL

show ns ip6

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

Synopsis

show ns ip6 [ [-td ]]

Arguments

IPv6Address IPv6 address whose settings you want the Citrix ADC to display.

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. Minimum value: 0 Maximum value: 4094

Output

scope Scope of the IPv6 address to be created. Cannot be changed after the IP address is created.

type The type of the IPV6 address

ipType The type of the IPv6 address

vlan The VLAN number.

nd Whether ND 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

state The state of the IPV6 address

state Current state of this IP.

map Mapped IPV4 address for the IPV6 address.

decrementHopLimit Decrement Hop Limit by 1 when ENABLED.This setting is applicable only for UDP traffic.

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

hostRoute Option to push the VIP6 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 SNIP6 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.

ip6hostRtGw IPv6 address of the gateway for the route. If Gateway is not set, VIP uses :: as the gateway.

metric The metric value to be added or subtracted from the cost of the route advertised for this IPv6 entity.

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

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

ospf6LSAType The OSPF’s route advertisement type.

ospfArea The area ID of the area in which OSPF INTRA AREA PREFIX LSAs should be advertised. When ospfArea is not set, LSAs are advertised in all areas.

ownerNode ID of the cluster node for which you are adding the IP address. Must be used if you want the IP address to be active only on the specific node. Can be configured only through the cluster IP address. Cannot be changed after the IP address is created.

stateflag vrID6 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.

cfgflags This contains the flags for IP in DB

ipRefcount Used to keep reference count of IPv6

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

systemType The type of the System. Possible Values: Standalone, HA, Cluster. Used for display purpose.

ndOwner NdOwner in Cluster for VIPS and Striped SNIPS

operationalndOwner Operational ND6 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 ip6

set ns ip6

Modifies the specified parameters of an IPv6 address configured on the Citrix ADC.

Synopsis

set ns ip6 (@ [-td ]) [-nd ( ENABLED | DISABLED )] [-icmp ( ENABLED | DISABLED )] [-vServer ( ENABLED | DISABLED )] [-telnet ( ENABLED | DISABLED )] [-ftp ( ENABLED | DISABLED )] [-gui ] [-ssh ( ENABLED | DISABLED )] [-snmp ( ENABLED | DISABLED )] [-mgmtAccess ( ENABLED | DISABLED )] [-ownerDownResponse ( YES | NO )] [-restrictAccess ( ENABLED | DISABLED )] [-state ( DISABLED | ENABLED )] [-map ] [-decrementHopLimit ( ENABLED | DISABLED )] [-dynamicRouting ( ENABLED | DISABLED )] [-hostRoute ( ENABLED | DISABLED )] [-advertiseOnDefaultPartition ( ENABLED | DISABLED )] [-networkRoute ( ENABLED | DISABLED )] [-ip6hostRtGw <ipv6_addr|*>] [-metric ] [-vserverRHILevel ] [-ospf6LSAType ( INTRA_AREA | EXTERNAL ) [-ospfArea ]] [-tag ] [-vrID6 ] [-ndOwner ] [-mptcpAdvertise ( YES | NO )]

Arguments

IPv6Address IPv6 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. Minimum value: 0 Maximum value: 4094

nd The state of ND responses for the entity.

Possible values: ENABLED, DISABLED Default value: ENABLED

icmp The state of ICMP responses for the entity.

Possible values: ENABLED, DISABLED Default value: ENABLED

vServer The state of vserver attribute for this IP entity.

Possible values: ENABLED, DISABLED Default value: ENABLED

telnet The state of telnet access to this IP entity.

Possible values: ENABLED, DISABLED Default value: ENABLED

ftp The state of ftp access to this IP entity.

Possible values: ENABLED, DISABLED Default value: ENABLED

gui The state of GUI access to this IP entity.

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

ssh The state of SSH access to this IP entity.

Possible values: ENABLED, DISABLED Default value: ENABLED

snmp The state of SNMP access to this IP entity.

Possible values: ENABLED, DISABLED Default value: ENABLED

mgmtAccess The state of management access to this IP entity.

Possible values: ENABLED, DISABLED Default value: DISABLED

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

Possible values: YES, NO Default value: YES

restrictAccess Status of ports not used for management access (blocked/open) for the entity.

Possible values: ENABLED, DISABLED Default value: DISABLED

state Enable or disable the IP address.

Possible values: DISABLED, ENABLED Default value: ENABLED

map Mapped IPV4 address for the IPV6 address.

decrementHopLimit Decrement Hop Limit 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 IPv6 (SNIP6) address.

Possible values: ENABLED, DISABLED Default value: DISABLED

hostRoute Option to push the VIP6 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 SNIP6 subnet to ZebOS routing table for Kernel route redistribution through dynamic routing protocol.

Possible values: ENABLED, DISABLED

ip6hostRtGw IPv6 address of the gateway for the route. If Gateway is not set, VIP uses :: as the gateway. Default value: 0

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

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

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

ospf6LSAType Type of LSAs to be used by the IPv6 OSPF protocol, running on the Citrix ADC, for advertising the route for the VIP6 address.

Possible values: INTRA_AREA, EXTERNAL Default value: EXTERNAL

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

vrID6 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

ndOwner NdOwner in Cluster for VIPS and Striped SNIPS 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 ip6 2001::a -map 10.102.33.27

ns-ip6