NSX-T Data Center REST API

ExecutePreCheckParams (type)

{
  "additionalProperties": false,
  "extends": {
    "$ref": "ListRequestParameters"
  },
  "id": "ExecutePreCheckParams",
  "module_id": "Upgrade",
  "properties": {
    "component_type": {
      "readonly": false,
      "required": false,
      "title": "Component type on which the pre-check will be executed.",
      "type": "string"
    },
    "cursor": {
      "readonly": false,
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
      "type": "string"
    },
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.",
      "title": "Comma separated list of fields that should be included in query result",
      "type": "string"
    },
    "page_size": {
      "default": 1000,
      "maximum": 1000,
      "minimum": 0,
      "title": "Maximum number of results to return in this page (server may return fewer)",
      "type": "integer"
    },
    "run_only_implicit_pre_checks": {
      "default": false,
      "description": "A boolean flag to determine the depth or type of pre-checks to execute. 'implicit' pre-checks are typically foundational or essential checks. - `true`: Only 'implicit' pre-checks will be executed for the specified           `component_type`. This option requires `component_type` to be provided. - `false`: (Default) All applicable pre-checks for the specified `component_type`             will be executed. If `component_type` is not provided, this flag             must be `false` (or omitted) Interaction:   If `run_only_on_enabled_groups` is also `true`, then setting this to `true`   will result in 'implicit' pre-checks being executed specifically on the   'enabled groups' of the given `component_type`.",
      "readonly": false,
      "required": false,
      "title": "Run Only Implicit Pre-Checks",
      "type": "boolean"
    },
    "run_only_on_enabled_groups": {
      "default": false,
      "description": "A boolean flag to control the scope of group-based pre-checks. - `true`: Universal Pre-checks will be executed on groups that are currently           marked as 'enabled' for the specified `component_type`.           This option requires `component_type` to be provided. - `false`: (Default) For the specified `component_type`, universal pre-checks will be            executed on every associated group, whether it's enabled or not.            If `component_type` is not provided, this flag must be `false` (or omitted).",
      "readonly": false,
      "required": false,
      "title": "Run Pre-Checks on Enabled Groups Only",
      "type": "boolean"
    },
    "sort_ascending": {
      "title": "If true, results are sorted in ascending order",
      "type": "boolean"
    },
    "sort_by": {
      "title": "Field by which records are sorted",
      "type": "string"
    }
  },
  "type": "object"
}