NSX-T Data Center REST API
# ***************************************************************************
# Copyright 2020-2024 VMware, Inc. All rights reserved. VMware Confidential.
# ***************************************************************************
ExecutePreCheckParams (schema)
| Name | Description | Type | Notes |
|---|---|---|---|
| component_type | Component type on which the pre-check will be executed. | string | |
| cursor | Opaque cursor to be used for getting next page of records (supplied by current result page) | string | |
| included_fields | Comma separated list of fields that should be included in query result 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. |
string | |
| page_size | Maximum number of results to return in this page (server may return fewer) | integer | Minimum: 0 Maximum: 1000 Default: "1000" |
| run_only_implicit_pre_checks | Run Only Implicit Pre-Checks 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`. |
boolean | Default: "False" |
| run_only_on_enabled_groups | Run Pre-Checks on Enabled Groups Only 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). |
boolean | Default: "False" |
| sort_ascending | If true, results are sorted in ascending order | boolean | |
| sort_by | Field by which records are sorted | string |