This section includes the following topics:

Encrypt command

The Encrypt command encrypts passwords that are used as parameters. The encryption is based on the encryption type that is currently configured on the site.

The encrypted password is displayed in the standard output. The Encrypt command uses the following format:

Windows    infra\bin\psin_cli.bat
                    -action encrypt
                    -password <password>
UNIX           
./infra/bin/psin_cli.sh
                    -action encrypt
                    -password <password>

password element

The following table describes the syntax of the password element.

Table 1 Password element

ElementDescription
password password

Contains the value of the password to be encrypted. To encrypt an empty password, type "".

Any password parameter can be a clear text value. To create a clear text value, replace the name of the parameter from encrypt to clear.

For example, replace:

dba-encrypted-password

to:

dba-clear-password

Apply License command

The Apply License CLI applies a new license to Precise.

To apply the license, run the following command on the main Precise FocalPoint server:

Windows    infra\bin\psin_cli.bat
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action apply-license
                    -license-file <license_file_name>
UNIX           
./infra/bin/psin_cli.sh
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action apply-license
                    -license-file <license_file_name>

License file name element

The following table describes the syntax of the license file name element.

Table 2 license file name element

ElementDescription
i3-userSee Authenticate to CLI Utility.
i3-encrypted-passwordSee Authenticate to CLI Utility.
action

Always apply-license

Mandatory: Yes

license-fileSpecifies the path to the license file name that needs to be applied.

Change an installed Precise Listener port

The Listener Port Change command enables you to change the port number of an installed Precise Listener.

This command must be executed on the server itself. You are not allowed to change the Precise FocalPoint Listener port number.

To change listener port, run the following command:

Windows    Infra\bin\psin_cli.bat
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action port-change
                    -port <port_number>
UNIX           
./infra/bin/psin_cli.sh
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action port-change
                    -port <port_number>

Create support file command

The Create a support file command enables you to generate a support file for Precise. The created support file is saved in the <precise_root>/support folder on the main Precise FocalPoint.

To create a support file, run the following command on the main Precise FocalPoint.:

Windows    Infra\bin\psin_cli.bat
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action support
                    -mode <support_mode>
                    -servers <servers_list>
                    [-proxy-alias <node_alias>]
UNIX           
./infra/bin/psin_cli.sh
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action support
                    -mode <support_mode>
                    -servers <servers_list>
                    [-proxy-alias <node_alias>]

Table 3 Elements for Create support file

ElementDescription
i3-userSee Authenticate to CLI Utility.
i3-encrypted-passwordSee Authenticate to CLI Utility.
action

Always support

Mandatory: Yes

mode

The type for the support file.

Values:

  • Full - for creating a full support file.
  • Express - for creating an express support file.

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

Update main registry command

The update main registry command updates the main registry with the proxy registry. The command should run on the proxy that the change was made on, and will update the main registry.

The update-main-registry command uses the following format:

Windows    Infra\bin\psin_cli.bat
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action update-main-registry
                    -registry-path <registry_path>
UNIX           
./infra/bin/psin_cli.sh
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action update-main-registry
                    -registry-path <registry_path>

Table 4 Elements for Update main registry

ElementDescription
i3-userSee Authenticate to CLI Utility.
i3-encrypted-passwordSee 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.

Clean Main DB and Infra DB CLI command

Precise maintains logically deleted entities for its operation. This allows, for example, reusing deleted instance's historical data for new instance installation. However as the Precise system ages, performance might be affected. To improve performance, clean the deleted entities using the following CLI.

Run the following command from the Main Precise FocalPoint root folder:

Windows    infra\bin\psin_cli.bat
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action clean-infra-db
UNIX           
./infra/bin/psin_cli.sh
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action clean-infra-db

Table 5 Elements for Clean Main DB and Infra DB CLI

ElementDescriptions
action

Always clean-infra-db

Mandatory:Yes

i3-userSee Authenticate to CLI Utility.
i3-encrypted-passwordSee Authenticate to CLI Utility.

Reusing deleted instance's historical data will not be available once this is used.

