Volume Management Commands

yo volume attach

Attach a block or boot volume to an instance.

usage: yo volume attach [-h] [--no-exact-name] [--exact-name] [--ro] [--shared] [--no-setup] [--iscsi | --pv | --emulated | --service-determined | --as-boot]
                        volume_name instance_name

Positional Arguments

volume_name

name of volume

instance_name

name of instance

Named Arguments

--no-exact-name

follow Yo’s normal rules on standardizing instance & volume names (this is the default, but can be used to override the config file)

--exact-name, -E

use the instance & volume names exactly as given

Volume Attachment Arguments

--ro

Attach volume read-only

Default: False

--shared

Attach volume in shared mode

Default: False

--no-setup

Do not automatically run iSCSI setup commands over SSH

Default: True

--iscsi

use iSCSI to attach

Default: “pv”

--pv

use paravirtualized to attach (default)

Default: “pv”

--emulated

use emulated to attach

Default: “pv”

--service-determined

Let OCI decide the right attachment type

Default: “pv”

--as-boot

Attach to the instance as a BOOT VOLUME. The instance must not already be attached to a boot volume.

Default: “pv”

yo volume attached

List volumes by their current instance attachment.

usage: yo volume attached [-h]

yo volume create

Create a block volume.

usage: yo volume create [-h] [--ad AD] [--for INST_NAME] [--attach] [--no-exact-name] [--exact-name] [--ro] [--shared] [--no-setup]
                        [--iscsi | --pv | --emulated | --service-determined]
                        name size_gbs

Positional Arguments

name

name of block volume (unique names strongly preferred)

size_gbs

Size of block volume

Named Arguments

--ad

availability domain (not needed if you use –for)

--for, -f

which instance you intend to attach to (yo will choose theright availability domain automatically)

--attach, -a

attach to the instance after completion (requires –for)

Default: False

--no-exact-name

follow Yo’s normal rules on standardizing instance & volume names (this is the default, but can be used to override the config file)

--exact-name, -E

use the instance & volume names exactly as given

Volume Attachment Arguments

--ro

Attach volume read-only

Default: False

--shared

Attach volume in shared mode

Default: False

--no-setup

Do not automatically run iSCSI setup commands over SSH

Default: True

--iscsi

use iSCSI to attach

Default: “pv”

--pv

use paravirtualized to attach (default)

Default: “pv”

--emulated

use emulated to attach

Default: “pv”

--service-determined

Let OCI decide the right attachment type

Default: “pv”

yo volume delete

Delete a block or boot volume.

usage: yo volume delete [-h] [--no-detach] [--no-exact-name] [--exact-name] [--no-teardown] name

Positional Arguments

name

name of volume to delete

Named Arguments

--no-detach, -D

do not detach from all instances first

Default: True

--no-exact-name

follow Yo’s normal rules on standardizing instance & volume names (this is the default, but can be used to override the config file)

--exact-name, -E

use the instance & volume names exactly as given

--no-teardown

do not run iSCSI tear down commands

Default: True

yo volume detach

Detach a block or boot volume from an instance.

usage: yo volume detach [-h] [--from FROM_INSTANCE] [--all] [--no-exact-name] [--exact-name] [--no-teardown] volume

Positional Arguments

volume

name of volume to detach

Named Arguments

--from

instance to detach from, if there are multiple

--all

instance to detach from, if there are multiple

Default: False

--no-exact-name

follow Yo’s normal rules on standardizing instance & volume names (this is the default, but can be used to override the config file)

--exact-name, -E

use the instance & volume names exactly as given

--no-teardown

do not run iSCSI tear down commands

Default: True

yo volume list

List block & boot volumes.

usage: yo volume list [-h]

yo volume rename

Rename a block or boot volume.

usage: yo volume rename [-h] [--exact-name] volume_name new_name

Positional Arguments

volume_name

name of volume

new_name

new name for volume

Named Arguments

--exact-name, -n

do not try to standardize the volume names

Default: False