This documentation is for WSO2 Private PaaS 4.1.0. View documentation for the latest release.
Configuring the CLI Tool - WSO2 Private PaaS 4.1.0 - WSO2 Documentation
Skip to end of metadata
Go to start of metadata

Administrators can use the PPaaS Command Line Interface (CLI), which is Java based, to carryout a host of actions (e.g., add a tenant, add a network partition, and more).

Follow the instructions below to configure the CLI tool:

If you have not deployed Private PaaS already, make sure to start Private PaaS before carrying out the following instructions. For more information, see the respective section under Deploy Private PaaS.

  1. Download the CLI binary distribution, from the PPaaS product page, and unzip it. The unzipped folder will be referred to as <CLI_HOME>.

  2. Export the host and port of the Stratos Manager (SM) as environment variables before using the CLI tool.
    • On Mac OS X you need to add the following to your .bash_profile file
    • On Linux you need to add the following to your .bashrc file.

      export STRATOS_URL=https://<PRIVATE_PAAS_IP>:<PORT>

      For example:

      export STRATOS_URL=https://localhost:9443
  3. Ensure that your Java home and Java path  environmental variables have been set in your .bash_profile (on Mac) or .bashrc (on Linux) file.

  4. Navigate to the  <CLI_HOME>/bin directory.

    cd <CLI_HOME>/bin
  5. Add execute permissions to the script.

    chmod +x ./
  6. Optionally, you can export your username and password as environment variables.

    If you only export your username, you will be prompted to enter your password.

    export STRATOS_USERNAME=<username>
    export STRATOS_PASSWORD=<password>
  7. Log into the CLI tool using the following command:

    ./ -u admin -p admin
    If you have not exported your username and password.
    ./ -p admin
    If you have only exported your username.
    If you have exported your username and password or if you wish to be prompted for your username and password later.

    For more information on how to use the CLI tool, see the CLI Tool Guide.

  • No labels