Table Of Contents

Previous topic

Table Schemas

Next topic

MSI Command Line Options

Runtime Configuration

Configuration File

As mentioned in Agent Architecture by default asagent reads its runtime configuration from the $AS_HOME/etc/asagent.conf file. However if the name setting is used then the file read will be $AS_HOME/etc/name.conf.

The syntax of the configuration file is fairly simple. Any lines starting with the “#” character are regarded as comments and ignored. The file is divided up into sections which are started by the section name enclosed in square brackets, “[” and “]” on a line by itself. Any keys and values are placed on lines by themselves inside the section separated by the “=” character. E.g.:

[section_name]
key1 = value1
key2 = value2

All settings live in one section called settings, any other section names are currently unused.

SETTING TYPES

BoolSetting

Boolean settings are very simple true/false settings. They accept true, t, yes, y, on and 1 as true, and false, f, no, n, off and 0 as false. In both cases any mixture of upper and lower case letters is allowed.

ByteSetting

This setting is used when you need to specify a file size or something similar. It accepts just an integer number which is interpredted as the number of bytes. But common suffixes can be used too.

Binary suffixes
Binary suffixes represent numbers as powers of 2. This uses the International Electrotechnical Commision’s notation that avoids confusion with the ISO notation. They are: KiB (2^10), MiB (2^20), GiB (2^30) and TiB (2^40).
SI suffixes
SI suffixes represent numbers as powers of 10. They are commonly known, although sometimes in relaction to computers mistakenly used for powers of two. Here they are used in their real meaning: kB (10^3), MB (10^6), GB (10^9), TB (10^12).

IntSetting

Unless a minimum and/or maximum is set any integer value is valid. The setting documentation should mention the possible restriction.

IpSetting

This specifies an IP address. It must be either an IPv4 address in dotted quad notation, an IPv6 address or a hostname which can be resolved. To specify a wildcard address leave this blank.

LogLevelSetting

This specifies how verbose a log target must be. Levels can be either a string or a numerical value between 0 and 100 (inclusive). Known strings with their numerical equivalent are: DEBUG (10), INFO (20), WARN (30), WARNING (30), ERROR (40), CRITICAL (50). Using 0 will get you all logging, using 100 will get you no log messages.

PathSetting

When setting a path, environment variables will be expanded and the resulting path will be made absolute. Since you normally don’t really have control over the current directory of the processes it is recommended that the fully expanded path will be an absolute path already.

Note that the ~ character is not expanded.

PeriodSetting

A period is represented as a string: days:hours:minutes:seconds. Any part may be left blank, leading blank parts may be omitted. E.g. legal values are: 200, :::200, 2:30, :2:30. This being 200 seconds for the first two and 2 minutes 30 seconds in the second.

SocketSetting

This specifies a socket address. The format is <address_type>:<address> where <address_type> is one of UNIX, TCP, UDP.

For a UNIX socket (always of SOCK_STREAM type) <address> is an absolute pathname, for a TCP or UDP socket <address> is made up of <ip_address>:<port> where <ip_address> is in the normal quad-dotted notation.

StringSetting

Unless there is a setting specific restriction for a string setting it can be set to any value. Be aware however that if a specific string setting does restrict the value it is probably also case sensitive.

If interprets special values is True, the following will be replaced with their respective values:

!HOST!:Replaced with the hostname of the server we are running on.
!FQDN!:Replaced with the fully qualified domain name of the server we are running on.
!IP!:Replaced with the IPv4 address of the server we are running on.
!APPID!:Replaced with the name of the application, for example asagent, up or ashttpd.
!NAME!:Replaced with the name given by the Name setting.

If expands environment variables is True, environment variables in the string are expanded. On UNIX the Bourne shell syntax is expected e.g:

$AS_HOME

On Windows the %variable-name% syntax is expected e.g:

%AS_HOME%

SETTINGS

daemonise

Run the application as a daemon

  • type: BoolSetting
  • setting: daemonise
  • default: True
  • parameter: –daemonise
  • environment variable: AS_DAEMONISE
  • MSI property: DAEMONISE
  • legacy name: Daemonise
  • legacy section: general
  • legacy parameter: –daemonise
  • legacy environment variable: AS_DAEMONISE

