Product Documentation

vlan_binding

Sep 07, 2016

Binding object which returns the resources bound to vlan.

Properties (click to see Operations)

Name Data Type Permissions Description
id
<Double>
Read-write
Integer that uniquely identifies the VLAN for which the details are to be displayed.
Minimum value = 1
Maximum value = 4094
vlan_channel_binding
<vlan_channel_binding[]>
Read-only
channel that can be bound to vlan.
vlan_nsip_binding
<vlan_nsip_binding[]>
Read-only
nsip that can be bound to vlan.
vlan_interface_binding
<vlan_interface_binding[]>
Read-only
interface that can be bound to vlan.
vlan_linkset_binding
<vlan_linkset_binding[]>
Read-only
linkset that can be bound to vlan.
vlan_nsip6_binding
<vlan_nsip6_binding[]>
Read-only
nsip6 that can be bound to vlan.

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>.

get

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

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_binding": [ {
      "id":<Double_value>,
      "vlan_interface_binding":<vlan_interface_binding[]_value>,
      "vlan_nsip6_binding":<vlan_nsip6_binding[]_value>,
      "vlan_nsip_binding":<vlan_nsip_binding[]_value>,
      "vlan_linkset_binding":<vlan_linkset_binding[]_value>,
      "vlan_channel_binding":<vlan_channel_binding[]_value>
}]}

get (all)

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

Query-parameters:

bulkbindings

http://<netscaler-ip-address>/nitro/v1/config/vlan_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_binding": [ {
      "id":<Double_value>,
      "vlan_interface_binding":<vlan_interface_binding[]_value>,
      "vlan_nsip6_binding":<vlan_nsip6_binding[]_value>,
      "vlan_nsip_binding":<vlan_nsip_binding[]_value>,
      "vlan_linkset_binding":<vlan_linkset_binding[]_value>,
      "vlan_channel_binding":<vlan_channel_binding[]_value>
}]}