Get Host | VMware Aria Operations for Networks API

Get Host

Show vSphere host details

Request

URI

GET

https://{api_host}/api/ni/entities/hosts/{id}

COPY

Path Parameters

string

Required

The Entity ID of object requestion information on

Query Parameters

integer

time

Optional

Time in epoch seconds

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns Host of type(s) application/json

This response body class contains all of the following: BaseEntity , InlineHost1

{
    "entity_id": "1000:104:12213212",
    "name": "My Name",
    "entity_type": "VirtualMachine",
    "vmknics": [
        {
            "entity_id": "1000:104:12213212",
            "name": "My Name",
            "entity_type": "VirtualMachine",
            "ip_addresses": [
                {
                    "ip_address": "string",
                    "netmask": "string",
                    "network_address": "string"
                }
            ],
            "vlan": {
                "begin": 0,
                "end": 0
            },
            "host": {
                "entity_id": "string",
                "entity_type": "VirtualMachine",
                "entity_name": "string"
            },
            "layer2_network": {
                "entity_id": "string",
                "entity_type": "VirtualMachine",
                "entity_name": "string"
            }
        }
    ],
    "cluster": {
        "entity_id": "string",
        "entity_type": "VirtualMachine",
        "entity_name": "string"
    },
    "vcenter_manager": {
        "entity_id": "string",
        "entity_type": "VirtualMachine",
        "entity_name": "string"
    },
    "vm_count": 100,
    "datastores": [
        {
            "entity_id": "string",
            "entity_type": "VirtualMachine",
            "entity_name": "string"
        }
    ],
    "service_tag": "CT1342",
    "vendor_id": "host-12",
    "nsx_manager": {
        "entity_id": "string",
        "entity_type": "VirtualMachine",
        "entity_name": "string"
    },
    "maintenance_mode": "false",
    "connection_state": "DISCONNECTED",
    "cpu_count": 4,
    "memory": 1024,
    "manager_uuid": "string",
    "tag_keys": [
        "string"
    ],
    "tag_key_values": [
        "string"
    ],
    "tag_values": [
        "string"
    ]
}

400

Bad Request

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details