{"id":3067,"date":"2021-04-29T09:52:00","date_gmt":"2021-04-29T06:52:00","guid":{"rendered":"https:\/\/upcloud.com\/global\/us\/resources\/tools\/upcloud-command-line-interface\/"},"modified":"2021-04-29T09:52:00","modified_gmt":"2021-04-29T06:52:00","slug":"upcloud-command-line-interface","status":"publish","type":"tools","link":"https:\/\/upcloud.com\/global\/resources\/tools\/upcloud-command-line-interface\/","title":{"rendered":"UpCloud Command-Line Interface"},"content":{"rendered":"\n<p class=\"wp-block-paragraph\">UpCloud Command-Line Interface, or UpCloud CLI for short, is a text-based user interface to UpCloud&#8217;s Infrastructure-as-a-service. It provides a fast command-line tool for accessing and managing your UpCloud resources. Save valuable time with quick commands always right at your fingertips!<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">UpCloud CLI<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">UpCloud CLI allows you to control your Cloud Servers, storage and networking from your local command line with simple and intuitive command structures.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">It&#8217;s offered as an addition to the current methods such as the UpCloud Control Panel and API for all users but especially developers and system administrators will likely find it highly useful!<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">The <a href=\"https:\/\/github.com\/UpCloudLtd\/upcloud-cli\/releases\" target=\"_blank\" rel=\"noreferrer noopener\">UpCloud CLI<\/a> is available for download from our GitHub repository with support for multiple operating systems including macOS, Windows and many Linux distributions. Pick the release as appropriate for your operating system and get started in minutes!<\/p>\n\n\n\n<figure class=\"wp-block-image\"><img decoding=\"async\" src=\"https:\/\/upcloud.com\/media\/upcloud-cli-github.png\" alt=\"UpCloud CLI on GitHub\" class=\"wp-image-20952\" \/><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\">Cheatsheet<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Here&#8217;s an overview of the various commands and their parameters UpCloud CLI supports. The list is not exhaustive and does not include every parameter available.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">You can always get more information about each command using the &#8211;help parameter.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\"># Details on specific command or option\nupctl {command} {option} --help\n\n# Cloud Servers\nserver list\nserver show {uuid|hostname}\nserver create --hostname {hostname} --zone {zone} --ssh-keys {ssh-public-key}\nserver start {uuid|hostname}\nserver restart {uuid|hostname}\nserver stop {uuid|hostname} [--type {soft|hard}]\nserver delete {uuid|hostname} [--delete-storages]\nserver storage attach {uuid|hostname} --storage {storage-uuid}\nserver storage detach {uuid|hostname} --address {virtio[0-9]}\nserver network-interface create {uuid|hostname} --network {uuid|name} \\\n       --type {public|utility|private} --family {IPv4|IPv6}\n\n# Storage devices\nstorage list\nstorage show {uuid|title}\nstorage clone {uuid|title} --tier {maxiops|hdd} --title {name} --zone {zone}\nstorage create --title {name} --size {int} --zone {zone} --tier {maxiops|hdd}\nstorage delete {uuid|title}\nstorage backup {uuid|title}\nstorage import {url}\nstorage modify {uuid|title}\nstorage templatise {uuid|title}\n\n# Static and floating IP addresses\nip-address list\nip-address show {ip|ptr}\nip-address assign [--floating] --zone {zone}\nip-address modify {ip-address} --mac {mac-address}\nip-address remove {ip-address}\n\n# SDN and Utility networks\nnetwork list\nnetwork show {uuid|name}\nnetwork create --name {name} --zone {zone} --ip-network {address-range}\nnetwork modify {uuid|name}\nnetwork delete {uuid|name}\n\n# SDN Routers\nrouter list\nrouter show {uuid|name}\nrouter create --name {name}\nrouter modify {uuid|name}\nrouter delete {uuid|name}\n\n# Other commands\naccount show  # Display account credits and resource limits\ncompletion    # Generate shell completion code\nhelp          # Help about any command\nversion       # Display software version<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Note that some commands, especially those making changes to Cloud Server network interfaces require the target to be shut down beforehand.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Get started<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Want to take the UpCloud CLI out for a spin? Head over to our tutorial for instructions on <a rel=\"noreferrer noopener\" href=\"https:\/\/upcloud.com\/global\/community\/tutorials\/get-started-upcloud-command-line-interface\/\" target=\"_blank\">how to install the CLI and details on basic commands<\/a>. Follow along with the tutorial to get a feel for the features and for ideas on how you might integrate the CLI into your workflow.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><a href=\"https:\/\/upcloud.com\/global\/community\/tutorials\/get-started-upcloud-command-line-interface\/\">Get started with UpCloud CLI <\/a>today and take a shortcut to the pole position!<\/p>\n","protected":false},"featured_media":21010,"template":"","tools-category":[298,301],"class_list":["post-3067","tools","type-tools","status-publish","has-post-thumbnail","hentry","tools-category-command-line","tools-category-management"],"acf":[],"_links":{"self":[{"href":"https:\/\/upcloud.com\/global\/wp-json\/wp\/v2\/tools\/3067","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/upcloud.com\/global\/wp-json\/wp\/v2\/tools"}],"about":[{"href":"https:\/\/upcloud.com\/global\/wp-json\/wp\/v2\/types\/tools"}],"version-history":[{"count":0,"href":"https:\/\/upcloud.com\/global\/wp-json\/wp\/v2\/tools\/3067\/revisions"}],"wp:attachment":[{"href":"https:\/\/upcloud.com\/global\/wp-json\/wp\/v2\/media?parent=3067"}],"wp:term":[{"taxonomy":"tools-category","embeddable":true,"href":"https:\/\/upcloud.com\/global\/wp-json\/wp\/v2\/tools-category?post=3067"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}