[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy

Get Intent Status

Description

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>: the request is evaluated on all enforcement points for the given intent with enforcement point specific details.

Request

Request

URL

URL


get
https://nsxmanager.your.domain/policy/api/v1/infra/realized-state/status
Copy

Query Parameters

Query Parameters

boolean
include_enforced_status Optional

Include Enforced Status Flag


string
intent_path Required

Policy Path of the intent object


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns ConsolidatedRealizedStatus of type(s) application/json
This response body class contains all of the following: AggregatePolicyRuntimeInfo, InlineConsolidatedRealizedStatus1
Errors

Errors

400

Bad Request


403

Forbidden


404

Not Found


412

Precondition Failed


500

Internal Server Error


503

Service Unavailable

Code Samples

Code Samples

PowerCLI Client SDK Example

Invoke-ReadIntentStatus -intentPath -includeEnforcedStatus -sitePath

cURL Command

curl https://nsxmanager.your.domain/policy/api/v1/infra/realized-state/status?intent_path=string
Vendor Extensions

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
Feedback

Was this page helpful?