NSX-T Data Center REST API

Read the details of a virtual machine on the NSX Manager

This API return optional details about a virtual machines (e.g. user login session) from the
specified enforcement point.
In case of NSXT, virtual-machine-id would be the value of the external_id of the virtual machine.
This API is only available when using VMware NSX-T.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/realized-state/enforcement-points/<enforcement-point-name>/virtual-machines/<virtual-machine-id>/details
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/realized-state/enforcement-points/default/virtual-machines/564d75b2-7e28-7e78-dd77-64e5fd6128e1/details

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
VirtualMachineDetails+

Example Response:

{ "active_sessions": [ { "domain_name": "test.com", "user_name": "test6", "login_time": 1540338056213, "logout_time": 0, "user_session_id": 0 }], "archived_sessions": [ { "domain_name": "test.com", "user_name": "test6", "login_time": 1540338057355, "logout_time": 154033872131, "user_session_id": 3, }, { "domain_name": "test.com", "user_name": "test6", "login_time": 1540338059011, "logout_time": 1540338061036, "user_session_id": 4 } ] }

Required Permissions:

read

Feature:

policy_identity

Additional Errors: