VLAN and interface VLAN related APIs

Table 1. VLAN and interface VLAN related APIs

Action

Method

Payload Required

API

To create VLAN

POST

Yes

/api/running/switch

To delete VLAN

DELETE

No

/api/running/switch/vlan/90

To create interface VLAN

POST

Yes

/api/running/switch/interface

To display the VLAN configuration

GET

No

/api/running/switch/vlan?deep

To displace all the interface VLAN configurations

GET

No

/api/running/switch/interface/vlan?deep

To display a specific interface VLAN configuration

GET

No

/api/running/switch/interface/vlan/90

To delete the VLAN interface

DELETE

No

/api/running/switch/interface/vlan/90

To configure an IP address for a VLAN interface

PATCH

Yes

/api/running/switch/interface/vlan

To delete an IP address for a VLAN interface

DELETE

No

/api/running/switch/ip/route/ip-route-forwarding-list/2.2.2.2,255.255.255.255,5.5.5.1

To show the IP interface

GET

No

/api/operational/switch/ip/interface

To delete remote SPAN setting for VLAN

DELETE

No

/api/running/switch/interface/vlan/20/remote-span

Example for VLAN and interface VLAN related APIs Payload 

<vlan><vlan-id>90</vlan-id></vlan>

Example for VLAN and interface VLAN related APIs Payload 

<vlan><vlan-id>90</vlan-id><ip><address><primary><address>13.13.13.13</address><mask>255.255.255.0</mask></primary></address></ip></vlan>

Example for VLAN and interface VLAN related APIs Payload 

<vlan><vlan-id>20</vlan-id><remote-span/></vlan>

Example: POST VLAN and interface VLAN related APIs

curl -k -u admin:admin -d "<vlan><vlan-id>90</vlan-id></vlan>" -X POST https://209.165.201.1/api/running/switch -H "Content-Type: application/vnd.yang.data+xml"

Example: DELETE VLAN and interface VLAN related APIs

curl -k -u admin:admin -X DELETE https://209.165.201.1/api/running/switch/vlan/90

Example: POST VLAN and interface VLAN related APIs

curl -k -u admin:admin -d "<vlan><vlan-id>90</vlan-id></vlan>" -X POST https://209.165.201.1/api/running/switch/interface -H "Content-Type: application/vnd.yang.data+xml"

Example: GET VLAN and interface VLAN related APIs

curl -k -u admin:admin -X GET https://209.165.201.1/api/running/switch/vlan?deep

Example: GET VLAN and interface VLAN related APIs

curl -k -u admin:admin -X GET https://209.165.201.1/api/running/switch/interface/vlan?deep

Example: GET VLAN and interface VLAN related APIs

curl -k -u admin:admin -X GET https://209.165.201.1/api/running/switch/interface/vlan/90

Example: DELETE VLAN and interface VLAN related APIs

curl -k -u admin:admin -X DELETE https://209.165.201.1/api/running/switch/interface/vlan/90

Example: PATCH VLAN and interface VLAN related APIs

curl -k -v -u admin:admin  -d "<vlan><vlan-id>90</vlan-id><ip><address><primary><address>13.13.13.13</address><mask>255.255.255.0</mask></primary></address></ip></vlan>" -X PATCH https://209.165.201.1/api/running/switch/interface/vlan -H "Content-Type: application/vnd.yang.data+xml"

Example: DELETE VLAN and interface VLAN related APIs

curl -k -u admin:admin -X DELETE https://209.165.201.1/api/running/switch/ip/route/ip-route-forwarding-list/2.2.2.2,255.255.255.255,5.5.5.1

Example: GET VLAN and interface VLAN related APIs

curl -k -u admin:admin -X GET https://209.165.201.1/api/operational/switch/ip/interface

Example: PATCH VLAN and interface VLAN related APIs

curl -k -v -u admin:admin -d "<vlan><vlan-id>20</vlan-id><remote-span/></vlan>" -X PATCH https://209.165.201.1/api/running/switch/interface/vlan -H "Content-Type: application/vnd.yang.data+xml"

Example: DELETE VLAN and interface VLAN related APIs

curl -k -v -u admin:admin  -X  DELETE  https://209.165.201.1/api/running/switch/interface/vlan/20/remote-span -H "Content-Type: application/vnd.yang.data+xml"