vmware.vmware_rest.vcenter_datacenter module – Create a new datacenter in the vCenter inventory
Note
This module is part of the vmware.vmware_rest collection (version 2.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.
To use it in a playbook, specify: vmware.vmware_rest.vcenter_datacenter.
New in version 0.1.0: of vmware.vmware_rest
Requirements
The below requirements are needed on the host that executes this module.
vSphere 7.0.2 or greater
python >= 3.6
aiohttp
Parameters
Parameter |
Comments |
|---|---|
Identifier of the datacenter to be deleted. Required with state=[‘absent’] |
|
Datacenter folder in which the new datacenter should be created. |
|
If true, delete the datacenter even if it is not empty. Choices:
|
|
The name of the datacenter to be created. Required with state=[‘present’] |
|
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. |
|
Choices:
|
|
The hostname or IP address of the vSphere vCenter If the value is not specified in the task, the value of environment variable |
|
The vSphere vCenter password If the value is not specified in the task, the value of environment variable |
|
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 |
|
The vSphere vCenter username If the value is not specified in the task, the value of environment variable |
|
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:
|
Examples
- name: Get a list of all the datacenters
register: existing_datacenters
vmware.vmware_rest.vcenter_datacenter_info:
- name: Force delete the existing DC
vmware.vmware_rest.vcenter_datacenter:
state: absent
datacenter: '{{ item.datacenter }}'
force: true
with_items: '{{ existing_datacenters.value }}'
until:
- _result is not failed
retries: 7
- name: Create datacenter my_dc
vmware.vmware_rest.vcenter_datacenter:
name: my_dc
folder: '{{ my_datacenter_folder.folder }}'
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Force delete the existing DC Returned: On success Sample: “All items completed” |
|
Force delete the existing DC Returned: On success Sample: [{“_ansible_item_label”: {“datacenter”: “datacenter-1107”, “name”: “my_dc”}, “_ansible_no_log”: null, “ansible_loop_var”: “item”, “attempts”: 1, “changed”: 1, “failed”: 0, “invocation”: {“module_args”: {“datacenter”: “datacenter-1107”, “folder”: null, “force”: 1, “name”: null, “session_timeout”: null, “state”: “absent”, “vcenter_hostname”: “vcenter.test”, “vcenter_password”: “VALUE_SPECIFIED_IN_NO_LOG_PARAMETER”, “vcenter_rest_log_file”: null, “vcenter_username”: “administrator@vsphere.local”, “vcenter_validate_certs”: 0}}, “item”: {“datacenter”: “datacenter-1107”, “name”: “my_dc”}, “value”: {}}] |
Authors
Ansible Cloud Team (@ansible-collections)