Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

nsip6

May 23, 2024
Contributed by: 
C

Configuration for ip6 resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
ipv6address Read-write IPv6 address to create on the Citrix ADC.

Minimum length = 1
scope Read-write Scope of the IPv6 address to be created. Cannot be changed after the IP address is created.

Default value: global

Possible values = global, link-local
type Read-write Type of IP address to be created on the Citrix ADC. Cannot be changed after the IP address is created.

Default value: SNIP

Possible values = NSIP, VIP, SNIP, GSLBsiteIP, ADNSsvcIP, RADIUSListenersvcIP, CLIP
vlan Read-write The VLAN number.

Default value: 0

Minimum value = 0

Maximum value = 4094
nd Read-write Respond to Neighbor Discovery (ND) requests for this IP address.

Default value: ENABLED

Possible values = ENABLED, DISABLED
icmp Read-write Respond to ICMP requests for this IP address.

Default value: ENABLED

Possible values = ENABLED, DISABLED
vserver Read-write Enable or disable the state of all the virtual servers associated with this VIP6 address.

Default value: ENABLED

Possible values = ENABLED, DISABLED
telnet Read-write Allow Telnet access to this IP address.

Default value: ENABLED

Possible values = ENABLED, DISABLED
ftp Read-write Allow File Transfer Protocol (FTP) access to this IP address.

Default value: ENABLED

Possible values = ENABLED, DISABLED
gui Read-write Allow graphical user interface (GUI) access to this IP address.

Default value: ENABLED

Possible values = ENABLED, SECUREONLY, DISABLED
ssh Read-write Allow secure Shell (SSH) access to this IP address.

Default value: ENABLED

Possible values = ENABLED, DISABLED
snmp Read-write Allow Simple Network Management Protocol (SNMP) access to this IP address.

Default value: ENABLED

Possible values = ENABLED, DISABLED
mgmtaccess Read-write Allow access to management applications on this IP address.

Default value: DISABLED

Possible values = ENABLED, DISABLED
restrictaccess Read-write 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.

Default value: DISABLED

Possible values = ENABLED, DISABLED
dynamicrouting Read-write Allow dynamic routing on this IP address. Specific to Subnet IPv6 (SNIP6) address.

Default value: DISABLED

Possible values = ENABLED, DISABLED
decrementhoplimit Read-write Decrement Hop Limit by 1 when ENABLED.This setting is applicable only for UDP traffic.

Default value: DISABLED

Possible values = ENABLED, DISABLED
hostroute Read-write Option to push the VIP6 to ZebOS routing table for Kernel route redistribution through dynamic routing protocols.

Possible values = ENABLED, DISABLED
advertiseondefaultpartition Read-write Advertise VIPs from Shared VLAN on Default Partition.

Default value: DISABLED

Possible values = ENABLED, DISABLED
networkroute Read-write Option to push the SNIP6 subnet to ZebOS routing table for Kernel route redistribution through dynamic routing protocol.

Possible values = ENABLED, DISABLED
tag Read-write Tag value for the network/host route associated with this IP.

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

Default value: 0
metric Read-write Integer value to add to or subtract from the cost of the route advertised for the VIP6 address.

