The Morpheus CLI is a ruby based CLI that provides a lot of functionality out of the box and is rapidly growing in coverage to be able to perform every task that can be performed in the Morpheus UI. It is also a great way to get started in exploring the morpheus API and understanding some of the data model aspects.
A Prerequisite to running the CLI is to have ruby 2.0.0+ installed (2.3.0 recommended). Once the ruby runtime is installed simply use rubygems to install the cli
gem install morpheus-cli. Once the gem is installed all cli commands can be run on the shell via
The first thing that needs to be done after installing the cli is pointing the cli to the appliance. The CLI can be pointed at many appliances and uses the RESTful OAUTH public developer apis to perform tasks. To set this up simply add a remote appliance with the
morpheus remote addcommand
morpheus remote add myappliance https://applianceUrl morpheus remote use myappliance morpheus login
There are several commands available when dealing with configuration of remote appliances. To see what commands are available just type
To get started with the morpheus cli its helpful to use the shell feature (
morpheus shell). The shell provides a handy shell with history and some autocomplete features for learning to use it. All commands mentioned prefixed with
morpheus can be omitted since we are in shell mode.
To confirm that we are hooked into the appliance properly lets check our authentication information:
morpheus> whoami Current User ================== ID: 1 Account: Labs (Master Account) First Name: Demo Last Name: Environment Username: david Email: email@example.com Role: System Admin Remote Appliance ================== Name: demo Url: https://demo.morpheusdata.com Build Version: 2.10.0
Fantastic! We are now ready to start our adventure in the Morpheus CLI. If this command fails please be sure to verify the appliance url entered previously is correct, and also verify the provided credentials are correctly entered.
While the CLI is relatively young there are a ton of features provided with it that can make it very convenient for working with morpheus. There are several base commands with subcommands within for example. Lets look at what happens when we simply type
morpheus on the command line:
Usage: morpheus [command] [options] Commands: remote login logout whoami groups clouds hosts load-balancers shell tasks workflows deployments instances apps app-templates deploy license instance-types security-groups security-group-rules accounts users roles key-pairs virtual-images library version
As you can see the cli is split into sections. Each of. these sections has subcommands available for performing certain actions. For example lets look at `morpheus instances`
morpheus> instances Usage: morpheus instances [list,add,remove,stop,start,restart,backup,run-workflow,stop-service,start-service,restart-service,resize,upgrade,clone,envs,setenv,delenv] [name]
These commands typically make it easier to figure out what command subsets are available and the CLI documentation can provide helpful information in more depth on each command option.
To get started provisioning instances from the CLI a few prerequisite commands must be setup in the CLI. First we must decide what
Group we want to provision into. We can first get a list of available groups to use by running
morpheus groups list
morpheus> groups list Morpheus Groups ================== = Automation - denver => Demo - Multi = Morpheus AWS - US-West = Morpheus Azure - US West = Morpheus Google - Auto = morpheus-approvals - = NIck-Demo - Chicago = San Mateo Hyper-V - San Mateo, CA = San Mateo Nutanix - San Mateo, CA = San Mateo Openstack - San Mateo, CA = San Mateo Servers - San Mateo, CA = San Mateo UCS - San Mateo, CA = San Mateo Vmware - San Mateo, CA = San Mateo Xen - San Mateo, CA = snow-approvals - = SoftLayer - Dallas-9
In the above example the currently active group is
Demo as can be seen by the
=> symbol to the left of the group name. To switch groups simply run:
morpheus groups use "San Mateo Xen"
This now becomes the active group we would like to provision into. Another thing to know before provisioning is we do have to also specify the cloud we want to provision into . This does require the cloud be in the group that is currently active. To see a list of clouds in the relevant group simpyl run:
morpheus clouds list -g [groupName]
This will scope the clouds command to list only clouds in the group specified.
Morpheus makes it very easy to get started provisioning via the CLI. It provides a list of instance-types that can be provisioned via the
instance-types list command. Lets get started by provisioning an ubuntu virtual machine.
morpheus> instances add Usage: morpheus instances add TYPE NAME -g, --group GROUP Group -c, --cloud CLOUD Cloud -O, --option OPTION Option -N, --no-prompt Skip prompts. Use default values for all optional fields. -j, --json JSON Output -d, --dry-run Dry Run, print json without making the actual request. -r, --remote REMOTE Remote Appliance -U, --url REMOTE API Url -u, --username USERNAME Username -p, --password PASSWORD Password -T, --token ACCESS_TOKEN Access Token -C, --nocolor ANSI -V, --debug Print extra output for debugging. -h, --help Prints this help
morpheus> instances add ubuntu MyInstanceName -c "San Mateo Vmware" morpheus> instances add ubuntu -c "San Mateo Vmware" dre-test Layout ['?' for options]: ? * Layout [-O layout=] - Select which configuration of the instance type to be provisioned. Options =============== * Docker Ubuntu Container  * VMware VM  * Existing Ubuntu  Layout ['?' for options]: VMware VM Plan ['?' for options]: ? * Plan [-O servicePlan=] - Choose the appropriately sized plan for this instance Options =============== * Memory: 512MB Storage: 10GB  * Memory: 1GB Storage: 10GB  * Memory: 2GB Storage: 20GB  * Memory: 4GB Storage: 40GB  * Memory: 8GB Storage: 80GB  * Memory: 16GB Storage: 160GB  * Memory: 24GB Storage: 240GB  * Memory: 32GB Storage: 320GB  Plan ['?' for options]: 10 Root Volume Label [root]: Root Volume Size (GB) : Root Datastore ['?' for options]: ? * Root Datastore [-O rootVolume.datastoreId=] - Choose a datastore. Options =============== * Auto - Cluster [autoCluster] * Auto - Datastore [auto] * cluster: labs-ds-cluster - 2.9TB Free  * store: ds-130-root - 178.5GB Free  * store: ds-130-vm - 699.0GB Free  * store: ds-131-root - 191.3GB Free  * store: ds-131-vm - 798.9GB Free  * store: ds-132-root - 191.2GB Free  * store: ds-132-vm - 799.4GB Free  * store: ds-177-root - 399.4GB Free  * store: labs-vm - 2.9TB Free  * store: VeeamBackup_WIN-0JNJSO32KI4 - 5.1GB Free  * store: VeeamBackup_WIN-QGARB6FA1GQ - 2.7GB Free  Root Datastore ['?' for options]: Auto - Cluster Add data volume? (yes/no): no Network ['?' for options]: VM Network Network Interface Type ['?' for options]: E1000 IP Address: Using DHCP Add another network interface? (yes/no): no Public Key (optional) ['?' for options]: Resource Pool ['?' for options]: ? * Resource Pool [-O config.vmwareResourcePoolId=] - Options =============== * Resources [resgroup-56] * Resources / Brian [resgroup-2301] * Resources / Brian / Macbook [resgroup-2302] * Resources / David [resgroup-2158] * Resources / David / Macbook [resgroup-2160] Resource Pool ['?' for options]: resgroup-2160
As can be seen in the example above, the CLI nicely prompts the user for input on required options for provisioning this particular instance type within this particular cloud. It provides capabilities of adding multiple disks and multiple networks in this scenario. It is also posslbe to skip these prompts and provision everything via one command line syntax by using the
-O optionName=value syntax:
morpheus> instances add ubuntu MyInstanceName -c "San Mateo Vmware" -O layout=105 -O servicePlan=10 -O rootVolume.datastoreId=autoCluster
This will cause morpheus cli to skip prompting for input on these prompts. All inputs have an equivalent
-O option that can be passed. To see what that option argument is simply enter
?on the input prompt to get specifics.
Now your VM should be provisioning and status can be checked by simply typing
morpheus instances list.
Most of the
list command types can be queried or paged via the cli. To do this simply look at the help information for the relevant list command
morpheus> instances list -h Usage: morpheus [options] -g, --group GROUP Group Name -m, --max MAX Max Results -o, --offset OFFSET Offset Results -s, --search PHRASE Search Phrase -S, --sort ORDER Sort Order -D, --desc Reverse Sort Order -j, --json JSON Output -r, --remote REMOTE Remote Appliance -U, --url REMOTE API Url -u, --username USERNAME Username -p, --password PASSWORD Password -T, --token ACCESS_TOKEN Access Token -C, --nocolor ANSI -V, --debug Print extra output for debugging. -h, --help Prints this help