get-vlan-brief

Retrieves the operational data for a given VLAN and enumeration of all the interfaces belonging to the VLAN.

Resource URIs


URI	Description
<base_URI>/operations/get-vlan-brief	Retrieves the operational data for a given VLAN and enumeration of all the interfaces belonging to the VLAN.

Parameters

vlan-id: Displays the VLAN ID.
vlan-type: Displays the VLAN type.
vlan-name: Displays the administrative name of the VLAN.
vlan-state: Displays the operational state of the VLAN.
last-vlan-id: Displays the last VLAN record that has been fetched.

Usage Guidelines

Only POST operation is supported.

Examples

URI

http://host:80/rest/operations/get-vlan-brief

<get-vlan-brief></get-vlan-brief>

If the entire information cannot be retrieved in a single execution, the last lines of output says has-more=true. In such cases the remaining information can be retrieved using "last-rcvd-interface" as shown in the request body below.

<get-vlan-brief xmlns="urn:brocade.com:mgmt:brocade-interface-ext">
  <last-rcvd-vlan-id>1</last-rcvd-vlan-id>
</get-vlan-brief>

<output xmlns='urn:brocade.com:mgmt:brocade-interface-ext'>
  <configured-vlans-count>1</configured-vlans-count>
  <provisioned-vlans-count>1</provisioned-vlans-count>
  <unprovisioned-vlans-count>0</unprovisioned-vlans-count>
  <vlan>
    <vlan-id>1</vlan-id>
    <vlan-type>static</vlan-type>
    <vlan-name>default</vlan-name>
    <vlan-state>suspend</vlan-state>
  </vlan>
  <last-vlan-id>1</last-vlan-id>
  <has-more>false</has-more>
</output>