Attaches the specified storage volume to the specified instance.


oci compute volume-attachment attach-paravirtualized-volume [OPTIONS]

Required Parameters

--instance-id [text]

The OCID of the instance. For AttachVolume operation, this is a required field for the request, see AttachVolume.

--volume-id [text]

The OCID of the volume. If CreateVolumeDetails is specified, this field must be omitted from the request.

Optional Parameters

--device [text]

The device name. To retrieve a list of devices for a given instance, see ListInstanceDevices.

--display-name [text]

A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link:

--is-pv-encryption-in-transit-enabled [boolean]

Whether to enable in-transit encryption for the data volume’s paravirtualized attachment. The default value is false.

--is-read-only [boolean]

Whether the attachment was created in read-only mode.

--is-shareable [boolean]

Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.

--max-wait-seconds [integer]

The maximum time to wait for the resource to reach the lifecycle state defined by --wait-for-state. Defaults to 1200 seconds.

--wait-for-state [text]

This operation creates, modifies or deletes a resource that has a defined lifecycle state. Specify this option to perform the action and then wait until the resource reaches a given lifecycle state. Multiple states can be specified, returning on the first state. For example, --wait-for-state SUCCEEDED --wait-for-state FAILED would return on whichever lifecycle state is reached first. If timeout is reached, a return code of 2 is returned. For any other error, a return code of 1 is returned.

Accepted values are:

--wait-interval-seconds [integer]

Check every --wait-interval-seconds to see whether the resource has reached the lifecycle state defined by --wait-for-state. Defaults to 30 seconds.

Example using required parameter

Copy the following CLI commands into a file named Run the command by typing “bash” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export cidr_block=<substitute-value-of-cidr_block> #
    export compartment_id=<substitute-value-of-compartment_id> #
    export availability_domain=<substitute-value-of-availability_domain> #
    export image_id=<substitute-value-of-image_id> #

    vcn_id=$(oci network vcn create --cidr-block $cidr_block --compartment-id $compartment_id --query --raw-output)

    subnet_id=$(oci network subnet create --cidr-block $cidr_block --compartment-id $compartment_id --vcn-id $vcn_id --query --raw-output)

    instance_id=$(oci compute instance launch --availability-domain $availability_domain --compartment-id $compartment_id --image-id $image_id --subnet-id $subnet_id --query --raw-output)

    volume_id=$(oci bv volume create --availability-domain $availability_domain --compartment-id $compartment_id --query --raw-output)

    oci compute volume-attachment attach-paravirtualized-volume --instance-id $instance_id --volume-id $volume_id