Management Plane API >
Security
>
Identity Firewall
>
Realization Data
Get IDFW user login events for a given VM
Get IDFW user login events for a given VM (all active plus up to 5 most
recent archived entries).
Request:
Method:
GET
URI Path(s):
/api/v1/idfw/vm-stats/<vm-ext-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a
Example Request:
GET https://<nsx-mgr>/api/v1/idfw/vm-stats/a6bc2d10-e98c-4a0c-a2e7-936eaec657e0
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
IdfwVmStats
+
IdfwVmStats
(
schema
)
Name
Description
Type
Notes
active_sessions
List of active (still logged in) user login/sessions data (no limit)
array of
IdfwUserSessionData
Required
archived_sessions
Optional list of archived (previously logged in) user login/session data (maximum 5)
Optional list of up to 5 most recent archived (previously logged in) user login/session data.
array of
IdfwUserSessionData
vm_ext_id
Virtual machine external ID or BIOS UUID
Virtual machine (external ID or BIOS UUID) where login/logout event occurred.
string
Required
Example Response:
{ "vm_ext_id": "a6bc2d10-e98c-4a0c-a2e7-936eaec657e0", "active_sessions": [ { "domain_name": "nimbustest.com", "vm_ext_id": "a6bc2d10-e98c-4a0c-a2e7-936eaec657e0", "user_id": { "is_valid": true, "target_type": "DirectoryUser", "target_id": "bee4cf12-9cb8-4b24-8604-a088d12efe0d" }, "user_name": "test6", "login_time": 1539209859091, "logout_time": 0, "user_session_id": 2 } ], "archived_sessions": [ { "domain_name": "nimbustest.com", "vm_ext_id": "a6bc2d10-e98c-4a0c-a2e7-936eaec657e0", "user_id": { "is_valid": true, "target_type": "DirectoryUser", "target_id": "bee4cf12-9cb8-4b24-8604-a088d12efe0d" }, "user_name": "test6", "login_time": 1539209850318, "logout_time": 1539209852692, "user_session_id": 1 } ] }
Required Permissions:
read
Feature:
identity_firewall
Additional Errors:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable