RmVrfProto

Description

API


    GET /api/placement/vrf
	Query Params: PlacementVrfFilter
    GET /api/placement/vrf/&ltkey>
	Query Params: PlacementVrfFilter

CLI


    show placement vrf filter [vrf_uuid]

Data

RmVrfProto

vrf_context

Type
VrfContext
Category
required
Description

VrfContext

uuid

Type
string
Category
required
Description

name

Type
string
Category
required
Description

static_routes

Type
StaticRoute
Category
repeated
Description

bgp_profile

Type
BgpProfile
Category
optional
Description
Bgp Local and Peer Info

system_default

Type
bool
Category
optional,readonly
Description
Default
False

gateway_mon

Type
GatewayMonitor
Category
repeated
Description
Configure ping based heartbeat check for gateway in service engines of vrf.

internal_gateway_monitor

Type
InternalGatewayMonitor
Category
optional
Description
Configure ping based heartbeat check for all default gateways in service engines of vrf.

debugvrfcontext

Type
DebugVrfContext
Category
optional
Description
Configure debug flags for VRF

description

Type
string
Category
optional
Description

tenant_ref

Type
Reference to Tenant
Category
optional
Description

cloud_ref

Type
Reference to Cloud
Category
optional
Description
Default
/api/cloud?name=Default-Cloud

StaticRoute

prefix

Type
IpAddrPrefix
Category
required
Description

next_hop

Type
IpAddr
Category
required
Description

if_name

Type
string
Category
optional
Description

route_id

Type
string
Category
required
Description

disable_gateway_monitor

Type
bool
Category
optional
Description
Disable the gateway monitor for default gateway. They are monitored by default.

IpAddrPrefix

ip_addr

Type
IpAddr
Category
required
Description

mask

Type
int32
Category
required
Description

IpAddr

addr

Type
string
Category
required
Description
IP address

type

Type
enum
Category
required
Description
Choices
V4, DNS

BgpProfile

local_as

Type
uint32
Category
required
Description
Local Autonomous System ID

ibgp

Type
bool
Category
required
Description
BGP peer type
Default
True

peers

Type
BgpPeer
Category
repeated
Description
BGP Peers

keepalive_interval

Type
uint32
Category
optional
Description
Keepalive interval for Peers
Default
60

hold_time

Type
uint32
Category
optional
Description
Hold time for Peers
Default
180

send_community

Type
bool
Category
optional
Description
Send community attribute to all peers
Default
True

community

Type
string
Category
repeated
Description
Set the community attribute - "internet", "local-AS", "no-advertise", "no-export", : One or more of these can be configured with 1 <= AS,Val <= 65535

BgpPeer

remote_as

Type
uint32
Category
optional
Description
Peer Autonomous System ID
Default
1

peer_ip

Type
IpAddr
Category
required
Description
IP Address of the BGP Peer

subnet

Type
IpAddrPrefix
Category
required
Description
Subnet providing reachability for Peer

md5_secret

Type
string
Category
optional
Description
Peer Autonomous System Md5 Digest Secret Key

bfd

Type
bool
Category
optional
Description
Enable Bi-Directional Forward Detection. Only async mode supported.
Default
True

network_uuid

Type
string
Category
optional
Description
Network providing reachability for Peer
Default

advertise_vip

Type
bool
Category
optional
Description
Advertise VIP to this Peer
Default
True

advertise_snat_ip

Type
bool
Category
optional
Description
Advertise SNAT IP to this Peer
Default
True

advertisement_interval

Type
uint32
Category
optional
Description
Advertisement interval for this Peer
Default
5

connect_timer

Type
uint32
Category
optional
Description
Connect timer for this Peer
Default
10

keepalive_interval

Type
uint32
Category
optional
Description
Keepalive interval for this Peer
Default
60

hold_time

Type
uint32
Category
optional
Description
Hold time for this Peer
Default
180

GatewayMonitor

gateway_ip

Type
IpAddr
Category
required
Description
IP address of next hop gateway to be monitored

gateway_monitor_interval

Type
uint32
Category
optional
Description
The interval between two ping requests sent by the gateway monitor in milliseconds. If a value is not specified, requests are sent every second.
Default
1000

gateway_monitor_fail_threshold

Type
uint32
Category
optional
Description
The number of consecutive failed gateway health checks before a gateway is marked down.
Default
10

gateway_monitor_success_threshold

Type
uint32
Category
optional
Description
The number of consecutive successful gateway health checks before a gateway that was marked down by the gateway monitor is marked up.
Default
15

InternalGatewayMonitor

gateway_monitor_interval

Type
uint32
Category
optional
Description
The interval between two ping requests sent by the gateway monitor in milliseconds. If a value is not specified, requests are sent every second.
Default
1000

gateway_monitor_failure_threshold

Type
uint32
Category
optional
Description
The number of consecutive failed gateway health checks before a gateway is marked down.
Default
10

gateway_monitor_success_threshold

Type
uint32
Category
optional
Description
The number of consecutive successful gateway health checks before a gateway that was marked down by the gateway monitor is marked up.
Default
15

disable_gateway_monitor

Type
bool
Category
optional
Description
Disable the gateway monitor for default gateway. They are monitored by default.
Default
False

DebugVrfContext

flags

Type
DebugVrf
Category
repeated
Description

DebugVrf

flag

Type
enum
Category
required
Description
Choices
DEBUG_VRF_BGP, DEBUG_VRF_ALL, DEBUG_VRF_NONE

References

Tenant Cloud

Sub Objects

Filters

PlacementVrfFilter

vrf_uuid

Type
string
Category
optional
Description