apple-silicon.md

Documentation for scw apple-silicon

Apple silicon API.

OS management commands

OS management commands.

Get an Operating System (OS)

Get an Operating System (OS). The response will include the OS's unique ID as well as its name and label.

Usage:

scw apple-silicon os get <os-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
os-id	UUID of the OS you want to get	Required
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-3

List all Operating Systems (OS)

List all Operating Systems (OS). The response will include the total number of OS as well as their associated IDs, names and labels.

Usage:

scw apple-silicon os list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
server-type	List of compatible server types
name	Filter OS by name (note that "11.1" will return "11.1.2" and "11.1" but not "12"))
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-3, all

Private network management command

A Private Network allows you to interconnect your resources in an isolated and private network. Network reachability is limited to the resources that are in the same VPC.

Note that a resource can be a part of multiple Private Networks.

Add a server to a Private Network

Add an Apple silicon server to a Private Network.

Usage:

scw apple-silicon private-network add [arg=value ...]

Arguments:

Name	Description	Argument Specifications
server-id	ID of the server	Required
private-network-id	ID of the Private Network	Required
ipam-ip-ids.{index}	IPAM IDs of IPs to attach to the server
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-1, fr-par-3

Delete a Private Network

Delete a Private Network.

Usage:

scw apple-silicon private-network delete [arg=value ...]

Arguments:

Name	Description	Argument Specifications
server-id	ID of the server	Required
private-network-id	ID of the Private Network	Required
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-1, fr-par-3

List the Private Networks of a server

List the Private Networks of an Apple silicon server.

Usage:

scw apple-silicon private-network list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
order-by	Sort order for the returned Private Networks	One of: created_at_asc, created_at_desc, updated_at_asc, updated_at_desc
server-id	Filter Private Networks by server ID
private-network-id	Filter Private Networks by Private Network ID
project-id	Filter Private Networks by Project ID
ipam-ip-ids.{index}	Filter Private Networks by IPAM IP IDs
organization-id	Filter Private Networks by Organization ID
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-1, fr-par-3, all

Set multiple Private Networks on a server

Configure multiple Private Networks on an Apple silicon server.

Usage:

scw apple-silicon private-network set [arg=value ...]

Arguments:

Name	Description	Argument Specifications
server-id	ID of the server	Required
per-private-network-ipam-ip-ids.{key}	Object where the keys are the IDs of Private Networks and the values are arrays of IPAM IDs representing the IPs to assign to this Apple silicon server on the Private Network. If the array supplied for a Private Network is empty, the next available IP from the Private Network's CIDR block will automatically be used for attachment.	Required
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-1, fr-par-3

Runner management commands

Runner management commands.

Create a new runner configuration

Create a new runner configuration.

Usage:

scw apple-silicon runner create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
project-id	Project ID to use. If none is passed the default project ID will be used
runner-configuration.name
runner-configuration.provider		One of: unknown_provider, github, gitlab
runner-configuration.github-configuration.url
runner-configuration.github-configuration.token
runner-configuration.github-configuration.labels.{index}
runner-configuration.gitlab-configuration.url
runner-configuration.gitlab-configuration.token
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-3

Create a new runner configuration

Create a new runner configuration.

Usage:

scw apple-silicon runner delete <runner-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
runner-id	ID of the runner configuration to delete	Required
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-3

Retrieve a runner configuration

Retrieve a runner configuration.

Usage:

scw apple-silicon runner get <runner-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
runner-id	ID of the runner configuration to get	Required
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-3

List runner configurations associated with a server

List runner configurations associated with a server.

Usage:

scw apple-silicon runner list <server-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
server-id	ID of the server for which to list applied runner configurations	Required
project-id	Only list servers of this project ID
organization-id	Only list servers of this Organization ID
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-3, all

Create a new runner configuration

Create a new runner configuration.

Usage:

scw apple-silicon runner update <runner-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
runner-id	ID of the runner configuration to update	Required
runner-configuration.name
runner-configuration.provider		One of: unknown_provider, github, gitlab
runner-configuration.github-configuration.url
runner-configuration.github-configuration.token
runner-configuration.github-configuration.labels.{index}
runner-configuration.gitlab-configuration.url
runner-configuration.gitlab-configuration.token
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-3

