Morpheus CLI v6.1.1
Getting Started¶
The Morpheus CLI is a command line interface for the Morpheus appliance. It’s a ruby gem that provides the morpheus executable. It works by making HTTP requests to the Morpheus API.
The Morpheus CLI is written in Ruby and requires ruby 2.5 or newer to be installed. Most UNIX-based systems will have this installed already.
Installation¶
Installing on Linux¶
A Prerequisite to running the Morpheus CLI is to have ruby 2.5 or newer installed. Use rubygems https://rvm.io/ to install the cli.
gem install morpheus-cli
In most cases, installing Morpheus CLI is as simple as installing from rubygems as discussed above. When installing on RHEL 8, ensure the following three dependencies are also installed:
gem install bigdecimal
gem install json
gem install io-console
Once the gem is installed, all the cli commands can be run on the shell via the morpheus executable.
Installing on Windows¶
The morpheus cli is capable of running on many platforms due to its ruby runtime. This includes windows based platforms. To get started, we must first ensure ruby is installed. To do this please visit http://rubyinstaller.org/downloads and download at least Ruby version 2.5.1 of the Ruby+Devkit (2.7.x recommended).
NOTE: When installing ruby on windows, make sure the options are selected for adding the ruby binaries to your PATH.
Now that ruby is installed, simply open a PowerShell window and run
gem install morpheus-cli --no-document
The –no-document option is relatively new and can be achieved in previous versions of rubygems by using –no-rdoc –no-ri instead.
A list of installed dependencies should start sliding by the screen. Once this has completed the CLI setup is complete. Now all that must be done is configuring the cli to point to an appliance for use.
morpheus remote add dev https://10.0.2.2 --insecure
The –insecure option tells the cli to ignore SSL errors for this remote appliance.
Credentials are used to acquire an access token which is then stored in the users home directory in a folder called .morpheus. Now all commands provided by the CLI are available for use just as if running in a *nix based environment.
Guides¶
Getting Started: https://github.com/gomorpheus/morpheus-cli/wiki/Getting-Started
Managing Instances: https://github.com/gomorpheus/morpheus-cli/wiki/Managing-Instances
Helpful Resources¶
To learn more about Morpheus Data, visit https://www.morpheusdata.com
For additional tips on using Morpheus CLI, visit https://github.com/gomorpheus/morpheus-cli/wiki/Getting-Started
To learn more about the Morpheus API, visit https://apidocs.morpheusdata.com
Global Options¶
There are several global options available.
-v, --version Print the version.
--noprofile Do not read and execute the personal initialization script .morpheus_profile
-C, --nocolor Disable ANSI coloring
-V, --debug Print extra output for debugging.
-h, --help Print this help
Common Options¶
There are many common options that are supported by a most commands.
-O, --option OPTION Option value in the format -O var="value" (deprecated soon in favor of first class options)
-N, --no-prompt Skip prompts. Use default values for all optional fields.
--payload FILE Payload from a local JSON or YAML file, skip all prompting
--payload-dir DIRECTORY Payload from a local directory containing 1-N JSON or YAML files, skip all prompting
--payload-json JSON Payload JSON, skip all prompting
--payload-yaml YAML Payload YAML, skip all prompting
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it
--curl Dry Run to output API request as a curl command.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-H, --header HEADER Additional HTTP header to include with requests.
--timeout SECONDS Timeout for api requests. Default is typically 30 seconds.
-y, --yes Auto Confirm
-q, --quiet No Output, do not print to stdout
Command Format¶
morpheus [command] [<args>] [options]
We divide morpheus into commands. Every morpheus command may have 0-N subcommands that it supports. Commands generally map to the functionality provided in the Morpheus UI.
You can get help for any morpheus command by using the -h option.
The available commands and their options are also documented below.
Command List¶
Usage: morpheus [command] [options]
Commands:
access-token
activity
alias
appliance-settings
approvals
apps
archives
backup-services
backup-settings
benchmark
blueprints
budgets
catalog
certificates
clients
clouds
clusters
containers
credential-types
credentials
curl
cypher
dashboard
datastores
deploy
deployments
deploys
edit-profile
edit-rc
environments
execute-schedules
execution-request
file-copy-request
forgot
groups
guidance
guidance-settings
health
hosts
image-builder
instance-types
instances
integrations
invoices
jobs
key-pairs
library-cluster-layouts
library-file-templates
library-instance-types
library-layouts
library-node-types
library-option-lists
library-option-types
library-scripts
library-spec-templates
library-upgrades
license
load-balancer-monitors
load-balancer-pool-nodes
load-balancer-pools
load-balancer-profiles
load-balancer-types
load-balancer-virtual-servers
load-balancers
log-settings
login
logout
logs
monitor-alerts
monitor-apps
monitor-checks
monitor-contacts
monitor-groups
monitor-incidents
monitor-settings
network-dhcp-relays
network-dhcp-servers
network-domains
network-edge-clusters
network-firewalls
network-floating-ips
network-groups
network-pool-servers
network-pools
network-proxies
network-routers
network-server-groups
network-services
network-static-routes
network-transport-zones
networks
passwd
ping
plugins
policies
power-schedules
price-sets
prices
process
projects
provisioning-licenses
provisioning-settings
remote
reports
resource-folders
resource-pool-groups
resource-pools
roles
scale-thresholds
search
security-groups
security-package-types
security-packages
security-scans
self-service
service-plans
setup
shell
snapshots
storage-buckets
storage-server-types
storage-servers
storage-volume-types
storage-volumes
subnets
tasks
tenants
update
usage
user-groups
user-settings
user-sources
users
vdi
vdi-allocations
vdi-apps
vdi-gateways
vdi-pools
version
view
virtual-images
whitelabel-settings
whoami
wiki
workflows
Options:
-e, --exec EXPRESSION Execute the command(s) expression. This is an alternative to passing [command] [options]
--noprofile Do not read and execute the personal initialization script .morpheus_profile
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time after the command is finished.
-V, --debug Print extra output for debugging.
-v, --version Print the version.
-h, --help Print this help
For more information, see https://clidocs.morpheusdata.com
access-token¶
Usage: morpheus access-token [command] [options]
Commands:
details
get
refresh
access-token details¶
Usage: morpheus access-token details
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-q, --quiet No Output, do not print to stdout
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Print your current authentication credentials.
This contains tokens that should be kept secret. Be careful.
access-token get¶
Usage: morpheus access-token get
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-q, --quiet No Output, do not print to stdout
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Print your current access token.
This token should be kept secret. Be careful.
access-token refresh¶
Usage: morpheus access-token refresh
-T, --token TOKEN Refresh Token to use. The saved credentials are used by default.
-y, --yes Auto Confirm
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-j, --json JSON Output
-q, --quiet No Output, do not print to stdout
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Use the refresh token in your saved credentials, or a provided token.
This will replace your current access and refresh tokens with a new values.
Your current access token will be invalidated
All other users or applications with access to your token will need to update to the new token.
activity¶
Usage: morpheus activity [command] [options]
Commands:
list
activity list¶
Usage: morpheus activity list
-a, --details Display more details object id, full date and time, etc.
-t, --type TYPE Activity Type eg. Provisioning, Admin
--timeframe TIMEFRAME Timeframe, eg. hour,day,today,yesterday,week,month,3months. Default is month
--start TIMESTAMP Start date to search for activity, can be used instead of --timeframe. Default is a month ago.
--end TIMESTAMP Start date to search for activity. Default is the current time.
-u, --user USER User Name or ID
--tenant TENANT Tenant Name or ID
-m, --max MAX Max Results
-o, --offset OFFSET Offset Results
-s, --search PHRASE Search Phrase
-S, --sort ORDER Sort Order. DIRECTION may be included as "ORDER [asc|desc]".
-D, --desc Descending Sort Direction.
--reverse Reverse order of results. This invert is done by the client, not necessarily the entire dataset.
-Q, --query PARAMS Query parameters. PARAMS format is 'foo=bar&category=web'
-j, --json JSON Output
-y, --yaml YAML Output
--csv CSV Output
--quotes Wrap CSV values with ". Default: false
--no-header Exclude header for CSV Output.
-f, --fields x,y,z Filter Output to a limited set of fields. Default is all fields for json,csv,yaml.
--all-fields Show all fields present in the data.
--wrap Wrap table columns instead hiding them when terminal is not wide enough.
--select x,y,z Filter Output to just print the value(s) of specific fields.
--delimiter [CHAR] Delimiter for output values. Default: ',', use with --select and --csv
--newline [CHAR] Delimiter for output rows. Default: '\n', use with --select and --csv
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
List activity.
The default timeframe a month ago up until now, with the most recent activity seen first.
The option --timeframe or --start and --end can be used to customized the date period
alias¶
Usage: morpheus alias [command] [options]
Commands:
add
export
list
remove
Aliases for commands
alias add¶
Usage: morpheus alias add [name]='[command]'
-e, --export Export this alias to your .morpheus_profile for future use
-h, --help Print this help
Define a new alias.
[name] is required. This is the alias name. It should be one word.
[command] is required. This is the full command wrapped in quotes.
Aliases can be exported for future use with the -e option.
The `alias add` command can be invoked with `alias [name]=[command]`
Examples:
alias cloud=clouds
alias ij='instances get -j'
alias new-hosts='hosts list -S id -D'
For more information, see https://github.com/gomorpheus/morpheus-cli/wiki/Alias
alias export¶
Usage: morpheus alias export [alias] [alias2] [alias3]
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Export an alias, saving it to your .morpheus_profile for future use
alias list¶
Usage: morpheus alias list
-f, --format FORMAT The format for the output: export, json, list, table (default).
-e, --export Include the '-e' switch after each alias in the output. This implies --format export.
-m, --max MAX Max Results
-o, --offset OFFSET Offset Results
-s, --search PHRASE Search Phrase
-S, --sort ORDER Sort Order. DIRECTION may be included as "ORDER [asc|desc]".
-D, --desc Descending Sort Direction.
--reverse Reverse order of results. This invert is done by the client, not necessarily the entire dataset.
-j, --json JSON Output
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Print list of defined aliases.
Use the --format option to vary output.
The `alias list` command can be abbreviated as just `alias`.
For more information, see https://github.com/gomorpheus/morpheus-cli/wiki/Alias
alias remove¶
Usage: morpheus alias remove [alias1] [alias2]
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
This is how you remove alias definitions from your .morpheus_profile
appliance-settings¶
Usage: morpheus appliance-settings [command] [options]
Commands:
get
reindex
toggle-maintenance
update
appliance-settings get¶
Usage: morpheus appliance-settings get
-Q, --query PARAMS Query parameters. PARAMS format is 'foo=bar&category=web'
-j, --json JSON Output
-y, --yaml YAML Output
--csv CSV Output
--quotes Wrap CSV values with ". Default: false
--no-header Exclude header for CSV Output.
-f, --fields x,y,z Filter Output to a limited set of fields. Default is all fields for json,csv,yaml.
--all-fields Show all fields present in the data.
--wrap Wrap table columns instead hiding them when terminal is not wide enough.
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Get appliance settings.
appliance-settings reindex¶
Usage: morpheus appliance-settings reindex
-y, --yes Auto Confirm
-O, --option OPTION Option in the format -O field="value"
--prompt Always prompt for input on every option, even those not prompted for by default.
-N, --no-prompt No prompt, skips all input prompting.
--payload FILE Payload from a local JSON or YAML file, skip all prompting
--payload-json JSON Payload JSON, skip all prompting
--payload-yaml YAML Payload YAML, skip all prompting
-j, --json JSON Output
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Reindex all search data.
appliance-settings toggle-maintenance¶
Usage: morpheus appliance-settings toggle-maintenance
--enabled [on|off] Enabled (on) or Disabled (off)
-y, --yes Auto Confirm
-O, --option OPTION Option in the format -O field="value"
--prompt Always prompt for input on every option, even those not prompted for by default.
-N, --no-prompt No prompt, skips all input prompting.
--payload FILE Payload from a local JSON or YAML file, skip all prompting
--payload-json JSON Payload JSON, skip all prompting
--payload-yaml YAML Payload YAML, skip all prompting
-j, --json JSON Output
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Toggle maintenance mode.
appliance-settings update¶
Usage: morpheus appliance-settings update
--appliance-url STRING Appliance URL
--internal-appliance-url STRING
Internal appliance URL (PXE)
--api-allowed-origins STRING API allowed origins
--registration-enabled [on|off]
Tenant registration enabled
--default-tenant-role ROLE Default tenant role authority or ID
--default-user-role ROLE Default user role authority or ID
--docker-privileged-mode [on|off]
Docker privileged mode
--expire-pwd-days NUMBER Expire password after specified days. Set to 0 to disable this feature
--disable-after-attempts NUMBER
Disable user after attempts. Set to 0 to disable this feature
--disable-after-days-inactive NUMBER
Disable user if inactive for specified days. Set to 0 to disable this feature
--warn-user-days-before NUMBER
Send warning email before deactivating. Set to 0 to disable this feature
--smtp-from-email STRING From email address
--smtp-server STRING SMTP server / host
--smtp-port NUMBER SMTP port
--smtp-ssl [on|off] Use SSL for SMTP connections
--smtp-tls [on|off] Use TLS for SMTP connections
--smtp-user STRING SMTP user
--smtp-password STRING SMTP password
--proxy-host STRING Proxy host
--proxy-port NUMBER Proxy port
--proxy-user STRING Proxy user
--proxy-password STRING Proxy password
--proxy-domain STRING Proxy domain
--proxy-workstation STRING Proxy workstation
--currency-provider STRING Currency provider
--currency-key STRING Currency provider API key
--enable-all-clouds Set all cloud types enabled status on, can be used in conjunction with --disable-clouds
--enable-clouds LIST List of cloud types to set enabled status on, each item can be either name or ID
--disable-clouds LIST List of cloud types to set enabled status off, each item can be either name or ID
--disable-all-clouds Set all cloud types enabled status off, can be used in conjunction with --enable-clouds options
--stats-retainment-period DAYS
Stats retainment period. The number of days stats should be available. Can be 30, 60, or 90.
-j, --json JSON Output
--payload FILE Payload from a local JSON or YAML file, skip all prompting
--payload-json JSON Payload JSON, skip all prompting
--payload-yaml YAML Payload YAML, skip all prompting
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-q, --quiet No Output, do not print to stdout
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
approvals¶
Usage: morpheus approvals [command] [options]
Commands:
approve
cancel
deny
get
list
approvals approve¶
Usage: morpheus approvals [id]
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-q, --quiet No Output, do not print to stdout
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Approve item.
[id] is required. Approval item ID
approvals cancel¶
Usage: morpheus approvals [id]
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-q, --quiet No Output, do not print to stdout
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Cancel item.
[id] is required. Approval item ID
approvals deny¶
Usage: morpheus approvals [id]
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-q, --quiet No Output, do not print to stdout
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Deny item.
[id] is required. Approval item ID
approvals get¶
Usage: morpheus approvals get [approval]
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Get details about a job.
[approval] is required. Approval ID or name
approvals list¶
Usage: morpheus approvals list
-m, --max MAX Max Results
-o, --offset OFFSET Offset Results
-s, --search PHRASE Search Phrase
-S, --sort ORDER Sort Order. DIRECTION may be included as "ORDER [asc|desc]".
-D, --desc Descending Sort Direction.
--reverse Reverse order of results. This invert is done by the client, not necessarily the entire dataset.
-Q, --query PARAMS Query parameters. PARAMS format is 'foo=bar&category=web'
-j, --json JSON Output
-y, --yaml YAML Output
--csv CSV Output
--quotes Wrap CSV values with ". Default: false
--no-header Exclude header for CSV Output.
-f, --fields x,y,z Filter Output to a limited set of fields. Default is all fields for json,csv,yaml.
--all-fields Show all fields present in the data.
--wrap Wrap table columns instead hiding them when terminal is not wide enough.
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
List approvals.
apps¶
Usage: morpheus apps [command] [options]
Commands:
add
add-instance
apply
apply-security-groups
cancel-removal
count
get
history
list
logs
refresh
remove
remove-instance
restart
security-groups
start
state
stop
update
update-wiki
view
wiki
View and manage apps.
apps add¶
Usage: morpheus apps add [name] [options]
-b, --blueprint BLUEPRINT Blueprint Name or ID. The default value is 'existing' which means no blueprint, for creating a blank app and adding existing instances.
-g, --group GROUP Group Name or ID
-c, --cloud CLOUD Default Cloud Name or ID.
--name VALUE Name
-l, --labels [LIST] Labels
--description VALUE Description
-e, --environment VALUE Environment Name
--validate Validate Only. Validates the configuration and skips creating it.
--refresh [SECONDS] Refresh until status is running,failed. Default interval is 30 seconds.
-O, --option OPTION Option in the format -O field="value"
--prompt Always prompt for input on every option, even those not prompted for by default.
-N, --no-prompt No prompt, skips all input prompting.
--payload FILE Payload from a local JSON or YAML file, skip all prompting
--payload-json JSON Payload JSON, skip all prompting
--payload-yaml YAML Payload YAML, skip all prompting
-j, --json JSON Output
-y, --yaml YAML Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-q, --quiet No Output, do not print to stdout
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Create a new app.
[name] is required. This is the name of the new app. It may also be passed as --name or inside your config.
apps add-instance¶
Usage: morpheus apps add-instance [app] [instance] [tier]
-O, --option OPTION Option in the format -O field="value"
--prompt Always prompt for input on every option, even those not prompted for by default.
-N, --no-prompt No prompt, skips all input prompting.
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Add an existing instance to an app.
[app] is required. This is the name or id of an app.
[instance] is required. This is the name or id of an instance.
[tier] is required. This is the name of the tier.
apps apply¶
Usage: morpheus apps apply [app] [options]
-p, --parameter NAME=VALUE Template parameter name and value
--refresh [SECONDS] Refresh until execution is complete. Default interval is 5 seconds.
--no-refresh Do not refresh
--no-validate Do not validate planned changes before apply
--validate-only Only validate planned changes, do not execute the apply command.
-y, --yes Auto Confirm
-O, --option OPTION Option in the format -O field="value"
--prompt Always prompt for input on every option, even those not prompted for by default.
-N, --no-prompt No prompt, skips all input prompting.
--payload FILE Payload from a local JSON or YAML file, skip all prompting
--payload-json JSON Payload JSON, skip all prompting
--payload-yaml YAML Payload YAML, skip all prompting
-j, --json JSON Output
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Apply an app.
[app] is required. This is the name or id of an app.
This is only supported by certain types of apps such as terraform.
By default this executes two requests to validate and then apply the changes.
The first request corresponds to the terraform plan command only.
Use --no-validate to skip this step apply changes in one step.
apps apply-security-groups¶
Usage: morpheus apps apply-security-groups [app] [--clear] [-s]
-c, --clear Clear all security groups
-s, --secgroups SECGROUPS Apply the specified comma separated security group ids
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
apps cancel-removal¶
Usage: morpheus apps cancel-removal [app]
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-q, --quiet No Output, do not print to stdout
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
apps count¶
Usage: morpheus apps count [options]
--owner USER Owner Username or ID
-s, --search PHRASE Search Phrase
-Q, --query PARAMS Query parameters. PARAMS format is 'foo=bar&category=web'
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Get the number of apps.
apps get¶
Usage: morpheus apps get [app]
--refresh [SECONDS] Refresh until status is running,failed. Default interval is 30 seconds.
--refresh-until STATUS Refresh until a specified status is reached.
-Q, --query PARAMS Query parameters. PARAMS format is 'foo=bar&category=web'
-j, --json JSON Output
-y, --yaml YAML Output
--csv CSV Output
--quotes Wrap CSV values with ". Default: false
--no-header Exclude header for CSV Output.
-f, --fields x,y,z Filter Output to a limited set of fields. Default is all fields for json,csv,yaml.
--all-fields Show all fields present in the data.
--wrap Wrap table columns instead hiding them when terminal is not wide enough.
--select x,y,z Filter Output to just print the value(s) of specific fields.
--delimiter [CHAR] Delimiter for output values. Default: ',', use with --select and --csv
--newline [CHAR] Delimiter for output rows. Default: '\n', use with --select and --csv
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Get details about an app.
[app] is required. This is the name or id of an app. Supports 1-N [app] arguments.
apps history¶
Usage: morpheus apps history [app]
--events Display sub processes (events).
--output Display process output.
--details Display more details. Shows everything, untruncated.
-m, --max MAX Max Results
-o, --offset OFFSET Offset Results
-s, --search PHRASE Search Phrase
-S, --sort ORDER Sort Order. DIRECTION may be included as "ORDER [asc|desc]".
-D, --desc Descending Sort Direction.
--reverse Reverse order of results. This invert is done by the client, not necessarily the entire dataset.
-Q, --query PARAMS Query parameters. PARAMS format is 'foo=bar&category=web'
-j, --json JSON Output
-y, --yaml YAML Output
--csv CSV Output
--quotes Wrap CSV values with ". Default: false
--no-header Exclude header for CSV Output.
-f, --fields x,y,z Filter Output to a limited set of fields. Default is all fields for json,csv,yaml.
--all-fields Show all fields present in the data.
--wrap Wrap table columns instead hiding them when terminal is not wide enough.
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
List historical processes for a specific app.
[app] is required. This is the name or id of an app.
apps list¶
Usage: morpheus apps list
-t, --type TYPE Filter by type
--blueprint BLUEPRINT Blueprint Name or ID
--owner USER Owner Username or ID
--pending-removal Include apps pending removal.
--pending-removal-only Only apps pending removal.
--environment ENV Filter by environment code (appContext)
--status STATUS Filter by status.
-l, --labels LABEL Filter by labels, can match any of the values
--all-labels LABEL Filter by labels, must match all of the values
-a, --details Display all details: memory and storage usage used / max values.
-m, --max MAX Max Results
-o, --offset OFFSET Offset Results
-s, --search PHRASE Search Phrase
-S, --sort ORDER Sort Order. DIRECTION may be included as "ORDER [asc|desc]".
-D, --desc Descending Sort Direction.
--reverse Reverse order of results. This invert is done by the client, not necessarily the entire dataset.
-Q, --query PARAMS Query parameters. PARAMS format is 'foo=bar&category=web'
-j, --json JSON Output
-y, --yaml YAML Output
--csv CSV Output
--quotes Wrap CSV values with ". Default: false
--no-header Exclude header for CSV Output.
-f, --fields x,y,z Filter Output to a limited set of fields. Default is all fields for json,csv,yaml.
--all-fields Show all fields present in the data.
--wrap Wrap table columns instead hiding them when terminal is not wide enough.
--select x,y,z Filter Output to just print the value(s) of specific fields.
--delimiter [CHAR] Delimiter for output values. Default: ',', use with --select and --csv
--newline [CHAR] Delimiter for output rows. Default: '\n', use with --select and --csv
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
List apps.
apps logs¶
Usage: morpheus apps logs [app]
-n, --node NODE_ID Scope logs to specific Container or VM
--start TIMESTAMP Start timestamp. Default is 30 days ago.
--end TIMESTAMP End timestamp. Default is now.
--level VALUE Log Level. DEBUG,INFO,WARN,ERROR
--table Format ouput as a table.
-a, --all Display all details: entire message.
-m, --max MAX Max Results
-o, --offset OFFSET Offset Results
-s, --search PHRASE Search Phrase
-S, --sort ORDER Sort Order. DIRECTION may be included as "ORDER [asc|desc]".
-D, --desc Descending Sort Direction.
--reverse Reverse order of results. This invert is done by the client, not necessarily the entire dataset.
-Q, --query PARAMS Query parameters. PARAMS format is 'foo=bar&category=web'
-j, --json JSON Output
-y, --yaml YAML Output
--csv CSV Output
--quotes Wrap CSV values with ". Default: false
--no-header Exclude header for CSV Output.
-f, --fields x,y,z Filter Output to a limited set of fields. Default is all fields for json,csv,yaml.
--all-fields Show all fields present in the data.
--wrap Wrap table columns instead hiding them when terminal is not wide enough.
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
List logs for an app.
[app] is required. This is the name or id of an app.
apps refresh¶
Usage: morpheus apps refresh [app] [options]
-y, --yes Auto Confirm
-O, --option OPTION Option in the format -O field="value"
--prompt Always prompt for input on every option, even those not prompted for by default.
-N, --no-prompt No prompt, skips all input prompting.
--payload FILE Payload from a local JSON or YAML file, skip all prompting
--payload-json JSON Payload JSON, skip all prompting
--payload-yaml YAML Payload YAML, skip all prompting
-j, --json JSON Output
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Refresh an app.
[app] is required. This is the name or id of an app.
This is only supported by certain types of apps.
apps remove¶
Usage: morpheus apps remove [app]
--remove-instances [on|off] Remove instances. Default is off.
--preserve-volumes [on|off] Preserve Volumes. Default is off. Applies to certain types only.
--keep-backups Preserve copy of backups
--release-ips [on|off] Release Floating IPs. Default is on. Applies to certain types only. Only applies when used with --remove-instances
-f, --force Force Delete
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-q, --quiet No Output, do not print to stdout
-y, --yes Auto Confirm
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Delete an app.
[app] is required. This is the name or id of an app.
apps remove-instance¶
Usage: morpheus apps remove-instance [app] [instance]
-O, --option OPTION Option in the format -O field="value"
--prompt Always prompt for input on every option, even those not prompted for by default.
-N, --no-prompt No prompt, skips all input prompting.
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Remove an instance from an app.
[app] is required. This is the name or id of an app.
[instance] is required. This is the name or id of an instance.
apps restart¶
Usage: morpheus apps restart [app]
-y, --yes Auto Confirm
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-q, --quiet No Output, do not print to stdout
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Restart an app.
[app] is required. This is the name or id of an app. Supports 1-N [app] arguments.
apps security-groups¶
Usage: morpheus apps security-groups [app]
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
apps start¶
Usage: morpheus apps start [app]
-y, --yes Auto Confirm
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-q, --quiet No Output, do not print to stdout
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Start an app.
[app] is required. This is the name or id of an app. Supports 1-N [app] arguments.
apps state¶
Usage: morpheus apps state [app] [options]
--data Display State Data
--specs Display Spec Templates
--plan Display Plan Data
--input Display Input
--output Display Output
-a, --all Display All Details
-Q, --query PARAMS Query parameters. PARAMS format is 'foo=bar&category=web'
-j, --json JSON Output
-y, --yaml YAML Output
--csv CSV Output
--quotes Wrap CSV values with ". Default: false
--no-header Exclude header for CSV Output.
-f, --fields x,y,z Filter Output to a limited set of fields. Default is all fields for json,csv,yaml.
--all-fields Show all fields present in the data.
--wrap Wrap table columns instead hiding them when terminal is not wide enough.
--select x,y,z Filter Output to just print the value(s) of specific fields.
--delimiter [CHAR] Delimiter for output values. Default: ',', use with --select and --csv
--newline [CHAR] Delimiter for output rows. Default: '\n', use with --select and --csv
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
View state of an app.
[app] is required. This is the name or id of an app.
This is only supported by certain types of apps such as terraform.
apps stop¶
Usage: morpheus apps stop [app]
-y, --yes Auto Confirm
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-q, --quiet No Output, do not print to stdout
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Stop an app.
[app] is required. This is the name or id of an app. Supports 1-N [app] arguments.
apps update¶
Usage: morpheus apps update [app] [options]
-g, --group GROUP Group Name or ID
--name VALUE Name
-l, --labels [LIST] Labels
--description VALUE Description
--environment VALUE Environment
--owner USER Owner Username or ID
-O, --option OPTION Option in the format -O field="value"
--prompt Always prompt for input on every option, even those not prompted for by default.
-N, --no-prompt No prompt, skips all input prompting.
--payload FILE Payload from a local JSON or YAML file, skip all prompting
--payload-json JSON Payload JSON, skip all prompting
--payload-yaml YAML Payload YAML, skip all prompting
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Update an app.
[app] is required. This is the name or id of an app.
apps update-wiki¶
Usage: morpheus apps update-wiki [app] [options]
--name VALUE Name (optional) - The name of the wiki page for this instance. Default is the instance name.
--content VALUE Content (optional) - The content (markdown) of the wiki page.
--file FILE File containing the wiki content. This can be used instead of --content
--clear Clear current page content
-O, --option OPTION Option in the format -O field="value"
--prompt Always prompt for input on every option, even those not prompted for by default.
-N, --no-prompt No prompt, skips all input prompting.
--payload FILE Payload from a local JSON or YAML file, skip all prompting
--payload-json JSON Payload JSON, skip all prompting
--payload-yaml YAML Payload YAML, skip all prompting
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
apps view¶
Usage: morpheus apps view [app]
-w, --wiki Open the wiki tab for this app
--tab VALUE Open a specific tab
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
View an app in a web browser
[app] is required. This is the name or id of an app. Supports 1-N [app] arguments.
apps wiki¶
Usage: morpheus apps wiki [app]
--view View wiki page in web browser.
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
View wiki page details for an app.
[app] is required. This is the name or id of an app.
archives¶
Usage: morpheus archives [command] [options]
Commands:
add
add-file-link
download
download-bucket
download-link
file
file-history
file-links
get
list
list-files
ls
read
remove
remove-file
remove-file-link
rm
update
upload
archives add¶
Usage: morpheus archives add [options]
--name VALUE Name
--description VALUE Description
--storageProvider VALUE Storage Provider ID
--visibility [private|public]
Visibility determines if read access is restricted to the specified Tenants (Private) or all tenants (Public).
--accounts LIST Tenant Accounts (comma separated ids)
--isPublic [on|off] Enabling Public URL allows files to be downloaded without any authentication.
-O, --option OPTION Option in the format -O field="value"
--prompt Always prompt for input on every option, even those not prompted for by default.
-N, --no-prompt No prompt, skips all input prompting.
--payload FILE Payload from a local JSON or YAML file, skip all prompting
--payload-json JSON Payload JSON, skip all prompting
--payload-yaml YAML Payload YAML, skip all prompting
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-q, --quiet No Output, do not print to stdout
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Create a new archive bucket.
archives add-file-link¶
Usage: morpheus archives add-file-link [bucket:/path]
-e, --expire SECONDS The time to live for this link. The default is 1200 (20 minutes). A value less than 1 means never expire.
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-q, --quiet No Output, do not print to stdout
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Create a public link to a file.
[bucket:/path] is required. This is the name of the bucket and /path the file or folder to be fetched.
archives download¶
Usage: morpheus archives download [bucket:/path] [local-file]
-f, --force Overwrite existing [local-file] if it exists.
--mkdir Create missing directories for [local-file] if they do not exist.
-p, --public Use Public Download URL instead of Private. The file must be in a public archives.
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-q, --quiet No Output, do not print to stdout
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Download an archive file or directory.
[bucket:/path] is required. This is the name of the bucket and /path the file or folder to be downloaded.
[local-file] is required. This is the full local filepath for the downloaded file.
Directories will be downloaded as a .zip file, so you'll want to specify a [local-file] with a .zip extension.
archives download-bucket¶
Usage: morpheus archives download-bucket [bucket] [local-file]
-f, --force Overwrite existing [local-file] if it exists.
-p, --mkdir Create missing directories for [local-file] if they do not exist.
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-q, --quiet No Output, do not print to stdout
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Download an entire archive bucket as a .zip file.
[bucket] is required. This is the name of the bucket.
[local-file] is required. This is the full local filepath for the downloaded file.
Buckets are be downloaded as a .zip file, so you'll want to specify a [local-file] with a .zip extension.
archives download-link¶
Usage: morpheus archives download-link [link-key] [local-file]
-f, --force Overwrite existing [local-file] if it exists.
-p, --mkdir Create missing directories for [local-file] if they do not exist.
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-q, --quiet No Output, do not print to stdout
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Download an archive file link.
[link-key] is required. This is the secret access key for the archive file link.
[local-file] is required. This is the full local filepath for the downloaded file.
archives file¶
Usage: morpheus archives file [bucket:/path]
-L, --all-links Display all links instead of only 10.
--all-history Display all history instead of only 10.
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Get details about an archive file.
[bucket:/path] is required. This is the name of the bucket and /path the file or folder to be fetched.
[id] can be passed instead of [bucket:/path]. This is the numeric File ID.
archives file-history¶
Usage: morpheus archives file-history [bucket:/path]
-m, --max MAX Max Results
-o, --offset OFFSET Offset Results
-s, --search PHRASE Search Phrase
-S, --sort ORDER Sort Order. DIRECTION may be included as "ORDER [asc|desc]".
-D, --desc Descending Sort Direction.
--reverse Reverse order of results. This invert is done by the client, not necessarily the entire dataset.
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
List history log events for an archive file.
archives file-links¶
Usage: morpheus archives file-links [bucket:/path]
-m, --max MAX Max Results
-o, --offset OFFSET Offset Results
-s, --search PHRASE Search Phrase
-S, --sort ORDER Sort Order. DIRECTION may be included as "ORDER [asc|desc]".
-D, --desc Descending Sort Direction.
--reverse Reverse order of results. This invert is done by the client, not necessarily the entire dataset.
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
List links for an archive file.
archives get¶
Usage: morpheus archives get [bucket:/path]
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Display archive bucket details and files.
The [bucket] component of the argument is the name or id of an archive bucket.
The [:/path] component is optional and can be used to display files under a sub-directory.
archives list¶
Usage: morpheus archives list
-m, --max MAX Max Results
-o, --offset OFFSET Offset Results
-s, --search PHRASE Search Phrase
-S, --sort ORDER Sort Order. DIRECTION may be included as "ORDER [asc|desc]".
-D, --desc Descending Sort Direction.
--reverse Reverse order of results. This invert is done by the client, not necessarily the entire dataset.
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
List archive buckets.
archives list-files¶
Usage: morpheus archives list-files [bucket:/path]
-a, --all Show all files, including subdirectories under the /path.
-m, --max MAX Max Results
-o, --offset OFFSET Offset Results
-s, --search PHRASE Search Phrase
-S, --sort ORDER Sort Order. DIRECTION may be included as "ORDER [asc|desc]".
-D, --desc Descending Sort Direction.
--reverse Reverse order of results. This invert is done by the client, not necessarily the entire dataset.
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
List files in an archive bucket.
Include [/path] to show files under a directory.
archives ls¶
Usage: morpheus archives ls [bucket/path]
-a, --all Show all files, including subdirectories under the /path.
-l, --long Lists files in the long format, which contains lots of useful information, e.g. the exact size of the file, the file type, and when it was last modified.
--human Humanized file sizes. The default is just the number of bytes.
-1, --oneline One file per line. The default delimiter is a single space.
-m, --max MAX Max Results
-o, --offset OFFSET Offset Results
-s, --search PHRASE Search Phrase
-S, --sort ORDER Sort Order. DIRECTION may be included as "ORDER [asc|desc]".
-D, --desc Descending Sort Direction.
--reverse Reverse order of results. This invert is done by the client, not necessarily the entire dataset.
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Print filenames for a given archive location.
Pass archive location in the format bucket/path.
archives read¶
Usage: morpheus archives read [bucket:/path]
-y, --yes Auto Confirm
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Print the contents of an archive file.
[bucket:/path] is required. This is the name of the bucket and /path the file or folder to be downloaded.
Confirmation is needed if the specified file is more than 1KB.
This confirmation can be skipped with the -y option.
archives remove¶
Usage: morpheus archives remove [bucket]
-y, --yes Auto Confirm
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
archives remove-file¶
Usage: morpheus archives remove-file [bucket:/path]
-R, --recursive Delete a directory and all of its files. This must be passed if specifying a directory.
-y, --yes Auto Confirm
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Delete an archive file or directory.
archives remove-file-link¶
Usage: morpheus archives remove-file-link [bucket:/path] [token]
-y, --yes Auto Confirm
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-q, --quiet No Output, do not print to stdout
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Delete a public link to a file.
[bucket:/path] is required. This is the name of the bucket and /path the file or folder to be fetched.[token] is required. This is the secret access key that identifies the link.
archives rm¶
Usage: morpheus archives remove-file [bucket:/path]
-R, --recursive Delete a directory and all of its files. This must be passed if specifying a directory.
-y, --yes Auto Confirm
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Delete an archive file or directory.
archives update¶
Usage: morpheus archives update [bucket] [options]
--name VALUE Name
--description VALUE Description
--payload-file FILE JSON Payload from a local file
--visibility [private|public]
Visibility determines if read access is restricted to the specified Tenants (Private) or all tenants (Public).
--accounts LIST Tenant Accounts (comma separated ids)
--isPublic [on|off] Enabling Public URL allows files to be downloaded without any authentication.
-O, --option OPTION Option in the format -O field="value"
--prompt Always prompt for input on every option, even those not prompted for by default.
-N, --no-prompt No prompt, skips all input prompting.
--payload FILE Payload from a local JSON or YAML file, skip all prompting
--payload-json JSON Payload JSON, skip all prompting
--payload-yaml YAML Payload YAML, skip all prompting
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-q, --quiet No Output, do not print to stdout
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Update an existing archive bucket.
archives upload¶
Usage: morpheus archives upload [local-file] [bucket:/path]
-R, --recursive Upload a directory and all of its files. This must be passed if [local-file] is a directory.
--ignore-files PATTERN Pattern of files to be ignored when uploading a directory.
-y, --yes Auto Confirm
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Upload a local file or folder to an archive bucket.
The first argument [local-file] should be the path of a local file or directory.
The second argument [bucket:/path] should contain the bucket name.
The [:/path] component is optional and can be used to specify the destination of the uploaded file or folder.
The default destination is the same name as the [local-file], under the root bucket directory '/'.
This will overwrite any existing remote files that match the destination /path.
backup-services¶
Usage: morpheus backup-services [command] [options]
Commands:
add
get
list
remove
update
View and manage backup services.
backup-services add¶
Usage: morpheus backup-services add [name]
-t, --type TYPE Backup Service Type
-O, --option OPTION Option in the format -O field="value"
--prompt Always prompt for input on every option, even those not prompted for by default.
-N, --no-prompt No prompt, skips all input prompting.
--payload FILE Payload from a local JSON or YAML file, skip all prompting
--payload-json JSON Payload JSON, skip all prompting
--payload-yaml YAML Payload YAML, skip all prompting
-j, --json JSON Output
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Create a new backup service.
[name] is required. This is the name of the new backup service.
backup-services get¶
Usage: morpheus backup-services get [backup service]
-Q, --query PARAMS Query parameters. PARAMS format is 'foo=bar&category=web'
-j, --json JSON Output
-y, --yaml YAML Output
--csv CSV Output
--quotes Wrap CSV values with ". Default: false
--no-header Exclude header for CSV Output.
-f, --fields x,y,z Filter Output to a limited set of fields. Default is all fields for json,csv,yaml.
--all-fields Show all fields present in the data.
--wrap Wrap table columns instead hiding them when terminal is not wide enough.
--select x,y,z Filter Output to just print the value(s) of specific fields.
--delimiter [CHAR] Delimiter for output values. Default: ',', use with --select and --csv
--newline [CHAR] Delimiter for output rows. Default: '\n', use with --select and --csv
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Get details about a backup service.
[backup service] is required. This is the name or id of a backup service.
backup-services list¶
Usage: morpheus backup-services list [search]
-m, --max MAX Max Results
-o, --offset OFFSET Offset Results
-s, --search PHRASE Search Phrase
-S, --sort ORDER Sort Order. DIRECTION may be included as "ORDER [asc|desc]".
-D, --desc Descending Sort Direction.
--reverse Reverse order of results. This invert is done by the client, not necessarily the entire dataset.
-Q, --query PARAMS Query parameters. PARAMS format is 'foo=bar&category=web'
-j, --json JSON Output
-y, --yaml YAML Output
--csv CSV Output
--quotes Wrap CSV values with ". Default: false
--no-header Exclude header for CSV Output.
-f, --fields x,y,z Filter Output to a limited set of fields. Default is all fields for json,csv,yaml.
--all-fields Show all fields present in the data.
--wrap Wrap table columns instead hiding them when terminal is not wide enough.
--select x,y,z Filter Output to just print the value(s) of specific fields.
--delimiter [CHAR] Delimiter for output values. Default: ',', use with --select and --csv
--newline [CHAR] Delimiter for output rows. Default: '\n', use with --select and --csv
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
List backup services.
[search] is optional. This is a search phrase to filter the results.
backup-services remove¶
Usage: morpheus backup-services remove [backup service]
-y, --yes Auto Confirm
-Q, --query PARAMS Query parameters. PARAMS format is 'foo=bar&category=web'
-j, --json JSON Output
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Delete an existing backup service.
[backup service] is required. This is the name or id of a backup service.
backup-services update¶
Usage: morpheus backup-services update [backup service] [options]
-O, --option OPTION Option in the format -O field="value"
--prompt Always prompt for input on every option, even those not prompted for by default.
-N, --no-prompt No prompt, skips all input prompting.
--payload FILE Payload from a local JSON or YAML file, skip all prompting
--payload-json JSON Payload JSON, skip all prompting
--payload-yaml YAML Payload YAML, skip all prompting
-j, --json JSON Output
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Update an existing backup service.
[backup service] is required. This is the name or id of a backup service.
backup-settings¶
Usage: morpheus backup-settings [command] [options]
Commands:
get
update
backup-settings get¶
Usage: morpheus backup-settings get
-Q, --query PARAMS Query parameters. PARAMS format is 'foo=bar&category=web'
-j, --json JSON Output
-y, --yaml YAML Output
--csv CSV Output
--quotes Wrap CSV values with ". Default: false
--no-header Exclude header for CSV Output.
-f, --fields x,y,z Filter Output to a limited set of fields. Default is all fields for json,csv,yaml.
--all-fields Show all fields present in the data.
--wrap Wrap table columns instead hiding them when terminal is not wide enough.
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Get backup settings.
backup-settings update¶
Usage: morpheus backup-settings update
-a, --active [on|off] Can be used to enable / disable the scheduled backups. Default is on
--create-backups [on|off] Can be used to enable / disable create backups. Default is on
--backup-appliance [on|off] Can be use to enable / disable backup appliance. Default is on
-b, --bucket BUCKET Default storage bucket name or ID
--clear-bucket Use this flag to clear default backup bucket
-u, --update-existing Use this flag to update existing backups with new settings
-s, --backup-schedule ID Backup schedule type ID
--clear-schedule Use this flag to clear default backup schedule
-R, --retention NUMBER Maximum number of successful backups to retain
-j, --json JSON Output
--payload FILE Payload from a local JSON or YAML file, skip all prompting
--payload-json JSON Payload JSON, skip all prompting
--payload-yaml YAML Payload YAML, skip all prompting
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-q, --quiet No Output, do not print to stdout
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Update your backup settings.
benchmark¶
Usage: morpheus benchmark [command] [options]
Commands:
exec Benchmark a specified command or expression.
off Disable global benchmarking.
off? Print the value of the global benchmark setting. Exit 0 if off.
on Enable global benchmarking.
on? Print the value of the global benchmark setting. Exit 0 if on.
start Start recording a benchmark.
status Print status of benchmark.
stop Stop recording a benchmark.
benchmark exec¶
Usage: morpheus benchmark exec [command...]
-n, --iterations NUMBER Number of iterations to run. The default is 1.
--name NAME Name for the benchmark. Default is the command itself.
-q, --quiet No Output, do not print to stdout
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Benchmark a specified command or expression.
[command] is required. This is the command to execute
benchmark off¶
Usage: morpheus benchmark off
-q, --quiet No Output, do not print to stdout
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Disable global benchmarking.
The default state for this setting is off.
benchmark off?¶
Usage: morpheus benchmark off?
-q, --quiet No Output, do not print to stdout
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Print the value of the global benchmark setting. Exit 0 if off.
Exit 0 if off.
benchmark on¶
Usage: morpheus benchmark on
-q, --quiet No Output, do not print to stdout
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Enable global benchmarking.
This behaves the same as if you were to add the -B switch to every command.
benchmark on?¶
Usage: morpheus benchmark on?
-q, --quiet No Output, do not print to stdout
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Print the value of the global benchmark setting. Exit 0 if on.
Exit 0 if on.
benchmark start¶
Usage: morpheus benchmark start [name]
-q, --quiet No Output, do not print to stdout
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Start recording a benchmark.
[name] is required. This is just a name for the routine.
This allows you to record how long it takes to run a series of commands.
Just run `benchmark stop` when you are finished.
benchmark status¶
Usage: morpheus benchmark status [name]
-q, --quiet No Output, do not print to stdout
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Print status of benchmark.
[name] is optional. This is the name of the benchmark to inspect.
The last benchmark is used by default.
benchmark stop¶
Usage: morpheus benchmark stop [name]
--exit CODE Exit code to end benchmark with. Default is 0 to indicate success.
--error ERROR Error message to include with a benchmark that failed.
-q, --quiet No Output, do not print to stdout
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Stop recording a benchmark.
[name] is optional. This is the name of the benchmark to stop.
The last benchmark is used by default.
blueprints¶
Usage: morpheus blueprints [command] [options]
Commands:
add
add-instance
add-instance-config
add-tier
available-tiers
connect-tiers
disconnect-tiers
duplicate
get
list
remove
remove-instance
remove-instance-config
remove-tier
types
update
update-permissions
update-tier
upload-image
blueprints add¶
Usage: morpheus blueprints add [name] [options]
--name VALUE Name - Enter a name for this app
--description VALUE Description (optional)
--category VALUE Category (optional)
-t, --type TYPE Blueprint Type. Default is morpheus.
-l, --labels [LIST] Labels
-O, --option OPTION Option in the format -O field="value"
--prompt Always prompt for input on every option, even those not prompted for by default.
-N, --no-prompt No prompt, skips all input prompting.
--payload FILE Payload from a local JSON or YAML file, skip all prompting
--payload-json JSON Payload JSON, skip all prompting
--payload-yaml YAML Payload YAML, skip all prompting
-j, --json JSON Output
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Create a new blueprint.
[name] is required. This is the name of the new blueprint.
blueprints add-instance¶
Usage: morpheus blueprints add-instance [blueprint] [tier] [instance-type]
--name VALUE Instance Name
-O, --option OPTION Option in the format -O field="value"
--prompt Always prompt for input on every option, even those not prompted for by default.
-N, --no-prompt No prompt, skips all input prompting.
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Update a blueprint, adding an instance.
[blueprint] is required. This is the name or id of a blueprint.
[tier] is required and will be prompted for. This is the name of the tier.
[instance-type] is required and will be prompted for. This is the type of instance.
blueprints add-instance-config¶
Usage: morpheus blueprints add-instance-config [blueprint] [tier] [instance]
-g, --group GROUP Group
-c, --cloud CLOUD Cloud
-e, --env ENVIRONMENT Environment
--name VALUE Instance Name
-O, --option OPTION Option in the format -O field="value"
--prompt Always prompt for input on every option, even those not prompted for by default.
-N, --no-prompt No prompt, skips all input prompting.
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Update a blueprint, adding an instance config.
[blueprint] is required. This is the name or id of a blueprint.
[tier] is required. This is the name of the tier.
[instance] is required. This is the type of instance.
blueprints add-tier¶
Usage: morpheus blueprints add-tier [blueprint] [tier]
--name VALUE Tier Name
--bootOrder NUMBER Boot Order
--linkedTiers x,y,z Connected Tiers.
--tierIndex NUMBER Tier Index. Used for Display Order
-O, --option OPTION Option in the format -O field="value"
--prompt Always prompt for input on every option, even those not prompted for by default.
-N, --no-prompt No prompt, skips all input prompting.
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
blueprints available-tiers¶
Usage: morpheus blueprints available-tiers
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
blueprints connect-tiers¶
Usage: morpheus blueprints connect-tiers [blueprint] [Tier1] [Tier2]
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
blueprints disconnect-tiers¶
Usage: morpheus blueprints disconnect-tiers [blueprint] [Tier1] [Tier2]
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
blueprints duplicate¶
Usage: morpheus blueprints duplicate [blueprint] [new name]
-y, --yes Auto Confirm
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Duplicate a blueprint.
[blueprint] is required. This is the name or id of a blueprint.
[new name] is required. This is the name for the clone.
blueprints get¶
Usage: morpheus blueprints get [blueprint]
-c, --config Display raw config only. Default is YAML. Combine with -j for JSON instead.
-Q, --query PARAMS Query parameters. PARAMS format is 'foo=bar&category=web'
-j, --json JSON Output
-y, --yaml YAML Output
--csv CSV Output
--quotes Wrap CSV values with ". Default: false
--no-header Exclude header for CSV Output.
-f, --fields x,y,z Filter Output to a limited set of fields. Default is all fields for json,csv,yaml.
--all-fields Show all fields present in the data.
--wrap Wrap table columns instead hiding them when terminal is not wide enough.
--select x,y,z Filter Output to just print the value(s) of specific fields.
--delimiter [CHAR] Delimiter for output values. Default: ',', use with --select and --csv
--newline [CHAR] Delimiter for output rows. Default: '\n', use with --select and --csv
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Get details about a blueprint.
[blueprint] is required. This is the name or id of a blueprint. Supports 1-N [instance] arguments.
blueprints list¶
Usage: morpheus blueprints list
-t, --type CODE Blueprint Type
--owner USER Owner Username or ID
-l, --labels LABEL Filter by labels, can match any of the values
--all-labels LABEL Filter by labels, must match all of the values
-m, --max MAX Max Results
-o, --offset OFFSET Offset Results
-s, --search PHRASE Search Phrase
-S, --sort ORDER Sort Order. DIRECTION may be included as "ORDER [asc|desc]".
-D, --desc Descending Sort Direction.
--reverse Reverse order of results. This invert is done by the client, not necessarily the entire dataset.
-Q, --query PARAMS Query parameters. PARAMS format is 'foo=bar&category=web'
-j, --json JSON Output
-y, --yaml YAML Output
--csv CSV Output
--quotes Wrap CSV values with ". Default: false
--no-header Exclude header for CSV Output.
-f, --fields x,y,z Filter Output to a limited set of fields. Default is all fields for json,csv,yaml.
--all-fields Show all fields present in the data.
--wrap Wrap table columns instead hiding them when terminal is not wide enough.
--select x,y,z Filter Output to just print the value(s) of specific fields.
--delimiter [CHAR] Delimiter for output values. Default: ',', use with --select and --csv
--newline [CHAR] Delimiter for output rows. Default: '\n', use with --select and --csv
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
List blueprints.
blueprints remove¶
Usage: morpheus blueprints remove [blueprint]
-y, --yes Auto Confirm
-Q, --query PARAMS Query parameters. PARAMS format is 'foo=bar&category=web'
-j, --json JSON Output
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Delete a blueprint.
[blueprint] is required. This is the name or id of a blueprint.
blueprints remove-instance¶
Usage: morpheus blueprints remove-instance [blueprint] [tier] [instance]
-y, --yes Auto Confirm
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Update a blueprint, removing a specified instance.
[blueprint] is required. This is the name or id of a blueprint.
[tier] is required. This is the name of the tier.
[instance] is required. This is the instance identifier, which may be the type, the name, or the index starting with 0.
blueprints remove-instance-config¶
Usage: morpheus blueprints remove-instance-config [blueprint] [tier] [instance] -g GROUP -c CLOUD
-g, --group GROUP Group
-c, --cloud CLOUD Cloud
-e, --env ENV Environment
-y, --yes Auto Confirm
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Update a blueprint, removing a specified instance config.
[blueprint] is required. This is the name or id of a blueprint.
[tier] is required. This is the name of the tier.
[instance] is required. This is the instance identifier, which may be the type, the name, or the index starting with 0.
The config scope is specified with the -g GROUP, -c CLOUD and -e ENV. The -g and -c options are required.
blueprints remove-tier¶
Usage: morpheus blueprints remove-tier [blueprint] [tier]
-y, --yes Auto Confirm
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
blueprints types¶
Usage: morpheus blueprints types
-j, --json JSON Output
-y, --yaml YAML Output
--csv CSV Output
--quotes Wrap CSV values with ". Default: false
--no-header Exclude header for CSV Output.
-f, --fields x,y,z Filter Output to a limited set of fields. Default is all fields for json,csv,yaml.
--all-fields Show all fields present in the data.
--wrap Wrap table columns instead hiding them when terminal is not wide enough.
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
List blueprint types.
blueprints update¶
Usage: morpheus blueprints update [blueprint] [options]
--name VALUE Name (optional) - Enter a name for this app
--category VALUE Category (optional)
--owner USER Owner Username or ID
-l, --labels [LIST] Labels
-O, --option OPTION Option in the format -O field="value"
--prompt Always prompt for input on every option, even those not prompted for by default.
-N, --no-prompt No prompt, skips all input prompting.
--payload FILE Payload from a local JSON or YAML file, skip all prompting
--payload-json JSON Payload JSON, skip all prompting
--payload-yaml YAML Payload YAML, skip all prompting
-j, --json JSON Output
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Update a blueprint.
[blueprint] is required. This is the name or id of a blueprint.
blueprints update-permissions¶
Usage: morpheus blueprints update-permissions [blueprint] [options]
--group-access-all [on|off] Toggle Access for all groups.
--group-access LIST Group Access, comma separated list of group IDs.
--visibility [private|public]
Visibility
--owner USER Owner Username or ID
--name VALUE Name (optional) - Enter a name for this app
--category VALUE Category (optional)
-O, --option OPTION Option in the format -O field="value"
--prompt Always prompt for input on every option, even those not prompted for by default.
-N, --no-prompt No prompt, skips all input prompting.
--payload FILE Payload from a local JSON or YAML file, skip all prompting
--payload-json JSON Payload JSON, skip all prompting
--payload-yaml YAML Payload YAML, skip all prompting
-j, --json JSON Output
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Update a blueprint permissions.
[blueprint] is required. This is the name or id of a blueprint.
blueprints update-tier¶
Usage: morpheus blueprints update-tier [blueprint] [tier]
--name VALUE Tier Name
--bootOrder NUMBER Boot Order
--linkedTiers x,y,z Connected Tiers
--tierIndex NUMBER Tier Index. Used for Display Order
-O, --option OPTION Option in the format -O field="value"
--prompt Always prompt for input on every option, even those not prompted for by default.
-N, --no-prompt No prompt, skips all input prompting.
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
blueprints upload-image¶
Usage: morpheus blueprints upload-image [blueprint] [file]
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-q, --quiet No Output, do not print to stdout
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Upload an image file to be used as the icon for a blueprint.
[blueprint] is required. This is the name or id of a blueprint.
[file] is required. This is the local path of a file to upload [png|jpg|svg].
budgets¶
Usage: morpheus budgets [command] [options]
Commands:
add
get
list
remove
update
budgets add¶
Usage: morpheus budgets add [name] [options]
--name VALUE Name
--description VALUE Description (optional)
--scope VALUE Scope. Default: account
--tenant VALUE Tenant
--user VALUE User
--group VALUE Group
--cloud VALUE Cloud
--year VALUE Period - The period (year) the budget applies, YYYY or 'custom' to enter Start Date and End Date manually. Default: 2023
--startDate VALUE Start Date - The Start Date for custom period budget eg. 2021-01-01
--endDate VALUE End Date - The End Date for custom period budget eg. 2023-12-31 (must be 1, 2 or 3 years from Start Date)
--interval VALUE Interval - The budget interval, determines cost amounts: "year", "quarter" or "month". Default: year
--costs LIST Budget cost amounts, one for each interval in the budget. eg "350" for one year, "25,25,25,100" for quarters, and "10,10,10,10,10,10,10,10,10,10,10,50" for each month
--enabled [on|off] Can be used to disable a policy
-O, --option OPTION Option in the format -O field="value"
--prompt Always prompt for input on every option, even those not prompted for by default.
-N, --no-prompt No prompt, skips all input prompting.
--payload FILE Payload from a local JSON or YAML file, skip all prompting
--payload-json JSON Payload JSON, skip all prompting
--payload-yaml YAML Payload YAML, skip all prompting
-j, --json JSON Output
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Create a budget.
The default period is the current year, eg. "2023"
and the default interval is "year".
Costs can be passed as an array of values, one for each interval. eg. --costs "[999]"
Examples:
budgets add example-budget --interval "year" --costs "[2500]"
budgets add example-qtr-budget --interval "quarter" --costs "[500,500,500,1000]"
budgets add example-monthly-budget --interval "month" --costs "[400,100,100,100,100,100,100,100,100,100,400,800]"
budgets add example-future-budget --year "2022" --interval "year" --costs "[5000]"
budgets add example-custom-budget --year "custom" --interval "year" --start "2021-01-01" --end "2023-12-31" --costs "[2500,5000,10000]"
budgets get¶
Usage: morpheus budgets get [budget]
-Q, --query PARAMS Query parameters. PARAMS format is 'foo=bar&category=web'
-j, --json JSON Output
-y, --yaml YAML Output
--csv CSV Output
--quotes Wrap CSV values with ". Default: false
--no-header Exclude header for CSV Output.
-f, --fields x,y,z Filter Output to a limited set of fields. Default is all fields for json,csv,yaml.
--all-fields Show all fields present in the data.
--wrap Wrap table columns instead hiding them when terminal is not wide enough.
--select x,y,z Filter Output to just print the value(s) of specific fields.
--delimiter [CHAR] Delimiter for output values. Default: ',', use with --select and --csv
--newline [CHAR] Delimiter for output rows. Default: '\n', use with --select and --csv
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Get details about a budget.
[budget] is required. Budget ID or name
budgets list¶
Usage: morpheus budgets list
-m, --max MAX Max Results
-o, --offset OFFSET Offset Results
-s, --search PHRASE Search Phrase
-S, --sort ORDER Sort Order. DIRECTION may be included as "ORDER [asc|desc]".
-D, --desc Descending Sort Direction.
--reverse Reverse order of results. This invert is done by the client, not necessarily the entire dataset.
-Q, --query PARAMS Query parameters. PARAMS format is 'foo=bar&category=web'
-j, --json JSON Output
-y, --yaml YAML Output
--csv CSV Output
--quotes Wrap CSV values with ". Default: false
--no-header Exclude header for CSV Output.
-f, --fields x,y,z Filter Output to a limited set of fields. Default is all fields for json,csv,yaml.
--all-fields Show all fields present in the data.
--wrap Wrap table columns instead hiding them when terminal is not wide enough.
--select x,y,z Filter Output to just print the value(s) of specific fields.
--delimiter [CHAR] Delimiter for output values. Default: ',', use with --select and --csv
--newline [CHAR] Delimiter for output rows. Default: '\n', use with --select and --csv
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
List budgets.
budgets remove¶
Usage: morpheus budgets remove [name]
-y, --yes Auto Confirm
-j, --json JSON Output
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Delete budget.
[budget] is required. Budget ID or name
budgets update¶
Usage: morpheus budgets update [budget] [options]
--name VALUE Name (optional)
--description VALUE Description (optional)
--scope VALUE Scope (optional)
--tenant VALUE Tenant (optional)
--user VALUE User (optional)
--group VALUE Group (optional)
--cloud VALUE Cloud (optional)
--year VALUE Period (optional) - The period (year) the budget applies, YYYY or 'custom' to enter Start Date and End Date manually
--startDate VALUE Start Date (optional) - The Start Date for custom period budget eg. 2021-01-01
--endDate VALUE End Date (optional) - The End Date for custom period budget eg. 2023-12-31 (must be 1, 2 or 3 years from Start Date)
--interval VALUE Interval (optional) - The budget interval, determines cost amounts: "year", "quarter" or "month"
--costs COSTS Budget cost amounts, one for each interval in the budget. eg. [999]
--enabled [on|off] Can be used to disable a policy
-O, --option OPTION Option in the format -O field="value"
--prompt Always prompt for input on every option, even those not prompted for by default.
-N, --no-prompt No prompt, skips all input prompting.
--payload FILE Payload from a local JSON or YAML file, skip all prompting
--payload-json JSON Payload JSON, skip all prompting
--payload-yaml YAML Payload YAML, skip all prompting
-j, --json JSON Output
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time and exit/error after the command is finished.
-V, --debug Print extra output for debugging.
-h, --help Print this help
Update a budget.
[budget] is required. Budget ID or name
catalog¶
Usage: morpheus catalog [command] [options]
Commands:
add
add-order
cart
checkout
clear-cart
dashboard
get
get-type
list
list-types
remove
remove-cart-item
update-cart
Service Catalog Persona: View catalog and manage inventory
catalog add¶
Usage: morpheus catalog add [type] [options]
-t, --type TYPE Catalog Item Type Name or ID
--quantity QUANTITY Quantity for this catalog item. Will be overridden to 1 if quantity not allowed.
--validate Validate Only. Validates the configuration and skips adding the item.
--context [instance|server] Context Type for operational workflow types
--target ID Target Resource (Instance or Server) for operational workflow types
-O, --option OPTION Option in the format -O field="value"
--prompt Always prompt for input on every option, even those not prompted for by default.
-N, --no-prompt No prompt, skips all input prompting.
--payload FILE Payload from a local JSON or YAML file, skip all prompting
--payload-json JSON Payload JSON, skip all prompting
--payload-yaml YAML Payload YAML, skip all prompting
--payloads PATH Payload(s) from one or more local JSON or YAML files, skip all prompting and execute the request 1-N times, once for each file. PATH can be a directory or a file pattern.
--payloads-ignore-error Continue processing payloads if an error occurs. The default behavior is to stop processing when an error occurs.
-j, --json JSON Output
-q, --quiet No Output, do not print to stdout
-d, --dry-run Dry Run, print the API request instead of executing it.
--curl Curl, print the API request as a curl command instead of executing it.
--scrub Mask secrets in output, such as the Authorization header. For use with --curl and --dry-run.
-r, --remote REMOTE Remote name. The current remote is used by default.
--remote-url URL Remote url. This allows adhoc requests instead of using a configured remote.
-T, --token TOKEN Access token for authentication with --remote. Saved credentials are used by default.
-U, --username USERNAME Username for authentication.
-P, --password PASSWORD Password for authentication.
-I, --insecure Allow insecure HTTPS communication. i.e. bad SSL certificate.
-C, --nocolor Disable ANSI coloring
-B, --benchmark Print benchmark time