Page History
...
The following table describes the syntax of the password element.
Table 1 Password element
| Element | Description | ||
|---|---|---|---|
| password password | Contains the value of the password to be encrypted. To encrypt an empty password, type "".
For example, replace: dba-encrypted-password to: dba-clear-password |
| Anchor | ||||
|---|---|---|---|---|
|
...
Table 2 license file name element
| Element | Description |
|---|---|
| i3-user | See Authenticate to CLI Utility. |
| i3-encrypted-password | See Authenticate to CLI Utility. |
| action | Always apply-license Mandatory: Yes |
| license-file | Specifies the path to the license file name that needs to be applied. |
| Anchor | ||||
|---|---|---|---|---|
|
...
Table 3 Elements for Create support file
| Element | Description |
|---|---|
| i3-user | See Authenticate to CLI Utility. |
| i3-encrypted-password | See Authenticate to CLI Utility. |
| action | Always support Mandatory: Yes |
| mode | The type for the support file. Values:
Mandatory: Yes |
| servers | The names of the servers for which you want to create support files. The servers names are separated by a comma. The servers list should contain at least one server name. If the list contains more than one server name, it should be wrapped with double quotes. The following format is used: "server1, server2, ..., serverN" Mandatory: Yes |
| proxy-alias | The proxy alias. Values: alias of the related node Mandatory: Only for a federated installation |
| Anchor | ||||
|---|---|---|---|---|
|
...
Table 4 Elements for Update main registry
| Element | Description |
|---|---|
| i3-user | See Authenticate to CLI Utility. |
| i3-encrypted-password | See Authenticate to CLI Utility. |
| action | Update-main-registry Mandatory: Yes |
| registry-path | The registry path that was updated in the proxy should start with /registry. It should not be a relative, nor an absolute path. The path should be the path to an existing registry file without the .xml suffix, for example /registry/products/infrastructure/thin. |
| Anchor | ||||
|---|---|---|---|---|
|
...
Table 5 Elements for Clean Main DB and Infra DB CLI
| Element | Descriptions |
|---|---|
| action | Always clean-infra-db Mandatory:Yes |
| i3-user | See Authenticate to CLI Utility. |
| i3-encrypted-password | See Authenticate to CLI Utility. |
| Info |
|---|
Reusing deleted instance's historical data will not be available once this is used. |
...
Table 6 Elements for LDAP Configuration
| Element | Description |
|---|---|
| action | Always ldap-sync Mandatory: Yes |
| i3-user | See Authenticate to CLI Utility. |
| i3-encrypted-password | See Authenticate to CLI Utility. |
| Anchor | ||||
|---|---|---|---|---|
|
...
Table 7 Elements for List Applications, Tiers, and instances
| Element | Description |
|---|---|
| i3-user | See Authenticate to CLI Utility. |
| i3-encrypted-password | See Authenticate to CLI Utility. |
| action | Always environments-list Mandatory: Yes |
| output-file | Values: path to output file If output-file argument is omitted, output will be redirected to a new file created in infra/cli/output folder. Mandatory: No |
| Anchor | ||||
|---|---|---|---|---|
|
...
Table 8 Elements for Associate/Disassociate instance Tier
| Element | Descriptions |
|---|---|
| i3-user | See Authenticate to CLI Utility. |
| i3-encrypted-password | See Authenticate to CLI Utility. |
| action | Always instance-apptier Mandatory: Yes |
| technology | Values: Technology code. For more information, see Technology Codes. Mandatory: Yes |
| instance-server-machine-name | The instance server machine name. Values: string Mandatory: Yes |
| proxy-alias | The proxy alias. Values: alias of the related node Mandatory: Only for a federated installation |
| instance-name | The instance name. Values: string Mandatory: Yes |
| apptier-name | The Tier name. Values: string Mandatory: Yes |
| environment-name | The application name. Values: string Mandatory: Yes |
| type | Values: one of DISSOCIATE,ASSOCIATE use ASSOCIATE to add an instance to a Tier use DISSOCIATE to remove an instance from a Tier. Mandatory: Yes |
| apptier-application | Values: Application code is optional and can be specified only for the following technologies: Other – CTX, .Net - ASP,DNT, WEB - WEB, SAP, PST, SBL. Mandatory: No |
| apptier-frontend | Indicates whether the Tier is a front-end Tier. Values: true or false Mandatory: No |
| force | Indicates whether this operation should be performed even if it affects several instances. Values: true or false Mandatory: Yes if changing the instance Tier when the instance is part of a cluster |
| Anchor | ||||
|---|---|---|---|---|
|
...
Table 9 Elements for Attach
| Element | Description |
|---|---|
| i3-user | See Authenticate to CLI Utility. |
| i3-clear-password | See Authenticate to CLI Utility. |
| action | Values: fs-copy-foresight-custom-report. Mandatory: Yes |
parametersfile | Values: Mandatory: |
| Anchor | ||||
|---|---|---|---|---|
|
...
Table 10 Elements for Create an inventory report
| Element | Description |
|---|---|
| i3-user | See Authenticate to CLI Utility. |
| i3-encrypted-password | See Authenticate to CLI Utility. |
| action | Values: Always inventory-report. Mandatory: Yes |
| output-file | The file name to save report to. Values: Path Mandatory: No |
| Anchor | ||||
|---|---|---|---|---|
|
...
Table 11 Elements for Clean Logger cache
| Element | Description |
|---|---|
| action | Always clean-logger-cache. Mandatory: Yes |
| server | The server name where the related agent is installed. Mandatory: Yes |
| proxy-alias | The proxy alias. Values: alias of the related node Mandatory: Only for a federated installation |
| Anchor | ||||
|---|---|---|---|---|
|
...
Table 12 Elements for Change GUI server port
| Element | Description |
|---|---|
| i3-user | See Authenticate to CLI Utility. |
| i3-clear-password | See Authenticate to CLI Utility. |
| action | Always change-gui-port. Mandatory: Yes |
| port | The new port used for GUI server. Mandatory: Yes |
| shutdown-port | Local port used to control the GUI server. Mandatory: No |
| url | URL used to access the GUI server. This can also be used in case you have changed GUI server to use SSL, and you want to update Precise of this. Mandatory: No |
| Anchor | ||||
|---|---|---|---|---|
|
...
Table 13 Elements for Join instances to cluster
| Element | Description |
|---|---|
| i3-user | See Authenticate to CLI Utility. |
| i3-clear-password | See Authenticate to CLI Utility. |
| action | Always join-instances-to-cluster Mandatory: Yes |
| proxy-alias | Alias of the instance’s related node. Mandatory: Yes, only in a federation installation. |
| instances-ids | Comma separated list of IDs related to the instances that need to be joined. To get the IDs related to the instances, use the get-instance-id CLI utility command. See Installing a new instance while keeping historical data from an old instance. Mandatory: Yes |
| cluster-name | The name of the cluster to install. Mandatory: Yes |
| template | The ID of the instance that will be used as the template to install the new cluster. If omitted, the first instance in -instances-ids is used as the template instance. Mandatory: No |
| installation-cd-path | Indicates the absolute path to the folder where the Precise v9.6 download was downloaded to. Values: String Mandatory: Yes |
| Anchor | ||||
|---|---|---|---|---|
|
...
Table 14 Elements to configure SmartLink
| Element | Description |
|---|---|
| i3-user | See Authenticate to CLI Utility. |
| i3-encrypted-password | See Authenticate to CLI Utility. |
| action | Always smartlink-config Mandatory: Yes |
| environment-name | The name of the application on which SmartLink should be enabled/disabled. Mandatory: Yes |
| enable | Indicates whether SmartLink should be enabled or disabled for the application. Values: true, false Mandatory: Yes |
| Anchor | ||||
|---|---|---|---|---|
|
...
Table 15 Elements to configure the downtime
| Element | Description |
|---|---|
| i3-user | See Authenticate to CLI Utility. |
| i3-encrypted-password | See Authenticate to CLI Utility. |
| action | Always downtime. Mandatory: Yes |
| environment-name | The name of the application on which the downtime needs to be defined. The downtime rules will be applied to all instances on this application Values: String Mandatory: Yes, unless the downtime rule is defined per server or an instance. |
| server | The name of the server on which the downtime needs to be defined. The downtime rules will be applied to all instances on this server. Values: String Mandatory: Yes, unless the downtime rule is defined per application. |
| technology | The related technology code. Values: String. For more information, see Technology Codes. Mandatory: Yes, when the downtime rule is applied to a specific instance. |
| proxy-alias | The proxy alias related to the downtime definition. Values: String Mandatory: No, unless there is more than one proxy. |
| start-date | The start date of the downtime rule. Values: Date (format: YYYY-MM-DD) Mandatory: Yes |
| start-time | The start time of the downtime rule. Values: Time (format: HH24:MI:SS) Mandatory: Yes |
| end-date | The end date of the downtime rule. Values: Date (format: YYYY-MM-DD) Mandatory: Yes |
| end-time | The end time of the downtime rule. Values: Time (format: HH24:MI:SS) Mandatory: Yes |
| Anchor | ||||
|---|---|---|---|---|
|
...
Table 16 Elements to configure the Dashboard acknowledgement
| Element | Description | ||
|---|---|---|---|
| i3-user | See Authenticate to CLI Utility. | ||
| i3-encrypted-password | See Authenticate to CLI Utility. | ||
| action | Always dashboard-ignore-handle. Mandatory: Yes | ||
| dashboard-key | The Unique Key of the Dashboard component. Values: String
|
Mandatory: Yes. | |
| type | Add or remove the Dashboard acknowledgement. Values: add, remove Mandatory: Yes. |
| expire-in-days | Relevant for adding ignore. It specifies the amount of days that the ignore is relevant for. If not specified, the acknowledge is enabled for good. Values: Integer Mandatory: No. |