Instance properties

Instance properties are set when the instance is created. They cannot be part of a profile.

The following instance properties are available:

Property

Read-only

Description

name

yes

Instance name (see Instance name requirements)

architecture

no

Instance architecture

Instance name requirements

The instance name can be changed only by renaming the instance with the incus rename command.

Valid instance names must fulfill the following requirements:

  • The name must be between 1 and 63 characters long.

  • The name must contain only letters, numbers and dashes from the ASCII table.

  • The name must not start with a digit or a dash.

  • The name must not end with a dash.

The purpose of these requirements is to ensure that the instance name can be used in DNS records, on the file system, in various security profiles and as the host name of the instance itself.