community.vmware.vmware_host_disk_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

This module returns information about disks attached to given ESXi host/s

If O(cluster_name) is provided, then disk information about all hosts from the given cluster will be returned.

If O(esxi_hostname) is provided, then disk information about the given host system will be returned.

Usage examples

Scanned by Steampunk Spotter

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

- name: Gather info about vmhbas of all ESXi Host in the given Cluster
  community.vmware.vmware_host_disk_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: '{{ cluster_name }}'
  delegate_to: localhost
  register: cluster_host_vmhbas

Scanned by Steampunk Spotter

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

- name: Gather info about vmhbas of an ESXi Host
  community.vmware.vmware_host_disk_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
  delegate_to: localhost
  register: host_vmhbas

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

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 cluster from which the ESXi host belong to.
    - If O(esxi_hostname) is not given, this parameter is required.
    type: str

esxi_hostname:
    description:
    - ESXi hostname to gather information from.
    - If O(cluster_name) is not given, this parameter is required.
    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

Outputs

hosts_disk_info:
  description: list of information for all disks attached to each ESXi host
  returned: always
  sample: "\"192.168.0.182\": [\n    {\n        \"canonical_name\": \"naa.6000c296ed6217bd61df35622eb21a3a\"\
    ,\n        \"capacity_mb\": 4096,\n        \"device_path\": \"/vmfs/devices/disks/naa.6000c296ed6217bd61df35622eb21a3a\"\
    ,\n        \"device_type\": \"disk\",\n        \"device_ctd_list\": [\n      \
    \      \"vmhba0:C0:T1:L0\"\n        ],\n        \"disk_uid\": \"key-vim.host.ScsiDisk-02000000006000c296ed6217bd61df35622eb21a3a566972747561\"\
    ,\n        \"display_name\": \"Local VMware Disk (naa.6000c296ed6217bd61df35622eb21a3a)\"\
    \n    },\n    {\n        \"canonical_name\": \"naa.6000c2968ad7142d93faae527fe8822b\"\
    ,\n        \"capacity_mb\": 204800,\n        \"device_path\": \"/vmfs/devices/disks/naa.6000c2968ad7142d93faae527fe8822b\"\
    ,\n        \"device_type\": \"disk\",\n        \"device_ctd_list\": [\n      \
    \      \"vmhba0:C0:T3:L0\"\n        ],\n        \"disk_uid\": \"key-vim.host.ScsiDisk-02000000006000c2968ad7142d93faae527fe8822b566972747561\"\
    ,\n        \"display_name\": \"Local VMware Disk (naa.6000c2968ad7142d93faae527fe8822b)\"\
    \n    },]"
  type: list