route-map

Resource URIs


URI	Description
<base_URI>/config/running/route-map/{name},{action-rm},{instance}	Configures route-map instance.


GET URIs	Description
<base_URI>/config/running/route-map/{name},{action-rm},{instance}	Configures a route-map instance.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match	Matches conditions.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/vrf	Match condition specified as a non-default VRF. Valid values range from 0 through 4294967295.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/interface	Matches interface conditions in a route-map instance.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/interface/ethernet	Specifies an ethernet interface.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/interface/loopback	Specifies a loopback interface.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/interface/ve	Specifies a virtual Ethernet VLAN interface
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/ipv6	Matches Internet Protocol (IPv6).
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/ipv6/address	Matches an IPv6 address in a route-map instance.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/ipv6/address/acl	Matches an IP address in a route-map instance and specifies access list.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/ip	Internet Protocol (IP).
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/ap/address	Matches an IP address in a route-map instance
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/ip/address/acl	Specifies the name of the access list
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/ip/next-hop	Matches IP next-hop match conditions in a route-map instance
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set	Set values.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ip	Internet Protocol (IP).
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ip/dscp	DSCP
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ip/dscp/dscp-rms	DSCP
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ip/interface	Interface
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ip/interface/null0	Sends traffic to a Null0 Interface.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ip/next-hop	Sets the IPv4 address of the next hop in a route-map instance.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ip/next-hop/peer-address	BGP peer IP address
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ip/next-hop/next-hop-list/{next-hop-addr}	Sets the IPv4 address of the next hop in a route-map instance.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ip/global	Global
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ip/global/next-global-hop/{next-hop}	Sets next global hop.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ip/next-vrf-list/{vrf},{next-hop}	Sets next VRF list.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ipv6	Internet Protocol (IPv6).
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ipv6/interface	IPv6 interface.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ipv6/interface/null0	Sends traffic to a Null0 Interface.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ipv6/global	Global
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ipv6/global/next-global-hop/{next-hop}	Sets next global hop.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ipv6/next-hop/{next-hop}	Sets the IPv6 address of the next hop in a route-map instance.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ipv6/next-vrf-list/{vrf},{next-hop}	Sets next VRF list.


POST URIs	Payload	Description
<base_URI>/config/running	<route-map><name>{common-def:name-string63}</name><action-rm>{action-t}</action-rm><instance>{instance-id-t}</instance></route-map>	Configures a route-map instance.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ip/next-hop	<next-hop-list><next-hop-addr>{inet:ipv4-address}</next-hop-addr></next-hop-list>	Configure a IPv4 next hop address.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ip/global	<next-global-hop><next-hop>{inet:ipv4-address}</next-hop></next-global-hop>	Sets next global hop.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ip	<next-vrf-list><vrf>{string}</vrf><next-hop>{inet:ipv4-address}</next-hop></next-vrf-list>	Sets next VRF list.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ipv6/global	<next-global-hop><next-hop>{inet:ipv6-address}</next-hop></next-global-hop>	Sets next global hop.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ipv6	<next-hop><next-hop>{inet:ipv6-address}</next-hop></next-hop>	Sets the IPv6 address of the next hop in a route-map instance.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ipv6	<next-vrf-list><vrf>{string}</vrf><next-hop>{inet:ipv6-address}</next-hop></next-vrf-list>	Sets next VRF list.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/	<next-hop-recursion>true</next-hop-recursion>	Enables recursive next hop resolution for PBR route-maps.


PATCH URIs	Payload	Description
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match	<match><vrf>{common-def:vrf-name}</vrf></match>	Match condition specified as a non-default VRF. Valid values range from 0 through 4294967295.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/interface	<interface><ethernet>{interface:interface-type}</ethernet></interface>	Specifies an ethernet interface.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/interface	<interface><loopback>{loopback-intf:intf-loopback-port-type}</loopback></interface>	Specifies a loopback interface.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/interface	<interface><ve>{interface:ve-type}</ve></interface>	Specifies a virtual Ethernet VLAN interface
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/ipv6/address	<address><acl>{ipv6-access-list:ipv6-l3-acl-policy-name}</acl></address>	Route address IPv6 ACL
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/ipv6/next-hop	<next-hop><prefix-list>{ipv6-prefix-name-t}</prefix-list></next-hop>	Route next hop address IPv6 prefix-list
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/ip/address	<address><acl>{ip-access-list:l3-acl-policy-name}</acl></address>	Route address IP ACL.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ip/interface	<interface><null0>{enumeration}</null0></interface>	Sends traffic to a Null0 Interface
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ipv6/interface	<interface><null0>{enumeration}</null0></interface>	Sends traffic to a Null0 Interface


