topology-group

Configures topology VLAN group for L2 protocols.

Resource URIs

URI Description
<base_URI>/config/running/topology-group Configures topology vlan group for L2 protocols.
GET URIa Description
<base_URI>/config/running/topology-group Retrieves topology group configuration details.
<base_URI>/config/running/topology-group/{group-id} Retrieves information for a particular topology group.
<base_URI>/config/running/topology-group/{group-id}/master-vlan Retrieves information about master VLAN.
<base_URI>/config/running/topology-group/{group-id}/member-vlan Retrieves information about member VLAN.
POST URIs Payload Description
<base_URI>/config/running/topology-group <topology-group><topology-group-id>(unit32)</topology-group-id></topology-group> Configures topology group.
PATCH URIs Payload Description
<base_URI>/config/running/topology-group/{group-id}/master-vlan <master-vlan>(unit32)</master-vlan> Configures master VLAN.
<base_URI>/config/running/topology-group/{group-id}/member-vlan <member-vlan><add>(unit32)</add></member-vlan> Adds member VLAN.
<base_URI>/config/running/topology-group/{group-id}/member-vlan <member-vlan><remove>(unit32)</remove></member-vlan> Removes member VLAN.
<base_URI>/config/running/topology-group/{group-id}/member-vlan/remove <remove>(unit32)</remove> Removes member VLAN.
PUT URIs Payload Description
<base_URI>/config/running/topology-group/{group-id}/master-vlan <master-vlan>(unit32)</master-vlan> Configures master VLAN.
<base_URI>/config/running/topology-group/{group-id}/member-vlan <member-vlan><add>(unit32)</add></member-vlan> Adds member VLAN.
<base_URI>/config/running/topology-group/{group-id}/member-vlan/add <add>(unit32)</add> Removes member VLAN.
<base_URI>/config/running/topology-group/{group-id}/member-vlan/remove <remove>(unit32)</remove> Removes member VLAN.
DELETE URIs
<base_URI>/config/running/topology-group/{group-id}/master-vlan
<base_URI>/config/running/topology-group/{group-id}/member-vlan
<base_URI>/config/running/topology-group/{group-id}/member-vlan/add/(vlan-id)
<base_URI>/config/running/topology-group/{group-id}/member-vlan/remove/(vlan-id)

Parameters

group-id
Specifies topology group ID.
member-vlan
Configures member VLANs.
master-vlan
Configures master VLANs.

Usage Guidelines

GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD operations are supported.

Examples

URI

The following example uses the GET option to retrieve the configuration details.

http://host:80/rest/config/running/topology-group 

<topology-group>
  <topology-group-id>1</topology-group-id>
</topology-group>

None

URI

The following example uses the DELETE option to remove Topology group master VLAN.

http://host:80/rest/config/running/topology-group/1/master-vlan

None

None

9036681-01 Rev AA