LDAP Sync command

Precise can use LDAP for its roles & users management. For more details about LDAP and Precise integration, see the Precise Administration Guide and/or the Precise Installation Guide. Precise automatically runs LDAP sync once a day at 00:08.

If you have changed LDAP configuration (add/removed users and/or groups) it will be applied at the next 00:08. In case you have changed the LDAP configuration and you don't want to wait, you can force the LDAP sync. Run the LDAP Sync command on the main Precise FocalPoint from the <precise_root>:

Windows    infra\bin\psin_cli.bat
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action ldap-sync
UNIX           
./infra/bin/psin_cli.sh
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action ldap-sync

Table 6 Elements for LDAP Configuration

ElementDescription
action

Always ldap-sync

Mandatory: Yes

i3-userSee Authenticate to CLI Utility.
i3-encrypted-passwordSee Authenticate to CLI Utility.

List Applications, Tiers, and instances

Using CLI you can list the entire Precise applications, Tiers and instances structure in a XML formatted file. To list, run the following command on the main Precise FocalPoint from the <precise_root>:

Windows    infra\bin\psin_cli.bat
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action environments-list
                    [-output-file <output_file>]
UNIX           
./infra/bin/psin_cli.sh
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action environments-list
                    [-output-file <output_file>]

Table 7 Elements for List Applications, Tiers, and instances

ElementDescription
i3-userSee Authenticate to CLI Utility.
i3-encrypted-passwordSee 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

Associate/Disassociate instance Tier

This command associates or disassociates instances to the Tier. Please note the following:

  • You can connect an instance to only one Tier in an application.
  • An instance must be part of at least one Tier.
  • To move an instance to another Tier, first associate the instance with the target Tier, and then disassociate the instance from the original Tier.
  • The OS Tier name must be "OS".
  • The Other Tier name must be identical to the instance name.
  • If you are associating an instance to a non-existent Tier and application, the specified Tier and application are automatically created.
  • If you are disassociating an instance from an Tier, and the Tier no longer contains instances, the Tier is automatically deleted. If there are no more Tiers in the related application, the application is also deleted.
  • Any Tier change performed on an instance which is part of a cluster, is automatically applied to all instances of that cluster.

Windows    infra\bin\psin_cli.bat
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action instance-apptier
                    -technology <technology_code>
                    -instance-server-machine-name <server_machine_name>
                    [-proxy-alias <node_alias>]
                    -instance-name <instance_name>
                    -apptier-name <Tier_name>
                    -environment-name <application_name>
                    -type <type>}
                    [-apptier-application <application_code>] [-apptier-frontend {true|false}]
                    [-force {true|false}]
UNIX           
./infra/bin/psin_cli.sh
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action instance-apptier
                    -technology <technology_code>
                    -instance-server-machine-name <server_machine_name>
                    [-proxy-alias <node_alias>]
                    -instance-name <instance_name>
                    -apptier-name <Tier_name>
                    -environment-name <application_name>
                    -type <type>
                    [-apptier-application <application_code>] [-apptier-frontend {true|false}]
                    [-force {true|false}]

Table 8 Elements for Associate/Disassociate instance Tier

ElementDescriptions
i3-userSee Authenticate to CLI Utility.
i3-encrypted-passwordSee 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

Copy Report Manager Reports

CLI enables you to copy reports from one Tier to another. This can also be done between different Nodes, meaning between 2 applications on the same Precise federated installations that each belongs to different Node. To copy Report Manager reports from one Tier to another run the following command from the main Precise FocalPoint root folder:

Windows    infra\bin\psin_cli.bat
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action fs-copy-foresight-custom-report
                    -parametersfile <parameters_file_path>
UNIX    
        ./infra/bin/psin_cli.sh
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action fs-copy-foresight-custom-report
                    -parametersfile <parameters_file_path>

An example of the parameters file is:

<parameters>
     <parameter name="source-environment" value="Default"/>
     <parameter name="source-apptier" value="SQL Server"/>
     <parameter name="source-report" value="a_test"/>
     <parameter name="destination-environment" value="test"/>
     <parameter name="destination-apptier" value="SQL Server"/>
