The Command Line Interface (CLI) provides functionality for managing Private PaaS via the shell. It includes a set of commands that can be issued in order to carry out various operation in WSO2 Private PaaS. To learn about all the available CLI commands, see CLI Commands.
The CLI tool can be operated in two modes:
- Interactive mode allows a human to execute commands against the Stratos Manager.
- Single command line mode allows a computer to execute a command script.
Before you can use the command line in either mode, you must configure the CLI tool and log into Stratos Manager. The rest of this page describes how to log in and use the different modes.
Using interaction mode
To run the CLI tool in interactive mode, log in by entering the following command. (If you do not enter the password, the CLI tool will prompt you for it.)
stratos.sh -u <username> -p <password>
stratos.sh -u firstname.lastname@example.org -p admin123
If you have provided any wrong login parameters, the login help will appear.
To get help, enter the following command:
The output will appear as follows:
Interactive mode supports auto complete. Press the Tab key in the CLI tool to list all the available command options.
Using single command line mode
Users can use this mode to execute commands in one line and directly call the required action as follows. If required, users can export their username and password to the environment and execute commands.
stratos.sh -u [username] -p [password] [action commands]
stratos.sh -u email@example.com -p admin123 [action]