dellemc.vxrail.dellemc_vxrail_host_folder_upgrade (2.2.0) — module

Perform host folder LCM

| "added in version" 1.4.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 node upgrade for all eligible satellite nodes in the specific host folder

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Start host folder upgrade
    dellemc_vxrail_host_folder_upgrade:
      vxmip: "{{ vxmip }}"
      vcadmin: "{{ vcadmin }}"
      vcpasswd: "{{ vcpasswd }}"
      action: "{{ action }}"
      folder_id: "{{ folder_id }}"
      target_version: "{{ target_version }}"
      failure_rate: "{{ failure_rate | default(omit) }}"
      concurrent_size: "{{ concurrent_size | default(omit) }}"
      api_version_number: "{{ api_version_number | default(omit) }}"

Inputs

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

action:
    choices:
    - UPGRADE
    - STAGE
    description: STAGE will transfer the upgrade bundle to the nodes but will not initiate
      the upgrade procedure. UPGRADE will initiate the upgrade procedure.
    required: true
    type: str

timeout:
    default: 1800
    description: Time out value for host folder upgrade, the default value is 1800 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

folder_id:
    description: The specific folder id
    required: true
    type: str

failure_rate:
    description: The failure rate of LCM batch job. failure_rate = failed nodes count
      / total nodes count. This parameter is only valid for UPGRADE requests.
    required: false
    type: int

target_version:
    description: The target VxRail system version
    required: true
    type: str

concurrent_size:
    description: Number of nodes that can be upgraded in parallel. This parameter is only
      valid for UPGRADE requests.
    required: false
    type: int

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

changed:
  description: Whether or not the resource has changed.
  returned: always
  type: bool
upgrade_status:
  description: host folder upgrade status summary
  returned: always
  sample: "{\n \"FolderUpgrade\": {\n     \"request_id\": \"433d0a61-06e7-4cb8-a1eb-985ab9a8b5dd\"\
    ,\n     \"status\": \"COMPLETED\"\n }\n \"msg\": \"The host folder upgrade is\
    \ successful. Please see the /tmp/vxrail_ansible_host_folder_upgrade.log for more\
    \ details\"\n}"
  type: dict