ecaqrtab

The ecaqrtab utility performs operations in the Resource Pools table. These operations include:

Running the ecaqrtab Utility

This procedure describes how to run the ecaqrtab utility, which performs operations on the Resource Pools table.

Begin

  • Do one of the following:

    • From a Control-M/Server computer, type one of the following commands:

      • ecaqrtab {LIST|ADD|DELETE|UPDATE}{<orName>|"*"}[<Max>][-OUTPUT <output>]

      • ecaqrtab -input_file <fullPathFileName>

    • From a Control-M/Agent computer, to invoke the LIST option, type one of the following commands:

      • ecaqrtab LIST "*" [-OUTPUT <output>]

      • ecaqrtab -input_file <fullPathFileName>

If a resource name is longer than 20 characters, the resource is not added.

ecaqrtab Utility Parameters

The following table describes the ecaqrtab utility parameters:

Parameter

Description

LIST

Displays the status of the specified resource pools.

This information is also available from Control‑M/EM in the Resource Pools window.

ADD

Defines a new resource pool and sets the maximum availability for the resource.

DELETE

Deletes an existing resource pool.

UPDATE

Changes the maximum availability of an existing resource pool.

<QR_Name>

Defines the name of the resource pool. For the LIST option, QR_Name can include wildcard character * to indicate any number of characters (including none).

If * is specified, enclose the name in quotation marks, for example, "LVL*".

When invoked by the server or Agent, specify "*" (including the quotation marks) to include all existing resource pools (default when invoked by the server).

<Max>

Determines the maximum availability for the specified resource.

Can only be specified with the ADD and UPDATE options.

<Output>

Defines the full path name where the report should be sent.

If not specified, output is routed to the default output device.

This parameter can only be specified with the LIST option.

<fullPathFileName>

Defines the name and full path of a file containing parameters for the utility.

In this file, each parameter and its values (if any) are on a separate line with the same syntax they would have on the command line.

Uses:

  • Prepare and save files of utility parameters that can be reused.

  • Specify utility input longer than the number of characters allowed in the command line.

    -input_file ~ <controlmOwner>/ctm_server/data/ecaqrtab_parms.txt

    The path that is specified for this parameter must be accessible by the Control-M/Server account, even if this utility is requested by Control‑M/Agent.

Listing Resource Pools

This procedure describes how to list the resource pools.

Begin

  • Do one of the following:

    • From a Control-M/Server computer, type the following command:

      ecaqrtab LIST {<QR_Name>|"*"} [-OUTPUT <Output>]

    • From a Control-M/Agent computer, type the following command:

      ecaqrtab LIST "*" [-OUTPUT <Output>]

Resource Pool Parameters

The following table describes the fields that are displayed for each resource pool that matches the specified resource name or mask.

Parameter

Description

QR name

Defines the resource pool name (with @<Host ID> where applicable).

Type

For future use.

Max Avail

Defines the maximum number of units of this resource in the computer.

Reserved

Defines the number of units of the resource reserved for critical‑path jobs.

Used

Defines the number of units of the resource currently in use or reserved. If the ctmloadset utility is used in the data center, this number can include usage of the resource by non‑Control‑M jobs.

Free

Defines the number of units of the resource currently available for use. This represents the difference between Max Avail and Used.

Resource Pool Example

The following command can be invoked by the server or the Agent to list the current status of all resource pools in the Resource Pool table:

ecaqrtab LIST "*" -OUTPUT D:\ctm_server\QR.txt

A report similar to the following is displayed:

Copy 
+-----------------------------------------------------+
Resource Name  Type  Max-Avail  Reserved  Used  Free
+-----------------------------------------------------+
CPU@linda       L        10         0      10     0
CPU@linda       L        20         0      15     5
MEM@Diana       L        10         0       0    10
Tape2           L        12         2       2    10

Adding a Resource Pool

This procedure describes how to add a resource pool.

Begin

  1. Do one of the following:

    • UNIX: Log in to a Control-M/Server account

    • Windows: Open a command prompt window where Control-M/Server is installed.

  2. Enter the following command:

    ecaqrtab ADD <QR name> <Max>

    The following command specifies that the new resource pool tape2 is to be added to the Resource Pool table, with a maximum availability of 12 units:

    ecaqrtab ADD tape2 12

Deleting a Resource Pool

This procedure describes how to delete a resource pool.

Begin

  1. Do one of the following:

    • UNIX: Log in to a Control-M/Server account

    • Windows: Open a command prompt window where Control-M/Server is installed.

  2. Enter the following command:

    ecaqrtab DELETE <QR name>

    The following command specifies that the resource pool tape3 is to be deleted from the table:

    ecaqrtab DELETE tape3

Altering the Availability of a Resource Pool

This procedure describes how to alter the availability of a resource pool.

Begin

  1. Do one of the following:

    • UNIX: Log in to a Control-M/Server account.

    • Windows: Open a command prompt window where Control-M/Server is installed.

  2. Type the following command:

    ecaqrtab UPDATE <QR name> <Max>

    The following command specifies that the new maximum availability for the existing resource pool linerje2 on computer Diana is 12 units:

    ecaqrtab UPDATE linerje2@Diana 12

    You can get the same result using the -input_file parameter as follows:

    ecaqrtab -input_file ~<controlm_owner>/ctm_server/data/ecaqrtab_lines.txt

    The referenced file contains the following lines:

    UPDATE

    linerje2@Diana

    12

    e.