Command Line Utilities

From DreamFactory
Jump to: navigation, search
DFEConsoleCommand Line Utilities
m (Reverted edits by JerryAblan (talk) to last revision by Leehicks)
m
Line 14: Line 14:
 
Available commands:
 
Available commands:
 
  ...
 
  ...
dfe
+
dfe
   dfe:blueprint        Generate an instance blueprint
+
   dfe:blueprint        Generates an instance blueprint
   dfe:capsule          Encapsulate a managed instance for direct access
+
   dfe:capsule          Encapsulate a managed instance for direct access.
 
   dfe:cluster          Create, update, delete, and manage clusters
 
   dfe:cluster          Create, update, delete, and manage clusters
 +
  dfe:daily            Performs daily maintenance tasks
 
   dfe:deprovision      Deprovisions, or shuts down, a running instance
 
   dfe:deprovision      Deprovisions, or shuts down, a running instance
 
   dfe:export            Create a portable instance export
 
   dfe:export            Create a portable instance export
   dfe:import            Create an instance from an instance export
+
   dfe:import            Import a portable instance export
   dfe:manifest          Generate a cluster manifest file (.dfe.cluster.json)
+
  dfe:info              Extract information from the system
   dfe:metrics          Gather system metrics
+
   dfe:manifest          Generates a cluster manifest file (.dfe.cluster.json) for DFE installations.
   dfe:migrate-instance  Run database migration for an instance (php artisan migrate)
+
   dfe:metrics          Gather overall system metrics
 +
   dfe:migrate-instance  Run migration for an instance.
 
   dfe:mount            Create, update, and delete mounts
 
   dfe:mount            Create, update, and delete mounts
 +
  dfe:move-instance    Moves an instance from one server to another.
 
   dfe:provision        Provision a new instance
 
   dfe:provision        Provision a new instance
   dfe:register          Create a key pair for use with the console API
+
   dfe:register          Creates a key pair used to communicate with the DFE Console
 
   dfe:server            Create, update, and delete servers
 
   dfe:server            Create, update, and delete servers
   dfe:setup            Initialize a new installation and generate a cluster environment file
+
   dfe:setup            Initializes a new installation and generates a cluster environment file.
   dfe:token            Generate a token for an instance
+
   dfe:token            Generates a token for an instance
   dfe:update            Update the local DFE installation to the latest version
+
   dfe:update            Update DFE Console to the latest version.
 +
  dfe:users            Manage DFE Dashboard users.
 
  ...
 
  ...
 
</pre>
 
</pre>
Line 46: Line 50:
 
       --env[=ENV]                    The environment the command should run under.
 
       --env[=ENV]                    The environment the command should run under.
 
   -v|vv|vvv, --verbose              Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
 
   -v|vv|vvv, --verbose              Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
</pre>
 
  
 
=== Command Types ===
 
=== Command Types ===
There are two basic types of commands: entity and operational. Entity commands manage the logical entities within the [[DFE/Console|Console]]. These commands are '''dfe:cluster''', '''dfe:mount''', and '''dfe:server'''. Operational commands are all the rest. These commands manipulate the entities or the system.
+
There are two basic types of commands: entity and operational. Entity commands manage the logical entities within the [[DFE/Console|Console]]. These commands are `dfe:cluster`, `dfe:mount`, and `dfe:server`. Operational commands are all the rest. These commands manipulate the entities or the system.
 
+
 
 
== dfe:blueprint ==
 
== dfe:blueprint ==
  
* Description: Generates an instance blueprint
+
Usage:
* Usage:
+
  dfe:blueprint [options] [--] <instance-id> [<instance-uri>] [<admin-email>] [<admin-password>]
** '''dfe:blueprint [--no-commit] [-d|--dump] [--] <instance-id> [<instance-uri>] [<admin-email>] [<admin-password>]'''
+
  
Generates an instance blueprint
+
Arguments:
 +
  instance-id            The id of the instance to inspect.
 +
  instance-uri          The URI of the instance (i.e. "http://localhost")
 +
  admin-email            An instance administrator email
 +
  admin-password        An instance administrator password
  
=== Arguments ===
+
Options:
 +
      --no-commit        Do not commit the result to the repo
 +
  -d, --dump            Dump the blueprint to stdout as well as writing to disk
 +
  -k, --api-key=API-KEY  The API key to use instead of auto-generated token
  
'''instance-id:'''
+
Help:
 
+
Generates an instance blueprint
* Name: instance-id
+
* Is required: yes
+
* Is array: no
+
* Description: The id of the instance to inspect.
+
* Default: '''NULL'''
+
 
+
'''instance-uri:'''
+
 
+
* Name: instance-uri
+
* Is required: no
+
* Is array: no
+
* Description: The URI of the instance (i.e. "http://localhost")
+
* Default: '''NULL'''
+
 
+
'''admin-email:'''
+
 
+
* Name: admin-email
+
* Is required: no
+
* Is array: no
+
* Description: An instance administrator email
+
* Default: '''NULL'''
+
 
+
'''admin-password:'''
+
 
+
* Name: admin-password
+
* Is required: no
+
* Is array: no
+
* Description: An instance administrator password
+
* Default: '''NULL'''
+
 
+
=== Options ===
+
 
+
'''no-commit:'''
+
 
+
* Name:  '''--no-commit'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not commit the result to the repo
+
* Default: '''false'''
+
 
+
'''dump:'''
+
 
+
* Name:  '''--dump'''
+
* Shortcut: '''-d'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Dump the blueprint to stdout
+
* Default: '''false'''
+
 
+
'''help:'''
+
 
+
* Name:  '''--help'''
+
* Shortcut: '''-h'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this help message
+
* Default: '''false'''
+
 
+
'''quiet:'''
+
 
+
* Name:  '''--quiet'''
+
* Shortcut: '''-q'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not output any message
+
* Default: '''false'''
+
 
+
'''verbose:'''
+
 
+
* Name:  '''--verbose'''
+
* Shortcut: '''-v|-vv|-vvv'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+
* Default: '''false'''
+
 
+
'''version:'''
+
 
+
* Name:  '''--version'''
+
* Shortcut: '''-V'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this application version
+
* Default: '''false'''
+
 
+
'''ansi:'''
+
 
+
* Name:  '''--ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Force ANSI output
+
* Default: '''false'''
+
 
+
'''no-ansi:'''
+
 
+
* Name:  '''--no-ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Disable ANSI output
+
* Default: '''false'''
+
 
+
'''no-interaction:'''
+
 
+
* Name:  '''--no-interaction'''
+
* Shortcut: '''-n'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not ask any interactive question
+
* Default: '''false'''
+
 
+
'''env:'''
+
 
+
* Name:  '''--env'''
+
* Shortcut: <none>
+
* Accept value: yes
+
* Is value required: no
+
* Is multiple: no
+
* Description: The environment the command should run under.
+
* Default: '''NULL'''
+
  
 
== dfe:capsule ==
 
== dfe:capsule ==
  
* Description: Encapsulate a managed instance for direct access.
+
Usage:
* Usage:
+
  dfe:capsule [options] [--] <instance-id>
** '''dfe:capsule [-d|--destroy] [--] <instance-id>'''
+
  
Encapsulates a managed instance for direct access.
+
Arguments:
 +
  instance-id          The instance to encapsulate
  
=== Arguments ===
+
Options:
 
+
  -d, --destroy         Destroys a previously created capsule.
'''instance-id:'''
+
 
+
* Name: instance-id
+
* Is required: yes
+
* Is array: no
+
* Description: The instance to encapsulate
+
* Default: '''NULL'''
+
 
+
=== Options ===
+
 
+
'''destroy:'''
+
 
+
* Name:  '''--destroy'''
+
* Shortcut: '''-d'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Destroys a previously created capsule.
+
* Default: '''false'''
+
 
+
'''help:'''
+
 
+
* Name:  '''--help'''
+
* Shortcut: '''-h'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this help message
+
* Default: '''false'''
+
 
+
'''quiet:'''
+
 
+
* Name:  '''--quiet'''
+
* Shortcut: '''-q'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not output any message
+
* Default: '''false'''
+
 
+
'''verbose:'''
+
 
+
* Name:  '''--verbose'''
+
* Shortcut: '''-v|-vv|-vvv'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+
* Default: '''false'''
+
 
+
'''version:'''
+
 
+
* Name:  '''--version'''
+
* Shortcut: '''-V'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this application version
+
* Default: '''false'''
+
 
+
'''ansi:'''
+
 
+
* Name:  '''--ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Force ANSI output
+
* Default: '''false'''
+
 
+
'''no-ansi:'''
+
 
+
* Name:  '''--no-ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Disable ANSI output
+
* Default: '''false'''
+
 
+
'''no-interaction:'''
+
 
+
* Name:  '''--no-interaction'''
+
* Shortcut: '''-n'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not ask any interactive question
+
* Default: '''false'''
+
 
+
'''env:'''
+
 
+
* Name:  '''--env'''
+
* Shortcut: <none>
+
* Accept value: yes
+
* Is value required: no
+
* Is multiple: no
+
* Description: The environment the command should run under.
+
* Default: '''NULL'''
+
  
 +
Help:
 +
            The dfe:capsule command encapsulates a managed instance for direct access.
 +
 +
php artisan dfe:capsule <instance-id> [-d|--destroy]
 +
 
== dfe:cluster ==
 
== dfe:cluster ==
  
* Description: Create, update, delete, and manage clusters
+
Usage:
* Usage:
+
  dfe:cluster [options] [--] <operation> [<cluster-id>]
** '''dfe:cluster [--owner-id OWNER-ID] [--owner-type OWNER-TYPE] [--subdomain SUBDOMAIN] [-m|--max-instances MAX-INSTANCES] [--server-id SERVER-ID] [--] <operation> <cluster-id>'''
+
 
+
Create, update, delete, and manage clusters
+
 
+
=== Arguments ===
+
 
+
'''operation:'''
+
 
+
* Name: operation
+
* Is required: yes
+
* Is array: no
+
* Description: The operation to perform: create, update, delete, add (server to cluster), or remove (server from cluster)
+
* Default: '''NULL'''
+
 
+
'''cluster-id:'''
+
 
+
* Name: cluster-id
+
* Is required: yes
+
* Is array: no
+
* Description: The id of the cluster upon which to perform operation
+
* Default: '''NULL'''
+
 
+
=== Options ===
+
 
+
'''owner-id:'''
+
 
+
* Name:  '''--owner-id'''
+
* Shortcut: <none>
+
* Accept value: yes
+
* Is value required: yes
+
* Is multiple: no
+
* Description: The "owner-id" of this cluster
+
* Default: '''NULL'''
+
 
+
'''owner-type:'''
+
 
+
* Name:  '''--owner-type'''
+
* Shortcut: <none>
+
* Accept value: yes
+
* Is value required: yes
+
* Is multiple: no
+
* Description: The type of owner: USER, INSTANCE, SERVER, MOUNT, CLUSTER, SERVICE_USER, OWNER_HASH, CONSOLE, DASHBOARD, APPLICATION, SERVICE, TESTING, _DEFAULT_NAMESPACE_
+
* Default: '''NULL'''
+
 
+
'''subdomain:'''
+
 
+
* Name:  '''--subdomain'''
+
* Shortcut: <none>
+
* Accept value: yes
+
* Is value required: yes
+
* Is multiple: no
+
* Description: The subdomain in which this cluster resides
+
* Default: '''NULL'''
+
 
+
'''max-instances:'''
+
 
+
* Name:  '''--max-instances'''
+
* Shortcut: '''-m'''
+
* Accept value: yes
+
* Is value required: yes
+
* Is multiple: no
+
* Description: The maximum number of instances allowed, if any.
+
* Default: '''NULL'''
+
 
+
'''server-id:'''
+
 
+
* Name:  '''--server-id'''
+
* Shortcut: <none>
+
* Accept value: yes
+
* Is value required: yes
+
* Is multiple: no
+
* Description: The "server-id" to "add" or "remove"
+
* Default: '''NULL'''
+
 
+
'''help:'''
+
 
+
* Name:  '''--help'''
+
* Shortcut: '''-h'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this help message
+
* Default: '''false'''
+
 