Normally on UNIX servers Abilisoft products run as daemons. However when you are debugging it can be useful to keep the server in the foreground with its file descriptors attached to the console. Setting this to false will inhibit daemonisation.

loglevel

The log level to use

  • type: LogLevelSetting
  • setting: loglevel
  • default: INFO
  • parameter: –loglevel
  • environment variable: AS_LOGLEVEL
  • MSI property: LOGLEVEL
  • legacy name: LogLevel
  • legacy section: logging
  • legacy parameter: –loglevel
  • legacy environment variable: AS_LOGLEVEL

The log level determines how detailed the logging output in the log files and console is. Values can be either a known string or an integer value between 0 and 100 (inclusive). Recognised string values with their numerical equivalents are: DEBUG (10), INFO (20), WARNING (30), ERROR (40) and CRITICAL (50).

name

Name of the application

  • type: StringSetting
  • setting: name
  • default: !APPID!
  • parameter: –name
  • environment variable: AS_NAME
  • MSI property: NAME
  • legacy name: Name
  • legacy section: general
  • legacy parameter: –name
  • legacy environment variable: AS_NAME
  • interprets special values: True
  • expands environment variables: False

Trying to run multiple instances of an Abilisoft product on a single server can sometimes cause a problem. Using this setting you can override the default application name. This influences defaults for the configuration file, log file, CORBA name and PID file. This is useful if you want to run more than one instance of an Abilisoft application on the same host (e.g. multiple agents).

aapi_maxcalls

Maximum API calls per minute

  • type: IntSetting
  • setting: aapi_maxcalls
  • default: 60
  • parameter: –aapi_maxcalls
  • environment variable: AS_AAPI_MAXCALLS
  • MSI property: AAPI_MAXCALLS
  • legacy name: MaxApiCallsPerMinute
  • legacy section: asagent
  • legacy parameter: –max_api_calls_per_minute
  • legacy environment variable: AS_MAX_API_CALLS_PER_MINUTE

This setting specifies the maximum calls per minute allowed by an API client before the agent raises a busy exception. Excessive usage will throttle all calls made to the agent by the the user that has exceeded the threshold. This limit applies to the MAQL and XML RPC APIs.

aapi_ssl

Use SSL on all AAPI interfaces

  • type: BoolSetting
  • setting: aapi_ssl
  • default: True
  • parameter: –aapi_ssl
  • environment variable: AS_AAPI_SSL
  • MSI property: AAPI_SSL

asagent has an API that can be invoked over HTTP or HTTPS. This setting determines whether the API is provided over HTTPS (the default behaviour) or HTTP. Note that the default behaviour of the maql tool is to connect over HTTPS so if this setting is changed the companion setting in a connecting MAQL must also be changed.

agentx_connaddr

Socket to connect to an AgentX master agent

  • type: SocketSetting
  • setting: agentx_connaddr
  • default: None
  • parameter: –agentx_connaddr
  • environment variable: AS_AGENTX_CONNADDR
  • MSI property: AGENTX_CONNADDR

By setting this to a socket address asagent will behave as an AgentX subagent and use the socket address to contact it’s master agent. Once connected to the master agent asagent will respond to all AgentX requests exposing it’s MIB data.

agentx_debuglogging

Enable DEBUG logging in AgentX subsystem

  • type: BoolSetting
  • setting: agentx_debuglogging
  • default: False
  • parameter: –agentx_debuglogging
  • environment variable: AS_AGENTX_DEBUGLOGGING
  • MSI property: AGENTX_DEBUGLOGGING
  • legacy name: AgentXDebugLogging
  • legacy section: asagent
  • legacy parameter: –agentx_debug_logging
  • legacy environment variable: AS_AGENTX_DEBUG_LOGGING

Normally the logging from the AgentX subsystem is capped at INFO level, even if the DEBUG level is set in the LogLevel setting, since it is very verbose. However if you are developing a new subagent or are having other trouble with the AgentX subsystem you might want to see a lot more. This setting will enable DEBUG logging from the AgentX subsystem, but note that is is still controlled by the LogLevel setting.

agentx_debugtrace

