community.vmware.vmware_guest_sendkey – Send USB HID codes to the Virtual Machine’s keyboard.
community.vmware.vmware_guest_sendkey – Send USB HID codes to the Virtual Machine’s keyboard.
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_guest_sendkey.
Synopsis
- This module is used to send keystrokes to 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 |
|---|---|---|
|
cluster string |
The name of cluster where the virtual machine is running. This is a required parameter, if
| |
|
datacenter string |
The datacenter name to which virtual machine belongs to. | |
|
esxi_hostname string |
The ESXi hostname where the virtual machine is running. This is a required parameter, if
| |
|
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 | |
|
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. | |
|
keys_send list / elements=string |
The list of the keys will be sent to the virtual machine. Valid values are If both | |
|
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 | |
|
sleep_time integer added in 1.4.0 of community.vmware |
Default: 0 |
Sleep time in seconds between two keys or string sent to the virtual machine. API is faster than actual key or string send to virtual machine, this parameter allow to control delay between keys and/or strings. |
|
string_send string |
The string will be sent to the virtual machine. This string can contain valid special character, alphabet and digit on the keyboard. | |
|
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 |
Notes
Note
- Tested on vSphere 6.5 and 6.7
Examples
- name: Send list of keys to virtual machine
community.vmware.vmware_guest_sendkey:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
folder: "{{ folder_name }}"
name: "{{ vm_name }}"
keys_send:
- TAB
- TAB
- ENTER
delegate_to: localhost
register: keys_num_sent
- name: Send list of keys to virtual machine using MoID
community.vmware.vmware_guest_sendkey:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
folder: "{{ folder_name }}"
moid: vm-42
keys_send:
- CTRL_ALT_DEL
delegate_to: localhost
register: ctrl_alt_del_sent
- name: Send a string to virtual machine
community.vmware.vmware_guest_sendkey:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
folder: "{{ folder_name }}"
name: "{{ vm_name }}"
string_send: "user_logon"
delegate_to: localhost
register: keys_num_sentReturn Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
sendkey_info dictionary |
always |
display the keys and the number of keys sent to the virtual machine
Sample: {'keys_send': ['SPACE', 'DOWNARROW', 'DOWNARROW', 'ENTER'], 'keys_send_number': 4, 'returned_keys_send_number': 4, 'string_send': None, 'virtual_machine': 'test_vm'} |
Authors
- Diane Wang (@Tomorrow9) <[email protected]>
© 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_guest_sendkey_module.html