+
'''quiet:'''
+
 
+
* Name:  '''--quiet'''
+
* Shortcut: '''-q'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not output any message
+
* Default: '''false'''
+
 
+
'''verbose:'''
+
 
+
* Name:  '''--verbose'''
+
* Shortcut: '''-v|-vv|-vvv'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+
* Default: '''false'''
+
 
+
'''version:'''
+
 
+
* Name:  '''--version'''
+
* Shortcut: '''-V'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this application version
+
* Default: '''false'''
+
 
+
'''ansi:'''
+
  
* Name: '''--ansi'''
+
Arguments:
* Shortcut: <none>
+
  operation                          The operation to perform: show, create, update, delete, add (server to cluster), or remove (server from cluster)
* Accept value: no
+
  cluster-id                        The id of the cluster upon which to perform operation [default: "cluster-gha-1"]
* Is value required: no
+
* Is multiple: no
+
* Description: Force ANSI output
+
* Default: '''false'''
+
  
'''no-ansi:'''
+
Options:
 +
      --owner-id=OWNER-ID            The "owner-id" of this cluster
 +
      --owner-type=OWNER-TYPE        The type of owner: USER, INSTANCE, SERVER, MOUNT, CLUSTER, SERVICE_USER, OWNER_HASH, CONSOLE, DASHBOARD, APPLICATION, SERVICE, TESTING, _DEFAULT_NAMESPACE_
 +
      --subdomain=SUBDOMAIN          The subdomain in which this cluster resides
 +
  -m, --max-instances=MAX-INSTANCES  The maximum number of instances allowed, if any.
 +
      --server-id=SERVER-ID          The "server-id" to "add" or "remove"
  
* Name'''--no-ansi'''
+
Help:
* Shortcut: <none>
+
  Create, update, delete, and manage clusters
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Disable ANSI output
+
* Default: '''false'''
+
  
'''no-interaction:'''
+
== dfe:daily ==
  
* Name: '''--no-interaction'''
+
Usage:
* Shortcut: '''-n'''
+
  dfe:daily [options]
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not ask any interactive question
+
* Default: '''false'''
+
  
'''env:'''
+
Options:
 +
      --dry-run        When specified, no instances will be deprovisioned.
  
* Name'''--env'''
+
Help:
* Shortcut: <none>
+
  Performs daily maintenance tasks
* Accept value: yes
+
* Is value required: no
+
* Is multiple: no
+
* Description: The environment the command should run under.
+
* Default: '''NULL'''
+
  
 
== dfe:deprovision ==
 
== dfe:deprovision ==
  
* Description: Deprovisions, or shuts down, a running instance
+
Usage:
* Usage:
+
  dfe:deprovision [options] [--] <instance-id>
** '''dfe:deprovision [-c|--cluster-id [CLUSTER-ID]] [--] <instance-id>'''
+
  
Deprovisions, or shuts down, a running instance
+
Arguments:
 +
  instance-id                    The instance to deprovision
  
=== Arguments ===
+
Options:
 +
  -c, --cluster-id[=CLUSTER-ID]  The cluster containing the instance [default: "cluster-gha-1"]
 +
  -h, --help                    Display this help message
 +
  -q, --quiet                    Do not output any message
 +
  -V, --version                  Display this application version
 +
      --ansi                    Force ANSI output
 +
      --no-ansi                  Disable ANSI output
 +
  -n, --no-interaction          Do not ask any interactive question
 +
      --env[=ENV]                The environment the command should run under.
 +
  -v|vv|vvv, --verbose          Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  
'''instance-id:'''
+
Help:
 
+
  Deprovisions, or shuts down, a running instance
* Name: instance-id
+
* Is required: yes
+
* Is array: no
+
* Description: The instance to deprovision
+
* Default: '''NULL'''
+
 
+
=== Options ===
+
 
+
'''cluster-id:'''
+
 
+
* Name: '''--cluster-id'''
+
* Shortcut: '''-c'''
+
* Accept value: yes
+
* Is value required: no
+
* Is multiple: no
+
* Description: The cluster containing the instance
+
* Default: ''''cluster-gha-1''''
+
 
+
'''help:'''
+
 
+
* Name:  '''--help'''
+
* Shortcut: '''-h'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this help message
+
* Default: '''false'''
+
 
+
'''quiet:'''
+
 
+
* Name:  '''--quiet'''
+
* Shortcut: '''-q'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not output any message
+
* Default: '''false'''
+
 
+
'''verbose:'''
+
 
+
* Name:  '''--verbose'''
+
* Shortcut: '''-v|-vv|-vvv'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+
* Default: '''false'''
+
 
+
'''version:'''
+
 
+
* Name:  '''--version'''
+
* Shortcut: '''-V'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this application version
+
* Default: '''false'''
+
 
+
'''ansi:'''
+
 
+
* Name:  '''--ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Force ANSI output
+
* Default: '''false'''
+
 
+
'''no-ansi:'''
+
 
+
* Name:  '''--no-ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Disable ANSI output
+
* Default: '''false'''
+
 
+
'''no-interaction:'''
+
 
+
* Name:  '''--no-interaction'''
+
* Shortcut: '''-n'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not ask any interactive question
+
* Default: '''false'''
+
 
+
'''env:'''
+
 
+
* Name:  '''--env'''
+
* Shortcut: <none>
+
* Accept value: yes
+
* Is value required: no
+
* Is multiple: no
+
* Description: The environment the command should run under.
+
* Default: '''NULL'''
+
  
 
== dfe:export ==
 
== dfe:export ==
  
* Description: Create a portable instance export
+
Usage:
* Usage:
+
  dfe:export [options] [--] <instance-id>
** '''dfe:export [-d|--destination [DESTINATION]] [--] <instance-id>'''
+
 
+
Create a portable instance export
+
 
+
=== Arguments ===
+
 
+
'''instance-id:'''
+
 
+
* Name: instance-id
+
* Is required: yes
+
* Is array: no
+
* Description: The instance to export
+
* Default: '''NULL'''
+
 
+
=== Options ===
+
 
+
'''destination:'''
+
 
+
* Name:  '''--destination'''
+
* Shortcut: '''-d'''
+
* Accept value: yes
+
* Is value required: no
+
* Is multiple: no
+
* Description: The path to place the export file.
+
* Default: '''NULL'''
+
 
+
'''help:'''
+
 
+
* Name:  '''--help'''
+
* Shortcut: '''-h'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this help message
+
* Default: '''false'''
+
 
+
'''quiet:'''
+
 
+
* Name:  '''--quiet'''
+
* Shortcut: '''-q'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not output any message
+
* Default: '''false'''
+
 
+
'''verbose:'''
+
 
+
* Name:  '''--verbose'''
+
* Shortcut: '''-v|-vv|-vvv'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+
* Default: '''false'''
+
 
+
'''version:'''
+
 
+
* Name:  '''--version'''
+
* Shortcut: '''-V'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this application version
+
* Default: '''false'''
+
 
+
'''ansi:'''
+
 
+
* Name:  '''--ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Force ANSI output
+
* Default: '''false'''
+
 
+
'''no-ansi:'''
+
 
+
* Name:  '''--no-ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Disable ANSI output
+
* Default: '''false'''
+
 
+
'''no-interaction:'''
+
  
* Name: '''--no-interaction'''
+
Arguments:
* Shortcut: '''-n'''
+
  instance-id                      The instance to export
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not ask any interactive question
+
* Default: '''false'''
+
  
'''env:'''
+
Options:
 +
  -d, --destination[=DESTINATION]  The path to place the export file.
 +
  -h, --help                      Display this help message
 +
  -q, --quiet                      Do not output any message
 +
  -V, --version                    Display this application version
 +
      --ansi                      Force ANSI output
 +
      --no-ansi                    Disable ANSI output
 +
  -n, --no-interaction            Do not ask any interactive question
 +
      --env[=ENV]                  The environment the command should run under.
 +
  -v|vv|vvv, --verbose            Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  
* Name'''--env'''
+
Help:
* Shortcut: <none>
+
  Create a portable instance export
* Accept value: yes
+
* Is value required: no
+
* Is multiple: no
+
* Description: The environment the command should run under.
+
* Default: '''NULL'''
+
  
 
== dfe:import ==
 
== dfe:import ==
  
* Description: Import a portable instance export
+
Usage:
* Usage:
+
  dfe:import [options] [--] <owner-id> <instance-id> <snapshot> [<guest-location>]
** '''dfe:import [-c|--cluster-id [CLUSTER-ID]] [-i|--snapshot-id] [--owner-type OWNER-TYPE] [--] <owner-id> <instance-id> <snapshot> [<guest-location>]'''
+
  
Import a portable instance export
+
Arguments:
 +
  owner-id                      The id of the owner of the new instance
 +
  instance-id                    The name of the new instance
 +
  snapshot                      The path of the snapshot file
 +
  guest-location                The location of the new instance [default: "dreamfactory"]
  
