HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

/system/vrfs/{name}

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Reference Resource: VRF
VRF identifier. Should be alphanumeric. VRF names must be unique.

Body Params
string
string
source_ip
object

Source IP that should be used by various protocols. If both 'source_ip' and 'source_interface' are configured, 'source_ip' takes the precedence.

string
string
dhcpv6_snooping_authorized_servers
array of strings
length ≤ 20

When configured, switch forwards DHCPv6 reply packets on trusted ports only if packet is from one of the authorized servers.

dhcpv6_snooping_authorized_servers
boolean

If the value is true, then only L3VPN support is enabled for this VRF.

boolean

Enable SNMP server.

string
string
string

Reference Resource: ACL
IPv4 ACL, potentially in flight, desired to be applied to control plane traffic, as identified in the ACL.

string

Reference Resource: DHCP_Server
DHCPv4 Server in the VRF.

string
rip_routers
object

Reference Resource: RIP_Router
The list of all the RIP IPv4 Router instances.

dns_host_v4_address_mapping
object

List of static host address configurations and the IPv4 address associated with them.

pim_routers
object

Reference Resource: PIM_Router
PIM router entries keyed by IP version. This can have one PIM_Router entry per IP version.

ripng_routers
object

Reference Resource: RIP_Router
The list of all the RIPng (RIP IPv6) Router instances.

bgp_routers
object

Reference Resource: BGP_Router
BGP routers keyed by ASN value.

dhcpv4_snooping_authorized_servers
array of strings
length ≤ 20

When configured, switch forwards DHCPv4 reply packets on trusted ports only if packet is from one of the authorized servers.

dhcpv4_snooping_authorized_servers
dns_name_servers
object

Name servers to be used for address resolution, keyed by the resolution priority order

int64
-9007199254740991 to 9007199254740991

The version of the 'aclv4_control_plane_cfg' column. This value should be changed to a random value each time any management interface modifies the 'aclv4_control_plane_cfg' value. An empty value means no IPv4 control plane ACL has been configured for the VRF.

string

Reference Resource: ACL
IPv6 ACL, potentially in flight, desired to be applied to control plane traffic, as identified in the ACL.

dns_host_v6_address_mapping
object

List of static host address configurations and the IPv6 address associated with them.

boolean

If the value is true, then SSH server is enabled on this VRF.

string
string
length ≤ 256

Domain name used for name resolution by the DNS client, if dns_domain_list is not configured. If both the configurations are not present, name resolution is performed with empty domain suffix.

https_server
object
ospf_routers
object

Reference Resource: OSPF_Router
The list of all the OSPFv2 Router instances.

source_interface
object

Reference Resource: Port
Interface, which should be used as a source by various protocols. If both 'source_ip' and 'source_interface' are configured, 'source_ip' takes the precedence.

ospfv3_routers
object

Reference Resource: OSPF_Router
The list of all the OSPFv3 Router instances.

string

Reference Resource: DHCPV6_Server
DHCPv6 Server in the VRF.

string
length ≤ 22

Route distinguisher in ASN:nn format or IP:nn format.

string

Reference Resource: MSDP_Router
Multicast Source Discovery Protocol Router.

dns_domain_list
object

Domain list names to be used for address resolution, keyed by the resolution priority order

vrf_address_families
object

Reference Resource: VRF_Address_Family
Reference to specific address family details.

int64
-9007199254740991 to 9007199254740991

The version of the 'aclv6_control_plane_cfg' column. This value should be changed to a random value each time any management interface modifies the 'aclv6_control_plane_cfg' value. An empty value means no IPv6 control plane ACL has been configured for the VRF.

string
Responses
200

OK

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language
LoadingLoading…