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+

Name	Description	Type	Notes
enforcement_point_path	String Path of the enforcement point enforcement point path, forward slashes must be escaped using %2F.	string

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+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	IDFW Virtual machine list. List of VM's on Identity Firewall Compute collection.	array of IdfwVirtualMachineStatus	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

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 }

List IDFW status of VMs by transport node id

Request:

PolicyIdfwEnforcementPointRequestParameters (schema)

Example Request:

Successful Response:

IdfwVirtualMachineStatusListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: