| addnsip |
Use this method to creates an IPv4 address on the Citrix ADC. |
Syntax |
Parameters |
ipaddress |
IPv4 address to create on the Citrix ADC. Cannot be changed after the IP address is created. This is mandatory parameter. |
netmask |
Subnet mask associated with the IP address. This is mandatory parameter. |
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. Default value = NSADDR_SNIP. |
arp |
Respond to ARP requests for this IP address. Default value = ENABLED. |
icmp |
Respond to ICMP requests for this IP address. Default value = ENABLED. |
vserver |
Use this option to set (enable or disable) the virtual server attribute for this IP address. Default value = ENABLED. |
telnet |
Allow Telnet access to this IP address. Default value = ENABLED. |
ftp |
Allow File Transfer Protocol (FTP) access to this IP address. Default value = ENABLED. |
gui |
Allow graphical user interface (GUI) access to this IP address. Default value = ENABLED. |
ssh |
Allow secure shell (SSH) access to this IP address. Default value = ENABLED. |
snmp |
Allow Simple Network Management Protocol (SNMP) access to this IP address. Default value = ENABLED. |
mgmtaccess |
Allow access to management applications on this IP address. 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. Default value = DISABLED. |
dynamicrouting |
Allow dynamic routing on this IP address. Specific to Subnet IP (SNIP) address. Default value = DISABLED. |
decrementttl |
Decrement TTL by 1 when ENABLED.This setting is applicable only for UDP traffic. Default value = DISABLED. |
hostroute |
Option to push the VIP to ZebOS routing table for Kernel route redistribution through dynamic routing protocols |
advertiseondefaultpartition |
Advertise VIPs from Shared VLAN on Default Partition. Default value = 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. 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.
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.
Default value = RHI_STATE_ONE. |
ospflsatype |
Type of LSAs to be used by the OSPF protocol, running on the Citrix ADC, for advertising the route for this VIP address. Default value = DISABLED. |
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. Maximum value = 4294967294LU. |
state |
Enable or disable the IP address. Default value = ENABLED. |
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. Default value = NS_IP_NONE. |
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. Default value = NS_IP_NONE. |
ownerdownresponse |
in cluster system, if the owner node is down, whether should it respond to icmp/arp 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. Default value = NO. |
Return Value |
Returns simpleResult |
See Also |