</parameters>

To copy a Cross-Tier report, you should use the following string for both the "source-apptier" and "destination-apptier" parameter: "Cross-AppTiers".

Table 9 Elements for Attach

ElementDescription
i3-userSee Authenticate to CLI Utility.
i3-clear-passwordSee Authenticate to CLI Utility.
action

Values: fs-copy-foresight-custom-report.

Mandatory: Yes

parametersfile

Values: Mandatory:

Create inventory report

The create inventory report enables you to create an Excel file containing information regarding your installation servers, nodes, PW, and instances.

To create an inventory report, run the following command on the main Precise FocalPoint:

Windows    infra\bin\psin_cli.bat
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action inventory-report
                    [-output-file <output_file_name>]
UNIX           
./infra/bin/psin_cli.sh
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action inventory-report
                    [-output-file <output_file_name>]

Table 10 Elements for Create an inventory report

ElementDescription
i3-userSee Authenticate to CLI Utility.
i3-encrypted-passwordSee Authenticate to CLI Utility.
action

Values: Always inventory-report.

Mandatory: Yes

output-file

The file name to save report to.

Values: Path

Mandatory: No

Clean Logger cache

Each agent that uses the logger has a cached configuration for the logger. When you want to update the logger configuration, you need to remove the logger cache, so that the related agent will reload the new updated configuration.

To update the logger configuration, run the following command on the Main Precise FocalPoint:

Windows    infra\bin\psin_cli.bat
                    -action clean-logger-cache
                    -server <server_name>
                    [-proxy-alias <node_alias>]
UNIX           
./infra/bin/psin_cli.sh
                    -action clean-logger-cache
                    -server <server_name>
                    [-proxy-alias <node_alias>]

Table 11 Elements for Clean Logger cache

ElementDescription
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

Change GUI server port

You can change the GUI server port using CLI. To change the GUI server port run the following command on the Precise FocalPoint whose GUI server port you want to change:

Windows    infra\bin\psin_cli.bat
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action change-gui-port
                    -port <the_new_port>
                    [-shutdown-port <the_new_shutdown_port>] [-url <the_gui_server_url>]
UNIX           
./infra/bin/psin_cli.sh
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action change-gui-port
                    -port <the_new_port>
                    [-shutdown-port <the_new_shutdown_port>] [-url <the_gui_server_url>]

Table 12 Elements for Change GUI server port

ElementDescription
i3-userSee Authenticate to CLI Utility.
i3-clear-passwordSee 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

Join instances to cluster

Web and J2EE technologies support cluster installation. When installing an instance, you can choose whether to install the instance as a standalone instance or as a cluster.

If you have installed instances as standalone instances and they should have been installed as a cluster, you can uninstall the instances and reinstall one instance as a cluster instead. This, however does not keep historical data for the newly installed cluster’s instances. If you want to keep the historical data related to the instances, you can use the join instances to cluster CLI utility command.

Prerequisites for using the Join instances to cluster command

The following list describes the prerequisites for using the Join instances to cluster command:

  • Only Web (WebSphere and WebLogic only) and J2EE instances are supported.
  • All instances’ servers must contain the same Precise version as the Main Precise FocalPoint. If upgrading from Precise 8.7, complete the upgrade related action items.
  • All instance’s servers must have the same path to the Precise installation folder.
  • All instances must be of the same type (and for Web also of the same application) and must be standalone instances (you cannot join instances which are already installed as a cluster).
  • Before a Web instance can be joined, it must run at least once.

The Join instances to cluster command

To join the instances, run the following CLI utility command from the Main Precise FocalPoint root folder:

