1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright: (c) 2021, Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# template: header.j2
# This module is autogenerated using the ansible.content_builder.
# See: https://github.com/ansible-community/ansible.content_builder
DOCUMENTATION = r"""
module: vcenter_vm_hardware_cpu
short_description: Updates the CPU-related settings of a virtual machine.
description: Updates the CPU-related settings of a virtual machine.
options:
cores_per_socket:
description:
- New number of CPU cores per socket. The number of CPU cores in the virtual
machine must be a multiple of the number of cores per socket.
- If unset, the value is unchanged.
type: int
count:
description:
- 'New number of CPU cores. The number of CPU cores in the virtual machine
must be a multiple of the number of cores per socket. '
- ' The supported range of CPU counts is constrained by the configured guest
operating system and virtual hardware version of the virtual machine. '
- ''
- ' If the virtual machine is running, the number of CPU cores may only be
increased if I(hot_add_enabled) is true, and may only be decreased if
I(hot_remove_enabled) is true.'
- ''
- If unset, the value is unchanged.
type: int
hot_add_enabled:
description:
- 'Flag indicating whether adding CPUs while the virtual machine is running
is enabled. '
- ' This field may only be modified if the virtual machine is powered off.'
- ''
- If unset, the value is unchanged.
type: bool
hot_remove_enabled:
description:
- 'Flag indicating whether removing CPUs while the virtual machine is running
is enabled. '
- ' This field may only be modified if the virtual machine is powered off.'
- ''
- If unset, the value is unchanged.
type: bool
session_timeout:
description:
- '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.
type: float
version_added: 2.1.0
state:
choices:
- present
default: present
description: []
type: str
vcenter_hostname:
description:
- 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.
required: true
type: str
vcenter_password:
description:
- 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.
required: true
type: str
vcenter_rest_log_file:
description:
- '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 C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
vcenter_username:
description:
- 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.
required: true
type: str
vcenter_validate_certs:
default: true
description:
- 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.
type: bool
vm:
description:
- Virtual machine identifier.
- The parameter must be the id of a resource returned by M(vmware.vmware_rest.vcenter_vm_info).
This parameter is mandatory.
required: true
type: str
author:
- Ansible Cloud Team (@ansible-collections)
version_added: 0.1.0
requirements:
- vSphere 7.0.3 or greater
- python >= 3.6
- aiohttp
notes:
- Tested on vSphere 7.0.3
"""
EXAMPLES = r"""
- name: Look up the VM called test_vm1 in the inventory
register: search_result
vmware.vmware_rest.vcenter_vm_info:
filter_names:
- test_vm1
- name: Collect information about a specific VM
vmware.vmware_rest.vcenter_vm_info:
vm: '{{ search_result.value[0].vm }}'
register: test_vm1_info
- name: Dedicate one core to the VM
vmware.vmware_rest.vcenter_vm_hardware_cpu:
vm: '{{ test_vm1_info.id }}'
count: 1
register: _result
"""
RETURN = r"""
# content generated by the update_return_section callback# task: Dedicate one core to the VM
id:
description: moid of the resource
returned: On success
sample: null
type: dict
value:
description: Dedicate one core to the VM
returned: On success
sample:
cores_per_socket: 1
count: 1
hot_add_enabled: 0
hot_remove_enabled: 0
type: dict
"""
# This structure describes the format of the data expected by the end-points
PAYLOAD_FORMAT = {
"update": {
"query": {},
"body": {
"cores_per_socket": "cores_per_socket",
"count": "count",
"hot_add_enabled": "hot_add_enabled",
"hot_remove_enabled": "hot_remove_enabled",
},
"path": {"vm": "vm"},
}
} # pylint: disable=line-too-long
from ansible.module_utils.basic import env_fallback
try:
from ansible_collections.cloud.common.plugins.module_utils.turbo.exceptions import (
EmbeddedModuleFailure,
)
from ansible_collections.cloud.common.plugins.module_utils.turbo.module import (
AnsibleTurboModule as AnsibleModule,
)
AnsibleModule.collection_name = "vmware.vmware_rest"
except ImportError:
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.vmware.vmware_rest.plugins.module_utils.vmware_rest import (
open_session,
prepare_payload,
session_timeout,
update_changed_flag,
)
def prepare_argument_spec():
argument_spec = {
"vcenter_hostname": dict(
type="str",
required=True,
fallback=(env_fallback, ["VMWARE_HOST"]),
),
"vcenter_username": dict(
type="str",
required=True,
fallback=(env_fallback, ["VMWARE_USER"]),
),
"vcenter_password": dict(
type="str",
required=True,
no_log=True,
fallback=(env_fallback, ["VMWARE_PASSWORD"]),
),
"vcenter_validate_certs": dict(
type="bool",
required=False,
default=True,
fallback=(env_fallback, ["VMWARE_VALIDATE_CERTS"]),
),
"vcenter_rest_log_file": dict(
type="str",
required=False,
fallback=(env_fallback, ["VMWARE_REST_LOG_FILE"]),
),
"session_timeout": dict(
type="float",
required=False,
fallback=(env_fallback, ["VMWARE_SESSION_TIMEOUT"]),
),
}
argument_spec["cores_per_socket"] = {"type": "int"}
argument_spec["count"] = {"type": "int"}
argument_spec["hot_add_enabled"] = {"type": "bool"}
argument_spec["hot_remove_enabled"] = {"type": "bool"}
argument_spec["state"] = {
"type": "str",
"choices": ["present"],
"default": "present",
}
argument_spec["vm"] = {"required": True, "type": "str"}
return argument_spec
async def main():
required_if = list([])
module_args = prepare_argument_spec()
module = AnsibleModule(
argument_spec=module_args, required_if=required_if, supports_check_mode=True
)
if not module.params["vcenter_hostname"]:
module.fail_json("vcenter_hostname cannot be empty")
if not module.params["vcenter_username"]:
module.fail_json("vcenter_username cannot be empty")
if not module.params["vcenter_password"]:
module.fail_json("vcenter_password cannot be empty")
try:
session = await open_session(
vcenter_hostname=module.params["vcenter_hostname"],
vcenter_username=module.params["vcenter_username"],
vcenter_password=module.params["vcenter_password"],
validate_certs=module.params["vcenter_validate_certs"],
log_file=module.params["vcenter_rest_log_file"],
)
except EmbeddedModuleFailure as err:
module.fail_json(err.get_message())
result = await entry_point(module, session)
module.exit_json(**result)
# template: default_module.j2
def build_url(params):
return ("https://{vcenter_hostname}" "/api/vcenter/vm/{vm}/hardware/cpu").format(
**params
)
async def entry_point(module, session):
if module.params["state"] == "present":
if "_create" in globals():
operation = "create"
else:
operation = "update"
elif module.params["state"] == "absent":
operation = "delete"
else:
operation = module.params["state"]
func = globals()["_" + operation]
return await func(module.params, session)
async def _update(params, session):
payload = prepare_payload(params, PAYLOAD_FORMAT["update"])
_url = ("https://{vcenter_hostname}" "/api/vcenter/vm/{vm}/hardware/cpu").format(
**params
)
async with session.get(_url, **session_timeout(params)) as resp:
_json = await resp.json()
if "value" in _json:
value = _json["value"]
else: # 7.0.2 and greater
value = _json
for k, v in value.items():
if k in payload:
if isinstance(payload[k], dict) and isinstance(v, dict):
to_delete = True
for _k in list(payload[k].keys()):
if payload[k][_k] != v.get(_k):
to_delete = False
if to_delete:
del payload[k]
elif payload[k] == v:
del payload[k]
elif payload[k] == {}:
del payload[k]
if payload == {} or payload == {"spec": {}}:
# Nothing has changed
if "value" not in _json: # 7.0.2
_json = {"value": _json}
_json["id"] = params.get("None")
return await update_changed_flag(_json, resp.status, "get")
async with session.patch(_url, json=payload, **session_timeout(params)) as resp:
try:
if resp.headers["Content-Type"] == "application/json":
_json = await resp.json()
except KeyError:
_json = {}
if "value" not in _json: # 7.0.2
_json = {"value": _json}
# e.g: content_configuration
if not _json and resp.status == 204:
async with session.get(_url, **session_timeout(params)) as resp_get:
_json_get = await resp_get.json()
if _json_get:
_json = _json_get
_json["id"] = params.get("None")
return await update_changed_flag(_json, resp.status, "update")
if __name__ == "__main__":
import asyncio
current_loop = asyncio.get_event_loop_policy().get_event_loop()
current_loop.run_until_complete(main())
|