Avi VIMgrNWRuntime Object API

CLI ``` - show vinfra network ```

More information: https://avinetworks.com/contact-us

Contact Info: support@avinetworks.com

Version: 20.1.9

BasePath:/api

http://apache.org/licenses/LICENSE-2.0.html

Access

HTTP Basic Authentication

Methods

[ Jump to Models ]

get /vimgrnwruntime
post /vimgrnwruntime
delete /vimgrnwruntime/{uuid}
get /vimgrnwruntime/{uuid}
patch /vimgrnwruntime/{uuid}
put /vimgrnwruntime/{uuid}

get /vimgrnwruntime

(vimgrnwruntimeGet)

Consumes

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

application/json

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 request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK VIMgrNWRuntimeApiResponse

401

post /vimgrnwruntime

(vimgrnwruntimePost)

Consumes

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

application/json

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 request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK VIMgrNWRuntime

401

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:

application/json

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 request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204

object deleted String

404

not found

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:

application/json

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 request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK VIMgrNWRuntime

401

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:

application/json

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 request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK VIMgrNWRuntime

401

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:

application/json

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 request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK VIMgrNWRuntime

401

Models

[ Jump to Methods ]

FloatingIpSubnet
IpAddr
IpAddrPrefix
VIMgrIPSubnetRuntime
VIMgrNWRuntime
VIMgrNWRuntimeApiResponse
VlanRange

FloatingIpSubnet Up

name

String FloatingIp subnet name if available, else uuid. Field introduced in 17.2.1.

prefix (optional)

IpAddrPrefix FloatingIp subnet prefix. Field introduced in 17.2.1.

uuid (optional)

String FloatingIp subnet uuid. Field introduced in 17.2.1.

IpAddr Up

addr

String IP address.

type

String Enum options - V4, DNS, V6.

IpAddrPrefix Up

ip_addr

IpAddr Placeholder for description of property ip_addr of obj type IpAddrPrefix field type str type object

mask

Integer Number of mask. format: int32

VIMgrIPSubnetRuntime Up

fip_available (optional)

Boolean If true, capable of floating/elastic IP association.

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.

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.

ip_subnet (optional)

String ip_subnet of VIMgrIPSubnetRuntime.

name (optional)

String Name of the object.

prefix

IpAddrPrefix Placeholder for description of property prefix of obj type VIMgrIPSubnetRuntime field type str type object

primary (optional)

Boolean True if prefix is primary IP on interface, else false.

ref_count (optional)

Integer Number of ref_count. format: int32

se_ref_count (optional)

Integer Number of se_ref_count. format: int32

uuid (optional)

String Unique object identifier of the object.

VIMgrNWRuntime Up

_last_modified (optional)

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

apic_vrf_context (optional)

String apic_vrf_context of VIMgrNWRuntime.

auto_expand (optional)

Boolean Placeholder for description of property auto_expand of obj type VIMgrNWRuntime field type str type boolean

availability_zone (optional)

String availability_zone of VIMgrNWRuntime.

cloud_ref (optional)

String It is a reference to an object of type Cloud.

datacenter_uuid (optional)

String Unique object identifier of datacenter.

dvs (optional)

Boolean Placeholder for description of property dvs of obj type VIMgrNWRuntime field type str type boolean

host_refs (optional)

array[String] It is a reference to an object of type VIMgrHostRuntime.

interested_nw (optional)

Boolean Placeholder for description of property interested_nw of obj type VIMgrNWRuntime field type str type boolean

ip_subnet (optional)

array[VIMgrIPSubnetRuntime] Placeholder for description of property ip_subnet of obj type VIMgrNWRuntime field type str type object

managed_object_id

String managed_object_id of VIMgrNWRuntime.

MgmtNW (optional)

Boolean Placeholder for description of property MgmtNW of obj type VIMgrNWRuntime field type str type boolean

name

String Name of the object.

num_ports (optional)

Integer Number of num_ports. format: int32

switch_name (optional)

String switch_name of VIMgrNWRuntime.

tenant_name (optional)

String tenant_name of VIMgrNWRuntime.

tenant_ref (optional)

String It is a reference to an object of type Tenant.

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.

url (optional)

String url

uuid (optional)

String Unique object identifier of the object.

vlan (optional)

Integer Number of vlan. format: int32

vlan_range (optional)

array[VlanRange] Placeholder for description of property vlan_range of obj type VIMgrNWRuntime field type str type object

vm_refs (optional)

array[String] It is a reference to an object of type VIMgrVMRuntime.

vrf_context_ref (optional)

String It is a reference to an object of type VrfContext.

VIMgrNWRuntimeApiResponse Up

count

Integer format: int32

results

array[VIMgrNWRuntime]

next (optional)

String

VlanRange Up

end

Integer Number of end. format: int32

start

Integer Number of start. format: int32

Avi VIMgrNWRuntime Object API

Access

Table of Contents

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Request body

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

204

404

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Table of Contents