Windows    infra\bin\psin_cli.bat
                    -i3-user <user_name>
                    -i3-clear-password <clear_password>
                    -action join-instances-to-cluster
                    [-proxy-alias<proxy alias>]
                    -instances-ids "<instances_ids>"
                    -cluster-name <cluster_name>
                    -[template <template>]
                    [[-installation-cd-path <cd_path>]
UNIX           
infra/bin/psin_cli.sh
                    -i3-user <user_name>
                    -i3-clear-password <clear_password>
                    -action join-instances-to-cluster
                    [-proxy-alias<proxy alias>]
                    -instances-ids "<instances_ids>"
                    -cluster-name <cluster_name> [template <template>]
                    [[-installation-cd-path <cd_path>]

Table 13 Elements for Join instances to cluster

ElementDescription
i3-userSee Authenticate to CLI Utility.
i3-clear-passwordSee 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

Configure SmartLink for an application

SmartLink is set by default for an application containing Web/J2EE/.NET Tiers. If you want to disable SmartLink for the application, run the following CLI utilities command on the main Precise FocalPoint:

Windows    infra\bin\psin_cli.bat
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action smartlink-config
                    -environment-name <application_name>
                    -enable <enable_smartlink>
UNIX           
./infra/bin/psin_cli.sh
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action smartlink-config
                    -environment-name <application_name>
                    -enable <enable_smartlink>

Table 14 Elements to configure SmartLink

ElementDescription
i3-userSee Authenticate to CLI Utility.
i3-encrypted-passwordSee 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

Downtime command

The downtime command defines new downtime rules for an application, server, or specific Instance. Define the downtime using CLI utilities by running the following command:

Windows    infra\bin\psin_cli.bat
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action downtime
                    {-environment-name <application_name> | -server <server_name> | -instance-name <instance_name>
                    -technology <technology_code> -server <server_name>}
                    -proxy-alias <proxy_alias_name>
                    -start date <start_date>
                    -start time <start_time>
                    -end date <end_date>
                    -end time <end_time>
UNIX           
./infra/bin/psin_cli.sh
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action downtime
                    {-environment-name <application_name> | -server <server_name> | -instance-name <instance_name>
                    -technology <technology_code> -server <server_name>}
                    -proxy-alias <proxy_alias_name>
                    -start date <start_date>
                    -start time <start_time>
                    -end date <end_date>
                    -end time <end_time>

Table 15 Elements to configure the downtime

ElementDescription
i3-userSee Authenticate to CLI Utility.
i3-encrypted-passwordSee 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

AdminPoint Dashboard acknowledgement

The AdminPoint Dashboard provides information regarding health of the Precise installation. The information is displayed in categories for each category per components. If you want to ignore a report for a specific component, for instance because the problem is currently being handled, you will have to add the Unique Key column to the Dashboard and use this relevant key in a CLI utillities command.

To ignore a specific component on the Dashboard:

  1. In Precise, enter the AdminPoint Dashboard.
  2. On the right side of the screen, click the Column chooser icon, and add the Unique Key column to the visible field. Now each component shows its unique key.
  3. Find the unique key of the component of which you want to ignore its condition.
  4. Run the CLI utillities script below to ignore the component’s condition.

    Ignored components are shown with a gray severity icon.

    If you have added the type add for the ignored item, it will also be listed in a new category named Acknowledged.

    You can specify an expiration date for the acknowledgement and you can also delete them.

Windows    infra\bin\psin_cli.bat
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action dashboard-ignore-handle
                    -dashboard-key <dashboard_key>
                    -type {add|remove}
                    {-expire-in-days<expire_in_days>}
UNIX    
./infra/bin/psin_cli.sh
                    -i3-user <user_name>
                    {-i3-encrypted-password <encrypted_password> | -i3-clear-password <clear_password>}
                    -action dashboard-ignore-handle
                    -dashboard-key <dashboard_key>
                    -type {add|remove}
                    {-expire-in-days<expire_in_days>}

Table 16 Elements to configure the Dashboard acknowledgement

ElementDescription
i3-userSee Authenticate to CLI Utility.
i3-encrypted-passwordSee Authenticate to CLI Utility.
action

Always dashboard-ignore-handle.

Mandatory: Yes

dashboard-key

The Unique Key of the Dashboard component.

Values: String

Use quotes to specify a key that includes spaces.


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.

IDERA |  Products | Purchase | Support |  Community |  Resources |  About Us  | Legal