vcenter_datacenter
Create a new datacenter in the vCenter inventory
Collection: vmware.vmware_rest
Full Name: vmware.vmware_rest.vcenter_datacenter
Synopsis
Create a new datacenter in the vCenter inventory
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| vcenter_hostname | string | yes | The hostname or IP address of the vSphere vCenter | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_HOST) will be used instead. | ||||
| vcenter_username | string | yes | The vSphere vCenter username | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_USER) will be used instead. | ||||
| vcenter_password | string | yes | The vSphere vCenter password | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD) will be used instead. | ||||
| vcenter_validate_certs | bool | true | Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted. | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS) 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 runs the module. | ||||
| If the value is not specified in the task, the value of | ||||
| environment variable C(VMWARE_REST_LOG_FILE) will be used instead. | ||||
| session_timeout | float | 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. | ||||
| datacenter | string | Identifier of the datacenter to be deleted. | ||
| The parameter must be the id of a resource returned by M(vmware.vmware_rest.vcenter_datacenter_info). Required with I(state=[‘absent’]) | ||||
| folder | string | Datacenter folder in which the new datacenter should be created. | ||
| This field is currently required. In the future, if this field is unset, the system will attempt to choose a suitable folder for the datacenter; if a folder cannot be chosen, the datacenter creation operation will fail. | ||||
| When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by M(vmware.vmware_rest.vcenter_folder_info). | ||||
| force | bool | If true, delete the datacenter even if it is not empty. | ||
| If unset a ResourceInUse error will be reported if the datacenter is not empty. This is the equivalent of passing the value false. | ||||
| name | string | The name of the datacenter to be created. Required with I(state=[‘present’]) | ||
| state | string | present | Operation to perform; allowed values: absent, present. |
Example
yaml
- 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 }}'