Search the docs

CLI Reference: object-volume-add

The object-volume-add command accepts the following options. The GIR-specific addition is --storage-class.

Two selectors are required:

  • One node selector: --node-name or --node-id.

  • One logical-volume selector: --logical-volume-name or --logical-volume-id.

The following options are mutually exclusive: --gc-enable and --gc-disable; --use-high-compression and --no-compression.

Option Description

--access-key

Access key for this volume. If omitted, the credentials configured on the storage system are used. Supplying --access-key without --secret-key prompts for the secret key; supplying --secret-key requires --access-key.

--availability

Volume availability capability, expressed as the number of nines (0–20).

--create-placement-objectives

Creates default place-on, confine-to, and exclude-from objectives for the new volume. Recommended when adding a GIR OSV.

--durability

Volume durability capability, expressed as the number of nines (0–20).

--gc-disable

Disables coordinated garbage collection. Shared object volumes only. Mutually exclusive with --gc-enable.

--gc-enable

Enables coordinated garbage collection. Shared object volumes only. Mutually exclusive with --gc-disable.

--help

Displays the help text and exits.

--use-high-compression

Enables high compression when storing data. Compatible with GIR OSVs. Mutually exclusive with --no-compression.

--high-threshold

Percentage (0–100) of capacity that triggers data evacuation. Defaults to 75%. Specifying this option does not change the --low-threshold default.

--logical-volume-name

Object logical volume (bucket) name. Required unless --logical-volume-id is supplied.

--logical-volume-id

Object logical volume (bucket) ID. Required unless --logical-volume-name is supplied.

--low-threshold

Target percentage (0–100) at which evacuation stops. Defaults to 60% when omitted, and specifying --high-threshold does not change that default. To use a different pair, supply both options explicitly — for example, --high-threshold 90 with --low-threshold 72.

--max-suspected-time

Time a volume stays in SUSPECTED state before becoming UNAVAILABLE. For example: 10seconds, 1minute.

--name

Display name for the OSV. A default is assigned if omitted.

--native

Stores data as non-chunked, unencrypted, and uncompressed. Compatible with GIR OSVs.

--no-compression

Disables compression. Mutually exclusive with --use-high-compression.

--no-encryption

Disables encryption.

--node-name

Name of the storage node (storage system) to add the volume on. Required unless --node-id is supplied.

--node-id

ID of the storage node. Required unless --node-name is supplied.

--online-delay

Maximum time (in nanoseconds) allowed to restore a file from this volume.

--realign-on-protection-drop-disabled

Prevents aggressive realignment when availability or durability is reduced.

--secret-key

Secret key for this volume. If omitted, the credentials configured on the storage system are used. Requires --access-key.

--shared

Marks the volume as a Shared Object Storage Volume (SOSV).

--storage-class

Storage class for cost-optimized tiers. Defaults to STANDARD if omitted. Cannot be changed after OSV creation. Valid values: STANDARD, AWS_GLACIER_INSTANT_RETRIEVAL (not case-sensitive). AWS S3 only.

--total-capacity

Total data capacity allowed on this volume. Defaults to practically unlimited if omitted.