PUT /vrfcontext/{uuid}

PUT /vrfcontext/{uuid}

/vrfcontext/{uuid}

Request
URI
PUT
https://{api_host}/api/vrfcontext/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.


Request Body

VrfContext object creation

VrfContext of type(s) application/json
Optional

Show optional properties

{
    "name": "string"
}
{
    "_last_modified": "string",
    "attrs": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "bfd_profile": {
        "minrx": 0,
        "mintx": 0,
        "multi": 0
    },
    "bgp_profile": {
        "community": [
            "string"
        ],
        "hold_time": 0,
        "ibgp": false,
        "ip_communities": [
            {
                "community": [
                    "string"
                ],
                "ip_begin": {
                    "addr": "string",
                    "type": "string"
                },
                "ip_end": {
                    "addr": "string",
                    "type": "string"
                }
            }
        ],
        "keepalive_interval": 0,
        "local_as": 0,
        "local_preference": 0,
        "num_as_path_prepend": 0,
        "peers": [
            {
                "advertise_snat_ip": false,
                "advertise_vip": false,
                "advertisement_interval": 0,
                "bfd": false,
                "connect_timer": 0,
                "ebgp_multihop": 0,
                "hold_time": 0,
                "ibgp_local_as_override": false,
                "keepalive_interval": 0,
                "label": "string",
                "local_as": 0,
                "md5_secret": "string",
                "network_ref": "string",
                "peer_ip": {
                    "addr": "string",
                    "type": "string"
                },
                "peer_ip6": {
                    "addr": "string",
                    "type": "string"
                },
                "remote_as": 0,
                "shutdown": false,
                "subnet": {
                    "ip_addr": {
                        "addr": "string",
                        "type": "string"
                    },
                    "mask": 0
                },
                "subnet6": {
                    "ip_addr": {
                        "addr": "string",
                        "type": "string"
                    },
                    "mask": 0
                }
            }
        ],
        "routing_options": [
            {
                "advertise_default_route": false,
                "advertise_learned_routes": false,
                "label": "string",
                "learn_only_default_route": false,
                "learn_routes": false,
                "max_learn_limit": 0
            }
        ],
        "send_community": false,
        "shutdown": false
    },
    "cloud_ref": "string",
    "configpb_attributes": {
        "version": 0
    },
    "debugvrfcontext": {
        "command_buffer_interval": 0,
        "command_buffer_size": 0,
        "flags": [
            {
                "flag": "string"
            }
        ]
    },
    "description": "string",
    "gateway_mon": [
        {
            "gateway_ip": {
                "addr": "string",
                "type": "string"
            },
            "gateway_monitor_fail_threshold": 0,
            "gateway_monitor_interval": 0,
            "gateway_monitor_success_threshold": 0,
            "subnet": {
                "ip_addr": {
                    "addr": "string",
                    "type": "string"
                },
                "mask": 0
            }
        }
    ],
    "internal_gateway_monitor": {
        "disable_gateway_monitor": false,
        "gateway_monitor_failure_threshold": 0,
        "gateway_monitor_interval": 0,
        "gateway_monitor_success_threshold": 0
    },
    "lldp_enable": false,
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "name": "string",
    "static_routes": [
        {
            "disable_gateway_monitor": false,
            "if_name": "string",
            "labels": [
                {
                    "key": "string",
                    "value": "string"
                }
            ],
            "next_hop": {
                "addr": "string",
                "type": "string"
            },
            "prefix": {
                "ip_addr": {
                    "addr": "string",
                    "type": "string"
                },
                "mask": 0
            },
            "route_id": "string"
        }
    ],
    "system_default": false,
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
Responses
200

OK

Returns VrfContext of type(s) application/json
"VrfContext Object"
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

array of object
attrs
Optional

Key/value vrfcontext attributes. Field introduced in 20.1.2. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

object
bfd_profile
Optional

bfd_profile

object
bgp_profile
Optional

bgp_profile

string
cloud_ref
Optional

It is a reference to an object of type Cloud. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

object
configpb_attributes
Optional

configpb_attributes

object
debugvrfcontext
Optional

debugvrfcontext

string
description
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of object
gateway_mon
Optional

Configure ping based heartbeat check for gateway in service engines of vrf. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

object
internal_gateway_monitor
Optional

internal_gateway_monitor

boolean
lldp_enable
Optional
Constraints: default: true

Enable LLDP. Field introduced in 18.2.10, 20.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- true), Basic edition(Allowed values- true), Enterprise with Cloud Services edition.

array of object
markers
Optional

List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

string
name
Required

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of object
static_routes
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
system_default
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string"}' https://{api_host}/api/vrfcontext/{uuid}