community.vmware.vmware_datastore_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 can be used to gather information about datastores in VMWare infrastructure.

All values and VMware object names are case sensitive.

Usage examples

Scanned by Steampunk Spotter

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

- name: Gather info from standalone ESXi server having datacenter as 'ha-datacenter'
  community.vmware.vmware_datastore_info:
    hostname: '{{ esxi_hostname }}'
    username: '{{ esxi_username }}'
    password: '{{ esxi_password }}'
    datacenter_name: "ha-datacenter"
  delegate_to: localhost
  register: info

Scanned by Steampunk Spotter

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

- name: Gather info from datacenter about specific datastore
  community.vmware.vmware_datastore_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: '{{ datacenter_name }}'
    name: datastore1
  delegate_to: localhost
  register: info

Scanned by Steampunk Spotter

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

- name: Gather some info from a datastore using the vSphere API output schema
  community.vmware.vmware_datastore_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: '{{ datacenter_name }}'
    schema: vsphere
    properties:
      - name
      - info.vmfs.ssd
      - capability.vsanSparseSupported
      - overallStatus
  delegate_to: localhost
  register: info

Inputs

    
name:
    description:
    - Name of the datastore to match.
    - If set, information of specific datastores are returned.
    required: false
    type: str

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

schema:
    choices:
    - summary
    - vsphere
    default: summary
    description:
    - Specify the output schema desired.
    - The 'summary' output schema is the legacy output from the module
    - The 'vsphere' output schema is the vSphere API class definition which requires pyvmomi>6.7.1
    type: str

cluster:
    description:
    - Cluster to search for datastores.
    - If set, information of datastores belonging this clusters will be returned.
    - This parameter is required, if O(datacenter) is not supplied.
    required: false
    type: str

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

show_tag:
    default: false
    description:
    - Tags related to Datastore are shown if set to V(true).
    type: bool

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:
    - Datacenter to search for datastores.
    - This parameter is required, if O(cluster) is not supplied.
    required: false
    type: str

properties:
    description:
    - Specify the properties to retrieve.
    - If not specified, all properties are retrieved (deeply).
    - Results are returned in a structure identical to the vsphere API.
    - 'Example:'
    - '   properties: ['
    - '      "name",'
    - '      "info.vmfs.ssd",'
    - '      "capability.vsanSparseSupported",'
    - '      "overallStatus"'
    - '   ]'
    - Only valid when O(schema=vsphere).
    elements: str
    required: false
    type: list

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

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

gather_nfs_mount_info:
    default: false
    description:
    - Gather mount information of NFS datastores.
    - Disabled per default because this slows down the execution if you have a lot of
      datastores.
    - Only valid when O(schema=summary).
    type: bool

gather_vmfs_mount_info:
    default: false
    description:
    - Gather mount information of VMFS datastores.
    - Disabled per default because this slows down the execution if you have a lot of
      datastores.
    - Only valid when O(schema=summary).
    type: bool

Outputs

datastores:
  description: metadata about the available datastores
  returned: always
  sample:
  - accessible: false
    capacity: 42681237504
    datastore_cluster: datacluster0
    freeSpace: 39638269952
    maintenanceMode: normal
    multipleHostAccess: false
    name: datastore2
    provisioned: 12289211488
    type: VMFS
    uncommitted: 9246243936
    url: ds:///vmfs/volumes/5a69b18a-c03cd88c-36ae-5254001249ce/
    vmfs_blockSize: 1024
    vmfs_uuid: 5a69b18a-c03cd88c-36ae-5254001249ce
    vmfs_version: '6.81'
  - accessible: true
    capacity: 5497558138880
    datastore_cluster: datacluster0
    freeSpace: 4279000641536
    maintenanceMode: normal
    multipleHostAccess: true
    name: datastore3
    nfs_path: /vol/datastore3
    nfs_server: nfs_server1
    provisioned: 1708109410304
    type: NFS
    uncommitted: 489551912960
    url: ds:///vmfs/volumes/420b3e73-67070776/
  type: list