command:admin

usersGetList

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

Get users and roles in Zend Server. The data is provided accordingly to the users making the request: non-admin users will get their user only, the received roles will be only their role + parent roles.

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

userGetAuthenticationSettings

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

Get current authentication settings, allowing the user to switch between simple and extended authentication and authorization schemes.

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

usersGetMappedGroups

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

Get current mapped groups (LDAP) for roles and applications.

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

getShowGuidePageFlag

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

Return a flag whether to show guide page or not.

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

changePhpVersion

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

Switch the PHP version.

  • --phpVersion
    The desired PHP version to switch to. Has to be one of the PHP versions supported by Zend Server.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

userAuthentificationSettings

userAuthentificationSettings --type= --ldap= --password= --confirmNewPassword= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Modify current authentication settings, allowing the user to switch between simple and extended authentication and authorization schemes.

  • --type
    One of : simple, extended
  • --ldap
    Array of ldap properties:
    • host: host, ip or location of the active directory
    • port: port part of the URL above
    • encryption:
      • ssl - use SSL to secure communications
      • tls - start TLS to secure communications
      • none - no encryption is used
    • username: directory username, broken to CN and DC parts for use in querying the active directory.
    • password: matching password for the above username
    • baseDn: DN broken down to CN and DC parts for using during user authentication
    • bindRequiresDn: 0 for use with Active Directory, 1 for use with other LDAP services
    • groupsAttribute: Name for a list of user groups’ membership
  • --password
    Current user’s password for authentication
  • --confirmNewPassword
    Confirmation of new password
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

userSetPassword

userSetPassword --username= --password= --newPassword= --confirmNewPassword= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Modify a specific user password. This action changes any user password and is an administrative action. Note that a separate action exists for the user to modify his own password and has a lower permission level.

  • --username
    This username will have his password modified.
  • --password
    Password of the user executing this command.
  • --newPassword
    New password.
  • --confirmNewPassword
    Confirmation of new password.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

setPassword

setPassword --password= --newPassword= --confirmNewPassword= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Modify a current user password.

  • --password
    Current password.
  • --newPassword
    New password.
  • --confirmNewPassword
    Confirmation of new password.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

apiKeysGetList

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

Get a list of api keys.

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

apiKeysAddKey

apiKeysAddKey --name= --username= [--hash=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Add a WebAPI Key.

  • --name
    The name of the key
  • --username
    Any username supplied for retrieving ACL information
  • --hash
    The hash for the key
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

apiKeysRemoveKey

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

Remove a WebAPI Key.

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

serverValidateLicense

serverValidateLicense --licenseName= --licenseValue= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Validate a Zend Server license.

  • --licenseName
    The name of the license
  • --licenseValue
    The value of the license
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

aclSetGroups

aclSetGroups --role_groups= [--app_groups=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Store a set of group mappings for resolving user roles during authentication. These groups correspond to roles within the system or to applications that implicitly grant the developerLimited role to the user.

  • --role_groups
    An associative list of role names and their corresponding group.
  • --app_groups
    An associative list of application IDs (numbers) and their corresponding group.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

bootstrapSingleServer

bootstrapSingleServer [--zsurl=] [--production=] --adminPassword= [--applicationUrl=] [--adminEmail=] [--developerPassword=] [--orderNumber=] [--licenseKey=] --acceptEula [--simple-output] [--wait] [--output-format=]

Bootstrap a server for standalone usage in production or development environment. This action is designed to give an automated process the option to bootstrap a server with particular settings.

  • --zsurl
    The url of the Zend Server to be bootstrapped. Default is http://localhost:10081.
  • --production
    Bootstrap this server using the factory “production” usage profile. Default value: true. If joining a cluster, a special “cluster” value will be stored.
  • --adminPassword
    The new administrator password to store for authentication
  • --applicationUrl
    The default application URL to use when displaying and handling deployed application URLs in the UI. Default: empty
  • --adminEmail
    The default Email to use when sending notifications about events, audit entries and other features
  • --developerPassword
    The new developer user password to be stored for authentication. If no password is supplied, the developer user will not be created
  • --orderNumber
    License order number to store in the server’s configuration. This license can be obtained from zend.com
  • --licenseKey
    License key to store in the server’s configuration. This license can be obtained from zend.com
  • --acceptEula
    Must be set to true to accept ZS6’s EULA
  • --simple-output
    If provided returns simple output with the web api key and secret.
  • --wait
    This operation is asynchronous. When the "wait" option is added the client will wait until the operation really finishes on all servers.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

serverStoreLicense

serverStoreLicense --licenseName= --licenseValue= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Validate and store a Zend Server license key.

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