=== Arguments ===
+
Options:
 +
  -c, --cluster-id[=CLUSTER-ID]  The cluster where this instance is to be placed. [default: "cluster-gha-1"]
 +
      --indirect                If specified, the "snapshot" value is a snapshot-id not a path
 +
      --owner-type=OWNER-TYPE    The owner-id of the new instance
 +
Help:
 +
Import a portable instance export
  
'''owner-id:'''
+
== dfe:info ==
  
* Name: owner-id
+
Usage:
* Is required: yes
+
  dfe:info [options] [--] <entity-type> [<entity-id>]
* Is array: no
+
* Description: The id of the owner of the new instance
+
* Default: '''NULL'''
+
  
'''instance-id:'''
+
Arguments:
 +
  entity-type                  The type of entity information to retrieve: mount, server, cluster, instance, or metrics
 +
  entity-id                   The id of the entity-type
  
* Name: instance-id
+
Options:
* Is required: yes
+
  -a, --all                    Return all data, ignoring entity-id
* Is array: no
+
  -s, --start-date=START-DATE  The start date for a range of metrics data
* Description: The name of the new instance
+
  -e, --end-date=END-DATE      The end date for a range of metrics data
* Default: '''NULL'''
+
  -f, --format[=FORMAT]        The format in which to output the information. Available formats are: json or xml
 +
  -u, --ugly                  For formatted output, does not pretty-print output
 +
      --escaped-slashes        For JSON formatted output, slashes will be escaped (default is that they are not)
 +
  -t, --owner-type=OWNER-TYPE  The "owner-type" of the entity (required by "app-key") [default: 0]
 +
  -h, --help                  Display this help message
 +
  -q, --quiet                  Do not output any message
 +
  -V, --version                Display this application version
 +
      --ansi                  Force ANSI output
 +
      --no-ansi                Disable ANSI output
 +
  -n, --no-interaction        Do not ask any interactive question
 +
      --env[=ENV]              The environment the command should run under.
 +
  -v|vv|vvv, --verbose        Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  
'''snapshot:'''
+
Help:
 
+
  Extract information from the system
* Name: snapshot
+
* Is required: yes
+
* Is array: no
+
* Description: The path of the snapshot file
+
* Default: '''NULL'''
+
 
+
'''guest-location:'''
+
 
+
* Name: guest-location
+
* Is required: no
+
* Is array: no
+
* Description: The location of the new instance
+
* Default: ''''dreamfactory''''
+
 
+
=== Options ===
+
 
+
'''cluster-id:'''
+
 
+
* Name: '''--cluster-id'''
+
* Shortcut: '''-c'''
+
* Accept value: yes
+
* Is value required: no
+
* Is multiple: no
+
* Description: The cluster where this instance is to be placed.
+
* Default: ''''cluster-gha-1''''
+
 
+
'''snapshot-id:'''
+
 
+
* Name:  '''--snapshot-id'''
+
* Shortcut: '''-i'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: If specified, the "snapshot" value is a snapshot-id not a path
+
* Default: '''false'''
+
 
+
'''owner-type:'''
+
 
+
* Name:  '''--owner-type'''
+
* Shortcut: <none>
+
* Accept value: yes
+
* Is value required: yes
+
* Is multiple: no
+
* Description: The owner-id of the new instance
+
* Default: '''NULL'''
+
 
+
'''help:'''
+
 
+
* Name:  '''--help'''
+
* Shortcut: '''-h'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this help message
+
* Default: '''false'''
+
 
+
'''quiet:'''
+
 
+
* Name:  '''--quiet'''
+
* Shortcut: '''-q'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not output any message
+
* Default: '''false'''
+
 
+
'''verbose:'''
+
 
+
* Name:  '''--verbose'''
+
* Shortcut: '''-v|-vv|-vvv'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+
* Default: '''false'''
+
 
+
'''version:'''
+
 
+
* Name:  '''--version'''
+
* Shortcut: '''-V'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this application version
+
* Default: '''false'''
+
 
+
'''ansi:'''
+
 
+
* Name:  '''--ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Force ANSI output
+
* Default: '''false'''
+
 
+
'''no-ansi:'''
+
 
+
* Name:  '''--no-ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Disable ANSI output
+
* Default: '''false'''
+
 
+
'''no-interaction:'''
+
 
+
* Name:  '''--no-interaction'''
+
* Shortcut: '''-n'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not ask any interactive question
+
* Default: '''false'''
+
 
+
'''env:'''
+
 
+
* Name:  '''--env'''
+
* Shortcut: <none>
+
* Accept value: yes
+
* Is value required: no
+
* Is multiple: no
+
* Description: The environment the command should run under.
+
* Default: '''NULL'''
+
  
 
== dfe:manifest ==
 
== dfe:manifest ==
  
* Description: Generates a cluster manifest file (.dfe.cluster.json) for DFE installations.
+
Usage:
* Usage:
+
  dfe:manifest [options] [--] <cluster-id> <web-server-id> [<output-file>]
** '''dfe:manifest [-c|--create] [-k|--no-keys] [-s|--show] [--owner-id OWNER-ID] [--owner-type OWNER-TYPE] [--] <cluster-id> <web-server-id> [<output-file>]'''
+
 
+
Generates a cluster manifest file (.dfe.cluster.json) for DFE installations.
+
 
+
=== Arguments ===
+
 
+
'''cluster-id:'''
+
 
+
* Name: cluster-id
+
* Is required: yes
+
* Is array: no
+
* Description: The id/name of the cluster
+
* Default: '''NULL'''
+
 
+
'''web-server-id:'''
+
 
+
* Name: web-server-id
+
* Is required: yes
+
* Is array: no
+
* Description: The id/name of the web server from "cluster-id"
+
* Default: '''NULL'''
+
 
+
'''output-file:'''
+
 
+
* Name: output-file
+
* Is required: no
+
* Is array: no
+
* Description: The /path/to/manifest/file to write. Otherwise it is written to the current working directory.
+
* Default: '''NULL'''
+
 
+
=== Options ===
+
 
+
'''create:'''
+
 
+
* Name:  '''--create'''
+
* Shortcut: '''-c'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Create a new manifest file. This is the default.
+
* Default: '''false'''
+
 
+
'''no-keys:'''
+
 
+
* Name:  '''--no-keys'''
+
* Shortcut: '''-k'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: If specified, no application keys will be generated.
+
* Default: '''false'''
+
 
+
'''show:'''
+
 
+
* Name:  '''--show'''
+
* Shortcut: '''-s'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: If specified, show the contents of an installation's manifest.
+
* Default: '''false'''
+
 
+
'''owner-id:'''
+
 
+
* Name:  '''--owner-id'''
+
* Shortcut: <none>
+
* Accept value: yes
+
* Is value required: yes
+
* Is multiple: no
+
* Description: The owner id for the manifest key if not 0
+
* Default: '''0'''
+
 
+
'''owner-type:'''
+
 
+
* Name:  '''--owner-type'''
+
* Shortcut: <none>
+
* Accept value: yes
+
* Is value required: yes
+
* Is multiple: no
+
* Description: The owner type for the manifest key if not "dashboard"
+
* Default: ''''dashboard''''
+
 
+
'''help:'''
+
 
+
* Name:  '''--help'''
+
* Shortcut: '''-h'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this help message
+
* Default: '''false'''
+
 
+
'''quiet:'''
+
 
+
* Name:  '''--quiet'''
+
* Shortcut: '''-q'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not output any message
+
* Default: '''false'''
+
 
+
'''verbose:'''
+
 
+
* Name:  '''--verbose'''
+
* Shortcut: '''-v|-vv|-vvv'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+
* Default: '''false'''
+
 
+
'''version:'''
+
 
+
* Name:  '''--version'''
+
* Shortcut: '''-V'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this application version
+
* Default: '''false'''
+
 
+
'''ansi:'''
+
 
+
* Name:  '''--ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Force ANSI output
+
* Default: '''false'''
+
 
+
'''no-ansi:'''
+
 
+
* Name:  '''--no-ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Disable ANSI output
+
* Default: '''false'''
+
 
+
'''no-interaction:'''
+
  
* Name: '''--no-interaction'''
+
Arguments:
* Shortcut: '''-n'''
+
  cluster-id                  The id/name of the cluster
* Accept value: no
+
  web-server-id                The id/name of the web server from "cluster-id"
* Is value required: no
+
  output-file                  The /path/to/manifest/file to write. Otherwise it is written to the current working directory.
* Is multiple: no
+
* Description: Do not ask any interactive question
+
* Default: '''false'''
+
  
'''env:'''
+
Options:
 +
  -c, --create                Create a new manifest file. This is the default.
 +
  -k, --no-keys                If specified, no application keys will be generated.
 +
  -s, --show                  If specified, show the contents of an installation's manifest.
 +
      --owner-id=OWNER-ID      The owner id for the manifest key if not 0 [default: 0]
 +
      --owner-type=OWNER-TYPE  The owner type for the manifest key if not "dashboard" [default: "dashboard"]
 +
  -h, --help                  Display this help message
 +
  -q, --quiet                  Do not output any message
 +
  -V, --version                Display this application version
 +
      --ansi                  Force ANSI output
 +
      --no-ansi                Disable ANSI output
 +
  -n, --no-interaction        Do not ask any interactive question
 +
      --env[=ENV]              The environment the command should run under.
 +
  -v|vv|vvv, --verbose        Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  
* Name'''--env'''
+
Help:
* Shortcut: <none>
+
  Generates a cluster manifest file (.dfe.cluster.json) for DFE installations.
* Accept value: yes
+
* Is value required: no
+
* Is multiple: no
+
* Description: The environment the command should run under.
+
* Default: '''NULL'''
+
  
 
== dfe:metrics ==
 
== dfe:metrics ==
  
* Description: Gather overall system metrics
+
Usage:
* Usage:
+
  dfe:metrics [options]
** '''dfe:metrics [--gather] [-f|--to-file TO-FILE] [--console-only] [--dashboard-only] [--instance-only]'''
+
  
Gather overall system metrics
+
Options:
 +
      --gather                        When specified, all metrics are gathered and written to the database. Use when scheduling jobs.
 +
  -f, --to-file=TO-FILE                Write metrics to a file.
 +
      --console-only                  Only gather "console" metrics
 +
      --dashboard-only                Only gather "dashboard" metrics
 +
      --instance-only                  Only gather "dashboard" metrics
 +
      --no-usage-data[=NO-USAGE-DATA]  Do not send usage data if true [default: false]
 +
      --force                          Force overwrite of daily gather
 +
  -h, --help                          Display this help message
 +
  -q, --quiet                          Do not output any message
 +
  -V, --version                        Display this application version
 +
      --ansi                          Force ANSI output
 +
      --no-ansi                        Disable ANSI output
 +
  -n, --no-interaction                Do not ask any interactive question
 +
      --env[=ENV]                      The environment the command should run under.
 +
  -v|vv|vvv, --verbose                Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  
=== Options ===
+
Help:
 
+
  Gather overall system metrics
'''gather:'''
+
 
+
* Name: '''--gather'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: When specified, all metrics are gathered and written to the database. Use when scheduling jobs.
+
* Default: '''false'''
+
 
