Documentation Index
Fetch the complete documentation index at: https://docs.nebius.com/llms.txt
Use this file to discover all available pages before exploring further.
Name
nebius compute instance update
Updates an existing VM instance with new configuration parameters.
Synopsis
Options
--boot-disk-attach-mode (string)
A value must be one of:
unspecifiedread_onlyread_write
--boot-disk-device-id (string)
Specifies the user-defined identifier, allowing to use ‘/dev/disk/by-id/virtio-’ as a device path in mount command.
--boot-disk-existing-disk-id (string)
Mutually exclusive with: --boot-disk-managed-disk-forbid-deletion, --boot-disk-managed-disk-labels, --boot-disk-managed-disk-name, --boot-disk-managed-disk-size-bytes, --boot-disk-managed-disk-size-gibibytes, --boot-disk-managed-disk-size-kibibytes, --boot-disk-managed-disk-size-mebibytes.
--boot-disk-managed-disk-forbid-deletion (bool)
Prevents deletion whilst set.
Mutually exclusive with: --boot-disk-existing-disk-id.
--boot-disk-managed-disk-labels (string->string)
Labels associated with disk resource.
Mutually exclusive with: --boot-disk-existing-disk-id.
--boot-disk-managed-disk-name (string)
Name of a dependent disk.
Use it to convert an ExistingDisk to a dependent disk.
Changing the name will replace the disk and cause data loss.
Mutually exclusive with: --boot-disk-existing-disk-id.
--boot-disk-managed-disk-size-bytes (int64)
Mutually exclusive with: --boot-disk-existing-disk-id, --boot-disk-managed-disk-size-gibibytes, --boot-disk-managed-disk-size-kibibytes, --boot-disk-managed-disk-size-mebibytes.
--boot-disk-managed-disk-size-gibibytes (int64)
Mutually exclusive with: --boot-disk-existing-disk-id, --boot-disk-managed-disk-size-bytes, --boot-disk-managed-disk-size-kibibytes, --boot-disk-managed-disk-size-mebibytes.
--boot-disk-managed-disk-size-kibibytes (int64)
Mutually exclusive with: --boot-disk-existing-disk-id, --boot-disk-managed-disk-size-bytes, --boot-disk-managed-disk-size-gibibytes, --boot-disk-managed-disk-size-mebibytes.
--boot-disk-managed-disk-size-mebibytes (int64)
Mutually exclusive with: --boot-disk-existing-disk-id, --boot-disk-managed-disk-size-bytes, --boot-disk-managed-disk-size-gibibytes, --boot-disk-managed-disk-size-kibibytes.
--cloud-init-user-data (string)
Data in cloud-init format for customizing instance initialization.
For details, see https://docs.nebius.com/compute/virtual-machines/manage#user-data.
--filesystems (json)
List of Shared Filesystems attached to the instance.
(structure)
attach_mode -> (string)[required]
A value must be one of:
“unspecified""read_only""read_write”
existing_filesystem -> (structure)
id -> (string)[required]
mount_tag -> (string)[required]
Specifies the user-defined identifier, allowing to use it as a device in mount command.
JSON Schema:
--hostname (string)
Instance’s hostname. Used to generate default DNS record in format <hostname>.<network_id>.compute.internal.
or <instance_id>.<network_id>.compute.internal. if hostname is not specified.
--id (string)
Identifier for the resource, unique for its resource type.
--labels (string->string)
Labels associated with the resource.
--labels-add (string->string)
Add values to Labels associated with the resource.
--labels-remove (string array)
Remove values from Labels associated with the resource.
--local-disks-passthrough-group-requested (bool)
Passthrough local disks from the underlying host.
Devices are expected to appear in the guest as NVMe devices (nvme0, nvme1, …),
but the exact number depends on the preset.
Enabled only when this field is explicitly set.
--name (string)
Human readable name for the resource.
--network-interfaces (json)
List of network interfaces attached to the instance.
(structure)
aliases -> (structure)
Assign ranges of IP addresses as aliases.
allocation_id -> (string)[required]
ID of allocation.
public_ip_address -> (structure)[meaningful_empty_value]
Public IPv4 address associated with the interface.
allocation_id -> (string)
Allocation identifier if it was created before.
static -> (bool)
If false - Allocation will be created/deleted during NetworkInterface.Allocate/NetworkInterface.Deallocate
If true - Allocation will be created/deleted during NetworkInterface.Create/NetworkInterface.Delete
False by default.
security_groups -> (structure)
Security groups associated with the network interface.
If an empty list is provided, the default security group for the network will be used.
Effective security groups can be seen in the status.
id -> (string)
Security group identifier.
JSON Schema:
--nvl-instance-group-id (string)
NVLink Instance Group ID associated with the VM.
--parent-id (string)
Identifier of the parent resource to which the resource belongs.
--reservation-policy-policy (string)
A value must be one of:
autoforbidstrict
--reservation-policy-reservation-ids (string array)
Capacity block groups, order matters.
--resource-version (int64)
Version of the resource for safe concurrent modifications and consistent reads.
Positive and monotonically increases on each resource spec change (but not on each change of the
resource’s container(s) or status).
Service allows zero value or current.
--resources-preset (string)
--secondary-disks (json)
List of additional data disks attached to the instance beyond the boot disk.
(structure)
attach_mode -> (string)[required]
A value must be one of:
“unspecified""read_only""read_write”
device_id -> (string)
Specifies the user-defined identifier, allowing to use ‘/dev/disk/by-id/virtio-’ as a device path in mount command.
existing_disk -> (structure)
Attach an existing disk.
Lifecycle:
- The disk is preserved when the instance is deleted (it will be detached).
- To delete the disk together with the instance, switch to ManagedDisk in the instance spec.
- For the switch,
ManagedDisk.nameMUST match the current diskname
(see DiskService.Get for the disk referenced byExistingDisk.id). - When converting an ExistingDisk to a ManagedDisk, you must provide
ManagedDisk.nameandManagedDisk.spec
exactly as they are currently defined in the disk resource.
Obtain the current values viaDiskService.Getand copy them verbatim.
IfManagedDisk.specdiffers from the current disk spec, the instance update will fail.
Mutually exclusive with: managed_disk.
id -> (string)[required]
managed_disk -> (structure)
Attach a managed disk.
Lifecycle:
- The disk is deleted when the instance is deleted.
- Specifying a ManagedDisk expresses an intent to have that managed disk attached.
- If this intent cannot be satisfied, the entire operation fails.
- You can check the intent status in
instance.status.disk_attachments.
- Managed disks can be updated only via instance spec updates. Updates via DiskService are not allowed.
- During updates, disks are matched by
name.
- Changing the disk
nametriggers disk replacement (create a new disk and delete the old one),
which causes data loss. - To rename a managed disk safely:
- switch it to ExistingDisk in the instance spec, and
- update/rename it via DiskService.
- switch it to ExistingDisk in the instance spec, and
- Instance create/update fails if there is already a disk with the same
name.
as requested by any ManagedDisk.
- The disk ID is available in
instance.status.disk_attachmentsafter it is created.
UseDiskAttachmentStatus.nameto find the desired disk which matchesname.
- To preserve the disk after instance deletion, switch it to ExistingDisk in the instance spec,
use the disk ID frominstance.status.disk_attachments.
- Switching ExistingDisk to ManagedDisk fails if
Disk.spec.deletion_protectionis enabled. - Deleting an instance that has a ManagedDisk fails if
Disk.spec.deletion_protectionis enabled.
Mutually exclusive with: existing_disk.
labels -> (map)[map]
Labels associated with disk resource.
key -> (string)
value -> (string)
name -> (string)[required]
Name of a dependent disk.
Use it to convert an ExistingDisk to a dependent disk.
Changing the name will replace the disk and cause data loss.
spec -> (structure)[required]
Specification of a dependent disk to be created.
forbid_deletion -> (bool)
Prevents deletion whilst set.
size_bytes -> (int64)
Mutually exclusive with: size_gibibytes, size_kibibytes, size_mebibytes.
size_gibibytes -> (int64)
Mutually exclusive with: size_bytes, size_kibibytes, size_mebibytes.
size_kibibytes -> (int64)
Mutually exclusive with: size_bytes, size_gibibytes, size_mebibytes.
size_mebibytes -> (int64)
Mutually exclusive with: size_bytes, size_gibibytes, size_kibibytes.
JSON Schema:
--stopped (bool)
Indicates whether the instance should be stopped.
--async (bool)
If set, returns operation id. Otherwise, waits for the operation to complete and returns its resource.
--clear-mask (string array)
Reset-mask field paths to clear in patch mode. Can be repeated.
--diff (bool)
Show diff of resource before commiting update.
--full (bool)
Update full resource state. Automatically set to true if the —file or argument provided.
--patch (bool)
Update only specified fields.
Global Options
-h, --help (bool)
Show this message.
-p, --profile (string)
Set a profile for interacting with the cloud.
--format (string)
Output format. Supported values: yaml|json|jsonpath|table|text.
-f, --file (string)
Input file. For ‘update’ commands automatically set —full=true.
-c, --config (string)
Provide path to config file.
--debug (bool)
Enable debug logs.
--color (bool)
Enable colored output.
--no-browser (bool)
Do not open browser automatically on auth.
--insecure (bool)
Disable transport security.
--auth-timeout (duration: 2h30m10s)
Set the timeout for the request including authentication process, default is 15m0s.
--per-retry-timeout (duration: 2h30m10s)
Set the timeout for each retry attempt, default is 20s.
--retries (uint)
Set the number of retry attempts, 1 is disable retries, default is 3.
--timeout (duration: 2h30m10s)
Set the timeout for the main request, default is 1m0s.
--no-check-update (bool)
Suppress check for updates.
--no-progress (bool)
Suppress progress indicators and spinners.