vmware.vmware_rest.vcenter_datastore_info module – Retrieves information about the datastore indicated by {@param.name datastore}.

Note

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

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 version 0.1.0: of vmware.vmware_rest

Synopsis

  • Retrieves information about the datastore indicated by {@param.name datastore}.

Requirements

The below requirements are needed on the host that executes this module.

  • vSphere 7.0.2 or greater

  • python >= 3.6

  • aiohttp

Parameters

Parameter

Comments

datacenters

aliases: filter_datacenters

list / elements=string

Datacenters that must contain the datastore for the datastore to match the filter.

datastore

string

Identifier of the datastore for which information should be retrieved. Required with state=[‘get’]

datastores

list / elements=string

Identifiers of datastores that can match the filter.

folders

aliases: filter_folders

list / elements=string

Folders that must contain the datastore for the datastore to match the filter.

names

aliases: filter_names

list / elements=string

Names that datastores must have to match the filter (see {@link Info#name}).

session_timeout

float

added in 2.1.0 of vmware.vmware_rest

Timeout settings for client session.

The maximal number of seconds for the whole operation including connection establishment, request sending and response.

The default value is 300s.

types

aliases: filter_types

list / elements=string

Types that datastores must have to match the filter (see {@link Summary#type}).

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_rest_log_file

string

You can use this optional parameter to set the location of a log file.

This file will be used to record the HTTP REST interaction.

The file will be stored on the host that run the module.

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:

  • no

  • yes ← (default)

Notes

Note

  • Tested on vSphere 7.0.2

Examples

- name: Build a list of all the datastores
  vmware.vmware_rest.vcenter_datastore_info:
  register: all_the_datastores

Return Values

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

Key

Description

value

list / elements=string

Build a list of all the datastores

Returned: On success

Sample: [{“capacity”: 11542724608, “datastore”: “datastore-1016”, “free_space”: 10033823744, “name”: “local”, “type”: “VMFS”}, {“capacity”: 26208088064, “datastore”: “datastore-1018”, “free_space”: 24281169920, “name”: “ro_datastore”, “type”: “NFS”}, {“capacity”: 26208088064, “datastore”: “datastore-1020”, “free_space”: 24281169920, “name”: “rw_datastore”, “type”: “NFS”}]

Authors

  • Ansible Cloud Team (@ansible-collections)