Vcenter Iso Image mount

Vcenter Iso Image mount

Mounts an ISO image from a content library on a virtual machine.

Returns an authorization error if you do not have all of the privileges described as follows:

  • Operation execution requires System.Read.
  • The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Config.AddRemoveDevice.
  • The resource com.vmware.content.library.Item referenced by the parameter libraryItem requires ContentLibrary.DownloadSession.
Request
URI
POST
https://{api_host}/api/vcenter/iso/image?action=mount
COPY
Request Body

Request body for invoking operation: mount

{
    "library_item": "string",
    "vm": "string"
}
string
library_item
Required

The identifier of the library item having the ISO image to mount on the virtual machine.

The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

string
vm
Required

The identifier of the virtual machine where the specified ISO image will be mounted.

The parameter must be an identifier for the resource type: VirtualMachine.

Authentication
This operation uses the following authentication methods.
Responses
200

The identifier of the newly created virtual CD-ROM backed by the specified ISO image.

The response will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.

Returns string of type(s) application/json
Operation doesn't return any data structure

400

Vapi Std Errors InvalidArgument If no .iso file is present on the library item.

Vapi Std Errors NotAllowedInCurrentState When the operation is not allowed on the virtual machine in its current state.

Returns Vapi Std Errors Error of type(s) application/json 
{
    "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"
}
array of object
messages
Required

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.

object
data
Optional

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.

string
error_type
Required

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.


404

If either vm or the libraryItem is not found.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0 
"Vapi Std Errors NotFound Object"

500

Error!

Returns Vapi Std Errors ResourceInaccessible of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors ResourceInaccessible0 
"Vapi Std Errors ResourceInaccessible Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"library_item:"string","vm:"string"}' https://{api_host}/api/vcenter/iso/image?action=mount
On This Page
Vcenter Iso Operations
POST
Vcenter Iso Image mount
POST
Vcenter Iso Image unmount