RESTCONF API Guide

AAA 22

Description

To create tacacs server using post method

Body
{ "server-group": [ { "name": "tacacs-default-group", "config": { "name": "tacacs-default-group", "type": "TACACS" }, "servers": { "server": [ { "address": "55.1.1.1", "config": { "name": "55.1.1.1", "address": "55.1.1.1" }, "tacacs": { "config": { "port": "1234", "secret-key": "test1234" } } } ] } } ] }

Description

To create radius server using POST method

Body
{ "server-group": [ { "name": "radius-default-group", "config": { "name": "radius-default-group", "type": "RADIUS" }, "servers": { "server": [ { "address": "56.1.1.1", "config": { "name": "56.1.1.1", "address": "56.1.1.1" }, "radius": { "config": { "auth-port": "1812", "acct-port": "1813", "secret-key": "radiust1234", "retransmit-attempts": 2, "icx-openconfig-aaa-aug:dot1x": true, "icx-openconfig-aaa-aug:web-auth": true } } } ] } } ] }

Description

To create/update radius server using patch method

Body
{ "server-groups": { "server-group": [ { "name": "radius-default-group", "config": { "name": "radius-default-group", "type": "RADIUS" }, "servers": { "server": [ { "address": "58.1.1.1", "config": { "name": "58.1.1.1", "address": "58.1.1.1" }, "radius": { "config": { "auth-port": 1812, "acct-port": 1813, "secret-key": "radiust123", "retransmit-attempts": 2 } } } ] } } ] } }

Description

To create/update tacacs server using PATCH method

Body
{ "server-groups": { "server-group": [ { "name": "tacacs-default-group", "config": { "name": "tacacs-default-group", "type": "TACACS" }, "servers": { "server": [ { "address": "57.1.1.1", "config": { "name": "57.1.1.1", "address": "57.1.1.1" }, "tacacs": { "config": { "port": 49, "secret-key": "test1234" } } } ] } } ] } }

Description

To delete all tacacs/radius servers configured in the system


Description

To delete specific radius server configured in the system


Description

To delete specific tacacs server configured in the system


Description

To update/disable AAA authorization icx COA(change of authorization) using patch

Body
{ "coa": { "enable":"false" } }

Description

To update/disable COA ignore options

Body
{ "ignore": { "flip-port": "false", "disable-port": "false", "reauth-host": "false", "modify-acl": "false", "dm-request": "false" } }

Description

To update/disable Dot1x RADIUS authentication using patch

Body
{ "authentication": { "icx-openconfig-aaa-aug:dot1x": { "default":"none" } } }

Description

To update/enable AAA authorization icx COA(change of Authorization) using patch method

Body
{ "icx-openconfig-aaa-aug:coa": { "enable":"true" } }

Description

To update/enable COA ignore options

Body
{ "ignore": { "flip-port": "true", "disable-port": "true", "reauth-host": "true", "modify-acl": "true", "dm-request": "true" } }

Description

To update/enable Dot1x RADIUS authentication using patch

Body
{ "authentication": { "icx-openconfig-aaa-aug:dot1x": { "default":"radius" } } }

Description

To get/read aaa authorization COA(change of authorization) options


Description

To get/read tacacs/radius servers configured in the system


Description

To read/get default AAA configs on icx switch after system boot up


Description

To get/read dot1x authentication status


Description

To get/read specific radius server configured in the system


Description

To get/read specific server configured in the system


Description

To replace radius server configured in the system

Body
{ "server-groups": { "server-group": [ { "name": "radius-default-group", "config": { "name": "radius-default-group", "type": "RADIUS" }, "servers": { "server": [ { "address": "66.1.1.1", "config": { "name": "66.1.1.1", "address": "66.1.1.1" }, "radius": { "config": { "auth-port": "1812", "acct-port": "1813", "secret-key": "radiust1234", "retransmit-attempts": 2, "icx-openconfig-aaa-aug:dot1x": true, "icx-openconfig-aaa-aug:web-auth": true } } } ] } } ] } }

