dellemc.vxrail.dellemc_vxrail_satellite_node_remove (2.2.0) — module

Remove a satellite host from the cluster

| "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 Remove a satellite host from the cluster.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove a node
  dellemc_vxrail_satellite_node_remove:
        vxmip: "{{ vxmip }}"
        vcadmin: "{{ vcadmin }}"
        vcpasswd: "{{ vcpasswd }}"
        host_sn: "{{ host_sn }}"
        api_version_number: "{{ api_version_number }}"

Inputs

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

host_sn:
    description: Serial number of the host to be removed
    required: true
    type: str

timeout:
    default: 1800
    description: Time out value for Day1 bring up, 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: 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

Remove_Node_status:
  description: Node Removal status summary
  returned: always
  sample: "{\n \"Remove_Node\": {\n     \"host_sn\": \"BB8VG03\"\n }\n \"msg\": \"\
    Removing Node is successful. Please see the /tmp/vxrail_ansible_satellite_node_remove.log\
    \ for more details\"\n}"
  type: dict
changed:
  description: Whether or not the resource has changed.
  returned: always
  type: bool