Skip to content
This repository has been archived by the owner on Aug 26, 2021. It is now read-only.

CLI reference

Lazarin Lazarov edited this page Sep 17, 2018 · 10 revisions

Admiral CLI commands

WARNING: Admiral CLI is deprecated and no longer actively maintained by VMware.

events
login
logout
wait

exec
inspect
logs
ps
restart
rm
run
scale
search
start
stop

inspect
ls
restart
rm
run
start
stop

add
ls
rm
update

ls
rm

decrypt
encrypt
get
inspect
set

add
ls
rm
update

ls
rm
set

add
ls
rm
update

add
create
disable
enable
ls
rm
update

create
inspect
ls
rm

add
inspect
ls
rm
update

add
ls
rm
update

add
ls
rm
update

add
disable
enable
ls
rm
update

clear
inspect
ls
rm

closure
export
import
inspect
ls
rm

admiral (basic)

admiral events

Prints events log.

Usage:
  admiral events [OPTIONS]

Options:
      --clear   Clear all logged events.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral login

Login with username and pass

Usage:
  admiral login [OPTIONS]

Options:
  -p, --pass string     Password.
      --status          Print information about current user.
      --tenant string   *vRA* Tenant.
      --url string      Set URL config property.
  -u, --user string     Username.
      --vra             *vRA* Login in Admiral instance embedded in vRA.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral logout

Logout user

