Get Unassociated Virtual Machines

Get Unassociated Virtual Machines

Get the list of all the virtual machines that are not a part of any existing NSGroup.


This API is deprecated. Please use below policy API /infra/realized-state/unassociated-virtual-machines to fetch virtual machines not associated with any existing policy group.
Request
URI
GET
https://nsxmanager.your.domain/api/v1/ns-groups/unassociated-virtual-machines
COPY
Query Parameters
string
cursor
Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

string
display_name
Optional

Display Name of the virtual machine

string
exclude_vm_type
Optional

VM types to be excluded

string
external_id
Optional

External id of the virtual machine

string
host_id
Optional

Id of the host where this vif is located

string
included_fields
Optional

Comma separated list of fields that should be included in query result

integer
page_size
Optional
Constraints: minimum: 0 maximum: 1000 default: 1000

Maximum number of results to return in this page (server may return fewer)

boolean
sort_ascending
Optional

sort_ascending

string
sort_by
Optional

Field by which records are sorted

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns UnassociatedVMListResult of type(s) application/json
This response body class contains all of the following: InlineUnassociatedVMListResult1 
{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {},
    "cursor": "string",
    "result_count": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "last_update_timestamp": 0,
    "results": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {},
            "_last_sync_time": 0,
            "description": "string",
            "display_name": "string",
            "resource_type": "string",
            "scope": [
                {
                    "scope_id": "string",
                    "scope_type": "string"
                }
            ],
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "compute_ids": [
                "string"
            ],
            "external_id": "string",
            "guest_info": {
                "computer_name": "string",
                "os_name": "string"
            },
            "host_id": "string",
            "local_id_on_host": "string",
            "power_state": "string",
            "runtime_info": {
                "vif_runtime_info": [
                    {
                        "external_id": "string",
                        "uptv2_active": "string"
                    }
                ]
            },
            "source": {
                "is_valid": false,
                "target_display_name": "string",
                "target_id": "string",
                "target_type": "string"
            },
            "type": "string",
            "uptv2_enabled": false
        }
    ]
}

400
Returns BadRequest of type(s) application/json
Operation doesn't return any data structure

403
Returns Forbidden of type(s) application/json
Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

412
Returns PreconditionFailed of type(s) application/json
Operation doesn't return any data structure

500
Returns InternalServerError of type(s) application/json
Operation doesn't return any data structure

503
Returns ServiceUnavailable of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/ns-groups/unassociated-virtual-machines
Deprecated
On This Page
Management Plane Api Operations
GET
List IP Sets
Deprecated
POST
Create IP Set
Deprecated
DELETE
Delete IP Set
Deprecated
GET
Read IP Set
Deprecated
POST
Add Remove IP Address
Deprecated
PUT
Update IP Set
Deprecated
GET
Get IP Addresses
Deprecated
GET
List MAC Sets
Deprecated
POST
Create MAC Set
Deprecated
DELETE
Delete MAC Set
Deprecated
GET
Read MAC Set
Deprecated
PUT
Update MAC Set
Deprecated
GET
Get MAC Addresses
Deprecated
POST
Add MAC Address
Deprecated
DELETE
Remove MAC Address
Deprecated
GET
List NS Groups
Deprecated
POST
Create NS Group
Deprecated
GET
Get Unassociated Virtual Machines
Deprecated
DELETE
Delete NS Group
Deprecated
GET
Read NS Group
Deprecated
POST
Add Or Remove NS Group Expression
Deprecated
PUT
Update NS Group
Deprecated
GET
Get Consolidated Effective IP Address Members
Deprecated
GET
Get Effective Cloud Native Service Instances
Deprecated
GET
Get Effective Active Directory Groups
Deprecated
GET
Get Effective IP Address Members
Deprecated
GET
Get Effective IP Set Members
Deprecated
GET
Get Effective Logical Port Members
Deprecated
GET
Get Effective Logical Switch Members
Deprecated
GET
Get Effective Physical Server Members
Deprecated
GET
Get Effective Transport Node Members
Deprecated
GET
Get Effective VIF Members
Deprecated
GET
Get Effective Virtual Machine Members
Deprecated
GET
Get Member Types
Deprecated
GET
Get Service Associations
Deprecated
GET
List NS Profiles
Deprecated
POST
Create NS Profile
Deprecated
GET
List NS Supported Attributes Types
Deprecated
GET
List NS Supported Attributes
Deprecated
DELETE
Delete NS Profile
Deprecated
GET
Read NS Profile
Deprecated
PUT
Update NS Profile
Deprecated
GET
List NS Service Groups
Deprecated
POST
Create NS Service Group
Deprecated
DELETE
Delete NS Service Group
Deprecated
GET
Read NS Service Group
Deprecated
PUT
Update NS Service Group
Deprecated
GET
List NS Services
Deprecated
POST
Create NS Service
Deprecated
DELETE
Delete NS Service
Deprecated
GET
Read NS Service
Deprecated
PUT
Update NS Service
Deprecated