+
'''to-file:'''
+
 
+
* Name:  '''--to-file'''
+
* Shortcut: '''-f'''
+
* Accept value: yes
+
* Is value required: yes
+
* Is multiple: no
+
* Description: Write metrics to a file.
+
* Default: '''NULL'''
+
 
+
'''console-only:'''
+
 
+
* Name:  '''--console-only'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Only gather "console" metrics
+
* Default: '''false'''
+
 
+
'''dashboard-only:'''
+
 
+
* Name:  '''--dashboard-only'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Only gather "dashboard" metrics
+
* Default: '''false'''
+
 
+
'''instance-only:'''
+
 
+
* Name:  '''--instance-only'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Only gather "dashboard" metrics
+
* Default: '''false'''
+
 
+
'''help:'''
+
 
+
* Name:  '''--help'''
+
* Shortcut: '''-h'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this help message
+
* Default: '''false'''
+
 
+
'''quiet:'''
+
 
+
* Name:  '''--quiet'''
+
* Shortcut: '''-q'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not output any message
+
* Default: '''false'''
+
 
+
'''verbose:'''
+
 
+
* Name:  '''--verbose'''
+
* Shortcut: '''-v|-vv|-vvv'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+
* Default: '''false'''
+
 
+
'''version:'''
+
 
+
* Name:  '''--version'''
+
* Shortcut: '''-V'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this application version
+
* Default: '''false'''
+
 
+
'''ansi:'''
+
 
+
* Name:  '''--ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Force ANSI output
+
* Default: '''false'''
+
 
+
'''no-ansi:'''
+
 
+
* Name:  '''--no-ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Disable ANSI output
+
* Default: '''false'''
+
 
+
'''no-interaction:'''
+
 
+
* Name:  '''--no-interaction'''
+
* Shortcut: '''-n'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not ask any interactive question
+
* Default: '''false'''
+
 
+
'''env:'''
+
 
+
* Name:  '''--env'''
+
* Shortcut: <none>
+
* Accept value: yes
+
* Is value required: no
+
* Is multiple: no
+
* Description: The environment the command should run under.
+
* Default: '''NULL'''
+
  
 
== dfe:migrate-instance ==
 
== dfe:migrate-instance ==
  
* Description: Run migration for an instance.
+
Usage:
* Usage:
+
  dfe:migrate-instance [options] [--] [<instance-id>]
** '''dfe:migrate-instance [-a|--all] [-c|--cluster-id CLUSTER-ID] [-s|--seed] [--] [<instance-id>]'''
+
 
+
Initiates a "php artisan migrate" for an instance under management.
+
 
+
=== Arguments ===
+
 
+
'''instance-id:'''
+
 
+
* Name: instance-id
+
* Is required: no
+
* Is array: no
+
* Description: The instance to migrate
+
* Default: '''NULL'''
+
 
+
=== Options ===
+
 
+
'''all:'''
+
 
+
* Name:  '''--all'''
+
* Shortcut: '''-a'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Migrate *all* cluster instances
+
* Default: '''false'''
+
 
+
'''cluster-id:'''
+
 
+
* Name:  '''--cluster-id'''
+
* Shortcut: '''-c'''
+
* Accept value: yes
+
* Is value required: yes
+
* Is multiple: no
+
* Description: If specified with "--all", will migrate only instances managed by "cluster-id".
+
* Default: '''NULL'''
+
 
+
'''seed:'''
+
 
+
* Name:  '''--seed'''
+
* Shortcut: '''-s'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: If specified, "--seed" will be passed to any "migrate" commands
+
* Default: '''false'''
+
 
+
'''help:'''
+
 
+
* Name:  '''--help'''
+
* Shortcut: '''-h'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this help message
+
* Default: '''false'''
+
 
+
'''quiet:'''
+
 
+
* Name:  '''--quiet'''
+
* Shortcut: '''-q'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not output any message
+
* Default: '''false'''
+
 
+
'''verbose:'''
+
 
+
* Name:  '''--verbose'''
+
* Shortcut: '''-v|-vv|-vvv'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+
* Default: '''false'''
+
 
+
'''version:'''
+
 
+
* Name:  '''--version'''
+
* Shortcut: '''-V'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this application version
+
* Default: '''false'''
+
 
+
'''ansi:'''
+
 
+
* Name:  '''--ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Force ANSI output
+
* Default: '''false'''
+
 
+
'''no-ansi:'''
+
 
+
* Name:  '''--no-ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Disable ANSI output
+
* Default: '''false'''
+
 
+
'''no-interaction:'''
+
  
* Name: '''--no-interaction'''
+
Arguments:
* Shortcut: '''-n'''
+
  instance-id                  The instance to migrate
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not ask any interactive question
+
* Default: '''false'''
+
  
'''env:'''
+
Options:
 +
  -a, --all                    Migrate *all* cluster instances
 +
  -c, --cluster-id=CLUSTER-ID  If specified with "--all", will migrate only instances managed by "cluster-id".
 +
  -s, --seed                  If specified, "--seed" will be passed to any "migrate" commands
 +
  -h, --help                  Display this help message
 +
  -q, --quiet                  Do not output any message
 +
  -V, --version                Display this application version
 +
      --ansi                  Force ANSI output
 +
      --no-ansi                Disable ANSI output
 +
  -n, --no-interaction        Do not ask any interactive question
 +
      --env[=ENV]              The environment the command should run under.
 +
  -v|vv|vvv, --verbose        Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  
* Name'''--env'''
+
Help:
* Shortcut: <none>
+
  Run migration for an instance.
* Accept value: yes
+
* Is value required: no
+
* Is multiple: no
+
* Description: The environment the command should run under.
+
* Default: '''NULL'''
+
  
 
== dfe:mount ==
 
== dfe:mount ==
  
* Description: Create, update, and delete mounts
+
Usage:
* Usage:
+
  dfe:mount [options] [--] <operation> [<mount-id>]
** '''dfe:mount [-t|--mount-type MOUNT-TYPE] [--owner-id OWNER-ID] [--owner-type OWNER-TYPE] [-p|--root-path ROOT-PATH] [-c|--config CONFIG] [--] <operation> <mount-id>'''
+
  
Create, update, and delete mounts
+
Arguments:
 +
  operation                    The operation to perform: show, create, update, or delete
 +
  mount-id                    The id of the mount upon which to perform operation
  
=== Arguments ===
+
Options:
 +
  -t, --mount-type=MOUNT-TYPE  The type of mount: LOCAL, SFTP, S3
 +
      --owner-id=OWNER-ID      The "owner-id" of this mount
 +
      --owner-type=OWNER-TYPE  The type of owner: USER, INSTANCE, SERVER, MOUNT, CLUSTER, SERVICE_USER, OWNER_HASH, CONSOLE, DASHBOARD, APPLICATION, SERVICE, TESTING, _DEFAULT_NAMESPACE_
 +
  -p, --root-path=ROOT-PATH    The "root-path" of the mount
 +
  -c, --config=CONFIG          JSON-encoded array of configuration data for this mount
 +
  -h, --help                  Display this help message
 +
  -q, --quiet                  Do not output any message
 +
  -V, --version                Display this application version
 +
      --ansi                  Force ANSI output
 +
      --no-ansi                Disable ANSI output
 +
  -n, --no-interaction        Do not ask any interactive question
 +
      --env[=ENV]              The environment the command should run under.
 +
  -v|vv|vvv, --verbose        Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  
'''operation:'''
+
Help:
 +
Create, update, and delete mounts
  
* Name: operation
+
== dfe:move-instance ==
* Is required: yes
+
* Is array: no
+
* Description: The operation to perform: create, update, or delete
+
* Default: '''NULL'''
+
  
'''mount-id:'''
+
Usage:
 +
  dfe:move-instance [options] [--] <server-id> [<instance-id>]
  
* Name: mount-id
+
Arguments:
* Is required: yes
+
  server-id                   The destination server of the move
* Is array: no
+
  instance-id                  The instance to move
* Description: The id of the mount upon which to perform operation
+
* Default: '''NULL'''
+
  
=== Options ===
+
Options:
 +
  -a, --all                    Move *all* instances
 +
  -p, --purge                  Purge existing credentials from database. Only used with database server moves.
 +
  -c, --cluster-id=CLUSTER-ID  If specified with "--all", only the instances managed by "cluster-id" will be moved.
 +
  -h, --help                  Display this help message
 +
  -q, --quiet                  Do not output any message
 +
  -V, --version                Display this application version
 +
      --ansi                  Force ANSI output
 +
      --no-ansi                Disable ANSI output
 +
  -n, --no-interaction        Do not ask any interactive question
 +
      --env[=ENV]              The environment the command should run under.
 +
  -v|vv|vvv, --verbose        Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  
'''mount-type:'''
+
Help:
 
+
  Moves an instance from one server to another.
* Name: '''--mount-type'''
+
* Shortcut: '''-t'''
+
* Accept value: yes
+
* Is value required: yes
+
* Is multiple: no
+
* Description: The type of mount: LOCAL, SFTP, S3
+
* Default: '''NULL'''
+
 
+
'''owner-id:'''
+
 
+
* Name:  '''--owner-id'''
+
* Shortcut: <none>
+
* Accept value: yes
+
* Is value required: yes
+
* Is multiple: no
+
* Description: The "owner-id" of this mount
+
* Default: '''NULL'''
+
 
+
'''owner-type:'''
+
 
+
* Name:  '''--owner-type'''
+
* Shortcut: <none>
+
* Accept value: yes
+
* Is value required: yes
+
* Is multiple: no
+
* Description: The type of owner: USER, INSTANCE, SERVER, MOUNT, CLUSTER, SERVICE_USER, OWNER_HASH, CONSOLE, DASHBOARD, APPLICATION, SERVICE, TESTING, _DEFAULT_NAMESPACE_
+
* Default: '''NULL'''
+
 
+
'''root-path:'''
+
 
