NSX-T Data Center REST API

IntentStatusRequestParameters (type)

{
  "additionalProperties": false,
  "description": "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.",
  "extends": {
    "$ref": "IntentRuntimeRequestParameters"
  },
  "id": "IntentStatusRequestParameters",
  "module_id": "PolicyRealizationStatus",
  "properties": {
    "include_enforced_status": {
      "default": false,
      "description": "Flag conveying whether to include detailed view of the enforcement point specific status or not.",
      "title": "Include Enforced Status Flag",
      "type": "boolean"
    },
    "intent_path": {
      "description": "Policy Path referencing an intent object.",
      "required": true,
      "title": "Policy Path of the intent object",
      "type": "string"
    },
    "site_path": {
      "description": "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",
      "required": false,
      "title": "Policy Path of the site from where the realization status needs to be fetched",
      "type": "string"
    }
  },
  "title": "Request Parameters for Intent Status Information",
  "type": "object"
}