Enable tracing of AgentX packets

  • type: BoolSetting
  • setting: agentx_debugtrace
  • default: False
  • parameter: –agentx_debugtrace
  • environment variable: AS_AGENTX_DEBUGTRACE
  • MSI property: AGENTX_DEBUGTRACE

This option will enable tracing of all AgentX PDUs at DEBUG log level (agentx_debuglogging must be enabled to see this). This can be helpful to find out exactly which packets are send and received even when using UNIX sockets.

agentx_listenaddr

Socket to listen on as an AgentX master agent

  • type: SocketSetting
  • setting: agentx_listenaddr
  • default: UNIX:$AS_HOME/var/agentx/!NAME!-master
  • parameter: –agentx_listenaddr
  • environment variable: AS_AGENTX_LISTENADDR
  • MSI property: AGENTX_LISTENADDR

The agent.mon.oidGet monitor can be used to get OID samples from AgentX subagents. If this monitor is used asagent does need to create a socket for the master agent to listen. This setting will configure the type (UNIX STREAM or TCP) and location of this socket. The subagent will also need to be configured to use this socket. The standard location from RFC 2741 is specified as UNIX:/var/agentx/master.

agentx_pinginterval

Interval to send AgentX-Ping requests to master

  • type: PeriodSetting
  • setting: agentx_pinginterval
  • default: 15
  • parameter: –agentx_pinginterval
  • environment variable: AS_AGENTX_PINGINTERVAL
  • MSI property: AGENTX_PINGINTERVAL

When asagent is running as a subagent it will send Agent-Ping PDUs to the master at regular intervals in accordance with RFC2741. This setting allows you to tweak the interval between those AgentX-Ping requests. This is also the period asagent will wait before trying to re-connect to the master agent if it has no connection.

agentx_registeroid

The OID of the sub-tree to register with the master agent

  • type: OIDSetting
  • setting: agentx_registeroid
  • default: 1.3.6.1
  • parameter: –agentx_registeroid
  • environment variable: AS_AGENTX_REGISTEROID
  • MSI property: AGENTX_REGISTEROID

When asagent is running as a subagent this setting will control which sub-tree it registers with the master agent. The entire tree is registered at priority 127, no finer grained control is currently possible.

This does not affect which requests the agent will respond to. It is perfectly fine to request a value from the subagent which it did not register, if it knows how to get that value it will return it regardless of registration.

agentx_sessiontimeout

Default timeout to use in AgentX sessions

  • type: PeriodSetting
  • setting: agentx_sessiontimeout
  • default: 3
  • parameter: –agentx_sessiontimeout
  • environment variable: AS_AGENTX_SESSIONTIMEOUT
  • MSI property: AGENTX_SESSIONTIMEOUT
  • legacy name: AgentXSessionTimeout
  • legacy section: asagent
  • legacy parameter: –agentx_session_timeout
  • legacy environment variable: AS_AGENTX_SESSION_TIMEOUT

This allows you to change the default timeout used by AgentX sessions, if the subagent does not respond in the time (in seconds) specified here then the response is treated as failed. After 3 timed-out requests the session gets closed. Note that a subagent has two ways of overwriting this: when opening the session and when registering subtrees. If you are unhappy with any overwrites from the subagent you will have to change/configure the subagent appropriately.

agentx_socket

deprecated

  • type: SocketSetting
  • setting: agentx_socket
  • default: UNIX:$AS_HOME/var/agentx/!NAME!-master
  • parameter: –agentx_socket
  • environment variable: AS_AGENTX_SOCKET
  • MSI property: AGENTX_SOCKET
  • legacy name: AgentXSocket
  • legacy section: asagent
  • legacy parameter: –agentx_socket
  • legacy environment variable: AS_AGENTX_SOCKET

Deprecated setting, this has been renamed to agentx_listenaddr which has a different default value. Currently a fallback to this settings is in effect when agentx_listenaddr is unset.

agentx_subagent

Enable the subagent usage

  • type: BoolSetting
  • setting: agentx_subagent
  • default: True
  • parameter: –agentx_subagent
  • environment variable: AS_AGENTX_SUBAGENT
  • MSI property: AGENTX_SUBAGENT

