ctmsetown

The ctmsetown utility manages Run as Users authentication credentials for Agent and Agentless Host jobs, and enable you to import and export user authentication details from different Control-M environments.

Control-M/Server attempts to find the owner and hostname authentication details whenever a job is run and does the following, based on the search result:

• If the owner and hostname are found, Control-M/Server uses these credentials.

• If the specified hostname is not found, Control-M/Server tries to find the owner on host <All>.

• If the run_as is found on host <All>, Control-M/Server uses these credentials.

• If the run_as is not found on the specified hostname or on host <All>, Control-M/Server uses empty credentials.

If you run the ctmsetown utility on an Agent, you can only update existing owner passwords. You can update job owner passwords for the following types of jobs:

• Jobs that run on Agentless Hosts.

• Jobs that run on Windows Agents that are configured to work in Logon as User mode.

• Jobs that run on UNIX Agents that run in non-root mode.

Running the ctmsetown Utility

This procedure describes how to run the ctmsetown utility, which enables you to manage the Run as Users authentication credentials for Agent and Agentless Host jobs.

Begin

1. Do one of the following:

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

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

   You can also run this utility on an Agent host.

2. Run one of the following commands:

   • ctmsetown -action add -run_as <user name> -host <host name> [-password <password> | -keyname <key name> [-passphrase <key passphrase>]]

   • ctmsetown -action update -run_as <user name> -host <host name> [-password <password> | -keyname <key name > [-passphrase <key passphrase>]]

   • ctmsetown -action delete -run_as <user name> -host <host name>

   • ctmsetown -action list [-run_as <user name>] [-host <host name>]

   • ctmsetown -action export -filename <export file name>

   • ctmsetown -action import -filename <import file name> -data append|truncate

   • ctmsetown help

   The ctmkeygen utility parameters and actions are described in ctmsetown Utility Parameters and ctmsetown Utility Actions.

3. (Optional) Run the following command to invoke the ctmsetown utility from an Agent:

   ctmsetown -action update -owner <user name> -host <host name> -password <new password> -oldpassword <old password>

ctmsetown Utility Parameters

The following table describes the ctmsetown utility parameters.

Parameter	Description
-run as	Defines username that runs the job.
-host	Specifies the hostname where the owner of the job is defined. Type <All> to include all hosts. ctmsetown -action delete -run_as s -host "<All>"
-password	Defines the owner password, which cannot exceed 120 characters.
-old password	Defines the existing password that the user changes. This parameter is mandatory only when the ctmsetown utility is executed from the Agent.
-key name	Defines the logical name of the key. The key itself is kept in a separate folder with its passphrase. For more information about generating and maintaining the key, see ctmkeygen. The same key can be used for multiple users.
-passphrase	Specifies the phrase used to encrypt the key itself. Used only if -keyname is defined.
-file name	Specifies the name of the file that contains the security details of the users. The filename cannot exceed 1,024 characters. This parameter is used only when either -action export or -action import is specified.
-data	Describes what action to take with the data from the imported text file. Valid actions: append: details of the users from the imported text file are added to the existing users truncate: details of the users from the imported text file replace the details of the existing users

ctmsetown Utility Actions

The following table describes the ctmsetown utility actions.

Action	Description
add	Adds security details to a new owner entry (user).
update	Modifies the security details of an existing owner entry (user).
delete	Removes the security details of an owner entry. The owner name and hostname must match an existing entry in the folder.
list	Lists the details of the user. You can use the following wildcards to define -owner and -host parameters: * represents any number of characters. ? represents any single character.
export	Exports the security details of all existing users to a text file. ctmsetown -action export -filename $HOME/ctm_server/data/user_report.txt You must use EOL transformation to export the text file from Windows to UNIX or from UNIX to Windows.
import	Imports the details of the users stored in the specified import file.
help	Displays the usage of the ctmsetown utility.