vmware.vmware_rest.vcenter_datastore_info module – Gather information about vCenter datastores.

Note

This module is part of the vmware.vmware_rest collection (version 5.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install vmware.vmware_rest.

To use it in a playbook, specify: vmware.vmware_rest.vcenter_datastore_info.

New in vmware.vmware_rest 5.0.0

Synopsis

  • Retrieve information about one or more VMware vCenter datastores.

  • Can return a list of all datastores or detailed information about a specific datastore identified by its MOID.

  • Use the filter parameters to narrow results by datastore name, identifier, type, folder, or datacenter.

Parameters

Parameter

Comments

datacenters

aliases: filter_datacenters

list / elements=string

A list of datacenter MOIDs to filter the results.

Only datastores that reside in the specified datacenters will be returned.

If omitted or empty, datastores in any datacenter are returned.

datastore

string

Identifier of the datastore to retrieve details for.

Must be an identifier (MOID) for a Datastore resource.

datastores

list / elements=string

A list of datastore MOIDs to filter the results.

Only datastores whose identifiers appear in this list will be returned.

If omitted or empty, datastores with any identifier are returned.

folders

aliases: filter_folders

list / elements=string

A list of folder MOIDs to filter the results.

Only datastores that reside in the specified folders will be returned.

If omitted or empty, datastores in any folder are returned.

names

aliases: filter_names

list / elements=string

A list of datastore names to filter the results.

Only datastores whose names appear in this list will be returned.

If omitted or empty, datastores with any name are returned.

session_timeout

float

Timeout in seconds for the whole operation including connection establishment, request sending, and response.

Default: 300.0

types

aliases: filter_types

list / elements=string

A list of datastore types to filter the results.

Only datastores of one of the listed types will be returned.

If omitted or empty, datastores of any type are returned.

Valid types are the following.

VMFS - VMware File System (ESX Server only).

NFS - Network file system v3 (linux & esx servers only).

NFS41 - Network file system v4.1 (linux & esx servers only).

CIFS - Common Internet File System.

VSAN - Virtual SAN (ESX Server only).

VFFS - Flash Read Cache (ESX Server only).

VVOL - vSphere Virtual Volume (ESX Server only).

vcenter_hostname

string / required

The hostname or IP address of the vSphere vCenter.

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

vcenter_password

string / required

The vSphere vCenter password.

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

vcenter_port

integer

The port number of the vSphere vCenter.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

vcenter_rest_log_file

string

Optional path to a log file for HTTP REST interaction.

If the value is not specified in the task, the value of environment variable VMWARE_REST_LOG_FILE will be used instead.

vcenter_username

string / required

The vSphere vCenter username.

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

vcenter_validate_certs

boolean

Allows connection when SSL certificates are not valid.

Set to false when certificates are not trusted.

If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.

Choices:

  • false

  • true ← (default)

Notes

Note

  • Generated from vSphere API spec 9.1.0.

  • Compatible with vSphere API 7.0.3.

  • Compatible with vSphere API 8.0.2.

Examples

- name: List all datastores
  vmware.vmware_rest.vcenter_datastore_info:
  register: all_datastores

- name: Get details about a specific datastore
  vmware.vmware_rest.vcenter_datastore_info:
    datastore: datastore-1001
  register: my_datastore

- name: Filter datastores by name
  vmware.vmware_rest.vcenter_datastore_info:
    names:
      - my_datastore
  register: filtered_datastores

- name: Filter VMFS and NFS datastores in a specific datacenter
  vmware.vmware_rest.vcenter_datastore_info:
    types:
      - VMFS
      - NFS
    datacenters:
      - datacenter-1001
  register: filtered_datastores

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

id

string

MOID of the queried datastore.

This is not returned when a single datastore is looked up directly by its MOID (using the datastore parameter), since it would be redundant with the value the caller already supplied.

Returned: When only one resource, with a MOID, was queried.

Sample: "datastore-1001"

info

list / elements=string

A list of datastores matching the query.

Returned: On success.

Sample: [{"capacity": 53687091200, "datastore": "datastore-1001", "free_space": 32204521472, "name": "my_datastore", "type": "VMFS"}]

value

any

Raw output from the API response.

This output is maintained for consistency with version 4.x and earlier of this collection. It is recommended to switch to the info return key for a more consistent and documented output.

Returned: On success.

Sample: {"accessible": true, "free_space": 32204521472, "multiple_host_access": true, "name": "my_datastore", "thin_provisioning_supported": true, "type": "VMFS"}

Authors

  • Ansible Eco Content Team (@eco-ansible-content)