For some operations asagent uses a subagent which it manages fully automatically and communicates with using the AgentX protocol. This setting allows you to disable this subagent ensuring the asagent daemon will only use one process. However this will impact some monitoring functionality which relies on the subagent.

agentx_subagentsocket

Socket to communicate with the subagent

  • type: SocketSetting
  • setting: agentx_subagentsocket
  • default: UNIX:/srv/eddie/tmp/mtm_donbot3/src/mtmCore/var/run/asagent/subagent_socket-!NAME!
  • parameter: –agentx_subagentsocket
  • environment variable: AS_AGENTX_SUBAGENTSOCKET
  • MSI property: AGENTX_SUBAGENTSOCKET

For some operations asagent uses a subagent which it manages fully automatically. This setting specifies which socket address it should use to communicate with this subagent. By default this will use a safe UNIX socket address on UNIX but on Windows it defaults to port 705 on the localhost. This setting allows you to change this to avoid conflicts.

analysis_prime_maxage

Max sample age in seconds for samples used to prime analysis

  • type: PeriodSetting
  • setting: analysis_prime_maxage
  • default: ::10:
  • parameter: –analysis_prime_maxage
  • environment variable: AS_ANALYSIS_PRIME_MAXAGE
  • MSI property: ANALYSIS_PRIME_MAXAGE
  • legacy name: MaxPrimedSampleAge
  • legacy section: asagent
  • legacy parameter: –max_primed_sample_age
  • legacy environment variable: AS_MAX_PRIMED_SAMPLE_AGE

Maximum age in seconds of sample data that will be used to prime the analysis engine on asagent startup. This will mean asagent can detect event which occurred while it was shortly down. Setting this to 0 will result in no historical samples being primed.

analysis_window

Data Analysis Window

  • type: PeriodSetting
  • setting: analysis_window
  • default: :1::
  • parameter: –analysis_window
  • environment variable: AS_ANALYSIS_WINDOW
  • MSI property: ANALYSIS_WINDOW
  • legacy name: DataAnalysisWindow
  • legacy section: asagent
  • legacy parameter: –data_analysis_window
  • legacy environment variable: AS_DATA_ANALYSIS_WINDOW

Specifies age after which observation and action data is purged from the agent store. This setting can be specified in the same way as monitor_window (e.g. ‘:1::’ means keep one hour of observation data).

cfg_backend

Configuration backend to use

  • type: StringSetting
  • setting: cfg_backend
  • default: DEFAULT
  • parameter: –cfg_backend
  • environment variable: AS_CFG_BACKEND
  • MSI property: CFG_BACKEND
  • legacy name: ConfigBackend
  • legacy section: config
  • legacy parameter: –config_backend
  • legacy environment variable: AS_CONFIG_BACKEND
  • interprets special values: False
  • expands environment variables: False

This defines which configuration backend should be used. Unless specified on the command line the default INI backend is used in any case, but this can be set to some other backend wich will then be loaded in addition to the INI backend. The latter backend will have priority over the INI one.

The DEFAULT backend will use INI on UNIX systems and WINREG on Windows.

cfg_crypt_keydir

Path to Encyption Keys

  • type: PathSetting
  • setting: cfg_crypt_keydir
  • default: $AS_HOME/etc/keys
  • parameter: –cfg_crypt_keydir
  • environment variable: AS_CFG_CRYPT_KEYDIR
  • MSI property: CFG_CRYPT_KEYDIR
  • legacy name: CryptKeysPath
  • legacy section: asagent
  • legacy parameter: –crypt_keys_path
  • legacy environment variable: AS_CRYPT_KEYS_PATH

This setting specifies the path to the Keyczar generated encryption keys.

cfg_inifile

Configuration file for the INI backend

  • type: StringSetting
  • setting: cfg_inifile
  • default: !NAME!.conf
  • parameter: –cfg_inifile
  • environment variable: AS_CFG_INIFILE
  • MSI property: CFG_INIFILE
  • legacy name: ConfigIni
  • legacy section: config
  • legacy parameter: –config
  • legacy environment variable: AS_CONFIG_FILE
  • interprets special values: True
  • expands environment variables: False

