Command Reference¶

A complete list of commands and their options.

Available on the command line by appending --help to the command.

Configure¶

The configure command interactively configures pontoon.

You’re prompted for details and a configuration file is written to ~/.pontoon.

Alternatively, you can manually place a config file at this location with this syntax:

api_token: foo-bar-baz
auth_key_name: Macbook.local
image: ubuntu-15-10-x32
region: lon1
size: 512mb
ssh_private_key: ~/.ssh/id_rsa
ssh_public_key: ~/.ssh/id_rsa.pub
username: root

pontoon configure¶: Launch interactive configuration of pontoon.

Droplets¶

pontoon droplet list [options]¶

--detail¶: Show full Droplet info.

$ pontoon droplet list --detail
example.com
id: 3164444
size: 512mb
image: ubuntu-14-04-x64
region: nyc3
ip_address: 104.236.32.182
status: active
kernel:
   id: 2233
   name: Ubuntu 14.04 x64 vmlinuz-3.13.0-37-generic
   version: 3.13.0-37-generic
...

pontoon droplet create <name> [options]¶

--size size¶: Droplet RAM allocation. e.g., 512mb

--image image¶: Droplet image.

--region region¶: Droplet region.

--keys keys...¶: List of registered keys to add to Droplet(s)

--user-data userdata¶: String of user data to pass to Droplet. Include a file like: --user-data="$(cat file.yml)"

--private-networking¶: Assign private address to Droplet (where available)

--disable-virtio¶: Disable VirtIO. (not recommended)

--no-wait¶: Don’t wait for action to complete, return immediately.

pontoon droplet ssh <name> [command] [options]¶

--user user¶: Override configured username for SSH login.

--key path¶: Override configured private key for SSH login.

pontoon droplet rename <from> <to> [options]¶: Rename a Droplet. Takes the current name as the first parameter, and the new name as the second.

--no-wait¶: Don’t wait for action to complete, return immediately.

pontoon droplet resize <name> <size> [options]¶: Resize a Droplet. Takes Droplet name as first paramter, size as second.

--yes¶: Don’t prompt for confirmation.

--no-wait¶: Don’t wait for action to complete, return immediately.

pontoon droplet snapshot <droplet> <snapshot> [options]¶: Snapshot a Droplet. Takes Droplet name as first paramter, snapshot name as second.

--no-wait¶: Don’t wait for action to complete, return immediately.

pontoon droplet show <name> [options]¶: Show detailed information about a particular Droplet.

--field field¶: Extract and return a single field. Access nested items with dot syntax, e.g.: networks.v4.0.gateway

pontoon droplet status <name>¶: Return Droplet status.

pontoon droplet destroy <name>¶: Destroy a Droplet.

pontoon droplet start <name>¶: Start a Droplet.

--no-wait¶: Don’t wait for action to complete, return immediately.

pontoon droplet shutdown <name>¶: Shut down a Droplet.

--no-wait¶: Don’t wait for action to complete, return immediately.

pontoon droplet reboot <name>¶: Reboot a Droplet (sending signal to OS).

--no-wait¶: Don’t wait for action to complete, return immediately.

pontoon droplet restore <name> <snapshot>¶: Restore a Droplet from a snapshot.

--no-wait¶: Don’t wait for action to complete, return immediately.

pontoon droplet rebuild <name> <image>¶: Rebuild a Droplet from a given image.

--no-wait¶: Don’t wait for action to complete, return immediately.

pontoon droplet powercycle <name>¶: Powercycle (hard restart) a Droplet.

--yes¶: Don’t prompt for confirmation.

--no-wait¶: Don’t wait for action to complete, return immediately.

pontoon droplet poweroff <name>¶: Power off (without signalling the OS) a Droplet.

--yes¶: Don’t prompt for confirmation.

--no-wait¶: Don’t wait for action to complete, return immediately.

pontoon droplet passwordreset <name>¶: Reset the root password on a Droplet.

--yes¶: Don’t prompt for confirmation.

pontoon droplet backups <name>¶: Manage backups on a Droplet.

--enable¶: Enable backups.

--disable¶: Depracated by Digital Ocean for their v2 API release, later added back but still deprecated here for the moment.

Events¶

These is an interface to Digital Ocean events.

Events are usually only an implementation detail, and an interface is provided here only for completeness.

pontoon event show <id>¶: Retrieve details for a particular event id.

Images¶

Public base images made available by Digital Ocean.

pontoon image list [options]¶: Retrieve a list of public images.

--with-ids¶: Include image IDs in tabular output.

pontoon image oses¶: Retrieve a list of Operating Systems for which there are base images.

pontoon image show <name>¶: Show details for a particular image, including regions where it is available.

Regions¶

Regions available to launch Droplets.

pontoon region list¶: List regions in which Droplets can be launched.

Sizes¶

Droplet sizes available.

pontoon size list¶: List sizes of Droplets which can be launched.

Snapshots¶

Commands for interacting with snapshots.

pontoon snapshot list [options]¶: List available snapshots.

--with-ids¶: Include image IDs in tabular output.

pontoon snapshot show <name>¶: Show snapshot details.

pontoon snapshot destroy <name>¶: Destroy a snapshot.

pontoon snapshot transfer <name> <region>¶: Move a snapshot from one region to another. A list of regions can be retrieved with pontoon region list

SSH Keys¶

Manage SSH keys in your account.

pontoon sshkey list¶: List of SSH keys in account.

pontoon sshkey add <name> <public-key-path>¶: Register a public SSH key from the specified path to your account.

pontoon sshkey show <name>¶: Retrieve a public key by name.

pontoon sshkey replace <name> <public-key-path>¶: Replace an existing key name with a new public key.

pontoon sshkey destroy <name>¶: Remove a given key from Digital Ocean. Note: this doesn’t remove the key from any existing Droplets, just removes it from the keys available to boot Droplets with.