dellemc.vxrail.dellemc_vxrail_cluster_shutdown (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 shut down a cluster or perform a shutdown dry run.

Usage examples

Scanned by Steampunk Spotter

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

  - name: Perform Cluster Shutdown
    dellemc_vxrail_cluster_shutdown:
        vxmip: "{{ vxmip }}"
        vcadmin: "{{ vcadmin }}"
        vcpasswd: "{{ vcpasswd }}"
        timeout : "{{ timeout }}"
        dryrun: "{{ dryrun }}"
        api_version_number: "{{ api_version_number }}"

Inputs

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

dryrun:
    default: false
    description: Perform an optional dry run to check whether it is safe to shut down.
      The default value is false.
    required: false
    type: bool

timeout:
    default: 1800
    description: Time out value for getting cluster shutdown request id, 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

api_version_number:
    description: The version of API to call. If omitted, will use highest version on the
      system.
    required: false
    type: int

Outputs

Cluster_Shutdown_API:
  description: cluster shutdown information
  returned: always
  sample: "{\n        \"Request_ID\": \"8b7539c2-bcb8-48cf-897d-1f50ab39227f\",\n\
    \        \"Request_Status\": \"COMPLETED\"\n    }"
  type: dict