Hawk Agent Configurations

-cluster <cluster name>

-agent_name <agent name>

-agent_domain <agent domain name>

-hawk_domain <TIBCO Hawk Domain Name>

-rvd_session <service> < network> <daemon>

-tcp_session <self_IP>:<port> <cluster_manager_IP>:<port>

-tcp_key_store <key store file path>

-tcp_trust_store <trust store file path>

-tcp_key_store_password <key store password>

-tcp_key_password <key password>

-tcp_trust_store_password <trust store password>

-tcp_ssl_protocol <security protocol>

-tcp_enabled_algorithms <security algorithms>

-ems_transport <ems transport parameters>

-ssl_ciphers <suite-name>

-ssl_no_verify_host

-ssl_trusted <file name>

-ssl_expected_hostname <host name>

-ssl_identity <file name>

-ssl_private_key <file name>

-ssl_password <string>

-use_thread_pool <thread pool>

-character_encoding <character encoding>

-hma_plugin_dir <directory>

-rulebases <rulebase> <rulebase> …

-config_path <list of directories to use as configuration sources>

-auto_config_dir <directory to autoload rulebases at startup>

-repository_path <list of repositories to use as configuration sources>

-repository_cache_dir <repository cache dir>

-variables <property file>

-email_smtp_server <SMTP hostname>

-email_smtp_port <server port number>

-email_smtp_auth_required <true or false>

-email_smtp_tls_required <true or false>

-email_smtp_user <user name>

-email_smtp_password <password>

-email_from <sender email address>

-email_content_type <content type>

-ami_rvd_session <service> <network> <domain>

-ami_tcp_session <self_IP>:<port>

-log_dir <directory to store TIBCO Hawk logs>

-log_max_size <maximum size of log file>

-log_max_num <maximum number of log files>

-log_level <desired trace level for logs>

-log_format <log format>

-interval <heartbeat interval in seconds>

-security_policy <class that implements security>

-repository_name <repository name>

-repository_dir <repository directory>

-scan_rate <scan interval in seconds>

-block_size <size in kilobytes>

-eval_rate <rate in seconds>

The name of the container in which the agent appears in the display by default. The display creates the container if it does not already exist. Allows for grouping of multiple agents. The cluster name must be enclosed within quotes, if the name contains spaces.

Each agent being managed must have a unique combination of agent_name, agent_domain, and hawk_domain values. To use the host name as the agent name, comment this option.

Note: Agent names with multiple words separated by dots are not supported.

An agent domain must be specified when two computers within the same TIBCO Hawk domain have the same name but reside in different network domains. For example, you might specify this option as: -agent_domain pa.tibco.com.

As explained in Hawk Domain.

TCP Transport for TIBCO Hawk (Default)

Specifies that the TIBCO Hawk Agent should use TCP Transport for TIBCO Hawk. The syntax of the property is:

-tcp_session <self_IP>:<port> <cluster_manager_IP>:<port>

where,

In case of multiple daemons, agents, or consoles running on the same instance, use different ports for creating unique socket address.

For fault tolerance, you can specify multiple seed daemon’s socket addresses in a comma-separated list.

-tcp_session <self_IP>:<port> <daemon1_IP>:<port>, <daemon2_IP>:<port>

For more information of the Hawk Cluster Manager, see Hawk Cluster Manager Configurations.

TCP Transport for TIBCO Hawk SSL Parameters

The following TLS/SSL parameters are applicable to -tcp_session and -ami_tcp_session.

Path of the key store file

Path of the trust store file

Password for the key store file

Encrypted key password

Password for the trust store file

Protocol for a secure connection

Algorithm to be used for the security protocol. You can specify multiple algorithms as comma-separated list without space.

TIBCO Rendezvous Transport

Comment this option if you are using TCP Transport for TIBCO Hawk or TIBCO EMS as the primary transport.

The format is -rvd_session <service> <network> <daemon>.

If you use this option, all three parameters must be present and separated by white space. Use a semicolon (;) to indicate a null value, or use an empty string, for example:

-rvd_session 7474; tcp:7474

TIBCO EMS Transport

Comment this option if you are using TCP Transport for TIBCO Hawk or TIBCO Rendezvous as the primary transport.

Specifies location of the EMS server. For example:

-ems_transport tcp://server1:7222 admin ""

NOTE: If EMS is configured as Transport, ami_rvd_session parameter should be configured.

TIBCO EMS SSL Parameters (In case EMS Server is configured for SSL communication).

The name of the vendor of the SSL implementation. The valid choices are

Cipher suite name

Indicate not to verify the EMS server

File name of the server certificates. The file should be accessible locally/ shared drive

Indicates not to verify the name in CN field of the server certificate

