Avi VIMgrNWRuntime Object API

CLI ``` - show vinfra network ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 21.1.6
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /vimgrnwruntime
  2. post /vimgrnwruntime
  3. delete /vimgrnwruntime/{uuid}
  4. get /vimgrnwruntime/{uuid}
  5. patch /vimgrnwruntime/{uuid}
  6. put /vimgrnwruntime/{uuid}
Up
get /vimgrnwruntime
(vimgrnwruntimeGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — 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.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
cloud_uuid (optional)
Query Parameter — Filter to get objects that belongs to a specific cloud using its uuid. Eg. cloud_uuid=cloud-xyz.
cloud_ref.name (optional)
Query Parameter — 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.

Return type

VIMgrNWRuntimeApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "dvs" : true,
    "availability_zone" : "aeiou",
    "tenant_name" : "aeiou",
    "interested_nw" : true,
    "vrf_context_ref" : "aeiou",
    "vm_refs" : [ "aeiou" ],
    "vlan_range" : [ {
      "start" : 123,
      "end" : 123
    } ],
    "host_refs" : [ "aeiou" ],
    "MgmtNW" : true,
    "num_ports" : 123,
    "datacenter_uuid" : "aeiou",
    "type" : "aeiou",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "ip_subnet" : [ {
      "fip_subnet_uuids" : [ "aeiou" ],
      "ip_subnet" : "aeiou",
      "fip_available" : true,
      "prefix" : "",
      "name" : "aeiou",
      "floatingip_subnets" : [ {
        "prefix" : {
          "ip_addr" : {
            "addr" : "aeiou",
            "type" : "aeiou"
          },
          "mask" : 123
        },
        "name" : "aeiou",
        "uuid" : "aeiou"
      } ],
      "ref_count" : 123,
      "uuid" : "aeiou",
      "se_ref_count" : 123,
      "primary" : true
    } ],
    "vlan" : 123,
    "cloud_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "apic_vrf_context" : "aeiou",
    "name" : "aeiou",
    "auto_expand" : true,
    "switch_name" : "aeiou",
    "managed_object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VIMgrNWRuntimeApiResponse

401

log in failed

Up
post /vimgrnwruntime
(vimgrnwruntimePost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — VIMgrNWRuntime object creation

Return type

VIMgrNWRuntime

Example data

Content-Type: application/json
{
  "dvs" : true,
  "availability_zone" : "aeiou",
  "tenant_name" : "aeiou",
  "interested_nw" : true,
  "vrf_context_ref" : "aeiou",
  "vm_refs" : [ "aeiou" ],
  "vlan_range" : [ {
    "start" : 123,
    "end" : 123
  } ],
  "host_refs" : [ "aeiou" ],
  "MgmtNW" : true,
  "num_ports" : 123,
  "datacenter_uuid" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "ip_subnet" : [ {
    "fip_subnet_uuids" : [ "aeiou" ],
    "ip_subnet" : "aeiou",
    "fip_available" : true,
    "prefix" : "",
    "name" : "aeiou",
    "floatingip_subnets" : [ {
      "prefix" : {
        "ip_addr" : {
          "addr" : "aeiou",
          "type" : "aeiou"
        },
        "mask" : 123
      },
      "name" : "aeiou",
      "uuid" : "aeiou"
    } ],
    "ref_count" : 123,
    "uuid" : "aeiou",
    "se_ref_count" : 123,
    "primary" : true
  } ],
  "vlan" : 123,
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "apic_vrf_context" : "aeiou",
  "name" : "aeiou",
  "auto_expand" : true,
  "switch_name" : "aeiou",
  "managed_object_id" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VIMgrNWRuntime

401

log in failed

Up
delete /vimgrnwruntime/{uuid}
(vimgrnwruntimeUuidDelete)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found

Up
get /vimgrnwruntime/{uuid}
(vimgrnwruntimeUuidGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — 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.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

VIMgrNWRuntime

Example data

Content-Type: application/json
{
  "dvs" : true,
  "availability_zone" : "aeiou",
  "tenant_name" : "aeiou",
  "interested_nw" : true,
  "vrf_context_ref" : "aeiou",
  "vm_refs" : [ "aeiou" ],
  "vlan_range" : [ {
    "start" : 123,
    "end" : 123
  } ],
  "host_refs" : [ "aeiou" ],
  "MgmtNW" : true,
  "num_ports" : 123,
  "datacenter_uuid" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "ip_subnet" : [ {
    "fip_subnet_uuids" : [ "aeiou" ],
    "ip_subnet" : "aeiou",
    "fip_available" : true,
    "prefix" : "",
    "name" : "aeiou",
    "floatingip_subnets" : [ {
      "prefix" : {
        "ip_addr" : {
          "addr" : "aeiou",
          "type" : "aeiou"
        },
        "mask" : 123
      },
      "name" : "aeiou",
      "uuid" : "aeiou"
    } ],
    "ref_count" : 123,
    "uuid" : "aeiou",
    "se_ref_count" : 123,
    "primary" : true
  } ],
  "vlan" : 123,
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "apic_vrf_context" : "aeiou",
  "name" : "aeiou",
  "auto_expand" : true,
  "switch_name" : "aeiou",
  "managed_object_id" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VIMgrNWRuntime

401

log in failed

Up
patch /vimgrnwruntime/{uuid}
(vimgrnwruntimeUuidPatch)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — VIMgrNWRuntime object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

VIMgrNWRuntime

Example data

Content-Type: application/json
{
  "dvs" : true,
  "availability_zone" : "aeiou",
  "tenant_name" : "aeiou",
  "interested_nw" : true,
  "vrf_context_ref" : "aeiou",
  "vm_refs" : [ "aeiou" ],
  "vlan_range" : [ {
    "start" : 123,
    "end" : 123
  } ],
  "host_refs" : [ "aeiou" ],
  "MgmtNW" : true,
  "num_ports" : 123,
  "datacenter_uuid" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "ip_subnet" : [ {
    "fip_subnet_uuids" : [ "aeiou" ],
    "ip_subnet" : "aeiou",
    "fip_available" : true,
    "prefix" : "",
    "name" : "aeiou",
    "floatingip_subnets" : [ {
      "prefix" : {
        "ip_addr" : {
          "addr" : "aeiou",
          "type" : "aeiou"
        },
        "mask" : 123
      },
      "name" : "aeiou",
      "uuid" : "aeiou"
    } ],
    "ref_count" : 123,
    "uuid" : "aeiou",
    "se_ref_count" : 123,
    "primary" : true
  } ],
  "vlan" : 123,
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "apic_vrf_context" : "aeiou",
  "name" : "aeiou",
  "auto_expand" : true,
  "switch_name" : "aeiou",
  "managed_object_id" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VIMgrNWRuntime

401

log in failed

Up
put /vimgrnwruntime/{uuid}
(vimgrnwruntimeUuidPut)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — VIMgrNWRuntime object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

VIMgrNWRuntime

Example data

Content-Type: application/json
{
  "dvs" : true,
  "availability_zone" : "aeiou",
  "tenant_name" : "aeiou",
  "interested_nw" : true,
  "vrf_context_ref" : "aeiou",
  "vm_refs" : [ "aeiou" ],
  "vlan_range" : [ {
    "start" : 123,
    "end" : 123
  } ],
  "host_refs" : [ "aeiou" ],
  "MgmtNW" : true,
  "num_ports" : 123,
  "datacenter_uuid" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "ip_subnet" : [ {
    "fip_subnet_uuids" : [ "aeiou" ],
    "ip_subnet" : "aeiou",
    "fip_available" : true,
    "prefix" : "",
    "name" : "aeiou",
    "floatingip_subnets" : [ {
      "prefix" : {
        "ip_addr" : {
          "addr" : "aeiou",
          "type" : "aeiou"
        },
        "mask" : 123
      },
      "name" : "aeiou",
      "uuid" : "aeiou"
    } ],
    "ref_count" : 123,
    "uuid" : "aeiou",
    "se_ref_count" : 123,
    "primary" : true
  } ],
  "vlan" : 123,
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "apic_vrf_context" : "aeiou",
  "name" : "aeiou",
  "auto_expand" : true,
  "switch_name" : "aeiou",
  "managed_object_id" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VIMgrNWRuntime

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. FloatingIpSubnet
  2. IpAddr
  3. IpAddrPrefix
  4. VIMgrIPSubnetRuntime
  5. VIMgrNWRuntime
  6. VIMgrNWRuntimeApiResponse
  7. VlanRange

FloatingIpSubnet Up

name
String FloatingIp subnet name if available, else uuid. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prefix (optional)
IpAddrPrefix FloatingIp subnet prefix. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
uuid (optional)
String FloatingIp subnet uuid. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

IpAddr Up

addr
String IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
type
String Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

IpAddrPrefix Up

ip_addr
IpAddr Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mask
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

VIMgrIPSubnetRuntime Up

fip_available (optional)
Boolean If true, capable of floating/elastic IP association. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
fip_subnet_uuids (optional)
array[String] If fip_available is True, this is list of supported FIP subnets, possibly empty if Cloud does not support such a network list. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
floatingip_subnets (optional)
array[FloatingIpSubnet] If fip_available is True, the list of associated FloatingIP subnets, possibly empty if unsupported or implictly defined by the Cloud. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip_subnet (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prefix
IpAddrPrefix Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
primary (optional)
Boolean True if prefix is primary IP on interface, else false. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ref_count (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
se_ref_count (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

VIMgrNWRuntime Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
apic_vrf_context (optional)
String Field deprecated in 21.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
auto_expand (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
availability_zone (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cloud_ref (optional)
String It is a reference to an object of type Cloud. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
datacenter_uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dvs (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
host_refs (optional)
array[String] It is a reference to an object of type VIMgrHostRuntime. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
interested_nw (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip_subnet (optional)
array[VIMgrIPSubnetRuntime] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
managed_object_id
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
MgmtNW (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
num_ports (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
switch_name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
type
String Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
String url
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vlan (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
vlan_range (optional)
array[VlanRange] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vm_refs (optional)
array[String] It is a reference to an object of type VIMgrVMRuntime. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vrf_context_ref (optional)
String It is a reference to an object of type VrfContext. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

VIMgrNWRuntimeApiResponse Up

count
Integer format: int32
results
next (optional)

VlanRange Up

end
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
start
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32