dellemc.vxrail.dellemc_vxrail_cluster_getvm (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 retrieve the name, status, and host information for system virtual machines in the VxRail cluster.

Usage examples

Scanned by Steampunk Spotter

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

  - name: Retrieves name, status and host information for system virtual machines in the VxRail cluster
    dellemc_vxrail_cluster_getvm:
        vxmip: "{{ vxmip }}"
        vcadmin: "{{ vcadmin }}"
        vcpasswd: "{{ vcpasswd }}"
        timeout : "{{ timeout }}"
        api_version_number: "{{ api_version_number }}"

Inputs

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

timeout:
    default: 60
    description: Time out value for getting cluster infomation, 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

Outputs

System_VM_Information:
  description: system VMs information summary
  returned: always
  sample: "[\n            {\n                \"host\": \"vcluster109-esx04.vv13xapp01.local\"\
    ,\n                \"name\": \"VxRail Manager\",\n                \"status\":\
    \ \"POWERED_ON\"\n            },\n            {\n                \"host\": \"\
    vcluster109-esx01.vv13xapp01.local\",\n                \"name\": \"VMware vCenter\
    \ Server Appliance\",\n                \"status\": \"POWERED_ON\"\n          \
    \  }\n        ]"
  type: dict