community.vmware.vmware_folder_info module – Provides information about folders in a datacenter
Note
This module is part of the community.vmware collection (version 6.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 community.vmware.
To use it in a playbook, specify: community.vmware.vmware_folder_info.
Synopsis
- The module can be used to gather a hierarchical view of the folders that exist within a datacenter
Parameters
Parameter | Comments |
|---|---|
datacenter aliases: datacenter_name string / required | Name of the datacenter. |
hostname string | The hostname or IP address of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable |
password aliases: pass, pwd string | The password of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable |
port integer | The port number of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable Default: |
proxy_host string | The address of a proxy that will receive all HTTPS requests and relay them. The format is a hostname or a IP. If the value is not specified in the task, the value of environment variable |
proxy_port integer | The port of the HTTP proxy that will receive all HTTPS requests and relay them. If the value is not specified in the task, the value of environment variable |
username aliases: admin, user string | The username of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable |
validate_certs boolean | Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
Notes
Note
- All modules require API write access and hence are not supported on a free ESXi license.
- All variables and VMware object names are case sensitive.
- Modules may rely on the ‘requests’ python library, which does not use the system certificate store by default. You can specify the certificate store by setting the REQUESTS_CA_BUNDLE environment variable. Note having this variable set may cause a ‘false’ value for the ‘validate_certs’ option to be ignored in some cases. Example: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’
Examples
- name: Provide information about vCenter folders
community.vmware.vmware_folder_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
datacenter: datacenter_name
delegate_to: localhost
register: vcenter_folder_info
- name: Get information about folders
community.vmware.vmware_folder_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
datacenter: 'Asia-Datacenter1'
register: r
- name: Set Managed object ID for the given folder
ansible.builtin.set_fact:
folder_mo_id: "{{ (r.flat_folder_info | selectattr('path', 'equalto', '/Asia-Datacenter1/vm/tier1/tier2') | map(attribute='moid'))[0] }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Description |
|---|---|
flat_folder_info list / elements=string | list of dict about folders in flat structure Returned: success Sample: |
folder_info dictionary | dict about folders Returned: success Sample: |
Collection links
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/vmware/vmware_folder_info_module.html
