CLI Guide

Following are the CLI commands that are used in WSO2 Private PaaS:

You need to configure the CLI tool before you use CLI commands. For more information, see Configuring CLI Tool.

Entity/ Process	Command	Description
Tenant	`add-tenant`	Add a tenant.
	`activate-tenant`	Activate a tenant.
	`describe-tenant`	Retrieve details of a specific tenant.
	`list-tenants`	Retrieve details of all tenants.
	`list-tenants`	Search for tenants based on the partial domain value entered. The `list-tenants` CLI has been repeated as it has two different uses.
	`update-tenant`	Update a specific tenant.
	`deactivate-tenant`	Deactivate a tenant.
User	`add-user`	Add a user.
	`list-users`	Retrieve details of all users.
	`update-user`	Update a specific user.
	`list-users`	Retrieve details of all users.
	`remove-user`	Delete a user.
Kubernetes Cluster	`add-kubernetes-cluster`	Add a Kubernetes-CoreOS Cluster.
	`list-kubernetes-clusters`	Retrieving details of all Kubernetes-CoreOS Clusters.
	`describe-kubernetes-cluster`	Describe a Kubernetes-CoreOS Cluster.
	`update-kubernetes-master`	Update the master node of the Kubernetes-CoreOS Cluster.
	`describe-kubernetes-master`	Retrieve details of the master in a Kubernetes-CoreOS Cluster.
	`remove-kubernetes-cluster`	Delete a Kubernetes-CoreOS Cluster.
	`add-kubernetes-host`	Add a host to a Kubernetes-CoreOS Cluster.
	`list-kubernetes-hosts`	Retrieve details of all hosts of a Kubernetes-CoreOS Cluster.
	`update-kubernetes-host`	Update the host of a Kubernetes-CoreOS Cluster.
	`remove-kubernetes-host`	Delete the host of a Kubernetes-CoreOS Cluster.
Network Partition	`add-network-partition`	Add a new network partition.
	`list-network-partitions`	Retrieve details of all the network partitions.
	`describe-network-partition`	Describe a network partition.
	`update-network-partition`	Update a specific network partition.
	`remove-network-partition`	Delete a network partition.
Deployment policy	`add-deployment-policy`	Add a deployment policy definition.
	`describe-deployment-policy`	Describe a deployment policy.
	`list-deployment-policies`	Retrieve details of a deployment policy.
	`update-deployment-policy`	Update a deployment policy.
	`remove-deployment-policy`	Delete a deployment policy.
Auto-scaling policy	`add-autoscaling-policy`	Add an auto-scaling policy definition.
	`describe-autoscaling-policy`	Retrieve details of an auto-scaling policy.
	`list-autoscaling-policies`	Retrieve details of auto-scaling policies.
	`update-autoscaling-policy`	Update an auto-scaling policy.
	`remove-autoscaling-policy`	Delete an auto-scaling policy.
Cartridge	`add-cartridge`	Add a cartridge definition.
	`describe-cartridge`	Retrieve details of a cartridge.
	`list-cartridges`	Retrieve details of available cartridges.
	`remove-cartridge`	Delete a cartridge.
Cartridge group	`add-cartridge-group`	Add a cartridge group.
	`describe-cartridge-group`	Describe cartridge group.
	`list-cartridge-groups`	Retrieve details of all the cartridge groups.
	`remove-cartridge-group`	Delete a cartridge group.
Application Policy	`add-application-policy`	Add an application policy.
	`list-application-policies`	Retrieve details of all the application policies.
	`describe-application-policy`	Describe an application policy.
	`update-application-policy`	Update an application policy.
	`remove-application-policy`	Delete an application policy.
Application	`add-application`	Add an application.
	`update-application`	Update an application.
	`describe-application`	Describe an application.
	`list-applications`	Retrieve details of all the applications.
	`describe-application-runtime`	Describe the runtime topology of an application.
	`deploy-application`	Deploy an application.
	`undeploy-application`	Undeploy an application.
	`remove-application`	Delete an application.
Application Sign Up	`add-application-signup`	Add an application sign up.
	`describe-application-signup`	Describe an application sign up of a specific application.
	`remove-application-signup`	Delete an application sign up.
Domain mapping	`add-domain-mappings`	Map domain to a subscribed cartridge.
	`list-domain-mappings`	Retrieve details of domain mappings of an application.
	`remove-domain-mappings`	Remove domain mappings of an application.

Usability	`help`	Used to obtain help about commands in the CLI tool.
Usability	`exit`	Exit from the CLI tool.

The corresponding methods for the above CLI commands can be viewed in the Apache Stratos Git repository in the following directory: [stratos.git]/components/org.apache.stratos.cli/src/main/java/org/apache/stratos/cli/commands/

Tenant

User

Kubernetes Cluster

Network Partition

Deployment policy

Auto-scaling policy

Cartridge

Cartridge group

Application Policy

Application

Application Sign Up

Domain mapping

Usability