nebius billing v1alpha1 calculator estimate-batch
Estimates prices for multiple resources.
Returns aggregated hourly and monthly cost estimates for all specified resources.
``` nebius billing v1alpha1 calculator estimate-batch --offer-types --resource-specs [required] ```
`--offer-types` (enum array)
Type of offers to be applied to the cost estimate.
`--resource-specs` (json) \[required]
List of resource specifications for cost estimation.
Each resource will be priced individually and then aggregated into total costs.
(structure)
compute\_disk\_spec -> (structure)
Mutually exclusive with: compute\_disk\_update\_spec, compute\_filesystem\_spec, compute\_filesystem\_update\_spec, compute\_instance\_spec, compute\_instance\_update\_spec.
metadata -> (structure)
id -> (string)\[identifier]
Identifier for the resource, unique for its resource type.
labels -> (map)\[map]
Labels associated with the resource.
key -> (string)
value -> (string)
name -> (string)
Human readable name for the resource.
parent\_id -> (string)\[required]
Identifier of the parent resource to which the resource belongs.
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.
spec -> (structure)
block\_size\_bytes -> (int64)\[immutable]
Block size in bytes.
The block size must be a power of two between 4096 bytes (4 KiB) and 131072 bytes (128 KiB).
The default value is 4096 bytes (4 KiB).
disk\_encryption -> (structure)\[immutable]
Defines how data on the disk is encrypted. By default, no encryption is applied.
type -> (string)
A value must be one of:
"disk\_encryption\_unspecified"
"disk\_encryption\_managed"
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.
source\_image\_family -> (structure)\[immutable]
Mutually exclusive with: source\_image\_id.
image\_family -> (string)\[required]
parent\_id -> (string)
source\_image\_id -> (string)\[immutable]
Mutually exclusive with: source\_image\_family.
type -> (string)\[required] \[immutable]
The type of disk defines the performance and reliability characteristics of the block device.
For details, see [https://docs.nebius.com/compute/storage/types#disks-types](https://docs.nebius.com/compute/storage/types#disks-types).
A value must be one of:
"unspecified"
"network\_ssd"
"network\_hdd"
"network\_ssd\_non\_replicated"
"network\_ssd\_io\_m3"
compute\_disk\_update\_spec -> (structure)
Mutually exclusive with: compute\_disk\_spec, compute\_filesystem\_spec, compute\_filesystem\_update\_spec, compute\_instance\_spec, compute\_instance\_update\_spec.
metadata -> (structure)
id -> (string)\[identifier]
Identifier for the resource, unique for its resource type.
labels -> (map)\[map]
Labels associated with the resource.
key -> (string)
value -> (string)
name -> (string)
Human readable name for the resource.
parent\_id -> (string)\[required]
Identifier of the parent resource to which the resource belongs.
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.
spec -> (structure)
block\_size\_bytes -> (int64)\[immutable]
Block size in bytes.
The block size must be a power of two between 4096 bytes (4 KiB) and 131072 bytes (128 KiB).
The default value is 4096 bytes (4 KiB).
disk\_encryption -> (structure)\[immutable]
Defines how data on the disk is encrypted. By default, no encryption is applied.
type -> (string)
A value must be one of:
"disk\_encryption\_unspecified"
"disk\_encryption\_managed"
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.
source\_image\_family -> (structure)\[immutable]
Mutually exclusive with: source\_image\_id.
image\_family -> (string)\[required]
parent\_id -> (string)
source\_image\_id -> (string)\[immutable]
Mutually exclusive with: source\_image\_family.
type -> (string)\[required] \[immutable]
The type of disk defines the performance and reliability characteristics of the block device.
For details, see [https://docs.nebius.com/compute/storage/types#disks-types](https://docs.nebius.com/compute/storage/types#disks-types).
A value must be one of:
"unspecified"
"network\_ssd"
"network\_hdd"
"network\_ssd\_non\_replicated"
"network\_ssd\_io\_m3"
compute\_filesystem\_spec -> (structure)
Mutually exclusive with: compute\_disk\_spec, compute\_disk\_update\_spec, compute\_filesystem\_update\_spec, compute\_instance\_spec, compute\_instance\_update\_spec.
metadata -> (structure)
id -> (string)\[identifier]
Identifier for the resource, unique for its resource type.
labels -> (map)\[map]
Labels associated with the resource.
key -> (string)
value -> (string)
name -> (string)
Human readable name for the resource.
parent\_id -> (string)\[required]
Identifier of the parent resource to which the resource belongs.
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.
spec -> (structure)
block\_size\_bytes -> (int64)\[immutable]
Block size in bytes.
The block size must be a power of two between 4096 bytes (4 KiB) and 131072 bytes (128 KiB).
The default value is 4096 bytes (4 KiB).
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.
type -> (string)\[required] \[immutable]
The Shared Filesystem type determines its limits and performance characteristics.
For details, see [https://docs.nebius.com/compute/storage/types#filesystems-types](https://docs.nebius.com/compute/storage/types#filesystems-types).
A value must be one of:
"unspecified"
"network\_ssd"
"network\_hdd"
"weka"
"vast"
compute\_filesystem\_update\_spec -> (structure)
Mutually exclusive with: compute\_disk\_spec, compute\_disk\_update\_spec, compute\_filesystem\_spec, compute\_instance\_spec, compute\_instance\_update\_spec.
metadata -> (structure)
id -> (string)\[identifier]
Identifier for the resource, unique for its resource type.
labels -> (map)\[map]
Labels associated with the resource.
key -> (string)
value -> (string)
name -> (string)
Human readable name for the resource.
parent\_id -> (string)\[required]
Identifier of the parent resource to which the resource belongs.
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.
spec -> (structure)
block\_size\_bytes -> (int64)\[immutable]
Block size in bytes.
The block size must be a power of two between 4096 bytes (4 KiB) and 131072 bytes (128 KiB).
The default value is 4096 bytes (4 KiB).
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.
type -> (string)\[required] \[immutable]
The Shared Filesystem type determines its limits and performance characteristics.
For details, see [https://docs.nebius.com/compute/storage/types#filesystems-types](https://docs.nebius.com/compute/storage/types#filesystems-types).
A value must be one of:
"unspecified"
"network\_ssd"
"network\_hdd"
"weka"
"vast"
compute\_instance\_spec -> (structure)
Mutually exclusive with: compute\_disk\_spec, compute\_disk\_update\_spec, compute\_filesystem\_spec, compute\_filesystem\_update\_spec, compute\_instance\_update\_spec.
metadata -> (structure)
id -> (string)\[identifier]
Identifier for the resource, unique for its resource type.
labels -> (map)\[map]
Labels associated with the resource.
key -> (string)
value -> (string)
name -> (string)
Human readable name for the resource.
parent\_id -> (string)\[required]
Identifier of the parent resource to which the resource belongs.
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.
spec -> (structure)
boot\_disk -> (structure)
Specified boot disk attached to the instance.
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-{device_id}' 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).
Switching to a managed disk:
* To delete the disk together with the instance, switch to ManagedDisk in the instance spec.
* For the switch, `ManagedDisk.name` MUST match the current disk `name`
(see DiskService.Get for the disk referenced by `ExistingDisk.id`).
* When converting an ExistingDisk to a ManagedDisk, you must provide `ManagedDisk.name` and `ManagedDisk.spec`
exactly as they are currently defined in the disk resource.
Obtain the current values via `DiskService.Get` and copy them verbatim.
If `ManagedDisk.spec` differs 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.
Semantics:
* 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`.
Updates and matching:
* Managed disks can be updated only via instance spec updates. Updates via DiskService are not allowed.
* During updates, disks are matched by `name`.
Renaming and data loss:
* Changing the disk `name` triggers disk replacement (create a new disk and delete the old one),
which causes data loss.
* To rename a managed disk safely:
1. switch it to ExistingDisk in the instance spec, and
2. update/rename it via DiskService.
Conflicts:
* Instance create/update fails if there is already a disk with the same `name`.
as requested by any ManagedDisk.
Finding the disk ID:
* The disk ID is available in `instance.status.disk_attachments` after it is created.
Use `DiskAttachmentStatus.name` to find the desired disk which matches `name`.
Switching to an existing (non-managed) disk:
* To preserve the disk after instance deletion, switch it to ExistingDisk in the instance spec,
use the disk ID from `instance.status.disk_attachments`.
Deletion protection:
* Switching ExistingDisk to ManagedDisk fails if `Disk.spec.deletion_protection` is enabled.
* Deleting an instance that has a ManagedDisk fails if `Disk.spec.deletion_protection` is 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.
block\_size\_bytes -> (int64)\[immutable]
Block size in bytes.
The block size must be a power of two between 4096 bytes (4 KiB) and 131072 bytes (128 KiB).
The default value is 4096 bytes (4 KiB).
disk\_encryption -> (structure)\[immutable]
Defines how data on the disk is encrypted. By default, no encryption is applied.
type -> (string)
A value must be one of:
"disk\_encryption\_unspecified"
"disk\_encryption\_managed"
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.
source\_image\_family -> (structure)\[immutable]
Mutually exclusive with: source\_image\_id.
image\_family -> (string)\[required]
parent\_id -> (string)
source\_image\_id -> (string)\[immutable]
Mutually exclusive with: source\_image\_family.
type -> (string)\[required] \[immutable]
The type of disk defines the performance and reliability characteristics of the block device.
For details, see [https://docs.nebius.com/compute/storage/types#disks-types](https://docs.nebius.com/compute/storage/types#disks-types).
A value must be one of:
"unspecified"
"network\_ssd"
"network\_hdd"
"network\_ssd\_non\_replicated"
"network\_ssd\_io\_m3"
cloud\_init\_user\_data -> (string)\[sensitive]
Data in cloud-init format for customizing instance initialization.
For details, see [https://docs.nebius.com/compute/virtual-machines/manage#user-data](https://docs.nebius.com/compute/virtual-machines/manage#user-data).
filesystems -> (structure)
List of Shared Filesystems attached to the instance.
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.
gpu\_cluster -> (structure)\[immutable]
If you want to interconnect several instances in a GPU cluster via NVIDIA InfiniBand,
set the ID of an existing GPU cluster.
You can only add the VM to the cluster when creating the VM.
For details, see [https://docs.nebius.com/compute/clusters/gpu](https://docs.nebius.com/compute/clusters/gpu).
id -> (string)
If you want to interconnect several instances in a GPU cluster via NVIDIA InfiniBand,
set the ID of an existing GPU cluster.
You can only add the VM to the cluster when creating the VM.
For details, see [https://docs.nebius.com/compute/clusters/gpu](https://docs.nebius.com/compute/clusters/gpu).
hostname -> (string)
Instance's hostname. Used to generate default DNS record in format `
or `
local\_disks -> (structure)
Local disks are meaningfully different from regular (remote) disks:
they are provided by the underlying host and are tied to a particular VM run.
Local disk data is not preserved across Stop-Start initiated via Compute API.
Local disks are not provided by default. To get them, explicitly request them via this field.
Availability depends on the selected platform, preset and region.
Changing this field will result in disks change and content loss, but only after stop and start the instance.
passthrough\_group -> (structure)
Requests passthrough local disks from the host.
Topology of the provided disks is preserved during stop and start
for every instance of a specific platform and preset in the region.
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.
network\_interfaces -> (structure)\[required]
List of network interfaces attached to the instance.
aliases -> (structure)
Assign ranges of IP addresses as aliases.
allocation\_id -> (string)\[required]
ID of allocation.
ip\_address -> (structure)\[required] \[immutable] \[meaningful\_empty\_value]
Private IPv4 address associated with the interface.
allocation\_id -> (string)
Allocation identifier if it was created before.
name -> (string)\[required] \[immutable]
Interface name
Value of this field configures the name of the network interface inside VM's OS.
Longer values will persist in the specification but will be truncated to 15 symbols before being passed to VM configuration.
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.
subnet\_id -> (string)\[required] \[immutable]
Subnet ID.
preemptible -> (structure)\[immutable]
Include these parameters to create a Preemptible VM and omit them to create a Regular VM
For details, see [https://docs.nebius.com/compute/virtual-machines/preemptible](https://docs.nebius.com/compute/virtual-machines/preemptible).
on\_preemption -> (string)\[required] \[immutable]
Specifies what happens when the VM is preempted. The only supported value is STOP:
Compute stops the VM without deleting or restarting it.
A value must be one of:
"unspecified"
"stop"
priority -> (int32)\[required] \[immutable]
The value can range from 1 to 5, where 5 indicates the highest priority.
Affects the order in which Compute tries to preempt VMs, but does not guarantee the exact order.
recovery\_policy -> (string)\[immutable]
Recovery policy defines how the instance will be treated in case of a failure.
Common source of failure is a host failure, but it can be any other failure.
Instance undergoing a guest shutdown (poweroff, etc.) will be subject to recovery policy, meaning that it could
be restarted and billed accordingly. Stop instance via API or UI to stop it to avoid recovering.
* If set to RECOVER, instance will be restarted, if possible. It could be restarted on the same host or on another host.
* If set to FAIL, instance will be stopped and not restarted.
A value must be one of:
"recover"
"fail"
reservation\_policy -> (structure)
policy -> (string)
A value must be one of:
"auto"
"forbid"
"strict"
reservation\_ids -> (string)
Capacity block groups, order matters.
resources -> (structure)\[required]
Specification of compute resources allocated to the instance.
For details, see [https://docs.nebius.com/compute/virtual-machines/types](https://docs.nebius.com/compute/virtual-machines/types).
platform -> (string)\[required] \[immutable]
preset -> (string)
secondary\_disks -> (structure)
List of additional data disks attached to the instance beyond the boot disk.
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-{device_id}' 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).
Switching to a managed disk:
* To delete the disk together with the instance, switch to ManagedDisk in the instance spec.
* For the switch, `ManagedDisk.name` MUST match the current disk `name`
(see DiskService.Get for the disk referenced by `ExistingDisk.id`).
* When converting an ExistingDisk to a ManagedDisk, you must provide `ManagedDisk.name` and `ManagedDisk.spec`
exactly as they are currently defined in the disk resource.
Obtain the current values via `DiskService.Get` and copy them verbatim.
If `ManagedDisk.spec` differs 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.
Semantics:
* 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`.
Updates and matching:
* Managed disks can be updated only via instance spec updates. Updates via DiskService are not allowed.
* During updates, disks are matched by `name`.
Renaming and data loss:
* Changing the disk `name` triggers disk replacement (create a new disk and delete the old one),
which causes data loss.
* To rename a managed disk safely:
1. switch it to ExistingDisk in the instance spec, and
2. update/rename it via DiskService.
Conflicts:
* Instance create/update fails if there is already a disk with the same `name`.
as requested by any ManagedDisk.
Finding the disk ID:
* The disk ID is available in `instance.status.disk_attachments` after it is created.
Use `DiskAttachmentStatus.name` to find the desired disk which matches `name`.
Switching to an existing (non-managed) disk:
* To preserve the disk after instance deletion, switch it to ExistingDisk in the instance spec,
use the disk ID from `instance.status.disk_attachments`.
Deletion protection:
* Switching ExistingDisk to ManagedDisk fails if `Disk.spec.deletion_protection` is enabled.
* Deleting an instance that has a ManagedDisk fails if `Disk.spec.deletion_protection` is 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.
block\_size\_bytes -> (int64)\[immutable]
Block size in bytes.
The block size must be a power of two between 4096 bytes (4 KiB) and 131072 bytes (128 KiB).
The default value is 4096 bytes (4 KiB).
disk\_encryption -> (structure)\[immutable]
Defines how data on the disk is encrypted. By default, no encryption is applied.
type -> (string)
A value must be one of:
"disk\_encryption\_unspecified"
"disk\_encryption\_managed"
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.
source\_image\_family -> (structure)\[immutable]
Mutually exclusive with: source\_image\_id.
image\_family -> (string)\[required]
parent\_id -> (string)
source\_image\_id -> (string)\[immutable]
Mutually exclusive with: source\_image\_family.
type -> (string)\[required] \[immutable]
The type of disk defines the performance and reliability characteristics of the block device.
For details, see [https://docs.nebius.com/compute/storage/types#disks-types](https://docs.nebius.com/compute/storage/types#disks-types).
A value must be one of:
"unspecified"
"network\_ssd"
"network\_hdd"
"network\_ssd\_non\_replicated"
"network\_ssd\_io\_m3"
service\_account\_id -> (string)\[immutable]
Unique identifier of the service account associated with this instance.
For details, see [https://docs.nebius.dev/en/iam/about-iam/concepts/service-accounts](https://docs.nebius.dev/en/iam/about-iam/concepts/service-accounts).
stopped -> (bool)
Indicates whether the instance should be stopped.
compute\_instance\_update\_spec -> (structure)
Mutually exclusive with: compute\_disk\_spec, compute\_disk\_update\_spec, compute\_filesystem\_spec, compute\_filesystem\_update\_spec, compute\_instance\_spec.
metadata -> (structure)
id -> (string)\[identifier]
Identifier for the resource, unique for its resource type.
labels -> (map)\[map]
Labels associated with the resource.
key -> (string)
value -> (string)
name -> (string)
Human readable name for the resource.
parent\_id -> (string)\[required]
Identifier of the parent resource to which the resource belongs.
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.
spec -> (structure)
boot\_disk -> (structure)
Specified boot disk attached to the instance.
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-{device_id}' 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).
Switching to a managed disk:
* To delete the disk together with the instance, switch to ManagedDisk in the instance spec.
* For the switch, `ManagedDisk.name` MUST match the current disk `name`
(see DiskService.Get for the disk referenced by `ExistingDisk.id`).
* When converting an ExistingDisk to a ManagedDisk, you must provide `ManagedDisk.name` and `ManagedDisk.spec`
exactly as they are currently defined in the disk resource.
Obtain the current values via `DiskService.Get` and copy them verbatim.
If `ManagedDisk.spec` differs 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.
Semantics:
* 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`.
Updates and matching:
* Managed disks can be updated only via instance spec updates. Updates via DiskService are not allowed.
* During updates, disks are matched by `name`.
Renaming and data loss:
* Changing the disk `name` triggers disk replacement (create a new disk and delete the old one),
which causes data loss.
* To rename a managed disk safely:
1. switch it to ExistingDisk in the instance spec, and
2. update/rename it via DiskService.
Conflicts:
* Instance create/update fails if there is already a disk with the same `name`.
as requested by any ManagedDisk.
Finding the disk ID:
* The disk ID is available in `instance.status.disk_attachments` after it is created.
Use `DiskAttachmentStatus.name` to find the desired disk which matches `name`.
Switching to an existing (non-managed) disk:
* To preserve the disk after instance deletion, switch it to ExistingDisk in the instance spec,
use the disk ID from `instance.status.disk_attachments`.
Deletion protection:
* Switching ExistingDisk to ManagedDisk fails if `Disk.spec.deletion_protection` is enabled.
* Deleting an instance that has a ManagedDisk fails if `Disk.spec.deletion_protection` is 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.
block\_size\_bytes -> (int64)\[immutable]
Block size in bytes.
The block size must be a power of two between 4096 bytes (4 KiB) and 131072 bytes (128 KiB).
The default value is 4096 bytes (4 KiB).
disk\_encryption -> (structure)\[immutable]
Defines how data on the disk is encrypted. By default, no encryption is applied.
type -> (string)
A value must be one of:
"disk\_encryption\_unspecified"
"disk\_encryption\_managed"
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.
source\_image\_family -> (structure)\[immutable]
Mutually exclusive with: source\_image\_id.
image\_family -> (string)\[required]
parent\_id -> (string)
source\_image\_id -> (string)\[immutable]
Mutually exclusive with: source\_image\_family.
type -> (string)\[required] \[immutable]
The type of disk defines the performance and reliability characteristics of the block device.
For details, see [https://docs.nebius.com/compute/storage/types#disks-types](https://docs.nebius.com/compute/storage/types#disks-types).
A value must be one of:
"unspecified"
"network\_ssd"
"network\_hdd"
"network\_ssd\_non\_replicated"
"network\_ssd\_io\_m3"
cloud\_init\_user\_data -> (string)\[sensitive]
Data in cloud-init format for customizing instance initialization.
For details, see [https://docs.nebius.com/compute/virtual-machines/manage#user-data](https://docs.nebius.com/compute/virtual-machines/manage#user-data).
filesystems -> (structure)
List of Shared Filesystems attached to the instance.
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.
gpu\_cluster -> (structure)\[immutable]
If you want to interconnect several instances in a GPU cluster via NVIDIA InfiniBand,
set the ID of an existing GPU cluster.
You can only add the VM to the cluster when creating the VM.
For details, see [https://docs.nebius.com/compute/clusters/gpu](https://docs.nebius.com/compute/clusters/gpu).
id -> (string)
If you want to interconnect several instances in a GPU cluster via NVIDIA InfiniBand,
set the ID of an existing GPU cluster.
You can only add the VM to the cluster when creating the VM.
For details, see [https://docs.nebius.com/compute/clusters/gpu](https://docs.nebius.com/compute/clusters/gpu).
hostname -> (string)
Instance's hostname. Used to generate default DNS record in format `
or `
local\_disks -> (structure)
Local disks are meaningfully different from regular (remote) disks:
they are provided by the underlying host and are tied to a particular VM run.
Local disk data is not preserved across Stop-Start initiated via Compute API.
Local disks are not provided by default. To get them, explicitly request them via this field.
Availability depends on the selected platform, preset and region.
Changing this field will result in disks change and content loss, but only after stop and start the instance.
passthrough\_group -> (structure)
Requests passthrough local disks from the host.
Topology of the provided disks is preserved during stop and start
for every instance of a specific platform and preset in the region.
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.
network\_interfaces -> (structure)\[required]
List of network interfaces attached to the instance.
aliases -> (structure)
Assign ranges of IP addresses as aliases.
allocation\_id -> (string)\[required]
ID of allocation.
ip\_address -> (structure)\[required] \[immutable] \[meaningful\_empty\_value]
Private IPv4 address associated with the interface.
allocation\_id -> (string)
Allocation identifier if it was created before.
name -> (string)\[required] \[immutable]
Interface name
Value of this field configures the name of the network interface inside VM's OS.
Longer values will persist in the specification but will be truncated to 15 symbols before being passed to VM configuration.
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.
subnet\_id -> (string)\[required] \[immutable]
Subnet ID.
preemptible -> (structure)\[immutable]
Include these parameters to create a Preemptible VM and omit them to create a Regular VM
For details, see [https://docs.nebius.com/compute/virtual-machines/preemptible](https://docs.nebius.com/compute/virtual-machines/preemptible).
on\_preemption -> (string)\[required] \[immutable]
Specifies what happens when the VM is preempted. The only supported value is STOP:
Compute stops the VM without deleting or restarting it.
A value must be one of:
"unspecified"
"stop"
priority -> (int32)\[required] \[immutable]
The value can range from 1 to 5, where 5 indicates the highest priority.
Affects the order in which Compute tries to preempt VMs, but does not guarantee the exact order.
recovery\_policy -> (string)\[immutable]
Recovery policy defines how the instance will be treated in case of a failure.
Common source of failure is a host failure, but it can be any other failure.
Instance undergoing a guest shutdown (poweroff, etc.) will be subject to recovery policy, meaning that it could
be restarted and billed accordingly. Stop instance via API or UI to stop it to avoid recovering.
* If set to RECOVER, instance will be restarted, if possible. It could be restarted on the same host or on another host.
* If set to FAIL, instance will be stopped and not restarted.
A value must be one of:
"recover"
"fail"
reservation\_policy -> (structure)
policy -> (string)
A value must be one of:
"auto"
"forbid"
"strict"
reservation\_ids -> (string)
Capacity block groups, order matters.
resources -> (structure)\[required]
Specification of compute resources allocated to the instance.
For details, see [https://docs.nebius.com/compute/virtual-machines/types](https://docs.nebius.com/compute/virtual-machines/types).
platform -> (string)\[required] \[immutable]
preset -> (string)
secondary\_disks -> (structure)
List of additional data disks attached to the instance beyond the boot disk.
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-{device_id}' 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).
Switching to a managed disk:
* To delete the disk together with the instance, switch to ManagedDisk in the instance spec.
* For the switch, `ManagedDisk.name` MUST match the current disk `name`
(see DiskService.Get for the disk referenced by `ExistingDisk.id`).
* When converting an ExistingDisk to a ManagedDisk, you must provide `ManagedDisk.name` and `ManagedDisk.spec`
exactly as they are currently defined in the disk resource.
Obtain the current values via `DiskService.Get` and copy them verbatim.
If `ManagedDisk.spec` differs 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.
Semantics:
* 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`.
Updates and matching:
* Managed disks can be updated only via instance spec updates. Updates via DiskService are not allowed.
* During updates, disks are matched by `name`.
Renaming and data loss:
* Changing the disk `name` triggers disk replacement (create a new disk and delete the old one),
which causes data loss.
* To rename a managed disk safely:
1. switch it to ExistingDisk in the instance spec, and
2. update/rename it via DiskService.
Conflicts:
* Instance create/update fails if there is already a disk with the same `name`.
as requested by any ManagedDisk.
Finding the disk ID:
* The disk ID is available in `instance.status.disk_attachments` after it is created.
Use `DiskAttachmentStatus.name` to find the desired disk which matches `name`.
Switching to an existing (non-managed) disk:
* To preserve the disk after instance deletion, switch it to ExistingDisk in the instance spec,
use the disk ID from `instance.status.disk_attachments`.
Deletion protection:
* Switching ExistingDisk to ManagedDisk fails if `Disk.spec.deletion_protection` is enabled.
* Deleting an instance that has a ManagedDisk fails if `Disk.spec.deletion_protection` is 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.
block\_size\_bytes -> (int64)\[immutable]
Block size in bytes.
The block size must be a power of two between 4096 bytes (4 KiB) and 131072 bytes (128 KiB).
The default value is 4096 bytes (4 KiB).
disk\_encryption -> (structure)\[immutable]
Defines how data on the disk is encrypted. By default, no encryption is applied.
type -> (string)
A value must be one of:
"disk\_encryption\_unspecified"
"disk\_encryption\_managed"
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.
source\_image\_family -> (structure)\[immutable]
Mutually exclusive with: source\_image\_id.
image\_family -> (string)\[required]
parent\_id -> (string)
source\_image\_id -> (string)\[immutable]
Mutually exclusive with: source\_image\_family.
type -> (string)\[required] \[immutable]
The type of disk defines the performance and reliability characteristics of the block device.
For details, see [https://docs.nebius.com/compute/storage/types#disks-types](https://docs.nebius.com/compute/storage/types#disks-types).
A value must be one of:
"unspecified"
"network\_ssd"
"network\_hdd"
"network\_ssd\_non\_replicated"
"network\_ssd\_io\_m3"
service\_account\_id -> (string)\[immutable]
Unique identifier of the service account associated with this instance.
For details, see [https://docs.nebius.dev/en/iam/about-iam/concepts/service-accounts](https://docs.nebius.dev/en/iam/about-iam/concepts/service-accounts).
stopped -> (bool)
Indicates whether the instance should be stopped.
JSON Schema:
```json theme={null} [{ "compute_disk_spec": { "metadata": { "id": "", "labels": { "": "" }, "name": "", "parent_id": "", "resource_version": 0 }, "spec": { "block_size_bytes": 0, "disk_encryption": { "type": "disk_encryption_unspecified"|"disk_encryption_managed" }, "forbid_deletion": false, "size_bytes": 0, "source_image_family": { "image_family": "", "parent_id": "" }, "type": "unspecified"|"network_ssd"|"network_hdd"|"network_ssd_non_replicated"|"network_ssd_io_m3" } } }] ```
`-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.