Product Documentation

vlan_nsip_binding

Sep 07, 2016

Binding object showing the nsip that can be bound to vlan.

Properties (click to see Operations)

Name Data Type Permissions Description
ownergroup
<String>
Read-write
The owner node group in a Cluster for this vlan.
Default value: DEFAULT_NG
Minimum length = 1
id
<Double>
Read-write
Specifies the virtual LAN ID.
Minimum value = 1
Maximum value = 4094
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.
Minimum value = 0
Maximum value = 4094
netmask
<String>
Read-write
Subnet mask for the network address defined for this VLAN.
ipaddress
<String>
Read-write
The IP address assigned to the VLAN.
__count
<Double>
Read-write
count parameter

Operations (click to see Properties)

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>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add:

URL: http://<netscaler-ip-address/nitro/v1/config/vlan_nsip_binding

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{
"vlan_nsip_binding":{
      "id":<Double_value>,
      "ipaddress":<String_value>,
      "netmask":<String_value>,
      "td":<Double_value>,
      "ownergroup":<String_value>
}}

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/vlan_nsip_binding/id_value<Double>

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

get

URL: http://<netscaler-ip-address>/nitro/v1/config/vlan_nsip_binding/id_value<Double>

Query-parameters:

filter

http://<netscaler-ip-address>/nitro/v1/config/vlan_nsip_binding/id_value<Double>?filter=property-name1:property-value1,property-name2:property-value2

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

pagination

http://<netscaler-ip-address>/nitro/v1/config/vlan_nsip_binding/id_value<Double>?pagesize=#no&pageno=#no

Use this query-parameter to get the vlan_nsip_binding 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 Headers:

Content-Type:application/json

Response Payload:

{ "vlan_nsip_binding": [ {
      "ownergroup":<String_value>,
      "id":<Double_value>,
      "td":<Double_value>,
      "netmask":<String_value>,
      "ipaddress":<String_value>
}]}

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/config/vlan_nsip_binding

Query-parameters:

bulkbindings

http://<netscaler-ip-address>/nitro/v1/config/vlan_nsip_binding?bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

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 Headers:

Content-Type:application/json

Response Payload:

{ "vlan_nsip_binding": [ {
      "ownergroup":<String_value>,
      "id":<Double_value>,
      "td":<Double_value>,
      "netmask":<String_value>,
      "ipaddress":<String_value>
}]}

count

URL: http://<netscaler-ip-address>/nitro/v1/config/vlan_nsip_binding/id_value<Double>?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 Headers:

Content-Type:application/json

Response Payload:

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