Documentation

vcenter_folder - Manage folders on given datacenter

New in version 2.5.

Synopsis

  • This module can be used to create, delete, move and rename folder on then given datacenter.

Requirements

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

  • python >= 2.6
  • PyVmomi

Parameters

Parameter
Choices/Defaults
Comments
datacenter
required
Name of the datacenter.
folder_name
required
Name of folder to be managed.
This is case sensitive parameter.
Folder name should be under 80 characters. This is a VMware restriction.
folder_type
    Choices:
  • datastore
  • host
  • network
  • vm ←
This is type of folder.
If set to vm, then 'VM and Template Folder' is created under datacenter.
If set to host, then 'Host and Cluster Folder' is created under datacenter.
If set to datastore, then 'Storage Folder' is created under datacenter.
If set to network, then 'Network Folder' is created under datacenter.
This parameter is required, if state is set to present and parent_folder is absent.
This option is ignored, if parent_folder is set.
hostname
The hostname or IP address of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
Environment variable supported added in version 2.6.
parent_folder
Name of the parent folder under which new folder needs to be created.
This is case sensitive parameter.
Please specify unique folder name as there is no way to detect duplicate names.
If user wants to create a folder under '/DC0/vm/vm_folder', this value will be 'vm_folder'.
password
The password of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
Environment variable supported added in version 2.6.

aliases: pass, pwd
port
(added in 2.5)
Default:
443
The port number of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
Environment variable supported added in version 2.6.
state
    Choices:
  • present ←
  • absent
State of folder.
If set to present without parent folder parameter, then folder with folder_type is created.
If set to present with parent folder parameter, then folder in created under parent folder. folder_type is ignored.
If set to absent, then folder is unregistered and destroyed.
username
The username of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
Environment variable supported added in version 2.6.

aliases: user, admin
validate_certs
    Choices:
  • no
  • yes
Default:
True
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.
Environment variable supported added in version 2.6.

Notes

Note

  • Tested on vSphere 6.5

Examples

- name: Create a VM folder on given datacenter
  vcenter_folder:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: datacenter_name
    folder_name: sample_vm_folder
    folder_type: vm
    state: present
  register: vm_folder_creation_result

- name: Create a datastore folder on given datacenter
  vcenter_folder:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: datacenter_name
    folder_name: sample_datastore_folder
    folder_type: datastore
    state: present
  register: datastore_folder_creation_result

- name: Create a sub folder under VM folder on given datacenter
  vcenter_folder:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: datacenter_name
    folder_name: sample_sub_folder
    parent_folder: vm_folder
    state: present
  register: sub_folder_creation_result

- name: Delete a VM folder on given datacenter
  vcenter_folder:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: datacenter_name
    folder_name: sample_vm_folder
    folder_type: vm
    state: absent
  register: vm_folder_deletion_result

Return Values

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

Key
Returned
Description
result
string
success
string stating about result

Sample:
Folder 'sub_network_folder' of type 'vm' created under vm_folder successfully.


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Abhijeet Kasurde (@akasurde)

Hint

If you notice any issues in this documentation you can edit this document to improve it.