Starting and stopping Fledge

Fledge administration is performed using the “fledge” command line utility. You must first ssh into the host system. The Fledge utility is installed by default in /usr/local/fledge/bin.

The following command options are available:

  • Start: Start the Fledge system

  • Stop: Stop the Fledge system

  • Status: Lists currently running Fledge services and tasks

  • Reset: Delete all data and configuration and return Fledge to factory settings

  • Kill: Kill Fledge services that have not correctly responded to Stop

  • Help: Describe Fledge options

For example, to start the Fledge system, open a session to the Fledge device and type:

/usr/local/fledge/bin/fledge start

If authentication is enabled, which is the default mode for Fledge version 3.0 onward, then a number of the commands require authentication. Authentication can be accomplished by several means;

  • Set the environment variable USERNAME to be the user name.

  • Pass the -u flag flag to the command to specify a user name.

  • If neither of the above are done the user will be prompted to enter a user name.

In both cases the user will be prompted to enter a password. It is possible, but not recommended, to set an environment variable PASSWORD or pass the -p flag on the command line, with the plain text version of the password.

$ /usr/local/fledge/bin/fledge -u admin stop
Password:
Stopping Fledge..........
Fledge Stopped

Note

The start, status and help commands do not require authentication.

It is also possible to use certificate based authentication to login to the system. In this case the “fledge” command line utility should be passed the -c flag with the name of the certificate file to use to authenticate.

$ /usr/local/fledge/bin/fledge -c ~/.fledge/admin.cert stop
Stopping Fledge..........
Fledge Stopped

Note

Extreme caution should be taken when storing certificate files that they not be readable by any other user within the system.

Following a successful authentication attempt a time based token is issued that allows the user to run further commands, for a limited time, without the need to authenticate again.