command:virtualhost

vhostGetStatus

vhostGetStatus [--vhosts=] [--limit=] [--offset=] [--order=] [--direction=] [--filters=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Get the list of virtual hosts currently used by the web server and information about each virtual host.

  • --vhosts
    Comma separated list of virtual host IDs.
  • --limit
    The number of rows to retrieve. Default lists all vhost entries up to an arbitrary limit set by the system
  • --offset
    A paging offset to begin the list from. Default: 0
  • --order
    Column identifier for sorting the result set (name, last_updated, port, owner). Default: name
  • --direction
    Sorting direction: ASC or DESC. Default: DESC
  • --filters
    Add filter parameters in an ad-hoc manner. These filters will be added to the predefined filter that was passed. This parameter is an array with a predefined set of parameters that accept arrays to hold multiple values:
    • ssl: array, a list of ssl support (ssl_enabled, ssl_disabled)
    • type: array, a list of vhost type (system_defined, zs_defined)
    • deployment: array, a list of deployment status (deployment_enabled, deployment_disabled)
    • freeText: string
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

vhostRemove

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

Remove the list of virtual hosts currently used by the web server and information about each virtual host.

  • --vhosts
    Comma separated list of virtual host IDs.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

vhostAdd

vhostAdd --name= --port= [--template=] [--forceCreation=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Add a new virtual host. Receives name, port and template and returns a single virtual host element with the same information.

  • --name
    Name of virtual host.
  • --port
    Port of virtual host.
  • --template
    Template of the virtual host settings according to the web server configuration options. Or an absolute path to a local template vhost file. A local template vhost file is a file that must be present on the machine where zs-client is running.
  • --forceCreation
    Force the creation of a virtual host, even if it fails syntax validation. Default: FALSE
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

vhostAddSecure

vhostAddSecure --name= --port= --sslCertificatePath= --sslCertificateKeyPath= [--sslCertificateChainPath=] [--template=] [--forceCreation=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Add a new vhost which is intended to be secure using SSL. This action is similar to vhostAdd. It receives name, port, template, and certificate paths and returns a single virtual host element with the same information.

  • --name
    Name of virtual host.
  • --port
    Port of virtual host.
  • --sslCertificatePath
    File path to locate the SSL certificate file. The file must be present on the machine where Zend Server is running.
  • --sslCertificateKeyPath
    File path to locate the SSL public key file. The file must be present on the machine where Zend Server is running.
  • --sslCertificateChainPath
    Full file path to the SSL chain file. The file must be present on the machine where Zend Server is running.
  • --template
    Template of the virtual host settings according to the web server configuration options. Or an absolute path to a local template vhost file. A local template vhost file is a file that must be present on the machine where zs-client is running.
  • --forceCreation
    Force the creation of a virtual host, even if it fails syntax validation. Default: FALSE
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

vhostAddSecureIbmi

vhostAddSecureIbmi --name= --port= --sslAppName= [--template=] [--forceCreation=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Add a new virtual host which is intended to be secure using SSL. Receives name, port, template and certificate application name and returns a single virtual host element with the same information.

  • --name
    Name of virtual host.
  • --port
    Port of virtual host.
  • --sslAppName
    Application name for SSL.
  • --template
    Template of the virtual host settings according to the web server configuration options. Or an absolute path to a local template vhost file. A local template vhost file is a file that must be present on the machine where zs-client is running.
  • --forceCreation
    Force the creation of a virtual host, even if it fails syntax validation. Default: FALSE
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

vhostEdit

vhostEdit --vhostId= --template= [--forceCreate=] [--sslEnabled=] [--sslCertificatePath=] [--sslCertificateKeyPath=] [--sslCertificateChainPath=] [--sslAppName] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Get the list of virtual hosts currently used by the web server and information about each virtual host.

  • --vhostId
    The ID of the virtual host.
  • --template
    New vhost template of virtual host settings. Or an absolute path to a local template vhost file. The local template vhost file must be present on the machine where zs-client is running.
  • --forceCreate
    Force edit of the virtual host template even if any errors are detected.
  • --sslEnabled
    Indicates whether the provided template is an SSL template. Default value is FALSE.
  • --sslCertificatePath
    File path to locate the SSL certificate file. The file must be present on the machine where Zend Server is running.
  • --sslCertificateKeyPath
    File path to locate the SSL key file. The file must be present on the machine where Zend Server is running.
  • --sslCertificateChainPath
    File path to locate the SSL chain file. The file must be present on the machine where Zend Server is running.
  • --sslAppName
    Application name for SSL (IBMI only).
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

vhostGetDetails

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

Get the list of virtual hosts currently used by the web server and full information about each virtual host.

  • --vhost
    The ID of a single virtual host.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

vhostValidateSsl

vhostValidateSsl --sslCertificatePath= --sslCertificateKeyPath [--sslChainPath=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Validate the existence of the supplied SSL certificate, key and chain provided during creation or edit of a virtual host.

  • --sslCertificatePath
    Full filepath to the ssl certificate file.
  • --sslCertificateKeyPath
    Full filepath to the ssl key file.
  • --sslChainPath
    Full filepath to the chain file.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

vhostValidateTemplate

vhostValidateTemplate --name= --port= --template= [--sslEnabled=] [--sslCertificatePath=] [--sslCertificateKeyPath=] [--sslChainPath=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Validate the existence of the supplied SSL certificate, key and chain provided during creation or edit of a virtual host.

  • --name
    Name of virtual host.
  • --port
    Port of virtual host.
  • --template
    Template text to be validated. Or an absolute path to a local template vhost file. A local template vhost file is a file that must be present on the machine where zs-client is running.
  • --sslEnabled
    Indicates if the provided template to be used is SSL template.
  • --sslCertificatePath
    File path to locate the SSL certificate file. The file must be present on the machine where Zend Server is running.
  • --sslCertificateKeyPath
    File path to locate the SSL public key file. The file must be present on the machine where Zend Server is running.
  • --sslCertificateChainPath
    Full file path to the SSL chain file. The file must be present on the machine where Zend Server is running.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

vhostRedeploy

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

Get the list of virtual hosts currently used by the web server and full information about each virtual host.

  • --vhost
    The ID of a single virtual host.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

vhostEnableDeployment

vhostEnableDeployment --vhost= [--applyImmediately=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Enable deployment to a system virtual host. This action requires user intervention. Enabling deployment is performed in two stages:

  • A file is created to contain the overriding virtual host configuration.
  • A blueprint entry is created to control and monitor the virtual host (performed if applyImmediately is TRUE).
After these two steps, the user is expected to link this new configuration file to the server’s virtual host section of the configuration file. This step is required because Zend Server generally does not have the write permissions needed to perform the action. The split to two workflow modes allows the user to create a minimal setup, complete the file system part of the workflow and only then enforce blueprint control. Changes will come into effect only after a full restart anyway.

  • --vhost
    The ID of a single virtual host.
  • --applyImmediately
    False: will only create an overriding configuration file. True: will create an overriding configuration.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

vhostDisableDeployment

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

Disable deployment to system virtual host that was enabled for deployment.

  • --vhost
    The ID of a single virtual host.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.