vmware.vmware_rest.vcenter_folder_info module – Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the Folder.FilterSpec.

Note

This module is part of the vmware.vmware_rest collection (version 3.2.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. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: vmware.vmware_rest.vcenter_folder_info.

New in vmware.vmware_rest 0.1.0

Synopsis

  • Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the Folder.FilterSpec.

Requirements

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

  • vSphere 7.0.3 or greater

  • python >= 3.6

  • aiohttp

Parameters

Parameter

Comments

datacenters

aliases: filter_datacenters

list / elements=string

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

If unset or empty, folder in any datacenter match the filter.

When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_datacenter_info.

folders

aliases: filter_folders

list / elements=string

Identifiers of folders that can match the filter.

If unset or empty, folders with any identifier match the filter.

When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_folder_info.

names

aliases: filter_names

list / elements=string

Names that folders must have to match the filter (see name).

If unset or empty, folders with any name match the filter.

parent_folders

list / elements=string

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

If unset or empty, folder in any folder match the filter.

When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.vcenter_folder_info.

session_timeout

float

added in vmware.vmware_rest 2.1.0

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.

type

aliases: filter_type

string

The type enumerated type defines the type of a vCenter Server folder. The type of a folder determines what what kinds of children can be contained in the folder.

Choices:

  • "DATACENTER"

  • "DATASTORE"

  • "HOST"

  • "NETWORK"

  • "VIRTUAL_MACHINE"

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:

  • false

  • true ← (default)

Notes

Note

  • Tested on vSphere 7.0.3

Examples

- name: Build a list of all the folders
  vmware.vmware_rest.vcenter_folder_info:
  register: my_folders

- name: Build a list of all the folders with the type VIRTUAL_MACHINE and called vm
  vmware.vmware_rest.vcenter_folder_info:
    filter_type: VIRTUAL_MACHINE
    filter_names:
    - vm
  register: my_folders

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 folders with the type VIRTUAL_MACHINE and called vm

Returned: On success

Sample: [{"folder": "group-v1002", "name": "vm", "type": "VIRTUAL_MACHINE"}]

Authors

  • Ansible Cloud Team (@ansible-collections)