| getnsipResult Structure Definition |
The getnsipResult structure defines the return type for getnsip API. |
Syntax |
Members |
rc |
If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings. |
message |
If the method succeeds, message is NULL else message contains Error/Warning message. |
nsipList |
List of nsips |
| nsip Structure Definition |
The nsip structure defines the actual return type values for getnsip API. |
Syntax |
Members |
ipaddress |
IPv4 address whose details you want the Citrix ADC to display. |
type |
Display the settings of all IPv4 addresses of a particular type. |
netmask |
The netmask of this IP. |
flags |
The flags for this entry. |
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. NOTE: This attribute is deprecated. |
ospf |
Whether ospf is enabled or disabled. NOTE: This attribute is deprecated. |
rip |
Whether rip is enabled or disabled. NOTE: This attribute is deprecated. |
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. NOTE: This attribute is deprecated. Replaced by ospfAreaval |
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. |
ownerdownresponse |
in cluster system, if the owner node is down, whether should it respond to icmp/arp |
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. |
_nextgenapiresource |
See Also |