vxlan
Configuration for "VXLAN" resource.
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| id | <Double> | Read-write | A positive integer, which is also called VXLAN Network Identifier (VNI), that uniquely identifies a VXLAN.
Minimum value = 1
Maximum value = 16777215
|
| vlan | <Double> | Read-write | ID of VLANs whose traffic is allowed over this VXLAN. If you do not specify any VLAN IDs, the Citrix ADC allows traffic of all VLANs that are not part of any other VXLANs.
Minimum value = 2
Maximum value = 4094
|
| port | <Integer> | Read-write | Specifies UDP destination port for VXLAN packets.
Default value: 4789
Minimum value = 1
Maximum value = 65534
|
| dynamicrouting | <String> | Read-write | Enable dynamic routing on this VXLAN.
Default value: DISABLED
Possible values = ENABLED, DISABLED
|
| ipv6dynamicrouting | <String> | Read-write | Enable all IPv6 dynamic routing protocols on this VXLAN. 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
|
| type | <String> | Read-write | VXLAN encapsulation type. VXLAN, VXLANGPE.
Default value: VXLAN
Possible values = VXLAN, VXLANGPE
|
| protocol | <String> | Read-write | VXLAN-GPE next protocol. RESERVED, IPv4, IPv6, ETHERNET, NSH.
Default value: ETHERNET
Possible values = IPv4, IPv6, ETHERNET, NSH
|
| innervlantagging | <String> | Read-write | Specifies whether Citrix ADC should generate VXLAN packets with inner VLAN tag.
Default value: DISABLED
Possible values = ENABLED, DISABLED
|
| td | <Double> | Read-only | 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. |
| partitionname | <String> | Read-only | The Partition to which this vxlan is bound.
Minimum length = 1
|
| __count | <Double> | Read-only | 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 Citrix ADC appliance, the URL is as follows:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/login?warning=yesIf 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 Citrix ADC 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://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vxlan
HTTP Method:POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"vxlan":{
<b>"id":<Double_value>,
</b>"vlan":<Double_value>,
"port":<Integer_value>,
"dynamicrouting":<String_value>,
"ipv6dynamicrouting":<String_value>,
"type":<String_value>,
"protocol":<String_value>,
"innervlantagging":<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 Citrix ADC specific errors). The response payload provides details of the error
delete
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vxlan/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 Citrix ADC specific errors). The response payload provides details of the error
update
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vxlan
HTTP Method:PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"vxlan":{
<b>"id":<Double_value>,
</b>"vlan":<Double_value>,
"port":<Integer_value>,
"dynamicrouting":<String_value>,
"ipv6dynamicrouting":<String_value>,
"innervlantagging":<String_value>
}}
Response:
HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error
unset
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vxlan?action=unset
HTTP Method:POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"vxlan":{
<b>"id":<Double_value>,
</b>"vlan":true,
"port":true,
"dynamicrouting":true,
"ipv6dynamicrouting":true,
"innervlantagging":true
}}
Response:
HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error
get (all)
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vxlan
Query-parameters:
attrs
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vxlan?attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
filter
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vxlan?filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of vxlan resources configured on Citrix ADC. Filtering can be done on any of the properties of the resource.
view
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vxlan?view=summary
Note:By default, the retrieved results are displayed in detail view (?view=detail).
pagination
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vxlan?pagesize=#no;pageno=#no
Use this query-parameter to get the vxlan 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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "vxlan": [ {
"id":<Double_value>,
"vlan":<Double_value>,
"port":<Integer_value>,
"dynamicrouting":<String_value>,
"ipv6dynamicrouting":<String_value>,
"innervlantagging":<String_value>,
"td":<Double_value>,
"type":<String_value>,
"protocol":<String_value>,
"partitionname":<String_value>
}]}
get
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vxlan/id_value<Double>
Query-parameters:
attrs
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vxlan/id_value<Double>?attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
view
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vxlan/id_value<Double>?view=summary
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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "vxlan": [ {
"id":<Double_value>,
"vlan":<Double_value>,
"port":<Integer_value>,
"dynamicrouting":<String_value>,
"ipv6dynamicrouting":<String_value>,
"innervlantagging":<String_value>,
"td":<Double_value>,
"type":<String_value>,
"protocol":<String_value>,
"partitionname":<String_value>
}]}
count
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vxlan?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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "vxlan": [ { "__count": "#no"} ] }