nsip
Configuration for ip resource.
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| ipaddress | <String> | Read-write | IPv4 address to create on the NetScaler appliance. Cannot be changed after the IP address is created.<br>Minimum length = 1 |
| netmask | <String> | Read-write | Subnet mask associated with the IP address. |
| type | <String> | Read-write | Type of the IP address to create on the NetScaler appliance. Cannot be changed after the IP address is created. The following are the different types of NetScaler owned IP addresses: * A Subnet IP (SNIP) address is used by the NetScaler ADC to communicate with the servers. The NetScaler 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 NetScaler appliance. 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.<br>Default value: SNIP<br>Possible values = SNIP, VIP, NSIP, GSLBsiteIP, CLIP |
| arp | <String> | Read-write | Respond to ARP requests for this IP address.<br>Default value: ENABLED<br>Possible values = ENABLED, DISABLED |
| icmp | <String> | Read-write | Respond to ICMP requests for this IP address.<br>Default value: ENABLED<br>Possible values = ENABLED, DISABLED |
| vserver | <String> | Read-write | Use this option to set (enable or disable) the virtual server attribute for this IP address.<br>Default value: ENABLED<br>Possible values = ENABLED, DISABLED |
| telnet | <String> | Read-write | Allow Telnet access to this IP address.<br>Default value: ENABLED<br>Possible values = ENABLED, DISABLED |
| ftp | <String> | Read-write | Allow File Transfer Protocol (FTP) access to this IP address.<br>Default value: ENABLED<br>Possible values = ENABLED, DISABLED |
| gui | <String> | Read-write | Allow graphical user interface (GUI) access to this IP address.<br>Default value: ENABLED<br>Possible values = ENABLED, SECUREONLY, DISABLED |
| ssh | <String> | Read-write | Allow secure shell (SSH) access to this IP address.<br>Default value: ENABLED<br>Possible values = ENABLED, DISABLED |
| snmp | <String> | Read-write | Allow Simple Network Management Protocol (SNMP) access to this IP address.<br>Default value: ENABLED<br>Possible values = ENABLED, DISABLED |
| mgmtaccess | <String> | Read-write | Allow access to management applications on this IP address.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED |
| restrictaccess | <String> | Read-write | 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 NetScaler Free BSD operating system.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED |
| dynamicrouting | <String> | Read-write | Allow dynamic routing on this IP address. Specific to Subnet IP (SNIP) address.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED |
| ospf | <String> | Read-write | Use this option to enable or disable OSPF on this IP address for the entity.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED |
| bgp | <String> | Read-write | Use this option to enable or disable BGP on this IP address for the entity.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED |
| rip | <String> | Read-write | Use this option to enable or disable RIP on this IP address for the entity.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED |
| hostroute | <String> | Read-write | Advertise a route for the VIP address using the dynamic routing protocols running on the NetScaler appliance.<br>Possible values = ENABLED, DISABLED |
| hostrtgw | <String> | Read-write | IP address of the gateway of the route for this VIP address.<br>Default value: -1 |
| metric | <Integer> | Read-write | Integer value to add to or subtract from the cost of the route advertised for the VIP address.<br>Minimum value = -16777215 |
| vserverrhilevel | <String> | Read-write | 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 NetScaler ADC always advertises the route for the VIP address. * If you set RHI STATE to ACTIVE on all virtual servers, the NetScaler 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 NetScaler 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.<br>Default value: ONE_VSERVER<br>Possible values = ONE_VSERVER, ALL_VSERVERS, NONE, VSVR_CNTRLD |
| vserverrhimode | <String> | Read-write | Advertise the route for the Virtual IP (VIP) address using dynamic routing protocols or using RISE * DYNMAIC_ROUTING - Advertise the route for the VIP address using dynamic routing protocols (default) * RISE - Advertise the route for the VIP address using RISE.<br>Default value: DYNAMIC_ROUTING<br>Possible values = DYNAMIC_ROUTING, RISE |
| ospflsatype | <String> | Read-write | Type of LSAs to be used by the OSPF protocol, running on the NetScaler appliance, for advertising the route for this VIP address.<br>Default value: DISABLED<br>Possible values = TYPE1, TYPE5 |
| ospfarea | <Double> | Read-write | 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 NetScaler appliance. When this parameter is not set, the VIP is advertised on all areas.<br>Default value: -1<br>Minimum value = 0<br>Maximum value = 4294967294LU |
| state | <String> | Read-write | Enable or disable the IP address.<br>Default value: ENABLED<br>Possible values = ENABLED, DISABLED |
| vrid | <Double> | Read-write | A positive integer that uniquely identifies a VMAC address for binding to this VIP address. This binding is used to set up NetScaler appliances in an active-active configuration using VRRP.<br>Minimum value = 1<br>Maximum value = 255 |
| icmpresponse | <String> | Read-write | 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 NetScaler appliance responds to any ICMP request for the VIP address, irrespective of the states of the virtual servers associated with the address. * ONE VSERVER - The NetScaler appliance 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 NetScaler appliance 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, NetScaler always responds. * If you set ICMP VSERVER RESPONSE to ACTIVE on all virtual servers, NetScaler responds if even one virtual server is UP. * When you set ICMP VSERVER RESPONSE to ACTIVE on some and PASSIVE on others, NetScaler responds if even one virtual server set to ACTIVE is UP.<br>Default value: 5<br>Possible values = NONE, ONE_VSERVER, ALL_VSERVERS, VSVR_CNTRLD |
| ownernode | <Double> | Read-write | 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.<br>Default value: 255 |
| arpresponse | <String> | Read-write | 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 NetScaler appliance responds to any ARP request for the VIP address, irrespective of the states of the virtual servers associated with the address. * ONE VSERVER - The NetScaler appliance 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 NetScaler appliance responds to any ARP request for the VIP address if all of the associated virtual servers are in UP state.<br>Default value: 5<br>Possible values = NONE, ONE_VSERVER, ALL_VSERVERS |
| td | <Double> | 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.<br>Minimum value = 0<br>Maximum value = 4094 |
| flags | <Double> | Read-only | The flags for this entry. |
| hostrtgwact | <String> | Read-only | Actual Gateway used for advertising host route. |
| ospfareaval | <Double> | Read-only | The area ID of the area in which OSPF Type1 LSAs are advertised. |
| viprtadv2bsd | <Boolean> | Read-only | Whether this route is advertised to FreeBSD. |
| vipvsercount | <Double> | Read-only | Number of vservers bound to this VIP. |
| vipvserdowncount | <Double> | Read-only | Number of vservers bound to this VIP, which are down. |
| vipvsrvrrhiactivecount | <Double> | Read-only | Number of vservers that have RHI state ACTIVE. |
| vipvsrvrrhiactiveupcount | <Double> | Read-only | Number of vservers that have RHI state ACTIVE, which are UP. |
| freeports | <Double> | Read-only | Number of free Ports available on this IP. |
| riserhimsgcode | <Integer> | Read-only | The code indicating the rise rhi status. |
| iptype | <String[]> | Read-only | .<br>Possible values = SNIP, VIP, NSIP, GSLBsiteIP, CLIP |
| __count | <Double> | Read-only | count parameter |
Operations
(click to see Properties)
ADD | DELETE | UPDATE | UNSET | ENABLE | DISABLE | 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://<NSIP>/nitro/v1/config/
HTTP Method: POST
Request Payload:
object={
"params":{
"warning":<String_value>,
"onerror":<String_value>
},
"sessionid":"##sessionid",
"nsip":{
"ipaddress":<String_value>,
"netmask":<String_value>,
"type":<String_value>,
"arp":<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>,
"ospf":<String_value>,
"bgp":<String_value>,
"rip":<String_value>,
"hostroute":<String_value>,
"hostrtgw":<String_value>,
"metric":<Integer_value>,
"vserverrhilevel":<String_value>,
"vserverrhimode":<String_value>,
"ospflsatype":<String_value>,
"ospfarea":<Double_value>,
"state":<String_value>,
"vrid":<Double_value>,
"icmpresponse":<String_value>,
"ownernode":<Double_value>,
"arpresponse":<String_value>,
"td":<Double_value>,
}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
delete
URL: http://<NSIP>/nitro/v1/config/nsip/ipaddress_value<String>
Query-parameters:
warning
http://<NS_IP>/nitro/v1/config/nsip/ipaddress_value<String>?warning=yes
Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a
HTTP Method: DELETE
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
update
URL: http://<NSIP>/nitro/v1/config/
HTTP Method: PUT
Request Payload:
{
"params": {
"warning":<String_value>,
"onerror":<String_value>"
},
sessionid":"##sessionid",
"nsip":{
"ipaddress":<String_value>,
"td":<Double_value>,
"netmask":<String_value>,
"arp":<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>,
"ospf":<String_value>,
"bgp":<String_value>,
"rip":<String_value>,
"hostroute":<String_value>,
"hostrtgw":<String_value>,
"metric":<Integer_value>,
"vserverrhilevel":<String_value>,
"vserverrhimode":<String_value>,
"ospflsatype":<String_value>,
"ospfarea":<Double_value>,
"vrid":<Double_value>,
"icmpresponse":<String_value>,
"arpresponse":<String_value>,
}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
unset
URL: http://<NSIP>/nitro/v1/config/
HTTP Method: POST
Request Payload:
object={
"params":{
"warning":<String_value>,
"onerror":<String_value>,
"action":"unset"
},
"sessionid":"##sessionid",
"nsip":{
"ipaddress":<String_value>,
"td":<Double_value>,
"ospfarea":true,
"hostrtgw":true,
"netmask":true,
"arp":true,
"icmp":true,
"vserver":true,
"telnet":true,
"ftp":true,
"gui":true,
"ssh":true,
"snmp":true,
"mgmtaccess":true,
"restrictaccess":true,
"dynamicrouting":true,
"ospf":true,
"bgp":true,
"rip":true,
"hostroute":true,
"metric":true,
"vserverrhilevel":true,
"vserverrhimode":true,
"ospflsatype":true,
"vrid":true,
"icmpresponse":true,
"arpresponse":true,
}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
enable
URL: http://<NSIP>/nitro/v1/config/
HTTP Method: POST
Request Payload:
object={
"params":{
"warning":<String_value>,
"onerror":<String_value>,
"action":"enable"
},
"sessionid":"##sessionid",
"nsip":{
"ipaddress":<String_value>,
"td":<Double_value>,
}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
disable
URL: http://<NSIP>/nitro/v1/config/
HTTP Method: POST
Request Payload:
object={
"params":{
"warning":<String_value>,
"onerror":<String_value>,
"action":"disable"
},
"sessionid":"##sessionid",
"nsip":{
"ipaddress":<String_value>,
"td":<Double_value>,
}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
get (all)
URL: http://<NSIP>/nitro/v1/config/nsip
Query-parameters:
args
http://<NSIP>/nitro/v1/config/nsip?args= "ipaddress":<String_value>, "td":<Double_value>, "type":<String_value>,
Use this query-parameter to get nsip resources based on additional properties.
filter
http://<NSIP>/nitro/v1/config/nsip?filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of nsip resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view
http://<NS_IP>/nitro/v1/config/nsip?view=summary
Use this query-parameter to get the summary output of nsip resources configured on NetScaler.
pagesize=#no;pageno=#no
http://<NS_IP>/nitro/v1/config/nsip?pagesize=#no;pageno=#no
Use this query-parameter to get the nsip resources in chunks.
warning
http://<NS_IP>/nitro/v1/config/nsip?warning=yes
Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a
HTTP Method: GET
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": <String_value>, "nsip": [ {
"ipaddress":<String_value>,
"td":<Double_value>,
"type":<String_value>,
"netmask":<String_value>,
"flags":<Double_value>,
"arp":<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>,
"dynamicrouting":<String_value>,
"bgp":<String_value>,
"ospf":<String_value>,
"rip":<String_value>,
"hostroute":<String_value>,
"hostrtgw":<String_value>,
"hostrtgwact":<String_value>,
"metric":<Integer_value>,
"ospfarea":<Double_value>,
"ospfareaval":<Double_value>,
"vserverrhilevel":<String_value>,
"vserverrhimode":<String_value>,
"viprtadv2bsd":<Boolean_value>,
"vipvsercount":<Double_value>,
"vipvserdowncount":<Double_value>,
"vipvsrvrrhiactivecount":<Double_value>,
"vipvsrvrrhiactiveupcount":<Double_value>,
"ospflsatype":<String_value>,
"state":<String_value>,
"freeports":<Double_value>,
"vrid":<Double_value>,
"riserhimsgcode":<Integer_value>,
"iptype":<String[]_value>,
"icmpresponse":<String_value>,
"ownernode":<Double_value>,
"arpresponse":<String_value>
}]}
count
URL: http://<NS_IP>/nitro/v1/config/nsip?count=yes
HTTP Method: GET
Response Payload:
{ "errorcode": 0, "message": "Done",nsip: [ { "__count": "#no"} ] }