RESTCONF API for VLAN CLI Command

This section provides the Representational State Transfer Configuration Protocol (RESTCONF) API sections for the VLAN CLI command.

POST or PATCH

To access the top-level interfaces resource within the openconfig-relay-agent YANG model, use the following URL:

https://$ip:8080/rest/restconf/data/openconfig-relay-agent: relay-agent/dhcp/interfaces/interface=<vlan-id>/agent-information-option

Use this API operation to do the following:

Configure DHCP Relay information on a VLAN.

Sample server response:

{
     " openconfig-relay-agent: agent-information-option": 
     {
         "config":
          {
               "enable": "<true | false>",   
               "circuit-id": "<circuit id>",     
               "remote-id":"<remote id>"  
          }
     } 

{

GET

To access the top-level interfaces resource within the openconfig-relay-agent YANG model, use the following URL:

https://$ip:8080/rest/restconf/data/openconfig-relay-agent: relay-agent/dhcp/interfaces/interface=<vlan-id>/agent-information-option

Use this API operation to do the following:

Get DHCP Relay configuration on a VLAN interface.

Sample server response:

Based on Yang Model

DELETE

To access the top-level interfaces resource within the openconfig-relay-agent YANG model, use the following URL:

https://$ip:8080/rest/restconf/data/openconfig-relay-agent: relay-agent/dhcp/interfaces/interface=<vlan-id>

Use this API operation to do the following:

Remove DHCP Relay configuration on a VLAN interface.