command:deployment

applicationAttachVhosts

applicationAttachVhosts --appId= --vhosts= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=] 

Attach virtual hosts to application.

• --appId
  Application id.
• --vhosts
  Array with virtual hosts ids
• --output-format
  Output format. Default is "xml", but you can use "json", or "kv" for key-value.

applicationDetachVhosts

applicationDetachVhosts --appId= --vhosts= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=] 

Detach Virtual hosts from application.

• --appId
  Application id.
• --vhosts
  Array with virtual hosts ids
• --output-format
  Output format. Default is "xml", but you can use "json", or "kv" for key-value.

getApplicationsSimpleList

getApplicationsSimpleList [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=] 

Simple application list: id -> name.

• --output-format
  Output format. Default is "xml", but you can use "json", or "kv" for key-value.

applicationGetStatus

applicationGetStatus [--applications=] [--direction=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=] 

Get the list of applications currently deployed (or staged) on the server or the cluster, and information about each application. If application IDs are specified, this method will return information about the specified applications. If no IDs are specified, this method will return information about all applications on the server or cluster.

• --applications
  A list of application IDs. If specified, information will be returned about the specific applications only. If not specified, information about all applications will be returned. If a non-existing application ID is provided this action will not fail but instead will return no information about the specific application.
• --direction
  One of ASC|DESC. Sets the ordering direction. Ordering is always by User application name.
• --output-format
  Output format. Default is "xml", but you can use "json", or "kv" for key-value.

applicationDeploy

applicationDeploy --appPackage= --baseUrl= [--createVhost=] [--defaultServer=] [--userAppName=] [--ignoreFailures=] [--userParams=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=] 

Deploy a new application to the server or cluster. This process is asynchronous, meaning the initial request will wait until the application is uploaded and verified, and the initial response will show information about the application being deployed. However, the staging and activation process will proceed after the response is returned. You must continue checking the application status using the applicationGetStatus method until the deployment process is complete.

• --appPackage
  The application package file.
• --baseUrl
  The base URL to which the application will be deployed. This must be an HTTP URL.
• --createVhost
  Create a virtual host based on the base URL (if the virtual host wasn't already created by Zend Server). The default value is FALSE.
• --defaultServer
  Deploy the application on the default server. The provided base URL will be ignored and replaced with '<default-server>'. If this parameter and createVhost are both used, createVhost will be ignored. The default value is FALSE.
• --userAppName
  Free text for a user defined application identifier. If not specified, the baseUrl parameter will be used.
• --ignoreFailures
  Ignore failures during staging if only some servers report failures. If all servers report failures the operation will fail in any case. The default value is FALSE, meaning any failure will return an error.
• --userParams
  Set values for user parameters defined in the package. Depending on package definitions, this parameter may be required. Each user parameter defined in the package must be provided as a key for this parameter.
  
• --output-format
  Output format. Default is "xml", but you can use "json", or "kv" for key-value.

Example:

applicationDeploy --appPackage=/path/to/application.zpk --baseUrl="http://test.domain.com/" --userParams="APPLICATION_ENV=staging&p[a]=1&p[b]=2"

applicationUpdate

applicationUpdate --appId= --appPackage= [--ignoreFailures=] [--userParams=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=] 

Update an existing application. The package you provide must contain the same application. Additionally, any new parameters or new values for existing parameters must be provided. This process is asynchronous, meaning the initial request will wait until the package is uploaded and verified, and the initial response will show information about the new version being deployed. However, the staging and activation process will proceed after the response is returned. You must continue checking the application status using the applicationGetStatus method until the deployment process is complete.

• --appId
  The application ID you would like to update.
• --appPackage
  The application package file.
• --ignoreFailures
  Ignore failures during staging if only some servers report failures. If all servers report failures the operation will fail in any case. The default value is FALSE, meaning any failure will return an error.
• --userParams
  Set values for user parameters defined in the package. Depending on package definitions, this parameter may be required. Each user parameter defined in the package must be provided as a key for this parameter.
• --output-format
  Output format. Default is "xml", but you can use "json", or "kv" for key-value.

Example:

applicationUpdate --appId=3 --appPackage=/path/to/application-v0.3.zpk --userParams="APPLICATION_ENV=staging&p[a]=1&p[b]=2"

applicationRemove

applicationRemove --appId= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=] 

Remove an existing application. This process is asynchronous, meaning the initial request will start the removal process and the initial response will show information about the application being removed. However, the removal process will proceed after the response is returned. You must continue checking the application status using the applicationGetStatus method until the removal process is complete. Once applicationGetStatus contains no information about the application, it has been completely removed.

• --appId
  The application ID you would like to remove.
• --output-format
  Output format. Default is "xml", but you can use "json", or "kv" for key-value.

applicationSynchronize

applicationSynchronize --appId= [--servers=] [--ignoreFailures=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=] 

Synchronizing an existing application, whether in order to fix a problem or to reset an installation. This process is asynchronous, meaning the initial request will start the synchronize process and the initial response will show information about the application being synchronized. However, the synchronize process will proceed after the response is returned. You must continue checking the application status using the applicationGetStatus method until the process is complete.

• --appId
  The application ID you would like to synchronize.
• --servers
  Comma separated list of server ID's. If defined, the action will be done only on the servers whose ID's are specified and which are currently members of the cluster.
• --ignoreFailures
  Ignore failures during staging or activation if only some servers report failures. If all servers report failures the operation will fail in any case. The default value is FALSE, meaning any failure will return an error.
• --output-format
  Output format. Default is "xml", but you can use "json", or "kv" for key-value.

applicationRollback

applicationRollback --appId= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=] 

Roll back an existing application to its previous version. This process is asynchronous, meaning the initial request will start the rollback process and the initial response will show information about the application being rolled back. You must continue checking the application status using the applicationGetStatus method until the process is complete.

• --appId
  The application ID you would like to rollback.
• --output-format
  Output format. Default is "xml", but you can use "json", or "kv" for key-value.

applicationGetDetails

applicationGetDetails --application= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=] 

Retrieve package and meta information about a deployed application. This action provides the most complete list of information about a single application we can provide.

• --application
  An application ID.
• --output-format
  Output format. Default is "xml", but you can use "json", or "kv" for key-value.

redeployAllApplications

redeployAllApplications [--servers=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=] 

Redeploy all applications currently registered in the system for the specified servers. This action only sends the operation request and will not wait on completion.

• --servers
  List of servers to perform the operation on. Default: All servers.
• --output-format
  Output format. Default is "xml", but you can use "json", or "kv" for key-value.

Example:

redeployAllApplications --servers="1,4"

applicationDefine

applicationDefine --name= --baseUrl= [--version=] [--healthCheck=] [--logo=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=] 

Define an application to the server or cluster. This process is asynchronous – the initial request will wait until the application is defined, and the initial response will show information about the application being defined – however the staging and activation process will proceed after the response is returned. The user is expected to continue checking the application status using the applicationGetStatus method until the deployment process is complete.

• --name
  Application name.
• --baseUrl
  Base URL to define the application to. Must be an HTTP URL. use <default-server> if needed.
• --version
  The version of the application.
• --healthCheck
  The health check url.
• --logo
  Logo image file.
• --output-format
  Output format. Default is "xml", but you can use "json", or "kv" for key-value.