+
* Name:  '''--root-path'''
+
* Shortcut: '''-p'''
+
* Accept value: yes
+
* Is value required: yes
+
* Is multiple: no
+
* Description: The "root-path" of the mount
+
* Default: '''NULL'''
+
 
+
'''config:'''
+
 
+
* Name:  '''--config'''
+
* Shortcut: '''-c'''
+
* Accept value: yes
+
* Is value required: yes
+
* Is multiple: no
+
* Description: JSON-encoded array of configuration data for this mount
+
* Default: '''NULL'''
+
 
+
'''help:'''
+
 
+
* Name:  '''--help'''
+
* Shortcut: '''-h'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this help message
+
* Default: '''false'''
+
 
+
'''quiet:'''
+
 
+
* Name:  '''--quiet'''
+
* Shortcut: '''-q'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not output any message
+
* Default: '''false'''
+
 
+
'''verbose:'''
+
 
+
* Name:  '''--verbose'''
+
* Shortcut: '''-v|-vv|-vvv'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+
* Default: '''false'''
+
 
+
'''version:'''
+
 
+
* Name:  '''--version'''
+
* Shortcut: '''-V'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this application version
+
* Default: '''false'''
+
 
+
'''ansi:'''
+
 
+
* Name:  '''--ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Force ANSI output
+
* Default: '''false'''
+
 
+
'''no-ansi:'''
+
 
+
* Name:  '''--no-ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Disable ANSI output
+
* Default: '''false'''
+
 
+
'''no-interaction:'''
+
 
+
* Name:  '''--no-interaction'''
+
* Shortcut: '''-n'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not ask any interactive question
+
* Default: '''false'''
+
 
+
'''env:'''
+
 
+
* Name:  '''--env'''
+
* Shortcut: <none>
+
* Accept value: yes
+
* Is value required: no
+
* Is multiple: no
+
* Description: The environment the command should run under.
+
* Default: '''NULL'''
+
  
 
== dfe:provision ==
 
== dfe:provision ==
  
* Description: Provision a new instance
+
Usage:
* Usage:
+
  dfe:provision [options] [--] <owner-id> <instance-id> [<guest-location>]
** '''dfe:provision [-c|--cluster-id [CLUSTER-ID]] [--] <owner-id> <instance-id> [<guest-location>]'''
+
 
+
Provision a new instance
+
 
+
=== Arguments ===
+
 
+
'''owner-id:'''
+
 
+
* Name: owner-id
+
* Is required: yes
+
* Is array: no
+
* Description: The id of the owner of the new instance
+
* Default: '''NULL'''
+
 
+
'''instance-id:'''
+
 
+
* Name: instance-id
+
* Is required: yes
+
* Is array: no
+
* Description: The name of the new instance
+
* Default: '''NULL'''
+
 
+
'''guest-location:'''
+
 
+
* Name: guest-location
+
* Is required: no
+
* Is array: no
+
* Description: The location of the new instance. Values: "amazon", "dreamfactory", "azure", "rackspace", "openstack", "local"
+
* Default: ''''dreamfactory''''
+
 
+
=== Options ===
+
 
+
'''cluster-id:'''
+
 
+
* Name:  '''--cluster-id'''
+
* Shortcut: '''-c'''
+
* Accept value: yes
+
* Is value required: no
+
* Is multiple: no
+
* Description: The cluster where this instance is to be placed.
+
* Default: ''''cluster-gha-1''''
+
 
+
'''help:'''
+
 
+
* Name:  '''--help'''
+
* Shortcut: '''-h'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this help message
+
* Default: '''false'''
+
 
+
'''quiet:'''
+
 
+
* Name:  '''--quiet'''
+
* Shortcut: '''-q'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not output any message
+
* Default: '''false'''
+
 
+
'''verbose:'''
+
 
+
* Name:  '''--verbose'''
+
* Shortcut: '''-v|-vv|-vvv'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+
* Default: '''false'''
+
 
+
'''version:'''
+
 
+
* Name:  '''--version'''
+
* Shortcut: '''-V'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this application version
+
* Default: '''false'''
+
 
+
'''ansi:'''
+
 
+
* Name:  '''--ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Force ANSI output
+
* Default: '''false'''
+
 
+
'''no-ansi:'''
+
 
+
* Name:  '''--no-ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Disable ANSI output
+
* Default: '''false'''
+
 
+
'''no-interaction:'''
+
  
* Name: '''--no-interaction'''
+
Arguments:
* Shortcut: '''-n'''
+
  owner-id                      The id of the owner of the new instance
* Accept value: no
+
  instance-id                    The name of the new instance
* Is value required: no
+
  guest-location                The location of the new instance. Values: "amazon", "dreamfactory", "azure", "rackspace", "openstack", or "local" [default: "dreamfactory"]
* Is multiple: no
+
* Description: Do not ask any interactive question
+
* Default: '''false'''
+
  
'''env:'''
+
Options:
 +
      --owner-type[=OWNER-TYPE]  The "owner-id" type. Values: "0" (user), "1" (instance), "2" (server), "3" (mount), "4" (cluster), "5" (service_user), "6" (owner_hash), "1000" (console), "1001" (dashboard), "1002" (application), "1003" (service), or "9999" (testing) [default: 0]
 +
  -c, --cluster-id[=CLUSTER-ID]  The cluster where this instance is to be placed. [default: "cluster-gha-1"]
 +
  -h, --help                    Display this help message
 +
  -q, --quiet                    Do not output any message
 +
  -V, --version                  Display this application version
 +
      --ansi                    Force ANSI output
 +
      --no-ansi                  Disable ANSI output
 +
  -n, --no-interaction          Do not ask any interactive question
 +
      --env[=ENV]                The environment the command should run under.
 +
  -v|vv|vvv, --verbose          Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  
* Name'''--env'''
+
Help:
* Shortcut: <none>
+
  Provision a new instance
* Accept value: yes
+
* Is value required: no
+
* Is multiple: no
+
* Description: The environment the command should run under.
+
* Default: '''NULL'''
+
  
 
== dfe:register ==
 
== dfe:register ==
  
* Description: Creates a key pair used to communicate with the DFE Console
+
Usage:
* Usage:
+
  dfe:register <owner-id> <owner-type>
** '''dfe:register <owner-id> <owner-type>'''
+
  
Creates a key pair used to communicate with the DFE Console
+
Arguments:
 +
  owner-id              The id of the owner of this key
 +
  owner-type            One of the following owner types: user, instance, server, mount, cluster, service_user, owner_hash, console, dashboard, application, service, or testing
  
=== Arguments ===
+
Options:
 +
  -h, --help            Display this help message
 +
  -q, --quiet          Do not output any message
 +
  -V, --version        Display this application version
 +
      --ansi            Force ANSI output
 +
      --no-ansi        Disable ANSI output
 +
  -n, --no-interaction  Do not ask any interactive question
 +
      --env[=ENV]      The environment the command should run under.
 +
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  
'''owner-id:'''
+
Help:
 
+
Creates a key pair used to communicate with the DFE Console
* Name: owner-id
+
* Is required: yes
+
* Is array: no
+
* Description: The id of the owner of this key
+
* Default: '''NULL'''
+
 
+
'''owner-type:'''
+
 
+
* Name: owner-type
+
* Is required: yes
+
* Is array: no
+
* Description: One of the following owner types: user, instance, server, mount, cluster, service_user, owner_hash, console, dashboard, application, service, testing
+
* Default: '''NULL'''
+
 
+
=== Options ===
+
 
+
'''help:'''
+
 
+
* Name:  '''--help'''
+
* Shortcut: '''-h'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this help message
+
* Default: '''false'''
+
 
+
'''quiet:'''
+
 
+
* Name:  '''--quiet'''
+
* Shortcut: '''-q'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not output any message
+
* Default: '''false'''
+
 
+
'''verbose:'''
+
 
+
* Name:  '''--verbose'''
+
* Shortcut: '''-v|-vv|-vvv'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+
* Default: '''false'''
+
 
+
'''version:'''
+
 
+
* Name:  '''--version'''
+
* Shortcut: '''-V'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this application version
+
* Default: '''false'''
+
 
+
'''ansi:'''
+
 
+
* Name:  '''--ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Force ANSI output
+
* Default: '''false'''
+
 
+
'''no-ansi:'''
+
 
+
* Name:  '''--no-ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Disable ANSI output
+
* Default: '''false'''
+
 
+
'''no-interaction:'''
+
 
+
* Name:  '''--no-interaction'''
+
* Shortcut: '''-n'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not ask any interactive question
+
* Default: '''false'''
+
 
+
'''env:'''
+
 
+
* Name:  '''--env'''
+
* Shortcut: <none>
+
* Accept value: yes
+
* Is value required: no
+
* Is multiple: no
+
* Description: The environment the command should run under.
+
* Default: '''NULL'''
+
  
 
== dfe:server ==
 
== dfe:server ==
  
* Description: Create, update, and delete servers
+
Usage:
* Usage:
+
  dfe:server [options] [--] <operation> [<server-id>]
** '''dfe:server [-t|--server-type SERVER-TYPE] [-m|--mount-id MOUNT-ID] [-a|--host-name HOST-NAME] [-c|--config CONFIG] [--] <operation> <server-id>'''
+
 
+
Create, update, and delete servers
+
 
+
=== Arguments ===
+
 
+
'''operation:'''
+
 
+
* Name: operation
+
* Is required: yes
+
* Is array: no
+
* Description: The operation to perform: create, update, or delete
+
* Default: '''NULL'''
+
 
+
'''server-id:'''
+
 
+
* Name: server-id
+
* Is required: yes
+
* Is array: no
+
* Description: The id of the server upon which to perform operation
+
* Default: '''NULL'''
+
 
+
=== Options ===
+
 
+
'''server-type:'''
+
 
+
* Name:  '''--server-type'''
+
* Shortcut: '''-t'''
+
* Accept value: yes
+
* Is value required: yes
+
* Is multiple: no
+
* Description: The type of server: DB, WEB, APP
+
* Default: '''NULL'''
+
 
+
'''mount-id:'''
+
 
+
* Name:  '''--mount-id'''
+
* Shortcut: '''-m'''
+
* Accept value: yes
+
* Is value required: yes
+
* Is multiple: no
+
* Description: The id of the storage mount for this server
+
* Default: '''NULL'''
+
 
+
'''host-name:'''
+
 
+
* Name:  '''--host-name'''
+
* Shortcut: '''-a'''
+
* Accept value: yes
+
* Is value required: yes
+
* Is multiple: no
+
* Description: The host name of this server
+
* Default: '''NULL'''
+
 
+
'''config:'''
+
 