If the -ssl_no_verify_host is not specified, the option -ssl_trusted has to be

used. Along with the option-ssl_trusted specify either

-ssl_no_verify_hostname or -ssl_expected_hostname.

Digital certificate

Private key

Optimizes the number of threads the agent creates for every microagent it discovers. It is advisable to turn this option On if the agent is going to discover over 100 microagents. This value is OS dependent and should be set to the maximum number of threads allowable per process.

Character encoding to be used across the configured transport

Specify the plug-in directory path.

List of .hrb files to be loaded at the startup

The list of directories to use as configuration sources. Used in the case of manual configuration.

The delimiter for path entries is a colon (:).

If -config_path is used, comment the -auto_config_dir,

-repository_path, and -repository_cache_dir options.

The directory to auto-load Rulebases at the startup.

If this option is present, the agent runs in an automatic configuration mode.

Specify the directory from which the Rulebase and schedule configuration objects are loaded at the startup. The default directory, HAWK_HOME/autoconfig, is used if a value is commented.

If you use automatic configuration, comment the following options:

-config_path, -repository_path, -repository_cache_dir,

-rulebases

List of repositories to use as configuration sources.

If repository configuration mode is used, specify the path to be searched for repositories. The delimiter for path entries is a colon (:).

The default used if this option is commented is the current working directory.

If -repository_path is used, comment the -auto_config_dir and -config_path options.

If repository configuration mode is used, all configuration objects loaded from the repository may be cached in a local directory, specified in this option. This cache is used if a repository fails, and also to minimize network traffic.

If -repository_cache_dir is used, comment the -auto_config_dir and

-config_path options.

Properties file to specify variables file. The variables file can pass data to define external variables to be passed to rules for use in Rulebase configurations.

Email Configurations

Email configuration options are used to send the notification email.

Specifies the hostname of the SMTP server.

Specifies the port at which the SMTP server is listening.

Specifies whether authentication is required for the SMTP server. The default value is false. If the value is true, you need to provide the user name (-email_smtp_user) and password (-email_smtp_password) for authentication.

Specifies whether TLS encryption is required for the SMTP server. If set to true, use of the STARTTLS command is required (if supported by the server) to switch the connection to a TLS-protected connection before issuing any login commands.

Specifies the sender’s user name for the SMTP server authentication. The field is mandatory if the authentication option (-email_smtp_auth_required) is set to true.

Specifies the sender’s password for the SMTP server authentication. The field is mandatory if the authentication option (-email_smtp_auth_required) is set to true.

Specifies the sender’s email address for sending the email. The default is the current system user, for example, "HawkAdministrator"<admin@abc.com>

Specifies the content type of email. The email application interprets the text characters in the body of the email based on this property.

Configuration for AMI communication

Configures the agent with a RVD session to be used to communicate with applications implementing the TIBCO Hawk Application Management Interface. Multiple -ami_rvd_session parameters may be specified. If none are specified, the RV session used for AMI is the primary session of the Self Module.

# Note: When using TIBCO EMS transport for communication, 127.0.0.1 should be used as the network parameter. For example: -ami_rvd_session 7474 127.0.0.1 tcp:7474

If you are using TCP Transport for TIBCO Hawk then uncomment this option, so that Hawk Agent can communicate with Hawk Microagent using the TCP-RV bridge. Same value must be used in the Hawk Microagent configuration (hawkhma.cfg) for the -rvd_session parameter.

Configures the Hawk agent with a TCP session to be used to communicate with applications implementing the TIBCO Hawk Application Management Interface.

If this parameter is not specified while using TCP Transport for TIBCO Hawk, the default value (localhost:2571) is used.

The syntax of the property is:

-ami_tcp_session <self_IP>:<port>

where, <self_IP>:<port> is the unique socket address for communication with TIBCO Hawk Application Management Interface.

Logging

The directory in which to store log files generated by the TIBCO Hawk Agent.

The maximum size of a rotating log files in Kbytes.

The maximum number of rotating log files

Specifies the level of diagnostic information stored in the logs. The following are the logging levels:

4 - Indicates error level trace messages should be enabled.

6- Indicates warning level trace messages should be enabled.

7 - Indicates information level trace messages should be enabled.

8 - Indicates debug level trace messages should be enabled.

16 - Indicates AMI level trace messages should be enabled.

A value of zero turns all tracing off.

A value of -1 turns all tracing on.

The format for trace log messages

TIBCO Protocol Adapter

The heartbeat interval in seconds.

The fully qualified name of the Java class which implements the security policy. For more information refer to TIBCO Hawk Security Model.

Rulebase Repository

The name of the Rulebase Repository

The location of the Repository

Logfile MicroAgent

The rate at which log files are scanned.

The maximum number of kilobytes to read on each scan.