community.vmware.vmware_resource_pool – Add/remove resource pools to/from vCenter

Note

This plugin is part of the community.vmware collection (version 1.6.0).

To install it use: ansible-galaxy collection install community.vmware.

To use it in a playbook, specify: community.vmware.vmware_resource_pool.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

This module can be used to add/remove a resource pool to/from vCenter

Requirements

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

python >= 2.6
PyVmomi

Parameters

Parameter	Choices/Defaults	Comments
cluster string		Name of the cluster to configure the resource pool. This parameter is required if `esxi_hostname` is not specified.
cpu_allocation_shares integer added in 1.4.0 of community.vmware	Default: 4000	The number of cpu shares allocated. This value is only set if cpu_shares is set to `custom`.
cpu_expandable_reservations boolean	no yes ←	In a resource pool with an expandable reservation, the reservation on a resource pool can grow beyond the specified value.
cpu_limit integer	Default: -1	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.
cpu_reservation integer	Default: 0	Amount of resource that is guaranteed available to the virtual machine or resource pool.
cpu_shares string	high custom low normal ←	Memory shares are used in case of resource contention.
datacenter string / required		Name of the datacenter.
esxi_hostname string added in 1.5.0 of community.vmware		Name of the host to configure the resource pool. The host must not be member of a cluster. This parameter is required if `cluster` is not specified.
hostname string		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 support added in Ansible 2.6.
mem_allocation_shares integer added in 1.4.0 of community.vmware	Default: 163840	The number of memory shares allocated. This value is only set if mem_shares is set to `custom`.
mem_expandable_reservations boolean	no yes ←	In a resource pool with an expandable reservation, the reservation on a resource pool can grow beyond the specified value.
mem_limit integer	Default: -1	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.
mem_reservation integer	Default: 0	Amount of resource that is guaranteed available to the virtual machine or resource pool.
mem_shares string	high custom low normal ←	Memory shares are used in case of resource contention.
password string		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 support added in Ansible 2.6. aliases: pass, pwd
port integer	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 support added in Ansible 2.6.
proxy_host string		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 `VMWARE_PROXY_HOST` will be used instead. This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
proxy_port integer		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 `VMWARE_PROXY_PORT` will be used instead.
resource_pool string / required		Resource pool name to manage.
state string	present ← absent	Add or remove the resource pool
username string		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 support added in Ansible 2.6. aliases: admin, user
validate_certs boolean	no yes ←	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 support added in Ansible 2.6. If set to `true`, please make sure Python >= 2.7.9 is installed on the given machine.

Notes

Note

Tested on vSphere 6.5

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	Returned	Description
instance dictionary	always	metadata about the new resource pool Sample: None
resource_pool_config dictionary	always	config data about the resource pool, version added 1.4.0 Sample: { "_vimtype": "vim.ResourceConfigSpec", "changeVersion": null, "cpuAllocation": { "_vimtype": "vim.ResourceAllocationInfo", "expandableReservation": true, "limit": -1, "overheadLimit": null, "reservation": 0, "shares": { "_vimtype": "vim.SharesInfo", "level": "normal", "shares": 4000 } }, "entity": "vim.ResourcePool:resgroup-1108", "lastModified": null, "memoryAllocation": { "_vimtype": "vim.ResourceAllocationInfo", "expandableReservation": true, "limit": -1, "overheadLimit": null, "reservation": 0, "shares": { "_vimtype": "vim.SharesInfo", "level": "high", "shares": 327680 } }, "name": "test_pr1", "scaleDescendantsShares": null }

Authors

Davis Phillips (@dav1x)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/vmware/vmware_resource_pool_module.html