vmware.vmware_rest.appliance_system_storage_info module – Gather the disk to partition mapping of the vCenter Server Appliance.

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.appliance_system_storage_info.

New in vmware.vmware_rest 5.0.0

Synopsis

  • Gather information about the storage layout of the vCenter Server Appliance.

  • Returns the mapping between the appliance storage partitions and the hard disk numbers that are visible in the vSphere Client.

  • Use this module to discover which disk backs each partition before resizing storage with vmware.vmware_rest.appliance_system_storage.

Parameters

Parameter

Comments

session_timeout

float

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

Default: 300.0

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: Gather the disk to partition mapping of the appliance
  vmware.vmware_rest.appliance_system_storage_info:
  register: storage_mapping

- name: Show the partition backed by each disk
  ansible.builtin.debug:
    msg: "Disk {{ item.disk }} backs partition {{ item.partition }}"
  loop: "{{ storage_mapping.info }}"

Return Values

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

Key

Description

info

list / elements=dictionary

A list of the disk to partition mapping entries on the appliance.

Returned: On success

Sample: [{"description": {"default_message": "Root partition", "id": "com.vmware.applmgmt.storage.root"}, "disk": "1", "partition": "/"}, {"description": {"default_message": "Log partition", "id": "com.vmware.applmgmt.storage.log"}, "disk": "2", "partition": "/storage/log"}]

value

any

Detailed information about the appliance storage partitions.

A list of disk to partition mapping entries.

Returned: On success

Sample: [{"description": {"default_message": "Root partition", "id": "com.vmware.applmgmt.storage.root"}, "disk": "1", "partition": "/"}, {"description": {"default_message": "Log partition", "id": "com.vmware.applmgmt.storage.log"}, "disk": "2", "partition": "/storage/log"}]

Authors

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