Command line application to run 4SS management tools. You will need manager ACL permissions to perform tasks using this tool.
4ss_manager |
[--help] [--show-commands] |
Name | Description |
---|---|
-h, --help | show detailed help message |
--show-commands | show system command tree |
Command | Description |
---|---|
4ss_manager backup | Create a low level backup of the entire system. |
4ss_manager init | Initialize the 4Suite repository |
4ss_manager log | Commands to work with the logs |
4ss_manager recompile | Recompile all stylesheets |
4ss_manager restart | Restart the 4Suite server (controller) |
4ss_manager start | Start the 4Suite server (controller) |
4ss_manager stop | Stop the 4Suite server (controller) |
The start command can be used to start any or all protocol servers. To start all of the servers, execute the start command with no paramters. To bring up individual servers, list them on the command line.
4ss_manager start |
[--help] [--username=<username>] [--password=<password>] [--core-id=<name>] [--config-file=<filename>] [--no-daemon] [server-uri] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<username> | connect using the given user name |
-p, --password=<password> | connect using the given password |
-I, --core-id=<name> | use alternative core section (default Core) |
-C, --config-file=<filename> | use alterntive configuration file in the configuration directory |
-n, --no-daemon | Do not detach from the terminal |
Name | Description |
---|---|
server-uri | If specified, set the running state of this server to 'on'. This does not start the 4ss daemon |
Initialize the repository. This involves reformatting the storage back end (e.g. Postgres database or FlatFile root directory) and then adding the core data structures. You will LOSE ALL DATA when you execute the init, unless you use the --update option. You can only init on the machine on which the command is executed. You must have write access to where the back end stores its data (e.g., your userid must be able to write to the Postgres database if the back end is Postgres). You may be prompted for additional information to complete the init.
4ss_manager init |
[--help] [--username=<username>] [--password=<password>] [--core-id=<name>] [--config-file=<filename>] [--confirm] [--update] [--repo-only] [components]... |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<username> | connect using the given user name |
-p, --password=<password> | connect using the given password |
-I, --core-id=<name> | use alternative core section (default Core) |
-C, --config-file=<filename> | use alterntive configuration file in the configuration directory |
-c, --confirm | Confirm before performing each sub-task. |
-r, --update | Don't destroy the current repository, just update the data. |
-o, --repo-only | Only create the bare repository (destroying any current one), and don't install any components. Only useful for development. |
Name | Description |
---|---|
components | Specify which components to add/update in the repository. Allowed values are: 'Demos' - The default 4Suite Repository Demonstration applications and the server to access them; 'Commands' - 4ss and 4ss_manager commands and documentation. These are needed to be able to use the 4ss and 4ss commandline tools; 'Dashboard' - The web-based control panel for 4Suite; 'Docs' - All 4Suite documentation; 'Data' - Commonly used 4Suite data and icons (required; must be first component installed); 'Servers' - The default FtRpc and Ftp Server. |
Manager commands to work with the log files
4ss_manager log |
[--help] [--username=<username>] [--password=<password>] [--core-id=<name>] [--config-file=<filename>] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<username> | connect using the given user name |
-p, --password=<password> | connect using the given password |
-I, --core-id=<name> | use alternative core section (default Core) |
-C, --config-file=<filename> | use alterntive configuration file in the configuration directory |
Command | Description |
---|---|
4ss_manager log clear | Clear a 4SS Log |
4ss_manager log view | View a 4SS Log |
Clear the logs
4ss_manager log clear |
[--help] [--username=<username>] [--password=<password>] [--core-id=<name>] [--config-file=<filename>] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<username> | connect using the given user name |
-p, --password=<password> | connect using the given password |
-I, --core-id=<name> | use alternative core section (default Core) |
-C, --config-file=<filename> | use alterntive configuration file in the configuration directory |
View the logs
4ss_manager log view |
[--help] [--username=<username>] [--password=<password>] [--core-id=<name>] [--config-file=<filename>] [--bytes=<N>] [--lines=<N>] [--sleep-interval=<S>] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<username> | connect using the given user name |
-p, --password=<password> | connect using the given password |
-I, --core-id=<name> | use alternative core section (default Core) |
-C, --config-file=<filename> | use alterntive configuration file in the configuration directory |
-c, --bytes=<N> | output the last N bytes |
-n, --lines=<N> | output the last N lines, instead of the last 10 |
-s, --sleep-interval=<S> | sleep for approximately S seconds (default 1.0) between iterations |
The recompile command will walk the entire repository and recompile all stylesheets. It is useful when changes to the underling code base require that stylesheets be reinited in the system.
4ss_manager recompile |
[--help] [--username=<username>] [--password=<password>] [--core-id=<name>] [--config-file=<filename>] [basePath] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<username> | connect using the given user name |
-p, --password=<password> | connect using the given password |
-I, --core-id=<name> | use alternative core section (default Core) |
-C, --config-file=<filename> | use alterntive configuration file in the configuration directory |
Name | Description |
---|---|
basePath | A base path, only resources below this in the repo will get recompiled. |
Create a lowlevel system backup of the entire repository.
4ss_manager backup |
[--help] [--username=<username>] [--password=<password>] [--core-id=<name>] [--config-file=<filename>] [--exclude=<exclude>] [--directory=<directory>] [--modified-since=<modified-since>] [--quiet] [--user-model] [--archive=[gztar|ztar|bztar|zip|tar]] [base-path]... |
Name | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
-h, --help | show detailed help message | ||||||||||
-u, --username=<username> | connect using the given user name | ||||||||||
-p, --password=<password> | connect using the given password | ||||||||||
-I, --core-id=<name> | use alternative core section (default Core) | ||||||||||
-C, --config-file=<filename> | use alterntive configuration file in the configuration directory | ||||||||||
-e, --exclude=<exclude> | Exclude a path (and all children) from backup (multiple allowed) | ||||||||||
-d, --directory=<directory> | Directory to backup too. | ||||||||||
-m, --modified-since=<modified-since> | Only backup files modified since specified ISO datetime | ||||||||||
-q, --quiet | No extra output | ||||||||||
--user-model | Also dump the user model | ||||||||||
--archive=[gztar|ztar|bztar|zip|tar] | Create an archive (not all options will work on all platforms!!)
Allowed Values:
|
Name | Description |
---|---|
base-path | Initial resources to start the backup at. |
The stop command is used to stop any or all of the 4SS servers. To stop all the servers, execute the stop command with out any arguments. To stop an individual server, specify their names as command line arguments. You will be prompted for authentication before you can stop the servers.
4ss_manager stop |
[--help] [--username=<username>] [--password=<password>] [--core-id=<name>] [--config-file=<filename>] [server-uri] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<username> | connect using the given user name |
-p, --password=<password> | connect using the given password |
-I, --core-id=<name> | use alternative core section (default Core) |
-C, --config-file=<filename> | use alterntive configuration file in the configuration directory |
Name | Description |
---|---|
server-uri | If specified, set the running state of this server to 'off'. This does not stop the 4ss daemon |
Restart the 4Suite server (controller).
4ss_manager restart |
[--help] [--username=<username>] [--password=<password>] [--core-id=<name>] [--config-file=<filename>] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<username> | connect using the given user name |
-p, --password=<password> | connect using the given password |
-I, --core-id=<name> | use alternative core section (default Core) |
-C, --config-file=<filename> | use alterntive configuration file in the configuration directory |