Description

To replace tacacs server configured in the system with new server

Body
{ "server-groups": { "server-group": [ { "name": "tacacs-default-group", "config": { "name": "tacacs-default-group", "type": "TACACS" }, "servers": { "server": [ { "address": "55.1.1.1", "config": { "name": "55.1.1.1", "address": "55.1.1.1" }, "tacacs": { "config": { "port": "1234", "secret-key": "test1234" } } } ] } } ] } }

Description

To create/update authentication method list using patch

Body
{ "authentication": { "config": { "authentication-method": "RADIUS_ALL", "authentication-method": "TACACS_ALL", "authentication-method": "LOCAL", "authentication-method": "LINE", "authentication-method": "ENABLE", "authentication-method": "NONE", "authentication-method": "TACACS_ONLY_ALL" } } }

AAA-username 7

Description

To delete a specific AAA username


Description

get/read AAA usernames configured in the system


Description

To get/read specific username configured in the system


Description

To create/update AAA user using PATCh method

Body
{ "users": { "user": [ { "username": "user3", "config": { "username": "user3", "password": "passwordforuser3", "icx-openconfig-aaa-aug:privilege": 0 } } ] } }

Description

To create/update AAA username using PATCH method

Body
{ "users": { "user": [ { "username": "user4", "config": { "username": "user4", "password": "passwordforuser4", "icx-openconfig-aaa-aug:privilege": 0 } } ] } }

Description

To replace AAA user using PUT method

Body
{ "users": { "user": [ { "username": "user4", "config": { "username": "user4", "password": "passwordforuser4", "icx-openconfig-aaa-aug:privilege": 0 } } ] } }

Description

To create AAA username using POST method

Body
{ "user": [ { "username": "user3", "config": { "username": "user3", "password": "passwordforuser3", "icx-openconfig-aaa-aug:privilege": 1 } } ] }

ACL 32

Description

To apply ipv4 ext acl on ingress/egress acl using POST method

Body
{ "interfaces": { "interface": [ { "id": "ethernet 1/1/1", "config": { "id": "ethernet 1/1/1" }, "ingress-acl-sets": { "ingress-acl-set": [ { "set-name": "ext_acl1", "type": "ACL_IPV4", "config": { "set-name": "ext_acl1", "type": "ACL_IPV4" } } ] } }, { "id": "ethernet 1/1/2", "config": { "id": "ethernet 1/1/2" }, "egress-acl-sets": { "egress-acl-set": [ { "set-name": "ext_acl1", "type": "ACL_IPV4", "config": { "set-name": "ext_acl1", "type": "ACL_IPV4" } } ] } } ] } }

Description

To apply ipv4 extended acl on ingress and egress interface using PATCH

Body
{ "interfaces" : { "interface": [ { "id": "ethernet 1/1/1", "config": { "id": "ethernet 1/1/1" }, "ingress-acl-sets": { "ingress-acl-set": [ { "set-name": "ext_acl1", "type": "ACL_IPV4", "config": { "set-name": "ext_acl1", "type": "ACL_IPV4" } } ] } }, { "id": "ethernet 1/1/2", "config": { "id": "ethernet 1/1/2" }, "egress-acl-sets": { "egress-acl-set": [ { "set-name": "ext_acl1", "type": "ACL_IPV4", "config": { "set-name": "ext_acl1", "type": "ACL_IPV4" } } ] } } ] } }

Description

To apply ipv4 std acl on ingress/egress interfaces using POST method

