vmware.vmware_rest.vcenter_vm_hardware_serial module – Adds a virtual serial port to the virtual machine.
Note
This module is part of the vmware.vmware_rest collection (version 4.2.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install vmware.vmware_rest
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: vmware.vmware_rest.vcenter_vm_hardware_serial
.
New in vmware.vmware_rest 0.1.0
Synopsis
Adds a virtual serial port to the virtual machine.
Requirements
The below requirements are needed on the host that executes this module.
vSphere 7.0.3 or greater
python >= 3.6
aiohttp
Parameters
Parameter |
Comments |
---|---|
Flag indicating whether the guest can connect and disconnect the device. If unset, the value is unchanged. Choices:
|
|
Physical resource backing for the virtual serial port. If unset, defaults to automatic detection of a suitable host device. Required with state=[‘present’] Valid attributes are:
This key is required with [‘present’].
This field is optional and it is only relevant when the value of type is FILE. ([‘present’])
If unset, the virtual serial port will be configured to automatically detect a suitable host device. ([‘present’])
This field is optional and it is only relevant when the value of type is one of PIPE_SERVER or PIPE_CLIENT. ([‘present’])
If unset, defaults to false. ([‘present’])
This field is optional and it is only relevant when the value of type is one of NETWORK_SERVER or NETWORK_CLIENT. ([‘present’])
If unset, no proxy service should be used. ([‘present’]) |
|
The name of the item |
|
Virtual serial port identifier. The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_hardware_serial. Required with state=[‘absent’, ‘connect’, ‘disconnect’, ‘present’] |
|
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. |
|
Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. If unset, the value is unchanged. Choices:
|
|
Choices:
|
|
The hostname or IP address of the vSphere vCenter If the value is not specified in the task, the value of environment variable |
|
The vSphere vCenter password If the value is not specified in the task, the value of environment variable |
|
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 runs the module. If the value is not specified in the task, the value of environment variable |
|
The vSphere vCenter username If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
|
Virtual machine identifier. The parameter must be the id of a resource returned by vmware.vmware_rest.vcenter_vm_info. This parameter is mandatory. |
|
CPU yield behavior. If set to true, the virtual machine will periodically relinquish the processor if its sole task is polling the virtual serial port. The amount of time it takes to regain the processor will depend on the degree of other virtual machine activity on the host. This field may be modified at any time, and changes applied to a connected virtual serial port take effect immediately. If unset, the value is unchanged. Choices:
|
Notes
Note
Tested on vSphere 7.0.3
Examples
- 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: Create a new serial port
vmware.vmware_rest.vcenter_vm_hardware_serial:
vm: '{{ test_vm1_info.id }}'
label: Serial port 2
allow_guest_control: true
register: _result
- name: Create another serial port with a label
vmware.vmware_rest.vcenter_vm_hardware_serial:
vm: '{{ test_vm1_info.id }}'
label: Serial port 2
allow_guest_control: true
register: _result
- name: Create an existing serial port (label)
vmware.vmware_rest.vcenter_vm_hardware_serial:
vm: '{{ test_vm1_info.id }}'
label: Serial port 1
allow_guest_control: true
register: _result
- name: Get an existing serial port (label)
vmware.vmware_rest.vcenter_vm_hardware_serial_info:
vm: '{{ test_vm1_info.id }}'
label: Serial port 1
register: serial_port_1
- name: Delete an existing serial port (port id)
vmware.vmware_rest.vcenter_vm_hardware_serial:
vm: '{{ test_vm1_info.id }}'
port: '{{ serial_port_1.id }}'
state: absent
register: _result
- name: Delete an existing serial port (label)
vmware.vmware_rest.vcenter_vm_hardware_serial:
vm: '{{ test_vm1_info.id }}'
label: Serial port 2
state: absent
register: _result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
moid of the resource Returned: On success Sample: |
|
Create an existing serial port (label) Returned: On success Sample: |