interface/tunnel

Configures a tunnel.

Resource URIs


URI	Description
<base_URI>/config/running/interface/tunnel	Configures a tunnel.


GET URIs	Description
<base_URI>/config/running/interface/tunnel/{identifier}/mode	Retrieves tunnel encapsulation method.
<base_URI>/config/running/interface/tunnel/{identifier}/source	Retrieves source of tunnel.
<base_URI>/config/running/interface/tunnel/{identifier}/destination	Retrieves destination IP address.
<base_URI>/config/running/interface/tunnel/{identifier}/ttl	Retrieves tunnel TTL.
<base_URI>/config/running/interface/tunnel/{identifier}/dscp	Retrieves tunnel DSCP.
<base_URI>/config/running/interface/tunnel/{identifier}/name	Retrieves tunnel name.
<base_URI>/config/running/interface/tunnel/{identifier}/dscp-ttl-mode	Retrieves tunnel DSCP TTL mode.
<base_URI>/config/running/interface/tunnel/{identifier}/statistics	Retrieves tunnel statistics.
<base_URI>/config/running/interface/tunnel/{identifier}/keepalive	Retrieves tunnel keepalive.
<base_URI>/config/running/interface/tunnel/{identifier}/keepalive/retry-count	Retrieves retry count.


POST URIs	Payload	Description
<base_URI>/config/running/interface	<tunnel><identifier>{uint32}</identifier></tunnel>	Creates a tunnel.


PUT URIs	Payload	Description
<base_URI>/config/running/interface/tunnel/{identifier}/mode/gre/ip	<ip>{enumeration}</ip>	Enables generic routing encapsulation (GRE) over a tunnel interface and specifies that the tunneling protocol is IPv4.
<base_URI>/config/running/tunnel/{identifier}/source/source-address	<source-address>{inet:ipv4-address}</source-address>	Configures the source IP address.
<base_URI>/config/running/interface/tunnel/{identifier}/destination	<destination>{inet:ipv4-address}</destination>	Configures the destination IP address.
<base_URI>/config/running/interface/tunnel/{identifier}/router-interface/ve	<ve>{uint32}</ve>	Configures the router interface for a tunnel.
<base_URI>/config/running/interface/tunnel/{identifier}/ttl	<ttl>{uint32}</ttl>	Configures Tunnel TTL.
<base_URI>/config/running/interface/tunnel/{identifier}/dscp	<dscp>{uint32}</dscp>	Configures Tunnel DSCP.
<base_URI>/config/running/interface/tunnel/{identifier}/statistics	<statistics>{enumeration}</statistics>	Configures Tunnel statistics.
<base_URI>/config/running/interface/tunnel/{identifier}/keepalive	<keepalive><time-interval>{uint32}</time-interval><retry-count>{uint32}</retry-count></keepalive>	Configures Tunnel keepalive.


DELETE URIs
<base_URI>/config/running/interface/tunnel/{identifier}

Parameters

identifier: Specifies the tunnel identifier. Valid values range from 1 through 1024.
ve num: Specifies a virtual router interface number. Valid values range from 1 through 4095.
ttl: Specifies the tunnel TTL range. Valid values range from 1 through 255.
dscp: Specifies the tunnel DSCP range. Valid values range from 0 through 63.
time-interval: Specifies the tunnel keepalive time interval. Valid values range from 1 through 32767.
retry-count: Specifies the tunnel keepalive retry count. Valid values range from 1 through 255.

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/interface/tunnel/1/mode

None

<mode xmlns="urn:brocade.com:mgmt:brocade-gre-vxlan" xmlns:y="http://brocade.com/ns/rest" 
y:self="/rest/config/running/interface/tunnel/1/mode">
  <gre y:self="/rest/config/running/interface/tunnel/1/mode/gre">
    <ip>true</ip>
  </gre>
</mode>

URI

The following is an example of the PUT operation to configure GRE over a tunnel interface and specifies that the tunneling protocol is IPv4..

http://host:80/rest/config/running/interface/tunnel/1/mode/gre/ip

<ip>true</ip>

None

URI

The following is an example of the DELETE operation to remove a tunnel.

http://host:80/rest/config/running/interface/tunnel/1

None