Synchronizing Reference Directories › How to Set Up hrefresh › hrefresh Argument File Definition

hrefresh Argument File Definition

Note: This task is optional.

The hrefresh argument file defines the following:

• Maximum Retry Value
• Retry Delay Value in seconds
• -nolock option
• hrefresh home directories for each broker name

  The home directory locates the hrefresh configuration file and the encrypted password files. In each hrefresh home directory, create a subdirectory named log for the hrefresh log files.

• (Optional) Configuration file name. Default is HRefresh.cfg.
• (Optional) Execute mode; synchronous or asynchronous (default).

Note: The HRefresh.arg file is optional but recommended. If you omit the HRefresh.arg file, the hrefresh home directory is CA_SCM_HOME and no retry capability is enabled.

HRefresh.arg supports the following arguments:

-maxretries=n

Specifies the maximum number of job retries. If hrefresh determines that an hrefresh job is running for a particular host, hrefresh waits and retries the job up to n times. If you do not specify this parameter, the default is 0 (do not retry).

-retrydelay=n

Sets the number of seconds to wait between retry attempts, if you configure hrefresh to retry a job when a previous job is still running (maxretries>0). If you do not specify this parameter, the default is 0 (no delay between retries).

-nolock

Overrides semaphore locks and allows multiple check-out operations for the same target directory to run concurrently. If you do not specify ‑nolock, the semaphore locks are active (the default), and the check-out operations run consecutively. Use -nolock with caution.

Note: When ‑nolock is in effect, the ‑maxretries and ‑retrydelay settings in the HRefresh.arg file are ignored.

-home=directory

Sets a default directory that hrefresh uses as the home directory. If you do not specify this parameter, hrefresh uses CA_SCM_HOME.

-home_name=directory

Sets a default directory that hrefresh uses as the home directory in cases where multiple brokers or hserver version groups exist on a single CA Harvest SCM server installation. If you do not specify this parameter for a broker name or version name, the value specified by ‑home=directory is used.

This option mimics the -homeserver_version argument in HBroker.arg, in which you specify where to find the HServer.arg file for each hserver version.

For example, if your HBroker.arg file specifies the following:

//Version 1 for Telon Group
-minserver_telon=10
-maxserver_telon=35
-queuesize=5
-homeserver_telon=H:\CA\Software Change Manager\Ver1

//Version 2 for Telco Group
-minserver_telco=2
-maxserver_telco=35
-queuesize=5
-homeserver_telco=H:\CA\Software Change Manager\Ver2

You create separate hrefresh home directories for each group in HRefresh.arg as follows:

//Version 1 for Telon Group
-home_telon=H:\CA\Software Change Manager\Ver1

//Version 2 for Telco Group
-home_telco=H:\CA\Software Change Manager\Ver2

The name portion of the argument is matched at runtime using the following logic:

1. If the broker value is in the form brokername/version, version locates a designated hrefresh home directory.
2. If the broker value does not have the version name, brokername locates a designated hrefresh home directory.
3. If no match exists for either one, the -home value is used when it is defined; otherwise, CA_SCM_HOME is used.

This approach supports cases where brokername is forced using RT_FORCE_NODE_NAME, and where multiple brokers may be running.

-cfg=filename

(Optional) Specifies the configuration file name.

Default: HRefresh.cfg

execmode= synchronous|asynchronous

(Optional) Sets the default execution mode for all hrefresh executions, unless overridden by using -execmode on the hrefresh command line.

Default: asynchronous

To define the argument file, do the following:

1. Create an ANSI text file and name the file HRefresh.arg.
2. Place the file in the CA_SCM_HOME directory.
3. Enter arguments and permissible values in the order as described earlier in this section.

   Blank lines are allowed, but hrefresh ignores them.

   Comment lines are allowed, and are designated by “#” or “//” at the beginning of the line.

4. Save the file and make sure it remains in the CA_SCM_HOME directory.