get-tunnel-info

Retrieves the summary of one or more tunnels from the switch.

Resource URIs


URI	Description
<base_URI>/operations/get-tunnel-info	Retrieves the summary of one or more tunnels from the switch. Output contains tunnel records sorted in the ascending order of tunnel ID.

Input Parameters

page-cursor: Opaque data identifying the next page, returned by previous RPC call. RPC returns first page data if this value is not present or empty.
node-id: Node from which the tunnel information is to be retrieved. If not specified, data is retrieved from all nodes.
choice filter-type: Input filter.
case filter-by-id: Filter by tunnel ID. Output can have at most only one tunnel information. The last-rcvd-record-id parameter is ignored.
case filter-by-mode: Filter by tunnel mode.
case filter-by-gateway: Filter by overlay gateway name.
case filter-by-sip: Filter by tunnel source IP. Only IPv4 addresses are supported in this release.
case filter-by-dip: Filter by tunnel destination IP. Only IPv4 addresses are supported in this release.
case filter-by-cfg-src: Filter by configuration source.
case filter-by-site: Filter by overlay site name.
case filter-by-opr-state: Filter by tunnel oper state.
case filter-by-bfd-state: Filter by tunnel bfd state.

Output Parameters

tunnel id: Displays the tunnel ID.
mode: Displays the tunnel encapsulation type.
src-ip: Displays the tunnel source IP address.
dest-ip: Displays the tunnel destination IP address.
vrf: Displays the tunnel vrf; encapsulated frames are routed to destination IP address in this vrf.
config-src: Displays the tunnel configuration source which indicates how the tunnel was created.
admin-state: Displays the tunnel admin state
oper-state: Displays the tunnel oper state.
bfd-state: Displays the tunnel bfd state. No value will be returned if bfd is not enabled on this tunnel.
container nodes: Displays the nodes from which this tunnel data is retrieved.
node-id: Displays the node ID.
has-conflicts: Indicates this tunnel has conflicting data across nodes. Client can repeat the rpc with node-id filter to inspect data from specific node.
next-page-cursor: Opaque data identifying the next page. Client must pass this value as 'page-cursor' parameter in following RPC to retrieve next page tunnel data. Value will not be present if no more tunnel records exist i.e. if current page is the last page.

Usage Guidelines

Only POST operation is supported.

Examples

URI

http://host:80/rest/operations/get-tunnel-info

<get-tunnel-info></get-tunnel-info>

<output xmlns='urn:brocade.com:mgmt:brocade-tunnels-ext'>
  <tunnel>
    <id>61441</id>
    <mode>vxlan</mode>
    <src-ip>107.107.107.10</src-ip>
    <dest-ip>107.107.107.2</dest-ip>
    <vrf>default-vrf</vrf>
    <config-src>site-config</config-src>
    <admin-state>up</admin-state>
    <oper-state>up</oper-state>
    <nodes>
      <node-id>1</node-id>
    </nodes>
  </tunnel>
</output>