1 ACC Command Reference #
Command Line Parameters If you specify a < Command>, ACC starts in command mode, executes only the command passed on the command line, and then exits. Syntax
acc <parameters> [<Command>]
| Switch | Value | Description |
|---|---|---|
| -?, --help | Show command line parameter help | |
| -c, --config | Relative or absolute path to a config file | Path to a configuration file. A configuration file is basically a template, but might contain a subset of ACC configuration commands such as the register app type and set acc cfg commands. If no configuration file is specified, ACC will look for a file named acc.cfg in the current working directory. |
| -f, --file | Relative or absolute path to a command file. | Path to a command file. Use this parameter to start ACC in batch mode, executing the commands in the given command file. Put the path in double quotes if the path contains any whitespaces. |
| -s, --silent | - (toggle) | Enables silent mode. When using ACC in batch mode, the output of the commands is suppressed, if silent mode is enabled. By default, silent mode is disabled. |
| any ACC command | To pass a command for running ACC in command mode. | |
| -h, --host | String (IP or Hostname) | The host name or IP address of the single cloud node on which you want to issue commands. ACC is invoked with an implicit add node command using the given host name followed by a set current node command. The logical node name used is the first part of the host name if a host name was used as parameter, or the first part of the host name determined by a reverse name lookup if an IP address was used as parameter. |
| -p, --port | Positive integer 1 - 65535 (Port) Default=9000 | The port of ACC's REST API on the single cloud node on which you want to issue commands, see -h switch. |
| -u, --username | The user name to use when connecting directly to an agent with the -h option. | Used to specify the user name to use when connecting directly to an agent with enabled authentication using the -h command-line option *.* |
| -pwd, --password | The password to use when connecting directly to an agent with the -h option. | Used to specify the password to use when connecting directly to an agent with enabled authentication using the -h command-line option *. * If a user name is specified with –u, but –pwd is not given, ACC will prompt you for the password. |
| -n, --nodefile | Relative or absolute path to a node file. | File containing the list of nodes that are part of this cloud. Allows factoring out of node-specific information (host names/IPs and ports) of the template, thereby making the templates reusable in different environments without any editing. Put the path in double quotes if it contains any whitespace. Two formats supported: • Old format, where every node is given on a separate line using the syntax <node-Name>=<ipOrHostName> '@' <agentPort> ; • New format, where the file only contains add node commands. |
| -ssl, --use-ssl | true/false or on/off Default=false/off | Specify a value of true or on to connect to an agent using SSL/HTTPS for its REST API. |
| -ig, --ignore-errors | - (toggle) Default=off | If set, processing of a command file will continue even if one of the contained commands fails. |
1.1 ACC Commands #
ACC commands can be grouped into five categories:
- Node management commands that enable adding or removing nodes to the ACC's control.
- Zookeeper ensemble management commands that enable adding or removing Zookeeper instances to different nodes.
- Lifecycle commands that enable controlling the lifecycle of executables on the respective node.
- Agent configuration commands that enable setting and getting the configuration parameters of the agent on the respective node.
- ACC configuration commands that enable changing ACC configuration. For example, to register application types or set other configuration parameters.
In addition, a number of special commands exist when you use ACC in interactive mode.
Commands can optionally be prefixed with a node specification (on node <nodeName>) referred to as <nodeSpec> in the syntax description of the commands to send them to a node other than the current node. Optional ACC command parameters are marked in (round brackets followed by)?
| Command and Syntax | Description |
| list nodes list nodes | Lists the currently registered cloud nodes. |
| show nodes show nodes | Shows details of the specified node. |
| Add node Add node <nodeName> <ipOrHostName> (@ <agentPort>)? (<username> <password>?)? | Registers a new cloud node with the specified IP or hostname node with ACC under the specified logical node name. Allows to optionally specify the port of the REST API of the node's agent if default is not used. |
| remove node remove node <nodeName> | Unregisters the cloud node with the specified logical node name. |
| add zk instance <nodeSpec>? add (zkl zookeeper) (master l observer)? instance? (using instanceId? <instanceId>)? | Adds a new zookeeper (ZK) instance to the cloud's zookeeper ensemble on the specified node or to the current node if no node name is specified. Allows to optionally specify the instanceId to be used for the new zookeeper instance. If instanceId is not specified, ACC will automatically choose an instanceId. Note: Change is committed only after the commit zk changes command. |
| remove zk instance <nodeSpec>? remove (zkl zookeeper) instance? (instanceId? <instanceId>)? l\t remove (zkl zookeeper) instance? (myId? <myId>) | Removes a zookeeper instance from the cloud's zookeeper ensemble. The zookeeper instance to be removed can be identifier either by specifying the node name and the instanceId of the zookeeper instance or the myId of the zookeeper instance. |
| show zk changesshow pending?(zk l zookeeper) (change l changes) | Shows the currently pending changes of the zookeeper ensemble that will be committed after the commit zk changes command. |
| commit zk changes commit pending? (zk l zookeeper) (change l changes) force? | Commits all currently pending changes of the zookeeper ensemble. |
| validate zk changes validate pending? (zk l zookeeper) (change l changes) | Validates the currently pending changes of the zookeeper ensemble. |
| discard zk changes discard pending? (zk l zookeeper) (change l changes) | Discards all currently pending changes of the Zookeeper ensemble. |
| list zk instance list (zk l zookeeper) instances | Lists all Zookeeper instances of the ensemble with their configuration. |
| list runnables list (instances l runnables) | Lists all the executables that are configured on the specified node or the current node if no node name is specified. |
| configure <nodeSpec>? configure <groupId>.<artifactId> <version> <instInstancId> (<key> <value> (, <value>)*)* (enhance with <enhancement> (, <enhancement>)*)? | Configures a new executable with the specified group ID, artifact ID, and version using the specified instance ID. Configuration parameters can be specified as key-value pairs (or list of comma-separated values). Values can be integers , identifiers , or Strings (arbitrary sequences of characters, delimited by double-quotes ()). Identifiers are strings starting with a letter or the underscore character ('_'), and containing only letters, digits, dashes ('-') or the underscore character ('_'). Enhancements can be specified. |
| start'<nodeSpec>? start <instanceId> | Starts the executable with the specified instance ID on the specified node or the current node, if no node name is specified. |
| stop'<nodeSpec>? stop <instanceId> | Stops the executable with the specified instance ID on the specified node or the current node, if no node name is specified. |
| kill'<nodeSpec>? kill <instanceId> | Kills the executable with the given instance ID on the specified node or the current node, if no node name is specified. |
| reconfigure'<nodeSpec>? reconfigure <instanceId> (+? <key> <value> (, <value>)* l - <key>)* | Reconfigures the executable with the specified instance ID on the specified node or the current node, if no node name is specified. Just like the configure command, configuration parameters can be specified as key-value pairs (or list of comma-separated values). Values can be integers, identifiers (strings starting with a letter or the underscore character ('_'), and containing only letters, digits, dashes ('-') or the underscore character ('_')), or Strings (arbitrary sequences of characters, delimited by double-quotes (')). Reconfigure will reset any existing parameterization of the executable to only contain those key-value pairs passed to it. Optionally, reconfigure can also be used to only modify or remove selected key value pairs. Do this by prefixing each key-value pair with a + character. To remove a value set for a key, use only the key prefixed with -. |
| deconfigure<nodeSpec>? deconfigure <instanceId> | Removes the configuration of the executable with the specified instance ID from the specified node or from the current node, if no node name is specified. WARNING: You will lose all persistent data stored by this executable. |
| show instance<nodeSpec>? show (runnable l instance) <instanceId> (cfg l config l configuration) | Shows configuration details of the executable identified by the specified instance ID on the specified node or on the current node, if no node name is specified. |
| update<nodeSpec>? update (force l check only?)? <instanceId> (to? <version>)? | Updates the executable identified by the specified instance ID on the specified node (or on the current node, if no node name is specified) to the specified version. The executable must be to be stopped before updating. If no version is specified and application type exists matching the executable, it will update it to the version specified by the application type if the version of the application type is newer than the version of the executable. If check only is specified, the command will only check if an update would be performed for the executable. If the force option is used, the command will not ask the user for confirmation of the update. |
| startall<nodeSpec>? startall | Starts all executables on the specified node (or the current node, if no node name is specified) that are not currently in STARTED or STARTING state. |
| stopall<nodeSpec>? stopall | Stops all executables on the specified node (or the current node, if no node name is specified) that are currently in STARTED state. |
| killall<nodeSpec>? killall | Kills all executables on the specified node (or the current node, if no node name is specified) that are currently not in STOPPED or DOWN state. |
| deconfigureall<nodeSpec>? deconfigureall | Removes configuration of all the executables on the speci-fied node (or the current node, if no node name is specified) that are currently in STOPPED or DOWN state. WARNING: You will lose any persistent data stored by the executables, if you remove the configuration. |
| updateall<nodeSpec>? updateall | Updates all executable that are currently not running on the specified node (or the current node, if no node name is specified) to the latest version. The latest version is determined based on the registered application types as described for update command. If you specify the check only option, the command will only check if an update would be performed for the executables. If the specify the force option, the command will not ask the user for confirmation of the update. |
| reset node<nodeSpec>? reset l reset node <nodeName> | Resets the specified node (or the current node, if no node name is specified). This means that any process that has been started directly or indirectly by the agent is killed, configuration from all executables is removed, and the agent is reset. WARNING: You will lose all persistent data stored by all executable on the node. |
| restart agent<nodeSpec>? restart agent | Restarts the agent on the specified node (or the current node, if no node name is specified). |
| show agent<nodeSpec>? show agent (cfg l config l configuration) | Shows the configuration parameters of the cloud agent on the specified node (or the current node, if no node name is specified). |
| set agent<nodeSpec>? set <key> <value> (, <value>)* | Sets the specified configuration parameter of the cloud agent on the specified node (or the current node, if no node name is specified) to the specified value (or list of comma-separated values). Values can be integers, identifiers (strings starting with a letter or the underscore character ('_'), and containing only letters, digits, dashes ('-') or the underscore character ('_')), or Strings (arbitrary sequences of characters, delimited by double-quotes ()). |
| get agent param'<nodeSpec>? get <key> | Gets the specified configuration parameter of the cloud agent on the specified node (or the current node, if no node name is specified). |
| set current node set current node '<nodeName> | Sets the node with the specified node name as the cloud controller's current node. Cloud controller's current node is used for all commands without an explicitly specified node. |
| on node <nodeName> | Commands can optionally be prefixed with a node specification referred to as <nodeSpec> in the syntax description of the commands to send them to a node other than the current node. |
| help help ('<command> l <nonTerminal>)? | Shows the list of available commands or detailed information of the specified command. |
| exit exit | Exits the ACC. |
| wait for'<nodeSpec>? wait for (<state> ((, l or) <state>)*) of <instanceId> (timeout <INT>)? | Instructs the cloud controller to wait until the specified executable instance has reached one of the specified state(s). Optionally, a timeout (in milliseconds) can be specified. If the instance of the executable does not reach one of the specified desired states after timeout, processing will stop with an error. |
| register app type register (app l application ) type '<appTypeId> <groupId>.<artifactId> <version> <portSpec>* (defaults (<key> <value> ( , <value>)*)+ )? | Registers an executable with specific group and artifact ID in a specific version under a logical name and the application type ID. The application type ID can later be referenced in configure commands to conveniently configure a new instance of this executable. The command also allows specification of the default configuration parameters which are added to the configure command of any executable of that application type that is later configured. Further, it is possible to add port specifications, telling the agent which parameters of the executable represent network ports. |
| deregister app type deregister (app l application ) type '<appTypeId>? | Removes the registered application type identified by the specified application type ID. |
| list app instances list (app l application) type '<appTypeId> instances? | Lists all instances of the specified application type across all nodes. |
| list app types list (app l application) types | Lists all registered application types. |
| show controller show (acc l controller) (cfg l config) | Shows the current value of all ACC configuration parameters. |
| set controller set (acc l controller) (cfg l config) '<key> <value> ( , <value>)* | Sets the ACC configuration parameter <key> to the specified '<value>. |
| get controller cfg parameters get (acc l controller) (cfg l config) '<key> | Gets the value of the ACC configuration parameter '<key>. |
| create tenant create tenant '<tenantId> (<key> <value> (, <value>)*)* | Triggers the creation of a new tenant including any additional associated activities (such as restoring of demo content). User name and password of an administrative user have to be specified using the 'master.tenant.user.name and master.tenant.user.pwd parameters. An initial password of the new tenant's system user can be specified with the tenant.user.pwd parameter. If it is not specified, the password will be manager. |
| backup tenant backup tenant '<tenantId> (to <path>)? (<key> <value> (, <value>)*)* | Backs up data of the specified tenant to the specified loca-tion. Use username and password parameters to specify user name and password of a user with sufficient administrative privileges in all applications. If the target path specified is an existing directory, the name of the backup file will be generated automatically and put into this directory. If the target path is an existing file, the user will be required to confirm overwriting of this file. If the directory of the target file does not exist, it will be created. |
| restore tenant restore tenant '<tenantId> from <path> (<key> <value> (, <value>)*)* | Restores data of the specified tenant from a file in the specified location. Use username and password parameters to specify user name and password of a user with sufficient administrative privileges in all applications. |
| delete tenant delete tenant '<tenantId> | Deletes the specified tenant and all its associated data from the system. User name and password of an administrative user must be specified using the master.tenant.user.name and mas-ter.tenant.user.pwd parameters. Warning: If you use the force option, the Are you sure? security question is overridden. That is, the tenant and its data are deleted without further notice. |
| list tenants list tenants | Lists all currently registered tenants. |
| list list services for (tenants l tenant '<tenantId>) | Lists the current assignments of services to tenants. Optionally, a <tenantId> can be specified to show only the assignments for this tenant. |
| assign tenant to service assign tenant? '<tenantId> to service? <serviceId> (<key> <value> (, <value>)*)* | Assigns the service instance with the specified <serviceId> to the tenant identified by <tenantId>. Optionally, parameters relevant for this tenant-to service mapping can be specified. |
| unassign tenant from service unassign tenant? '<tenantId> from service? <serviceId> | Removes the existing service-to-tenant assignment between the service with the specified <serviceId> and the tenant with the given <tenantId>. |
| set tenant data set tenant '<tenantId> data (for (app l application l services) (<serviceType> l <appType>))? (+? <key> <value> (, <value>)* l - <key>)* | Set tenant data for the specified tenant, optionally for the specified application or service type. Tenant data is a set of key-value pairs that is stored individually for each tenant.You can optionally specify the application or service type for the tenants. Several key-value pairs can be specified in one command. Existing value of the specified key is overwritten with the new value. By prefixing a key with -, any value already set for that key can be unset. Any key-value-pair that is not explicitly set or unset will remain unchanged. |
| get tenant data get tenant '<tenantId> data (for (app l application l services) (<serviceType> l <appType>))? <key> | Gets the tenant data of the specified tenant, optionally for a specific application or service. Tenant data is a set of key-value pairs that is stored individually for each tenant. You can optionally specify the application or service type for the tenants. |
| show tenant data show tenant '<tenantId> data (for (app l application l services) (<serviceType> l <appType>))? | Displays all tenant data values for the specified tenant, optionally for a specific application or service. Tenant data is a set of key-value pairs that is stored individually for each tenant. You can optionally specify the application or service type for the tenants. |
| set system config set system (config l cfg l configuration) (+? '<key> <value> (, <value>)* l - <key>)* | Sets system configuration values. System configuration val-ues are key-value pairs that are stored for the entire installation (independently from specific applications or tenants). Several key-value pairs can be specified in one set system config command. Existing value for a specified key is overwritten with the new value. By prefixing a key with -, any value already set for that key can be unset. Any key-value-pair that is not explicitly set or unset will remain unchanged. |
| get system config get system (config l cfg l configuration) '<key> | Gets the system configuration value with the specified key. |
| show system config show system (config l cfg l configuration) | Displays all system configuration data values that are cur-rently configured. |
| register external service register external? service '<serviceType> (<key> <value> (, <value>)*)* | Registers an external service of the specified service type (external DBMS), SMTP server, HTTP proxy with its configuration parameters. |
| list external service list external? services | Lists all external (or non-managed) services currently registered with the system. |
| show external service show external? service '<serviceId> | Displays the details of an external service currently regis-tered with the system. |
| deregister external service deregister external? service '<serviceId> | Unregisters an external service. |
| update external service update external? service '<serviceId> (<key> <value> (, <value>)*)* | Updates the configuration parameters of an already regis-tered external service. |
| list tenants for services list tenants for (services l service '<serviceId>) | Lists the current assignments of tenants to services. Optionally, a <serviceId> can be specified to show only the assignments of a service. |
| get runnable property'<nodeSpec>? get (runnable l instance)? <instanceId> property <key> | Gets the specified property value of the specified executable on the specified node (or the current node, if no node name is specified). |
| set runnable property'<nodeSpec>? set (runnable l instance)? <instanceId> property (<key> <value> (, <value>)*)* | Sets the specified property value of the specified executable on the specified node (or the current node, if no node name is specified) to the specified value. |
| enhance runnable'<nodeSpec>? enhance <instanceId> with <enhancement> (, <enhancement>)* | Enhances an already configured executable with the speci-fied enhancement(s). Note: Depending on the type of enhancement and executa-ble, it might be necessary to restart the executable for the enhancement to become effective. |
| enhance any instance enhance any ('<state> ((, l or) <state>)*)? <appTypeId> instance with <enhancement> (, <enhancement>)* | Invokes an enhancement on a single instance of the specified application type. This is useful for enhancements that will not affect the instance, but the application as a whole. |
| invoke'<nodeSpec>? invoke <operation> on <instanceId> (<key> <value> (, <value>)* l <invocationFile>)* | Invokes an operation on the specified executable, optionally passing parameters for the invocation as key-value pairs. In addition, files can be specified as additional input to the operation. These files can be taken from the repositories configured for the respective agent or can be local files on the machine where the ACC is executed. |
| invoke any invoke '<operation> on any (<state> ((, l or) <state>)*)? <appTypeId> instance (<key> <value> (, <value>)* l <invocationFile>)* | Invokes operation on executable of the specified application type, optionally passing parameters for the invocation as key-value pairs. In addition, files can be specified as additional input to the operation. These files can be taken from the repositories configured for the respective agent or can be local files on the machine where the ACC is executed. Optionally, the desired state(s) the executable on which the invocation should be done can be specified. |
| register global enhancement register global? enhancement '<ID> <enhancement> | Registers a new global enhancement with the specified ID. Global enhancements will be added to all executables con-figured later. |
| deregister global enhancement deregister global? enhancement '<ID> | Unregisters the existing global enhancement identified by the ID. |
| list global enhancement list global? enhancements | Lists all global enhancements currently registered with the cloud controller. |
| zk create (zk l zookeeper) create '<absoluteZookeeperPath> (payload <STRING> )? | Creates a new zookeeper node in the specified path, creating any non-yet existing parent nodes in the path. Optionally, the node's payload can be specified as a string. It is not possible to set binary payloads with this command. |
| zk ls (zk l zookeeper) ls '<absoluteZookeeperPath> | Lists the children of the zookeeper node in the specified path. |
| zk get (zk l zookeeper) get '<absoluteZookeeperPath> | Retrieves the payload of the zookeeper node in the speci-fied path. The payload is displayed as a string, which makes this method unsuitable for binary payloads. |
| zk delete (zk l zookeeper) force? delete '<absoluteZookeeperPath> | Deletes the zookeeper node in the specified path. Deletion of a node is successful, if the node does not have any child nodes. By using the force keyword, you can delete entire sub trees. |
| zk update (zk l zookeeper) (set l update) '<absoluteZookeeperPath> (payload <STRING> )? | Changes the payload of the zookeeper node in the specified path to the specified string. It is not possible to set binary payloads with this command. |
| zk dump (zk l zookeeper) dump | Prints the entire zookeeper content to screen. |
| list backups'<nodeSpecWithAllNodes>? list (instance l runnable)? backups <instanceId>? | Lists all the available backups for the current node, a specified node, or for all nodes. If an instanceId is specified, only the backups for this in-stanceId are listed. For each instance, all available backups are listed, with a backupId (temporary created id for a backup), the date and time, and the version of the backup. |
| restore backups'<nodeSpecWithAllNodes>? restore (instance l runnable)? (backups l backup) ( <instanceId> <backupId>? )? | Restores backups of executables of the current node, speci-fied node, or for all nodes. If only an instanceId is specified, the last backup of this instance gets restored, if additionally a <backupId> is entered the backup with this Id will be restored. If no instanceId is specified for the executables, the last available backup will be restored. |
| delete backups'<nodeSpecWithAllNodes>? delete (instance l runnable) (backups l backup) <instanceId> <backupId>? | Deletes backups of the executables on the current node, specified node, or on all nodes. If only an instanceId is specified, the oldest backup of this instance gets deleted, if additionally a <backupId> is entered the backup with this Id will be deleted. |
1.1.1 Database Management System Configuration Parameters #
If you want to register an external database management system (DBMS) using the register external service command, use the following parameters.
| Parameter | Type | Default Value | Description |
|---|---|---|---|
| host | String | Qualified hostname or IP address of the data-base server. | |
| port | Integer | Port of the database server. | |
| username | String | User of the DBMS. | |
| password | String | Password of the DBMS's user. | |
| driverClassName | String | Class name of the DB driver. For example, "com.microsoft.sqlserver.jdbc.SQLServerDriver" | |
| url | String | Database URL. For example "jdbc:sqlserver:mssqlserver01:1433;DatabaseName=CUSTOMER" | |
| removeAbandoned (Optional) | Boolean | false | Flag to remove abandoned connections if they exceed the removeAbandonedTimeout. If set to true, a connection is considered abandoned and eligible for removal if it has been in use longer than the removeAbandonedTimeout. If set to true, DB connections can be recovered from applications that fail to close a connection. |
| jmxEnabled (Optional) | Boolean | true | Whether to register the pool with JMX or not. |
| rollbackOnReturn (Optional) | Boolean | false | If autoCommit==false, the pool can terminate the transaction by calling rollback on the con-nection as it is returned to the pool. |
| maxIdle (Optional) | Integer | 100 | The maximum number of connections that should be kept in the pool at all times. |
| maxActive(Optional) | Integer | 100 | The maximum number of active connections that can be allocated from this pool at the same time. |
| maxWait (Optional) | Integer | 30000 | The maximum number of milliseconds that the pool will wait for a connection to be returned before throwing an exception. |
1.1.2 SMTP Configuration Parameters #
If you want to configure email notifications using the register external service command, use the following parameters.
| Parameter | Type | Default value | Description |
|---|---|---|---|
| host | String | Qualified hostname or IP address of the data-base server. | |
| port (Optional) | Integer | 25 | Port of the SMTP server. |
| username (Optional) | String | User name on the SMTP server. If this parameter is set, the applications will implicitly enable SMTP authentication. There is no dedicated parameter to explicitly enable SMTP authentication. | |
| password (Optional) | String | Password for the user on the SMTP server. | |
| sender.address (Optional) | String | Sender's email address. | |
| use.tls (Optional) | Boolean | false | Specifies if SMTP server is TLS enabled. |
| tls.mode (Optional) | String | STARTTLS | Specifies the method used to secure the con-nection. Valid values are STARTTLS and SSL. STARTTLS upgrades an initially insecure con-nection to an encrypted one without requiring a dedicated port for secure communication, whereas SSL immediately establishes a secured connection on a dedicated port. |
1.1.3 Proxy Configuration Parameters #
If you want to register an external proxy server using the register external service com-mand, use the following parameters.
| Parameter | Type | Default value | Description |
|---|---|---|---|
| host | String | Qualified hostname or IP address of the proxy server. | |
| port (Optional) | Integer | 8080 | Port of the proxy server. |
| username | String | User of the proxy server. | |
| password (Optional) | String | Password of the proxy server's user. | |
| non.proxy.hosts (Optional) | String | Specifies the hosts that should be accessed directly and not through the proxy server. |
1.2 Syntax Glossary #
Description of expressions:
Absolute path('/' l '\' l [A-Z] ':') <relativePath> An absolute path starting with either a forward or backward slash (on Linux), or a file letter (on Windows), where the individual path steps are separated by either forward or backward slashes.
ACC locale filelocal file <key> (<relativePath> l <absolutePath>) Uses a file on the machine on which the ACC is running as input for an invoke command, by specifying the file either as absolute path or as a path relative to the ACC's current working directory.
Artifact enhancement<groupId>.<artifactId> <version> (classifier <ID>)? type <ID> Enhances an executable with an artifact from the repository, by specifying the groupdId, artifactId, version, type, and optionally the classifier, of the artifact.
Artifact filefile <key> <groupId> . <artifactId> <version> (classifier <classifier>)? type <type> Uses an artifact from the repository as input for an invoke command, by specifying the Maven-esque groupdId, artifactId, version, type, and optionally the classifier, of the artifact.
Enhancement point<ID> The name of the executable's enhancement point to which to send the file, and the optional parameters to be used for enhancement.
ID('a'..'z'l'A'..'Z'l'_') ('a'..'z'l'A'..'Z'l'0'..'9'l'_'l'-')* An ID (identifier) is any string beginning with a letter or the underscore character (_), and containing only letters, digits, the underscore character (_), or a dash character (-).
Integer'-'? '0'..'9'+ A positive or negative integer number.
Relative path(<ID> l <STRING>) ( ('/' l '\') (<ID> l <STRING>))* A relative path, where the individual path steps are separated by either forward or backward slashes.
Repository filefile <key> <relativePath> Uses a file from the repository as input for an invoke command, by specifying the file's path relative to the repository's root.
String'' ( <any character but '\\' or '' )* '' An almost arbitrary sequence of characters, delimited by double quotes. To represent certain special characters, you can use the backslash character (\) as the escape sequence. For example, for newline, for a backslash, \t for a tabulator, and \” to obtain a double-quote as part of the string's content.
Please find the description of used syntax entries in alphabetical order:
<absolute ZookeeperPath> Absolute zookeeper path ('/' l '\' ) <relativePath> A path in zookeeper.
<agentPort> Agent's Port number.
<appType> Application type umc l abs l ads l apg l ecp l cop l ... A technical application type as defined by the zookeeper component.
<appTypeId> Application type ID <ID> An application type ID is used to uniquely identify a registered application type on the cloud controller. An application type ID can be any string without whitespace, starting with a letter or underscore character (_), and containing only letters, digits, or underscore characters.
<artifactId> Artifact ID <ID> The common Maven-esque artifact ID of the executable.
<backupId> Backup ID <ID> A backup ID is used to uniquely identify an executable backup for an instance within one node. It is only unique for an instance on a node. A backup Id is an integer number and will be generated temporary by the list backups command.
<enhancement> Enhancement <enhancementPoint> (<artifactEnhancement> l <fileEnhancement> l <localFileEnhancement>) (op-tions ( <key> <value> (, <value>)*)+ )? Enhance an executable with a file. There are two ways to specify the source file, as Maven repository artifact or as repository file. Optionally, parameters can be specified that are passed to the executables corresponding enhancement point.
<groupId> Group ID <ID> (. (<ID>l<INT>))+) The common Maven-esque group ID of the executable. That is, a sequence of identifiers separated by dots (.).
<instanceId> Instance ID <ID> An instance ID is used to uniquely identify an executable within one node. An instance ID can be any string without whitespace, starting with a letter or underscore character (_), and containing only letters, digits, or underscore characters.
<invocationFile> Invocation file <artifactFile> l <repositoryFile> l <accLocalFile> Specifies a file to be used as input for the operation. The file can be specified using Maven artifact coordinates (GAV), as a relative path to a file in one of the repositories known to the respective agent, or as a file local to the machine on which the ACC is running.
<ipOrHostName> IP address or fully qualified name of the server to be connected.
<key> Key
<ID> (. (<ID> l <INT>))+ A key can be any identifier. That is, any string without whitespace, starting with a letter or underscore character (_), and containing only letters, digits, or underscore characters or a dotted identifier(a sequence of several identifiers integers as parts separated by a . character). For example: ShortId, ASimpleButLongerIdentifier12345, A.dotted.identifier.1
<nodeName> Node name A node name is a unique logical name given to a node registered by ACC. It can be any string without whitespace, starting with a letter or underscore character (_), and containing only letters, digits, or underscore characters.
<nodeSpec> Node specification on <nodeName> All zookeeper ensemble management, lifecycle and agent configuration commands can optionally be prefixed with a node specification to send them to a node other than the current node or to determine the node if no current node has been set.
<operation> Operation <ID> The name of the operation to invoke.
<password> Required user password. This might be the password of a remote access user, a database user, the superuser or a system user.
<portSpec> Port specification port <key> (<INT> l <INT>:<INT>) (',' (<INT> l <INT>:<INT>))* (default <INT>)? A port specification declares that the configure parameter <key> represents a port (or is a port parameter for short). Individual or ranges of ports that are reserved for this port parameter can be specified. Further, a default can be declared, which indicates the port that is used by the executable if no explicit value is specified for this port parameter during configure.
<serviceId> Service ID <ID> A service ID is used to uniquely identify a service. It is assigned automatically by the system when the service is registered. It can be used to refer to a specific service for updating or deregistering it.
<serviceType> Service type DB l SMTP l proxy l PostgreSQL-ecp l elasticsearch l rs l ... A technical service type as defined by the zookeeper component. A service type specifies the type of an external or internal service to be registered. This example shows how to register an external service DB (Microsoft SOL) and the required configuration parameters:
url="jdbc:sqlserver://<host name>:<port>;DatabaseName=<DATABASE NAME"
driverClassName="com.microsoft.sqlserver.jdbc.SQLServerDriver"
username="<user name>"
password="<password>"
maxIdle=15
maxActive=300
maxWait=10000
removeAbandoned=false
removeAbandonedTimeout=600
logAbandoned=true
defaultAutoCommit=false
rollbackOnReturn=true
host=<host name>
jmxEnabled=true
<state> State STOPPED l STARTED l STARTING l STOPPING l UNKNOWN l DOWN l The possible executable lifecycle states.
<tenantId> Tenant ID <ID> A tenant ID is used to uniquely identify a tenant. A tenant ID can be any string without whitespace, starting with a letter or underscore character (_), and containing only letters, digits, or underscore characters.
<username> Required user name. This might be a remote access user, a database user, the superuser or a system user.
<value> Value <ID> l <INT> l <STRING> A value can be any identifier. That is, a string without whitespace, starting with a letter or underscore character (_), and containing only letters, digits, or underscore characters, and Integer number, or a string. That is, an arbitrary, double-quote-delimited sequence of characters. For example, ThisIsAnIdentifier435, _ThisIsAlsoAnIdentifier, 12345, This is also a valid value.
<version> Version
('a'..'z'l'A'..'Z'l'0'..'9'l'_'l'-'l'.')+ See also: #
- Introduction
- Preparing Oracle Database
- Preparing SQL Server Database
- Preparing DB2 Database
- Upgrading Collaboration (from previous version)
- Configuring Collaboration User Management Component
- Starting and Stopping Collaboration Server
- Connecting Business Console to Collaboration
- Using Collaboration Cloud Controller (ACC)
- User Management Configuration
- User Configuration Reference