Get Host

Get Host

Show vSphere host details

Request
URI
GET
https://vrni.example.com/api/ni/entities/hosts/{id}
COPY
Path Parameters
string
id
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.
Responses
200

OK

Returns Host of type(s) application/json
This response body class contains all of the following: BaseEntity
{
    "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"
            },
            "layer2_network": {
                "entity_id": "string",
                "entity_type": "VirtualMachine"
            }
        }
    ],
    "cluster": {
        "entity_id": "string",
        "entity_type": "VirtualMachine"
    },
    "vcenter_manager": {
        "entity_id": "string",
        "entity_type": "VirtualMachine"
    },
    "vm_count": 100,
    "datastores": [
        {
            "entity_id": "string",
            "entity_type": "VirtualMachine"
        }
    ],
    "service_tag": "CT1342",
    "vendor_id": "host-12",
    "nsx_manager": {
        "entity_id": "string",
        "entity_type": "VirtualMachine"
    },
    "maintenance_mode": "false",
    "connection_state": "DISCONNECTED"
}

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

details
Optional

details


401

Unauthorized

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

500

Internal Error

Operation doesn't return any data structure