Skip to content

Server Usage Examples

Create Servers

See available flavors:

cloudscale flavor list

and images:

cloudscale image list

Create one server:

cloudscale server create \
--flavor flex-2 \
--image centos-7 \
--name my-server \
--ssh-key "$(cat ~/.ssh/id_rsa.pub)"

Create up to 10 servers in a row with --count:

Tip

The option --name allows to use string format syntax with 2 special variables:

  • counter: A number representing the current iteration while creating multiple servers.
  • uid: A random 8 char/number long string.

This allows to create dynamic names, e.g.:

  • Single number suffix: --name 'myserver-{counter}'
  • Number with leading zero suffix: --name 'server-{counter:02d}'
  • Random string suffix: --name 'server-{uid}'
  • Combinations: --name 'server-{uid}-{counter:02d}.example.com'
cloudscale server create \
--flavor flex-2 \
--image centos-7 \
--ssh-key "$(cat ~/.ssh/id_rsa.pub)" \
--name 'my-server-{counter}' \
--count 10

Tip

To ensure all servers created have booted and are running by providing the option --wait.

Usage of the --interface option in server create and server update

If the --interface option is used, --use-{public,private}-network options are disabled. This are the examples from the api documentation:

  • Create a public network interface with an automatically assigned IPv4 address and an IPv6 address if use_ipv6 is set to true:
--interface network=public
  • Create a private network interface on the network identified by "UUID1". The interface will automatically be assigned an address from the DHCP range of the network's subnet.
--interface network=UUID1
  • Create a private network interface on the network on which the subnet identified by "UUID2" is configured. The interface will automatically be assigned an address from the DHCP range of the subnet.
--interface subnet=UUID2
  • This is equivalent to the schema defined above. It is only valid if the subnet identified by "UUID4" is configured on the network identified by "UUID3".
--interface network=UUID3,subnet=UUID4
  • Create a private network interface on the network on which the subnet identified by "UUID5" is configured. The interface will automatically be assigned the address A.B.C.D.
--interface subnet=UUID5,address=A.B.C.D
  • This is equivalent to the schema defined above. It is only valid if the subnet identified by "UUID7" is configured on the network identified by "UUID6".
--interface network=UUID6,subnet=UUID7,address=A.B.C.D
  • Create a private network interface on the network identified by "UUID8". No IP address will be assigned using DHCP.
--interface network=UUID8,address=

List Servers

Get a list as table view:

cloudscale server list

Get a list as JSON response:

cloudscale -o json server list

Filter by Tag

List servers having the tag project with value gemini:

cloudscale server list --filter-tag project=gemini

List servers having a tag project:

cloudscale server list --filter-tag project

Filter by JSON Query

Get a list of stopped servers:

cloudscale server list --filter-json '[?status == `stopped`]'

Get a list of stopped servers having tag project=demo and start them after accepting:

cloudscale server list \
--filter-tag project=demo \
--filter-json '[?status == `stopped`]' \
--action start
...
Do you want to start? [y/N]:

Start a list of stopped servers after accepting having tag project=demo:

cloudscale server list \
--filter-tag project=demo \
--filter-json '[?status == `stopped`]' \
--action start
...
Do you want to start? [y/N]:

Delete a list of stopped servers after accepting having tag project=demo:

cloudscale server list \
--filter-tag project=demo \
--filter-json '[?status == `stopped`]' \
--delete
...
Do you want to delete? [y/N]:

Get a simplified custom JSON list of stopped servers in profile production:

cloudscale \
--output json \
--profile production \
server list \
--filter-json '[?status == `stopped`].{"server_name": name, "zone": zone.slug, "image": image.slug, "flavor": flavor.slug}'
[
    {
        "flavor": "flex-8",
        "image": "rhel-7",
        "server_name": "server1",
        "zone": "rma1"
    },
    {
        "flavor": "flex-8",
        "image": "centos-7",
        "server_name": "server2",
        "zone": "rma1"
    }
]

Server Actions

SSH into to a Server

SSH into a server via its public IP:

cloudscale server ssh <uuid or unique name>

Stop a Server

Stop a server:

cloudscale server stop <uuid or unique name>

Start a Server

cloudscale server start <uuid or unique name>

Delete a Server

With prompt:

cloudscale server delete <uuid or unique name>

Just delete without questions asked:

cloudscale server delete --force <uuid or unique name>