NSX-T Data Center REST API

# *************************************************************************** # Copyright 2020-2024 VMware, Inc. All rights reserved. VMware Confidential. # ***************************************************************************

IntentStatusRequestParameters (schema)

Request Parameters for Intent Status Information

Request parameters that represents a binding between an intent path and whether the
enforcement point specific status shall be retrieved from the enforcement point or
not. A request can be parameterized with this pair and will be evaluated as follows:
- <intent_path>: the request is evaluated on all enforcement points for the given
intent with no enforced statuses' details returned.
- <intent_path, include_enforced_status=true>: the request is evaluated on all
enforcement points for the given intent with enforced statuses' details returned.

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