NSX-T Data Center REST API

List IDFW status of VMs by transport node id

This API will list all VMs and statuses based on transport node ID of idfw
enabled compute collection.
This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX-T.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/settings/firewall/idfw/transport-nodes/<transport-node-id>/vms/status
Request Headers:
n/a
Query Parameters:
PolicyIdfwEnforcementPointRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-ip>/policy/api/v1/infra/settings/firewall/idfw/transport-nodes/<transport-node-id>/vms/status

Successful Response:

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

Example Response:

{ "results": [ { "vm_id": "52e03984-673f-bb95-ce4c-820247a9c388", "vm_status": [ { "status": "UP" }, { "status": "IDFW_ENABLED" } ] }, { "vm_id": "501ae88d-bf57-0c5f-ac67-54ee37f2a111", "vm_status": [ { "status": "UP" }, { "status": "IDFW_ENABLED" } ] }, { "vm_id": "5286c272-27a3-f62f-96ca-57b96163456e", "vm_status": [ { "status": "UP" }, { "status": "IDFW_ENABLED" } ] }, { "vm_id": "501ada68-57b5-8b84-788a-fe7dc34e3ffb", "vm_status": [ { "status": "UP" }, { "status": "IDFW_ENABLED" } ] }, { "vm_id": "501a8541-a9a1-d246-bf91-122c6ed45307", "vm_status": [ { "status": "UP" }, { "status": "IDFW_ENABLED" } ] }, { "vm_id": "5284ecaa-204a-cf30-823e-9e2f757ba407", "vm_status": [ { "status": "UP" }, { "status": "IDFW_ENABLED" } ] } ], "result_count": 6 }

Required Permissions:

read

Feature:

policy_identity

Additional Errors: