Interface Server

interface Server {
    adminPasswordEncryptedValue?: string;
    adminPasswordEncryptionSshKeyId?: string;
    allowedActions: ServerAction[];
    arch: Arch;
    bootType: BootType;
    commercialType: string;
    creationDate?: Date;
    dynamicIpRequired: boolean;
    enableIpv6?: boolean;
    hostname: string;
    id: string;
    image?: Instance.v1.Image;
    ipv6?: ServerIpv6;
    location?: Instance.v1.ServerLocation;
    macAddress: string;
    maintenances: ServerMaintenance[];
    modificationDate?: Date;
    name: string;
    organization: string;
    placementGroup?: PlacementGroup;
    privateIp?: string;
    privateNics: PrivateNIC[];
    project: string;
    protected: boolean;
    publicIp?: ServerIp;
    publicIps: ServerIp[];
    routedIpEnabled?: boolean;
    securityGroup?: SecurityGroupSummary;
    state: ServerState;
    stateDetail: string;
    tags: string[];
    volumes: Record<string, VolumeServer>;
    zone: Zone;
}

Properties

adminPasswordEncryptedValue? adminPasswordEncryptionSshKeyId? allowedActions arch bootType commercialType creationDate? dynamicIpRequired enableIpv6? hostname id image? ipv6? location? macAddress maintenances modificationDate? name organization placementGroup? privateIp? privateNics project protected publicIp? publicIps routedIpEnabled? securityGroup? state stateDetail tags volumes zone

Properties

OptionaladminPasswordEncryptedValue

adminPasswordEncryptedValue?: string

This value is reset when admin_password_encryption_ssh_key_id is set to an empty string.

OptionaladminPasswordEncryptionSshKeyId

adminPasswordEncryptionSshKeyId?: string

The public_key value of this key is used to encrypt the admin password. When set to an empty string, reset this value and admin_password_encrypted_value to an empty string so a new password may be generated.

allowedActions

allowedActions: ServerAction[]

List of allowed actions on the Instance.

arch

arch: Arch

Instance architecture.

bootType

bootType: BootType

Instance boot type.

commercialType

commercialType: string

Instance commercial type (eg. GP1-M).

OptionalcreationDate

creationDate?: Date

Instance creation date.

dynamicIpRequired

dynamicIpRequired: boolean

True if a dynamic IPv4 is required.

OptionalenableIpv6

enableIpv6?: boolean

Deprecated

True if IPv6 is enabled (deprecated and always False when routed_ip_enabled is True).

hostname

hostname: string

Instance host name.

id

id: string

Instance unique ID.

Optionalimage

image?: Instance.v1.Image

Information about the Instance image.

Optionalipv6

ipv6?: ServerIpv6

Deprecated

Instance IPv6 address (deprecated when routed_ip_enabled is True).

Optionallocation

location?: Instance.v1.ServerLocation

Instance location.

macAddress

macAddress: string

The server's MAC address.

maintenances

maintenances: ServerMaintenance[]

Instance planned maintenance.

OptionalmodificationDate

modificationDate?: Date

Instance modification date.

name

name: string

Instance name.

organization

organization: string

Instance Organization ID.

OptionalplacementGroup

placementGroup?: PlacementGroup

Instance placement group.

OptionalprivateIp

privateIp?: string

Private IP address of the Instance (deprecated and always null when routed_ip_enabled is True).

privateNics

privateNics: PrivateNIC[]

Instance private NICs.

project

project: string

Instance Project ID.

protected

protected: boolean

Defines whether the Instance protection option is activated.

OptionalpublicIp

publicIp?: ServerIp

Deprecated

Information about the public IP (deprecated in favor of public_ips).

publicIps

publicIps: ServerIp[]

Information about all the public IPs attached to the server.

OptionalroutedIpEnabled

routedIpEnabled?: boolean

Deprecated

True to configure the instance so it uses the routed IP mode. Use of routed_ip_enabled as False is deprecated.

OptionalsecurityGroup

securityGroup?: SecurityGroupSummary

Instance security group.

state

state: ServerState

Instance state.

stateDetail

stateDetail: string

Detailed information about the Instance state.

tags

tags: string[]

Tags associated with the Instance.

volumes

volumes: Record<string, VolumeServer>

Instance volumes.

zone

zone: Zone

Zone in which the Instance is located.

Settings

On This Page

Properties