community.vmware.vmware_resource_pool module – Add/remove resource pools to/from vCenter
Note
This module is part of the community.vmware collection (version 1.18.2).
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_resource_pool.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
PyVmomi
Parameters
Parameter |
Comments |
|---|---|
Name of the cluster to configure the resource pool. This parameter is required if The |
|
The number of cpu shares allocated. This value is only set if cpu_shares is set to Default: 4000 |
|
In a resource pool with an expandable reservation, the reservation on a resource pool can grow beyond the specified value. Choices:
|
|
The utilization of a virtual machine/resource pool will not exceed this limit, even if there are available resources. The default value -1 indicates no limit. Default: -1 |
|
Amount of resource that is guaranteed available to the virtual machine or resource pool. Default: 0 |
|
Memory shares are used in case of resource contention. Choices:
|
|
Name of the datacenter. |
|
Name of the host to configure the resource pool. The host must not be member of a cluster. This parameter is required if The |
|
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 Environment variable support added in Ansible 2.6. |
|
The number of memory shares allocated. This value is only set if mem_shares is set to Default: 163840 |
|
In a resource pool with an expandable reservation, the reservation on a resource pool can grow beyond the specified value. Choices:
|
|
The utilization of a virtual machine/resource pool will not exceed this limit, even if there are available resources. The default value -1 indicates no limit. Default: -1 |
|
Amount of resource that is guaranteed available to the virtual machine or resource pool. Default: 0 |
|
Memory shares are used in case of resource contention. Choices:
|
|
Name of the parent resource pool. This parameter is required if The |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. Default: 443 |
|
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 This feature depends on a version of pyvmomi greater than v6.7.1.2018.12 |
|
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 |
|
Resource pool name to manage. |
|
Add or remove the resource pool Choices:
|
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. If set to Choices:
|
Notes
Note
Tested on vSphere 6.5
All modules requires API write access and hence is not supported on a free ESXi license.
Examples
- name: Add resource pool to vCenter
community.vmware.vmware_resource_pool:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
datacenter: '{{ datacenter_name }}'
cluster: '{{ cluster_name }}'
resource_pool: '{{ resource_pool_name }}'
mem_shares: normal
mem_limit: -1
mem_reservation: 0
mem_expandable_reservations: true
cpu_shares: normal
cpu_limit: -1
cpu_reservation: 0
cpu_expandable_reservations: true
state: present
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
metadata about the new resource pool Returned: always Sample: “None” |
|
config data about the resource pool, version added 1.4.0 Returned: always Sample: “{\n \”_vimtype\”: \”vim.ResourceConfigSpec\”,\n \”changeVersion\”: null,\n \”cpuAllocation\”: {\n \”_vimtype\”: \”vim.ResourceAllocationInfo\”,\n \”expandableReservation\”: true,\n \”limit\”: -1,\n \”overheadLimit\”: null,\n \”reservation\”: 0,\n \”shares\”: {\n \”_vimtype\”: \”vim.SharesInfo\”,\n \”level\”: \”normal\”,\n \”shares\”: 4000\n }\n },\n \”entity\”: \”vim.ResourcePool:resgroup-1108\”,\n \”lastModified\”: null,\n \”memoryAllocation\”: {\n \”_vimtype\”: \”vim.ResourceAllocationInfo\”,\n \”expandableReservation\”: true,\n \”limit\”: -1,\n \”overheadLimit\”: null,\n \”reservation\”: 0,\n \”shares\”: {\n \”_vimtype\”: \”vim.SharesInfo\”,\n \”level\”: \”high\”,\n \”shares\”: 327680\n }\n },\n \”name\”: \”test_pr1\”,\n \”scaleDescendantsShares\”: null\n}” |
Authors
Davis Phillips (@dav1x)