+
* Name:  '''--config'''
+
* Shortcut: '''-c'''
+
* Accept value: yes
+
* Is value required: yes
+
* Is multiple: no
+
* Description: JSON-encoded array of configuration data for this server
+
* Default: '''NULL'''
+
 
+
'''help:'''
+
 
+
* Name:  '''--help'''
+
* Shortcut: '''-h'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this help message
+
* Default: '''false'''
+
 
+
'''quiet:'''
+
 
+
* Name:  '''--quiet'''
+
* Shortcut: '''-q'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not output any message
+
* Default: '''false'''
+
 
+
'''verbose:'''
+
 
+
* Name:  '''--verbose'''
+
* Shortcut: '''-v|-vv|-vvv'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+
* Default: '''false'''
+
 
+
'''version:'''
+
 
+
* Name:  '''--version'''
+
* Shortcut: '''-V'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this application version
+
* Default: '''false'''
+
 
+
'''ansi:'''
+
 
+
* Name:  '''--ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Force ANSI output
+
* Default: '''false'''
+
 
+
'''no-ansi:'''
+
  
* Name: '''--no-ansi'''
+
Arguments:
* Shortcut: <none>
+
  operation                      The operation to perform: show, create, update, or delete
* Accept value: no
+
  server-id                      The id of the server upon which to perform operation
* Is value required: no
+
* Is multiple: no
+
* Description: Disable ANSI output
+
* Default: '''false'''
+
  
'''no-interaction:'''
+
Options:
 +
  -t, --server-type=SERVER-TYPE  The type of server: APP, WEB, DB
 +
  -m, --mount-id=MOUNT-ID        The id of the storage mount for this server
 +
  -a, --host-name=HOST-NAME      The host name of this server
 +
  -c, --config=CONFIG            JSON-encoded array of configuration data for this server
 +
  -h, --help                    Display this help message
 +
  -q, --quiet                    Do not output any message
 +
  -V, --version                  Display this application version
 +
      --ansi                    Force ANSI output
 +
      --no-ansi                  Disable ANSI output
 +
  -n, --no-interaction           Do not ask any interactive question
 +
      --env[=ENV]                The environment the command should run under.
 +
  -v|vv|vvv, --verbose          Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  
* Name'''--no-interaction'''
+
Help:
* Shortcut: '''-n'''
+
  Create, update, and delete servers
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not ask any interactive question
+
* Default: '''false'''
+
  
'''env:'''
 
  
* Name:  '''--env'''
 
* Shortcut: <none>
 
* Accept value: yes
 
* Is value required: no
 
* Is multiple: no
 
* Description: The environment the command should run under.
 
* Default: '''NULL'''
 
  
 
== dfe:setup ==
 
== dfe:setup ==
  
* Description: Initializes a new installation and generates a cluster environment file.
+
Usage:
* Usage:
+
  dfe:setup [options] [--] <admin-email>
** '''dfe:setup [--force] [--no-manifest] [--no-keys] [--admin-password [ADMIN-PASSWORD]] [--api-secret [API-SECRET]] [--] <admin-email>'''
+
  
Initializes a new installation and generates a cluster environment file.
+
Arguments:
 +
  admin-email                            The admin email address.
  
=== Arguments ===
+
Options:
 +
      --force                            Use to force re-initialization of system.
 +
      --no-manifest                      Do not create a manifest file.
 +
      --no-keys                          Do not create initialization keys.
 +
      --admin-password[=ADMIN-PASSWORD]  The admin account password to use. [default: "dfe.admin"]
 +
      --api-secret[=API-SECRET]          The API secret to use. If not specified, one will be generated
 +
  -h, --help                            Display this help message
 +
  -q, --quiet                            Do not output any message
 +
  -V, --version                          Display this application version
 +
      --ansi                            Force ANSI output
 +
      --no-ansi                          Disable ANSI output
 +
  -n, --no-interaction                  Do not ask any interactive question
 +
      --env[=ENV]                        The environment the command should run under.
 +
  -v|vv|vvv, --verbose                  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  
'''admin-email:'''
+
Help:
 +
Initializes a new installation and generates a cluster environment file.
  
* Name: admin-email
 
* Is required: yes
 
* Is array: no
 
* Description: The admin email address.
 
* Default: '''NULL'''
 
 
=== Options ===
 
 
'''force:'''
 
 
* Name:  '''--force'''
 
* Shortcut: <none>
 
* Accept value: no
 
* Is value required: no
 
* Is multiple: no
 
* Description: Use to force re-initialization of system.
 
* Default: '''false'''
 
 
'''no-manifest:'''
 
 
* Name:  '''--no-manifest'''
 
* Shortcut: <none>
 
* Accept value: no
 
* Is value required: no
 
* Is multiple: no
 
* Description: Do not create a manifest file.
 
* Default: '''false'''
 
 
'''no-keys:'''
 
 
* Name:  '''--no-keys'''
 
* Shortcut: <none>
 
* Accept value: no
 
* Is value required: no
 
* Is multiple: no
 
* Description: Do not create initialization keys.
 
* Default: '''false'''
 
 
'''admin-password:'''
 
 
* Name:  '''--admin-password'''
 
* Shortcut: <none>
 
* Accept value: yes
 
* Is value required: no
 
* Is multiple: no
 
* Description: The admin account password to use.
 
* Default: ''''dfe.admin''''
 
 
'''api-secret:'''
 
 
* Name:  '''--api-secret'''
 
* Shortcut: <none>
 
* Accept value: yes
 
* Is value required: no
 
* Is multiple: no
 
* Description: The API secret to use. If not specified, one will be generated
 
* Default: '''NULL'''
 
 
'''help:'''
 
 
* Name:  '''--help'''
 
* Shortcut: '''-h'''
 
* Accept value: no
 
* Is value required: no
 
* Is multiple: no
 
* Description: Display this help message
 
* Default: '''false'''
 
 
'''quiet:'''
 
 
* Name:  '''--quiet'''
 
* Shortcut: '''-q'''
 
* Accept value: no
 
* Is value required: no
 
* Is multiple: no
 
* Description: Do not output any message
 
* Default: '''false'''
 
 
'''verbose:'''
 
 
* Name:  '''--verbose'''
 
* Shortcut: '''-v|-vv|-vvv'''
 
* Accept value: no
 
* Is value required: no
 
* Is multiple: no
 
* Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
 
* Default: '''false'''
 
 
'''version:'''
 
 
* Name:  '''--version'''
 
* Shortcut: '''-V'''
 
* Accept value: no
 
* Is value required: no
 
* Is multiple: no
 
* Description: Display this application version
 
* Default: '''false'''
 
 
'''ansi:'''
 
 
* Name:  '''--ansi'''
 
* Shortcut: <none>
 
* Accept value: no
 
* Is value required: no
 
* Is multiple: no
 
* Description: Force ANSI output
 
* Default: '''false'''
 
 
'''no-ansi:'''
 
 
* Name:  '''--no-ansi'''
 
* Shortcut: <none>
 
* Accept value: no
 
* Is value required: no
 
* Is multiple: no
 
* Description: Disable ANSI output
 
* Default: '''false'''
 
 
'''no-interaction:'''
 
 
* Name:  '''--no-interaction'''
 
* Shortcut: '''-n'''
 
* Accept value: no
 
* Is value required: no
 
* Is multiple: no
 
* Description: Do not ask any interactive question
 
* Default: '''false'''
 
 
'''env:'''
 
 
* Name:  '''--env'''
 
* Shortcut: <none>
 
* Accept value: yes
 
* Is value required: no
 
* Is multiple: no
 
* Description: The environment the command should run under.
 
* Default: '''NULL'''
 
  
 
== dfe:token ==
 
== dfe:token ==
  
* Description: Generates a token for an instance
+
Usage:
* Usage:
+
  dfe:token <instance-id>
** '''dfe:token <instance-id>'''
+
  
Generates a token for an instance
+
Arguments:
 +
  instance-id          The instance id
  
=== Arguments ===
+
Options:
 +
  -h, --help            Display this help message
 +
  -q, --quiet          Do not output any message
 +
  -V, --version        Display this application version
 +
      --ansi            Force ANSI output
 +
      --no-ansi        Disable ANSI output
 +
  -n, --no-interaction  Do not ask any interactive question
 +
      --env[=ENV]      The environment the command should run under.
 +
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  
'''instance-id:'''
+
Help:
 +
Generates a token for an instance
  
* Name: instance-id
 
* Is required: yes
 
* Is array: no
 
* Description: The instance id
 
* Default: '''NULL'''
 
  
=== Options ===
+
== dfe:update ==
  
'''help:'''
+
Usage:
 +
  dfe:update [options]
  
* Name: '''--help'''
+
Options:
* Shortcut: '''-h'''
+
      --no-composer    If specified, a "composer update" will NOT be performed after an update.
* Accept value: no
+
      --no-clear        If specified, the caches will not be cleared after an update.
* Is value required: no
+
  -h, --help            Display this help message
* Is multiple: no
+
  -q, --quiet          Do not output any message
* Description: Display this help message
+
  -V, --version        Display this application version
* Default: '''false'''
+
      --ansi            Force ANSI output
 +
      --no-ansi        Disable ANSI output
 +
  -n, --no-interaction  Do not ask any interactive question
 +
      --env[=ENV]      The environment the command should run under.
 +
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  
'''quiet:'''
+
Help:
 
+
  The dfe:update command checks github.com for newer
* Name: '''--quiet'''
+
versions of DFE Console and if found, installs the latest.
* Shortcut: '''-q'''
+
* Accept value: no
+
php artisan dfe:update
* Is value required: no
+
   
* Is multiple: no
+
* Description: Do not output any message
+
* Default: '''false'''
+
 
+
'''verbose:'''
+
 
+
* Name:  '''--verbose'''
+
* Shortcut: '''-v|-vv|-vvv'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+
* Default: '''false'''
+
 
+
'''version:'''
+
 
+
* Name:  '''--version'''
+
* Shortcut: '''-V'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this application version
+
* Default: '''false'''
+
 
+
'''ansi:'''
+
 
+
* Name:  '''--ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Force ANSI output
+
* Default: '''false'''
+
 
+
'''no-ansi:'''
+
 
+
* Name:  '''--no-ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Disable ANSI output
+
* Default: '''false'''
+
 
+
'''no-interaction:'''
+
 
+
* Name:  '''--no-interaction'''
+
* Shortcut: '''-n'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not ask any interactive question
+
* Default: '''false'''
+
 
+
'''env:'''
+
 
