List Vm Tools Info

List Vm Tools Info

This API returns the list of tools and agents installed in VMs.

Request
URI
GET
https://nsxmanager.your.domain/api/v1/fabric/virtual-machines/tools-info
COPY
Query Parameters
string
cursor
Optional

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

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 VmToolsInfoListResult of type(s) application/json
This response body class contains all of the following: InlineVmToolsInfoListResult1
{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {},
    "cursor": "string",
    "result_count": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "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"
                }
            ],
            "external_id": "string",
            "file_agent_version": "string",
            "host_local_id": "string",
            "network_agent_version": "string",
            "source": {
                "is_valid": false,
                "target_display_name": "string",
                "target_id": "string",
                "target_type": "string"
            },
            "svmStatus": [
                {
                    "_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"
                        }
                    ],
                    "connectivity_status": false,
                    "service_name": "string",
                    "solution_id": "string"
                }
            ],
            "svm_connectivity": false,
            "tools_version": "string",
            "vm_type": "string"
        }
    ]
}

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
Returns NotFound of type(s) application/json
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/fabric/virtual-machines/tools-info