vcenter_vm_hardware_adapter_sata

Adds a virtual SATA adapter to the virtual machine

Collection: vmware.vmware_rest

Full Name: vmware.vmware_rest.vcenter_vm_hardware_adapter_sata

Synopsis

Adds a virtual SATA adapter to the virtual machine

Parameters

Name	Type	Required	Default	Description
vcenter_hostname	string	yes		The hostname or IP address of the vSphere vCenter
If the value is not specified in the task, the value of environment variable C(VMWARE_HOST) will be used instead.
vcenter_username	string	yes		The vSphere vCenter username
If the value is not specified in the task, the value of environment variable C(VMWARE_USER) will be used instead.
vcenter_password	string	yes		The vSphere vCenter password
If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD) will be used instead.
vcenter_validate_certs	bool		`true`	Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted.
If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS) will be used instead.
vcenter_rest_log_file	string			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 C(VMWARE_REST_LOG_FILE) will be used instead.
session_timeout	float			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.
adapter	string			Virtual SATA adapter identifier.
The parameter must be the id of a resource returned by M(vmware.vmware_rest.vcenter_vm_hardware_adapter_sata). Required with I(state=[‘absent’])
bus	int		`0`	SATA bus number.
If unset, the server will choose an available bus number; if none is available, the request will fail.
label	string			The name of the item
pci_slot_number	int			Address of the SATA adapter on the PCI bus.
If unset, the server will choose an available address when the virtual machine is powered on.
state	string		`present`	Operation to perform; allowed values: absent, present.
type	string			The I(type) enumerated type defines the valid emulation types for a virtual SATA adapter.
vm	string	yes		Virtual machine identifier.
The parameter must be the id of a resource returned by M(vmware.vmware_rest.vcenter_vm_info). This parameter is mandatory.

Example

yaml

- 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 SATA adapter at PCI slot 34
  vmware.vmware_rest.vcenter_vm_hardware_adapter_sata:
    vm: '{{ test_vm1_info.id }}'
    pci_slot_number: 34
  register: _sata_adapter_result_1

- name: Remove SATA adapter at PCI slot 34
  vmware.vmware_rest.vcenter_vm_hardware_adapter_sata:
    vm: '{{ test_vm1_info.id }}'
    pci_slot_number: 34
    state: absent