dellemc.vxrail.dellemc_vxrail_system_precheck (2.2.0) — module

Perform a system pre-check.

| "added in version" 1.6.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

This module will perform a system pre-check.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Perform a system precheck
    dellemc_vxrail_system_precheck:
        vxmip: "{{ vxmip }}"
        vcadmin: "{{ vcadmin }}"
        vcpasswd: "{{ vcpasswd }}"
        profile: "{{ profile }}"
        vxm_root_username: "{{ vxm_root_username }}"
        vxm_root_password: "{{ vxm_root_password }}"
        vc_root_username: "{{ vc_root_username }}"
        vc_root_password: "{{ vc_root_password }}"
        witness_username: "{{ witness_username }}"
        witness_password: "{{ witness_password }}"
        auto_witness_upgrade: "{{ auto_witness_upgrade }}"
        vc_temporary_ip: "{{ vc_temporary_ip }}"
        vc_temporary_gateway: "{{ vc_temporary_gateway }}"
        vc_temporary_netmask: "{{ vc_temporary_netmask }}"
        sn: "{{ sn }}"
        version: "{{ version }}"
        ip: "{{ ip }}"
        root_user: "{{ root_user }}"
        root_password: "{{ root_password }}"
        timeout: "{{ timeout }}"
        api_version_number: "{{ api_version_number }}"

Inputs

    
ip:
    description: IP address of the new node to be added
    required: false
    type: str

sn:
    description: Serial number of the new node to be added
    required: false
    type: str

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

profile:
    description: The profile name. Allowed only PRE_UPGRADE, PROACTIVE_HEALTH or NODE_EXPANSION.
    required: true
    type: str

timeout:
    default: 300
    description: Time out value for performing a system precheck, the default value is
      300 seconds
    required: false
    type: int

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

version:
    description: Install version of the new node to be added
    required: false
    type: str

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

root_user:
    description: Root user of the new node to be added
    required: false
    type: str

root_password:
    description: Root passwrod of the new node to be added
    required: false
    type: str

vc_temporary_ip:
    description: Temporary IP settings for the vCenter upgrade
    required: false
    type: str

vc_root_password:
    description: The password of vCenter root user account
    required: true
    type: str

vc_root_username:
    description: Username of vCenter root user account
    required: true
    type: str

witness_password:
    description: The password information of witness user account for a stretched cluster,
      including a vSAN 2-node cluster. The witness object only applies to a cluster when
      vLCM is not enabled.
    required: false
    type: str

witness_username:
    description: The username information of witness user account for a stretched cluster,
      including a vSAN 2-node cluster. The witness object only applies to a cluster when
      vLCM is not enabled.
    required: false
    type: str

vxm_root_password:
    description: The password of VxRail Manager root user account
    required: true
    type: str

vxm_root_username:
    description: Username of VxRail Manager root user account
    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

auto_witness_upgrade:
    description: Whether VxRail will automatically upgrade the witness node
    required: false
    type: bool

vc_temporary_gateway:
    description: Temporary IP settings for the vCenter upgrade
    required: false
    type: str

vc_temporary_netmask:
    description: Temporary IP settings for the vCenter upgrade
    required: false
    type: str

Outputs

Post_System_Precheck_API:
  description: perform system precheck
  returned: always
  sample: "{\n  \"request_iD\": \"a6146c2f-73fd-4415-a596-9e372f406d98\"\n}"
  type: dict