/system/vrfs/{VRF.name}

patch

https://switch-ip/rest/v10.16/system/vrfs/{VRF.name}

Path Params

VRF.name

string

required

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

Body Params

aclv4_control_plane_cfg

string

Reference Resource: ACL
IPv4 ACL, potentially in flight, desired to be applied to control plane traffic, as identified in the ACL. An empty column value indicates that no list is applied for this type and direction.

aclv4_control_plane_cfg_version

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 column value will indicate that the user does not want the system to process this configuration yet.

aclv6_control_plane_cfg

string

Reference Resource: ACL
IPv6 ACL, potentially in flight, desired to be applied to control plane traffic, as identified in the ACL. An empty column value indicates that no list is applied for this type and direction.

aclv6_control_plane_cfg_version

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 column value will indicate that the user does not want the system to process this configuration yet.

bgp_routers

object

Reference Resource: BGP_Router
BGP routers keyed by ASN value.

default_loose_nexthop_resolution_ipv4

boolean

If the value is false, then default route shall not be used in recursive routes resolution of IPv4 routes.

default_loose_nexthop_resolution_ipv6

boolean

If the value is false, then default route shall not be used in recursive routes resolution of IPv6 routes.

dhcp_server

string

Reference Resource: DHCP_Server
DHCPv4 Server in the VRF.

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

dhcpv6_server

string

Reference Resource: DHCPV6_Server
DHCPv6 Server in the VRF.

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

dns_domain_list

object

Domain list names to be used for address resolution, keyed by the resolution priority order. This column value can be empty.

dns_domain_name

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. This column value can be empty.

dns_host_v4_address_mapping

object

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

dns_host_v6_address_mapping

object

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

dns_name_servers

object

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

evpn_export_route_targets

array of strings

length ≤ 32

BGP route targets, formatted as ASN:NN or A.B.C.D:NN, to be sent with the EVPN routes exported from the VRF. Option 'auto' to export auto-generated route-targets from the VRF.

evpn_export_route_targets

evpn_import_route_targets

array of strings

length ≤ 32

BGP route targets, formatted as ASN:NN or A.B.C.D:NN, to be matched to the EVPN routes being imported into the VRF. Option 'auto' to import based on auto-generated route-targets into the VRF.

evpn_import_route_targets

https_server

object

l3vpn_only_enable

boolean

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

msdp_router

string

Reference Resource: MSDP_Router
Multicast Source Discovery Protocol Router. If this is not set, MSDP will be disabled on this VRF.

multicast_multipath_hash

object

Hashing algorithm to be used to decide the nexthop when multiple equal cost paths exist to reach a given source address. S-hash : This method uses only the source address to compute the hash to pick the nexthop. S-G-hash : This method uses source and group address in the hash calculation. If not set, the global configuration specified for the system will be used. If set, then it overrides the globally configured value.

ntp_associations

string

ntp_conductors

string

ospf_routers

object

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

ospfv3_af4_routers

object

Reference Resource: OSPF_Router
The list of all the OSPFv3 Router instances for IPv4 Unicast Address Family.

ospfv3_af6_routers

object

Reference Resource: OSPF_Router
The list of all the OSPFv3 Router instances for IPv6 Unicast Address Family.

ospfv3_af_routers

object

Reference Resource: OSPFv3_AF_Router
The list of all the OSPFv3 Router instances for IPv4 & IPv6 Unicast Address Family.

ospfv3_routers

object

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

pim_routers

object

Reference Resource: PIM_Router
PIM router entries keyed by IP version. This can have one PIM_Router entry per IP version. If this is not set, then PIM will be disabled on this VRF.

radius_dynamic_authorization_clients

string

radius_servers

string

length between 3 and 22

Route distinguisher in ASN:nn format or IP:nn format. This is optional.

rip_routers

object

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

ripng_routers

object

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

snmp_enable

boolean

Enable SNMP server.

snmpv2_mib_traps

object

snmpv3_contexts

string

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.

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.

ssh_enable

boolean

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

static_neighbors

string

static_routes

string

tacacs_servers

string

telnet_server_enable

boolean

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

ubt_zones

string

vrf_address_families

object

Reference Resource: VRF_Address_Family
Reference to specific address family details.

Responses

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

Response

Click Try It! to start a request and see the response here!