[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Get Intent Status
DescriptionGet 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>: the request is evaluated on all enforcement points for the given intent with enforcement point specific details.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/realized-state/status
Query Parameters
Query Parameters
boolean
include_enforced_status
Optional
Include Enforced Status Flag
string
intent_path
Required
Policy Path of the intent object
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
ConsolidatedRealizedStatus
of type(s) application/json
This response body class contains all of the following:
AggregatePolicyRuntimeInfo, InlineConsolidatedRealizedStatus1
Errors
ApiError
400
Bad Request
ApiError
403
Forbidden
ApiError
404
Not Found
ApiError
412
Precondition Failed
ApiError
500
Internal Server Error
ApiError
503
Service Unavailable
Code Samples
PowerCLI Client SDK Example
Invoke-ReadIntentStatus -intentPath "MyintentPath" -includeEnforcedStatus $true -sitePath "MysitePath"
cURL Command
curl https://nsxmanager.your.domain/policy/api/v1/infra/realized-state/status?intent_path=string
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get-intent-status
x-vmw-nsx-module: PolicyRealizedState
[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
