vmware.vmware_rest.vcenter_folder_info module – Gather information about vCenter folders.

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

New in vmware.vmware_rest 5.0.0

DEPRECATED

Removed in:

version 6.0.0

Why:

This functionality has been moved to vmware.vmware.folder_info.

Alternative:

Use vmware.vmware.folder_info instead.

Synopsis

  • Retrieve information about one or more VMware vCenter folders.

  • Returns the folders that match the supplied filters, or all folders when no filter is given.

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

Parameters

Parameter

Comments

datacenters

aliases: filter_datacenters

list / elements=string

A list of datacenter MOIDs to filter the results.

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

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

filter

dictionary

A specification used to filter the folders that are returned.

If omitted, all folders match the filter.

type

string

Return only folders of this type.

DATACENTER - A folder that can contain datacenters.

DATASTORE - A folder that can contain datastores.

HOST - A folder that can contain compute resources (hosts and clusters).

NETWORK - A folder that can contain networks.

VIRTUAL_MACHINE - A folder that can contain virtual machines.

If omitted, folders of any type are returned.

Choices:

  • "DATACENTER"

  • "DATASTORE"

  • "HOST"

  • "NETWORK"

  • "VIRTUAL_MACHINE"

folders

aliases: filter_folders

list / elements=string

A list of folder MOIDs to filter the results.

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

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

names

aliases: filter_names

list / elements=string

A list of folder names to filter the results.

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

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

parent_folders

list / elements=string

A list of parent folder MOIDs to filter the results.

Only folders that reside directly within the specified parent folders will be returned.

If omitted or empty, folders in any parent folder are returned.

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 folders
  vmware.vmware_rest.vcenter_folder_info:
  register: all_folders

- name: List only virtual machine folders
  vmware.vmware_rest.vcenter_folder_info:
    filter:
      type: VIRTUAL_MACHINE
  register: vm_folders

- name: Filter folders by name
  vmware.vmware_rest.vcenter_folder_info:
    names:
      - my_folder
  register: filtered_folders

- name: List virtual machine folders within a specific datacenter
  vmware.vmware_rest.vcenter_folder_info:
    filter:
      type: VIRTUAL_MACHINE
    datacenters:
      - datacenter-1001
  register: dc_vm_folders

Return Values

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

Key

Description

info

list / elements=string

A list of folders matching the query.

Returned: On success.

Sample: [{"folder": "group-v1005", "name": "my_folder", "type": "VIRTUAL_MACHINE"}]

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: {"folder": "group-v1005", "name": "my_folder", "type": "VIRTUAL_MACHINE"}

Status

  • This module will be removed in version 6.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

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