vrf

Configures, modifies, or retrieves VRF configurations.

Resource URIs


URI	Description
<base_URI>/config/running/vrf	VRF configurations.


GET URIs	Description
<base_URI>/config/running/vrf/{vrf-name}	VRF configurations.
<base_URI>/config/running/vrf/{vrf-name}/address-family/ipv4/unicast	Retrieves IPv4 address family configurations.
<base_URI>/config/running/vrf/{vrf-name}/address-family/ipv4/unicast/max-route	Retrieves IPv4 address family max route.
<base_URI>/config/running/vrf/{vrf-name}/address-family/ipv6/unicast	Retrieves IPv6 address family configurations.
<base_URI>/config/running/vrf/{vrf-name}/address-family/ipv6/unicast/max-route	Retrieves IPv6 address family max route.
/config/running/vrf/{vrf-name}/rd	Configures route-distinguisher to identify a VRF.
/config/running/vrf/{vrf-name}/vpn-statistics	Enables VPN statistics for a VRF.
/config/running/vrf/{vrf-name}/address-family/ipv4/unicast/import/map	Imports a map.
/config/running/vrf/{vrf-name}/address-family/ipv4/unicast/export/map	Exports a map.
<base_URI>/config/running/vrf/{vrf-name}/ip/router-id	Retrieves IP route details.


POST URIs	Payload	Description
<base_URI>/config/running/	<vrf>(name)</vrf>	Configures VRF.
<base_URI>/config/running/vrf/{vrf-name}/address-family/ipv4	<unicast />	Configures unicast IPv4 address family.
<base_URI>/config/running/vrf/{vrf-name}/address-family/ipv6	<unicast />	Configures unicast IPv6 address family.


PUT URIs	Payload	Description
<base_URI>/config/running/vrf/{vrf-name}/ip/router-id	<router-id>(ip-address)</router-id>	Configures IP route.
<base_URI>/config/running/vrf/{vrf-name}/address-family/ipv4/unicast/max-route	<max-route>(unit32)</max-route>	Configures unicast IPv4 address family max-route.
<base_URI>/config/running/vrf/{vrf-name}/address-family/ipv6/unicast/max-route	<max-route>(unit32)</max-route>	Configures unicast IPv6 address family max route.
<base_URI>/config/running/vrf/{vrf-name}	<rd>(ASN:NN)</rd>	Configures the route distinguisher.


DELETE URIs
<base_URI>/config/running/vrf/{vrf-name}/ip/router-id
<base_URI>/config/running/vrf/{vrf-name}/address-family/ipv4/unicast/max-route
<base_URI>/config/running/vrf/{vrf-name}/address-family/ipv6/unicast/max-route
<base_URI>/config/running/vrf/{vrf-name}

Parameters

vrf-name: Specifies the VRF name.
rd: Specifies the ASN number.
max-route: Specifies the maximum number of routes.
router-id: Specifies IP address.

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/vrf

None

<vrf xmlns="urn:brocade.com:mgmt:brocade-vrf" xmlns:y="http://brocade.com/ns/rest" y:self="/rest/config/running/vrf/mgmt-vrf">
  <vrf-name>mgmt-vrf</vrf-name>
  <rd>1:2</rd>
  <address-family y:self="/rest/config/running/vrf/mgmt-vrf/address-family">
    <ipv4 y:self="/rest/config/running/vrf/mgmt-vrf/address-family/ipv4">
      <unicast y:self="/rest/config/running/vrf/mgmt-vrf/address-family/ipv4/unicast">
        <max-route>129</max-route>        
      </unicast>
    </ipv4>
    <ipv6 y:self="/rest/config/running/vrf/mgmt-vrf/address-family/ipv6">
      <unicast y:self="/rest/config/running/vrf/mgmt-vrf/address-family/ipv6/unicast">
      </unicast>
    </ipv6>
  </address-family>
  <ip y:self="/rest/config/running/vrf/mgmt-vrf/ip">
    <router-id>1.1.1.1</router-id>
  </ip>
  <ipv6 y:self="/rest/config/running/vrf/mgmt-vrf/ipv6">
    <router-id>1.2.1.1</router-id>
  </ipv6>
</vrf>

URI

The following is an example of the POST operation to add a VRF.

http://host:80/rest/config/running

<vrf>vrf1</vrf>

None

URI

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

http://host:80/rest/config/running/vrf/vrf1

None