+
* Name:  '''--env'''
+
* Shortcut: <none>
+
* Accept value: yes
+
* Is value required: no
+
* Is multiple: no
+
* Description: The environment the command should run under.
+
* Default: '''NULL'''
+
 
+
== dfe:update ==
+
 
+
* Description: Update DFE Console to the latest version.
+
* Usage:
+
** '''dfe:update [--no-composer] [--no-clear]'''
+
 
+
The <info>dfe:update</info> command checks github.com for newer
+
versions of DFE Console and if found, installs the latest.
+
 
+
<info>php artisan dfe:update</info>
+
 
+
 
+
=== Options ===
+
 
+
'''no-composer:'''
+
 
+
* Name: '''--no-composer'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: If specified, a "composer update" will NOT be performed after an update.
+
* Default: '''false'''
+
 
+
'''no-clear:'''
+
 
+
* Name:  '''--no-clear'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: If specified, the caches will not be cleared after an update.
+
* Default: '''false'''
+
 
+
'''help:'''
+
 
+
* Name:  '''--help'''
+
* Shortcut: '''-h'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this help message
+
* Default: '''false'''
+
 
+
'''quiet:'''
+
 
+
* Name:  '''--quiet'''
+
* Shortcut: '''-q'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Do not output any message
+
* Default: '''false'''
+
 
+
'''verbose:'''
+
 
