vmware.vmware_rest.vcenter_storage_policies_info module – Gather information about vCenter storage policies.

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

New in vmware.vmware_rest 5.0.0

Synopsis

  • Retrieve information about VMware vSphere storage policies.

  • Storage policies define storage requirements and capabilities for virtual machines and virtual disks through Storage Policy-Based Management (SPBM).

  • Use this module to list all available storage policies or to get details about specific policies by their identifiers.

  • Storage policies help ensure that VM storage is provisioned on datastores that meet defined service levels and capabilities.

Parameters

Parameter

Comments

policies

list / elements=string

A list of storage policy MOIDs to filter the results.

Only storage policies whose identifiers appear in this list will be returned.

If omitted or empty, all storage policies are returned.

This parameter was added in vSphere API 6.7.

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: List all storage policies
  vmware.vmware_rest.vcenter_storage_policies_info:
  register: all_storage_policies

- name: Get details about specific storage policies
  vmware.vmware_rest.vcenter_storage_policies_info:
    policies:
      - aa6d5a82-1c88-45da-85d3-3d74b91a5bad
      - 9b0e68e6-54cf-4b59-9e53-8a8e0b45c4d2
  register: filtered_policies

Return Values

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

Key

Description

id

string

Identifier of the queried storage policy.

Returned: When only one storage policy, with an identifier, was queried.

Sample: "aa6d5a82-1c88-45da-85d3-3d74b91a5bad"

info

list / elements=string

A list of storage policies matching the query.

Returned: On success.

Sample: [{"description": "Storage policy for virtual machine workloads", "name": "VM Storage Policy", "policy": "aa6d5a82-1c88-45da-85d3-3d74b91a5bad"}, {"description": "Storage policy for high-performance applications", "name": "High Performance Policy", "policy": "9b0e68e6-54cf-4b59-9e53-8a8e0b45c4d2"}]

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: {"description": "Storage policy for virtual machine workloads", "name": "VM Storage Policy", "policy": "aa6d5a82-1c88-45da-85d3-3d74b91a5bad"}

Authors

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