Usage:
  admiral logout [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral wait

Wait until task has finished.

Usage:
  admiral wait [TASK-ID] [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral (container management)

admiral exec

Run a command in a running container.

Usage:
  admiral exec [CONTAINER] [OPTIONS]

Options:
      --cmd string    Command to execute.
  -i, --interactive   Interactive mode.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral inspect

Return low-level information on a container.

Usage:
  admiral inspect [CONTAINER] [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral logs

Fetch the logs of a container

Usage:
  admiral logs [CONTAINER] [OPTIONS]

Options:
  -s, --since int   Since when to show logs. (minutes) (default 15)

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral ps

Lists existing containers.

Usage:
  admiral ps

Options:
  -a, --all            Show all containers.
  -q, --query string   Add query.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral restart

Restart container.

Usage:
  admiral restart [CONTAINER] [OPTIONS]

Options:
      --async   Wait until the task is finished.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral rm

Remove existing container(s).

Usage:
  admiral rm [CONTAINER]... [OPTIONS]

Options:
      --async          Wait until the task is finished.
  -f, --force          Do not prompt asking for remove.
  -q, --query string   Every container that match the query will be removed.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral run

Provision container

Usage:
  admiral run [IMAGE] [OPTIONS]

Options:
      --async                 Wait until the task is finished.
      --cluster-size int32    The number of nodes to be provisioned. (default 1)
      --cmd stringSlice       Commands to run on container start.
      --cpu-shares string     CPU shares.
  -e, --env stringSlice       Set enivornment variables.
  -h, --hostname string       Container host name.
      --log-driver string     Logging driver for container.
      --max-restarts int32    Max restart count on container failures.
  -m, --memory int            Memory limit. Default unit: kb. Units supported: kb/mb/gb. Example: 1024mb
      --memory-swap int       Memory limit. Default unit: kb. Units supported: kb/mb/gb. Example: 1024mb
      --name string           Container name.
      --network-mode string   Driver to manage the Network. (default "bridge")
      --project string        Project ID.
  -p, --publish stringSlice   Publish a container's port(s) to the host. Format: hostPort:containerPort
  -P, --publish-all           Publish all exposed ports to random ports. (default true)
      --restart string        Restart policy to apply. (default "no")
      --timeout int           Set custom task timeout (seconds).
  -v, --volume stringSlice    Bind mount volume
  -w, --workdir string        Working directory inside the container

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral scale

Scale existing container

Usage:
  admiral scale [CONTAINER-ID] [OPTIONS]

Options:
      --async         Wait until the task is finished.
  -c, --count int32   *Required* Nodes count of the resource.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral search

Search for image from which you can provision container.

Usage:
  admiral search [IMAGE-NAME] [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral start

Starts existing container

Usage:
  admiral start [CONTAINER]... [OPTIONS]

Options:
      --async   Wait until the task is finished.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral stop

Stops existing container

Usage:
  admiral stop [CONTAINER] [OPTIONS]

Options:
      --async   Wait until the task is finished.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral app

admiral app inspect

Inspect application for additional info.

Usage:
  admiral app inspect [APPLICATION] [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral app ls

Lists existing applications.

Usage:
  admiral app ls

Options:
  -q, --query string   Add query.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral app restart

Restarts application.

Usage:
  admiral app restart [APPLICATION] [OPTIONS]

Options:
      --async   Wait until the task is finished.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral app rm

Remove existing application

Usage:
  admiral app rm [APPLICATION] [OPTIONS]

Options:
      --async   Wait until the task is finished.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral app run

Provision application from template.

Usage:
  admiral app run [TEMPLATE] [OPTIONS]

Options:
      --async            Wait until the task is finished.
      --file string      Provision template from file.
      --keep             Do not remove template after provisioning.
      --project string   Project ID.
      --timeout int      Set custom task timeout (seconds).

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral app start

Starts existing application

Usage:
  admiral app start [APPLICATION] [OPTIONS]

Options:
      --async   Wait until the task is finished.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral app stop

Stops existing application

Usage:
  admiral app stop [APPLICATION] [OPTIONS]

Options:
      --async   Wait until the task is finished.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral cert

admiral cert add

Add certificate

Usage:
  admiral cert add [OPTIONS]

Options:
  -f, --file string   File to import certificate.
  -u, --url string    Url to import certificate.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral cert ls

Lists existing certificates

Usage:
  admiral cert ls

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral cert rm

Remove certificate.

Usage:
  admiral cert rm [CERTIFICATE] [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral cert update

Update certificate.

Usage:
  admiral cert update [CERTIFICATE] [OPTIONS]

Options:
  -f, --file string   File to import certificate.
  -u, --url string    Url to import certificate. (NOT IMPLEMENTED YET).

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral closure

admiral closure ls

List closures.

Usage:
  admiral closure ls [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral closure rm

Remove closure.

Usage:
  admiral closure rm [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral config

admiral config decrypt

Decrypt text.

Usage:
  admiral config decrypt [TEXT] [OPTIONS]

Options:
      --encryption-key string   File containing encryption key.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral config encrypt

Encrypt text.

Usage:
  admiral config encrypt [TEXT] [OPTIONS]

Options:
      --encryption-key string   File containing encryption key.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral config get

Get value from provided key key.

Usage:
  admiral config get [OPTIONS]

Options:
  -k, --key string   *Required* Key

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral config inspect

Shows current config properties

Usage:
  admiral config inspect [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral config set

Set value to provided key.

Usage:
  admiral config set [OPTIONS]

Options:
  -k, --key string     *Required* Key
  -v, --value string   *Required* Value

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral credentials

admiral credentials add

Add credentials

Usage:
  admiral credentials add [OPTIONS]

Options:
      --cp stringSlice    Add custom properties. Format: key=value
      --name string       *Required* Credentials ID.
      --password string   *Required if using username* Password.
      --private string    *Required if using ceritficates* Location to your private key.
      --public string     *Required if using certificates* Location to your public key.
      --username string   *Required if using username* Username.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral credentials ls

Lists credentials.

Usage:
  admiral credentials ls

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral credentials rm

Removes existing credentials.

Usage:
  admiral credentials rm [CREDENTIALS] [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral credentials update

Update credentials.

Usage:
  admiral credentials update [CREDENTIALS] [OPTIONS]

Options:
      --password string   Password.
      --private string    Location to your private key.
      --public string     Location to your public key.
      --username string   Username.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral custom-properties

admiral custom-properties ls

Lists current properties of given entity.

Usage:
  admiral custom-properties ls [OPTIONS]

Options:
      --credentials string   ID of the credentials that you want to manage custom properties.
      --host string          ID of the host that you want to manage custom properties.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral custom-properties rm

Remove custom property to given entity.

Usage:
  admiral custom-properties rm [OPTIONS]

Options:
      --credentials string   ID of the credentials that you want to manage custom properties.
      --host string          ID of the host that you want to manage custom properties.
  -k, --key stringSlice      *Required* Keys of custom properties.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral custom-properties set

Set custom property to given entity.

Usage:
  admiral custom-properties set [OPTIONS]

Options:
      --credentials string   ID of the credentials that you want to manage custom properties.
      --host string          ID of the host that you want to manage custom properties.
  -k, --key stringSlice      *Required* Keys of custom properties.
  -v, --value stringSlice    *Required* Values of custom properties

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral endpoint

admiral endpoint add

Add endpoint.

Usage:
  admiral endpoint add [command] 

Available Commands:
  aws         Add AWS endpoint.
  azure       Add Azure endpoint.
  vsphere     Add vSphere endpoint.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

Use "admiral endpoint add [command] --help" for more information about a command.

admiral endpoint ls

List endpoints.

Usage:
  admiral endpoint ls [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral endpoint rm

Remove endpoint.

Usage:
  admiral endpoint rm [ENDPOINT] [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral endpoint update

Update endpoint.

Usage:
  admiral endpoint update [command] 

Available Commands:
  aws         Update AWS endpoint.
  azure       Update Azure endpoint.
  vsphere     Update vSphere endpoint.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

Use "admiral endpoint update [command] --help" for more information about a command.

admiral host

admiral host add

Add host

Usage:
  admiral host add [OPTIONS]

Options:
      --accept                     Auto accept if certificate is not trusted.
      --address string             *Required* Address of host.
      --cp stringSlice             Add custom properties. Format: key=value
      --credentials string         Credentials ID.
      --deployment-policy string   DeploymentPolicy ID.
      --password string            *Required if adding new credentials* Password.
      --placement-zone string      Placement zone ID.
      --private string             *Required if adding new credentials* Location to your private key.
      --public string              *Required if adding new credentials* Location to your public key.
      --tag stringSlice            Tags. Input format - key:value
      --username string            *Required if adding new credentials* Username.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral host create

Create docker host.

Usage:
  admiral host create [command] 

Available Commands:
  aws         Create docker host on AWS.
  azure       Create docker host on Azure.
  vsphere     Create docker host on vSphere.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

Use "admiral host create [command] --help" for more information about a command.

admiral host disable

Disable host with address provided.

Usage:
  admiral host disable [HOST] [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral host enable

Enable host with address provided.

Usage:
  admiral host enable [HOST] [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral host ls

Lists existing hosts.

Usage:
  admiral host ls

Options:
  -q, --query string   Add query.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral host rm

Remove existing host.

Usage:
  admiral host rm [HOST] [OPTIONS]

Options:
      --async   Wait until the task is finished.
      --force   Force remove.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral host update

Edit existing hosts.

Usage:
  admiral host update [HOST] [OPTIONS]

Options:
      --accept                     Auto accept if certificate is not trusted.
      --credentials string         New Credentials ID.
      --deployment-policy string   New DeploymentPolicy ID.
      --name string                New host name.
      --placement-zone string      New Placement zone ID.
      --tag-add stringSlice        Tags. Input format - key:value
      --tag-rm stringSlice         Tags. Input format - key:value

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral network

admiral network create

Create a network

Usage:
  admiral network create [NAME] [OPTIONS]

Options:
      --async                  Wait until the task is finished.
      --cp stringSlice         Add custom properties. Format: key=value
  -d, --driver string          Driver to manage the Network.
      --gateway stringSlice    Gateway for the master subnet.
      --host stringSlice       *Required* Hosts IDs.
      --ip-range stringSlice   IP Range
      --ipam-driver string     IPAM driver.
      --subnet stringSlice     Subnet in CIDR format that represents a network segment.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral network inspect

Display detailed network information

Usage:
  admiral network inspect [NETWORK] [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral network ls

Lists existing networks.

Usage:
  admiral network ls

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral network rm

Remove a network(s)

Usage:
  admiral network rm [NETWORK] [OPTIONS]

Options:
      --async   Wait until the task is finished.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral placement

admiral placement add

Add placement

Usage:
  admiral placement add [NAME] [OPTIONS]

Options:
      --cpu-shares string       CPU shares.
      --instances int           Instances.
      --memory-limit string     Memory limit. Default unit: kb. Units supported: kb/mb/gb. Example: 1024mb (default "0kb")
      --placement-zone string   *Required* Placement zone ID.
      --priority string         Priority.
      --project string          Project ID.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral placement inspect

Inspect placement.

Usage:
  admiral placement inspect [PLACEMENT] [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral placement ls

Lists existing placements.

Usage:
  admiral placement ls

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral placement rm

Remove placement

Usage:
  admiral placement rm [PLACEMENT] [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral placement update

Update placement.

Usage:
  admiral placement update [PLACEMENT] [OPTIONS]

Options:
      --cpu-shares int             New CPU shares. (default -1)
      --deployment-policy string   New DeploymentPolicy ID.
      --instances int              New Instances. (default -1)
      --memory-limit string        New Memory limit. Default unit: kb. Units supported: kb/mb/gb. Example: 1024mb (default "0kb")
      --name string                New name
      --placement-zone string      New Placement zone ID.
      --priority int32             New Priority. (default -1)
      --project string             New Project ID.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral placement-zone

admiral placement-zone add

Add placement zone by given name.

Usage:
  admiral placement-zone add [NAME] [OPTIONS]

Options:
  -t, --tag stringSlice            Tags. Input format - key:value
  -T, --tag-to-match stringSlice   Tags to match. Input format - key:value

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral placement-zone ls

Lists existing placement zones.

Usage:
  admiral placement-zone ls

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral placement-zone rm

Removes existing placement zone

Usage:
  admiral placement-zone rm [PLACEMENT-ZONE] [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral placement-zone update

Edit placement zone

Usage:
  admiral placement-zone update [PLACEMENT-ZONE-ID] [OPTIONS]

Options:
      --name string                    New name of placement zone.
  -t, --tag-add stringSlice            Tags. Input format - key:value
      --tag-rm stringSlice             Tags. Input format - key:value
  -T, --tag-to-match-add stringSlice   Tags to match. Input format - key:value
      --tag-to-match-rm stringSlice    Tags to match. Input format - key:value

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral project

admiral project add

Add project.

Usage:
  admiral project add [NAME] [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral project ls

List projects.

Usage:
  admiral project ls [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral project rm

Remove project.

Usage:
  admiral project rm [GROUP] [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral project update

Update project.

Usage:
  admiral project update [PROJECT] [OPTIONS]

Options:
      --name string   New name.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral registry

admiral registry add

Add registry

Usage:
  admiral registry add [NAME] [OPTIONS]

Options:
      --accept               Auto accept if certificate is not trusted.
      --address string       *Required* Registry address.
      --cp stringSlice       Add custom properties. Format: key=value
      --credentials string   *Required if using existing credentials* Credentials ID.
      --password string      *Required if adding new credentials* Password.
      --private string       *Required if adding new credentials* Location to your private key.
      --public string        *Required if adding new credentials* Location to your public key.
      --username string      *Required if adding new credentials* Username.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral registry disable

Disable registry.

Usage:
  admiral registry disable [REGISTRY] [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral registry enable

Enable registry.

Usage:
  admiral registry enable [REGISTRY] [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral registry ls

Lists existing registries.

Usage:
  admiral registry ls

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral registry rm

Remove existing registry.

Usage:
  admiral registry rm [REGISTRY] [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral registry update

Usage:
  admiral registry update [REGISTRY] [OPTIONS]

Options:
      --accept               Auto accept if certificate is not trusted.
      --address string       New address of registry.
      --credentials string   New credentials name.
      --name string          New registry name.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral requests

admiral requests clear

Clear all requests.

Usage:
  admiral requests clear [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral requests inspect

Inspect specific request.

Usage:
  admiral requests inspect [REQUEST-ID] [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral requests ls

Prints request log.

Usage:
  admiral requests ls [OPTIONS]

Options:
      --failed     Show failed only requests.
      --finished   Show finished only requests.
      --started    Show started only requests.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral requests rm

Remove specific request.

Usage:
  admiral requests rm [REQUEST-ID] [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral template

admiral template closure

Perform operations with closure templates.

Usage:
  admiral template closure [command] 

Available Commands:
  ls          List closure descriptions.
  rm          Remove closure description.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

Use "admiral template closure [command] --help" for more information about a command.

admiral template export

Download exported application.

Usage:
  admiral template export [TEMPLATE] [OPTIONS]

Options:
      --file string     *Required* Path to the exported file.
      --format string   File format - vRA/Docker (default "yaml")

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral template import

Import yaml file.

Usage:
  admiral template import [PATH/TO/FILE] [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral template inspect

Inspect template.

Usage:
  admiral template inspect [TEMPLATE] [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral template ls

Lists existing templates.

Usage:
  admiral template ls

Options:
  -q, --query string   Add query.

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.

admiral template rm

Remove template.

Usage:
  admiral template rm [TEMPLATE] [OPTIONS]

Global Flags:
      --insecure       Allow insecure SSL connection to Admiral server.
      --quiet          The output of the commands will be only the expected entity's ID.
      --token string   Authorization token.
      --verbose        Show every request/response json body.
Clone this wiki locally