This specifies which configuration file the INI backend should read the configuration from.

The default is overwritten by all applications so for example asagent modifies this value to asagent.conf.

log_dir

Directory for logfiles

  • type: PathSetting
  • setting: log_dir
  • default: $AS_HOME/var/log
  • parameter: –log_dir
  • environment variable: AS_LOG_DIR
  • MSI property: LOG_DIR
  • legacy name: LogDir
  • legacy section: logging
  • legacy parameter: –log_dir
  • legacy environment variable: AS_LOGDIR

The directory to store the logfiles in. If you use environment variables in here they will be expanded.

log_filecount

Number of roll-over logfiles to keep

  • type: IntSetting
  • setting: log_filecount
  • default: 5
  • parameter: –log_filecount
  • environment variable: AS_LOG_FILECOUNT
  • MSI property: LOG_FILECOUNT
  • legacy name: BackupCount
  • legacy section: logging
  • legacy parameter: –logfile_backup_count
  • legacy environment variable: AS_LOGFILE_BACKUP_COUNT

When a log file reaches it’s maximum size (specified by log_maxfilesize) it is rolled over and renamed to foo.log.N where N is a number. The number of these rolled over log files to keep is specified here.

log_filename

Name for the log file

  • type: StringSetting
  • setting: log_filename
  • default: !NAME!
  • parameter: –log_filename
  • environment variable: AS_LOG_FILENAME
  • MSI property: LOG_FILENAME
  • legacy name: LogFileName
  • legacy section: logging
  • legacy parameter: –log_file_name
  • legacy environment variable: AS_LOGFILENAME
  • interprets special values: True
  • expands environment variables: False

The base filename of the logfile to use, i.e. the name given here will get .log appended to it. Specials values like !APPID! and !NAME! are allowed.

log_maxfilesize

Maximum size of a logfile before it gets rolled over

  • type: ByteSetting
  • setting: log_maxfilesize
  • default: 5MiB
  • parameter: –log_maxfilesize
  • environment variable: AS_LOG_MAXFILESIZE
  • MSI property: LOG_MAXFILESIZE
  • legacy name: MaxSize
  • legacy section: logging
  • legacy parameter: –max_logfile_size
  • legacy environment variable: AS_MAX_LOGFILE_SIZE

The maximum size a logfile is allowed to have, once this size is reached it is rolled over and a new one is started. The size can have common size suffixes like kB, MB, KiB, MiB, etc.

log_utc

Timestamp in logfiles are UTC

  • type: BoolSetting
  • setting: log_utc
  • default: True
  • parameter: –log_utc
  • environment variable: AS_LOG_UTC
  • MSI property: LOG_UTC
  • legacy name: LogTimeUTC
  • legacy section: logging
  • legacy parameter: –log_time_utc
  • legacy environment variable: AS_LOG_TIME_UTC

Timestamps used in the logfiles represent UTC time. By setting this to False they will represent local time.

manifest_checkperiod

Period between checks for an updated manifest (in minutes)

  • type: IntSetting
  • setting: manifest_checkperiod
  • default: 0
  • parameter: –manifest_checkperiod
  • environment variable: AS_MANIFEST_CHECKPERIOD
  • MSI property: MANIFEST_CHECKPERIOD
  • legacy name: ManifestCheckPeriod
  • legacy section: asagent
  • legacy parameter: –manifest_check_period
  • legacy environment variable: AS_MANIFEST_CHECK_PERIOD

This setting specifies periodicity the agent checks for an updated manifest in minutes. A value of zero means the agent will only check on start-up but never again after that.

manifest_http_pwd

HTTP Password

  • type: StringSetting
  • setting: manifest_http_pwd
  • default: ''
  • parameter: –manifest_http_pwd
  • environment variable: AS_MANIFEST_HTTP_PWD
  • MSI property: MANIFEST_HTTP_PWD
  • legacy name: HTTPPwd
  • legacy section: asagent
  • legacy parameter: –http_pwd
  • legacy environment variable: AS_HTTP_PWD
  • interprets special values: False
  • expands environment variables: False

MA supports the acquisition of manifests and sub-manifests over HTTP and HTTPS. If HT-Access is configured on the webserver as specified in manifest_uri then you can use this setting to specify the password credential.

