PATCH /vimgrnwruntime/{uuid}

PATCH /vimgrnwruntime/{uuid}

/vimgrnwruntime/{uuid}

Request
URI
PATCH
https://api_host/api/vimgrnwruntime/{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
VIMgrNWRuntime of type(s) application/json
Optional 
{
    "_last_modified": "string",
    "auto_expand": false,
    "availability_zone": "string",
    "cloud_ref": "string",
    "datacenter_uuid": "string",
    "dvs": false,
    "host_refs": [
        "string"
    ],
    "interested_nw": false,
    "ip_subnet": [
        {
            "fip_available": false,
            "fip_subnet_uuids": [
                "string"
            ],
            "floatingip_subnets": [
                {
                    "name": "string",
                    "prefix": {
                        "ip_addr": {
                            "addr": "string",
                            "type": "string"
                        },
                        "mask": 0
                    },
                    "uuid": "string"
                }
            ],
            "ip_subnet": "string",
            "name": "string",
            "prefix": {
                "ip_addr": {
                    "addr": "string",
                    "type": "string"
                },
                "mask": 0
            },
            "primary": false,
            "ref_count": 0,
            "se_ref_count": 0,
            "uuid": "string"
        }
    ],
    "logical_switch_id": "string",
    "managed_object_id": "string",
    "MgmtNW": false,
    "name": "string",
    "num_ports": 0,
    "switch_name": "string",
    "tenant_name": "string",
    "tenant_ref": "string",
    "type": "string",
    "url": "string",
    "uuid": "string",
    "vlan": 0,
    "vlan_range": [
        {
            "end": 0,
            "start": 0
        }
    ],
    "vm_refs": [
        "string"
    ],
    "vrf_context_ref": "string"
}
string
_last_modified
Optional

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

boolean
auto_expand
Optional

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

string
availability_zone
Optional

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

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.

string
datacenter_uuid
Optional

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

boolean
dvs
Optional

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

array of string
host_refs
Optional

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

boolean
interested_nw
Optional

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

array of VIMgrIPSubnetRuntime
ip_subnet
Optional

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

string
logical_switch_id
Optional

UUID of NSX-T segment spanning multiple VDS with vCenter cloud. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
managed_object_id
Required

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

boolean
MgmtNW
Optional

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

string
name
Required

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

integer As int32 As int32
num_ports
Optional

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

string
switch_name
Optional

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

string
tenant_name
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
type
Required

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.

string
url
Optional

url

string
uuid
Optional

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

integer As int32 As int32
vlan
Optional

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

array of VlanRange
vlan_range
Optional

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

array of string
vm_refs
Optional

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

string
vrf_context_ref
Optional

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

Responses
200

OK

Returns VIMgrNWRuntime of type(s) application/json 
{
    "_last_modified": "string",
    "auto_expand": false,
    "availability_zone": "string",
    "cloud_ref": "string",
    "datacenter_uuid": "string",
    "dvs": false,
    "host_refs": [
        "string"
    ],
    "interested_nw": false,
    "ip_subnet": [
        {
            "fip_available": false,
            "fip_subnet_uuids": [
                "string"
            ],
            "floatingip_subnets": [
                {
                    "name": "string",
                    "prefix": {
                        "ip_addr": {
                            "addr": "string",
                            "type": "string"
                        },
                        "mask": 0
                    },
                    "uuid": "string"
                }
            ],
            "ip_subnet": "string",
            "name": "string",
            "prefix": {
                "ip_addr": {
                    "addr": "string",
                    "type": "string"
                },
                "mask": 0
            },
            "primary": false,
            "ref_count": 0,
            "se_ref_count": 0,
            "uuid": "string"
        }
    ],
    "logical_switch_id": "string",
    "managed_object_id": "string",
    "MgmtNW": false,
    "name": "string",
    "num_ports": 0,
    "switch_name": "string",
    "tenant_name": "string",
    "tenant_ref": "string",
    "type": "string",
    "url": "string",
    "uuid": "string",
    "vlan": 0,
    "vlan_range": [
        {
            "end": 0,
            "start": 0
        }
    ],
    "vm_refs": [
        "string"
    ],
    "vrf_context_ref": "string"
}
string
_last_modified
Optional

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

boolean
auto_expand
Optional

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

string
availability_zone
Optional

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

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.

string
datacenter_uuid
Optional

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

boolean
dvs
Optional

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

array of string
host_refs
Optional

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

boolean
interested_nw
Optional

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

array of VIMgrIPSubnetRuntime
ip_subnet
Optional

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

string
logical_switch_id
Optional

UUID of NSX-T segment spanning multiple VDS with vCenter cloud. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
managed_object_id
Required

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

boolean
MgmtNW
Optional

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

string
name
Required

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

integer As int32 As int32
num_ports
Optional

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

string
switch_name
Optional

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

string
tenant_name
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
type
Required

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.

string
url
Optional

url

string
uuid
Optional

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

integer As int32 As int32
vlan
Optional

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

array of VlanRange
vlan_range
Optional

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

array of string
vm_refs
Optional

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

string
vrf_context_ref
Optional

It is a reference to an object of type VrfContext. 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

On This Page
Vimgr Nwruntime Operations
DELETE
DELETE /vimgrnwruntime/{uuid}
GET
GET /vimgrnwruntime
GET
GET /vimgrnwruntime/{uuid}
PATCH
PATCH /vimgrnwruntime/{uuid}
POST
POST /vimgrnwruntime
PUT
PUT /vimgrnwruntime/{uuid}