Apple silicon management commands

Apple silicon management commands.

Create a server

Create a new server in the targeted zone, specifying its configuration including name and type.

Usage:

scw apple-silicon server create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
name	Create a server with this given name	Default: <generated>
project-id	Project ID to use. If none is passed the default project ID will be used
type	Create a server of the given type
os-id	Create a server with the given os_id
enable-vpc	Activate the Private Network feature for this server
commitment-type	Activate commitment for this server	One of: duration_24h, renewed_monthly, none
public-bandwidth-bps	Public bandwidth to configure for this server. Expressed in bits per second.
runner-configuration.name
runner-configuration.url
runner-configuration.token
runner-configuration.provider		One of: unknown_provider, github, gitlab
runner-configuration.download-runner
runner-configuration.action		One of: unknown_action, remove, update, add
runner-configuration.id
runner-configuration.labels.{index}
applied-runner-configurations.runner-configuration-ids.{index}
enable-kext	Enable kernel extensions
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-3

Delete a server

Delete an existing Apple silicon server, specified by its server ID. Deleting a server is permanent, and cannot be undone. Note that the minimum allocation period for Apple silicon-as-a-service is 24 hours, meaning you cannot delete your server prior to that.

Usage:

scw apple-silicon server delete <server-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
server-id	UUID of the server you want to delete	Required
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-3

Get a server

Retrieve information about an existing Apple silicon server, specified by its server ID. Its full details, including name, status and IP address, are returned in the response object.

Usage:

scw apple-silicon server get <server-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
server-id	UUID of the server you want to get	Required
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-3

List all servers

List all servers in the specified zone. By default, returned servers in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

Usage:

scw apple-silicon server list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
order-by	Sort order of the returned servers	One of: created_at_asc, created_at_desc
project-id	Only list servers of this project ID
organization-id	Only list servers of this Organization ID
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-3, all

Reboot a server

Reboot an existing Apple silicon server, specified by its server ID.

Usage:

scw apple-silicon server reboot <server-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
server-id	UUID of the server you want to reboot	Required
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-3

Reinstall a server

Reinstall an existing Apple silicon server (specified by its server ID) from a new image (OS). All the data on the disk is deleted and all configuration is reset to the default configuration values of the image (OS).

Usage:

scw apple-silicon server reinstall <server-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
server-id	UUID of the server you want to reinstall	Required
os-id	Reinstall the server with the OS corresponding to the os_id
enable-kext	Enable kernel extensions
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-3

SSH into a server

Connect to distant server via the SSH protocol.

Usage:

scw apple-silicon server ssh <server-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
server-id	Server ID to SSH into	Required
username	Username used for the SSH connection	Default: m1
port	Port used for the SSH connection	Default: 22
command	Command to execute on the remote server
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1

Update a server

Update the parameters of an existing Apple silicon server, specified by its server ID.

Usage:

scw apple-silicon server update <server-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
server-id	UUID of the server you want to update	Required
name	Updated name for your server
schedule-deletion	Specify whether the server should be flagged for automatic deletion
enable-vpc	Activate or deactivate Private Network support for this server
commitment-type.commitment-type		One of: duration_24h, renewed_monthly, none
public-bandwidth-bps	Public bandwidth configured for this server
applied-runner-configurations.runner-configuration-ids.{index}
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-3

Wait for a server to reach a stable state

Wait for server to reach a stable state. This is similar to using --wait flag on other action commands, but without requiring a new action on the server.

Usage:

scw apple-silicon server wait <server-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
server-id	ID of the server.	Required
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1
timeout	Timeout of the wait	Default: 1h0m0s

Examples:

Wait for a server to reach a stable state

scw apple-silicon server wait 11111111-1111-1111-1111-111111111111

Server-Types management commands

Server-Types management commands.

Get a server type

Get technical details (CPU, disk size etc.) of a server type.

Usage:

scw apple-silicon server-type get <server-type ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
server-type	Server type identifier	Required
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-3

List server types

List all technical details about Apple silicon server types available in the specified zone. Since there is only one Availability Zone for Apple silicon servers, the targeted value is fr-par-3.

Usage:

scw apple-silicon server-type list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-3