Interface Server

interface Server {
    createdAt?: Date;
    deletableAt?: Date;
    deletionScheduled: boolean;
    delivered: boolean;
    id: string;
    ip: string;
    name: string;
    organizationId: string;
    os?: AppleSilicon.v1alpha1.OS;
    projectId: string;
    sshUsername: string;
    status: AppleSilicon.v1alpha1.ServerStatus;
    sudoPassword: string;
    type: string;
    updatedAt?: Date;
    vncPort: number;
    vncUrl: string;
    zone: Zone;
}

Properties

createdAt? deletableAt? deletionScheduled delivered id ip name organizationId os? projectId sshUsername status sudoPassword type updatedAt? vncPort vncUrl zone

Properties

OptionalcreatedAt

createdAt?: Date

Date on which the server was created.

OptionaldeletableAt

deletableAt?: Date

Date from which the server can be deleted.

deletionScheduled

deletionScheduled: boolean

Set to true to mark the server for automatic deletion depending on deletable_at date. Set to false to cancel an existing deletion schedule. Leave unset otherwise.

delivered

delivered: boolean

Set to true once the server has completed its provisioning steps and is ready to use. Some OS configurations might require a reinstallation of the server before delivery depending on the available stock. A reinstallation after the initial delivery will not change this flag and can be tracked using the server status.

id

id: string

UUID of the server.

ip

ip: string

IPv4 address of the server.

name

name: string

Name of the server.

organizationId

organizationId: string

Organization this server is associated with.

Optionalos

os?: AppleSilicon.v1alpha1.OS

Initially installed OS, this does not necessarily reflect the current OS version.

projectId

projectId: string

Project this server is associated with.

sshUsername

sshUsername: string

SSH Username for remote shell.

status

status: AppleSilicon.v1alpha1.ServerStatus

Current status of the server.

sudoPassword

sudoPassword: string

Admin password required to execute commands.

type

type: string

Type of the server.

OptionalupdatedAt

updatedAt?: Date

Date on which the server was last updated.

vncPort

vncPort: number

VNC port to use for remote desktop connection.

vncUrl

vncUrl: string

Vnc:// URL to access Apple Remote Desktop.

zone

zone: Zone

Zone of the server.

Settings

On This Page

Properties