community.vmware.vmware_vsan_health_info (4.2.0) — module

Install collection

Install with ansible-galaxy collection install community.vmware:==4.2.0

Add to requirements.yml

  collections:
    - name: community.vmware
      version: 4.2.0

Description

Gather information about a VMware vSAN cluster's health.

Requirements

• VMware vSAN Python's SDK

Usage examples

Scanned by Steampunk Spotter

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

- name: Gather health info from a vSAN's cluster
  community.vmware.vmware_vsan_health_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    cluster_name: 'vSAN01'
    fetch_from_cache: false

Scanned by Steampunk Spotter

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

- name: Gather health info from a vSAN's cluster with datacenter
  community.vmware.vmware_vsan_health_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    cluster_name: 'vSAN01'
    datacenter: 'Datacenter_01'
    fetch_from_cache: true

Inputs

    
port:
    default: 443
    description:
    - The port number of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_PORT)
      will be used instead.
    type: int

hostname:
    description:
    - The hostname or IP address of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_HOST)
      will be used instead.
    type: str

password:
    aliases:
    - pass
    - pwd
    description:
    - The password of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD)
      will be used instead.
    type: str

username:
    aliases:
    - admin
    - user
    description:
    - The username of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_USER)
      will be used instead.
    type: str

datacenter:
    aliases:
    - datacenter_name
    description:
    - Name of the Datacenter.
    required: false
    type: str

proxy_host:
    description:
    - Address of a proxy that will receive all HTTPS requests and relay them.
    - The format is a hostname or a IP.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_HOST)
      will be used instead.
    required: false
    type: str

proxy_port:
    description:
    - Port of the HTTP proxy that will receive all HTTPS requests and relay them.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_PORT)
      will be used instead.
    required: false
    type: int

cluster_name:
    description:
    - Name of the vSAN cluster.
    required: true
    type: str

validate_certs:
    default: true
    description:
    - Allows connection when SSL certificates are not valid. Set to V(false) when certificates
      are not trusted.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS)
      will be used instead.
    type: bool

fetch_from_cache:
    default: false
    description:
    - V(true) to return the result from cache directly instead of running the full health
      check.
    required: false
    type: bool

Outputs

vsan_health_info:
  description: vSAN cluster health info
  returned: on success
  sample:
    _vimtype: vim.cluster.VsanClusterHealthSummary
    burnInTest: null
    clusterStatus:
      _vimtype: vim.cluster.VsanClusterHealthSystemStatusResult
      goalState: installed
      status: green
      trackedHostsStatus:
      - _vimtype: vim.host.VsanHostHealthSystemStatusResult
        hostname: esxi01.example.com
        issues: []
        status: green
      - _vimtype: vim.host.VsanHostHealthSystemStatusResult
        hostname: esxi04.example.com
        issues: []
        status: green
      - _vimtype: vim.host.VsanHostHealthSystemStatusResult
        hostname: esxi02.example.com
        issues: []
        status: green
      - _vimtype: vim.host.VsanHostHealthSystemStatusResult
        hostname: esxi03.example.com
        issues: []
        status: green
      untrackedHosts: []
  type: dict