vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_info module – Gather information about the virtual SATA adapters 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_adapter_sata_info.

New in vmware.vmware_rest 5.0.0

Synopsis

  • Return information about the virtual SATA adapters attached to a virtual machine.

  • When adapter is provided, detailed information about that single SATA adapter is returned, including its type, label, and SATA bus number.

  • When adapter is omitted, a list of all SATA adapters configured on the virtual machine is returned.

Parameters

Parameter

Comments

adapter

string

Identifier of the SATA adapter to query.

When set, detailed information about only this adapter is returned.

When omitted, all SATA adapters on the virtual machine are returned.

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

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 SATA adapters should be queried.

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: Look up the VM called test_vm1 in the inventory
  register: search_result
  vmware.vmware_rest.vcenter_vm_info:
    filter_names:
      - test_vm1

- name: List all SATA adapters of a virtual machine
  vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_info:
    vm: '{{ search_result.value[0].vm }}'
  register: sata_adapters

- name: Gather detailed information about a single SATA adapter
  vmware.vmware_rest.vcenter_vm_hardware_adapter_sata_info:
    vm: '{{ search_result.value[0].vm }}'
    adapter: '{{ sata_adapters.info[0].adapter }}'
  register: sata_adapter_detail

Return Values

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

Key

Description

info

list / elements=string

A list of detailed information about the virtual SATA adapters.

Returned: On success.

Sample: [{"bus": 0, "label": "SATA controller 0", "pci_slot_number": 32, "type": "AHCI"}]

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: {"bus": 0, "label": "SATA controller 0", "pci_slot_number": 32, "type": "AHCI"}

Authors

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