community / community.vmware / 4.2.0 / module / vmware_guest_sendkey Send USB HID codes to the Virtual Machine's keyboard. Authors: Diane Wang (@Tomorrow9) <dianew@vmware.com>community.vmware.vmware_guest_sendkey (4.2.0) — module
Install with ansible-galaxy collection install community.vmware:==4.2.0
collections: - name: community.vmware version: 4.2.0
This module is used to send keystrokes to given virtual machine.
All parameters and VMware object names are case sensitive.
- 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_sent
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 O(name) or O(uuid) is not supplied. type: str name: description: - Name of the virtual machine. - This is a required parameter, if parameter O(uuid) or O(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 E(VMWARE_PORT) will be used instead. 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 O(name) or O(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 cluster: description: - The name of cluster where the virtual machine is running. - This is a required parameter, if O(esxi_hostname) is not set. - O(esxi_hostname) and O(cluster) are mutually exclusive. 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 E(VMWARE_HOST) will be used instead. 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 E(VMWARE_PASSWORD) will be used instead. 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 E(VMWARE_USER) will be used instead. type: str keys_send: default: [] description: - The list of the keys will be sent to the virtual machine. - Valid values are C(ENTER), C(ESC), C(BACKSPACE), C(TAB), C(SPACE), C(CAPSLOCK), C(HOME), C(DELETE), C(END), C(CTRL_ALT_DEL), C(CTRL_C), C(CTRL_X) and C(F1) to C(F12), C(RIGHTARROW), C(LEFTARROW), C(DOWNARROW), C(UPARROW), C(WINDOWS). - If both O(keys_send) and O(string_send) are specified, keys in O(keys_send) list will be sent in front of the O(string_send). elements: str type: list datacenter: description: - The datacenter name to which virtual machine belongs to. 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 E(VMWARE_PROXY_HOST) will be used instead. 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 E(VMWARE_PROXY_PORT) will be used instead. required: false type: int sleep_time: default: 0 description: - 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. type: int string_send: description: - The string will be sent to the virtual machine. - This string can contain valid special character, alphabet and digit on the keyboard. - If both O(keys_send) and O(string_send) are specified, keys in O(keys_send) list will be sent in front of the O(string_send). type: str esxi_hostname: description: - The ESXi hostname where the virtual machine is running. - This is a required parameter, if O(cluster) is not set. - O(esxi_hostname) and O(cluster) are mutually exclusive. type: str validate_certs: default: true description: - Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted. - If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS) will be used instead. type: bool
sendkey_info: description: display the keys and the number of keys sent to the virtual machine returned: always sample: keys_send: - SPACE - DOWNARROW - DOWNARROW - ENTER keys_send_number: 4 returned_keys_send_number: 4 string_send: null virtual_machine: test_vm type: dict