dellemc.vxrail.dellemc_vxrail_lcm (2.2.0) — module

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 the LCM full upgrade or partial upgrade via v4+ API of all VxRail software and hardware.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: LCM api
  dellemc_vxrail_lcm:
    vxmip: "{{ vxmip }}"
    vcadmin: "{{ vcadmin }}"
    vcpasswd: "{{ vcpasswd }}"
    bundle: "{{ bundle }}"
    vc_root_account: "{{ vc_root_account }}"
    vc_root_passwd: "{{ vc_root_passwd }}"
    vxm_root_account: "{{ vxm_root_account }}"
    vxm_root_passwd: "{{ vxm_root_passwd }}"
    target_hosts_name: "{{ target_hosts_name }}"
    missing_file_check: "{{ missing_file_check }}"
    skip_failed_hosts: "{{ skip_failed_hosts }}"
    ecosystem_check_continue_with_incompatible: "{{ ecosystem_check_continue_with_incompatible }}"
    ecosystem_check_components: "{{ ecosystem_check_components }}"

Inputs

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

bundle:
    description: the path of lcm bundle on vxm, which is recommended under /data/store2
    required: true
    type: str

timeout:
    default: 21600
    description: Time out value for LCM Upgrade, the default value is 21600 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

temporary_ip:
    description: Temporary IP to be used during the vCenter upgrade
    required: false
    type: str

vc_root_passwd:
    description: The password for the root account provided in vcroot
    required: true
    type: str

psc_root_passwd:
    description: The password for the root account provided in PSC
    required: false
    type: str

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

vxm_root_passwd:
    description: The password for the root account provided in vxm
    required: true
    type: str

psc_root_account:
    description: root account of the PSC the VxRail Manager is registered to
    required: false
    type: str

vxm_root_account:
    description: root account of VxRail Manager
    required: true
    type: str

witness_password:
    description: Password of the witness account
    required: false
    type: str

witness_username:
    description: Username of the witness account
    required: false
    type: str

skip_failed_hosts:
    description: If set to true, any nodes that fail the upgrade will be ignored.
    required: false
    type: bool

target_hosts_name:
    default: all
    description: target hosts name for partial upgrade
    required: false
    type: str

temporary_gateway:
    description: Gateway to be used during the vCenter upgrade
    required: false
    type: str

temporary_netmask:
    description: Netmask to be used during the vCenter upgrade
    required: false
    type: str

api_version_number:
    description: Specify the API version to perform the upgrade.
    required: false
    type: int

missing_file_check:
    default: true
    description: If you are using the customizing upgrade bundle i.e. Smart Bundle, this
      option should be set to false.
    required: false
    type: bool

auto_witness_upgrade:
    description: Automatically upgrade the witness node by VxRail
    required: false
    type: bool

source_psc_host_name:
    description: Hostname of the ESXi host
    required: false
    type: str

source_vcsa_host_name:
    description: Hostname of the ESXi host
    required: false
    type: str

target_vcsa_host_name:
    description: Hostname of the ESXi host
    required: false
    type: str

source_psc_host_user_name:
    description: The username of account provided in the ESXi host
    required: false
    type: str

ecosystem_check_components:
    description: The ecosystem pre-check will be ignored according to the value in "continue_with_incompatible"
      and "components".
    required: false
    type: str

source_vcsa_host_user_name:
    description: The username of account provided in the ESXi host
    required: false
    type: str

target_vcsa_host_user_name:
    description: The username of account provided in the ESXi host
    required: false
    type: str

source_psc_host_user_passwd:
    description: The password of account provided in the ESXi host
    required: false
    type: str

preferred_fault_domain_first:
    description: Upgrade preferred fault domain hosts first
    required: false
    type: bool

source_vcsa_host_user_passwd:
    description: The password of account provided in the ESXi host
    required: false
    type: str

target_vcsa_host_user_passwd:
    description: The password of account provided in the ESXi host
    required: false
    type: str

ecosystem_check_continue_with_incompatible:
    description: if set to true, will ignore the ecosystem pre-check according to the
      inputs in "continue_with_incompatible" and "components".
    required: false
    type: bool

Outputs

LCM_status:
  description: LCM status summary
  returned: always
  sample: "{\n \"LCM_API_Upgrade\": {\n     \"request_id\": \"2ce09bde-d987-4fff-8f90-6fc430e2bfc3\"\
    ,\n     \"status\": \"COMPLETED\"\n }\n \"msg\": \"LCM is successful. Please see\
    \ the /tmp/vxrail_ansible_lcm.log for more details\"\n}"
  type: dict
changed:
  description: Whether or not the resource has changed.
  returned: always
  type: bool