Avi VIMgrVMRuntime Object API

##CLI## ``` - show vinfra virtualmachine ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
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 /vimgrvmruntime
  2. post /vimgrvmruntime
  3. delete /vimgrvmruntime/{uuid}
  4. get /vimgrvmruntime/{uuid}
  5. patch /vimgrvmruntime/{uuid}
  6. put /vimgrvmruntime/{uuid}
Up
get /vimgrvmruntime
( vimgrvmruntimeGet)

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.
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

VIMgrVMRuntimeApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "controller_ip_addr" : "aeiou",
    "memory" : 123456789,
    "connection_state" : "aeiou",
    "type" : "aeiou",
    "uuid" : "aeiou",
    "ovf_avisetype_field" : "aeiou",
    "powerstate" : "aeiou",
    "vcenter_vAppName" : "aeiou",
    "vcenter_vAppVendor" : "aeiou",
    "se_ver" : 123,
    "vm_lb_weight" : 123,
    "vcenter_datacenter_uuid" : "aeiou",
    "creation_in_progress" : true,
    "cloud_ref" : "aeiou",
    "host" : "aeiou",
    "vcenter_se_type" : "aeiou",
    "memory_reservation" : 123456789,
    "vcenter_rm_cookie" : "aeiou",
    "availability_zone" : "aeiou",
    "mem_shares" : 123,
    "vcenter_vnic_discovered" : true,
    "vcenter_vm_type" : "aeiou",
    "num_cpu" : 123,
    "url" : "aeiou",
    "cpu_reservation" : 123456789,
    "controller_vm" : true,
    "guest_nic" : [ {
      "connected" : true,
      "mac_addr" : "aeiou",
      "mgmt_vnic" : true,
      "guest_ip" : [ {
        "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
      } ],
      "network_name" : "aeiou",
      "label" : "aeiou",
      "network_uuid" : "aeiou",
      "avi_internal_network" : true,
      "type" : "aeiou",
      "del_pending" : true,
      "os_port_uuid" : "aeiou"
    } ],
    "controller_cluster_uuid" : "aeiou",
    "init_vnics" : 123,
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "vcenter_template_vm" : true,
    "cpu_shares" : 123,
    "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 VIMgrVMRuntimeApiResponse

401

log in failed

Up
post /vimgrvmruntime
( vimgrvmruntimePost)

Consumes

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

Request body

body (required)
Body Parameter — VIMgrVMRuntime object creation

Return type

VIMgrVMRuntime

Example data

