Working with CLI Tools

This procedure describes how to use CLI Tools to perform common setup operations, as well as Web API operations, using the example of launching Zend Server (bootstrap-single-server). The specified workflow is recommended for all supported actions.

Note:

CLI Tools can be used by Zend Server on Linux and IBMi.

Instructions on how to complete a procedure

To use CLI Tools:

  1. In your CLI, enter a general help command to get a menu of all the available commands and common arguments:

/usr/local/zend/bin/zs-manage --help

  1. Enter a help command for the action you would like to perform to learn which elements your command should consist of:

/usr/local/zend/bin/zs-manage bootstrap-single-server --help

  1. Enter your command with the required elements:

/usr/local/zend/bin/zs-manage bootstrap-single-server -p <YourPassword> -o <YourOrderNumber> -l <YourLicenseKey> -a True -u <DefaultApplicationURL> -U <ServerURL>

 

Important!

After successfully entering a CLI command for launching Zend Server, you are provided with a WebAPI key that consists of a key name and key hash. You will need these details for additional commands.

zs-manage Commands

The list of available commands can be viewed by running the command: '<install path>/zs-manage --h'. All commands are also available in the Web API Reference Guide.

Note:

See Resetting Passwords for information on a separate CLI utility for externally resetting passwords.

CLI Commmand Description

api-keys-add-key

Add a Web API key.

api-keys-get-list

List Web API keys.

app-deploy

Deploy an application.   

app-get-status

Show the status of applications on a server/cluster. By default will return status on all applications.

app-remove

Remove an application.

app-rollback

Rollback an application.

app-synchronize

Synchronize an application on a server, a set of servers or a cluster.   

app-update

Update an application.

bootstrap-single-server

Bootstrap a server for standalone usage in production or development environment.

cluster-add-server

Add a new (unbootstrapped) Zend server to a cluster.

cluster-disable-server

Disable a Zend Server cluster member.

cluster-enable-server

Enable a disabled Zend Server cluster member.

cluster-list-servers

List servers in the cluster and show their status.

cluster-reconfig-server

Reconfigure a cluster member to match the cluster's profile.

cluster-remove-server

Remove a server from a cluster.

config-apply-changes

Apply the configuration changes on a given server to the blueprint. In a clustered environment, this will apply the changes to all serv ers in the cluster. This should be done if you manually edited .conf files.

extension-off

Disable a PHP extension.

extension-on

Enable a PHP extension.

library-deploy

Deploy a library.

library-get-status

Get the library's status.

library-remove

Remove a library with all its versions.

library-version-remove

Remove a library version.

restart

Restart the PHP and components that need to be restar ted on the server, or on all the servers in the cluster - in the case of a clustered environment.

restart-php

Restart the PHP and components that need to be restar ted on the server, or on all the servers in the cluster - in the case of a clustered environment.

server-add-to-cluster

Add a new (bootstrapped) Zend server to a cluster. Connects directly to MySQL.

store-directive

Change directive value.

system-info   

Get information about the remote Zend Server system.

vhost-add

Add a new vhost to Zend Server's Web server.

vhost-add-secure

Add a new secure SSL vhost to Zend Server's Web server.

vhost-get-status

Get the list of virtual hosts currently used by the Web server and information about each vhost.

vhost-remove

Remove a vhost by its ID.