manifest_http_usr

HTTP User

  • type: StringSetting
  • setting: manifest_http_usr
  • default: ''
  • parameter: –manifest_http_usr
  • environment variable: AS_MANIFEST_HTTP_USR
  • MSI property: MANIFEST_HTTP_USR
  • legacy name: HTTPUser
  • legacy section: asagent
  • legacy parameter: –http_user
  • legacy environment variable: AS_HTTP_USER
  • interprets special values: False
  • expands environment variables: False

MA supports the acquisition of manifests and sub-manifests over HTTP and HTTPS. If HT-Access is configured on the webserver as specified in manifest_uri then you can use this setting to specify the user credential.

manifest_uri

Master Manifest URI

  • type: StringSetting
  • setting: manifest_uri
  • default: file://$AS_HOME/etc/manifest.xml
  • parameter: –manifest_uri
  • environment variable: AS_MANIFEST_URI
  • MSI property: MANIFEST_URI
  • legacy name: MasterManifestUri
  • legacy section: asagent
  • legacy parameter: –master_manifest_uri
  • legacy environment variable: AS_MASTER_MANIFEST_URI
  • interprets special values: True
  • expands environment variables: True

Specifies the master manifest URI the agent will use. You can use the special !HOST!, !FQDN!, !IP! and !APPID! special values anywhere in this string. For a full list of the special values that will be replaced see mtmconfig_types(5) under “StringSetting”.

manifest_utc

Interpre manifest timestamps as UTC

  • type: BoolSetting
  • setting: manifest_utc
  • default: True
  • parameter: –manifest_utc
  • environment variable: AS_MANIFEST_UTC
  • MSI property: MANIFEST_UTC
  • legacy name: ManifestTimestampsAsLocal
  • legacy section: asagent
  • legacy parameter: –manifest_timestamps_as_local
  • legacy environment variable: AS_MANIFEST_TIMESTAMPS_AS_LOCAL

By default timestamps in the manifest are interpreted as UTC time however if this flag is set to false then they are interpreted as local time. This is especially useful for the ‘effectiveFrom’ and ‘updated’ attributes of a manifest.

manifest_validate

Perform manifest validation

  • type: BoolSetting
  • setting: manifest_validate
  • default: True
  • parameter: –manifest_validate
  • environment variable: AS_MANIFEST_VALIDATE
  • MSI property: MANIFEST_VALIDATE
  • legacy name: ValidateManifest
  • legacy section: asagent
  • legacy parameter: –validate_manifest
  • legacy environment variable: AS_VALIDATE_MANIFEST

Perform DTD validation of any manifest loaded.

monitor_asyncpoolsize

Maximum number of concurrent async tasks

  • type: IntSetting
  • setting: monitor_asyncpoolsize
  • default: 64
  • parameter: –monitor_asyncpoolsize
  • environment variable: AS_MONITOR_ASYNCPOOLSIZE
  • MSI property: MONITOR_ASYNCPOOLSIZE

The monitoring engine uses asynchronous I/O for many network related monitors. This setting control the maximum number of concurrent asynchronous task which should be running. If there are too many tasks then the worker queue will start backing up work.

Tuning this can be important depending on the maximum number of filedescriptors asagent is allowed to use by the operating system and the single-core processing speed of the host. Having a too large pool might result in degraded performance and inaccurate results. Performance statistics of an agent might be gleaned from the PERFSTATUS table.

monitor_poolsize

Number of monitoring engine workers

  • type: IntSetting
  • setting: monitor_poolsize
  • default: 4
  • parameter: –monitor_poolsize
  • environment variable: AS_MONITOR_POOLSIZE
  • MSI property: MONITOR_POOLSIZE
  • legacy name: DataAcquisitionPoolsize
  • legacy section: asagent
  • legacy parameter: –data_acquisition_poolsize
  • legacy environment variable: AS_DATA_ACQUISITION_POOLSIZE

The monitoring engine schedules monitors which are then executed by a thread pool of workers. This setting will define how many workers the engine will use. If there are not enough workers the execution time of monitors will start to slip.

monitor_window