Minimum value = -16777215
vserverrhilevel Read-write 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. Default value: ONE_VSERVER Possible values = ONE_VSERVER, ALL_VSERVERS, NONE, VSVR_CNTRLD
    		•
    ospf6lsatype Read-write Type of LSAs to be used by the IPv6 OSPF protocol, running on the Citrix ADC, for advertising the route for the VIP6 address.

    Default value: EXTERNAL

    Possible values = INTRA_AREA, EXTERNAL
    ospfarea Read-write 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 Read-write Enable or disable the IP address.

    Default value: ENABLED

    Possible values = DISABLED, ENABLED
    map Read-write Mapped IPV4 address for the IPV6 address.
    vrid6 Read-write 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 Read-write 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
    ownerdownresponse Read-write in cluster system, if the owner node is down, whether should it respond to icmp/arp.

    Default value: YES

    Possible values = YES, NO
    td Read-write 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 Read-write NdOwner in Cluster for VIPS and Striped SNIPS.

    Default value: 255
    mptcpadvertise Read-write If enabled, this IP will be advertised by Citrix ADC to MPTCP enabled clients as part of ADD_ADDR option.

    Default value: NO

    Possible values = YES, NO
    iptype <String[]> Read-only The type of the IPv6 address.

    Possible values = NSIP, VIP, SNIP, GSLBsiteIP, ADNSsvcIP, RADIUSListenersvcIP, CLIP
    curstate Read-only Current state of this IP.

    Default value: ENABLED

    Possible values = DISABLED, ENABLED
    viprtadv2bsd Read-only Whether this route is advertised to FreeBSD.
    vipvsercount Read-only Number of vservers bound to this VIP.
    vipvserdowncount Read-only Number of vservers bound to this VIP, which are down.
    systemtype Read-only The type of the System. Possible Values: Standalone, HA, Cluster. Used for display purpose.

    Possible values = Stand-alone, HA, Cluster
    operationalndowner Read-only Operational ND6 Owner.
    __count Read-only count parameter

    Operations

    (click to see Properties )

    • ADD
    • DELETE
    • UPDATE
    • UNSET
    • GET (ALL)
    • COUNT

    Some options that you can use for each operations:

    • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

      http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

      If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.

    • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

      To do this, you must specify the username and password in the request header of the NITRO request as follows:

      X-NITRO-USER: <username>

      X-NITRO-PASS: <password>

      Note: In such cases, make sure that the request header DOES not include the following:

      Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    *Note: * Mandatory parameters are marked in red and placeholder content is marked in green

    add

    URL: http:// <netscaler-ip-address> /nitro/v1/config/nsip6 HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    {"nsip6":{
<b>"ipv6address":<String_value>,
</b>"scope":<String_value>,
"type":<String_value>,
"vlan":<Double_value>,
"nd":<String_value>,
"icmp":<String_value>,
"vserver":<String_value>,
"telnet":<String_value>,
"ftp":<String_value>,
"gui":<String_value>,
"ssh":<String_value>,
"snmp":<String_value>,
"mgmtaccess":<String_value>,
"restrictaccess":<String_value>,
"dynamicrouting":<String_value>,
"decrementhoplimit":<String_value>,
"hostroute":<String_value>,
"advertiseondefaultpartition":<String_value>,
"networkroute":<String_value>,
"tag":<Double_value>,
"ip6hostrtgw":<String_value>,
"metric":<Integer_value>,
"vserverrhilevel":<String_value>,
"ospf6lsatype":<String_value>,
"ospfarea":<Double_value>,
"state":<String_value>,
"map":<String_value>,
"vrid6":<Double_value>,
"ownernode":<Double_value>,
"ownerdownresponse":<String_value>,
"td":<Double_value>,
"ndowner":<Double_value>,
"mptcpadvertise":<String_value>
}}

<!--NeedCopy-->

    Response: HTTP Status Code on Success: 201 Created

    HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

    delete

    URL: http:// <netscaler-ip-address> /nitro/v1/config/nsip6/ ipv6address_value<String> Query-parameters: args=td: <Double_value>

    </b>

    HTTP Method: DELETE

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Response: HTTP Status Code on Success: 200 OK

    HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

    update

    URL: http:// <netscaler-ip-address> /nitro/v1/config/nsip6 HTTP Method: PUT

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    {"nsip6":{
<b>"ipv6address":<String_value>,
</b>"td":<Double_value>,
"nd":<String_value>,
"icmp":<String_value>,
"vserver":<String_value>,
"telnet":<String_value>,
"ftp":<String_value>,
"gui":<String_value>,
"ssh":<String_value>,
"snmp":<String_value>,
"mgmtaccess":<String_value>,
"ownerdownresponse":<String_value>,
"restrictaccess":<String_value>,
"state":<String_value>,
"map":<String_value>,
"decrementhoplimit":<String_value>,
"dynamicrouting":<String_value>,
"hostroute":<String_value>,
"advertiseondefaultpartition":<String_value>,
"networkroute":<String_value>,
"ip6hostrtgw":<String_value>,
"metric":<Integer_value>,
"vserverrhilevel":<String_value>,
"ospf6lsatype":<String_value>,
"ospfarea":<Double_value>,
"tag":<Double_value>,
"vrid6":<Double_value>,
"ndowner":<Double_value>,
"mptcpadvertise":<String_value>
}}