Body
{ "interfaces" : { "interface": [ { "id": "ethernet 1/1/5", "config": { "id": "ethernet 1/1/5" }, "ingress-acl-sets": { "ingress-acl-set": [ { "set-name": "ip_stan_test", "type": "ACL_IPV4", "config": { "set-name": "ip_stan_test", "type": "ACL_IPV4" } } ] } }, { "id": "ethernet 1/1/6", "config": { "id": "ethernet 1/1/6" }, "egress-acl-sets": { "egress-acl-set": [ { "set-name": "ip_stan_test", "type": "ACL_IPV4", "config": { "set-name": "ip_stan_test", "type": "ACL_IPV4" } } ] } } ] } }

Description

To apply mac acl(l2 acl) on ingree/egress interface using POST method

Body
{ "interfaces" : { "interface": [ { "id": "ethernet 1/1/10", "config": { "id": "ethernet 1/1/10" }, "ingress-acl-sets": { "ingress-acl-set": [ { "set-name": "bj5", "type": "ACL_L2", "config": { "set-name": "bj5", "type": "ACL_L2" } } ] } }, { "id": "ethernet 1/1/11", "config": { "id": "ethernet 1/1/11" }, "egress-acl-sets": { "egress-acl-set": [ { "set-name": "bj5", "type": "ACL_L2", "config": { "set-name": "bj5", "type": "ACL_L2" } } ] } } ] } }

Description

To apply/update ipv4 std acl on ingress and egress interface using PATCH method

Body
{ "interfaces" : { "interface": [ { "id": "ethernet 1/1/5", "config": { "id": "ethernet 1/1/5" }, "ingress-acl-sets": { "ingress-acl-set": [ { "set-name": "ip_stan_test", "type": "ACL_IPV4", "config": { "set-name": "ip_stan_test", "type": "ACL_IPV4" } } ] } }, { "id": "ethernet 1/1/6", "config": { "id": "ethernet 1/1/6" }, "egress-acl-sets": { "egress-acl-set": [ { "set-name": "ip_stan_test", "type": "ACL_IPV4", "config": { "set-name": "ip_stan_test", "type": "ACL_IPV4" } } ] } } ] } }

Body
{ "interfaces" : { "interface": [ { "id": "ethernet 1/1/10", "config": { "id": "ethernet 1/1/10" }, "ingress-acl-sets": { "ingress-acl-set": [ { "set-name": "bj5", "type": "ACL_L2", "config": { "set-name": "bj5", "type": "ACL_L2" } } ] } } ] } }

Description

To delete a specific ipv4 extended acl configured in the system


Description

To delete a specific L2 acl(mac acl) configured in the system


Description

To delete L2 acl binding on ingress interface


Description

To delete a specific ipv4 standard acl configured in the system



Description

To delete ipv4 acl binding on egress interface


Description

To delete ipv6 acl binding on egress interface


Description

To delete ipv6 acl binding on ingress interface


Description

To delete a specific ipv6 acl configured in the system


Description

To get/read specific L2 ACL(mac acl) configured in the system


Description

To get/read all acl binding interfaces


Description

To read/get acl configured in the system


Description

To get/read specific ipv4 standard acl configured in the system


Description

To get/read specific acl binded interface


Description

To get/read specific ipv6 acl configured in the system


Description

To apply/update ipv6 acl on ingress and egress interface using PATCH method

Body
{ "interfaces" : { "interface": [ { "id": "ethernet 1/1/3", "config": { "id": "ethernet 1/1/3" }, "ingress-acl-sets": { "ingress-acl-set": [ { "set-name": "acl_ipv61", "type": "ACL_IPV6", "config": { "set-name": "acl_ipv61", "type": "ACL_IPV6" } } ] } }, { "id": "ethernet 1/1/4", "config": { "id": "ethernet 1/1/4" }, "egress-acl-sets": { "egress-acl-set": [ { "set-name": "acl_ipv61", "type": "ACL_IPV6", "config": { "set-name": "acl_ipv61", "type": "ACL_IPV6" } } ] } } ] } }

Description

To apply ipv6 acl on ingress/egress interfaces using POST method

