Command Line Utility

From DreamFactory
Jump to: navigation, search
DFEConsoleCommand Line Utility


Usage

The Console provides several administrative functions through the `artisan` command line tool. To see the list of available commands, simply run `php artisan` from the Console installation directory:

dfadmin@console:/opt/dreamfactory/dfe/dfe-console$ php artisan
Laravel Framework version 5.1.x (LTS)

Usage:
  command [options] [arguments]

Available commands:
 ...
 dfe
  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           Import a portable instance export
  dfe:manifest         Generates a cluster manifest file (.dfe.cluster.json) for DFE installations.
  dfe:metrics          Gather overall system metrics
  dfe:mount            Create, update, and delete mounts
  dfe:provision        Provision a new instance
  dfe:register         Creates a key pair used to communicate with the DFE Console
  dfe:server           Create, update, and delete servers
  dfe:setup            Initializes a new installation and generates a cluster environment file.
  dfe:token            Generates a token for an instance
  dfe:update           Update DFE Console to the latest version.
 ...

Commands

There are two types of commands: entity and operational. Entity commands (`dfe:cluster`, `dfe:mount`, and `dfe:server`) manage the logical entities within the Console.

dfe:cluster

dfe:deprovision

dfe:export

dfe:import

dfe:manifest

dfe:metrics

dfe:mount

dfe:provision

dfe:register

dfe:server

dfe:setup

dfe:token

dfe:update