NSX-T Data Center REST API

Get consolidated status of an intent object

Get Consolidated Status of an intent object (with or without enforcement specific status details).
The request is evaluated as follows:
- <intent_path>: the request is evaluated on all enforcement points for the given intent without
enforcement point specific details.
- <intent_path, include_enforced_status=true>: the request is evaluated on all enforcement points
for the given intent with enforcement point specific details. This is only supported when intent_path
refers to an object of one of the following types:
SECURITY_POLICY,
GATEWAY_POLICY,
IDS_SECURITY_POLICY,
IDS_GATEWAY_POLICY,
IDS_COMPRESSED_SIGNATURE,
IDS_COMPRESSED_CUSTOM_SIGNATURE,
TLS_POLICY,
VPC_SECURITY_POLICY,
VPC_GATEWAY_POLICY,
PUBLIC_CLOUD_VPC_SECURITY_POLICY,
Passing the path of an unsupported type (e.g. a rule) with include_enforced_status=true
will result in an error. In such cases, pass the path of the parent policy object instead
(e.g., the SecurityPolicy or GatewayPolicy that contains the rule).

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/realized-state/status
/policy/api/v1/global-infra/realized-state/status
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/realized-state/status

Request Headers:

n/a

Query Parameters:

IntentStatusRequestParameters+

IntentStatusRequestParameters (schema)

Name	Description	Type	Notes
include_enforced_status	Include Enforced Status Flag Flag conveying whether to include detailed per-transport-node enforcement status in the response. When set to true, each item in consolidated_status_per_enforcement_point is returned as ConsolidatedStatusNsxT (with the enforced_status field populated). When set to false (default), each item is returned as ConsolidatedStatusPerEnforcementPoint (enforced_status absent). Use the resource_type field in each item to distinguish between the two types. This flag is only supported when intent_path refers to an object of one of the following types: SECURITY_POLICY, GATEWAY_POLICY, IDS_SECURITY_POLICY, IDS_GATEWAY_POLICY, IDS_COMPRESSED_SIGNATURE, IDS_COMPRESSED_CUSTOM_SIGNATURE, TLS_POLICY, VPC_SECURITY_POLICY, VPC_GATEWAY_POLICY, PUBLIC_CLOUD_VPC_SECURITY_POLICY, COMMUNICATION_MAP (deprecated alias for SECURITY_POLICY), EDGE_COMMUNICATION_MAP (deprecated alias for GATEWAY_POLICY). Setting this flag for any other type (e.g. a rule path) will result in an error. In such cases, pass the path of the parent policy object instead (e.g., the SecurityPolicy or GatewayPolicy that contains the rule).	boolean	Default: "False"
intent_path	Policy Path of the intent object Policy Path referencing an intent object.	string	Required
site_path	Policy Path of the site from where the realization status needs to be fetched Policy Path referencing a site. This is applicable only on a GlobalManager. If no site_path is specified, then based on the span of the intent the response will be fetched from the respective sites	string

Request Body:

n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/realized-state/status?intent_path=/infra/domains/default/security-policies/block-external&include_enforced_status=true

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ConsolidatedRealizedStatus+

ConsolidatedRealizedStatus (schema)

Name	Description	Type	Notes
consolidated_status	Consolidated Realized Status Consolidated Realized Status across enforcement points.	ConsolidatedStatus	Readonly
consolidated_status_per_enforcement_point	List of Consolidated Realized Status per Enforcement Point List of Consolidated Realized Status per enforcement point. An enforcement point represents an enforcing system — NSX is the default; others include Antrea, or a site (on the global manager). Within an NSX enforcement point, ESXi(for distributed firewall) and Edge Nodes (for gateway firewall) are tracked as Transport Nodes, not as enforcement points. Each item is a ConsolidatedStatusPerEnforcementPoint or its sub-type ConsolidatedStatusNsxT. The resource_type field indicates the effective response shape: "ConsolidatedStatusNsxT" when include_enforced_status=true — the enforced_status field is populated with detailed per-transport-node enforcement information. "ConsolidatedStatusPerEnforcementPoint" when include_enforced_status=false (default) — the enforced_status field is absent.	array of ConsolidatedStatusPerEnforcementPoint	Readonly
intent_path	String Path of the intent object Intent path of object, forward slashes must be escaped using %2F.	string	Required Readonly
intent_version	Intent version for the status Represent highest intent version across all realized objects	string	Readonly
publish_status	Aggregated Realization state of this object	string	Required Enum: UNAVAILABLE, UNREALIZED, REALIZED, ERROR
publish_time	Publish time of the intent This is the time when our system detects that data has been pushed to the transport nodes. This is based on a poll mechanism and hence this is not the accurate time when the intent was published at the data path. The value of -1 indicates that either the publishing is still in progress or the runtime status is UNKNOWN and hence not available. The Runtime status can be UNKNOWN if one or more hosts are down and the rules could not be sent to those hosts. When the host comes up, the runtime status will change to SUCCESS but the publish_time will show the value of the last realization time. Any new configuration change after this will start reflecting the proper value for publish_time	EpochMsTimestamp	Readonly Sortable
site_uuid	id of Site Site UUID supplied for realized site.	string
time_taken_for_realization	Appoximate time taken in milliseconds for end to end realization. This is an approximate time taken for the realization of the intent to the data path. The actual time taken could be lesser than what is reported here. The value of -1 indicates that either the publishing is still in progress or the runtime status is UNKNOWN and hence not available. The Runtime status can be UNKNOWN if one or more hosts are down and the rules could not be sent to those hosts. When the host comes up, the runtime status will change to SUCCESS but the time taken for realization will show the value of the last realization time. Any new configuration change after this will start reflecting the proper value for time_taken_for_realization.	integer

Example Response:

{ "consolidated_status": { "consolidated_status": "ERROR" }, "consolidated_status_per_enforcement_point": [ { "resource_type": "ConsolidatedStatusNsxT", "enforced_status": { "enforced_status_info": { "enforced_status": { "status": "UNKNOWN" }, "enforced_status_per_scope": [ { "enforced_status_per_transport_node": [ { "path": "/infra/sites/default/enforcement-points/default/edge-clusters/ec/edge-nodes/c578e7ba-5ce5-11e9-acec-41d19997391c", "enforced_status": { "status": "FAILURE", "status_message": "Internal error(1101) occurred on transport node c578e7ba-5ce5-11e9-acec-41d19997391c." } }, { "path": "/infra/sites/default/enforcement-points/default/edge-clusters/ec/edge-nodes/a744cd7e-5ce5-11e9-a24b-df71fdc87f85", "enforced_status": { "status": "SUCCESS" } }, { "path": "/infra/sites/default/enforcement-points/default/edge-clusters/ec/edge-nodes/77af8e10-5ce5-11e9-9149-5bb770f7c6c7", "enforced_status": { "status": "SUCCESS" } }, { "path": "/infra/sites/default/enforcement-points/default/edge-clusters/ec/edge-nodes/93ecd452-5ce5-11e9-8c18-bdce5885e998", "enforced_status": { "status": "SUCCESS" } } ], "resource_type": "TransportNodeSpanEnforcedStatus" } ] }, "pending_changes_info": { "pending_changes_flag": false } }, "enforcement_point_path": "/infra/sites/default/enforcement-points/default", "enforcement_point_id": "default", "consolidated_status": { "consolidated_status": "UNKNOWN" } } ], "intent_path": "/infra/domains/default/security-policies/block-external" }