Body
{ "interfaces" : { "interface": [ { "id": "ethernet 1/1/3", "config": { "id": "ethernet 1/1/3" }, "ingress-acl-sets": { "ingress-acl-set": [ { "set-name": "acl_ipv61", "type": "ACL_IPV6", "config": { "set-name": "acl_ipv61", "type": "ACL_IPV6" } } ] } }, { "id": "ethernet 1/1/4", "config": { "id": "ethernet 1/1/4" }, "egress-acl-sets": { "egress-acl-set": [ { "set-name": "acl_ipv61", "type": "ACL_IPV6", "config": { "set-name": "acl_ipv61", "type": "ACL_IPV6" } } ] } } ] } }

Description

To create ipv4 extended acl with acl entries using POST method

Body
{ "acl-set": [ { "name": "ext_acl1", "type": "ACL_IPV4", "config": { "name": "ext_acl1", "type": "ACL_IPV4" }, "acl-entries": { "acl-entry": [ { "sequence-id": 10, "config": { "sequence-id": 10 }, "ipv4": { "config": { "source-address": "0.0.0.0", "destination-address": "0.0.0.0", "dscp": 0, "protocol": 6 } }, "transport": { "config": { "source-port": "0", "destination-port": "0" } }, "actions": { "config": { "forwarding-action": "openconfig-acl:ACCEPT" } } } ] } } ] }

Description

To cretae ipv4 std acl using POST method

Body
{ "acl-set": [ { "name": "ip_stan_test", "type": "ACL_IPV4", "config": { "name": "ip_stan_test", "type": "ACL_IPV4" }, "acl-entries": { "acl-entry": [ { "sequence-id": 10, "config": { "sequence-id": 10 }, "ipv4": { "config": { "source-address": "10.157.29.12", "destination-address": "0.0.0.0", "dscp": 0, "protocol": 0 } }, "actions": { "config": { "forwarding-action": "openconfig-acl:DROP" } } }, { "sequence-id": 20, "config": { "sequence-id": 20 }, "ipv4": { "config": { "source-address": "0.0.0.0", "destination-address": "0.0.0.0", "dscp": 0, "protocol": 0 } }, "transport": { "config": { "source-port": "0", "destination-port": "0" } }, "actions": { "config": { "forwarding-action": "openconfig-acl:ACCEPT" } } } ] } } ] }

Description

To cretae ipv6 acl withacl entries using POST method

Body
{ "acl-set": [ { "name": "acl_ipv61", "type": "ACL_IPV6", "config": { "name": "acl_ipv61", "type": "ACL_IPV6" }, "acl-entries": { "acl-entry": [ { "sequence-id": 10, "config": { "sequence-id": 10 }, "ipv6": { "config": { "source-address": "1000::10/120", "destination-address": "2000::10/100", "dscp": 0, "protocol": "IP_TCP" } }, "actions": { "config": { "forwarding-action": "ACCEPT" } } } ] } } ] }

Description

To create mac acl using POST method

Body
{ "acl-set": [ { "name": "bj5", "type": "ACL_L2", "config": { "name": "bj5", "type": "ACL_L2" }, "acl-entries": { "acl-entry": [ { "sequence-id": 100, "config": { "sequence-id": 100 }, "l2": { "config": { "source-mac": "1111.2222.3333", "source-mac-mask": "1111.2222.3333", "destination-mac": "1111.2222.3333", "destination-mac-mask": "1111.2222.3333", "ethertype": 2048 } }, "actions": { "config": { "forwarding-action": "ACCEPT" } } } ] } } ] }

Description

To create/update ipv4 extended acl using PATCH method

Body
{ "acl-sets": { "acl-set": [ { "name": "ext3", "type": "ACL_IPV4", "config": { "name": "ext3", "type": "ACL_IPV4" }, "acl-entries": { "acl-entry": [ { "sequence-id": 10, "config": { "sequence-id": 10 }, "ipv4": { "config": { "source-address": "0.0.0.0", "destination-address": "0.0.0.0", "dscp": 0, "protocol": 6 } }, "transport": { "config": { "source-port": "0", "destination-port": "0" } }, "actions": { "config": { "forwarding-action": "openconfig-acl:ACCEPT" } } } ] } } ] } }

Description

To create/update ipv4 std acl using PATCH method

Body
{ "acl-sets": { "acl-set": [ { "name": "ip_stan_test1", "type": "ACL_IPV4", "config": { "name": "ip_stan_test1", "type": "ACL_IPV4" }, "acl-entries": { "acl-entry": [ { "sequence-id": 10, "config": { "sequence-id": 10 }, "ipv4": { "config": { "source-address": "10.157.29.12", "destination-address": "0.0.0.0", "dscp": 0, "protocol": 0 } }, "actions": { "config": { "forwarding-action": "openconfig-acl:DROP" } } }, { "sequence-id": 20, "config": { "sequence-id": 20 }, "ipv4": { "config": { "source-address": "0.0.0.0", "destination-address": "0.0.0.0", "dscp": 0, "protocol": 0 } }, "transport": { "config": { "source-port": "0", "destination-port": "0" } }, "actions": { "config": { "forwarding-action": "openconfig-acl:ACCEPT" } } } ] } } ] } }

Description

To create/update ipv6 acl using PATCH method

Body
{ "acl-sets": { "acl-set": [ { "name": "acl_ipv61", "type": "ACL_IPV6", "config": { "name": "acl_ipv61", "type": "ACL_IPV6" }, "acl-entries": { "acl-entry": [ { "sequence-id": 10, "config": { "sequence-id": 10 }, "ipv6": { "config": { "source-address": "1000::10/120", "destination-address": "2000::10/100", "dscp": 0, "protocol": "IP_TCP" } }, "actions": { "config": { "forwarding-action": "ACCEPT" } } } ] } } ] } }

Description

To create/update mac acl using PATCH method

Body
{ "acl-sets": { "acl-set": [ { "name": "bj5", "type": "ACL_L2", "config": { "name": "bj5", "type": "ACL_L2" }, "acl-entries": { "acl-entry": [ { "sequence-id": 100, "config": { "sequence-id": 100 }, "l2": { "config": { "source-mac": "1111.2222.3333", "source-mac-mask": "1111.2222.3333", "destination-mac": "1111.2222.3333", "destination-mac-mask": "1111.2222.3333", "ethertype": 2048 } }, "actions": { "config": { "forwarding-action": "ACCEPT" } } } ] } } ] } }

Description

To get/read specific ipv4 extended acl configured in the system


DNS 7

Description

create DNS server thro POST method

Body
{ "server": [ { "address": "20.1.1.1", "config": { "address": "20.1.1.1" } } ] }

Description

To delete all dns server configured in the system


Description

To delete specific dns server


Description

read/get all DNS servers configured in the system


Description

To get specific dns server configured in the system


Description

replace existing DNS server with new server using PUT method

Body
{ "servers": { "server": [ { "address": "30.1.1.1", "config": { "address": "30.1.1.1" } } ] } }

Description

updating/appending DNS server using PATCH

Body
{ "servers": { "server": [ { "address": "40.1.1.1", "config": { "address": "40.1.1.1" } } ] } }

Interface 10

Description

To delete ip address assigned on interface using delete method


Description

To assign ip address on interface using POST method

Body
{ "subinterface": [ { "index": 0, "config": { "index": 0 }, "openconfig-if-ip:ipv4": { "addresses": { "address": [ { "ip": "36.1.1.1", "config": { "ip": "36.1.1.1", "prefix-length": 25 } } ] } } } ] }

Description

To disable interface using PATCH method

Body
{ "interfaces": { "interface": [ { "name": "ethernet 1/1/1", "config": { "name": "ethernet 1/1/1", "type": "iana-if-type:ethernetCsmacd", "description": "", "enabled": false } } ] } }

Description

To enable interface using PATCH method

Body
{ "interfaces": { "interface": [ { "name": "ethernet 1/1/1", "config": { "name": "ethernet 1/1/1", "type": "iana-if-type:ethernetCsmacd", "description": "", "enabled": true } } ] } }

Description

To read/get all interfaces in the system


Description

To get/read ip address on specific interface


Description

To get/read state of a specific interface


Description

To update port description using PATCH method

Body
{ "interfaces": { "interface": [ { "name": "ethernet 1/1/1", "config": { "name": "ethernet 1/1/1", "type": "iana-if-type:ethernetCsmacd", "description": "port 1", "enabled": true } } ] } }

Description

To update the port speed using PATCH method

Body
{ "config": { "auto-negotiate": false, "duplex-mode": "FULL", "port-speed": "openconfig-if-ethernet:SPEED_10GB", "icx-openconfig-if-ethernet-aug:ethernet-clock": "slave" } }

Description

To update/assign ip address on interface using PATCH method

Body
{ "subinterfaces": { "subinterface": [ { "index": 1, "config": { "index": 1 }, "openconfig-if-ip:ipv4": { "addresses": { "address": [ { "ip": "37.1.1.1", "config": { "ip": "37.1.1.1", "prefix-length": 25 } } ] } } } ] } }

LAG 11

Description

To delete a specific lag


Description

To delete a port from a LAG


Description

To add/update the ports to LAG using PATCH method

Body
{ "config": { "openconfig-if-aggregate:aggregate-id": "lag 7" } }

Description

To add ports to LAG using POST method

Body
{ "openconfig-if-aggregate:aggregate-id": "lag 7" }

Description

Create dynamic LAG using POST method

Body
{ "interface" : [ { "name": "lag 4", "config": { "name": "lag 4", "type": "iana-if-type:ieee8023adLag", "enabled": true }, "openconfig-if-aggregate:aggregation": { "config": { "lag-type": "LACP" } } } ] }

Description

To create static LAG using POST method

Body
{ "interface": [ { "name": "lag 4", "config": { "name": "lag 4", "type": "iana-if-type:ieee8023adLag", "enabled": true }, "openconfig-if-aggregate:aggregation": { "config": { "lag-type": "STATIC" } } } ] }

Description

create/update dynamic LAG using PATCH

Body
{ "interfaces": { "interface" : [ { "name": "lag 7", "config": { "name": "lag 7", "type": "iana-if-type:ieee8023adLag", "enabled": true }, "openconfig-if-aggregate:aggregation": { "config": { "lag-type": "LACP" } } } ] } }

Description

create/update static LAG using PATCH method

Body
{ "interfaces": { "interface" : [ { "name": "lag 6", "config": { "name": "lag 6", "type": "iana-if-type:ieee8023adLag", "enabled": true }, "openconfig-if-aggregate:aggregation": { "config": { "lag-type": "STATIC" } } } ] } }

Description

To get/read LAG configured on specific interface


Description

To get/read specific LAG configured in the system


Description

To get/read all LAG interfaces configured in the system


LLDP 10

Description

To disable lldp on interface using PATCH method

Body
{ "interfaces" : { "interface": [ { "name": "ethernet 1/1/1", "config": { "name": "ethernet 1/1/1", "enabled": false } } ] } }

Description

To disable global level lldp using PUT method

Body
{ "config": { "enabled": false } }

Description

To disable global level lldp using PATCH method

Body
{ "config": { "enabled": false } }

Description

To enable global level lldp using PATCH method

Body
{ "config": { "enabled": true } }

Description

To enable global level lldp using PUT method

Body
{ "config": { "enabled": true } }

Description

To enable lldp on specific interface using PATCH method

Body
{ "interfaces" : { "interface": [ { "name": "ethernet 1/1/1", "config": { "name": "ethernet 1/1/1", "enabled": true } } ] } }

Description

