0% found this document useful (0 votes)
209 views

Control-D Agent 9.0.21 User Guide

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
209 views

Control-D Agent 9.0.21 User Guide

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 25

Control-D/Agent

9.0.21
User Guide

August 2022
Contacting BMC Software
You can access the BMC Software website at http://www.bmc.com. From this website, you can obtain
information about the company, its products, corporate offices, special events, and career opportunities.
United States and Canada

Address BMC SOFTWARE INC Telephone  713 918 8800 Fax 713 918 8000
2103 CITYWEST BLVD  800 841 2031
HOUSTON TX
77042-2827
USA

Outside United States and Canada

Telephone (01) 713 918 8800 Fax (01) 713 918 8000

© Copyright 1999-2022 BMC Software, Inc.


Your use of this information is subject to the terms and conditions of the applicable End User License
Agreement for the product and the proprietary and restricted rights notices included in this
documentation. No part of this publication may be reproduced, stored in a retrieval system, or transmitted
in any form or by any means, electronic, mechanical, photocopying, recording or otherwise, without the
prior written permission of BMC Software, Inc.
BMC, BMC Software, the BMC logo, the BMC Software logo, and other BMC marks, and the tagline “Bring
IT to Life” are the exclusive properties of BMC Software, Inc., or its affiliates or subsidiaries and are
registered or may be registered with the U.S. Patent and Trademark Office and in other countries. All
other BMC trademarks, service marks, and logos may be registered or pending registration in the U.S. or
in other countries. All other trademarks or registered trademarks are the property of their respective
owners.
For BMC Control-M Products that are licensed on the “per CPU – Full Capacity” unit of measurement and
installed in an Amazon Web Services (“AWS”), Microsoft Azure (“Azure”), or Google Cloud Platform
("GCP") cloud environment, a license is required for the total number of CPUs in each AWS, Azure, or GCP
instance upon which the Product is installed or which the Product manages, either remotely or locally. For
AWS and GCP, one CPU is equivalent to one vCPU, as defined by AWS. For Azure, one CPU is equivalent
to up to four Virtual Cores (as defined by Azure), rounded up to the closest multiple of four.
IBM® Cognos, IBM InfoSphere DataStage, IBM i (AS/400), IBM Websphere, and AIX® are the
trademarks or registered trademarks of International Business Machines Corporation in the United States,
other countries, or both.
UNIX® is the registered trademark of The Open Group in the US and other countries.
Linux is the registered trademark of Linus Torvalds.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks
of their respective owners.
SAP® R/2 and SAP R/3, SAP Business Objects, and SAP NetWeaver are trademarks or registered
trademarks of SAP AG in Germany and in several other countries.

