vmware.vmware_rest.appliance_system_storage module – Resize the storage partitions 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.

New in vmware.vmware_rest 5.0.0

Synopsis

  • Resize all storage partitions of the vCenter Server Appliance to use 100 percent of the underlying disk size.

  • Use this module after enlarging one or more of the appliance’s virtual disks so that the partitions grow to fill the newly available space.

  • Use vmware.vmware_rest.appliance_system_storage_info to view the disk to partition mapping before resizing.

Parameters

Parameter

Comments

session_timeout

float

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

Default: 300.0

state

string / required

The resize action to perform on the appliance storage partitions.

Use resize to resize all partitions to 100 percent of the disk size.

Use resize-ex to resize all partitions and return the size of each partition before and after the operation.

Neither action is idempotent; each run attempts to resize the partitions.

Choices:

  • "resize"

  • "resize-ex"

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: Resize all appliance storage partitions to fill their disks
  vmware.vmware_rest.appliance_system_storage:
    state: resize

- name: Resize partitions and report the size change of each one
  vmware.vmware_rest.appliance_system_storage:
    state: resize-ex
  register: resize_result

Return Values

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

Key

Description

value

any

The raw API response body from the vCenter operation.

Empty when state=resize.

When state=resize-ex, a mapping of each partition to its size in MB before and after the resize.

Returned: On success

Sample: {"/storage/db": {"new_size": 25600, "old_size": 10240}, "/storage/log": {"new_size": 25600, "old_size": 10240}}

Authors

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