Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

vlan

August 17, 2023
Contributed by: 
C

Configuration for “VLAN” resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
id Read-write A positive integer that uniquely identifies a VLAN.

Minimum value = 1

Maximum value = 4094
aliasname Read-write A name for the VLAN. Must begin with a letter, a number, or the underscore symbol, and can consist of from 1 to 31 letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at sign (@), equals (=), colon (:), and underscore (_) characters. You should choose a name that helps identify the VLAN. However, you cannot perform any VLAN operation by specifying this name instead of the VLAN ID.

Maximum length = 31
dynamicrouting Read-write Enable dynamic routing on this VLAN.

Default value: DISABLED

Possible values = ENABLED, DISABLED
ipv6dynamicrouting Read-write Enable all IPv6 dynamic routing protocols on this VLAN. Note: For the ENABLED setting to work, you must configure IPv6 dynamic routing protocols from the VTYSH command line.

Default value: DISABLED

Possible values = ENABLED, DISABLED
mtu Read-write Specifies the maximum transmission unit (MTU), in bytes. The MTU is the largest packet size, excluding 14 bytes of ethernet header and 4 bytes of crc, that can be transmitted and received over this VLAN.

Default value: 0

Minimum value = 500

Maximum value = 9216
sharing Read-write If sharing is enabled, then this vlan can be shared across multiple partitions by binding it to all those partitions. If sharing is disabled, then this vlan can be bound to only one of the partitions.

Default value: DISABLED

Possible values = ENABLED, DISABLED
linklocalipv6addr Read-only The link-local IP address assigned to the VLAN.
rnat Read-only Temporary flag used for internal purpose.
portbitmap Read-only Member interfaces of this vlan.
lsbitmap Read-only Member linksets of this vlan.
tagbitmap Read-only Tagged members of this vlan.
lstagbitmap Read-only Tagged linksets of this vlan.
ifaces Read-only Names of all member interfaces of this vlan.
tagifaces Read-only Names of all tagged member interfaces of this vlan.
ifnum Read-only The interface to be bound to the VLAN, specified in slot/port notation (for example, 1/3).

Minimum length = 1
tagged Read-only Make the interface an 802.1q tagged interface. Packets sent on this interface on this VLAN have an additional 4-byte 802.1q tag, which identifies the VLAN. To use 802.1q tagging, you must also configure the switch connected to the appliance’s interfaces.
vlantd Read-only Traffic domain associated with vlan.

Minimum value = 0

Maximum value = 4094
sdxvlan Read-only SDX vlan.

Default value: NO

Possible values = YES, NO
partitionname Read-only Name of the Partition to which this vlan bound to.

Minimum length = 1
vxlan Read-only The VXLAN that extends this vlan.
__count Read-only count parameter

Operations

(click to see Properties )

  • ADD
  • DELETE
  • UPDATE
  • UNSET
  • GET (ALL)
  • GET
  • 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/vlan

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"vlan":{
<b>      "id":<Double_value>,
</b>      "aliasname":<String_value>,
      "dynamicrouting":<String_value>,
      "ipv6dynamicrouting":<String_value>,
      "mtu":<Double_value>,
      "sharing":<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/vlan/ 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

update

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

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"vlan":{
<b>      "id":<Double_value>,
</b>      "aliasname":<String_value>,
      "dynamicrouting":<String_value>,
      "ipv6dynamicrouting":<String_value>,
      "mtu":<Double_value>,
      "sharing":<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/vlan? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"vlan":{
<b>      "id":<Double_value>,
</b>      "aliasname":true,
      "dynamicrouting":true,
      "ipv6dynamicrouting":true,
      "mtu":true,
      "sharing":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/vlan

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/vlan? 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/vlan? filter=property-name1:property-val1,property-name2:property-val2

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

view

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

Use this query-parameter to get the summary output of vlan 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/vlan? pagesize=#no;pageno=#no

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


{ "vlan": [ {
      "id":<Double_value>,
      "aliasname":<String_value>,
      "linklocalipv6addr":<String_value>,
      "rnat":<Boolean_value>,
      "portbitmap":<Double_value>,
      "lsbitmap":<Double_value>,
      "tagbitmap":<Double_value>,
      "lstagbitmap":<Double_value>,
      "ifaces":<String_value>,
      "tagifaces":<String_value>,
      "dynamicrouting":<String_value>,
      "ipv6dynamicrouting":<String_value>,
      "ifnum":<String_value>,
      "tagged":<Boolean_value>,
      "vlantd":<Double_value>,
      "sdxvlan":<String_value>,
      "mtu":<Double_value>,
      "sharing":<String_value>,
      "partitionname":<String_value>,
      "vxlan":<Double_value>
}]}

<!--NeedCopy-->

get

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

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/vlan/ id_value<Double> ? attrs=property-name1,property-name2

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

view

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

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

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

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: 


{  "vlan": [ {
      "id":<Double_value>,
      "aliasname":<String_value>,
      "linklocalipv6addr":<String_value>,
      "rnat":<Boolean_value>,
      "portbitmap":<Double_value>,
      "lsbitmap":<Double_value>,
      "tagbitmap":<Double_value>,
      "lstagbitmap":<Double_value>,
      "ifaces":<String_value>,
      "tagifaces":<String_value>,
      "dynamicrouting":<String_value>,
      "ipv6dynamicrouting":<String_value>,
      "ifnum":<String_value>,
      "tagged":<Boolean_value>,
      "vlantd":<Double_value>,
      "sdxvlan":<String_value>,
      "mtu":<Double_value>,
      "sharing":<String_value>,
      "partitionname":<String_value>,
      "vxlan":<Double_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/vlan? 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: 


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

<!--NeedCopy-->
vlan
August 17, 2023
Contributed by: 
C
August 17, 2023
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.