Data Acquisition Window

  • type: PeriodSetting
  • setting: monitor_window
  • default: :1::
  • parameter: –monitor_window
  • environment variable: AS_MONITOR_WINDOW
  • MSI property: MONITOR_WINDOW
  • legacy name: DataAcquisitionWindow
  • legacy section: asagent
  • legacy parameter: –data_acquisition_window
  • legacy environment variable: AS_DATA_ACQUISITION_WINDOW

Specifies age after which acquired sample data is purged from the agent store. This setting can be specified in the same way sample periods are, e.g:

':::60'  - 1 Minute
'::1:'   - 1 Minute
'1:'     - 1 Minute
'1:::'   - 1 day
':24::'  - 1 day

monitor_zeroconfig

Enable Zero Config Monitoring

  • type: BoolSetting
  • setting: monitor_zeroconfig
  • default: False
  • parameter: –monitor_zeroconfig
  • environment variable: AS_MONITOR_ZEROCONFIG
  • MSI property: MONITOR_ZEROCONFIG
  • legacy name: ZeroConfigMonitoring
  • legacy section: asagent
  • legacy parameter: –zero_config_monitoring
  • legacy environment variable: AS_ZERO_CONFIG_MONITORING

When set to true the agent will automatically perform monitoring of all cpu cores, file-systems (and certain file and log monitoring) on the host without the requirement for any manifest additional manifest definition. This default monitoring is as defined in the CPU, DISK, MEM and MON Platform Component Definitions.

notify_retrycount

Number of times to re-try an action if it fails

  • type: IntSetting
  • setting: notify_retrycount
  • default: 3
  • parameter: –notify_retrycount
  • environment variable: AS_NOTIFY_RETRYCOUNT
  • MSI property: NOTIFY_RETRYCOUNT
  • legacy name: ActionretryCount
  • legacy section: asagent
  • legacy parameter: –actionretry_count
  • legacy environment variable: AS_ACTIONRETRY_COUNT

When an action fails the notification subsystem will attempt to re-execute it a number of times. This setting defines how many times it will be re-tried. Note that when the agent gets re-configured any pending action-retries will be lost.

notify_retrydelay

Time to wait before re-trying a failed action

  • type: PeriodSetting
  • setting: notify_retrydelay
  • default: 15
  • parameter: –notify_retrydelay
  • environment variable: AS_NOTIFY_RETRYDELAY
  • MSI property: NOTIFY_RETRYDELAY
  • legacy name: ActionretryDelay
  • legacy section: asagent
  • legacy parameter: –actionretry_delay
  • legacy environment variable: AS_ACTIONRETRY_DELAY

When an action fails the notification subsystem will re-try executing it a few times (see notify_retrycount). This setting defines how long the delay should be before retrying it’s execution.

status_eventcount

Number of status events to keep

  • type: IntSetting
  • setting: status_eventcount
  • default: 42
  • parameter: –status_eventcount
  • environment variable: AS_STATUS_EVENTCOUNT
  • MSI property: STATUS_EVENTCOUNT
  • legacy name: status_eventcount
  • legacy section: asagent
  • legacy parameter: –status_eventcount
  • legacy environment variable: AS_STATUS_EVENTCOUNT

Specifies the number of status events which are kept. Each status event is a name like e.g. “startup”, “config”, etc and can have several additional data key-value pairs like e.g. “uri=http://example.com/manifest.xml”.

status_perfwindow

Status performance data acquisition window

  • type: PeriodSetting
  • setting: status_perfwindow
  • default: 7:::
  • parameter: –status_perfwindow
  • environment variable: AS_STATUS_PERFWINDOW
  • MSI property: STATUS_PERFWINDOW
  • legacy name: status_perfwindow
  • legacy section: asagent
  • legacy parameter: –status_perfwindow
  • legacy environment variable: AS_STATUS_PERFWINDOW

Specifies the age after which performance status data is purged from the agent store. Defaults to keeping 7 days of performance data.

store_uri

