Download full document:

vxlanvlanmap_vxlan_binding

Binding object showing the vxlan that can be bound to vxlanvlanmap.

Properties

(click to see Operations)

NameData TypePermissionsDescription
name<String>Read-writeName of the mapping table.
Minimum length = 1
vxlan<Double>Read-writeThe VXLAN assigned to the vlan inside the cloud.
Minimum value = 1
Maximum value = 16777215
vlan<String[]>Read-writeThe vlan id or the range of vlan ids in the on-premise network.
Minimum length = 1
Maximum length = 4094
__count<Double>Read-writecount parameter

Operations

(click to see Properties)

ADD:| DELETE:| GET| 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 redand placeholder content is marked in <green>.

add:

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

HTTP Method:PUT

Request Headers:

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

Request Payload:

{
"vxlanvlanmap_vxlan_binding":{
<b>"name":<String_value>,
</b>"vxlan":<Double_value>,
"vlan":<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/vxlanvlanmap_vxlan_binding/name_value<String>

Query-parameters:

args

http://<netscaler-ip-address>/nitro/v1/config/vxlanvlanmap_vxlan_binding/name_value<String>?args=vxlan:<Double_value>

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/vxlanvlanmap_vxlan_binding/name_value<String>

Query-parameters:

filter

http://<netscaler-ip-address>/nitro/v1/config/vxlanvlanmap_vxlan_binding/name_value<String>?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of vxlanvlanmap_vxlan_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/vxlanvlanmap_vxlan_binding/name_value<String>?pagesize=#no;pageno=#no

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

Content-Type:application/json

Response Payload:

{ "vxlanvlanmap_vxlan_binding": [ {
"name":<String_value>,
"vxlan":<Double_value>,
"vlan":<String[]_value>
}]}

get (all)

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

Query-parameters:

bulkbindings

http://<netscaler-ip-address>/nitro/v1/config/vxlanvlanmap_vxlan_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 errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "vxlanvlanmap_vxlan_binding": [ {
"name":<String_value>,
"vxlan":<Double_value>,
"vlan":<String[]_value>
}]}

count

URL:http://<netscaler-ip-address>/nitro/v1/config/vxlanvlanmap_vxlan_binding/name_value<String>?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 errorResponse Headers:

Content-Type:application/json

Response Payload:

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