dellemc / dellemc.vxrail / 2.1.0 / module / dellemc_vxrail_host_shutdown Shuts down a specific VxRail Host | "added in version" 1.5.0 of dellemc.vxrail" Authors: VxRail Development Team(@VxRailDevTeam) <ansible.team@dell.com>dellemc.vxrail.dellemc_vxrail_host_shutdown (2.1.0) — module
Install with ansible-galaxy collection install dellemc.vxrail:==2.1.0
collections: - name: dellemc.vxrail version: 2.1.0
This module will shut down a specified host
- name: Shut down a specific VxRail Host dellemc_vxrail_host_shutdown: vxmip: "{{ vxmip }}" vcadmin: "{{ vcadmin }}" vcpasswd: "{{ vcpasswd }}" host_sn: "{{ host_sn }}" dryrun: "{{ dryrun }}" evacuate_poweredoff_vms: "{{ evacuate_poweredoff_vms }}" timeout : "{{ timeout }}" api_version_number: "{{ api_version_number }}"
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 host. The default value is false. required: false type: bool host_sn: description: The serial number for the host to shut down required: true type: str timeout: default: 1800 description: Time out value for cancelling the host shutdown, 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 evacuate_poweredoff_vms: default: true description: Choose whether powered off vms should be evacuated off of the chosen host before shutdown. The default value is true. required: false type: bool
Host_Shutdown_API: description: Returns the request ID and whether the operation was successful. returned: always sample: "{\n \"Request_ID\": \"8b7539c2-bcb8-48cf-897d-1f50ab39227f\",\n \"\ Request_Status\": \"COMPLETED\"\n}" type: dict