Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Getting started with CLI

...

  • Call stratos.sh to log-in to Stratos Controller using this mode:
    As mentioned previously, providing the password as an argument is optional. The CLI tool will prompt for the password.

    Code Block
    $ stratos.sh  -u <username> -p <password>


    Example:
    $ stratos.sh  -u admin@wso2.org   -p admin123

    The log-in help will be shown, if you have provided wrong parameters to log-in.
    As mentioned previously, the password is prompted only if the password argument is not passed.

  • Once you have successfully logged in, you can use the help command to get an idea of the various actions that can be carried out via the interactive command line shell interface named Stratos .

    Code Block
    stratos> help

    The output will appear as follows:

     

...

Code Block
stratos>subscribe php nirmalphp --policy elastic


CLI commands

The following are To learn about all the available CLI tool commands.

Table of Contents
minLevel5

Cartridges

This CLI command lists the available Cartridges.

Code Block
stratos> cartridges

Output

Image Removed

 

Policies

This CLI command lists the available policies.

Code Block
stratos> policies

Output

Image Removed

Subscribe

This CLI command is used to subscribe to a Cartridge.

Code Block
stratos> subscribe [Cartridge type] [Cartridge alias] -c <data cartridge type> -d <alias> -i <privateRepo> -o <policy name> -p <password> -r <>

 

Image Removed

Unsubscribe

This CLI command is used to unsubscribe from a Cartridge.

Sync

This CLI command is used to synchronize the GIT repository for subscribed Cartridges.

Domain mapping
Add domain mapping

This CLI command is used to map the domain to a subscribed Cartridge.

Remove domain mapping

This CLI command is used to remove the domain mapping for a subscribed Cartridge.

List

This CLI command is used to get a list of the subscribed Cartridges together with their details.

Code Block
stratos> list

Output

Image Removed

Info

This CLI command is used to get information on a subscribed Cartridge.

Code Block
stratos> info
Help
  • This CLI command is used to get help on the available commands.

    Code Block
    stratos> help

     

  • This CLI command is used to get in-depth details on a specific command.

    Code Block
    stratos> help [command]

     Example:

    Code Block
    stratos> help subscribe

...

commands, please see CLI Commands.