Command Line Utilities

From DreamFactory
Jump to: navigation, search
DFEConsoleCommand Line Utilities
m
m (Reverted edits by JerryAblan (talk) to last revision by Leehicks)
Line 1: Line 1:
== dfe:blueprint ==
+
{{DISPLAYTITLE:Command Line Utilities}}
 +
 
 +
== Usage ==
 +
 
 +
The [[DFE/Console|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 [[DFE/Console|Console]] installation directory:
 +
 
 +
<pre>
 +
[email protected]:/var/www/console$ php artisan
 +
Laravel Framework version 5.1.x (LTS)
  
 
Usage:
 
Usage:
   dfe:blueprint [options] [--] <instance-id> [<instance-uri>] [<admin-email>] [<admin-password>]
+
   command [options] [arguments]
  
Arguments:
+
Available commands:
   instance-id           The id of the instance to inspect.
+
...
   instance-uri          The URI of the instance (i.e. "http://localhost")
+
dfe
   admin-email            An instance administrator email
+
   dfe:blueprint        Generate an instance blueprint
   admin-password         An instance administrator password
+
  dfe:capsule          Encapsulate a managed instance for direct access
 +
  dfe:cluster          Create, update, delete, and manage clusters
 +
  dfe:deprovision      Deprovisions, or shuts down, a running instance
 +
  dfe:export           Create a portable instance export
 +
   dfe:import            Create an instance from an instance export
 +
  dfe:manifest          Generate a cluster manifest file (.dfe.cluster.json)
 +
   dfe:metrics          Gather system metrics
 +
  dfe:migrate-instance Run database migration for an instance (php artisan migrate)
 +
   dfe:mount            Create, update, and delete mounts
 +
  dfe:provision         Provision a new instance
 +
  dfe:register          Create a key pair for use with the console API
 +
  dfe:server            Create, update, and delete servers
 +
  dfe:setup            Initialize a new installation and generate a cluster environment file
 +
  dfe:token            Generate a token for an instance
 +
  dfe:update            Update the local DFE installation to the latest version
 +
...
 +
</pre>
  
Options:
+
=== Conventions ===
      --no-commit        Do not commit the result to the repo
+
In the usage sections to follow, the common options will be omitted. These options exist for**all* console commands:
   -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
+
<pre>
 +
  -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
 +
</pre>
  
Help:
+
=== Command Types ===
Generates an instance blueprint
+
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 ==
 +
 
 +
* Description: Generates an instance blueprint
 +
* Usage:
 +
** '''dfe:blueprint [--no-commit] [-d|--dump] [--] <instance-id> [<instance-uri>] [<admin-email>] [<admin-password>]'''
 +
 
 +
Generates an instance blueprint
 +
 
 +
=== Arguments ===
 +
 
 +
'''instance-id:'''
 +
 
 +
* 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 ==
  
Usage:
+
* Description: Encapsulate a managed instance for direct access.
  dfe:capsule [options] [--] <instance-id>
+
* Usage:
 +
** '''dfe:capsule [-d|--destroy] [--] <instance-id>'''
  
Arguments:
+
Encapsulates a managed instance for direct access.
  instance-id          The instance to encapsulate
+
  
Options:
+
=== Arguments ===
  -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 ==
  
Usage:
+
* Description: Create, update, delete, and manage clusters
  dfe:cluster [options] [--] <operation> [<cluster-id>]
+
* Usage:
 +
** '''dfe:cluster [--owner-id OWNER-ID] [--owner-type OWNER-TYPE] [--subdomain SUBDOMAIN] [-m|--max-instances MAX-INSTANCES] [--server-id SERVER-ID] [--] <operation> <cluster-id>'''
  
Arguments:
+
Create, update, delete, and manage clusters
  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:
+
=== Arguments ===
      --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:
+
'''operation:'''
Create, update, delete, and manage clusters
+
  
== dfe:daily ==
+
* 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'''
  
Usage:
+
'''cluster-id:'''
  dfe:daily [options]
+
  
Options:
+
* Name: cluster-id
      --dry-run        When specified, no instances will be deprovisioned.
+
* Is required: yes
 +
* Is array: no
 +
* Description: The id of the cluster upon which to perform operation
 +
* Default: '''NULL'''
  
Help:
+
=== Options ===
  Performs daily maintenance tasks
+
 
 +
'''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'''
 +
* 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:deprovision ==
 
== dfe:deprovision ==
  
Usage:
+
* Description: Deprovisions, or shuts down, a running instance
  dfe:deprovision [options] [--] <instance-id>
+
* Usage:
 +
** '''dfe:deprovision [-c|--cluster-id [CLUSTER-ID]] [--] <instance-id>'''
  
Arguments:
+
Deprovisions, or shuts down, a running instance
  instance-id                    The instance to deprovision
+
  
Options:
+
=== Arguments ===
  -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:
+
'''instance-id:'''
  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 ==
  
Usage:
+
* Description: Create a portable instance export
  dfe:export [options] [--] <instance-id>
+
* Usage:
 +
** '''dfe:export [-d|--destination [DESTINATION]] [--] <instance-id>'''
  
Arguments:
+
Create a portable instance export
  instance-id                      The instance to export
+
  
Options:
+
=== Arguments ===
  -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:
+
'''instance-id:'''
Create a portable instance export
+
 
 +
* 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'''
 +
* 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:import ==
 
== dfe:import ==
  
Usage:
+
* Description: Import a portable instance export
  dfe:import [options] [--] <owner-id> <instance-id> <snapshot> [<guest-location>]
+
* Usage:
 +
** '''dfe:import [-c|--cluster-id [CLUSTER-ID]] [-i|--snapshot-id] [--owner-type OWNER-TYPE] [--] <owner-id> <instance-id> <snapshot> [<guest-location>]'''
  
Arguments:
+
Import a portable instance export
  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:
+
=== Arguments ===
  -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:
+
'''owner-id:'''
Import a portable instance export
+
  
== dfe:info ==
+
* Name: owner-id
 +
* Is required: yes
 +
* Is array: no
 +
* Description: The id of the owner of the new instance
 +
* Default: '''NULL'''
  
Usage:
+
'''instance-id:'''
  dfe:info [options] [--] <entity-type> [<entity-id>]
+
  
Arguments:
+
* Name: instance-id
  entity-type                  The type of entity information to retrieve: mount, server, cluster, instance, or metrics
+
* Is required: yes
  entity-id                   The id of the entity-type
+
* Is array: no
 +
* Description: The name of the new instance
 +
* Default: '''NULL'''
  
Options:
+
'''snapshot:'''
  -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]
+
  
Help:
+
* Name: snapshot
  Extract information from the system
+
* 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 ==
  
Usage:
+
* Description: Generates a cluster manifest file (.dfe.cluster.json) for DFE installations.
  dfe:manifest [options] [--] <cluster-id> <web-server-id> [<output-file>]
+
* Usage:
 +
** '''dfe:manifest [-c|--create] [-k|--no-keys] [-s|--show] [--owner-id OWNER-ID] [--owner-type OWNER-TYPE] [--] <cluster-id> <web-server-id> [<output-file>]'''
  
Arguments:
+
Generates a cluster manifest file (.dfe.cluster.json) for DFE installations.
  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:
+
=== Arguments ===
  -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:
+
'''cluster-id:'''
  Generates a cluster manifest file (.dfe.cluster.json) for DFE installations.
+
 
 +
* 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'''
 +
* 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:metrics ==
 
== dfe:metrics ==
  
Usage:
+
* Description: Gather overall system metrics
  dfe:metrics [options]
+
* Usage:
 +
** '''dfe:metrics [--gather] [-f|--to-file TO-FILE] [--console-only] [--dashboard-only] [--instance-only]'''
 +
 
 +
Gather overall system metrics
 +
 
 +
=== Options ===
 +
 
 +
'''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'''
  
Options:
+
'''env:'''
      --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:
+
* Name'''--env'''
  Gather overall system metrics
+
* 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 ==
  
Usage:
+
* Description: Run migration for an instance.
  dfe:migrate-instance [options] [--] [<instance-id>]
+
* Usage:
 +
** '''dfe:migrate-instance [-a|--all] [-c|--cluster-id CLUSTER-ID] [-s|--seed] [--] [<instance-id>]'''
  
Arguments:
+
Initiates a "php artisan migrate" for an instance under management.
  instance-id                  The instance to migrate
+
  
Options:
+
=== Arguments ===
  -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:
+
'''instance-id:'''
  Run migration for an instance.
+
 
 +
* 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'''
 +
* 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:mount ==
 
== dfe:mount ==
  
Usage:
+
* Description: Create, update, and delete mounts
  dfe:mount [options] [--] <operation> [<mount-id>]
+
* Usage:
 +
** '''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>'''
  
Arguments:
+
Create, update, and delete mounts
  operation                    The operation to perform: show, create, update, or delete
+
  mount-id                    The id of the mount upon which to perform operation
+
  
Options:
+
=== Arguments ===
  -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:
+
'''operation:'''
Create, update, and delete mounts
+
  
== dfe:move-instance ==
+
* Name: operation
 +
* Is required: yes
 +
* Is array: no
 +
* Description: The operation to perform: create, update, or delete
 +
* Default: '''NULL'''
  
Usage:
+
'''mount-id:'''
  dfe:move-instance [options] [--] <server-id> [<instance-id>]
+
  
Arguments:
+
* Name: mount-id
  server-id                   The destination server of the move
+
* Is required: yes
  instance-id                  The instance to move
+
* Is array: no
 +
* 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
+
  
Help:
+
'''mount-type:'''
  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 ==
  
Usage:
+
* Description: Provision a new instance
  dfe:provision [options] [--] <owner-id> <instance-id> [<guest-location>]
+
* Usage:
 +
** '''dfe:provision [-c|--cluster-id [CLUSTER-ID]] [--] <owner-id> <instance-id> [<guest-location>]'''
  
Arguments:
+
Provision a new instance
  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:
+
=== Arguments ===
      --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:
+
'''owner-id:'''
Provision a new instance
+
 
 +
* 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'''
 +
* 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:register ==
 
== dfe:register ==
  
Usage:
+
* Description: Creates a key pair used to communicate with the DFE Console
  dfe:register <owner-id> <owner-type>
+
* Usage:
 +
** '''dfe:register <owner-id> <owner-type>'''
 +
 
 +
Creates a key pair used to communicate with the DFE Console
 +
 
 +
=== Arguments ===
 +
 
 +
'''owner-id:'''
 +
 
 +
* 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:'''
  
Arguments:
+
* Name: '''--no-interaction'''
  owner-id              The id of the owner of this key
+
* Shortcut: '''-n'''
  owner-type            One of the following owner types: user, instance, server, mount, cluster, service_user, owner_hash, console, dashboard, application, service, or testing
+
* Accept value: no
 +
* Is value required: no
 +
* Is multiple: no
 +
* Description: Do not ask any interactive question
 +
* Default: '''false'''
  
Options:
+
'''env:'''
  -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:
+
* Name'''--env'''
  Creates a key pair used to communicate with the DFE Console
+
* 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 ==
  
Usage:
+
* Description: Create, update, and delete servers
  dfe:server [options] [--] <operation> [<server-id>]
+
* Usage:
 +
** '''dfe:server [-t|--server-type SERVER-TYPE] [-m|--mount-id MOUNT-ID] [-a|--host-name HOST-NAME] [-c|--config CONFIG] [--] <operation> <server-id>'''
  
Arguments:
+
Create, update, and delete servers
  operation                      The operation to perform: show, create, update, or delete
+
  server-id                      The id of the server upon which to perform operation
+
  
Options:
+
=== Arguments ===
  -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:
+
'''operation:'''
Create, update, and delete servers
+
  
 +
* 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'''
 +
* 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:setup ==
 
== dfe:setup ==
  
Usage:
+
* Description: Initializes a new installation and generates a cluster environment file.
  dfe:setup [options] [--] <admin-email>
+
* Usage:
 +
** '''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:'''
 +
 
 +
* 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'''
  
Arguments:
+
'''no-interaction:'''
  admin-email                            The admin email address.
+
  
Options:
+
* Name: '''--no-interaction'''
      --force                            Use to force re-initialization of system.
+
* Shortcut: '''-n'''
      --no-manifest                      Do not create a manifest file.
+
* Accept value: no
      --no-keys                          Do not create initialization keys.
+
* Is value required: no
      --admin-password[=ADMIN-PASSWORD]  The admin account password to use. [default: "dfe.admin"]
+
* Is multiple: no
      --api-secret[=API-SECRET]          The API secret to use. If not specified, one will be generated
+
* Description: Do not ask any interactive question
  -h, --help                            Display this help message
+
* Default: '''false'''
  -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:
+
'''env:'''
Initializes a new installation and generates a cluster environment file.
+
  
 +
* 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 ==
  
Usage:
+
* Description: Generates a token for an instance
  dfe:token <instance-id>
+
* Usage:
 +
** '''dfe:token <instance-id>'''
  
Arguments:
+
Generates a token for an instance
  instance-id          The instance id
+
  
Options:
+
=== Arguments ===
  -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:
+
'''instance-id:'''
Generates a token for an instance
+
  
 +
* Name: instance-id
 +
* Is required: yes
 +
* Is array: no
 +
* Description: The instance id
 +
* Default: '''NULL'''
  
== dfe:update ==
+
=== Options ===
  
Usage:
+
'''help:'''
  dfe:update [options]
+
  
Options:
+
* Name: '''--help'''
      --no-composer    If specified, a "composer update" will NOT be performed after an update.
+
* Shortcut: '''-h'''
      --no-clear        If specified, the caches will not be cleared after an update.
+
* Accept value: no
  -h, --help            Display this help message
+
* Is value required: no
  -q, --quiet          Do not output any message
+
* Is multiple: no
  -V, --version        Display this application version
+
* Description: Display this help message
      --ansi            Force ANSI output
+
* Default: '''false'''
      --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:
+
'''quiet:'''
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 ==
+
* Name: '''--quiet'''
 +
* Shortcut: '''-q'''
 +
* Accept value: no
 +
* Is value required: no
 +
* Is multiple: no
 +
* Description: Do not output any message
 +
* Default: '''false'''
  
Usage:
+
'''verbose:'''
  dfe:users [options] [--] <operation> <email>
+
 
 +
* 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'''
 +
* Shortcut: <none>
 +
* Accept value: no
 +
* Is value required: no
 +
* Is multiple: no
 +
* Description: Disable ANSI output
 +
* Default: '''false'''
 +
 
 +
'''no-interaction:'''
  
Arguments:
+
* Name: '''--no-interaction'''
  operation                    The operation to perform: show, create, update, delete, activate, deactivate
+
* Shortcut: '''-n'''
  email                        The email address of the target user
+
* Accept value: no
 +
* Is value required: no
 +
* Is multiple: no
 +
* Description: Do not ask any interactive question
 +
* Default: '''false'''
  
Options:
+
'''env:'''
      --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:
+
* Name'''--env'''
  Manage DFE Dashboard users.
+
* Shortcut: <none>
 +
* Accept value: yes
 +
* Is value required: no
 +
* Is multiple: no
 +
* Description: The environment the command should run under.
 +
* Default: '''NULL'''

Revision as of 02:25, 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         Generate an instance blueprint
  dfe:capsule           Encapsulate a managed instance for direct access
  dfe:cluster           Create, update, delete, and manage clusters
  dfe:deprovision       Deprovisions, or shuts down, a running instance
  dfe:export            Create a portable instance export
  dfe:import            Create an instance from an instance export
  dfe:manifest          Generate a cluster manifest file (.dfe.cluster.json)
  dfe:metrics           Gather system metrics
  dfe:migrate-instance  Run database migration for an instance (php artisan migrate)
  dfe:mount             Create, update, and delete mounts
  dfe:provision         Provision a new instance
  dfe:register          Create a key pair for use with the console API
  dfe:server            Create, update, and delete servers
  dfe:setup             Initialize a new installation and generate a cluster environment file
  dfe:token             Generate a token for an instance
  dfe:update            Update the local DFE installation to the latest version
 ...

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 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

  • Description: Generates an instance blueprint
  • Usage:
    • dfe:blueprint [--no-commit] [-d|--dump] [--] <instance-id> [<instance-uri>] [<admin-email>] [<admin-password>]

Generates an instance blueprint

Arguments

instance-id:

  • 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

  • Description: Encapsulate a managed instance for direct access.
  • Usage:
    • dfe:capsule [-d|--destroy] [--] <instance-id>

Encapsulates a managed instance for direct access.

Arguments

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

dfe:cluster

  • Description: Create, update, delete, and manage clusters
  • Usage:
    • 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
  • 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:deprovision

  • Description: Deprovisions, or shuts down, a running instance
  • Usage:
    • dfe:deprovision [-c|--cluster-id [CLUSTER-ID]] [--] <instance-id>

Deprovisions, or shuts down, a running instance

Arguments

instance-id:

  • 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

  • Description: Create a portable instance export
  • Usage:
    • 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
  • 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:import

  • Description: Import a portable instance export
  • Usage:
    • 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:

  • 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

snapshot:

  • 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

  • Description: Generates a cluster manifest file (.dfe.cluster.json) for DFE installations.
  • Usage:
    • 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
  • 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:metrics

  • Description: Gather overall system metrics
  • Usage:
    • dfe:metrics [--gather] [-f|--to-file TO-FILE] [--console-only] [--dashboard-only] [--instance-only]

Gather overall system metrics

Options

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

  • Description: Run migration for an instance.
  • Usage:
    • 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
  • 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:mount

  • Description: Create, update, and delete mounts
  • Usage:
    • 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:

  • Name: operation
  • Is required: yes
  • Is array: no
  • Description: The operation to perform: create, update, or delete
  • Default: NULL

mount-id:

  • Name: mount-id
  • Is required: yes
  • Is array: no
  • Description: The id of the mount upon which to perform operation
  • Default: NULL

Options

mount-type:

  • 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

  • Description: Provision a new instance
  • Usage:
    • 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
  • 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:register

  • Description: Creates a key pair used to communicate with the DFE Console
  • Usage:
    • dfe:register <owner-id> <owner-type>

Creates a key pair used to communicate with the DFE Console

Arguments

owner-id:

  • 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

  • Description: Create, update, and delete servers
  • Usage:
    • 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
  • 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:setup

  • Description: Initializes a new installation and generates a cluster environment file.
  • Usage:
    • 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:

  • 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

  • Description: Generates a token for an instance
  • Usage:
    • dfe:token <instance-id>

Generates a token for an instance

Arguments

instance-id:

  • Name: instance-id
  • Is required: yes
  • Is array: no
  • Description: The instance id
  • 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:update

  • Description: Update DFE Console to the latest version.
  • Usage:
    • dfe:update [--no-composer] [--no-clear]
The
dfe:update
command checks github.com for newer

versions of DFE Console and if found, installs the latest.

php artisan dfe:update


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
  • 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