Documentation Index

Fetch the complete documentation index at: https://kb.vastdata.com/llms.txt

Use this file to discover all available pages before exploring further.

dbox modify

  • Published on Aug 6, 2026
  • 1 minute(s) read
Prev Next

This command modifies the configuration or replacement state of a DBox.

Usage

dbox modify  --id ID | --uid UID
             --description DESCRIPTION
            [--name NAME]
            [--replace]
            [--conclude]
            [--force]

Required Parameters

--description DESCRIPTION

Add a description of the DBox's position for ease of management (e.g., rack ID, datacenter location).

--id ID

Specify the DBox by its ID (use either this or --uid).

--uid UID

Specify the DBox by its UID (use either this or --id).

Options

--name NAME

Rename the DBox.

--replace

Start DBox replacement.

--conclude

Conclude DBox replacement.

--force

When concluding: do not verify that all devices have been moved. When replacing: support moving devices while transitioning to a degraded state during replacement.

Example

This example shows how to update the description and name of a DBox using its ID:

vcli: admin> dbox modify --id 1 --description "Rack 2, Datacenter East" --name dbox-east-1