community.vmware.vmware_guest_video – Modify video card configurations of specified virtual machine in given vCenter infrastructure
community.vmware.vmware_guest_video – Modify video card configurations of specified virtual machine in given vCenter infrastructure
Note
This plugin is part of the community.vmware collection (version 1.7.0).
To install it use: ansible-galaxy collection install community.vmware
.
To use it in a playbook, specify: community.vmware.vmware_guest_video
.
Synopsis
- This module is used to reconfigure video card settings of given virtual machine.
- All parameters and VMware object names are case sensitive.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- PyVmomi
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
datacenter string |
Default: "ha-datacenter" |
The datacenter name to which virtual machine belongs to. This parameter is case sensitive. |
display_number integer |
The number of display. Valid value from 1 to 10. The maximum display number is 4 on vCenter 6.0, 6.5 web UI. | |
enable_3D boolean |
|
Enable 3D for guest operating systems on which VMware supports 3D. |
folder string |
Destination folder, absolute or relative path to find an existing guest. This is a required parameter, only if multiple VMs are found with same name. The folder should include the datacenter. ESXi server's datacenter is ha-datacenter. Examples: folder: /ha-datacenter/vm folder: ha-datacenter/vm folder: /datacenter1/vm folder: datacenter1/vm folder: /datacenter1/vm/folder1 folder: datacenter1/vm/folder1 folder: /folder1/datacenter1/vm folder: folder1/datacenter1/vm folder: /folder1/datacenter1/vm/folder2 | |
gather_video_facts boolean |
|
If set to If set to |
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 Environment variable support added in Ansible 2.6. | |
memory_3D_mb integer |
The value of 3D Memory must be power of 2 and valid value is from 32 MB to 2048 MB. | |
moid string |
Managed Object ID of the instance to manage if known, this is a unique identifier only within a single vCenter instance. This is required if | |
name string |
Name of the virtual machine. This is a required parameter, if parameter | |
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 Environment variable support added in Ansible 2.6.
| |
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 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 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 | |
renderer_3D string |
|
If set to If set to If set to |
use_auto_detect boolean |
|
If set to If set to |
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 Environment variable support added in Ansible 2.6.
| |
uuid string |
UUID of the instance to gather facts if known, this is VMware's unique identifier. This is a required parameter, if parameter | |
validate_certs boolean |
|
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 |
video_memory_mb float |
Valid total MB of video memory range of virtual machine is from 1.172 MB to 256 MB on ESXi 6.7U1, from 1.172 MB to 128 MB on ESXi 6.7 and previous versions. For specific guest OS, supported minimum and maximum video memory are different, please be careful on setting this. |
Notes
Note
- Tested on vSphere 6.0, 6.5 and 6.7
Examples
- name: Change video card settings of virtual machine
community.vmware.vmware_guest_video:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
name: test-vm
gather_video_facts: false
use_auto_detect: false
display_number: 2
video_memory_mb: 8.0
enable_3D: true
renderer_3D: automatic
memory_3D_mb: 512
delegate_to: localhost
register: video_facts
- name: Change video card settings of virtual machine using MoID
community.vmware.vmware_guest_video:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
moid: vm-42
gather_video_facts: false
use_auto_detect: false
display_number: 2
video_memory_mb: 8.0
enable_3D: true
renderer_3D: automatic
memory_3D_mb: 512
delegate_to: localhost
register: video_facts
- name: Gather video card settings of virtual machine
community.vmware.vmware_guest_video:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
name: test-vm
gather_video_facts: false
delegate_to: localhost
register: video_facts
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
video_status dictionary |
always |
metadata about the virtual machine's video card after managing them
Sample: {'auto_detect': False, 'display_number': 2, 'enable_3D_support': True, 'memory_3D': 524288, 'renderer_3D': 'automatic', 'video_memory': 8192} |
Authors
- Diane Wang (@Tomorrow9) <[email protected]>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/vmware/vmware_guest_video_module.html