Hawk Console Modules and Configuration Options

Each section in this configuration file (HAWK_HOME/bin/hawkconsole.cfg) begins with “-M” followed by the module name, such as –M Self. Within each modular section, all the command-line options that can be configured are listed. These options are as follows:

Hawk Console Modules and Options
Module	Parameters
-M Self	-domain_config_file <`domain config file path`>
	-server_port <`port number`>
	-key_alias <`key alias`>
	-key_password <`encrypted key password`>
	-key_store <`key store file path`>
	-key_store_password `<key store password>`
	-protocol <`security protocol`>
	-ciphers <`cipher name`>
	-subscription_queue_size <queue size>
	-subscription_expiry_time <`expiry time`>
	-proxy_alert_count_pull_interval <`time interval`>
	-proxy_domain_reachability_check_interval <`time interval`>
	-datasource_url `<Datasource URL>`
	-datasource_drivername `<JDBC driver name>`
	-datasource_username `<Database user name>`
	-datasource_password `<Database password>`
	-datasource_connection_pool_initial_size `<Initial number of database connections to be allocated>`
	-datasource_connection_pool_max_idle `<Maximum number of idle database connections allowed>`
	-datasource_connection_pool_max_active `<Maximum number of active database connections allowed>`
	-retention_count_for_notification <`Alert limit for Notification. Default is 100000.`>
	-retention_count_for_high_alerts <`Alert limit for High Alerts. Default is 100000.`>
	-retention_count_for_medium_alerts <`Alert limit for Medium Alerts. Default is 100000.`>
	-retention_count_for_low_alerts <`Alert limit for Low Alerts. Default is 100000.`>
	-repository_path "`CONFIG_HOME/hawk/repository`"
	-alert_manager_activity_interval `<time interval in milliseconds>`
	-max_reconnect_attempts_during_connect
	-max_reconnect_attempts_after_restart
-M LogService	-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 `<required trace level for logs>`
	-log_format <`log format`>
-M UserAuth	-user_store_type <`store type`>
	-user_file_store <`path of file store`>

Each of the parameters listed above are explained in more detail, in the following table.

Property

Mandatory

Default Value

Description

-domain_config_file

CONFIG_FOLDER/bin/DomainTransportConfig.yml

Path of file that contains the domain and transport configurations for Hawk Console.

For details on the domain and transport configuration file, see Domain and Transport Configuration for Hawk Console.

-server_port

8083

The server port to access Hawk Console.

Secure Communication (SSL Authentication) Options

-key_alias

Key alias

-key_password

Encrypted key password

-key_store

The path of the key store file.

-key_store_password

The password for the key store file.

-protocol

TLSv1.2

The security protocol for a secure communication.

-ciphers

TLS_RSA_WITH_AES_128_CBC_SHA

The ciphers to be used for the specified security protocol. You can specify multiple ciphers as comma-separated list. The following ciphers are supported:

TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384

TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384

TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256

TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256

TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384

TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384

TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256

TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256

-subscription_queue_size

128

A bounded circular queue is maintained for each subscription for storing its results. This parameter defines the maximum size of the queue. If the maximum size of queue is reached then old results are overridden by the new ones.

-subscription_expiry_time

90000

Time in milliseconds after which a subscription expires if the results of subscription are accessed.

Proxy Domain Options

-proxy_alert_count_pull_interval

15000

Time interval (in milliseconds) in which the alert count is fetched from proxy domains.

-proxy_domain_reachability_check_interval

15000

Time interval (in milliseconds) in which proxy domains are checked for reachability.

External Database Configuration

-datasource_url

jdbc:h2:mem:test;DB_CLOSE_DELAY=-1

URL which identifies the database connection

-datasource_drivername

org.h2.Driver

Name of the JDBC driver

-datasource_username

User name to connect to the database

-datasource_password

User’s password to connect to the database

-datasource_connection_pool_initial_size

Initial number of database connections to be allocated

-datasource_connection_pool_max_idle

Maximum number of idle connections allowed in the database connection pool

-datasource_connection_pool_max_active

100

Maximum number of active connections allowed in the database connection pool

-retention_count_for_notification

100000

Alert limit for Notification

-retention_count_for_high_alerts

100000

Alert limit for High Alerts

-retention_count_for_medium_alerts

100000

Alert limit for Medium Alerts

-retention_count_for_low_alerts

100000

Alert limit for Low Alerts

-alert_manager_activity_interval

20000

The period, in milliseconds, after which the alert manager executes to store alerts in the database and purge extra alerts in the database.

-max_reconnect_attempts_during_connect No 20 Specifies the number of reconnection attempts when the console is unable to connect on first attempt

-max_reconnect_attempts_after_restart No 1000 Specifies the number of reconnect attempts to be made when the console gets disconnected from the Daemon

-repository_path

CONFIG_HOME/hawk/repository

Path to the repository

Logging

-log_dir

CONFIG_FOLDER/logs

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

-log_max_size

10M

The maximum size of a rotating log files in KB. You can apply a suffix ’m’ or ’M’ for indicating MB values.

-log_max_num

The maximum number of rotating log files

-log_level

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.

-log_format

ae4

The format for trace log messages

User Authentication

-user_store_type

database

Specify whether Hawk Console uses an inbuilt database or a file for user authentication. The values are:

• database - In the database based configuration, the user names and passwords are stored in the database.

• file - In the file based configuration, the user names and passwords are stored in a file in the disk. Specify the location of the user authentication file in the -user_file_store property.

• ldap - In the ldap based configuration, the user names and passwords are validated with a LDAP directory server.

-user_file_store

CONFIG_FOLDER/bin/hawkconsole-users.cfg

If -user_store_type is file, specify the path of the file which stores user details for authentication.

User Authentication: LDAP-Based

ldap_host

Yes

Not applicable

Host name for the LDAP server.

ldap_port

389

Port of the LDAP server.

ldap_adminDN

Yes

Not applicable

LDAP manager user DN for accessing the server, to avoid anonymous access to the server.

ldap_admin_password

Yes

Not applicable

LDAP admin password for accessing the server.

The password is obfuscated.

ldap_baseDN

Yes

Not applicable

Base DN for the users to search.

ldap_uid_attr

UID

UID attribute to perform the user search.

ldap_ssl_enabled

false

Specifies whether to connect to LDAP over SSL or not.

Did you find this helpful?

Yes No