To get global lldp status


Description

To get lldp status of all interfaces


Description

To get/read lldp status of all interfaces


Description

To read/get lldp status of specific interface


OSPF 10

Body
{ "protocol": [ { "identifier": "OSPF", "name":"icx-ospf", "config" : { "identifier": "OSPF", "name":"icx-ospf" }, "ospfv2": { "areas": { "area": [ { "identifier": "0.0.0.0", "config": { "identifier": "0.0.0.0" } } ] } } } ] }

Description

bind interfce(assign ip address) to an ospf area using patch operation

Body
{ "interfaces": { "interface": [ { "id": "ethernet 1/1/3", "config": { "id": "ethernet 1/1/3" } } ] } }

Description

bind interface(assign ip address) to an ospf area using POST operation

Body
{ "interface": [ { "id": "ethernet 1/1/2", "config": { "id": "ethernet 1/1/2" } } ] }

Description

To create/update ospf area using PATCH method

Body
{ "protocols": { "protocol": [ { "identifier": "OSPF", "name":"icx-ospf", "config" : { "identifier": "OSPF", "name":"icx-ospf" }, "ospfv2": { "areas": { "area": [ { "identifier": "20.1.1.1", "config": { "identifier": "20.1.1.1" } } ] } } } ] } }

Description

To delete all ospf areas configured in the system


Description

delete specific ospf area configured in the system


Description

To get/read all ospf areas configured in the system


Description

To get/read specific ospf area configured in the system


Description

remove all interface binding from the opsf area


Description

remove interface binding from the ospf interface


PoE 10

Description

To disable PoE on specific interface using PATCH method

Body
{ "poe": { "config": { "enabled": false } } }

Description

To disable PoE on specific interface

Body
{ "poe": { "config": { "enabled": false } } }

Description

enable PoE on specific interface using PoE method

Body
{ "poe": { "config": { "enabled": true } } }

Description

To enable PoE on specific interface using PUT method

Body
{ "poe": { "config": { "enabled": true } } }

Description

To read/get PoE enabled status on specific interface


Description

To read/get PoE status/values on all interfaces


Description

To read/get configured PoE status on specific interface


Description

To get/read poe state values on specific values


Description

To read/get power-class on specific PoE interface


Description

To read/get power-used on specific PoE interface


STP 7

Description

To delete rstp on specific vlan


Description

To disable bpdu-guard on interface using PATCH method

Body
{ "interfaces": { "interface": [ { "name": "ethernet 1/1/4", "config": { "name": "ethernet 1/1/4", "bpdu-guard": false } } ] } }

Description

To enable STP on vlan using POST method

Body
{ "vlan": [ { "vlan-id": 20, "config": { "vlan-id": 20 } } ] }

Description

To enable bpdu-guard on interface using PATCH

Headers
KeyValueDescription
Content-Typeapplication/json
Body
{ "interfaces": { "interface": [ { "name": "ethernet 1/1/4", "config": { "name": "ethernet 1/1/4", "bpdu-guard": true } } ] } }

Description

To enable rstp on vlan using PATCH

Body
{ "rapid-pvst": { "vlan": [ { "vlan-id": 30, "config": { "vlan-id": 30 } } ] } }

Description

To get/read default stp status

Body
{ "openconfig-interfaces:interfaces": { "interface": [ { "name": "ethernet 1/1/1", "config": { "name": "ethernet 1/1/1", "type": "iana-if-type:ethernetCsmacd", "description": "", "enabled": false } } ] } }

Description

To get/read rstp on specific vlan


Static Route 5

Description

To create static route using POST method

Body
{ "protocol": { "identifier": "openconfig-policy-types:STATIC", "name": "icx-static", "config": { "identifier": "openconfig-policy-types:STATIC", "name": "icx-static" }, "static-routes": { "static": [ { "prefix": "44.1.1.1/16", "config": { "prefix": "44.1.1.1/16" }, "next-hops": { "next-hop": [ { "index": "10.176.128.1", "config": { "index": "10.176.128.1", "next-hop": "10.176.128.1" } } ] } } ] } } }

