vmware.vmware_rest.vcenter_vm_hardware_parallel module – Manage virtual parallel ports on a virtual machine.

Note

This module is part of the vmware.vmware_rest collection (version 5.0.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.

To use it in a playbook, specify: vmware.vmware_rest.vcenter_vm_hardware_parallel.

New in vmware.vmware_rest 5.0.0

Synopsis

  • Create, update, and delete virtual parallel ports attached to a VMware virtual machine.

  • A virtual parallel port can be backed by a file on a datastore or by a physical parallel port device on the ESXi host where the virtual machine is running.

  • This module also supports connecting and disconnecting an existing virtual parallel port at runtime using the connect and disconnect states.

  • Only present and absent states are idempotent.

Parameters

Parameter

Comments

allow_guest_control

boolean

Whether the guest operating system is allowed to connect and disconnect the virtual parallel port.

Defaults to false if omitted.

Choices:

  • false

  • true

backing

dictionary

Physical resource backing for the virtual parallel port.

If omitted, defaults to automatic detection of a suitable host device.

file

string

Path of the file that should be used as the virtual parallel port backing.

Only relevant when type is FILE.

host_device

string

Name of the host device that should be used as the virtual parallel port backing.

If omitted, the virtual parallel port will be configured to automatically detect a suitable host device.

Only relevant when type is HOST_DEVICE.

type

string

Backing type for the virtual parallel port.

FILE - Virtual parallel port is backed by a file on a datastore.

HOST_DEVICE - Virtual parallel port is backed by a physical parallel port device on the ESXi host where the virtual machine is running.

Choices:

  • "FILE"

  • "HOST_DEVICE"

port

string

Identifier of the virtual parallel port to manage.

Must be an identifier (MOID) for a ParallelPort resource, for example 13000.

Required when state is absent, connect, or disconnect.

When state is present, omit to create a new parallel port or provide to update an existing one. If you provide an ID and the parallel port does not exist, a new one will be created with a random ID.

session_timeout

float

Timeout in seconds for the whole operation including connection establishment, request sending, and response.

Default: 300.0

start_connected

boolean

Whether the virtual parallel port should be connected whenever the virtual machine is powered on.

Defaults to false if omitted.

Choices:

  • false

  • true

state

string

The desired state of the resource.

Use present to create or update the resource.

Use absent to delete the resource.

Use connect to connect the virtual parallel port to its backing.

Use disconnect to disconnect the virtual parallel port from its backing.

Only present and absent support idempotence.

Choices:

  • "present" ← (default)

  • "absent"

  • "connect"

  • "disconnect"

vcenter_hostname

string / required

The hostname or IP address of the vSphere vCenter.

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

vcenter_password

string / required

The vSphere vCenter password.

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

vcenter_port

integer

The port number of the vSphere vCenter.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

vcenter_rest_log_file

string

Optional path to a log file for HTTP REST interaction.

If the value is not specified in the task, the value of environment variable VMWARE_REST_LOG_FILE will be used instead.

vcenter_username

string / required

The vSphere vCenter username.

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

vcenter_validate_certs

boolean

Allows connection when SSL certificates are not valid.

Set to false when certificates are not trusted.

If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.

Choices:

  • false

  • true ← (default)

vm

string / required

Identifier of the virtual machine that owns the parallel port.

Must be an identifier (MOID) for a Vm resource.

Notes

Note

  • Generated from vSphere API spec 9.1.0.

  • Compatible with vSphere API 7.0.3.

  • Compatible with vSphere API 8.0.2.

Examples

- name: Add a virtual parallel port backed by a file
  vmware.vmware_rest.vcenter_vm_hardware_parallel:
    vm: vm-1001
    backing:
      type: FILE
      file: "[datastore1] parallel/port1.log"
    start_connected: true
    allow_guest_control: true
    state: present
  register: parallel_result

- name: Add a virtual parallel port backed by a host device
  vmware.vmware_rest.vcenter_vm_hardware_parallel:
    vm: vm-1001
    backing:
      type: HOST_DEVICE
      host_device: /dev/parport0
    state: present

- name: Update an existing virtual parallel port
  vmware.vmware_rest.vcenter_vm_hardware_parallel:
    vm: vm-1001
    port: '{{ parallel_result.id }}'
    allow_guest_control: false
    state: present

- name: Connect a virtual parallel port
  vmware.vmware_rest.vcenter_vm_hardware_parallel:
    vm: vm-1001
    port: '{{ parallel_result.id }}'
    state: connect

- name: Disconnect a virtual parallel port
  vmware.vmware_rest.vcenter_vm_hardware_parallel:
    vm: vm-1001
    port: '{{ parallel_result.id }}'
    state: disconnect

- name: Remove a virtual parallel port
  vmware.vmware_rest.vcenter_vm_hardware_parallel:
    vm: vm-1001
    port: '{{ parallel_result.id }}'
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

id

string

MOID of the managed virtual parallel port.

Returned: When state is present, or when a resource is deleted, or when state is set to a supported action.

Sample: "13000"

value

any

The raw API response body from the vCenter operation.

Returned: On success

Sample: {"allow_guest_control": true, "backing": {"file": "[datastore1] parallel/port1.log", "type": "FILE"}, "label": "Parallel port 1", "start_connected": true, "state": "CONNECTED"}

Authors

  • Ansible Eco Content Team (@eco-ansible-content)