GET /vrfcontext
/vrfcontext
object name
Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=
Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=
List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
Default values are not set.
It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Filter to get objects that belongs to a specific cloud using its uuid. Eg. cloud_uuid=cloud-xyz.
Filter to get objects that belongs to a specific cloud usings its name. This uses cloud name rather than uuid. Eg. cloud_ref.name=Default-Cloud.
Filter to get objects that belongs to a specific cloud using its uuid. Eg. cloud_ref.uuid=cloud_uuid.
Filter to get objects with name that contains the parameter. This is a case sensitive search. Eg. name.contains=pool-.
Filter to get objects with name that contains the parameter. This is a case insensitive search. Eg. name.icontains=pool-.
Filter to get objects that have a uuid matching any of the values in the parameter list. Each value for this parameter is to comma separated. Eg. name.in=pool-1,pool-12.
Filter to get objects that have a uuid matching any of the values in the parameter list. Each value for this parameter is to comma separated. Eg. uuid.in=
Filter to get objects that contains the search string as value for any of its fields. Eg. search=LEAST_CONN. The search filter can also be used to search under a specific field. This is achieved by sending the parameter as ?search=(
Filter to get objects that contains case insensitive search string. Eg. isearch=(name,Vs-Pool-).
Filter to limit the number of objects in the response data. Eg. limit_by=3.
Filter to exclude the uuid(s) contained in the parameter. Eg. uuid.in=
Parameter to sort the results with respect to a field. Eg. sort=name.
Parameter to specify the maximum number of results to be returned per page. The page_size can range from 1 to 200. Eg. page_size=5.
Avi Tenant Header
Avi Tenant Header UUID
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.
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.
OK
{
"count": 0,
"results": [
{
"_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"
}
],
"next": "string"
}count
results
next
log in failed
curl -H 'Authorization: <value>' https://{api_host}/api/vrfcontext