Description

To create/update static route using PATCH method

Body
{ "protocols": { "protocol": { "identifier": "openconfig-policy-types:STATIC", "name": "icx-static", "config": { "identifier": "openconfig-policy-types:STATIC", "name": "icx-static" }, "static-routes": { "static": [ { "prefix": "55.1.1.1/16", "config": { "prefix": "55.1.1.1/16" }, "next-hops": { "next-hop": [ { "index": "10.176.128.1", "config": { "index": "10.176.128.1", "next-hop": "10.176.128.1" } } ] } } ] } } } }

Description

To delete a specific static route configured in the system using delete method


Description

To get all static routes configured in the system


Description

To get/read specific static route configured in the system


VLAN 13

Description

create/replace vlans using PUT operation

Body
{ "vlans": { "vlan": [ { "vlan-id": 20, "config": { "vlan-id": 20, "name": "user-vlan-20" } }, { "vlan-id": 1, "config": { "vlan-id": 1, "name": "DEFAULT-VLAN" } } ] } }

Description

To delete untag ports from access vlans using delete method on specific interface


Description

To get/read vlans configured on specific vlans


Description

To delete a specific vlan using DELETE method


Description

To read/get specific vlan using GET method


Description

To create new vlan using POST method

Body
{ "vlan": [ { "vlan-id": 10, "config": { "vlan-id": 10, "name": "user-vlan-10" } } ] }

Description

To delete tagging ports from vlan using PATCH


Description

To get/read all vlans configured in the system


Description

Tagging ports in trunk vlans using PATCH method

Body
{ "openconfig-vlan:switched-vlan": { "config": { "trunk-vlans": [10,20,30] } } }

Description

tag ports in trunk vlans using POST method

Body
{ "config": { "trunk-vlans": [10,20,30] } }

Description

Untag ports in access vlans using PATCH method

Body
{ "openconfig-vlan:switched-vlan": { "config": { "access-vlan": 20 } } }

Description

untag ports in access vlan using POST method

Body
{ "config": { "access-vlan": 10 } }

Description

To update/create vlan using PATCH method

Body
{ "vlans": { "vlan": [ { "vlan-id": 20, "config": { "vlan-id": 20, "name": "user-vlan-20" } } ] } }

Virtual interface 6

Description

To create virtual interface with ip address using POST method

Body
{ "interface": [ { "name": "ve 40", "config": { "name": "ve 40", "type": "iana-if-type:l3ipvlan" }, "openconfig-vlan:routed-vlan": { "config": { "vlan": 40 }, "openconfig-if-ip:ipv4": { "addresses": { "address": [ { "ip": "40.1.1.1", "config": { "ip": "40.1.1.1", "prefix-length": 25 } } ] } } } } ] }

Description

To cretae/update virtual interface using PATCH method

Body
{ "interfaces": { "interface": [ { "name": "ve 60", "config": { "name": "ve 60", "type": "iana-if-type:l3ipvlan" } } ] } }

Description

To create/update virtual interface with ip address using PATCH method

Body
{ "interfaces": { "interface": [ { "name": "ve 70", "config": { "name": "ve 70", "type": "iana-if-type:l3ipvlan" }, "openconfig-vlan:routed-vlan": { "config": { "vlan": 70 }, "openconfig-if-ip:ipv4": { "addresses": { "address": [ { "ip": "70.1.1.1", "config": { "ip": "70.1.1.1", "prefix-length": 25 } } ] } } } } ] } }

Description

To create virtual interface using POST method

Body
{ "interface": [ { "name": "ve 50", "config": { "name": "ve 50", "type": "iana-if-type:l3ipvlan" } } ] }

Description

To delete specific virtual interface


Description

To get/read specific virtual interface