+
* Name:  '''--verbose'''
+
* Shortcut: '''-v|-vv|-vvv'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+
* Default: '''false'''
+
 
+
'''version:'''
+
 
+
* Name:  '''--version'''
+
* Shortcut: '''-V'''
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Display this application version
+
* Default: '''false'''
+
 
+
'''ansi:'''
+
 
+
* Name:  '''--ansi'''
+
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Force ANSI output
+
* Default: '''false'''
+
 
+
'''no-ansi:'''
+
  
* Name: '''--no-ansi'''
+
== dfe:users ==
* Shortcut: <none>
+
* Accept value: no
+
* Is value required: no
+
* Is multiple: no
+
* Description: Disable ANSI output
+
* Default: '''false'''
+
  
'''no-interaction:'''
+
Usage:
 +
  dfe:users [options] [--] <operation> <email>
  
* Name: '''--no-interaction'''
+
Arguments:
* Shortcut: '''-n'''
+
  operation                    The operation to perform: show, create, update, delete, activate, deactivate
* Accept value: no
+
  email                        The email address of the target user
* Is value required: no
+
* Is multiple: no
+
* Description: Do not ask any interactive question
+
* Default: '''false'''
+
  
'''env:'''
+
Options:
 +
      --format=FORMAT          Output show in alternate format. Valid types are: json and xml
 +
  -u, --ugly                  For formatted output, does not pretty-print output
 +
      --escaped-slashes        For JSON formatted output, slashes will be escaped (default is that they are not)
 +
      --force                  Use to force current operation.
 +
      --password=PASSWORD      The password of the target user
 +
  -f, --first-name=FIRST-NAME  The first name of the target user
 +
  -l, --last-name=LAST-NAME    The last name of the target user
 +
      --nickname[=NICKNAME]    The nickname of the target user
 +
  -h, --help                  Display this help message
 +
  -q, --quiet                  Do not output any message
 +
  -V, --version                Display this application version
 +
      --ansi                  Force ANSI output
 +
      --no-ansi                Disable ANSI output
 +
  -n, --no-interaction        Do not ask any interactive question
 +
      --env[=ENV]              The environment the command should run under.
 +
  -v|vv|vvv, --verbose        Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  
* Name'''--env'''
+
Help:
* Shortcut: <none>
+
  Manage DFE Dashboard users.
* Accept value: yes
+
* Is value required: no
+
* Is multiple: no
+
* Description: The environment the command should run under.
+
* Default: '''NULL'''
+

Revision as of 02:29, 28 March 2016


Usage

The Console provides command-line access to all GUI features except reporting. This is provided through Laravel's artisan tool. To see the list of available commands, simply run php artisan from the Console installation directory:

[email protected]:/var/www/console$ php artisan
Laravel Framework version 5.1.x (LTS)

Usage:
  command [options] [arguments]

Available commands:
 ...
 dfe
  dfe:blueprint         Generates an instance blueprint
  dfe:capsule           Encapsulate a managed instance for direct access.
  dfe:cluster           Create, update, delete, and manage clusters
  dfe:daily             Performs daily maintenance tasks
  dfe:deprovision       Deprovisions, or shuts down, a running instance
  dfe:export            Create a portable instance export
  dfe:import            Import a portable instance export
  dfe:info              Extract information from the system
  dfe:manifest          Generates a cluster manifest file (.dfe.cluster.json) for DFE installations.
  dfe:metrics           Gather overall system metrics
  dfe:migrate-instance  Run migration for an instance.
  dfe:mount             Create, update, and delete mounts
  dfe:move-instance     Moves an instance from one server to another.
  dfe:provision         Provision a new instance
  dfe:register          Creates a key pair used to communicate with the DFE Console
  dfe:server            Create, update, and delete servers
  dfe:setup             Initializes a new installation and generates a cluster environment file.
  dfe:token             Generates a token for an instance
  dfe:update            Update DFE Console to the latest version.
  dfe:users             Manage DFE Dashboard users.
 ...

Conventions

In the usage sections to follow, the common options will be omitted. These options exist for**all* console commands:

  -h, --help                         Display this help message
  -q, --quiet                        Do not output any message
  -V, --version                      Display this application version
      --ansi                         Force ANSI output
      --no-ansi                      Disable ANSI output
  -n, --no-interaction               Do not ask any interactive question
      --env[=ENV]                    The environment the command should run under.
  -v|vv|vvv, --verbose               Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

=== Command Types ===
There are two basic types of commands: entity and operational. Entity commands manage the logical entities within the [[DFE/Console|Console]]. These commands are `dfe:cluster`, `dfe:mount`, and `dfe:server`. Operational commands are all the rest. These commands manipulate the entities or the system.

== dfe:blueprint ==

Usage:
  dfe:blueprint [options] [--] <instance-id> [<instance-uri>] [<admin-email>] [<admin-password>]

Arguments:
  instance-id            The id of the instance to inspect.
  instance-uri           The URI of the instance (i.e. "http://localhost")
  admin-email            An instance administrator email
  admin-password         An instance administrator password

Options:
      --no-commit        Do not commit the result to the repo
  -d, --dump             Dump the blueprint to stdout as well as writing to disk
  -k, --api-key=API-KEY  The API key to use instead of auto-generated token

Help:
 Generates an instance blueprint

== dfe:capsule ==

Usage:
  dfe:capsule [options] [--] <instance-id>

Arguments:
  instance-id           The instance to encapsulate

Options:
  -d, --destroy         Destroys a previously created capsule.

Help:
             The dfe:capsule command encapsulates a managed instance for direct access.
 
 php artisan dfe:capsule <instance-id> [-d|--destroy]
 
== dfe:cluster ==

Usage:
  dfe:cluster [options] [--] <operation> [<cluster-id>]

Arguments:
  operation                          The operation to perform: show, create, update, delete, add (server to cluster), or remove (server from cluster)
  cluster-id                         The id of the cluster upon which to perform operation [default: "cluster-gha-1"]

Options:
      --owner-id=OWNER-ID            The "owner-id" of this cluster
      --owner-type=OWNER-TYPE        The type of owner: USER, INSTANCE, SERVER, MOUNT, CLUSTER, SERVICE_USER, OWNER_HASH, CONSOLE, DASHBOARD, APPLICATION, SERVICE, TESTING, _DEFAULT_NAMESPACE_
      --subdomain=SUBDOMAIN          The subdomain in which this cluster resides
  -m, --max-instances=MAX-INSTANCES  The maximum number of instances allowed, if any.
      --server-id=SERVER-ID          The "server-id" to "add" or "remove"

Help:
 Create, update, delete, and manage clusters

== dfe:daily ==

Usage:
  dfe:daily [options]

Options:
      --dry-run         When specified, no instances will be deprovisioned.

Help:
 Performs daily maintenance tasks

== dfe:deprovision ==

Usage:
  dfe:deprovision [options] [--] <instance-id>

Arguments:
  instance-id                    The instance to deprovision

Options:
  -c, --cluster-id[=CLUSTER-ID]  The cluster containing the instance [default: "cluster-gha-1"]
  -h, --help                     Display this help message
  -q, --quiet                    Do not output any message
  -V, --version                  Display this application version
      --ansi                     Force ANSI output
      --no-ansi                  Disable ANSI output
  -n, --no-interaction           Do not ask any interactive question
      --env[=ENV]                The environment the command should run under.
  -v|vv|vvv, --verbose           Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
 Deprovisions, or shuts down, a running instance

== dfe:export ==

Usage:
  dfe:export [options] [--] <instance-id>

Arguments:
  instance-id                      The instance to export

Options:
  -d, --destination[=DESTINATION]  The path to place the export file.
  -h, --help                       Display this help message
  -q, --quiet                      Do not output any message
  -V, --version                    Display this application version
      --ansi                       Force ANSI output
      --no-ansi                    Disable ANSI output
  -n, --no-interaction             Do not ask any interactive question
      --env[=ENV]                  The environment the command should run under.
  -v|vv|vvv, --verbose             Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
 Create a portable instance export

== dfe:import ==

Usage:
  dfe:import [options] [--] <owner-id> <instance-id> <snapshot> [<guest-location>]

Arguments:
  owner-id                       The id of the owner of the new instance
  instance-id                    The name of the new instance
  snapshot                       The path of the snapshot file
  guest-location                 The location of the new instance [default: "dreamfactory"]

Options:
  -c, --cluster-id[=CLUSTER-ID]  The cluster where this instance is to be placed. [default: "cluster-gha-1"]
      --indirect                 If specified, the "snapshot" value is a snapshot-id not a path
      --owner-type=OWNER-TYPE    The owner-id of the new instance
Help:
 Import a portable instance export

== dfe:info ==

Usage:
  dfe:info [options] [--] <entity-type> [<entity-id>]

Arguments:
  entity-type                  The type of entity information to retrieve: mount, server, cluster, instance, or metrics
  entity-id                    The id of the entity-type

Options:
  -a, --all                    Return all data, ignoring entity-id
  -s, --start-date=START-DATE  The start date for a range of metrics data
  -e, --end-date=END-DATE      The end date for a range of metrics data
  -f, --format[=FORMAT]        The format in which to output the information. Available formats are: json or xml
  -u, --ugly                   For formatted output, does not pretty-print output
      --escaped-slashes        For JSON formatted output, slashes will be escaped (default is that they are not)
  -t, --owner-type=OWNER-TYPE  The "owner-type" of the entity (required by "app-key") [default: 0]
  -h, --help                   Display this help message
  -q, --quiet                  Do not output any message
  -V, --version                Display this application version
      --ansi                   Force ANSI output
      --no-ansi                Disable ANSI output
  -n, --no-interaction         Do not ask any interactive question
      --env[=ENV]              The environment the command should run under.
  -v|vv|vvv, --verbose         Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
 Extract information from the system

== dfe:manifest ==

Usage:
  dfe:manifest [options] [--] <cluster-id> <web-server-id> [<output-file>]

Arguments:
  cluster-id                   The id/name of the cluster
  web-server-id                The id/name of the web server from "cluster-id"
  output-file                  The /path/to/manifest/file to write. Otherwise it is written to the current working directory.

Options:
  -c, --create                 Create a new manifest file. This is the default.
  -k, --no-keys                If specified, no application keys will be generated.
  -s, --show                   If specified, show the contents of an installation's manifest.
      --owner-id=OWNER-ID      The owner id for the manifest key if not 0 [default: 0]
      --owner-type=OWNER-TYPE  The owner type for the manifest key if not "dashboard" [default: "dashboard"]
  -h, --help                   Display this help message
  -q, --quiet                  Do not output any message
  -V, --version                Display this application version
      --ansi                   Force ANSI output
      --no-ansi                Disable ANSI output
  -n, --no-interaction         Do not ask any interactive question
      --env[=ENV]              The environment the command should run under.
  -v|vv|vvv, --verbose         Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
 Generates a cluster manifest file (.dfe.cluster.json) for DFE installations.

== dfe:metrics ==

Usage:
  dfe:metrics [options]

Options:
      --gather                         When specified, all metrics are gathered and written to the database. Use when scheduling jobs.
  -f, --to-file=TO-FILE                Write metrics to a file.
      --console-only                   Only gather "console" metrics
      --dashboard-only                 Only gather "dashboard" metrics
      --instance-only                  Only gather "dashboard" metrics
      --no-usage-data[=NO-USAGE-DATA]  Do not send usage data if true [default: false]
      --force                          Force overwrite of daily gather
  -h, --help                           Display this help message
  -q, --quiet                          Do not output any message
  -V, --version                        Display this application version
      --ansi                           Force ANSI output
      --no-ansi                        Disable ANSI output
  -n, --no-interaction                 Do not ask any interactive question
      --env[=ENV]                      The environment the command should run under.
  -v|vv|vvv, --verbose                 Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
 Gather overall system metrics

== dfe:migrate-instance ==

Usage:
  dfe:migrate-instance [options] [--] [<instance-id>]

Arguments:
  instance-id                  The instance to migrate

Options:
  -a, --all                    Migrate *all* cluster instances
  -c, --cluster-id=CLUSTER-ID  If specified with "--all", will migrate only instances managed by "cluster-id".
  -s, --seed                   If specified, "--seed" will be passed to any "migrate" commands
  -h, --help                   Display this help message
  -q, --quiet                  Do not output any message
  -V, --version                Display this application version
      --ansi                   Force ANSI output
      --no-ansi                Disable ANSI output
  -n, --no-interaction         Do not ask any interactive question
      --env[=ENV]              The environment the command should run under.
  -v|vv|vvv, --verbose         Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
 Run migration for an instance.

== dfe:mount ==

Usage:
  dfe:mount [options] [--] <operation> [<mount-id>]

Arguments:
  operation                    The operation to perform: show, create, update, or delete
  mount-id                     The id of the mount upon which to perform operation

Options:
  -t, --mount-type=MOUNT-TYPE  The type of mount: LOCAL, SFTP, S3
      --owner-id=OWNER-ID      The "owner-id" of this mount
      --owner-type=OWNER-TYPE  The type of owner: USER, INSTANCE, SERVER, MOUNT, CLUSTER, SERVICE_USER, OWNER_HASH, CONSOLE, DASHBOARD, APPLICATION, SERVICE, TESTING, _DEFAULT_NAMESPACE_
  -p, --root-path=ROOT-PATH    The "root-path" of the mount
  -c, --config=CONFIG          JSON-encoded array of configuration data for this mount
  -h, --help                   Display this help message
  -q, --quiet                  Do not output any message
  -V, --version                Display this application version
      --ansi                   Force ANSI output
      --no-ansi                Disable ANSI output
  -n, --no-interaction         Do not ask any interactive question
      --env[=ENV]              The environment the command should run under.
  -v|vv|vvv, --verbose         Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
 Create, update, and delete mounts

== dfe:move-instance ==

Usage:
  dfe:move-instance [options] [--] <server-id> [<instance-id>]

Arguments:
  server-id                    The destination server of the move
  instance-id                  The instance to move

Options:
  -a, --all                    Move *all* instances
  -p, --purge                  Purge existing credentials from database. Only used with database server moves.
  -c, --cluster-id=CLUSTER-ID  If specified with "--all", only the instances managed by "cluster-id" will be moved.
  -h, --help                   Display this help message
  -q, --quiet                  Do not output any message
  -V, --version                Display this application version
      --ansi                   Force ANSI output
      --no-ansi                Disable ANSI output
  -n, --no-interaction         Do not ask any interactive question
      --env[=ENV]              The environment the command should run under.
  -v|vv|vvv, --verbose         Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
 Moves an instance from one server to another.

== dfe:provision ==

Usage:
  dfe:provision [options] [--] <owner-id> <instance-id> [<guest-location>]

Arguments:
  owner-id                       The id of the owner of the new instance
  instance-id                    The name of the new instance
  guest-location                 The location of the new instance. Values: "amazon", "dreamfactory", "azure", "rackspace", "openstack", or "local" [default: "dreamfactory"]

Options:
      --owner-type[=OWNER-TYPE]  The "owner-id" type. Values: "0" (user), "1" (instance), "2" (server), "3" (mount), "4" (cluster), "5" (service_user), "6" (owner_hash), "1000" (console), "1001" (dashboard), "1002" (application), "1003" (service), or "9999" (testing) [default: 0]
  -c, --cluster-id[=CLUSTER-ID]  The cluster where this instance is to be placed. [default: "cluster-gha-1"]
  -h, --help                     Display this help message
  -q, --quiet                    Do not output any message
  -V, --version                  Display this application version
      --ansi                     Force ANSI output
      --no-ansi                  Disable ANSI output
  -n, --no-interaction           Do not ask any interactive question
      --env[=ENV]                The environment the command should run under.
  -v|vv|vvv, --verbose           Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
 Provision a new instance

== dfe:register ==

Usage:
  dfe:register <owner-id> <owner-type>

Arguments:
  owner-id              The id of the owner of this key
  owner-type            One of the following owner types: user, instance, server, mount, cluster, service_user, owner_hash, console, dashboard, application, service, or testing

Options:
  -h, --help            Display this help message
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi            Force ANSI output
      --no-ansi         Disable ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under.
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
 Creates a key pair used to communicate with the DFE Console

== dfe:server ==

Usage:
  dfe:server [options] [--] <operation> [<server-id>]

Arguments:
  operation                      The operation to perform: show, create, update, or delete
  server-id                      The id of the server upon which to perform operation

Options:
  -t, --server-type=SERVER-TYPE  The type of server: APP, WEB, DB
  -m, --mount-id=MOUNT-ID        The id of the storage mount for this server
  -a, --host-name=HOST-NAME      The host name of this server
  -c, --config=CONFIG            JSON-encoded array of configuration data for this server
  -h, --help                     Display this help message
  -q, --quiet                    Do not output any message
  -V, --version                  Display this application version
      --ansi                     Force ANSI output
      --no-ansi                  Disable ANSI output
  -n, --no-interaction           Do not ask any interactive question
      --env[=ENV]                The environment the command should run under.
  -v|vv|vvv, --verbose           Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
 Create, update, and delete servers



== dfe:setup ==

Usage:
  dfe:setup [options] [--] <admin-email>

Arguments:
  admin-email                            The admin email address.

Options:
      --force                            Use to force re-initialization of system.
      --no-manifest                      Do not create a manifest file.
      --no-keys                          Do not create initialization keys.
      --admin-password[=ADMIN-PASSWORD]  The admin account password to use. [default: "dfe.admin"]
      --api-secret[=API-SECRET]          The API secret to use. If not specified, one will be generated
  -h, --help                             Display this help message
  -q, --quiet                            Do not output any message
  -V, --version                          Display this application version
      --ansi                             Force ANSI output
      --no-ansi                          Disable ANSI output
  -n, --no-interaction                   Do not ask any interactive question
      --env[=ENV]                        The environment the command should run under.
  -v|vv|vvv, --verbose                   Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
 Initializes a new installation and generates a cluster environment file.


== dfe:token ==

Usage:
  dfe:token <instance-id>

Arguments:
  instance-id           The instance id

Options:
  -h, --help            Display this help message
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi            Force ANSI output
      --no-ansi         Disable ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under.
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
 Generates a token for an instance


==  dfe:update ==

Usage:
  dfe:update [options]

Options:
      --no-composer     If specified, a "composer update" will NOT be performed after an update.
      --no-clear        If specified, the caches will not be cleared after an update.
  -h, --help            Display this help message
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi            Force ANSI output
      --no-ansi         Disable ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under.
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
 The dfe:update command checks github.com for newer
 versions of DFE Console and if found, installs the latest.
 
 php artisan dfe:update
 

== dfe:users ==

Usage:
  dfe:users [options] [--] <operation> <email>

Arguments:
  operation                    The operation to perform: show, create, update, delete, activate, deactivate
  email                        The email address of the target user

Options:
      --format=FORMAT          Output show in alternate format. Valid types are: json and xml
  -u, --ugly                   For formatted output, does not pretty-print output
      --escaped-slashes        For JSON formatted output, slashes will be escaped (default is that they are not)
      --force                  Use to force current operation.
      --password=PASSWORD      The password of the target user
  -f, --first-name=FIRST-NAME  The first name of the target user
  -l, --last-name=LAST-NAME    The last name of the target user
      --nickname[=NICKNAME]    The nickname of the target user
  -h, --help                   Display this help message
  -q, --quiet                  Do not output any message
  -V, --version                Display this application version
      --ansi                   Force ANSI output
      --no-ansi                Disable ANSI output
  -n, --no-interaction         Do not ask any interactive question
      --env[=ENV]              The environment the command should run under.
  -v|vv|vvv, --verbose         Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
 Manage DFE Dashboard users.