You can copy locally the latest stable in a stand-alone file from: https://github.com/zendtech/ZendServerSDK/raw/master/bin/zs-client.phar
Clone the latest source code
git clone https://github.com/zendtech/ZendServerSDK.git
Then change the directory to the newly created one
cd ZendServerSDK
Install composer
wget http://getcomposer.org/composer.phar
Get all dependant packages.
php composer.phar install --no-dev
Run the phar file with --help to see the available commands:
php zs-client.phar --help
See below for more options. Notice: When using the stable version remember to use zs-client.phar instead of bin/zs-client.php.
Run the following, from the directory where this file is located, to see all commands:
php bin/zs-client.php --help
If you want to see information about certain command only, then run:
php bin/zs-client.php <commandName> --help
You can pack the source code into one stand-alone file that php can read. Run the following command to produce the zs-client.phar file.
php bin/create-phar.php
The generated file should be saved under bin/zs-client.phar. You can copy it and use it without the need to have the other PHP files.
A target is representing the information needed to connect to a Zend Server. Every target contains unique name and must have URL that points to the location of the Zend Server, WebAPI key and secret and optionally a target can contain information about the version of Zend Server.
To add a target run the following command:
php bin/zs-client.php addTarget --target="<put-here-unique-name>" \
--zskey="<put-here-the-webapi-key-name>" \
--zssecret="<put-here-the-webapi-key-hash>" \
--zsurl="<(optional)put-here-valid-url>" \
--zsversion="<(optional)put-here-the-version>"
To update a target run the command with the same --target value and provide the new values.
zsurl: if not specified, the value http://localhost:10081 is used.
zsversion: if not specified, the value 6.1 is used.
The information about the available targets is saved in the home directory of the current user in a file named .zsapi.ini.
Once a target has been defined, specify it in subsequent commands by adding its unique name to the argument list, as in this example:
php bin/zs-client.php monitorGetIssuesListPredefinedFilter \
--target="<unique-name-from-addTarget-command>" \
--filterId="Resources Issues"
You have a PHP application that you want to deploy to Zend Server. In order to use the deployment you will have to enable deployment support, create a package and upload it to the remote server.
Below are the steps that you need to take:
php bin/zs-client.php initZpk --folder="<folder-where-the-PHP-code-is>"
This will add two new files in the specified folder: deployment.xml and deployment.properties.
Using Zend Studio 10 or normal text editor edit the deployment.xml file and change the XML data to match your application name, version, etc.
Run the following command.
php bin/zs-client.php packZpk --folder="<folder-where-the-PHP-code-is>" --destination="<folder-where-the-package-will-be-created>"
It will output the name of the newly created package file. You have to use this name to install or update an existing application on Zend Server. If you want to use other name for the output file you can use the --name="{desired-zpk-name}" option.
There is experimental integration with composer that allows you to download the dependant packages, as described in composer.json, download them and convert them to zpk files. The above command with composer integration will look like this
php bin/zs-client.php packZpk --folder="<folder-where-the-PHP-code-is>" \
--destination="<folder-where-the-package-will-be-created>" \
--composer
The result from the command will be list of packages in the order that they have to be installed (top first, bottom last). Example:
/tmp/zendframework.zend-stdlib-2.2.4.zpk /tmp/zendframework.zend-console-2.2.4.zpk /tmp/zendframework.zend-file-2.2.4.zpk /tmp/zendframework.zend-mvc-2.2.4.zpk /tmp/zendframework.zend-text-2.2.4.zpk /tmp/zendframework.zend-math-2.2.4.zpk /tmp/zendframework.zend-json-2.2.4.zpk /tmp/zendframework.zend-serializer-2.2.4.zpk /tmp/zenddevops.webapi-dev-dev.zpk /tmp/AddYourUniqueApplicationName-1.0.0.zpk
Run the following command to install a package.
php bin/zs-client.php installApp --zpk="<location-of-the-zpk-file>" \
--target="<the-name-of-the-target>" \
--baseUri="<baseUri>"
You can use the same command to update a package. User parameters during the installation can be passed using --userParams="{provide-params-as-query-string}". For example if you want to pass parameter APPLICATION_ENV and DB_TYPE then you can use the following
php bin/zs-client.php installApp --zpk="<location-of-the-zpk-file>" \
--target="<the-name-of-the-target>" \
--baseUri="<baseUri>" \
--userParams="APPLICATION_ENV=staging&DB_TYPE=mysql"
If you use the composer integration then packZpk can create multiple packages, instead of one. Below is a suggestion how you can deploy these newly created packages in the correct order.
ZPKS=`php bin/zs-client.php packZpk --folder="<folder-where-the-PHP-code-is>" \
--destination="<folder-where-the-package-will-be-created>" \
--composer`;
for i in $ZPKS; do
php bin/zs-client.php installApp --zpk="$i" \
--target="<the-name-of-the-target>" \
--baseUri="<baseUri>" \
--userParams="APPLICATION_ENV=staging&DB_TYPE=mysql"
done;
In some cases we may expect slower communication between the client and the server. In that case we can set explicitly the http timeout to a bigger value. The example below shows how to set it to 40 seconds.
php bin/zs-client.php getSystemInfo --target="<name-of-the-target> \
--http="timeout=40"
In most cases the HTTPS access to your Zend Server will use self-signed certificate. In order to instruct the client to accept the SSL certificate you can do the following.
php bin/zs-client.php getSystemInfo --target="<name-of-the-target> \
--http="sslverify=0"
If you want to combine multiple HTTP options in the same request then you can format the value of the http parameter as a valid HTTP query string. Request with timeout of 40 seconds and acceptance of self-signed certificates will look like this.
php bin/zs-client.php getSystemInfo --target="<name-of-the-target> \
--http="timeout&sslverify=0"
If you want to keep the http options saved to a target then when defining or updating the target define also the http parameter. Format the value as valid HTTP query string. Take a look at the following example.
php bin/zs-client.php addTarget --target="<name-of-the-target> \
--zsurl="http://x.y.z" \
--zskey="admin" \
--zssecret="<secret-hash>" \
--http="timeout&sslverify=0"
In the cases where the output is text zs-client supports three formats: xml, which is the default one, json and kv(key value). To specify the desired format you have to use the --output-format parameter.
Example:
php bin/zs-client.php getSystemInfo --target=zserver --output-format=kv
Will return
status=Error
edition=ZendServerCluster
zendServerVersion=7.0.0
supportedApiVersions[0]=application/vnd.zend.serverapi;version=1.2
supportedApiVersions[1]=application/vnd.zend.serverapi;version=1.3
...
supportedApiVersions[6]=application/vnd.zend.serverapi;version=1.8
phpVersion=5.5.13
operatingSystem=Linux
deploymentVersion=2.0
serverLicenseInfo[status]=OK
...
serverLicenseInfo[nodeLimit]=100
serverLicenseInfo[edition]=ENTERPRISE
...
managerLicenseInfo[evaluation]=
For questions and feedback write to slavey (at) zend DOT com.