dellemc.vxrail.dellemc_vxrail_system_getprechecksreport (2.2.0) — module

Get all or one pre-check report using a specified request ID.

| "added in version" 1.5.0 of dellemc.vxrail"

Authors: VxRail Development Team(@VxRailDevTeam) <ansible.team@dell.com>

Install collection

Install with ansible-galaxy collection install dellemc.vxrail:==2.2.0


Add to requirements.yml

  collections:
    - name: dellemc.vxrail
      version: 2.2.0

Description

Get a pre-check report using a specified request ID.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Get prechecks reports
    dellemc_vxrail_system_getprechecksreport:
        vxmip: "{{ vxmip }}"
        vcadmin: "{{ vcadmin }}"
        vcpasswd: "{{ vcpasswd }}"
        id: "{{ id }}"
        timeout: "{{ timeout }}"
        api_version_number: "{{ api_version_number }}"

Inputs

    
id:
    description: Request ID of the pre-check status that you want to query
    required: false
    type: str

vxmip:
    description: The IP address of the VxRail Manager System
    required: true
    type: str

timeout:
    default: 60
    description: Time out value for getting a system precheck report information, the
      default value is 60 seconds
    required: false
    type: int

vcadmin:
    description: Administrative account of the vCenter Server the VxRail Manager is registered
      to
    required: true
    type: str

vcpasswd:
    description: The password for the administrator account provided in vcadmin
    required: true
    type: str

api_version_number:
    description: A specific version number to use for the API call. If not included, will
      use the highest version by default
    required: false
    type: int

Outputs

Prechecks_Report:
  description: A precheck report
  returned: always
  sample: "{\n  \"id\": \"ba8901c1-913b-4a2b-9b62-d358bcc2ed47\",\n  \"profile\":\
    \ \"string\",\n  \"status\": \"IN-PROGRESS [IN-PROGRESS,COMPLETED]\",\n  \"progress\"\
    : \"50%\",\n  \"total_severity\": \"OK [OK, WARN, ERROR, CRITICAL]\",\n  \"complete_check_count\"\
    : 25,\n  \"total_success_count\": 22,\n  \"total_warn_count\": 0,\n  \"total_error_count\"\
    : 3,\n  \"results\": {\n    \"host_checks\": [\n      {\n        \"host_id\":\
    \ \"c2-esx01\",\n        \"checks\": [\n          {\n            \"status\": \"\
    COMPLETED\",\n            \"check_id\": \"vcsa_state_check\",\n            \"\
    start_time\": \"string\",\n            \"end_time\": \"string\",\n           \
    \ \"plugin_name\": \"string\",\n            \"plugin_version\": \"1.0.100\",\n\
    \            \"result\": {\n              \"severity\": \"OK [OK, WARN, ERROR,\
    \ CRITICAL]\",\n              \"messages\": [\n                {\n           \
    \       \"id\": \"VXR304RADAR0003\",\n                  \"kb\": \"string\",\n\
    \                  \"action\": \"Ensure there are not critical alarms existing\
    \ on VCSA.\",\n                  \"alphaid\": \"check_script_failed\",\n     \
    \             \"symptom\": \"There are critical alarms existing on VCSA.\",\n\
    \                  \"severity\": \"Error [Ok, Warn, Error, Critical]\"\n     \
    \           }\n              ]\n            }\n          }\n        ]\n      }\n\
    \    ],\n    \"general_checks\": [\n      {\n        \"status\": \"COMPLETED\"\
    ,\n        \"check_id\": \"vcsa_state_check\",\n        \"start_time\": \"string\"\
    ,\n        \"end_time\": \"string\",\n        \"plugin_name\": \"string\",\n \
    \       \"plugin_version\": \"1.0.100\",\n        \"result\": {\n          \"\
    severity\": \"OK [OK, WARN, ERROR, CRITICAL]\",\n          \"messages\": [\n \
    \           {\n              \"id\": \"VXR304RADAR0003\",\n              \"kb\"\
    : \"string\",\n              \"action\": \"Ensure there are not critical alarms\
    \ existing on VCSA.\",\n              \"alphaid\": \"check_script_failed\",\n\
    \              \"symptom\": \"There are critical alarms existing on VCSA.\",\n\
    \              \"severity\": \"Error [Ok, Warn, Error, Critical]\"\n         \
    \   }\n          ]\n        }\n      }\n    ]\n  }\n}"
  type: dict