2
Restricted rights legend
U.S. Government Restricted Rights to Computer Software. UNPUBLISHED -- RIGHTS RESERVED UNDER
THE COPYRIGHT LAWS OF THE UNITED STATES. Use, duplication, or disclosure of any data and
computer software by the U.S. Government is subject to restrictions, as applicable, set forth in FAR Field
52.227-14, DFARS 252.227-7013, DFARS 252.227-7014, DFARS 252.227-7015, and DFARS 252.227-7025,
as amended from time to time. Contractor/Manufacturer is BMC SOFTWARE INC, 2101 CITYWEST BLVD,
HOUSTON TX 77042-2827, USA. Any contract notices should be sent to this address.
Customer support
You can obtain technical support by using the BMC Software Customer Support website or by contacting
Customer Support by telephone or e-mail. To expedite your inquiry, see “Before contacting BMC.”
Support website
You can obtain technical support from BMC 24 hours a day, 7 days a week at
(http://www.bmc.com/support). From this website, you can:
 Read overviews about support services and programs that BMC offers
 Find the most current information about BMC products
 Search a database for issues similar to yours and possible solutions
 Order or download product documentation
 Download products and maintenance
 Report an issue or ask a question
 Subscribe to receive proactive e-mail alerts when new product notices are released
 Find worldwide BMC support center locations and contact information, including e-mail addresses, fax
numbers, and telephone numbers
Support by telephone or e-mail
In the United States and Canada, if you need technical support and do not have access to the web, call
800 537 1813 or send an e-mail message to [email protected]. (In the subject line, enter
SupID:<yourSupportContractID>, such as SupID:12345). Outside the United States and Canada,
contact your local support center for assistance.
Before contacting BMC
Have the following information available so that Customer Support can begin working on your issue
immediately:
 Product information
• Product name
• Product version (release number)
• License number and password (trial or permanent)
 Operating system and environment information
• Machine type
• Operating system type, version, and service pack or other maintenance level such as PUT or PTF

3
• System hardware configuration
• Serial numbers
• Related software (database, application, and communication) including type, version, and service
pack or maintenance level
 Sequence of events leading to the issue
 Commands and options that you used
 Messages received (and the time and date that you received them)
• Product error messages
• Messages from the operating system, such as file system full
• Messages from related software
License key and password information
If you have questions about your license key or password, contact BMC as follows:
 (USA or Canada) Contact the Order Services Password Team at 800 841 2031, or send an e-mail
message to [email protected].
 (Europe, the Middle East, and Africa) Fax your questions to EMEA Contracts Administration at +31 20
354 8702, or send an e-mail message to [email protected].
 (Asia-Pacific) Contact your BMC sales representative or your local BMC office.
Third party Software
For the provisions described in the BMC License Agreement and Order related to third party products or
technologies included in the BMC Product,
seehttps://docs.bmc.com/docs/display/workloadautomation/Control-M+Workload+Automation+Document
ation and click Third-party software (TPS).

4
Contents
Introduction to Control-D/Agent ........................................................................................ 6
Setting up Control-D/Agent .......................................................................................................... 6

Control-D file watcher ....................................................................................................... 7


Control-D file watcher configuration .............................................................................................. 7
Starting and stopping Control-D file watcher ................................................................................ 11
Previous version Automation Process configuration files conversion ............................................... 12

Control-D file transfer client ............................................................................................ 13


Starting Control-D file transfer client using the command line........................................................ 13

Control-D file transfer server ........................................................................................... 14


Starting Control-D file transfer server .......................................................................................... 14
Control-D file transfer server configuration parameters ................................................................. 14

Control-D/Agent installation ............................................................................................ 16


Preparing an external Java installation ........................................................................................ 16
Control-D/Agent installation on UNIX .......................................................................................... 17
Control-D/Agent installation on Windows ..................................................................................... 19
Uninstalling Control-D/Agent ...................................................................................................... 21

Control-D/Agent SSL configuration .................................................................................. 22


Enabling SSL ............................................................................................................................. 22
Control-D/Agent SSL configuration parameters ............................................................................ 23
Changing the encrypted password .............................................................................................. 23
Generating SSL certificates ......................................................................................................... 23

5
1
1
Introduction to Control-D/Agent
Control-D/Agent administers the transfer of files and reports from distributed system computers to the
mainframe or to other distributed system computers. The transfer of files is facilitated by components of
Control-D/Agent that are described in this manual (Control-D file watcher, Control-D file transfer client,
and Control-D file transfer server).
Control-D/Agent manages file transfer by monitoring predefined directories to detect newly arrived files
(for example, business reports) in the local file system. Pattern matching on file names is used to identify
individual files or categories of files destined for particular destinations.

Setting up Control-D/Agent
This procedure describes how to set up Control-D/Agent.

Before you begin


 Ensure that file watcher on one of the following systems is running:
• Windows: runs as a Windows service (BMC Control-D/Agent file watcher).
• UNIX: start using command line script (start_filewatcher)

 To set up Control-D/Agent to send files to a mainframe destination:


1. Configure the file watcher to start Control-D/Agent file transfer client to send files to the target
computer upon arrival.
2. Place the files to be sent to the target computer in the watched directory.
For more information on how to run and configure Control-D/Agent, see Control-D file watcher (on
page 7).

6
2
2
Control-D file watcher
Control-D file watcher (file watcher) polls specified directories to detect new files (e.g., reports) as they
arrive in the local file system. Depending on file identification specifications (for example,
Branch_20*.*av would specify all files beginning with the name Branch_20 and having a suffix that
ends with av), files matching the specifications would be sent to their destinations by invoking Control-D
file transfer client to handle the sending processing.
On Windows, the file watcher is started as a Window service. On UNIX, it is started from the command
line.
Once started, the file watcher continually polls specified directories for newly arrived files that fit pattern
matching criteria.
When a file that matches polling criteria is found, the action designated to process the file is automatically
started using the parameters defined in the file watcher GUI. Processing can take place concurrently as
more matching files arrive.
The file watcher GUI allows you to specify what to do with processed files. If a file is processed
successfully, you can have it deleted or placed in the sub-directory, Done.
If processing fails, the file is placed in the sub-directory, Failed.
NOTE: If you define more than one matching mask for the same directory, matching reports will be
transferred randomly to the specified hosts.

Control-D file watcher configuration


Configure Control-D file watcher using the configuration GUI. The GUI enables you to configure
parameters for file watcher actions and definitions for watched files. When adding a new configuration
definition or modifying an existing one, Control-D file watcher must be restarted before the changes take
effect.
NOTE: (UNIX Only) Before opening the GUI, set the environment variable display to 0.0 by issuing the
following command:
setenv DISPLAY <working station IP address>:0.0
For more information, see Starting and stopping Control-D file watcher (on page 11).
 Directory definition parameters: Set up watched directories where each directory contains polling
criteria definitions for files you want sent to a certain location. You can set up as many separate
directories as required. Directory definition parameters are listed in Control-D file watcher directory
definition parameters (on page 8).
 File watcher configuration parameters: These parameters apply to functionality of the file
watcher and control functions such as polling interval, parallel executions, etc. These parameters
listed in Control-D file watcher configuration parameters (on page 10)are configured using the File
watcher configuration GUI.

7
Control-D/Agent User Guide

Control-D file watcher directory definition parameters


The following table describes the Control-D file watcher directory definition parameters.

Parameter Description

Action Command line Command to process a matched file. This command includes
(Mandatory if the processing program name and its input parameters (e.g.,
parameter ProcessAndSend.sh %%FILE_PATH).
Destination is
Note:
not used.)
 using the variable %%FILE causes the watched file
name to be substituted for the variable in the command.
 using the variable %%FILE_PATH causes the watched
file path and the watched file name to be substituted for
the variable in the command.
 Similarly, use of the %%INSTALLATION_PATH
variable causes the installation path to be substituted for
the variable.
(Mandatory if parameter Destination is not used).

Destination Host Name of the receiving host server that


(This is the receives the file transfer request.
recommended
Mandatory.
method.
(Mandatory if
Port Port number of the receiving host server that
parameter
receives the file transfer request.
Command is not
used). Mandatory.
This is an efficient
SSL Enable SSL communication. Use this option
internal file
only if the destination is configured to work
transfer client.
with SSL communication.

Target path Filename and path of the transferred file at


the target destination.
Optional.

8
Control-D/Agent User Guide

Parameter Description

Delete after execution Delete processed files. If left unchecked, processed files are
moved to the subdirectory done that is created automatically
under the polling directory to store removed files. The polling
directory security must allow file deletion for this parameter
to work.
Default: No

Directory path Polling directory - the directory in which to poll for new files
(e.g., programs/pollfiles).
Mandatory

Mask Mask specification for file search (e.g., Mask=*.txt). A mask


specification can consist of letters, numbers and symbols that
are acceptable to the system and are used in file names.
Wildcards characters ? (any character) and * (any string) can
also be used.
Default: *
Mandatory

Name Logical name of the watched directory.


Mandatory

Overwrite when done Overwrite processed files. files moved to subdirectory done
can overwrite existing files with identical names. Otherwise,
files with identical names are saved with a random number
added to the file name (e.g., a new version of the file abc.txt
might be saved as abc_985352). See also,
DeleteAfterExecution.
Default: No

9
Control-D/Agent User Guide

Control-D file watcher configuration parameters


The following table describes the Control-D file watcher configuration parameters.

Parameter Description

Max parallel executions Maximum number of destinations or command line parallel


executions.
 Minimum: 1.
 Maximum: 2000.
 Default: 10.
Mandatory

Polling interval Length (in seconds) of polling interval (e.g., -i=10).


 Minimum interval length: 1.
 Maximum: 600.
 Default: 10.
Mandatory

Verification ready count Maximum number of times to check that a matched file is
complete. This check is necessary as the file may still be in the
process of being uploaded to the system.
 Minimum number of completion checks: 1.
 Maximum: 100.
 Default: 3.
Mandatory

Refresh configuration Refresh the configuration parameters (in seconds)


interval
 Minimum: 1 second.
 Default: 60 seconds.
Mandatory

File watcher logging mechanism configuration


The logging mechanism monitors Control-D/Agent components and records the details of errors and other
exceptions that occur.
Logging messages can be sent to three destinations:

10
Control-D/Agent User Guide

 Console - specific information such as starting, stopping, and runtime errors are written to the
console.
 Log file - starting, stopping, runtime errors and warnings are written to a file.
 Memory buffer - detailed information held in memory is dumped to a file if a severe error occurs.
File destinations and message levels can be configured in the Control-D/Agent component configuration
files in the <ctdAgentHome>\config directory:
 Control-D file watcher - file_watcher_logging.cfg
 Control-D file transfer client - ft_client_logging.cfg
 Control-D file transfer server - ft_server_logging.cfg
Configuration instructions are provided inside the configuration files.

Starting and stopping Control-D file watcher


This procedure describes how to start and stop Control-D file watcher.
Before you begin
(UNIX only) Before opening the GUI, set the environment variable display to 0.0 by issuing the following
command:
setenv DISPLAY <working station IP address>:0.0

 To start and stop Control-D file watcher:


1. Do one of the following:
• UNIX: The file watcher is started or stopped from the command line using the following syntax:
o start_filewatcher
o stop_filewatcher
The status of Control-D file watcher can be checked using the command:
check_filewatcher
• Windows: The file watcher is started or stopped via the Window service, BMC
Control-D/Agent file watcher.
2. Start the Control-D file watcher GUI by doing one of the following:
• UNIX: From the bin folder, start the file watcher by typing the following command:
bmc-ctd-filewatcher-gui
• Windows: From the Start menu, click Configure File Watcher.
NOTE: If Configure File Watcher does not appear in the Start menu, from the bin folder run
the following batch file:
bmc-ctd-filewatcher-gui.bat

11
Control-D/Agent User Guide

Previous version Automation Process configuration files


conversion
The bmc-ctd-filewatcher-config-convert utility is used to convert previous version Automation
Process configuration files to File Watcher configuration files in XML format. The
bmc-ctd-filewatcher-config-convert utility is available in both UNIX and Windows
(bmc-ctd-filewatcher-config-convert.bat)
Usage:
bmc-ctd-filewatcher-config-convert <source ini file> <destination XML file>
where
<source ini file> is the previous version Automation Process configuration file (automate.ini).
<destination XML file> is the resulting File Watcher XML configuration file (file_watcher.xml).

12
3
3
Control-D file transfer client
Control-D file transfer client (file transfer client) is usually invoked automatically from Control-D file
watcher which monitors directories for incoming files and uses an internal file transfer client to send them
to the mainframe. BMC Software recommends using this method for all your file transfers. For more
information, see Control-D file watcher (on page 7).

Starting Control-D file transfer client using the command


line
This procedure describes how to starting Control-D file transfer client using the command line. Although
the file transfer client is usually invoked from the file watcher, you can also send individual files to the
mainframe from the command line.

 To start Control-D file transfer using the command line:


 Use the following syntax (modify command suffix for UNIX or Windows as necessary):
bmc-ctd-ftclient [-h=host] [-p=port] -f=input file [-d=output file] [-ssl]
[-h=host] Name of the host server that receives the request for file transfer.
[-p=port] Port on the remote computer. Default 1948.
[-f=input file] File name and path of the source file. Use a comma separated list to transfer multiple
files.
[-d=output file] File name and path of the target destination.
[-ssl] enable SSL communication (see Control-D/Agent SSL configuration (on page 22)).
EXAMPLE: bmc-ctd-ftclient -h=mfhost -p=12345 -f=report_file_name.pdf
-d=FTO_group_ID/FTO_report_ID

13
4
4
Control-D file transfer server
Control-D file transfer server is responsible for receiving files on a distributed systems computer.
Received files are stored in the directory specified by the WorkingDir parameter in the ft_server.config
file.

Starting Control-D file transfer server


This procedure describes how to start Control-D file transfer server.
 To start Control-D file transfer server:
 Do one of the following:
• UNIX: The Control-D file transfer server is started or stopped from the command line using the
following syntax:
o start_ftserver
o stop_ftserver
The status of Control-D file transfer service can be checked using the command:
check_ft_server
• Windows:
o The Control-D file transfer server is started via the Windows service, Control-D/Agent file
transfer server.

Control-D file transfer server configuration parameters


Control-D file transfer server is configured using the configuration file, ft_server.config, located in the
<INSTALLATION PATH>\config directory.

14
Control-D/Agent User Guide

Parameters are listed in the following table.

Parameter Description

WorkingDir Location for incoming files. This parameter can be expressed as a


full path name. Default: <INSTALLATION PATH>\tmp
To change the default parameter for WorkingDir or add multiple
client names, which require new security definitions in the
ft_server_security.txt file (located in the config folder) open
the file and update as necessary. You then need to restart the
ft_server.

Port Port number. Default: 1948

Overwrite Allow overwriting of existing files by files with newly received


files of same name. The following values can be specified:
 Yes: allow existing files to be overwritten
 No: create a unique name for the incoming file by extending
the existing file name. For example, a new version of
banking.txt would be stored as banking_#xxx...#.txt where
#xxx...# is a system generated addition to the existing file
name.
Default: Yes

RefreshConfigurati Time interval (in minutes) for re-reading the configuration file.
onInterval

Ssl Enable use of SSL.


Values: yes, no
Default: no
For further information, see Control-D/Agent SSL configuration
(on page 22).

15
5
5
Control-D/Agent installation
You can install Control-D/Agent on UNIX (GUI or console mode) or on Windows, either interactively or
silently.
The silent installation procedure allows you to set up an XML script file with all the necessary parameter
information to install Control-D/Agent using a single command. This is especially useful when the product
needs to be installed on several computers using the same configuration.
You can download the installation package in various formats from http://www.bmc.com/available/epd.
For more information, see the Control-D/Agent Release Notes.
The following topics describe how to prepare for the installation and how to install or uninstall
Control-D/Agent on UNIX or Windows:
 Preparing an external Java installation (on page 16)
 Control-D/Agent installation on UNIX (on page 17)
 Control-D/Agent installation on Windows (on page 19)
 Uninstalling Control-D/Agent (on page 21)

Preparing an external Java installation


This procedure describes how to choose an external Java installation that is compatible with
Control-D/Agent and set a Java environment variable to point to that Java installation. An external Java
installation is required for any installation or upgrade of Control-D/Agent. The Java installation directory
must contain the bin directory and the Release file.

 To set the Java environment variable:


1. Check whether your external Java installation is compatible with Control-D/Agent by running the
following command.
Ensure that the return code is 0.
• UNIX: <DVD Path>/Setup_files/check_java_ready.sh -java_path <Java Path>
• Windows: powershell <DVD Path>\Setup_files\check_java_ready.ps1 -java_path "<Java Path>"
Java path examples:
• UNIX: /usr/lib/jvm/java-11-openjdk-amd64
• Windows: C:\jdk-11.0.14.1+1-jre
2. Set the Java environment variable by running the relevant command:
• UNIX:
o sh/bash: export BMC_INST_JAVA_HOME=<Java Path>
o csh/tcsh: setenv BMC_INST_JAVA_HOME <Java Path>
• Windows: set BMC_INST_JAVA_HOME="<Java Path>"

16
Control-D/Agent User Guide

Control-D/Agent installation on UNIX


You can install Control-D/Agent on UNIX either interactively or silently.
The following procedures describe how to prepare for the installation and how to install Control-D/Agent
for UNIX.
 Setting environment variables in UNIX (on page 17)
 Installing Control-D/Agent on UNIX interactively (on page 17)
 Installing Control-D/Agent on UNIX silently (on page 18)

Setting environment variables in UNIX


This procedure describes how to set environment variables in UNIX, which enables you to view messages
from the console.
 To set environment variables in UNIX:
 Do one of the following:
• Users of csh and tcsh should use the following syntax:
setenv <envVar> <value>
EXAMPLE: setenv DISPLAY myhost:0.0
 Users of sh, ksh, and bash should use the following syntax:
<envVar>=<value>
export <envVar>
EXAMPLE: DISPLAY=myhost:0.0
export DISPLAY
<envVar> is the name of the environment variable.
<value> is the value assigned to the environment variable.

Installing Control-D/Agent on UNIX interactively


This procedure describes how to install Control-D/Agent on UNIX.

Before you begin:


Ensure that you have an external Java installation that is compatible with Control-D/Agent and have set
an environment variable to point to that Java installation, as described in Preparing an external Java
installation (on page 16).

17
Control-D/Agent User Guide

 To install Control-D/Agent on UNIX interactively:


1. Log on to the Control-D/Agent account.
2. If you are using the GUI, set the DISPLAY environment variable, for example, to value
<hostName>:0.0 For your UNIX environment, see Setting environment variables in UNIX (on page
17).
To run the installation in console mode instead of GUI mode, do not set DISPLAY.
3. Do one of the following:
• ISO DVD: Do the following:
a. Log on to the root user.
b. Mount the Control-D/Agent installation DVD from the root user.
c. Log off the root user.
d. Insert the installation DVD and use the following command to run the installation script:
<dvdPath>/setup.sh [-BMC_INST_JAVA_HOME <Java Path>]
NOTE: Java Path is required only if you do not have an environment variable to point to your
external Java installation.
• EPD/FTP: Do the following:
a. Download and save the file into a temporary directory, <INST_TEMP_DIR>.
b. Extract the compressed .z file.
c. Run the following command:
<INST_TEMP_DIR>/setup.sh [-BMC_INST_JAVA_HOME <Java Path>]
NOTE: Java Path is required only if you do not have an environment variable to point to your
external Java installation.
4. Follow the instructions on the screen.
The installation log can be found in the home directory of the Control-D/Agent account.
EXAMPLE: <agentInstallFolder>/BMCINSTALL/log/BMC_Control-D_Agent_Install_<date.time>.log
NOTE: After you have finished installation, you can now install the latest fix pack to apply the most
recent software updates.

Installing Control-D/Agent on UNIX silently


This procedure describes how to install Control-D/Agent on UNIX silently. This installation involves the
following stages:
 Preparing an installation script
This is accomplished by running the interactive installation to generate an installation script.
 Running the installation using the prepared installation script
The Control-D/Agent components are installed silently using the generated information script. You can
reuse the script to silently install Control-D/Agent on other computers.

18
Control-D/Agent User Guide

 To prepare the silent installation script:


1. Run the interactive installation as described under Installing Control-D/Agent on UNIX interactively (on
page 17).
The DISPLAY environment variable should not be set for silent mode.
2. When you reach the Summary screen, use the Generate an automatic installation script button
to save your installation choices from the previous screens to an XML script file (you are prompted to
specify a name and path for the file).
3. Select Quit.
If you want to change parameter values at a later time, you can modify the script using a text editor.

 To install Control-D/Agent on UNIX silently:


1. Log on to the Control-D/Agent account.
2. Issue the following command:
<DVD Path/Hard drive/other>/setup.sh -silent <Automatic installation script path>
-BMC_INST_JAVA_HOME <Java Path>
where
• <DVD Path/Hard drive/other> defines where the setup files are located.
• <Automatic installation script path> defines the full path to the silent installation script file.
• <Java Path> defines the path to an external Java installation that is compatible with
Control-D/Agent (as described in Preparing an external Java installation (on page 16)).
3. The installation log can be found in the home directory of the Control-D/Agent account, for example:
<agentInstallFolder>/BMCINSTALL/log/BMC_Control-D_Agent_Install_<date.time>.log

Control-D/Agent installation on Windows


You can install Control-D/Agent on Windows either interactively or silently. The following sections describe
how to install Control-D/Agent for Windows.
 Installing Control-D/Agent on Windows interactively (on page 19)
 Installing Control-D/Agent on Windows silently (on page 20)

Installing Control-D/Agent on Windows interactively


This procedure describes how to install Control-D/Agent on Windows interactively.
Before you begin:
Ensure that you have an external Java installation that is compatible with Control-D/Agent and have set
an environment variable to point to that Java installation, as described in Preparing an external Java
installation (on page 16).

19
Control-D/Agent User Guide

 To install Control-D/Agent on Windows interactively:


1. Log on using an ID with Administrator privileges on the current computer.
2. Do one of the following:
• ISO DVD: Insert the installation DVD and run <dvdPath>\setup.
• Zip file: Download and extract the .zip file to a temporary folder and run: <temporary
folder>\setup
NOTE: If you do not have an environment variable to point to your external Java installation, run
the setup file with the Java Path property: <dvdPath/temporary folder>\setup
-BMC_INST_JAVA_HOME <Java Path>
3. Follow the instructions on the screen.
The installation log can be found in: %TEMP%

Installing Control-D/Agent on Windows silently


This procedure describes how to install Control-D/Agent on Windows silently. This installation involves the
following stages:
 Preparing an installation script
This is accomplished by running the interactive installation to generate an installation script.
 Running the installation using the prepared installation script
The Control-D/Agent components are installed silently using the generated information script. You can
reuse the script to silently install Control-D/Agent on other computers.
Before you begin:
Prepare the silent installation script by doing the following:
 Run the interactive installation as described in Interactive installation. When you reach the Summary
screen, use the Generate an automatic installation script button to save your installation choices
from the previous screens to an XML script file, and then select Quit. If you want to change
parameter values at a later time, you can modify the script using a text editor.
 To install Control-D/Agent on Windows silently:
1. Log on to the target computer using an ID with Administrator privileges.
2. Issue the following command in the CMD:
<DVD Path/Hard drive/other>\setup -silent <Automatic installation script path>
-BMC_INST_JAVA_HOME <Java Path>
where
• <DVD Path/Hard drive/other> defines where the Setup_files and the setup.exe are located.
• <Automatic installation script path> defines the full path to the silent installation script file.
• <Java Path> defines the path to an external Java installation that is compatible with
Control-D/Agent (as described in Preparing an external Java installation (on page 16)).
The installation log can be found in: %TEMP%

20
Control-D/Agent User Guide

Uninstalling Control-D/Agent
The uninstall process attempts to delete all Control-D/Agent files and folders/directories. In cases where
items cannot be deleted (locked or in used by another process), you can safely deleted them manually
after the installation process has completed.
The following procedures describe how to uninstall Control-D/Agent from UNIX and Windows:
 Uninstalling Control-D/Agent from UNIX (on page 21)
 Uninstalling Control-D/Agent from Windows (on page 21)

Uninstalling Control-D/Agent from UNIX


This procedure describes how to completely remove all Control-D/Agent components from UNIX.
 To uninstall Control-D/Agent from UNIX:
1. If you are using the GUI, set the environment variable DISPLAY to value <hostName>:0.0.
See Setting environment variables in UNIX (on page 17) for your UNIX environment. It is not
necessary to set DISPLAY for console mode or silent mode.
2. Use the following command to run the uninstallation script:
<agentInstallFolder>/BMCINSTALL/uninstall/<LPnumber>/uninstall.sh [-silent]
If the -silent parameter is used, uninstall is performed immediately. If not, you are asked to confirm
your intention to uninstall.
The uninstallation log can be found in the Control-D/Agent home folder.
EXAMPLE: <agentInstallFolder>/BMCINSTALL/log/BMC_Control-D_Agent_UnInstall_<date.time>.log

Uninstalling Control-D/Agent from Windows


Use the following procedure to completely remove all Control-D/Agent components from Windows. You
can uninstall interactively or silently.
 To uninstall Control-D/Agent from Windows:
 Do one of the following:
• Uninstall interactively, perform the following procedure:
a. Select Start => Settings => Control Panel=> Add/Remove Programs.
b. Select Control-D/Agent 9.0.21 from the Currently installed programs list.
c. Click Remove or Add/Remove to begin the uninstall procedure.
• Uninstall silently, use the following command:
<agentInstallFolder>\BMCINSTALL\uninstall\<LPnumber>\uninstall.exe -silent
The uninstallation log can be found in the Control-D/Agent home folder.
EXAMPLE: %TEMP%\BMC_Control-D_Agent_UnInstall_<date.time>.log

21
6
6
Control-D/Agent SSL configuration
SSL is used to ensure security when transferring files from distributed systems computers to the
mainframe.
NOTE: Control-D/Agent supports TLS Protocol version 1.2.
Control-D file transfer client, Control-D file transfer server, and Control-D for z/OS should have certificates
signed by the same CA (Certificate Authority). Control-D file transfer client, Control-D file transfer server,
and Control-D for z/OS DEMO certificates are signed by the same DEMO CA. BMC Software recommends
that you replace the demo certificates with a certificate signed by a approved CA in your organization.

Enabling SSL
This procedure describes how to enable SSL on Control-D file transfer client and server.

 To enable SSL on Control-D file transfer client and server:


 Do the following:
• Enable SSL on Control-D file transfer client:
The -ssl command line parameter should be added to the command line to communicate with the
host and port using SSL.
• Enable SSL on Control-D file transfer server:
In the configuration file, ft_server.config, <INSTALLATION PATH>/config, set Ssl to yes
to enable the server to listen in SSL mode on the port.

22
Control-D/Agent User Guide

Control-D/Agent SSL configuration parameters


SSL can be configured using the configuration file, ctdagent.ssl.properties, located in the <INSTALLATION
PATH>/config directory. The following table describes the ctdagent.ssl.properties configuration
parameters that can be edited.

Parameter Description

KeystorePassword Password required to open the "keystore" file in which certificate


and other SSL information is stored. This password is encrypted.

KeystoreFile Path to the location of the keystore.


Default: ctdagent.keystore

KeyManagerFactory In the case that Control-D/Agent is running on IBM Java, i.e.,


AIX the value should be set to IbmX509
To switch to IbmX509:
In the ctdagent.ssl.properties configuration file, remove the #
at the beginning of the line containing IbmX509 and add # to
the beginning of the line containing SunX509.
Default: SunX509

If you want to change the encrypted password, see: Changing the encrypted password (on page 23).

Changing the encrypted password


This procedure describes how to change the encrypted KeystorePassword.
 To change the encrypted KeystorePassword:
1. Run bmc-ctd-ssl-changepass (UNIX) or bmc-ctd-ssl-changepass.bat (Windows) from the
<INSTALLATION PATH>/bin directory.
2. Enter a new password at the prompt to update the ctdagent.ssl.properties configuration file.

Generating SSL certificates


Control-D/Agent uses Java keystore to store public and private keys and SSL certificates. The Java
keystore file format is the same as the Apache Tomcat web server, but uses ctdagent as the alias
instead of tomcat.

23
Control-D/Agent User Guide

 To generate SSL certificates:


1. Create the ctdagent.keystore file and export or import a private/public key.
NOTE: On Windows, the Java keytool utility must be run from the following folder:
<INSTALLATION PATH>\JRE\bin.
Run the Java keytool utility with the following parameters:
keytool -genkey -alias ctdagent -keystore keystore_file_path -storepass
keystore_password -keypass keystore_password -dname distinguished_name
-keyalg rsa/dsa
EXAMPLE: keytool -genkey -alias ctdagent -keystore ctdagent.keystore
-keyalg rsa -storepass ctdagentpass -keypass ctdagentpass -dname
"C=IS, ST=Texas, L=Houston, O=bmc, OU=MSM, CN=ctdagent"
NOTE: The passwords for storepass and keypass must be identical. The password generated in
this step will be required in step 7.
2. Export a CSR (Certificate Signing request) from keystore in order to sign it.
Run the keytool utility with the following parameters:
keytool -certreq -alias ctdagent -keystore <keystore_file_path> -storepass
<keystore_password> -file <certfilename.crs>
EXAMPLE: keytool -certreq -alias ctdagent -keystore ctdagent.keystore
-storepass ctdagentpass -file ctdagentCert.crs
3. Use a private or commercial trusted CA to sign the certificate to process the CSR.
4. Import a CA certificate into keystore
Run the keytool utility with the following parameters:
keytool -import -alias <alias_for_the_CA_entry> -keystore
<keystore_file_path> -storepass <keystore_password> -file <cacert.pem>
EXAMPLE: keytool -import -alias systemca -keystore ctdagent.keystore
-storepass ctdagentpass -file new_ca.pem
5. If the CA has an intermediate certificate, import this one as well (see step 4).
6. Import a signed certificate into keystore
Run the keytool utility with the following parameters:
keytool -import -alias alias_for_the_key_entry -keystore
keystore_file_path -storepass keystore_password -file certfilename.der
The signed certificate must be in X.509 DER (Definite Encoding Rules) format.
EXAMPLE: keytool -import -alias ctdagent -keystore ctdagent.keystore
-storepass ctdagentpass -file ctdagentCert.der
7. Ensure that the Control-D/Agent SSL configuration contains the same keystore password that was
used for the keystore. If necessary, follow the procedure in Changing the encrypted password (on
page 23).

24

You might also like