PUT URIs	Payload	Description
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/vrf	<vrf>{common-def:vrf-name}</vrf>	Match condition specified as a non-default VRF. Valid values range from 0 through 4294967295.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/interface/ethernet	<ethernet>{interface:interface-type}</ethernet>	Specifies an ethernet interface.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/interface/loopback	<loopback>{loopback-intf:intf-loopback-port-type}</loopback>	Specifies a loopback interface.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/interface/ve	<ve>{interface:ve-type}</ve>	Specifies a virtual Ethernet VLAN interface
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/ipv6/address/acl	<acl>{ipv6-access-list:ipv6-l3-acl-policy-name}</acl>	Route address IPv6 ACL
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/ip/address/acl	<acl>{ip-access-list:l3-acl-policy-name}</acl>	Route address IP ACL.
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ip/interface/null0	<null0>true</null0>	Sends traffic to a Null0 Interface
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ipv6/interface/null0	<null0>true</null0>	Sends traffic to a Null0 Interface


DELETE URIs
<base_URI>/config/running/route-map/{name},{action-rm},{instance}
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/ipv6/address/acl
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/ipv6/next-hop/prefix-list
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/match/ip/address/acl
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ip/interface/null0
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ip/next-hop/next-hop-list/{next-hop-addr}
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ip/global/next-global-hop/{next-hop}
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ip/next-vrf-list/{vrf},{next-hop}
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ipv6/interface/null0
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ipv6/global/next-global-hop/{next-hop}
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ipv6/next-hop/{next-hop}
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/set/ipv6/next-vrf-list/{vrf},{next-hop}
<base_URI>/config/running/route-map/{name},{action-rm},{instance}/next-hop-recursion

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/route-map/rm1,permit,1

None

<route-map xmlns="urn:brocade.com:mgmt:brocade-ip-policy" xmlns:y="http://brocade.com/ns/rest" 
y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1">
  <name>rm1</name>
  <action-rm>permit</action-rm>
  <instance>1</instance>
  <match y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/match">
    <interface y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/match/interface">
    </interface>
    <ipv6 y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/match/ipv6">
      <address y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/match/ipv6/address">
      </address>
      <next-hop y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/match/ipv6/next-hop">
      </next-hop>
      <route-source y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/match/ipv6/route-source">
      </route-source>
    </ipv6>
    <ip y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/match/ip">
      <address y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/match/ip/address">
        <acl>acl2</acl>
      </address>
      <next-hop y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/match/ip/next-hop">
      </next-hop>
      <route-source y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/match/ip/route-source">
      </route-source>
    </ip>
    <extcommunity y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/match/extcommunity">
    </extcommunity>
    <metric y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/match/metric">
    </metric>
    <route-type y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/match/route-type">
    </route-type>
    <tag y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/match/tag">
    </tag>
    <as-path y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/match/as-path">
    </as-path>
    <community y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/match/community">
    </community>
    <protocol y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/match/protocol">
    </protocol>
  </match>
  <set y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set">
    <ip y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/ip">
      <dscp y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/ip/dscp">
      </dscp>
      <interface y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/ip/interface">
      </interface>
      <next-hop y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/ip/next-hop">
        <next-hop-list y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/ip/next-hop/
next-hop-list/24.24.24.2">
          <next-hop-addr>24.24.24.2</next-hop-addr>
        </next-hop-list>
      </next-hop>
      <global y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/ip/global">
      </global>
    </ip>
    <ipv6 y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/ipv6">
      <interface y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/ipv6/interface">
      </interface>
      <global y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/ipv6/global">
      </global>
    </ipv6>
    <extcommunity y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/extcommunity">
      <rt y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/extcommunity/rt">
      </rt>
      <soo y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/extcommunity/soo">
      </soo>
    </extcommunity>
    <community y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/community">
    </community>
    <metric y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/metric">
    </metric>
    <distance y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/distance">
    </distance>
    <tag y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/tag">
    </tag>
    <weight y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/weight">
    </weight>
    <as-path y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/as-path">
    </as-path>
    <automatic-tag y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/automatic-tag">
    </automatic-tag>
    <comm-list y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/comm-list">
    </comm-list>
    <dampening y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/dampening">
    </dampening>
    <local-preference y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/local-preference">
    </local-preference>
    <origin y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/origin">
    </origin>
    <metric-type y:self="/rest/config/running/route-map/rm1%2Cpermit%2C1/set/metric-type">
    </metric-type>
  </set>
</route-map>

URI

The following example uses the POST option to configure an IPv4 next hop address.

http://host:80/rest/config/running/config/running/route-map/rm1,permit,1/set/ip/next-hop

<next-hop-list><next-hop-addr>{24.24.24.2}</next-hop-addr></next-hop-list>

None

URI

The following example uses the DELETE option to remove a route map instance.

http://host:80/rest/config/running/route-map/rm1,permit,1

None

URI

The following example uses the POST option to enable recursive next hop resolution for PBR route-maps.

http://host:80/rest/config/running/route-map/rm1,permit,1/next-hop-recursion

<next-hop-recursion>true</next-hop-recursion>

None