vcenter_vm_hardware_boot_device
Sets the virtual devices that will be used to boot the virtual machine
Collection: vmware.vmware_rest
Full Name: vmware.vmware_rest.vcenter_vm_hardware_boot_device
Synopsis
Sets the virtual devices that will be used to boot 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. | ||||
| devices | list | yes | Ordered list of boot devices. This parameter is mandatory. | |
| Valid attributes are: |
- C(type) (str): This option defines the valid device types that may be used as bootable devices. ([‘set’])
This key is required with [‘set’].
- Accepted values:
- CDROM
- DISK
- ETHERNET
- FLOPPY
- Accepted values:
- C(nic) (str): Virtual Ethernet device. Ethernet device to use as boot device for this entry. This field is optional and it is only relevant when the value of I(type) is ETHERNET. When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by M(vmware.vmware_rest.vcenter_vm_hardware_ethernet). ([‘set’])
- C(disks) (list): Virtual disk device. List of virtual disks in boot order.
This field is optional and it is only relevant when the value of I(type) is DISK.
When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by M(vmware.vmware_rest.vcenter_vm_hardware_disk). ([‘set’]) |
| state | string | |
set| Operation to perform; allowed values: set. | | 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: Set a boot device
vmware.vmware_rest.vcenter_vm_hardware_boot_device:
vm: '{{ test_vm1_info.id }}'
devices:
- type: CDROM
register: _result