vmware.vmware_rest.vcenter_vm_hardware_parallel_info module – Gather information about the virtual parallel ports of 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_info.

New in vmware.vmware_rest 5.0.0

Synopsis

  • Retrieve information about the virtual parallel ports attached to a virtual machine.

  • When port is provided, detailed information about that single parallel port is returned.

  • When port is omitted, a summary list of all parallel ports on the virtual machine is returned.

Parameters

Parameter

Comments

port

string

Identifier of a specific virtual parallel port to query.

Must be the MOID (managed object identifier) of a parallel Port resource.

When omitted, information about all parallel ports on the virtual machine is returned.

session_timeout

float

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

Default: 300.0

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 whose parallel ports should be queried.

Must be the MOID (managed object identifier) of an existing VirtualMachine 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: List all parallel ports of a virtual machine
  vmware.vmware_rest.vcenter_vm_hardware_parallel_info:
    vm: vm-1013

- name: Gather information about a specific parallel port
  vmware.vmware_rest.vcenter_vm_hardware_parallel_info:
    vm: vm-1013
    port: "16000"

Return Values

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

Key

Description

id

string

MOID of the queried parallel port.

Returned: When only one resource, with a MOID, was queried

Sample: "16000"

info

list / elements=string

A list of detailed information about the virtual parallel ports.

Returned: On success

Sample: [{"allow_guest_control": false, "backing": {"auto_detect": false, "file": "[datastore1] vm-1013/port1.txt", "type": "FILE"}, "label": "Parallel port 1", "port": "16000", "start_connected": true, "state": "NOT_CONNECTED"}]

value

any

Raw output from the API response.

This output is maintained for consistency with version 4.x and earlier of this collection. It is recommended to switch to the info return key for a more consistent and documented output.

Returned: On success

Sample: {"allow_guest_control": false, "backing": {"auto_detect": false, "file": "[datastore1] vm-1013/port1.txt", "type": "FILE"}, "label": "Parallel port 1", "start_connected": true, "state": "NOT_CONNECTED"}

Authors

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