ansible.builtin.vmware_guest_video (v2.9.24) — module

Install Ansible via pip

Install with pip install ansible==2.9.24

Description

This module is used to reconfigure video card settings of given virtual machine.

All parameters and VMware object names are case sensitive.

Requirements

• python >= 2.6
• PyVmomi

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Change video card settings of virtual machine
  vmware_guest_video:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    validate_certs: no
    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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Change video card settings of virtual machine using MoID
  vmware_guest_video:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    validate_certs: no
    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

Inputs

    
moid:
    description:
    - 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 C(name) or C(uuid) is not supplied.
    type: str
    version_added: '2.9'
    version_added_collection: ansible.builtin

name:
    description:
    - Name of the virtual machine.
    - This is a required parameter, if parameter C(uuid) or C(moid) is not supplied.
    type: str

port:
    default: 443
    description:
    - The port number of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable C(VMWARE_PORT)
      will be used instead.
    - Environment variable support added in Ansible 2.6.
    type: int

uuid:
    description:
    - UUID of the instance to gather facts if known, this is VMware's unique identifier.
    - This is a required parameter, if parameter C(name) or C(moid) is not supplied.
    type: str

folder:
    description:
    - 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'
    type: str

hostname:
    description:
    - 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 C(VMWARE_HOST)
      will be used instead.
    - Environment variable support added in Ansible 2.6.
    type: str

password:
    aliases:
    - pass
    - pwd
    description:
    - The password of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD)
      will be used instead.
    - Environment variable support added in Ansible 2.6.
    type: str

username:
    aliases:
    - admin
    - user
    description:
    - The username of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable C(VMWARE_USER)
      will be used instead.
    - Environment variable support added in Ansible 2.6.
    type: str

enable_3D:
    description:
    - Enable 3D for guest operating systems on which VMware supports 3D.
    type: bool

datacenter:
    default: ha-datacenter
    description:
    - The datacenter name to which virtual machine belongs to.
    - This parameter is case sensitive.
    type: str

proxy_host:
    description:
    - 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 C(VMWARE_PROXY_HOST)
      will be used instead.
    - This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
    required: false
    type: str

proxy_port:
    description:
    - 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 C(VMWARE_PROXY_PORT)
      will be used instead.
    required: false
    type: int

renderer_3D:
    choices:
    - automatic
    - software
    - hardware
    description:
    - If set to C(automatic), selects the appropriate option (software or hardware) for
      this virtual machine automatically.
    - If set to C(software), uses normal CPU processing for 3D calculations.
    - If set to C(hardware), requires graphics hardware (GPU) for faster 3D calculations.
    type: str

memory_3D_mb:
    description:
    - The value of 3D Memory must be power of 2 and valid value is from 32 MB to 2048
      MB.
    type: int

display_number:
    description:
    - The number of display. Valid value from 1 to 10. The maximum display number is 4
      on vCenter 6.0, 6.5 web UI.
    type: int

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.
    - Environment variable support added in Ansible 2.6.
    - If set to C(true), please make sure Python >= 2.7.9 is installed on the given machine.
    type: bool

use_auto_detect:
    description:
    - If set to True, applies common video settings to the guest operating system, attributes
      C(display_number) and C(video_memory_mb) are ignored.
    - If set to False, the number of display and the total video memory will be reconfigured
      using C(display_number) and C(video_memory_mb).
    type: bool

video_memory_mb:
    description:
    - 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.
    type: float

gather_video_facts:
    default: 'no'
    description:
    - If set to True, return settings of the video card, other attributes are ignored.
    - If set to False, will do reconfiguration and return video card settings.
    type: bool

Outputs

video_status:
  description: metadata about the virtual machine's video card after managing them
  returned: always
  sample:
    auto_detect: false
    display_number: 2
    enable_3D_support: true
    memory_3D: 524288
    renderer_3D: automatic
    video_memory: 8192
  type: dict