mirror of
https://github.com/netbox-community/netbox.git
synced 2025-12-12 11:29:36 -06:00
01cbdbb968
Some checks failed
CodeQL / Analyze (${{ matrix.language }}) (none, actions) (push) Has been cancelled
CodeQL / Analyze (${{ matrix.language }}) (none, javascript-typescript) (push) Has been cancelled
CodeQL / Analyze (${{ matrix.language }}) (none, python) (push) Has been cancelled
CI / build (20.x, 3.12) (push) Has been cancelled
CI / build (20.x, 3.13) (push) Has been cancelled
68 lines
2.4 KiB
Markdown
68 lines
2.4 KiB
Markdown
# Virtual Machines
|
|
|
|
A virtual machine (VM) represents a virtual compute instance hosted within a [cluster](./cluster.md). Each VM must be assigned to a [site](../dcim/site.md) and/or cluster, and may optionally be assigned to a particular host [device](../dcim/device.md) within a cluster.
|
|
|
|
Virtual machines may have virtual [interfaces](./vminterface.md) assigned to them, but do not support any physical component. When a VM has one or more interfaces with IP addresses assigned, a primary IP for the device can be designated, for both IPv4 and IPv6.
|
|
|
|
## Fields
|
|
|
|
### Name
|
|
|
|
The virtual machine's configured name. Must be unique to the assigned cluster and tenant.
|
|
|
|
### Role
|
|
|
|
The functional [role](../dcim/devicerole.md) assigned to the VM.
|
|
|
|
### Status
|
|
|
|
The VM's operational status.
|
|
|
|
!!! tip
|
|
Additional statuses may be defined by setting `VirtualMachine.status` under the [`FIELD_CHOICES`](../../configuration/data-validation.md#field_choices) configuration parameter.
|
|
|
|
### Start on boot
|
|
|
|
The start on boot setting from the hypervisor.
|
|
|
|
!!! tip
|
|
Additional statuses may be defined by setting `VirtualMachine.start_on_boot` under the [`FIELD_CHOICES`](../../configuration/data-validation.md#field_choices) configuration parameter.
|
|
|
|
### Site & Cluster
|
|
|
|
The [site](../dcim/site.md) and/or [cluster](./cluster.md) to which the VM is assigned.
|
|
|
|
### Device
|
|
|
|
The physical host [device](../dcim/device.md) within the assigned site/cluster on which this VM resides.
|
|
|
|
### Platform
|
|
|
|
A VM may be associated with a particular [platform](../dcim/platform.md) to indicate its operating system.
|
|
|
|
### Primary IPv4 & IPv6 Addresses
|
|
|
|
Each VM may designate one primary IPv4 address and/or one primary IPv6 address for management purposes.
|
|
|
|
!!! tip
|
|
NetBox will prefer IPv6 addresses over IPv4 addresses by default. This can be changed by setting the `PREFER_IPV4` configuration parameter.
|
|
|
|
### vCPUs
|
|
|
|
The number of virtual CPUs provisioned. A VM may be allocated a partial vCPU count (e.g. 1.5 vCPU).
|
|
|
|
### Memory
|
|
|
|
The amount of running memory provisioned, in megabytes.
|
|
|
|
### Disk
|
|
|
|
The amount of disk storage provisioned, in megabytes.
|
|
|
|
!!! warning
|
|
This field may be directly modified only on virtual machines which do not define discrete [virtual disks](./virtualdisk.md). Otherwise, it will report the sum of all attached disks.
|
|
|
|
### Serial Number
|
|
|
|
Optional serial number assigned to this virtual machine. Unlike devices, uniqueness is not enforced for virtual machine serial numbers.
|