Command Line Utilities

From DreamFactory
Jump to: navigation, search
DFEConsoleCommand Line Utilities
    1. 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: 

dfadmin@console:/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
 ...
      1. 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
      1. 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

      1. 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`
      1. 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>`
The
dfe:capsule
 command encapsulates a managed instance for direct access.
php artisan dfe:capsule [-d|--destroy]


      1. Arguments:
    • instance-id:**
  • Name: instance-id
  • Is required: yes
  • Is array: no
  • Description: The instance to encapsulate
  • Default: `NULL`
      1. 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

      1. 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`
      1. 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

      1. Arguments:
    • instance-id:**
  • Name: instance-id
  • Is required: yes
  • Is array: no
  • Description: The instance to deprovision
  • Default: `NULL`
      1. 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

      1. Arguments:
    • instance-id:**
  • Name: instance-id
  • Is required: yes
  • Is array: no
  • Description: The instance to export
  • Default: `NULL`
      1. 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

      1. 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'`
      1. 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.

      1. 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`
      1. 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

      1. 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>]`
The
dfe:migrate-instance
 command initiates a "php artisan migrate"

for an instance under management.

php artisan dfe:migrate-instance [-s|--seed] [-a|--all] [-c|--cluster-id=] "instance-id"


      1. Arguments:
    • instance-id:**
  • Name: instance-id
  • Is required: no
  • Is array: no
  • Description: The instance to migrate
  • Default: `NULL`
      1. 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

      1. 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`
      1. 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

      1. 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'`
      1. 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

      1. 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`
      1. 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

      1. 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`
      1. 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.

      1. Arguments:
    • admin-email:**
  • Name: admin-email
  • Is required: yes
  • Is array: no
  • Description: The admin email address.
  • Default: `NULL`
      1. 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

      1. Arguments:
    • instance-id:**
  • Name: instance-id
  • Is required: yes
  • Is array: no
  • Description: The instance id
  • Default: `NULL`
      1. 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


      1. 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`
Retrieved from "https://wiki.dreamfactory.com/index.php?title=DFE/Console/Command_Line_Utilities&oldid=31305"