PARALLAX

vcenter_vm_hardware_adapter_scsi

Adds a virtual SCSI adapter to the virtual machine

Collection: vmware.vmware_rest

Full Name: vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi

Synopsis

Adds a virtual SCSI adapter to the virtual machine

Parameters

NameTypeRequiredDefaultDescription
vcenter_hostnamestringyesThe 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_usernamestringyesThe 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_passwordstringyesThe 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_certsbooltrueAllows 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_filestringYou 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_timeoutfloatTimeout 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.
adapterstringVirtual SCSI adapter identifier.
The parameter must be the id of a resource returned by M(vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi). Required with I(state=[‘absent’, ‘present’])
busint0SCSI bus number.
If unset, the server will choose an available bus number; if none is available, the request will fail.
labelstringThe name of the item
pci_slot_numberintAddress of the SCSI adapter on the PCI bus. If the PCI address is invalid, the server will change it when the VM is started or as the device is hot added.
If unset, the server will choose an available address when the virtual machine is powered on.
sharingstringThe I(sharing) enumerated type defines the valid bus sharing modes for a virtual SCSI adapter.
statestringpresentOperation to perform; allowed values: absent, present.
typestringThe I(type) enumerated type defines the valid emulation types for a virtual SCSI adapter.
vmstringyesVirtual 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 SCSI adapter at PCI slot 35
  vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi:
    vm: '{{ test_vm1_info.id }}'
    pci_slot_number: 35
  register: _scsi_adapter_result_1

- name: Drop the SCSI controller
  vmware.vmware_rest.vcenter_vm_hardware_adapter_scsi:
    vm: '{{ test_vm1_info.id }}'
    pci_slot_number: 35
    state: absent
  register: _result
Search
    ↑ ↓ move↵ openesc close