URI of the master database

  • type: StringSetting
  • setting: store_uri
  • default: sqlite:$AS_HOME/var/lib/asagent/!NAME!.db
  • parameter: –store_uri
  • environment variable: AS_STORE_URI
  • MSI property: STORE_URI
  • legacy name: MasterDatabaseURI
  • legacy section: asagent
  • legacy parameter: –master_database_uri
  • legacy environment variable: AS_MASTER_DATABASE_URI
  • interprets special values: True
  • expands environment variables: True

Specifies the URI of the master database, this is the database that contains the data service definitions, and typically the database the data services will use.

The URI has the form: sqlite:/path/to/database?timeout=10
Here the ?timeout=10 part is optional and allows you to specify a lock timeout. Only in exceptional circumstances should the timeout be set.

xmlrpc_addr

IP address for the XML-RPC remote interface

  • type: IpSetting
  • setting: xmlrpc_addr
  • default: 0.0.0.0
  • parameter: –xmlrpc_addr
  • environment variable: AS_XMLRPC_ADDR
  • MSI property: XMLRPC_ADDR

The address the built-in XML-RPC server will listen on when enabled. If the server has multiple interfaces you can specify the specific address to listen on with this setting.

xmlrpc_enabled

XML RPC API Enabled

  • type: BoolSetting
  • setting: xmlrpc_enabled
  • default: False
  • parameter: –xmlrpc_enabled
  • environment variable: AS_XMLRPC_ENABLED
  • MSI property: XMLRPC_ENABLED
  • legacy name: XmlrpcApiEnabled
  • legacy section: asagent
  • legacy parameter: –xmlrpc_api_enabled
  • legacy environment variable: AS_XMLRPC_API_ENABLED

MA has an API that can be invoked over HTTP using XML-RPC protocol. This is required to use the maql tool as well as allowing third-party applications to easily manipulate asagent via its API. This setting allows you to switch on the XML-RPC API interface.

xmlrpc_maxmsgsize

Maximum message size

  • type: ByteSetting
  • setting: xmlrpc_maxmsgsize
  • default: 2MiB
  • parameter: –xmlrpc_maxmsgsize
  • environment variable: AS_XMLRPC_MAXMSGSIZE
  • MSI property: XMLRPC_MAXMSGSIZE

Specifies the maximum amount of data that can be sent (or received) in an interface call. The default is 2MiB (2*1024^2). Increase this value if you get ‘SizeError’ exceptions.

xmlrpc_port

XML RPC API Port

  • type: IntSetting
  • setting: xmlrpc_port
  • default: 8080
  • parameter: –xmlrpc_port
  • environment variable: AS_XMLRPC_PORT
  • MSI property: XMLRPC_PORT
  • legacy name: XmlrpcApiPort
  • legacy section: asagent
  • legacy parameter: –xmlrpc_api_port
  • legacy environment variable: AS_XMLRPC_API_PORT

Specifies the port that the XML Remote Procedure Call API will listen on.

Settings on Windows

On Windows platforms the agent settings are stored (by default) in the registry. All agent settings are stored under:

HKEY_LOCAL_MACHINE\SOFTWARE\abilisoft\asagent

Settings on Windows can be modified using the Registry Editor:

_images/regeditor.png

To run the Registry Editor, select Start/Run on the Windows start menu and type regedit in the open field. All key names have the same name settings described in this appendix. Double-click on a setting key to change the value.

_images/regeditor_edit.png

One can however configure the agent to use the UNIX INI style configuration settings instead. Changing ConfigBackend to INI will force the agent to load runtime settings from the $AS_HOME/etc/asagent.conf file.

_images/regeditor_configbackend.png

Windows 64 bit

The registry key for any 32 bit application running on a 64 bit version of Windows is found under the Wow6432Node sub-heading [1]. Therefore if the agent is installed on a 64 bit Windows platform settings are stored under:

HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\abilisoft\asagent

Footnotes

[1]Wow64 (Windows 32-bit On Windows 64-bit) is a compatibility layer which was introduced in Windows 2000. More information can be here: http://msdn.microsoft.com/en-us/library/aa384249(VS.85).aspx

Other Registry Settings

On installation the following registry key is set the installed directory:

HKEY_LOCAL_MACHINE\SOFTWARE\abilisoft\as_home

By default this value is C:\Program Files\Abilisoft\asagent. This value must be changed if the installed directory is moved.