getnsip6Result Structure Definition

The getnsip6Result structure defines the return type for getnsip6 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.

nsip6List

List of nsip6s


nsip6 Structure Definition

The nsip6 structure defines the actual return type values for getnsip6 API.

Syntax



Members

ipv6address

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

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
NOTE: This attribute is deprecated.
This option is deprecated in favour of ip6_type

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

state2

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.

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.

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.

icmpresponse

Respond to ICMPv6 requests for a Virtual IP (VIP) address on the basis of the states of the virtual servers associated with that VIP

_nextgenapiresource


See Also