Content-Type: application/json
{
  "controller_ip_addr" : "aeiou",
  "memory" : 123456789,
  "connection_state" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "ovf_avisetype_field" : "aeiou",
  "powerstate" : "aeiou",
  "vcenter_vAppName" : "aeiou",
  "vcenter_vAppVendor" : "aeiou",
  "se_ver" : 123,
  "vm_lb_weight" : 123,
  "vcenter_datacenter_uuid" : "aeiou",
  "creation_in_progress" : true,
  "cloud_ref" : "aeiou",
  "host" : "aeiou",
  "vcenter_se_type" : "aeiou",
  "memory_reservation" : 123456789,
  "vcenter_rm_cookie" : "aeiou",
  "availability_zone" : "aeiou",
  "mem_shares" : 123,
  "vcenter_vnic_discovered" : true,
  "vcenter_vm_type" : "aeiou",
  "num_cpu" : 123,
  "url" : "aeiou",
  "cpu_reservation" : 123456789,
  "controller_vm" : true,
  "guest_nic" : [ {
    "connected" : true,
    "mac_addr" : "aeiou",
    "mgmt_vnic" : true,
    "guest_ip" : [ {
      "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
    } ],
    "network_name" : "aeiou",
    "label" : "aeiou",
    "network_uuid" : "aeiou",
    "avi_internal_network" : true,
    "type" : "aeiou",
    "del_pending" : true,
    "os_port_uuid" : "aeiou"
  } ],
  "controller_cluster_uuid" : "aeiou",
  "init_vnics" : 123,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "vcenter_template_vm" : true,
  "cpu_shares" : 123,
  "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 VIMgrVMRuntime

401

log in failed

Up
delete /vimgrvmruntime/{uuid}
( vimgrvmruntimeUuidDelete)

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 /vimgrvmruntime/{uuid}
( vimgrvmruntimeUuidGet)

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.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

VIMgrVMRuntime

Example data

Content-Type: application/json
{
  "controller_ip_addr" : "aeiou",
  "memory" : 123456789,
  "connection_state" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "ovf_avisetype_field" : "aeiou",
  "powerstate" : "aeiou",
  "vcenter_vAppName" : "aeiou",
  "vcenter_vAppVendor" : "aeiou",
  "se_ver" : 123,
  "vm_lb_weight" : 123,
  "vcenter_datacenter_uuid" : "aeiou",
  "creation_in_progress" : true,
  "cloud_ref" : "aeiou",
  "host" : "aeiou",
  "vcenter_se_type" : "aeiou",
  "memory_reservation" : 123456789,
  "vcenter_rm_cookie" : "aeiou",
  "availability_zone" : "aeiou",
  "mem_shares" : 123,
  "vcenter_vnic_discovered" : true,
  "vcenter_vm_type" : "aeiou",
  "num_cpu" : 123,
  "url" : "aeiou",
  "cpu_reservation" : 123456789,
  "controller_vm" : true,
  "guest_nic" : [ {
    "connected" : true,
    "mac_addr" : "aeiou",
    "mgmt_vnic" : true,
    "guest_ip" : [ {
      "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
    } ],
    "network_name" : "aeiou",
    "label" : "aeiou",
    "network_uuid" : "aeiou",
    "avi_internal_network" : true,
    "type" : "aeiou",
    "del_pending" : true,
    "os_port_uuid" : "aeiou"
  } ],
  "controller_cluster_uuid" : "aeiou",
  "init_vnics" : 123,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "vcenter_template_vm" : true,
  "cpu_shares" : 123,
  "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 VIMgrVMRuntime

401

log in failed

Up
patch /vimgrvmruntime/{uuid}
( vimgrvmruntimeUuidPatch)

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 — VIMgrVMRuntime object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

VIMgrVMRuntime

Example data

Content-Type: application/json
{
  "controller_ip_addr" : "aeiou",
  "memory" : 123456789,
  "connection_state" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "ovf_avisetype_field" : "aeiou",
  "powerstate" : "aeiou",
  "vcenter_vAppName" : "aeiou",
  "vcenter_vAppVendor" : "aeiou",
  "se_ver" : 123,
  "vm_lb_weight" : 123,
  "vcenter_datacenter_uuid" : "aeiou",
  "creation_in_progress" : true,
  "cloud_ref" : "aeiou",
  "host" : "aeiou",
  "vcenter_se_type" : "aeiou",
  "memory_reservation" : 123456789,
  "vcenter_rm_cookie" : "aeiou",
  "availability_zone" : "aeiou",
  "mem_shares" : 123,
  "vcenter_vnic_discovered" : true,
  "vcenter_vm_type" : "aeiou",
  "num_cpu" : 123,
  "url" : "aeiou",
  "cpu_reservation" : 123456789,
  "controller_vm" : true,
  "guest_nic" : [ {
    "connected" : true,
    "mac_addr" : "aeiou",
    "mgmt_vnic" : true,
    "guest_ip" : [ {
      "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
    } ],
    "network_name" : "aeiou",
    "label" : "aeiou",
    "network_uuid" : "aeiou",
    "avi_internal_network" : true,
    "type" : "aeiou",
    "del_pending" : true,
    "os_port_uuid" : "aeiou"
  } ],
  "controller_cluster_uuid" : "aeiou",
  "init_vnics" : 123,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "vcenter_template_vm" : true,
  "cpu_shares" : 123,
  "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 VIMgrVMRuntime

401

log in failed

Up
put /vimgrvmruntime/{uuid}
( vimgrvmruntimeUuidPut)

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 — VIMgrVMRuntime object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

VIMgrVMRuntime

Example data

Content-Type: application/json
{
  "controller_ip_addr" : "aeiou",
  "memory" : 123456789,
  "connection_state" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "ovf_avisetype_field" : "aeiou",
  "powerstate" : "aeiou",
  "vcenter_vAppName" : "aeiou",
  "vcenter_vAppVendor" : "aeiou",
  "se_ver" : 123,
  "vm_lb_weight" : 123,
  "vcenter_datacenter_uuid" : "aeiou",
  "creation_in_progress" : true,
  "cloud_ref" : "aeiou",
  "host" : "aeiou",
  "vcenter_se_type" : "aeiou",
  "memory_reservation" : 123456789,
  "vcenter_rm_cookie" : "aeiou",
  "availability_zone" : "aeiou",
  "mem_shares" : 123,
  "vcenter_vnic_discovered" : true,
  "vcenter_vm_type" : "aeiou",
  "num_cpu" : 123,
  "url" : "aeiou",
  "cpu_reservation" : 123456789,
  "controller_vm" : true,
  "guest_nic" : [ {
    "connected" : true,
    "mac_addr" : "aeiou",
    "mgmt_vnic" : true,
    "guest_ip" : [ {
      "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
    } ],
    "network_name" : "aeiou",
    "label" : "aeiou",
    "network_uuid" : "aeiou",
    "avi_internal_network" : true,
    "type" : "aeiou",
    "del_pending" : true,
    "os_port_uuid" : "aeiou"
  } ],
  "controller_cluster_uuid" : "aeiou",
  "init_vnics" : 123,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "vcenter_template_vm" : true,
  "cpu_shares" : 123,
  "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 VIMgrVMRuntime

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. FloatingIpSubnet
  2. IpAddr
  3. IpAddrPrefix
  4. VIMgrGuestNicRuntime
  5. VIMgrIPSubnetRuntime
  6. VIMgrVMRuntime
  7. VIMgrVMRuntimeApiResponse

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.

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

VIMgrGuestNicRuntime Up

avi_internal_network (optional)
Boolean Placeholder for description of property avi_internal_network of obj type VIMgrGuestNicRuntime field type str type boolean
connected (optional)
Boolean Placeholder for description of property connected of obj type VIMgrGuestNicRuntime field type str type boolean
del_pending (optional)
Boolean Placeholder for description of property del_pending of obj type VIMgrGuestNicRuntime field type str type boolean
guest_ip (optional)
array[VIMgrIPSubnetRuntime] Placeholder for description of property guest_ip of obj type VIMgrGuestNicRuntime field type str type object
label (optional)
String label of VIMgrGuestNicRuntime.
mac_addr
String mac_addr of VIMgrGuestNicRuntime.
mgmt_vnic (optional)
Boolean Placeholder for description of property mgmt_vnic of obj type VIMgrGuestNicRuntime field type str type boolean
network_name (optional)
String network_name of VIMgrGuestNicRuntime.
network_uuid (optional)
String Unique object identifier of network.
os_port_uuid (optional)
String Unique object identifier of os_port.
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.

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.

VIMgrVMRuntime Up

availability_zone (optional)
String availability_zone of VIMgrVMRuntime.
cloud_ref (optional)
String It is a reference to an object of type Cloud.
connection_state (optional)
String connection_state of VIMgrVMRuntime.
controller_cluster_uuid (optional)
String Unique object identifier of controller_cluster.
controller_ip_addr (optional)
String controller_ip_addr of VIMgrVMRuntime.
controller_vm (optional)
Boolean Placeholder for description of property controller_vm of obj type VIMgrVMRuntime field type str type boolean
cpu_reservation (optional)
Long Number of cpu_reservation. format: int64
cpu_shares (optional)
Integer Number of cpu_shares. format: int32
creation_in_progress (optional)
Boolean Placeholder for description of property creation_in_progress of obj type VIMgrVMRuntime field type str type boolean
guest_nic (optional)
array[VIMgrGuestNicRuntime] Placeholder for description of property guest_nic of obj type VIMgrVMRuntime field type str type object
host (optional)
String host of VIMgrVMRuntime.
init_vnics (optional)
Integer Number of init_vnics. format: int32
managed_object_id
String managed_object_id of VIMgrVMRuntime.
mem_shares (optional)
Integer Number of mem_shares. format: int32
memory (optional)
Long Number of memory. format: int64
memory_reservation (optional)
Long Number of memory_reservation. format: int64
name
String Name of the object.
num_cpu (optional)
Integer Number of num_cpu. format: int32
ovf_avisetype_field (optional)
String Field introduced in 17.1.3.
powerstate (optional)
String powerstate of VIMgrVMRuntime.
se_ver (optional)
Integer Number of se_ver. format: int32
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.
url (optional)
String url
uuid (optional)
String Unique object identifier of the object.
vcenter_datacenter_uuid (optional)
String Unique object identifier of vcenter_datacenter.
vcenter_rm_cookie (optional)
String vcenter_rm_cookie of VIMgrVMRuntime.
vcenter_se_type (optional)
String Enum options - VIMGR_SE_NETWORK_ADMIN, VIMGR_SE_UNIFIED_ADMIN.
vcenter_template_vm (optional)
Boolean Placeholder for description of property vcenter_template_vm of obj type VIMgrVMRuntime field type str type boolean
vcenter_vAppName (optional)
String vcenter_vAppName of VIMgrVMRuntime.
vcenter_vAppVendor (optional)
String vcenter_vAppVendor of VIMgrVMRuntime.
vcenter_vm_type (optional)
String Enum options - VMTYPE_SE_VM, VMTYPE_POOL_SRVR.
vcenter_vnic_discovered (optional)
Boolean Placeholder for description of property vcenter_vnic_discovered of obj type VIMgrVMRuntime field type str type boolean
vm_lb_weight (optional)
Integer Number of vm_lb_weight. format: int32

VIMgrVMRuntimeApiResponse Up

count
Integer format: int32
results