Interface OS

interface OS {
    allowCustomPartitioning: boolean;
    allowedFilesystems: PartitionFileSystem[];
    allowSshKeys: boolean;
    arch: OSArch;
    displayName: string;
    hostnameMaxLength: number;
    hostnameRegex?: string;
    id: number;
    licenseOffers: Dedibox.v1.Offer[];
    maxPartitions?: number;
    name: string;
    panelPasswordRegex?: string;
    passwordRegex: string;
    releasedAt?: Date;
    requiresAdminPassword: boolean;
    requiresLicense: boolean;
    requiresPanelPassword: boolean;
    requiresUser: boolean;
    requiresValidHostname?: boolean;
    type: OSType;
    version: string;
}

Properties

allowCustomPartitioning allowedFilesystems allowSshKeys arch displayName hostnameMaxLength hostnameRegex? id licenseOffers maxPartitions? name panelPasswordRegex? passwordRegex releasedAt? requiresAdminPassword requiresLicense requiresPanelPassword requiresUser requiresValidHostname? type version

Properties

allowCustomPartitioning

allowCustomPartitioning: boolean

True if the OS allow custom partitioning.

allowedFilesystems

allowedFilesystems: PartitionFileSystem[]

True if the OS allow file systems.

allowSshKeys

allowSshKeys: boolean

True if the OS allow SSH Keys.

arch

arch: OSArch

Architecture of the OS.

displayName

displayName: string

Display name of the OS.

hostnameMaxLength

hostnameMaxLength: number

Hostname max length.

OptionalhostnameRegex

hostnameRegex?: string

If both requires_valid_hostname & hostname_regex are set, it means that at least one of the criterias must be valid.

id

id: number

ID of the OS.

licenseOffers

licenseOffers: Dedibox.v1.Offer[]

License offers available with the OS.

OptionalmaxPartitions

maxPartitions?: number

Maximum number of partitions which can be created.

name

name: string

Name of the OS.

OptionalpanelPasswordRegex

panelPasswordRegex?: string

Regex used to validate the panel installation password.

passwordRegex

passwordRegex: string

Regex used to validate the installation passwords.

OptionalreleasedAt

releasedAt?: Date

OS release date.

requiresAdminPassword

requiresAdminPassword: boolean

True if the OS requires admin password.

requiresLicense

requiresLicense: boolean

True if the OS requires license.

requiresPanelPassword

requiresPanelPassword: boolean

True if the OS requires panel password.

requiresUser

requiresUser: boolean

True if the OS requires user.

OptionalrequiresValidHostname

requiresValidHostname?: boolean

If both requires_valid_hostname & hostname_regex are set, it means that at least one of the criterias must be valid.

type

type: OSType

Type of the OS.

version

version: string

Version of the OS.

Settings

On This Page

Properties