<!--NeedCopy-->

    Response: HTTP Status Code on Success: 200 OK

    HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

    unset

    URL: http:// <netscaler-ip-address> /nitro/v1/config/nsip6? action=unset HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    {"nsip6":{
<b>"ipv6address":<String_value>,
</b>"td":<Double_value>,
"ospfarea":true,
"nd":true,
"icmp":true,
"vserver":true,
"telnet":true,
"ftp":true,
"gui":true,
"ssh":true,
"snmp":true,
"mgmtaccess":true,
"ownerdownresponse":true,
"restrictaccess":true,
"state":true,
"map":true,
"decrementhoplimit":true,
"dynamicrouting":true,
"hostroute":true,
"advertiseondefaultpartition":true,
"networkroute":true,
"ip6hostrtgw":true,
"metric":true,
"vserverrhilevel":true,
"ospf6lsatype":true,
"tag":true,
"vrid6":true,
"ndowner":true,
"mptcpadvertise":true
}}

<!--NeedCopy-->

    Response: HTTP Status Code on Success: 200 OK

    HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

    get (all)

    URL: http:// <netscaler-ip-address> /nitro/v1/config/nsip6 Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/nsip6? attrs=property-name1,property-name2

    Use this query parameter to specify the resource details that you want to retrieve.

    filter http:// <netscaler-ip-address> /nitro/v1/config/nsip6? filter=property-name1:property-val1,property-name2:property-val2

    Use this query-parameter to get the filtered set of nsip6 resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

    view http:// <netscaler-ip-address> /nitro/v1/config/nsip6? view=summary

    Use this query-parameter to get the summary output of nsip6 resources configured on NetScaler.

    Note: By default, the retrieved results are displayed in detail view (?view=detail).

    pagination http:// <netscaler-ip-address> /nitro/v1/config/nsip6? pagesize=#no;pageno=#no

    Use this query-parameter to get the nsip6 resources in chunks.

    HTTP Method: GET

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Accept:application/json

    Response: HTTP Status Code on Success: 200 OK

    HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

    Response Header:

    Content-Type:application/json

    Response Payload: 

    { "nsip6": [ {
"ipv6address":<String_value>,
"td":<Double_value>,
"scope":<String_value>,
"type":<String_value>,
"iptype":<String[]_value>,
"vlan":<Double_value>,
"nd":<String_value>,
"icmp":<String_value>,
"vserver":<String_value>,
"telnet":<String_value>,
"ssh":<String_value>,
"gui":<String_value>,
"snmp":<String_value>,
"ftp":<String_value>,
"mgmtaccess":<String_value>,
"restrictaccess":<String_value>,
"state":<String_value>,
"curstate":<String_value>,
"map":<String_value>,
"decrementhoplimit":<String_value>,
"dynamicrouting":<String_value>,
"hostroute":<String_value>,
"advertiseondefaultpartition":<String_value>,
"networkroute":<String_value>,
"tag":<Double_value>,
"ip6hostrtgw":<String_value>,
"metric":<Integer_value>,
"vserverrhilevel":<String_value>,
"viprtadv2bsd":<Boolean_value>,
"vipvsercount":<Double_value>,
"vipvserdowncount":<Double_value>,
"ospf6lsatype":<String_value>,
"ospfarea":<Double_value>,
"ownernode":<Double_value>,
"vrid6":<Double_value>,
"ownerdownresponse":<String_value>,
"systemtype":<String_value>,
"ndowner":<Double_value>,
"operationalndowner":<Double_value>,
"mptcpadvertise":<String_value>
}]}

<!--NeedCopy-->

    count

    URL: http:// <netscaler-ip-address> /nitro/v1/config/nsip6? count=yes HTTP Method: GET

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Accept:application/json

    Response: HTTP Status Code on Success: 200 OK

    HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

    Response Header:

    Content-Type:application/json

    Response Payload: 

    { "nsip6": [ { "__count": "#no"} ] }

<!--NeedCopy-->
    nsip6
    May 23, 2024
    Contributed by: 
    C
    May 23, 2024
    Contributed by: 
    C

    In this article

    Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
    © 1999- Cloud Software Group, Inc. All rights reserved.