Vcenter Vm Hardware Cdrom create
Adds a virtual CD-ROM device to the virtual machine.
Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine.
Specification for the new virtual CD-ROM device.
{
"type": "string",
"ide": {
"primary": false,
"master": false
},
"sata": {
"bus": 0,
"unit": 0
},
"backing": {
"type": "string",
"iso_file": "string",
"host_device": "string",
"device_access_type": "string"
},
"start_connected": false,
"allow_guest_control": false
}Type of host bus adapter to which the device should be attached.
For more information see: Vcenter Vm Hardware Cdrom HostBusAdapterType.
If missing or null, guest-specific default values will be used
Address for attaching the device to a virtual IDE adapter.
If missing or null, the server will choose an available address; if none is available, the request will fail.
Address for attaching the device to a virtual SATA adapter.
If missing or null, the server will choose an available address; if none is available, the request will fail.
Physical resource backing for the virtual CD-ROM device.
If missing or null, defaults to automatic detection of a suitable host device.
Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
Defaults to false if missing or null.
Flag indicating whether the guest can connect and disconnect the device.
Defaults to false if missing or null.
Virtual CD-ROM device identifier.
The response will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.
Vapi Std Errors NotAllowedInCurrentState if the virtual machine is suspended or if the virtual machine is powered on and virtual CD-ROM type is IDE.
Vapi Std Errors ResourceInUse if the specified storage address is in use.
Vapi Std Errors InvalidArgument if the specified storage address is out of bounds.
Vapi Std Errors Unsupported if the guest operating system of the virtual machine is not supported and spec includes missing or null properties that default to guest-specific values.
{
"messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
],
"data": {},
"error_type": "string"
}Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
if the user can not be authenticated.
{
"messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
],
"data": {},
"error_type": "string",
"challenge": "string"
}Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
if the user doesn't have the required privileges.
{
"messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
],
"data": {},
"error_type": "string"
}if the virtual machine is not found.
{
"messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
],
"data": {},
"error_type": "string"
}Vapi Std Errors Error:
- if the system reported that the CD-ROM device was created but was unable to confirm the creation because the identifier of the new device could not be determined.
- if the system reports an error while responding to the request.
Vapi Std Errors UnableToAllocateResource if the specified storage address is unavailable; for example, if the SCSI adapter requested does not exist.
Vapi Std Errors ResourceBusy if the virtual machine is busy performing another operation.
Vapi Std Errors ResourceInaccessible if the virtual machine's configuration state cannot be accessed.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
if the system is unable to communicate with a service to complete the request.
{
"messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
],
"data": {},
"error_type": "string"
} curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/vcenter/vm/{vm}/hardware/cdrom