Blueprint RSRemote Configuration
Blueprint File
The Blueprint file contains configuration settings for all Resolve Actions Pro components. The first section of the Blueprint contains installation parameters which need to be set before installing Actions Pro. After installation, you may need to modify the Blueprint file to optimize or customize Actions Pro for your existing environment.
Each server with Actions Pro installed has its own Blueprint file. Connection settings (covered in Installation Parameters) need to match on each server in the cluster. Other settings, such as gateway configurations, may be set on individual servers.
Blueprint Syntax
The following is special syntax used in the blueprint.properties file. They are mostly used to change the value of properties before being applied to the local Actions Pro environment (i.e., encrypting values or referencing other property values).
Reserved Variables
The following Variables are reserved by the Blueprint and cannot be overwritten.
${DIST}—Installation Directory of Actions Pro
Syntax
The following table describes the syntax of the Blueprint.
| Item | Description |
|---|
# | Used at the start of a line to add a comment. |
${} | Reference to other parameters in the Blueprint; for example, ${PRIMARY} will reference the value of PRIMARY. |
ENC: | Deprecated. A value encrypted with an older encryption method. |
ENC1: | An encrypted value; by default, all non-reference, plain text password fields will be encrypted after running config.sh/config.bat. |
NO_ENC: | Used to leave a password field unencrypted or as plain text; for example, DB_PASSWORD=NO_ENC:resolve will be left as is after config, even though it is a password field. |
TO_ENC: | Used to specify a value that needs to be encrypted after running config.sh/config.bat which is not normally encrypted; for example, rsmq.username=TO_ENC:resolve after config.sh/config.bat is run becomes rsmq.username=ENC1:encrypted text. |
Modifying the Blueprint and Re-configuring RSRemote
The file is named blueprint.properties and is located in the <installPath>/rsmgmt/config directory. In UNIX environments, there is a softlink to this file in the bin directory.
Do not remove the blueprint.properties file located in the rsmgmt/config directory! Your Actions Pro installation will not operate without this file.
When setting up the blueprint file, use a forward slash / instead of a backslash \. If you do use a backslash, double it \\ because Java treats the single backslash as an escape.
If you make a mistake configuring the JAVA_HOME variable, it can not be fixed.
Modifying the Blueprint
You can edit the Blueprint file using any text editor. The Blueprint file contains simple name=value pairs. These configuration options are described in detail in other sections.
Applying the Blueprint Configuration
Actions Pro must be reconfigured using the modified Blueprint before changes will take effect.
- Stop all Actions Pro processes whose configurations are being changed.
- Modify the
blueprint.properties file for the new configuration. - Run the configuration script:
- Linux: config.sh
<actions-pro-home>/bin/config.sh
- Windows:
<actions-pro-home>\bin\config.bat
- After the configuration script completes, restart Actions Pro.
Required Settings
The following settings are required for the Actions Pro installation.
Always change the localhost IP address 127.0.0.1 to the actual IP address or hostname of the machine.
| Property | Description | Default Value |
|---|
| CLUSTERNAME | Name of the RSSearch cluster. Set it to the same name used on the cluster’s core machines. | RESOLVE |
| LOCALHOST | The hostname or IP address of the local server.
Change to the actual IP address or hostname of the machine. | 127.0.0.1 |
| RSMQ_PRIMARY_HOST | The hostname or IP address of the primary RSMQ node. | 127.0.0.1 |
| RSMQ_PRIMARY_PORT | Port used by the RSMQ service on the primary node. | 4004 |
| RSMQ_BACKUP_HOST | Only in clustered installations
The hostname or IP address of the secondary RSMQ node. | 127.0.0.1 |
| RSMQ_BACKUP_PORT | Port used by the RSMQ service on the secondary node. | 4004 |
Blueprint File Advanced Settings
The Blueprint file contains additional settings and values beyond those described in the Installation Guides. These values are listed here for reference.
RSRemote Settings
The following lists shows the logical groups of RSRemote properties and their default values.
See Configuring Multiple RSRemote Instances on the Same Server for setting up multiple RSRemotes on a single server.
rsremote.instance.count=1
rsremote.instance1.name=rsremote
RSRemote General Configuration
rsremote.general.home=${DIST}
rsremote.general.cluster=false
rsremote.general.configfileversion=1.0
rsremote.general.configrevisions=2
rsremote.general.saveconfigonstart=true
rsremote.general.saveconfigonexit=true
rsremote.general.cronoffset=0
rsremote.general.maxthread=500
rsremote.general.maxsystemthread=500
rsremote.general.timezone=
rsremote.general.threadkeepalive=30
RSRemote Log4j Properties
rsremote.log4j.Loggers.Root.level=WARN
rsremote.log4j.Loggers.Root.appender-ref.ref=RSREMOTE,amqp
rsremote.log4j.Loggers.Logger.com.resolve.rsremote.level=${rsremote.log4j.loglevel}
rsremote.log4j.Loggers.Logger.com.resolve.dcs.httplogappender.level=INFO
rsremote.log4j.Loggers.Logger.DCS.level=INFO
rsremote.log4j.Loggers.Logger.DCS.appender-ref.ref=DCS
rsremote.log4j.Loggers.Logger.syslog.level=ERROR
rsremote.log4j.Loggers.Logger.syslog.additivity=false
rsremote.log4j.Appenders.RollingFile.name=RSREMOTE
rsremote.log4j.Appenders.RollingFile.fileName=rsremote/log/rsremote.log
rsremote.log4j.Appenders.RollingFile.filePattern=rsremote/log/$\${date:yyyy-MM}/rsremote-%d{MM-dd-yyyy}-%i.log.zip
rsremote.log4j.Appenders.RollingFile.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rsremote.log4j.Appenders.RollingFile.SizeBasedTriggeringPolicy.size=32MB
rsremote.log4j.Appenders.RollingFile.DefaultRolloverStrategy.max=6
rsremote.log4j.Appenders.AmqpAppender.name=amqp
rsremote.log4j.Appenders.AmqpAppender.threshold=WARN
rsremote.log4j.Appenders.AmqpAppender.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] %X{context} %X{filter} (%F:%L) - %m%n
rsremote.log4j.Appenders.HttpLogAppender.name=DCS
rsremote.log4j.Appenders.HttpLogAppender.charset=utf-8
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationInstance=update-me
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationUsername=update-me
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationPassword=update-me
rsremote.log4j.Appenders.HttpLogAppender.hostAddresses=${RSREMOTE_RSDATALOADER_URL}
rsremote.log4j.Appenders.HttpLogAppender.httpConnectionTimeout=5000
rsremote.log4j.Appenders.HttpLogAppender.httpSOTimeout=1000
rsremote.log4j.Appenders.HttpLogAppender.maxConnections=100
rsremote.log4j.Appenders.HttpLogAppender.templatesToEndpointsMapping=data-collector-template:/api/v1/data/collected,incident-events-template:/api/v1/data/incident/events
rsremote.log4j.Appenders.HttpLogAppender.threadCount=10
rsremote.log4j.Appenders.HttpLogAppender.PatternLayout.pattern=%m
rsremote.log4j.Appenders.HttpLogAppender.enabled=false
rsremote.log4j.Appenders.HttpLogAppender.sslEnabled=${RSREMOTE_SSL_ENABLED}
rsremote.log4j.Appenders.HttpLogAppender.sslVerify=${RSREMOTE_SSL_VERIFY}
rsremote.log4j.Appenders.HttpLogAppender.trustStore=${RSREMOTE_TRUSTSTORE_PATH}
rsremote.log4j.Appenders.HttpLogAppender.trustStorePassword=${RSREMOTE_TRUSTSTORE_PASSWORD}
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationInstance=${RSREMOTE_RSDATALOADER_URL}/login
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationUsername=rsremote
rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationPassword=
rsremote.esb.product=${rsmq.product}
rsremote.esb.brokeraddr=${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT}
rsremote.esb.username=${rsmq.username}
rsremote.esb.password=${rsmq.password}
rsremote.esb.domain=domain1
rsremote.esb.brokername=router1
rsremote.esb.mgmtaddr=
rsremote.esb.brokeraddr2=${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT}
rsremote.esb.createqueueretry=30
rsremote.esb.createqueuewait=10
rsremote.esb.keepalive=0
rsremote.esb.maxfailed=10
rsremote.esb.cachesize=500
rsremote.esb.flowcontrolstartqueuesize=400
rsremote.esb.maxmessages=-1
rsremote.esb.messagettl=1200000
rsremote.esb.vhost=${rsmq.vhost}
RSRemote Registration Configuration
rsremote.registration.parentguid=RSCONTROL
rsremote.registration.expiration=10080
rsremote.registration.discard=43200
rsremote.registration.interval=5
rsremote.registration.logheartbeat=true
RSRemote ID Configuration
rsremote.id.group=default
rsremote.id.description=RSREMOTE
rsremote.id.location=${LOCALHOST}
RSRemote Elasticsearch Configuration
rsremote.search.active=false
rsremote.search.serverlist=${rssearch.serverlist}
rsremote.search.shards=${rssearch.shards}
rsremote.search.replicas=${rssearch.replicas}
rsremote.search.indexthreads=${rssearch.indexthreads}
rsremote.search.indextimout=${rssearch.indextimout}
rsremote.search.indexretries=${rssearch.indexretries}
rsremote.search.serverport=${rssearch.yml.transport.tcp.port}
rsremote.search.cluster=${rssearch.yml.cluster.name}
rsremote.search.clienttype=${rssearch.clienttype}
rsremote.search.http=${rssearch.yml.http.enabled}
rsremote.search.httpport=${rssearch.yml.http.port}
rsremote.search.analytics=false
rsremote.search.embedded=false
rsremote.search.datadir=${DIST}/tmp/es
#TTL is in seconds, default is 3 months (60*60*24*30*3)
#ES removes system and rss posts based on this
rsremote.search.ttl=7776000
User that Owns RSRemote Installation
rsremote.run.R_USER=${resolve.user}
Additional java_option when RSRemote is Run
RSRemote Self Check
| Property Name | Description | Default Value |
|---|
| rsremote.selfcheck.ping.active | Set to 'true' to activate rsremote self check. | false |
| rsremote.selfcheck.ping.interval | The interval for self check of rsremote. | 300 |
| rsremote.selfcheck.ping.timeout | Period of time until a ping to the rsremote timesout. | 600 |
RSMgmt Settings
The following lists shows the logical groups of RSMgmt properties and their default values.
User that Owns RSMgmt Installation
rsmgmt.run.R_USER=${resolve.user}
Additional java_option when RSMgmt is Run
rsmgmt.general.home=${DIST}
rsmgmt.general.configfileversion=1.0
rsmgmt.general.configrevisions=2
rsmgmt.general.saveconfigonstart=truersmgmt.general.saveconfigonexit=true
rsmgmt.general.maxthread=100
rsmgmt.general.maxsystemthread=100
rsmgmt.general.timezone=
rsmgmt.general.threadkeepalive=30
RSMgmt Log4j
rsmgmt.log4j.Loggers.Root.level=WARN
rsmgmt.log4j.Loggers.Root.appender-ref.ref=RSMGMT
rsmgmt.log4j.Loggers.Logger.com.resolve.rsmgmt.level=${rsmgmt.log4j.loglevel}
rsmgmt.log4j.Loggers.Logger.com.resolve.update.level=INFO
rsmgmt.log4j.Loggers.Logger.com.resolve.update.additivity=false
rsmgmt.log4j.Loggers.Logger.com.resolve.update.appender-ref.ref=UPDATE
rsmgmt.log4j.Loggers.Logger.syslog.level=ERROR
rsmgmt.log4j.Loggers.Logger.syslog.additivity=false
rsmgmt.log4j.Appenders.RollingFile.RSMGMT.fileName=rsmgmt/log/rsmgmt.log
rsmgmt.log4j.Appenders.RollingFile.RSMGMT.filePattern=rsmgmt/log/$\${date:yyyy-MM}/rsmgmt-%d{MM-dd-yyyy}-%i.log.zip
rsmgmt.log4j.Appenders.RollingFile.RSMGMT.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rsmgmt.log4j.Appenders.RollingFile.RSMGMT.SizeBasedTriggeringPolicy.size=32MB
rsmgmt.log4j.Appenders.RollingFile.RSMGMT.DefaultRolloverStrategy.max=6
rsmgmt.log4j.Appenders.RollingFile.UPDATE.fileName=rsmgmt/log/update.log
rsmgmt.log4j.Appenders.RollingFile.UPDATE.filePattern=rsmgmt/log/$\${date:yyyy-MM}/update-%d{MM-dd-yyyy}-%i.log.zip
rsmgmt.log4j.Appenders.RollingFile.UPDATE.PatternLayout.pattern=%d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n
rsmgmt.log4j.Appenders.RollingFile.UPDATE.Policies.TimeBasedTriggeringPolicy.interval=1
rsmgmt.log4j.Appenders.RollingFile.UPDATE.Policies.TimeBasedTriggeringPolicy.modulate=true
(DEPRECATED) License Validation Configuration
rsmgmt.license.active=true
#License Master election interval in seconds
rsmgmt.license.election=30
rsmgmt.license.failover=90
RSMgmt config.xml
rsmgmt.esb.product=${rsmq.product}
rsmgmt.esb.brokeraddr=${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT}
rsmgmt.esb.username=${rsmq.username}
rsmgmt.esb.password=${rsmq.password}
rsmgmt.esb.domain=domain1
rsmgmt.esb.brokername=router1
rsmgmt.esb.mgmtaddr=
rsmgmt.esb.brokeraddr2=${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT}
rsmgmt.esb.createqueueretry=30
rsmgmt.esb.createqueuewait=10
rsmgmt.esb.keepalive=0
rsmgmt.esb.maxfailed=10
rsmgmt.esb.cachesize=500
rsmgmt.esb.flowcontrolstartqueuesize=400
rsmgmt.esb.maxmessages=-1
rsmgmt.esb.messagettl=1200000
RSMgmt Queue Name
rsmgmt.esb.queue.name.1=RSMGMT
RSMgmt Database Settings
rsmgmt.sql.active=true
rsmgmt.sql.dbtype=${DB_TYPE}
rsmgmt.sql.dbname=${DB_NAME}
rsmgmt.sql.host=${DB_HOST}
rsmgmt.sql.username=${DB_USERNAME}
rsmgmt.sql.password=${DB_PASSWORD}
rsmgmt.sql.url=${DB_URL}
(DEPRECATED) Metric configuration
rsmgmt.metric.queue=METRIC
rsmgmt.metric.active=${PRIMARY}
rsmgmt.metric.group.units.1=thread_count,mem_free
rsmgmt.metric.group.name.1=jvm
rsmgmt.metric.group.init.1=true
rsmgmt.metric.group.drop.1=false
rsmgmt.metric.group.type.1=default
rsmgmt.metric.group.units.2=aborted,completed,gcondition,bcondition,ucondition,gseverity,cseverity,wseverity,sseverity,useverity,duration
rsmgmt.metric.group.name.2=runbook
rsmgmt.metric.group.init.2=true
rsmgmt.metric.group.drop.2=false
rsmgmt.metric.group.type.2=default
rsmgmt.metric.group.units.3=transaction,latency
rsmgmt.metric.group.name.3=transaction
rsmgmt.metric.group.init.3=true
rsmgmt.metric.group.drop.3=false
rsmgmt.metric.group.type.3=default
rsmgmt.metric.group.units.4=active
rsmgmt.metric.group.name.4=users
rsmgmt.metric.group.init.4=true
rsmgmt.metric.group.drop.4=false
rsmgmt.metric.group.type.4=default
rsmgmt.metric.group.units.5=load1,load5,load15
rsmgmt.metric.group.name.5=server
rsmgmt.metric.group.init.5=true
rsmgmt.metric.group.drop.5=false
rsmgmt.metric.group.type.5=default
rsmgmt.metric.group.units.6=wiki,wikiresponsetime,social,socialresponsetime
rsmgmt.metric.group.name.6=latency
rsmgmt.metric.group.init.6=true
rsmgmt.metric.group.drop.6=false
rsmgmt.metric.group.type.6=default
rsmgmt.metric.group.units.7=free_space,size,percentage_used,response_time,query_count,percentage_wait
rsmgmt.metric.group.name.7=database
rsmgmt.metric.group.init.7=true
rsmgmt.metric.group.drop.7=false
rsmgmt.metric.group.type.7=default
rsmgmt.metric.group.units.8=status
rsmgmt.metric.group.name.8=cr
rsmgmt.metric.group.init.8=true
rsmgmt.metric.group.drop.8=false
rsmgmt.metric.group.type.8=default
rsmgmt.metric.group.units.9=node_cnt,tot_cnt,tot_time,status:string(20),dtnamespace:string(100)
rsmgmt.metric.group.name.9=dt
rsmgmt.metric.group.init.9=true
rsmgmt.metric.group.drop.9=false
rsmgmt.metric.group.type.9=decisiontree
rsmgmt.metric.group.units.10=endUsers,adminUsers
rsmgmt.metric.group.name.10=licensedusers
rsmgmt.metric.group.init.10=true
rsmgmt.metric.group.drop.10=false
rsmgmt.metric.group.type.10=default
(DEPRECATED) RSMgmt Settings to Alert on FATAL Errors
rsmgmt.alert.active=true
rsmgmt.alert.snmp.active=false
rsmgmt.alert.snmp.community=public
rsmgmt.alert.snmp.traphost=127.0.0.1
rsmgmt.alert.snmp.trapport=162
rsmgmt.alert.dblog.active=${rsmgmt.sql.active}
rsmgmt.alert.gateway.active=true
rsmgmt.alert.email.active=false
#Email subject in the form "Resolve alert message: $MESSAGE with Severity $SEVERITY."
#where #$MESSAGE and $SEVERITY will be replaced with actual message and severity.
#There are $CODE and $COMPONENT parameters as well and all parameters are optional.
rsmgmt.alert.email.subject=Resolve Alert
rsmgmt.alert.email.body=Severity: $SEVERITY, Component: $COMPONENT, Type: $CODE, Message: $MESSAGE.
rsmgmt.alert.email.to=
rsmgmt.alert.email.cc=
rsmgmt.alert.email.bcc=
RSMgmt Local Monitor Settings
rsmgmt.monitor.local.active=true
rsmgmt.monitor.local.interval=300
rsmgmt.monitor.local.restart=false
rsmgmt.monitor.db.active=true
rsmgmt.monitor.db.interval=300
rsmgmt.monitor.db.timeout=5
rsmgmt.monitor.esb.active=true
rsmgmt.monitor.esb.interval=300
rsmgmt.monitor.stdout.active=true
rsmgmt.monitor.stdout.interval=60
rsmgmt.monitor.stdout.file=stdoutMonitor.txt
RSMgmt registration configuration
rsmgmt.registration.parentguid=RSCONTROL
rsmgmt.registration.expiration=10080
rsmgmt.registration.discard=43200
rsmgmt.registration.interval=5
rsmgmt.registration.logheartbeat=true
RSMgmt Registration Configuration
rsmgmt.registration.parentguid=RSCONTROL
rsmgmt.registration.expiration=10080
rsmgmt.registration.discard=43200
rsmgmt.registration.interval=5
rsmgmt.registration.logheartbeat=true
RSMgmt Registration Configuration
rsmgmt.registration.parentguid=RSCONTROL
rsmgmt.registration.expiration=10080
rsmgmt.registration.discard=43200
rsmgmt.registration.interval=5
rsmgmt.registration.logheartbeat=true
RSMgmt Elasticsearch Configuration
rsmgmt.search.active=false
rsmgmt.search.serverlist=${rssearch.serverlist}
rsmgmt.search.shards=${rssearch.shards}
rsmgmt.search.replicas=${rssearch.replicas}
rsmgmt.search.indexthreads=${rssearch.indexthreads}
rsmgmt.search.indextimout=${rssearch.indextimout}
rsmgmt.search.indexretries=${rssearch.indexretries}
rsmgmt.search.serverport=${rssearch.yml.transport.tcp.port}
rsmgmt.search.cluster=${rssearch.yml.cluster.name}
rsmgmt.search.clienttype=${rssearch.clienttype}
rsmgmt.search.http=${rssearch.yml.http.enabled}
rsmgmt.search.httpport=${rssearch.yml.http.port}
rsmgmt.search.analytics=false
rsmgmt.search.embedded=false
rsmgmt.search.datadir=${DIST}/tmp/es
#TTL is in seconds, default is 3 months (60*60*24*30*3)
#ES removes system and rss posts based on this
rsmgmt.search.ttl=7776000
RSMgmt ID Configuration
rsmgmt.id.group=default
rsmgmt.id.description=RSMGMT
rsmgmt.id.location=${LOCALHOST}
MCP Web Service Configuration
rsmgmt.restwebservice.active=true
rsmgmt.restwebservice.username=resolve
rsmgmt.restwebservice.password=resolve
rsmgmt.restwebservice.httpport=8082
rsmgmt.restwebservice.httpsport=8083
rsmgmt.restwebservice.ssl=true
rsmgmt.restwebservice.keystore=${DIST}/rsmgmt/config/restcerts.jks
rsmgmt.restwebservice.keystorepassword=changeit
rsmgmt.restwebservice.keypassword=changeit
MCP Configuration
rsmgmt.mcp.active=true
#when component status is asked, wait for these many
#seconds to give up
rsmgmt.mcp.statusrequestexpiration=60
ESB Configuration
rsmgmt.esb.vhost=${rsmq.vhost}
Optional Settings
The following settings are optional to the configuration. These settings can be used to configure the resources available to the different components installed on this server.
| Property Name | Description | Default Value |
|---|
| resolve.user | Linux user that Actions Pro will run under. | resolve |
| rsremote.run.Xms | RSRemote minimum memory allocated. | 256MB |
| rsremote.run.Xmx | RSRemote maximum memory allocated. | 512MB |
| rsremote.esb.queue.name.1 | Queue name that RSRemote will listen to. | RSREMOTE |
| rsremote.run.externalclasspaths | Used if there is a jar that is needed to be added for an actiontask in RSRemote. | |
| rsremote.run.ld_library_path | Used if there is a .so is needed for an actiontask in RSRemote. | |
| rsmgmt.run.Xms | RSMgmt minimum memory allocated. | 64MB |
| rsmgmt.run.Xmx | RSMgmt maximum memory allocated. | 512MB |
RSRemote Queue Names
Each RSRemote will, by default, listen to the RSREMOTE queue (rsremote.esb.queue.name.1) for executing task content.
Additional queues can be added to target specific RSRemotes with tasks by:
- Copying the rsremote.esb.queue.name.1 property and changing the value and number (e.g. rsremote.esb.queue.name.2=WINDOWS)
- Configuring gateways (Blueprint File - Gateways).
- Optionally, the value rsremote.esb.queue.name.1 can also be removed so the RSRemote will only listen to queues that are added automatically by gateways.
Multiple RSRemote queues can be added by:
- Copying the rsremote.esb.queue.name.1.
- Incrementing the number (e.g. rsremote.esb.queue.name.2=NEWQUEUE).
This can be useful if the RSRemote needs to be targeted by specific tasks. Alternatively, all queues can be removed if the RSRemote should only perform gateway functions.
Authenticate via RSRemote
Actions Pro can have more than one RSRemote for the authentication to more than one LDAP/Active Directory. Follow these steps:
- Set the "userauth" to true for user authentication uses.
- Review LDAP configuration and Active Directory configuration under the User Administration main menu.
- Set the active flag to true to enable the LDAP for RSRemote.
rsremote.receive.ldap.active=true
rsremote.receive.ldap.queue=LDAP
# if userauth=true this gateway may be used for Actions Pro
# user authentication
rsremote.receive.ldap.userauth=true
rсemote.receive.ad.active=true
rsremote.receive.ad.queue=AD
# if userauth=true this gateway may be used for Actions Pro
# user authentication
rsremote.receive.ad.userauth=true
Encrypted Password Fields
Any field that is a password field is automatically encrypted after running the config.sh/bat file to apply the blueprint.properties file. The following syntax can be used to either force or skip encryption of properties in the Blueprint file:
#NO_ENC—Leaves the password field unencrypted, for example, DB_PASSWORD=NO_ENC:resolve#TO_ENC—Specifies a value that needs to be encrypted after running config.sh/config.bat; for example, rsmq.username=TO_ENC:resolve
Reserved and Reference Variables
The following variables are reserved within Actions Pro and provide the values shown below. These variables cannot be set by the user or used as user-defined values.
LOG—Log object used to append to RSControl logREFERENCE—External System Reference, for example, Netcool ServerName:ServerSerial:SerialPARAMS—PARAM parameter mapFLOWS—FLOW parameter mapINPUTS—INPUT parameter mapPROBLEMID—Worksheet IDWIKI—Name of Runbook wiki document pageSESSIONS—Object used to persist a connection in a Runbook
Advanced RSRemote Blueprint Properties
RSRemote Instance
| Property Name | Description | Default Value |
|---|
| rsremote.instance.count | Number of rsremote instances | 1 |
RSRemote Instance1
| Property Name | Description | Default Value |
|---|
| rsremote.instance1.name | Name of the rsremote instance one | rsremote |
RSRemote General
| Property Name | Description | Default Value |
|---|
| rsremote.general.home | Home directory of the rsremote component. | ${DIST} |
| rsremote.general.clustername | Name of the Actions Pro cluster. | ${CLUSTERNAME} |
| rsremote.general.cluster | Set to 'true' to enable clustering in rsremote. | false |
| rsremote.general.configfileversion | Default version of the rsremote config.xml. | 1.0 |
| rsremote.general.configrevisions | Number of backup to keep of the config.xml. | 2 |
| rsremote.general.saveconfigonstart | Save the config.xml on startup. | true |
| rsremote.general.saveconfigonexit | Save the config.xml on exit. | true |
| rsremote.general.cronoffset | Period of time to offset cron jobs. | 0 |
| rsremote.general.maxthread | Maximum number of threads rsremote can have active at one time. | 500 |
| rsremote.general.maxsystemthread | Maximum number of system threads rsremote can have active. | 500 |
| rsremote.general.timezone | RSRemote's timezone. | |
| rsremote.general.threadkeepalive | If the number of threads is greater than the core, this is the maximum timethat excess idle threads will wait for new tasks before terminating. | 30 |
| rsremote.general.perfdebug | Set to 'true' to enable performance debugging. | false |
| rsremote.general.mcpmode | The mcp mode of the rsremote component. | ${MCPMODE} |
RSRemote Log4j
| Property Name | Description | Default Value |
|---|
| rsremote.log4j.Loggers.Root.level | Defines common log level. | WARN |
| rsremote.log4j.Loggers.Root.appender-ref.ref | | RSREMOTE,amqp |
| rsremote.log4j.Loggers.Logger.com.resolve.rsremote.level | | ${rsremote.log4j.loglevel} |
| rsremote.log4j.Loggers.Logger.com.resolve.dcs.httplogappender.level | | INFO |
| rsremote.log4j.Loggers.Logger.DCS.level | | INFO |
| rsremote.log4j.Loggers.Logger.DCS.appender-ref.ref | | DCS |
| rsremote.log4j.Loggers.Logger.syslog.level | | ERROR |
| rsremote.log4j.Loggers.Logger.syslog.additivity | | false |
| rsremote.log4j.Appenders.RollingFile.name | | REMOTE |
| rsremote.log4j.Appenders.RollingFile.fileName | | rsremote/log/rsremote.log |
| rsremote.log4j.Appenders.RollingFile.filePattern | | rsremote/log/$\${date:yyyy-MM}/rsremote-%d{MM-dd-yyyy}-%i.log.zip |
| rsremote.log4j.Appenders.RollingFile.PatternLayout.pattern | | %d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n |
| rsremote.log4j.Appenders.RollingFile.SizeBasedTriggeringPolicy.size | | 32MB |
| rsremote.log4j.Appenders.RollingFile.DefaultRolloverStrategy.max | | 6 |
| rsremote.log4j.Appenders.AmqpAppender.name | | amqp |
| rsremote.log4j.Appenders.AmqpAppender.threshold | | WARN |
| rsremote.log4j.Appenders.AmqpAppender.PatternLayout.pattern | | %d{ISO8601}{GMT+0} %5p [%t] %X{context} %X{filter} (%F:%L) - %m%n |
| rsremote.log4j.Appenders.HttpLogAppender.name | | DCS |
| rsremote.log4j.Appenders.HttpLogAppender.charset | | utf-8 |
| rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationInstance | | |
| rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationUsername | | |
| rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationPassword | | |
| rsremote.log4j.Appenders.HttpLogAppender.hostAddresses | | ${RSREMOTE_RSDATALOADER_URL} |
| rsremote.log4j.Appenders.HttpLogAppender.httpConnectionTimeout | | 5000 |
| rsremote.log4j.Appenders.HttpLogAppender.httpSOTimeout | | 1000 |
| rsremote.log4j.Appenders.HttpLogAppender.maxConnections | | 100 |
| rsremote.log4j.Appenders.HttpLogAppender.templatesToEndpointsMapping | | data-collector-template:/api/v1/data/collected,incident-events-template:/api/v1/data/incident/events |
| rsremote.log4j.Appenders.HttpLogAppender.threadCount | | 10 |
| rsremote.log4j.Appenders.HttpLogAppender.PatternLayout.pattern | | %m |
| rsremote.log4j.Appenders.HttpLogAppender.enabled | | false |
| rsremote.log4j.Appenders.HttpLogAppender.sslEnabled | | ${RSREMOTE_SSL_ENABLED} |
| rsremote.log4j.Appenders.HttpLogAppender.sslVerify | | ${RSREMOTE_SSL_VERIFY} |
| rsremote.log4j.Appenders.HttpLogAppender.trustStore | | ${RSREMOTE_TRUSTSTORE_PATH} |
| rsremote.log4j.Appenders.HttpLogAppender.trustStorePassword | | ${RSREMOTE_TRUSTSTORE_PASSWORD} |
| rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationInstance | | ${RSREMOTE_RSDATALOADER_URL}/login |
| rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationUsername | | rsremote |
| rsremote.log4j.Appenders.HttpLogAppender.dcsAuthenticationPassword | | Resolve1 |
RSRemote ESB
| Property Name | Description | Default Value |
|---|
| rsremote.esb.product | Product used for the rsremote esb. | ${rsmq.product} |
| rsremote.esb.brokeraddr | Address and port used for messaging. | ${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT} |
| rsremote.esb.username | Username used to connect to the esb product. | ${rsmq.username} |
| rsremote.esb.password | Password used to connect to the esb product. | ${rsmq.password} |
| rsremote.esb.domain | deprecated | domain1 |
| rsremote.esb.brokername | deprecated | router1 |
| rsremote.esb.mgmtaddr | deprecated | |
| rsremote.esb.brokeraddr2 | Backup address and port used for messaging. | ${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT} |
| rsremote.esb.createqueueretry | Period of time to retry creating a queue. | 30 |
| rsremote.esb.createqueuewait | Period of time to wait before creating a queue. | 10 |
| rsremote.esb.keepalive | After how long time to send a keep alive message. | 0 |
| rsremote.esb.maxfailed | Maximum amount of failed messaged allowed. | 10 |
| rsremote.esb.cachesize | Maximum number of messages that can be cached. | 500 |
| rsremote.esb.flowcontrolstartqueuesize | Maximum number of messages allowed before flow control starts. | 400 |
| rsremote.esb.maxmessages | Maximum number of messages allowed -1 means unlimited. | 1 |
| rsremote.esb.messagettl | The message time to live. | 600000 |
| rsremote.esb.sslprotocol | The ssl protocol used must be atleast TLSv1.1. | TLSv1.2 |
| rsremote.esb.vhost | | ${rsmq.vhost} |
RSRemote Registration
| Property Name | Description | Default Value |
|---|
| rsremote.registration.parentguid | Guid of rsremotes parent component. | RSCONTROL |
| rsremote.registration.expiration | Period of time until component registration expires. | 10080 |
| rsremote.registration.discard | Period of time to wait until an expired registation is discarded. | 43200 |
| rsremote.registration.interval | Interval in minutes for sending of heartbeats. | 5 |
| rsremote.registration.logheartbeat | The log each heartbeat sent. | true |
RSRemote Search
| Property Name | Description | Default Value |
|---|
| rsremote.search.active | Set to 'true' to activate use of elasticsearch in rsremote. | false |
| rsremote.search.serverlist | List of each elasticsearch node. | ${rssearch.serverlist} |
| rsremote.search.shards | Number of shards in each index. | ${rssearch.shards} |
| rsremote.search.replicas | Number of replicas kept by elasticsearch. | ${rssearch.replicas} |
| rsremote.search.indexthreads | deprecated | ${rssearch.indexthreads} |
| rsremote.search.indextimout | Period of time it takes for a request to an index takes to timeout. | ${rssearch.indextimout} |
| rsremote.search.indexretries | Period of times to retry a request to an index. | ${rssearch.indexretries} |
| rsremote.search.serverport | Port used by elasticsearch. | ${rssearch.yml.transport.tcp.port} |
| rsremote.search.cluster | Name of the elasticsearch cluster. | ${rssearch.yml.cluster.name} |
| rsremote.search.clienttype | Set whether clients should be node or transport. | ${rssearch.clienttype} |
| rsremote.search.http | Set to 'true' to enable http in elasticsearch. | ${rssearch.yml.http.enabled} |
| rsremote.search.httpport | Port elasticsearch uses for http calls. | ${rssearch.yml.http.port} |
| rsremote.search.ttl | Period of time for an index to live. | ${search.ttl} |
RSRemote ID
| Property Name | Description | Default Value |
|---|
| rsremote.id.group | Name of the Actions Pro cluster. | ${CLUSTERNAME} |
| rsremote.id.description | Description of the rsremote component. | RSREMOTE |
| rsremote.id.location | Address of the rsremote. | ${LOCALHOST} |
RSRemote Run
| Property Name | Description | Default Value |
|---|
| rsremote.run.R_USER | User to run rsremote. | ${resolve.user} |
| rsremote.run.java_opts | Extra java options used when running rsremote. | |
| rsremote.run.terminatetimeout | Period of time before a run is timedout and terminated. | 600 |
RSremote ESAPI Access Control
| Property Name | Default Value |
|---|
| rsremote.ESAPI.AccessControl | Class used for access control. |
RSremote ESAPI Authentication
| Property Name | Default Value |
|---|
| rsremote.ESAPI.Authenticator | Class used for ESAPI authenticator. |
| rsremote.ESAPI.Authenticator.AllowedLoginAttempts | Maximum allowed login attemps. |
| rsremote.ESAPI.Authenticator.MaxOldPasswordHashes | Maximum amount of old password hashes allowed. |
| rsremote.ESAPI.Authenticator.UsernameParameterName | Parameter name for the username in the ESAPI authenticator. |
| rsremote.ESAPI.Authenticator.PasswordParameterName | Parameter name for the password in the ESAPI authenticator. |
| rsremote.ESAPI.Authenticator.RememberTokenDuration | Period of time to remember an authentication token. |
| rsremote.ESAPI.Authenticator.IdleTimeoutDuration | Period of time a user can be idle before time out. |
| rsremote.ESAPI.Authenticator.AbsoluteTimeoutDuration | Period of time until a token is times out. |
RSremote ESAPI Encoder
| Property Name | Default Value |
|---|
| rsremote.ESAPI.Encoder | Class used for encoding. |
| rsremote.ESAPI.Encoder.AllowMultipleEncoding | Set to 'true' to allow multiple encoding. |
| rsremote.ESAPI.Encoder.DefaultCodecList | List of encoders used by default. |
RSremote ESAPI Encryptor
| Property Name | Default Value |
|---|
| rsremote.ESAPI.Encryptor.PreferredJCEProvider | Preferred JCEProvider. |
| rsremote.ESAPI.Encryptor.EncryptionAlgorithm | Encryption algorithmn used. |
| rsremote.ESAPI.Encryptor.CipherTransformation | Cipher transformation used to encrypt. |
| rsremote.ESAPI.Encryptor.cipher_modes.combined_modes | Modes that support confidentiality and authenticity. |
| rsremote.ESAPI.Encryptor.cipher_modes.additional_allowed | Ciphers allowed in addition to the ones in combined_modes. |
| rsremote.ESAPI.Encryptor.EncryptionKeyLength | The number of bits in a key used by a cryptographic algorithm. |
| rsremote.ESAPI.Encryptor | Class used for encryption. |
| rsremote.ESAPI.Encryptor.ChooseIVMethod | Method of generating initialization vector. |
| rsremote.ESAPI.Encryptor.fixedIV | Initialization vector to use if fixed IV method is chosen. |
| rsremote.ESAPI.Encryptor.CipherText.useMAC | If 'true' compute and store the MAC. |
| rsremote.ESAPI.Encryptor.PlainText.overwrite | First overwrite the bytes of plaintext with the character. |
| rsremote.ESAPI.Encryptor.HashAlgorithm | Algorithm used to generate the encryption hash. |
| rsremote.ESAPI.Encryptor.HashIterations | Number of steps to take when hashing. |
| rsremote.ESAPI.Encryptor.DigitalSignatureAlgorithm | Algorithm used to generate a digital signature. |
| rsremote.ESAPI.Encryptor.DigitalSignatureKeyLength | The number of bits in a key used by a cryptographic algorithm. |
| rsremote.ESAPI.Encryptor.RandomAlgorithm | Algorithm used to generate a random number. |
| rsremote.ESAPI.Encryptor.CharacterEncoding | Character encoding used. |
| rsremote.ESAPI.Encryptor.KDF.PRF | Psuedo random function used in KDF. |
Advanced RSMgmt Blueprint Properties
RSMgmt Run
| Property Name | Description | Default Value |
|---|
| rsmgmt.run.R_USER | The name of the user to run the RSMgmt component. | ${resolve.user} |
| rsmgmt.run.java_opts | Java options used when starting up the component. | |
| rsmgmt.run.terminatetimeout | Period of time before a run is timed out and terminated. | 30 |
RSMgmt General
| Property Name | Description | Default Value |
|---|
| rsmgmt.general.home | Home directory of the RSMgmt component. | ${DIST} |
| rsmgmt.general.clustername | Name of the Actions Pro cluster. | ${CLUSTERNAME} |
| rsmgmt.general.configfileversion | Default version of the config.xml. | 1.0 |
| rsmgmt.general.configrevisions | Numberof backup config.xmls to keep. | 2 |
| rsmgmt.general.saveconfigonstart | Set to 'true' to save config.xml on start. | true |
| rsmgmt.general.saveconfigonexit | Set to 'true' to save config on exit. | true |
| rsmgmt.general.maxthread | Maximum number of active threads RSMgmt can have up. | 100 |
| rsmgmt.general.maxsystemthread | Maximum number of system threads RSMgmt can use. | 100 |
| rsmgmt.general.timezone | Time zone of the RSMgmt component. | |
| rsmgmt.general.threadkeepalive | If the number of threads is greater than the core, this is the maximum timethat excess idle threads will wait for new tasks before terminating. | 30 |
| rsmgmt.general.perfdebug | Set to 'true' to enable performance debugging. | false |
| rsmgmt.general.mcpmode | The mcp mode of the RSMgmt component. | ${MCPMODE} |
RSMgmt Log4
| Property Name | Description | Default Value |
|---|
| rsmgmt.log4j.Loggers.Root.level | Defines common log level. | WARN |
| rsmgmt.log4j.Loggers.Root.appender-ref.ref | | RSMGMT |
| rsmgmt.log4j.Loggers.Logger.com.resolve.rsmgmt.level | | {rsmgmt.log4j.loglevel} |
| rsmgmt.log4j.Loggers.Logger.com.resolve.update.level | | INFO |
| rsmgmt.log4j.Loggers.Logger.com.resolve.update.additivity | | false |
| rsmgmt.log4j.Loggers.Logger.com.resolve.update.appender-ref.ref | | UPDATE |
| rsmgmt.log4j.Loggers.Logger.syslog.level | | ERROR |
| rsmgmt.log4j.Loggers.Logger.syslog.additivity | | false |
| rsmgmt.log4j.Appenders.RollingFile.RSMGMT.fileName | | rsmgmt.log4j.Appenders.RollingFile.RSMGMT.fileName |
| rsmgmt.log4j.Appenders.RollingFile.RSMGMT.filePattern | | rsmgmt/log/$\\${date:yyyy-MM}/rsmgmt-%d{MM-dd-yyyy}-%i.log.zip |
| rsmgmt.log4j.Appenders.RollingFile.RSMGMT.PatternLayout.pattern | | %d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n |
| rsmgmt.log4j.Appenders.RollingFile.RSMGMT.SizeBasedTriggeringPolicy.size | | 32MB |
| rsmgmt.log4j.Appenders.RollingFile.RSMGMT.DefaultRolloverStrategy.max | | 6 |
| rsmgmt.log4j.Appenders.RollingFile.UPDATE.fileName | | rsmgmt/log/update.log |
| rsmgmt.log4j.Appenders.RollingFile.UPDATE.filePattern | | rsmgmt/log/$\\${date:yyyy-MM}/update-%d{MM-dd-yyyy}-%i.log.zip |
| rsmgmt.log4j.Appenders.RollingFile.UPDATE.PatternLayout.pattern | | %d{ISO8601}{GMT+0} %5p [%t] (%F:%L) - %m%n |
| rsmgmt.log4j.Appenders.RollingFile.UPDATE.Policies.TimeBasedTriggeringPolicy.interval | | 1 |
| rsmgmt.log4j.Appenders.RollingFile.UPDATE.Policies.TimeBasedTriggeringPolicy.modulate | | true |
RSMgmt ESB
| Property Name | Description | Default Value |
|---|
| rsmgmt.esb.product | Name of the messaging application used, do not change unless advised by support. | ${rsmq.product} |
| rsmgmt.esb.brokeraddr | Address used by the rabbitmq broker in the host:port format. | ${RSMQ_EXTERNAL_PRIMARY_HOST}:${RSMQ_EXTERNAL_PRIMARY_PORT} |
| rsmgmt.esb.username | Username for the rsmq client. | ${rsmq.username} |
| rsmgmt.esb.password | Password for the given rsmq username. | ${rsmq.password} |
| rsmgmt.esb.domain | deprecated* | domain1 |
| rsmgmt.esb.brokername | deprecated* | router1 |
| rsmgmt.esb.mgmtaddr | deprecated* | |
| rsmgmt.esb.brokeraddr2 | Address of the rabbitmq backup broker in the host:port format | ${RSMQ_EXTERNAL_BACKUP_HOST}:${RSMQ_EXTERNAL_BACKUP_PORT} |
| rsmgmt.esb.createqueueretry | Period of time before retrying to create a queue. | 30 |
| rsmgmt.esb.createqueuewait | Period of time to wait before creating a queue. | 10 |
| rsmgmt.esb.keepalive | After how long time to send a keep alive message. | 0 |
| rsmgmt.esb.maxfailed | Maximum number of failed messages allowed. | 10 |
| rsmgmt.esb.cachesize | Maximum number of messages cached. | 500 |
| rsmgmt.esb.flowcontrolstartqueuesize | Number of messages allowed before flow control activates. | 400 |
| rsmgmt.esb.maxmessages | Maximum number of messages store, a value of -1 means unlimited messages. | 1 |
| rsmgmt.esb.messagettl | Period of time for a message to live in milliseconds. | 600000 |
| rsmgmt.esb.sslprotocol | Name of the encryption protocol used by rabbitmq, needs to be atleast TLSv1.1 | TLSv1.2 |
| rsmgmt.esb.queue.name.1 | Queue name for the RSMgmt component. | RSMGMT |
| rsmgmt.esb.vhost | | ${rsmq.vhost |
RSMgmt SQL
| Property Name | Property Name | Description |
|---|
| rsmgmt.sql.active | Set to 'true' to activate the database for this component. | true |
| rsmgmt.sql.dbtype | The type of database Actions Pro is connected to. | ${DB_TYPE} |
| rsmgmt.sql.dbname | Name of the database RSMgmt will connect to. | ${DB_NAME} |
| rsmgmt.sql.host | Address of the database RSMgmt is connecting to. | ${DB_HOST} |
| rsmgmt.sql.username | Username used to connect to the database. | ${DB_USERNAME} |
| rsmgmt.sql.password | Password used to connect to the database. | ${DB_PASSWORD} |
| rsmgmt.sql.url | The url of the database. | ${DB_URL} |
| rsmgmt.sql.perfdebug | Set to 'true' to enable performace debugging. | false |
RSMgmt Monitor
| Property Name | Description | Default Value |
|---|
| rsmgmt.monitor.local.active | Whether to monitor the local components for UP/DOWN/HANGING status. | true |
| rsmgmt.monitor.local.interval | How often to check on the local components (in seconds) | 300 |
| rsmgmt.monitor.local.restart | Whether to restart the local components if a HANGING (unexpectedly DOWN) status is detected | false |
| rsmgmt.monitor.db.active | Whether to monitor the connection to the Actions Pro database for unavailable or slow connections. | true |
| rsmgmt.monitor.db.interval | How often to check the database connectivity (in seconds) | 300 |
| rsmgmt.monitor.db.timeout | How long the test query has to take before alerting on a slow connection (in seconds). | 5 |
| rsmgmt.monitor.esb.active | Whether to monitor the AMQP connectivity for unavailable or undelivered messages | true |
| rsmgmt.monitor.esb.interval | How often to check the AMQP connectivity in seconds. | 300 |
| rsmgmt.monitor.stdout.active | Whether to monitor the local connections stdout files (catalina.out for RSView). | true |
| rsmgmt.monitor.stdout.interval | How often to check the stdout files for error messages in seconds. | 60 |
| rsmgmt.monitor.stdout.file | A file containing the messages that, if in the stdout files, will trigger an alert | stdoutMonitor.txt |
| rsmgmt.monitor.rsremote.interval | How often to send AMQP messages to the local RSRemote(s) to check if they are busy. | 300 |
| rsmgmt.monitor.rsremote.timeout | How long without a response from the RSRemote before its status is set to inactive, in seconds. | 60 |
| rsmgmt.monitor.diskspace.active | Set to 'true' to activate monitoring of diskspace. | true |
| rsmgmt.monitor.diskspace.interval | Interval between checking of the available diskspace. | 300 |
| rsmgmt.monitor.ping.rsremote | Set to 'true' to enable pinging of rsremote. | false |
| rsmgmt.monitor.ping.rscontrol | Set to 'true' to enable pinging of rscontrol. | false |
| rsmgmt.monitor.ping.rsview | Set to 'true' to enable pinging of RSView. | false |
| rsmgmt.monitor.ping.interval | Interval between pinging of other components. | 300 |
| rsmgmt.monitor.ping.threshold | Period of time until a ping to other components to timeout. | 5 |
| rsmgmt.monitor.es.active | Set to 'true' to activate monitoring of Elasticsearch. | false |
| rsmgmt.monitor.esb.interval | Interval between checks to Elasticsearch. | 300 |
| rsmgmt.monitor.es.osmemthresholdprcnt | Elasticsearch maximum ram threshold. | 80 |
| rsmgmt.monitor.es.fsmemthresholdprcnt | Elasticsearch maximum hard disk threshold. | 80 |
| rsmgmt.monitor.es.jvmheapthresholdprcnt | Elasticsearch maximum java virtual memory threshold. | 80 |
| rsmgmt.monitor.es.gcfreqthresholdpersec | Time in between consecutive garbage collection on old objects. | 10 |
| rsmgmt.monitor.http.active | Set to 'true' to activate monitoring of http. | false |
| rsmgmt.monitor.http.interval | Interval between http checks. | 300 |
| rsmgmt.monitor.dbtps.active | Set to 'true' to activate checking of database TPS. | false |
| rsmgmt.monitor.dbtps.interval | Interval between checking of database TPS. | 60 |
| rsmgmt.monitor.dbtps.threshold | Maximum transactions per second allowed. | 50 |
RSMgmt Registration
| Property Name | Description | Default Value |
|---|
| rsmgmt.registration.parentguid | Guide of parent. | RSCONTROL |
| rsmgmt.registration.expiration | Period of time until component registration expires. | 10080 |
| rsmgmt.registration.discard | Period of time after registration until a registration is discarded. | 43200 |
| rsmgmt.registration.interval | Interval between registration checks. | 5 |
| rsmgmt.registration.logheartbeat | Log heartbeat. | true |
RSMgmt Search
| Property Name | Description | Default Value |
|---|
| rsmgmt.search.active | Set to 'true' to give rsmgmt access to Elasticsearch. | true |
| rsmgmt.search.serverlist | List of Elasticsearch nodes. | ${rssearch.serverlist} |
| rsmgmt.search.shards | Number of shards per index in Elasticsearch. | ${rssearch.shards} |
| rsmgmt.search.replicas | Number of Elasticsearch replicas. | ${rssearch.replicas} |
| rsmgmt.search.indexthreads | deprecated* | ${rssearch.indexthreads} |
| rsmgmt.search.indextimout | Period of time it takes for a request to in index times out. | ${rssearch.indextimout} |
| rsmgmt.search.indexretries | Period of time to retry making a request to an index | ${rssearch.indexretries} |
| rsmgmt.search.serverport | Port that Elasticsearch uses. | ${rssearch.yml.transport.tcp.port} |
| rsmgmt.search.cluster | Name of the Elasticsearch cluster. | ${rssearch.yml.cluster.name} |
| rsmgmt.search.clienttype | Set whether clients should be node or transport. | ${rssearch.clienttype} |
| rsmgmt.search.http | Set to 'true' to enable http. | ${rssearch.yml.http.enabled} |
| rsmgmt.search.httpport | Port Elasticsearch uses for http. | ${rssearch.yml.http.port} |
| rsmgmt.search.ttl | Period of time for an index to live. | ${search.ttl} |
| rsmgmt.id.group | Name of the Actions Pro cluster. | ${CLUSTERNAME} |
| rsmgmt.id.description | Description of this component. | RSMGMT |
| rsmgmt.id.location | Address of this component. | ${LOCALHOST} |
RSMgmt Restwebservice
| Property Name | Description | Default Value |
|---|
| rsmgmt.restwebservice.active | Set to 'true' to activate restwebservice. | false |
| rsmgmt.restwebservice.username | Username used to connect to the restwebservice. | resolve |
| rsmgmt.restwebservice.password | Password used to connect to the restwebservice. | resolve |
| rsmgmt.restwebservice.httpport | Port used by the restwebservice for http. | 8082 |
| rsmgmt.restwebservice.httpsport | Port used by the restwebservice for https. | 8083 |
| rsmgmt.restwebservice.ssl | Set to 'true' to use ssl with the restwebservice. | true |
| rsmgmt.restwebservice.keystore | Path to the keystorefile. | ${DIST}/rsmgmt/config/restcerts.jks |
| rsmgmt.restwebservice.keystorepassword | Password needed to use the keystore. | changeit |
| rsmgmt.restwebservice.keypassword | Password used by the key. | changeit |
RSMgmt MCP
| Property Name | Description | Default Value |
|---|
| rsmgmt.mcp.registration.enabled | Set to 'true' to enable mcp registration. | false |
| rsmgmt.mcp.registration.password | Password used for mcp registration. | |
| rsmgmt.mcp.registration.port | Port used for mcp registration. | |
| rsmgmt.mcp.registration.protocol | Protocol used with mcp registration. | |
| rsmgmt.mcp.registration.username | Username user for mcp registration. | |
| rsmgmt.mcp.registration.uri | The Uri used when registering with mcp. | |
RSmgmt ESAPI AccessControl
| Property Name | Default Value |
|---|
| rsmgmt.ESAPI.AccessControl | Class used for access control. |
RSmgmt ESAPI Authentification
| Property Name | Default Value |
|---|
| rsmgmt.ESAPI.Authenticator | Class used for ESAPI authenticator. |
| rsmgmt.ESAPI.Authenticator.AllowedLoginAttempts | Maximum allowed login attemps. |
| rsmgmt.ESAPI.Authenticator.MaxOldPasswordHashes | Maximum amount of old password hashes allowed. |
| rsmgmt.ESAPI.Authenticator.UsernameParameterName | Parameter name for the username in the ESAPI authenticator. |
| rsmgmt.ESAPI.Authenticator.PasswordParameterName | Parameter name for the password in the ESAPI authenticator. |
| rsmgmt.ESAPI.Authenticator.RememberTokenDuration | Period of time to remember an authentication token. |
| rsmgmt.ESAPI.Authenticator.IdleTimeoutDuration | Period of time a user can be idle before time out. |
| rsmgmt.ESAPI.Authenticator.AbsoluteTimeoutDuration | Period of time until a token times out |
RSmgmt ESAPI Encoder
| Property Name | Default Value |
|---|
| rsmgmt.ESAPI.Encoder | Class used for encoding. |
| rsmgmt.ESAPI.Encoder.AllowMultipleEncoding | Set to 'true' to allow multiple encoding. |
| rsmgmt.ESAPI.Encoder.DefaultCodecList | List of encoders used by default. |
RSmgmt ESAPI Encryptor
| Property Name | Default Value |
|---|
| rsmgmt.ESAPI.Encryptor.PreferredJCEProvider | Preferred JCEProvider. |
| rsmgmt.ESAPI.Encryptor.EncryptionAlgorithm | Encryption algorithmn used. |
| rsmgmt.ESAPI.Encryptor.CipherTransformation | Cipher transformation used to encrypt. |
| rsmgmt.ESAPI.Encryptor.cipher_modes.combined_modes | Modes that support confidentiality and authenticity. |
| rsmgmt.ESAPI.Encryptor.cipher_modes.additional_allowed | Ciphers allowed in addition to the ones in combined_modes. |
| rsmgmt.ESAPI.Encryptor.EncryptionKeyLength | The number of bits in a key used by a cryptographic algorithm. |
| rsmgmt.ESAPI.Encryptor | Class used for encryption. |
| rsmgmt.ESAPI.Encryptor.ChooseIVMethod | Method of generating initialization vector. |
| rsmgmt.ESAPI.Encryptor.fixedIV | Initialization vector to use if fixed IV method is chosen. |
| rsmgmt.ESAPI.Encryptor.CipherText.useMAC | If 'true' compute and store the MAC. |
| rsmgmt.ESAPI.Encryptor.PlainText.overwrite | First overwrite the bytes of plaintext with the character. |
| rsmgmt.ESAPI.Encryptor.HashAlgorithm | Algorithm used to generate the encryption hash. |
| rsmgmt.ESAPI.Encryptor.HashIterations | Number of steps to take when hashing. |
| rsmgmt.ESAPI.Encryptor.DigitalSignatureAlgorithm | Algorithm used to generate a digital signature. |
| rsmgmt.ESAPI.Encryptor.DigitalSignatureKeyLength | The number of bits in a key used by a cryptographic algorithm. |
| rsmgmt.ESAPI.Encryptor.RandomAlgorithm | Algorithm used to generate a random number. |
| rsmgmt.ESAPI.Encryptor.CharacterEncoding | Character encoding used. |
| rsmgmt.ESAPI.Encryptor.KDF.PRF | Psuedo random function used in KDF. |
RSmgmt ESAPI Executor
| Property Name | Default Value |
|---|
| rsmgmt.ESAPI.Executor | Class used to execute os commands. |
| rsmgmt.ESAPI.Executor.WorkingDirectory | Directory in which commands are executed. |
| rsmgmt.ESAPI.Executor.ApprovedExecutables | List of approved executable files. |
RSmgmt HTTPUtilities
| Property Name | Default Value |
|---|
| rsmgmt.ESAPI.HTTPUtilities | Class used for securing http requests, responses, sessions, cookies, headers, and logging. |
| rsmgmt.ESAPI.HttpUtilities.UploadDir | Directory for files upload. |
| rsmgmt.ESAPI.HttpUtilities.UploadTempDir | Directory for temporary files upload. |
| rsmgmt.ESAPI.HttpUtilities.ForceHttpOnlySession | Set to 'true' to force the http only flag be set on the session. |
| rsmgmt.ESAPI.HttpUtilities.ForceSecureSession | Set to 'true' to force the secure session only flag to be set the session. |
| rsmgmt.ESAPI.HttpUtilities.ForceHttpOnlyCookies | Set to 'true' to force the http only flag to be set on cookies. |
| rsmgmt.ESAPI.HttpUtilities.ForceSecureCookies | Set to 'true' to force the secure only flag to be set on cookies. |
| rsmgmt.ESAPI.HttpUtilities.MaxHeaderSize | Maximum size of header. |
| rsmgmt.ESAPI.HttpUtilities.ApprovedUploadExtensions | Extensions allowed for upload. |
| rsmgmt.ESAPI.HttpUtilities.MaxUploadFileBytes | Maximum upload size for a file in bytes. |
| rsmgmt.ESAPI.HttpUtilities.ResponseContentType | The content type of the response and its character encoding. |
| rsmgmt.ESAPI.HttpUtilities.HttpSessionIdName | Name of the http session. |
RSmgmt ESAPI Intrusion Detector
| Property Name | Default Value |
|---|
| rsmgmt.ESAPI.IntrusionDetector.Disable | Set to 'true' to disable intrusion detection. |
| rsmgmt.ESAPI.IntrusionDetector | Class used for intrusion detection. |
| rsmgmt.ESAPI.IntrusionDetector.event.test.actions | Action to take if an intrusionexception fires. |
| rsmgmt.ESAPI.IntrusionDetector.event.test.count | Fire off intrusion exception if count events are received within an interval. |
| rsmgmt.ESAPI.IntrusionDetector.event.test.interval | Interval in which count actions are allowed. |
| rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.actions | Action to take if an integrityException fires. |
| rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.count | Fire off IntegrityException if count events are received within an interval. |
| rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntegrityException.interval | Interval in which count actions are allowed. |
| rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.actions | Action to take if an IntrusionException fires. |
| rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.count | Fire off intrusion exception if count events are received within an interval. |
| rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.IntrusionException.interval | Interval in which count actions are allowed. |
| rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.count | Fire off AuthenticationHostException if count events are received within an interval. |
| rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.interval | Interval in which count actions are allowed. |
| rsmgmt.ESAPI.IntrusionDetector.org.owasp.esapi.errors.AuthenticationHostException.actions | Action to take if an AuthenticationHostException fires. |
RSmgmt ESAPI Logger
| Property Name | Default Value |
|---|
| rsmgmt.ESAPI.Logger | Logger factory used to create a logger. |
| rsmgmt.ESAPI.Logger.ApplicationName | Name of the application being logged for. |
| rsmgmt.ESAPI.Logger.LogApplicationName | Determines whether ESAPI should log the application name. |
| rsmgmt.ESAPI.Logger.LogEncodingRequired | Set to 'true' to require log data to be encoded. |
| rsmgmt.ESAPI.Logger.LogFileName | Name of file to log into. |
| rsmgmt.ESAPI.Logger.MaxLogFileSize | Max log file size. |
| rsmgmt.ESAPI.Logger.LogServerIP | Log the server IP when logging. |
RSmgmt printProperteis
| Property Name | Default Value |
|---|
| rsmgmt.ESAPI.printProperties | If 'true' print all ESAPI properties when loaded. |
RSmgmt ESAPI Randomizer
| Property Name | Description | Default Value |
|---|
| rsmgmt.ESAPI.Randomizer | Class used for creating random numbers. | org.owasp.esapi.reference.DefaultRandomizer |
RSmgmt ESAPI Validation
| Property Name | Default Value |
|---|
| rsmgmt.ESAPI.Validator | Class used for validation. |
| rsmgmt.ESAPI.Validator.AcceptLenientDates | Set to 'true' to accept lenient dates. |
| rsmgmt.ESAPI.Validator.AccountName | regex for allowed chracters and length for an account name |
| rsmgmt.ESAPI.Validator.ConfigurationFile | Name of the config file for validation. |
| rsmgmt.ESAPI.Validator.DirectoryName | regex for a valid directory name |
| rsmgmt.ESAPI.Validator.FileName | regex for a valid file name |
| rsmgmt.ESAPI.Validator.HTTPContextPath | regex for a valid http context path |
| rsmgmt.ESAPI.Validator.HTTPCookieName | regex for a valid cookie name |
| rsmgmt.ESAPI.Validator.HTTPCookieValue | regex for a valid cookie value |
| rsmgmt.ESAPI.Validator.HTTPHeaderName | regex for a valid http header name |
| rsmgmt.ESAPI.Validator.HTTPHeaderValue | regex for a valid http header value |
| rsmgmt.ESAPI.Validator.HTTPJSESSIONID | regex for a valid http JSESSIONID |
| rsmgmt.ESAPI.Validator.HTTPParameterName | regex for a valid http parameter name |
| rsmgmt.ESAPI.Validator.HTTPParameterValue | regex for a valid http parameter value |
| rsmgmt.ESAPI.Validator.HTTPPath | regex for a valid http path |
| rsmgmt.ESAPI.Validator.HTTPQueryString | regex for a valid http query string |
| rsmgmt.ESAPI.Validator.HTTPServletPath | regex for a valid http servlet path |
| rsmgmt.ESAPI.Validator.HTTPScheme | regex for a valid http scheme |
| rsmgmt.ESAPI.Validator.HTTPServerName | regex for a valid http server name |
| rsmgmt.ESAPI.Validator.HTTPURI | regex for a valid http uri |
| rsmgmt.ESAPI.Validator.HTTPURL | regex for a valid http url |
| rsmgmt.ESAPI.Validator.Redirect | regex for a valid redirect |
| rsmgmt.ESAPI.Validator.RoleName | regex for a valid rolename |
| rsmgmt.ESAPI.Validator.SystemCommand | regex for a valid System Command |
Enabling Gateways
Gateways provide API libraries that allow Actions Pro to connect to external systems. The Gateways are used in ActionTasks to create temporary connections to interact with other applications. Gateways come in software development kit (SDK) which is installed additionally and require changes in the Blueprint properties file. Connectors are used the same way but they do not require changes in the Blueprint properties file. They are part of the Actions Pro product and are used as is.
When the Gateway properties are set to true and the config script is run, the RSRemote run script is modified to include the necessary libraries on its classpath. If your task is giving an error when trying to use a Gateway, ensure that the Gateway is enabled in the Blueprint.
For most Connectors, including Oracle or MySQL, simply switching the relevant Blueprint properties is enough to enable them. The major exceptions are the Informix and Remedy Connectors, which also require copying the relevant jar file (ifxjdbc.jar for Informix) in the /opt/resolve/lib folder. Alternatively, the jar file can be copied to the rsremote/lib folder and it will be automatically added to the classpath on the next RSRemote restart. For more about using connectors and gateways, see The Confluence Community site/Gateway Connectors.
| Integration Name | Integration Type | Latest Third Party Product Version Support |
|---|
| EWS Gateway | Gateway | All Versions supported |
| ArcSight Gateway | SDK Gateway | ArcSight ESM 6.8c |
| CA Spectrum | Gateway | CA Spectrum 10.x |
| CAServiceDesk Gateway | SDK Gateway | CA Service Desk 14.x |
| Database Gateway | Gateway | DB2, SQL, MySQL, MariaDB, PostGres, Oracle, Sybase |
| AssureNow Gateway | SDK Gateway | Federos AssureOne 4.x |
| Netcool Gateway | Gateway | IBM Netcool 8.x |
| QRadar Gateway | SDK Gateway | IBM QRADAR SIEM 7.x |
| QRadarPull Gateway | SDK Gateway | IBM QRADAR SIEM 9.x |
| IBMMQ Gateway | SDK Gateway | IBM Websphere MQ 8.x |
| Jira Service Desk | SDK Gateway | Jira Service Desk 4.x |
| Kafka Gateway | SDK Gateway | Kafka 2.2 |
| SCOM Gateway | SDK Gateway | MS SCOM 2012R2 |
| McAfee Gateway | SDK Gateway | McAfee ESM 10.x |
| MoogSoft Gateway | SDK Gateway | Moogsoft AI/Ops 7.x |
| EmailConnect | Connector | N/A |
| EmailConnect2 | Connector | N/A |
| Email Gateway | Gateway | N/A |
| Exchange Gateway | Gateway | N/A |
| FTP | Connector | N/A |
| Informix | Connector | N/A |
| VT | Connector | N/A |
| Htmlconnect | Connector | N/A |
| PDF | Connector | N/A |
| Salesforce Gateway | Gateway | N/A |
| HTTP | Gateway | N/A |
| SMTP | Gateway | N/A |
| SNMP | Gateway | N/A |
| SSH | Gateway | N/A |
| AMQP | Gateway | N/A |
| Telnet | Gateway | N/A |
| TSRM | Gateway | N/A |
| HPOM | Gateway | N/A |
| HPSM | Gateway | N/A |
| Terminal Emulation TN3270 (MainFrame) | Connector | N/A |
| Terminal Emulation TN5250 (MainFrame) | Connector | N/A |
| Itncm | Connector | N/A |
| Wsliteconnect | Connector | N/A |
| XMPP | Gateway | N/A |
| TibcoBespoke | Gateway | N/A |
| Groovy Gateway | SDK Gateway | N/A |
| Gateway Builder | SDK-2 Gateway | N/A |
| RemedyX | Gateway | Remedy 9.x |
| ServiceNow Gateway | Gateway | ServiceNow Madrid |
| Solarwinds Gateway | SDK Gateway | Solarwinds NPM 12.x |
| Splunk Gateway | SDK Gateway | Splunk 7.x |
| SplunkPull Gateway | SDK Gateway | Splunk 7.x |
| JMS Gateway | SDK Gateway | Weblogic 14c or Weblogic 12c using wlthint3client.jar from the 14c version (as that from the 12c version is not compatible with OpenJDK 11) |
| Zenoss Gateway | SDK-2 Gateway | Zenoss 6.x |
Email Setup
Configuration of an email SMTP server is encouraged to allow Actions Pro to send notifications. Emails will be sent to users through this SMTP server from Social, the CR and SR applications, and Runbooks using the NotificationAPI.
Advanced settings can be set in the rsremote.receive.email.<property name> properties in the Connector/Gateway Setup section.
| Field | Description | Defaults |
|---|
| rsremote.receive.email.active | To activate email for Actions Pro. | false |
| rsremote.receive.email.queue | Queue name to listen for messages. | EMAIL |
| rsremote.receive.email.primary | Whether this is the primary gateway connection; if primary=true then secondary must be false. | true |
| rsremote.receive.email.secondary | If secondary=true then primary must be false. | false |
| rsremote.receive.email.worker | If true, processes data received from the server; in primary or secondary you may set it as false so it simply distribute data to workers. | true |
| rsremote.receive.email.heartbeat | In seconds, interval to check for heartbeat from primary. | 20 |
| rsremote.receive.email.failover | In seconds, if heartbeat from primary not received in this time frame, then take over as primary. | 60 |
| rsremote.receive.email.interval | In seconds, if there is no filter to process, pause | 10 |
| rsremote.receive.email.protocol | name of the email protocol | |
| rsremote.receive.email.socialpost | true allows this gateway to post and email notifications in Actions Pro Social | true |
| rsremote.receive.email.pop3.username | Username/password used to authenticate against POP3 server | e-mail user_name |
| rsremote.receive.email.pop3.password | Username/password used to authenticate against POP3 server | e-mail password |
| rsremote.receive.email.pop3.ipaddress | IPaddress to connect to | e-mail host |
| rsremote.receive.email.pop3.port | Port to use with POP3 when creating the gateway connection | 110 |
| rsremote.receive.email.pop3.folder | | inbox |
| rsremote.receive.email.pop3.ssl | Is SSL enabled on the POP3 server | false |
| rsremote.receive.email.properties | | pop3.properties |
| rsremote.receive.email.smtp.host | SMTP server host name | e-mail host |
| rsremote.receive.email.smtp.port | Port to use with SMTP when creating the gateway connection | 25 |
| rsremote.receive.email.smtp.from | | |
| rsremote.receive.email.smtp.username | Username/password used to authenticate against SMTP server | e-mail user_name |
| rsremote.receive.email.smtp.password | Username/password used to authenticate against SMTP server | e-mail password |
| rsremote.receive.email.smtp.ssl | Is SSL enabled on the SMTP server | false |
| rsremote.receive.email.smtp.properties | | |
| rsremote.receive.email.smtp.properties | If true, properties received from the server will be converted to uppercase and sent to the Runbook | true |
Ensure that a proper hostname and port were configured during installation, as these values will be used to generating links inside Social notification emails. This property is stored as "system.resolve.url" and can be verified or altered from the System Administration main menu, in System Properties menu item.
Email Gateway Blueprint Configuration
| Field | Description | Defaults |
|---|
| EMAIL_ACTIVE | To activate email for Actions Pro | false |
| EMAIL_HOST | SMTP server host name | |
| EMAIL_SMTP_PORT | SMTP port number | 25 |
| EMAIL_POP3_PORT | POP3 port number | 110 |
| EMAIL_USERNAME | Username/password used to authenticate against SMTP server | |
| EMAIL_PASSWORD | Username/password used to authenticate against SMTP server | |
| EMAIL_SSL | Is SSL enabled on the SMTP server | false |
Database Gateway Blueprint Configuration
| Property Name | Description | Default Value |
|---|
| rsremote.receive.db.active | true makes this gateway active | false |
| rsremote.receive.db.queue | Queue name to listen for messages | REMEDYX |
| rsremote.receive.db.primary | Whether this is the primary gateway connection. if primary=true then secondary must be false | true |
| rsremote.receive.db.secondary | If secondary=true then primary must be false | false |
| rsremote.receive.db.worker | If true, processes data received from the server. in primary or secondary you may set it as false so it simply distribute data to workers | true |
| rsremote.receive.db.heartbeat | In seconds, interval to check for heartbeat from primary | 20 |
| rsremote.receive.db.failover | In seconds, if heartbeat from primary not received in this time frame, then take over as primary | 60 |
| rsremote.receive.db.failover | In seconds, if heartbeat from primary not received in this time frame, then take over as primary | 60 |
| rsremote.receive.db.interval | In seconds, if there is no filter to process, pause | 10 |
| rsremote.receive.db.uppercase | If true, properties received from the server will be converted to uppercase and sent to the Runbook | true |
| rsremote.receive.db.poll | If true, access the database server if there is deployed filter | false |
| rsremote.receive.db.pollinterval | In seconds, 0 means no interval | 10 |
| rsremote.receive.db.resolvestatusfield | name of the status field to update | ResolveStatus |
| rsremote.receive.db.resolvestatusvalue | value to put into the status field when updating | 1 |
EWS Gateway Blueprint Configuration
| Property | Description | Default Value |
|---|
| rsremote.receive.ews.active | true makes this gateway active | false |
| rsremote.receive.ews.queue | Queue name to listen for messages | EWS |
| rsremote.receive.ews.primary | Whether this is the primary gateway connection; if primary=true then secondary must be false | true |
| rsremote.receive.ews.secondary | If secondary=true then primary must be false | false |
| rsremote.receive.ews.worker | If true, processes data received from the server; in primary or secondary you may set it as false so it simply distribute data to workers | true |
| rsremote.receive.ews.heartbeat | In seconds, interval to check for heartbeat from primary | 20 |
| rsremote.receive.ews.failover | In seconds, if heartbeat from primary not received in this time frame, then take over as primary | 60 |
| rsremote.receive.ews.uppercase | If true, properties received from the server will be converted to uppercase and sent to the Runbook | true |
| rsremote.receive.ews.interval | In seconds, if there is no filter to process, pause | 10 |
| rsremote.receive.ews.url | EWS server web service URL | https://127.0.0.1/EWS/Exchange.asmx |
| https://127.0.0.1/EWS/Exchange.asmx | Whether or not to automatically uppercase all filter fields when executing a Runbook or script from a filter | true |
| rsremote.receive.ews.socialpost | true allows this gateway to post and email notifications in Actions Pro Social | false |
| rsremote.receive.ews.isproxyenabled | | false |
| rsremote.receive.ews.proxyhost | EWS server hostname or the IP address | |
| rsremote.receive.ews.proxyport | Port to use with primary ipaddress when creating the gateway connection | |
| rsremote.receive.ews.proxydomain | Proxy domain | |
| rsremote.receive.ews.proxyusername | Proxy user name | |
| rsremote.receive.ews.proxypassword | Proxy password | |
Exchange Gateway Blueprint Configuration
| Property | Description | Default Value |
|---|
| rsremote.receive.exchange.active | true makes this gateway active | false |
| rsremote.receive.exchange.queue | Queue name to listen for messages | EXCHANGE |
| rsremote.receive.exchange.username | Username to the Exchange server | username |
| rsremote.receive.exchange.password | Password of the Exchange server | password |
| rsremote.receive.exchange.host | Exchange server hostname or the IP address | 127.0.0.1 |
| rsremote.receive.exchange.ewsmode | If true, use the EWS web service to connect; if false, use MAPI | true |
| rsremote.receive.exchange.ewsurl | URL of the Exchange web service | https://localhost/ews/exchange.asmx |
| rsremote.receive.exchange.mailbox | Mail box to access by default | mailbox |
| rsremote.receive.exchange.domain | Domain of email account | domain |
| rsremote.receive.exchange.mapiclientversion | MAPI client version the server support | 12.4518.1014 |
| rsremote.receive.exchange.reconnectdelay | In seconds, delay between reconnection | 30 |
| rsremote.receive.exchange.retrydelay | In seconds, retrying between reconnection | 5 |
| rsremote.receive.exchange.maxattachmentmessagesize | Maximum size of attachments that can be passed as a binary array to a Runbook, if attachment size is greater they will be written as local files and the filenames passed instead | 0 |
| rsremote.receive.exchange.socialpost | true allows this gateway to post to Actions Pro Social | false |
HP Operations Manager Gateway Blueprint Configuration
| Property Name | Description | Default Value |
|---|
| rsremote.receive.hpom.active | true makes this gateway active | false |
| rsremote.receive.hpom.queue | Queue name to listen for messages | HPOM |
| rsremote.receive.hpom.primary | Whether this is the primary gateway connection. if primary=true then secondary must be false | true |
| rsremote.receive.hpom.secondary | If secondary=true then primary must be false | false |
| rsremote.receive.hpom.worker | If true, processes data received from the server. in primary or secondary you may set it as false so it simply distributes data to workers | true |
| rsremote.receive.hpom.heartbeat | In seconds, interval to check for heartbeat from primary | 20 |
| rsremote.receive.hpom.failover | In seconds, if heartbeat from primary not received in this time frame, then take over as primary | 60 |
| rsremote.receive.hpom.interval | In seconds, if there is no filter to process, pause | 10 |
| rsremote.receive.hpom.url | url used to connect to hpom | http://hpom_host:port/opr-webservice |
| rsremote.receive.hpom.username | Username to the HPOM server | |
| rsremote.receive.hpom.password | Password to the HPOM server | |
| rsremote.receive.hpom.socket_timeout | | 30 |
| rsremote.receive.hpom.status.active | Whether or not to update a status field for every event picked up by the gateway | false |
| rsremote.receive.hpom.status.fieldname | Name of the status field to update | RESOLVE_STATUS |
| rsremote.receive.hpom.status.process | Value to put into the status field when updating | 1 |
| rsremote.receive.hpom.runbookid.active | Whether or not to update a field with the value of the Runbook field in the filter | false |
| rsremote.receive.hpom.runbookid.fieldname | The name of the field to update with the Runbook ID | RESOLVE_RUNBOOKID |
| rsremote.receive.hpom.uppercase | If true, properties received from the server will be converted to uppercase and sent to the Runbook | true |
| rsremote.receive.hpom.objects | Comma-separated list of the supported objects for this gateway. this list may grow in the future as we add support for more objects | Case |
HP Service Manager Gateway Blueprint Configuration
| Property Name | Description | Default Value |
|---|
| rsremote.receive.hpsm.active | true makes this gateway active | false |
| rsremote.receive.hpsm.queue | Queue name to listen for messages | HPSM |
| rsremote.receive.hpsm.primary | Whether this is the primary gateway connection. if primary=true then secondary must be false | true |
| rsremote.receive.hpsm.secondary | If secondary=true, then primary must be false | false |
| rsremote.receive.hpsm.worker | Whether or not filter scripts will be run on this gateway instance; if worker is true, then primary MUST be false | false |
| rsremote.receive.hpsm.heartbeat | How often heartbeat messages are sent to other gateway cluster members | 20 |
| rsremote.receive.hpsm.failover | How long a secondary gateway has to wait without a heartbeat message before taking over for the primary | 60 |
| rsremote.receive.hpsm.interval | In seconds, if there is no filter to process, pause | 10 |
| rsremote.receive.hpsm.url | url used to connect to HPSM | http://127.0.0.1:13080/SM/7 |
| rsremote.receive.hpsm.username | Username to use when connecting | falcon |
| rsremote.receive.hpsm.password | Password to use when connecting | |
| rsremote.receive.hpsm.uppercase | If true, properties received from the server will be converted to uppercase and sent to the Runbook | true |
| rsremote.receive.hpsm.objects | Comma-separated list of the supported objects for this gateway; this list may grow in the future as we add support for more objects | Case |
ITM Gateway Blueprint Configuration
| Property | Description | Default Value |
|---|
| rsremote.receive.itm.server | The itm server to connect to. | teps.demo.local |
| rsremote.receive.itm.cmd | Location of the itm command prompt. | /opt/IBM/ITM/bin/tacmd |
| rsremote.receive.itm.remote_windows_dir | Location of the windows. | C: temp |
| rsremote.receive.itm.remote_unix_dir | Location of the unix dir. | /usr/tmp |
| rsremote.receive.itm.deleteoutputs | If 'true' delete the itm responefile after using it. | true |
| rsremote.receive.itm.outputdir | The directory to store the .out response file in. | {DIST}/rsremote/log/ |
| rsremote.receive.itm.scriptdir | The directory to store the remote script in. | {DIST}/rsremote/file/ |
| rsremote.receive.itm.loginduration | How long you want to stay logged in to itm for. | 1440 |
| rsremote.receive.itm.timeout | How long until a command times out. | 1200 |
Netcool Gateway Blueprint Configuration
| Property Name | Description | Default Value |
|---|
| rsremote.receive.netcool.active | true makes this gateway active | false |
| rsremote.receive.netcool.queue | Queue name to listen for messages | NETCOOL |
| rsremote.receive.netcool.primary | Whether this is the primary gateway connection. if primary=true then secondary must be false | true |
| rsremote.receive.netcool.secondary | Whether this is the primary gateway connection. if primary=true then secondary must be false | true |
| rsremote.receive.netcool.secondary | Whether this is a secondary gateway connection. if secondary=true then primary must be false | false |
| rsremote.receive.netcool.worker | Whether or not filter scripts will be run on this gateway instance | true |
| rsremote.receive.netcool.ipaddress | Primary Omnibus ipaddress to connect to | |
| rsremote.receive.netcool.ipaddress2 | Secondary Omnibus ipaddress to connect to if primary connection fails | |
| rsremote.receive.netcool.port | Port to use with primary ipaddress when creating the gateway connection | 4100 |
| rsremote.receive.netcool.port2 | Port to use with secondary ipaddress when creating the gateway connection | 4100 |
| rsremote.receive.netcool.username | Username to use when connecting | root |
| rsremote.receive.netcool.password | Password to use when connecting | |
| rsremote.receive.netcool.applicationname | Application name. Auto update a status field on filter matched events, fieldname will be updated to process value, type can be NUMBER or STRING | |
| rsremote.receive.netcool.status.active | Whether or not to update a status field in Netcool for every event picked up by the gateway | false |
| rsremote.receive.netcool.status.fieldname | Name of the status field to update | ResolveStatus |
| rsremote.receive.netcool.status.process | Value to put into the status field when updating | 1 |
| rsremote.receive.netcool.status.type | Status type. Auto update a status field on filter matched events, fieldname will be updated to process value, type can be NUMBER or STRING | |
| rsremote.receive.netcool.runbookid.active | Whether or not to update a field in Netcool with the value of the Runbook field in the filter | false |
| rsremote.receive.netcool.runbookid.fieldname | The name of the field to update in Netcool with the Runbook ID | ResolveRunbookId |
| rsremote.receive.netcool.version | Version of Netcool the gateway is connecting to | 7 |
| rsremote.receive.netcool.poolsize | Size of the connection pool created by the gateway | 10 |
| rsremote.receive.netcool.minevictableidletime | minimum amount of time a connection can sit idle in the connection pool before it can be evicted from the connection pool | 600 |
| rsremote.receive.netcool.timebetweenevictionruns | time between runs that remove connections from the connection pool | 300 |
| rsremote.receive.netcool.url | Url to be used to connect to netcool. If provided, will overwrite the JDBC connection string created from ipaddress and port | |
| rsremote.receive.netcool.url2 | Backup url to be used to connect to netcool. If provided, will overwrite the JDBC connection string created from ipaddress2 and port2 | |
| rsremote.receive.netcool.driver | The name of the driver used to connect to the Netcool Omnibus, if different than the default (com.sybase.jdbc3.jdbc.SybDriver) | |
| rsremote.receive.netcool.heartbeat | How often heartbeat messages are sent to other gateway cluster members | 20 |
| rsremote.receive.netcool.failover | How long a secondary gateway has to wait without a heartbeat message before taking over for the primary | 60 |
| rsremote.receive.netcool.reconnectdelay | How often the gateway will try to reconnect to its primary instance if it has failed over to the secondary | 30 |
| rsremote.receive.netcool.retrydelay | How may times the gateway will attempt to connect before it gives up | 5 |
| rsremote.receive.netcool.uppercase | Whether or not to automatically uppercase all filter fields when executing a Runbook or script from a filter | true |
| rsremote.receive.netcool.activeconnectionvalidation | causes all netcool select update calls to run a test query to validate connection before executing | false |
RemedyX Gateway Blueprint Configuration
| Property | Description | Default Value |
|---|
| rsremote.receive.remedyx.active | true makes this gateway active | false |
| rsremote.receive.remedyx.queue | Queue name to listen for messages | REMEDYX |
| rsremote.receive.remedyx.primary | Whether this is the primary gateway connection; if primary=true then secondary must be false | true |
| rsremote.receive.remedyx.secondary | If secondary=true then primary must be false | false |
| rsremote.receive.remedyx.worker | If true, processes data received from the server; in primary or secondary you may set it as false so it simply distributes data to workers | true |
| rsremote.receive.remedyx.heartbeat | In seconds, interval to check for heartbeat from primary | 20 |
| rsremote.receive.remedyx.failover | In seconds, if heartbeat from primary not received in this time frame, then take over as primary | 60 |
| rsremote.receive.remedyx.interval | In seconds, if there is no filter to process, pause | 10 |
| rsremote.receive.remedyx.username | Username to the RemedyX server | remedy |
| rsremote.receive.remedyx.password | Password of the RemedyX user | |
| rsremote.receive.remedyx.host | RemedyX server hostname or the ipaddress | |
| rsremote.receive.remedyx.port | Port RemedyX server is listening on, -1 indicates the gateway will use port mapping instead of a fixed port | 1 |
| rsremote.receive.remedyx.poll | If true, access the RemedyX server if there is deployed filter. | false |
| rsremote.receive.remedyx.pollinterval | In seconds, 0 means no interval. | 0 |
| rsremote.receive.remedyx.uppercase | If true, properties received from the server will be converted to uppercase and sent to the Runbook. | true |
Salesforce Gateway Blueprint Configuration
| Property | Description | Default Value |
|---|
| rsremote.receive.salesforce.active | true makes this gateway active | false |
| rsremote.receive.salesforce.queue | Queue name to listen for messages | SALESFORCE |
| rsremote.receive.salesforce.primary | Whether this is the primary gateway connection, if primary=true then secondary must be false | true |
| rsremote.receive.salesforce.secondary | If secondary=true then primary must be false | false |
| rsremote.receive.salesforce.worker | If true, processes data received from the server. in primary or secondary you may set it as false so it simply distribute data to workers | true |
| rsremote.receive.salesforce.heartbeat | In seconds, interval to check for heartbeat from primary | 20 |
| rsremote.receive.salesforce.failover | In seconds, if heartbeat from primary not received in this time frame, then take over as primary | 60 |
| rsremote.receive.salesforce.uppercase | If true, properties received from the server will be converted to uppercase and sent to the Runbook | true |
| rsremote.receive.salesforce.interval | In seconds, if there is no filter to process, pause | 10 |
| rsremote.receive.salesforce.accounttype | types of accounts to activate in gateway | enterprisehttps://login.salesforce.com/services/Soap/c/25.0 |
| rsremote.receive.salesforce.url | url used to connect to saleforce with this link | https://login.salesforce.com/services/Soap/u/25.0 |
| rsremote.receive.salesforce.httpbasicauthusername | username used to authenticate rest calls to salesforce | |
| rsremote.receive.salesforce.httpbasicauthpassword | password used to authenticate rest calls to salesforce | |
| rsremote.receive.salesforce.objects | comma separated lists the supported objects for this gateway | Incident |
ServiceNow Gateway Blueprint Configuration
| Property | Description | Default Value |
|---|
| rsremote.receive.servicenow.active | true makes this gateway active | false |
| rsremote.receive.servicenow.queue | Queue name to listen for messages | SERVICENOW |
| rsremote.receive.servicenow.primary | Whether this is the primary gateway connection. if primary=true then secondary must be false | true |
| rsremote.receive.servicenow.secondary | If secondary=true then primary must be false | false |
| rsremote.receive.servicenow.worker | If true, processes data received from the server; in primary or secondary you may set it as false so it simply distribute data to workers | true |
| rsremote.receive.servicenow.heartbeat | In seconds, interval to check for heartbeat from primary | 20 |
| rsremote.receive.servicenow.failover | In seconds, if heartbeat from primary not received in this time frame, then take over as primary | 60 |
| rsremote.receive.servicenow.uppercase | If true, properties received from the server will be converted to uppercase and sent to the Runbook | true |
| rsremote.receive.servicenow.interval | In seconds, if there is no filter to process, pause | 10 |
| rsremote.receive.servicenow.url | url of the Servicenow application to connect to | http://localhost/api/now/v1/table/ |
| rsremote.receive.servicenow.httpbasicauthusername | username used to authenticate rest calls to service now | |
| rsremote.receive.servicenow.httpbasicauthpassword | password used to authenticate rest calls to service now | |
| rsremote.receive.servicenow.datetimewebservicename | name of the web service to get server date time for | GetServerDateTime |
| rsremote.receive.servicenow.datetimerestserviceurl | url of the web service to get the server date time for | https://localhost/api/x_ressy_resolve_sy/resolve_servicenow_service/serverdatetime |
| rsremote.receive.servicenow.mutualtlsenabled | | false |
| rsremote.receive.servicenow.mutualtlskeystore | | |
| rsremote.receive.servicenow.mutualtlskeystorepass | | |
| rsremote.receive.servicenow.mutualtlstruststore | | |
| rsremote.receive.servicenow.mutualtlstruststorepass | | |
| rsremote.receive.servicenow.headerredirenable | | false |
| rsremote.receive.servicenow.headerredirurl | | |
| rsremote.receive.servicenow.headerredirheader | | |
| rsremote.receive.servicenow.headerredirencauth | | true |
SNMP Gateway Blueprint Configuration
| Property Name | Description | Default Value |
|---|
| rsremote.receive.snmp.active | true makes this gateway active | false |
| rsremote.receive.snmp.queue | Queue name to listen for messages | SNMP |
| rsremote.receive.snmp.primary | Whether this is the primary gateway connection. if primary=true then secondary must be false | true |
| rsremote.receive.snmp.secondary | If secondary=true then primary must be false | false |
| rsremote.receive.snmp.worker | If true, processes data received from the server. in primary or secondary you may set it as false so it simply distribute data to workers | true |
| rsremote.receive.snmp.heartbeat | In seconds, interval to check for heartbeat from primary | 20 |
| rsremote.receive.snmp.failover | In seconds, if heartbeat from primary not received in this time frame take over as primary | 60 |
| rsremote.receive.snmp.uppercase | If true, properties received from the server will be converted to uppercase and sent to the Runbook | true |
| rsremote.receive.snmp.interval | In seconds, if there is no filter to process, pause | 10 |
| rsremote.receive.snmp.ipaddress | IPaddress to connect to | localhost |
| rsremote.receive.snmp.port | Port to use with primary ipaddress when creating the gateway connection | 162 |
| rsremote.receive.snmp.readcommunity | community used to authenticate a request to read data | public |
| rsremote.receive.snmp.writecommunity | community used to authenticate a write request to a machine | private |
| rsremote.receive.snmp.sendtrap.retries | number of times to retry sending a trap | 2 |
| rsremote.receive.snmp.sendtrap.timeout | time until a trap timesout | |
SSH Pool Gateway Blueprint Configuration
| Property Name | Description | Default Value |
|---|
| rsremote.receive.ssh.active | true makes this gateway active | false |
| rsremote.receive.ssh.queue | Queue name to listen for messages | SSH |
| rsremote.receive.ssh.primary | Whether this is the primary gateway connection. if primary=true then secondary must be false | true |
| rsremote.receive.ssh.interval | In seconds, if there is no filter to process, pause | 10 |
| rsremote.receive.ssh.port | Port to use with primary ipaddress when creating the gateway connection | 22 |
| rsremote.receive.ssh.maxconnection | maximum number of connections the gateway can have open at one time | 10 |
| rsremote.receive.ssh.timeout | time until a connection attempt timesout | 120 |
| rsremote.receive.ssh.timeoutcounter | number of timeouts allowed for a connection | 10 |
| rsremote.receive.ssh.expiry | | 1 |
| rsremote.receive.ssh.cleanup | | 1 |
Telnet Pool Gateway Blueprint Configuration
| Property Name | Description | Default Value |
|---|
| rsremote.receive.telnet.active | Set to 'true' to activate the gateway. | false |
| rsremote.receive.telnet.queue | Queue name to listen for messages. | TELNET |
| rsremote.receive.telnet.interval | In seconds, if there is no filter to process, pause. | 10 |
| rsremote.receive.telnet.port | Port to use when creating the gateway connection. | 23 |
| rsremote.receive.telnet.maxconnection | Maximum number of connections the gateway can have open at one time. | 10 |
| rsremote.receive.telnet.timeout | Time for request to timeout. | 120 |
TSRM Gateway Blueprint Configuration
| Property Name | Description | Default Value |
|---|
| rsremote.receive.tsrm.active | true makes this gateway active | false |
| rsremote.receive.tsrm.queue | Queue name to listen for messages | TSRM |
| rsremote.receive.tsrm.primary | Whether this is the primary gateway connection. if primary=true then secondary must be false | true |
| rsremote.receive.tsrm.secondary | If secondary=true then primary must be false | false |
| rsremote.receive.tsrm.worker | If true, processes data received from the server. in primary or secondary you may set it as false so it simply distribute data to workers | true |
| rsremote.receive.tsrm.heartbeat | In seconds, interval to check for heartbeat from primary | 20 |
| rsremote.receive.tsrm.failover | In seconds, if heartbeat from primary not received in this time frame, then take over as primary | 60 |
| rsremote.receive.tsrm.interval | In seconds, if there is no filter to process, pause | 10 |
| rsremote.receive.tsrm.uppercase | If true, properties received from the server will be converted to uppercase and sent to the Runbook | true |
| rsremote.receive.tsrm.reconnectdelay | How often the gateway will try to reconnect to its primary instance if it has failed over to the secondary | 30 |
| rsremote.receive.tsrm.retrydelay | How may times the gateway will attempt to connect before it gives up | 5 |
| rsremote.receive.tsrm.url | url used of the tsrm server you are connecting to | http://localhost/maxrest/rest/os/ |
| rsremote.receive.tsrm.username | Username to use when connecting | maxadmin |
| rsremote.receive.tsrm.password | Password to use when connecting | maxadmin |
| rsremote.receive.tsrm.httpbasicauthusername | username to authenticate rest call to TSRM server | |
| rsremote.receive.tsrm.httpbasicauthpassword | password to authenticate rest call to TSRM server | |
| rsremote.receive.tsrm.url2 | url of backup tsrm server | |
| rsremote.receive.tsrm.username2 | user name to connect ot backup TSRM server with | |
| rsremote.receive.tsrm.password2 | password to connect to backup TSRM server with | |
| rsremote.receive.tsrm.httpbasicauthusername2 | username to authenticate rest call to backup TSRM server | |
| rsremote.receive.tsrm.httpbasicauthpassword2 | password to authenticate rest call to backup TSRM server | |
| rsremote.receive.tsrm.uppercase | If true, properties received from the server will be converted to uppercase and sent to the Runbook | false |
| rsremote.receive.tsrm.objects | Comma-separated list of supported objects for this gateway, this list may grow in the future as we add support for more | Incident |
XMPP Gateway Blueprint Configuration
| Property Name | Description | Default Value |
|---|
| rsremote.receive.xmpp.active | true makes this gateway active | false |
| rsremote.receive.xmpp.queue | Queue name to listen for messages | XMPP |
| rsremote.receive.xmpp.primary | Whether this is the primary gateway connection. if primary=true then secondary must be false | true |
| rsremote.receive.xmpp.secondary | If secondary=true then primary must be false | false |
| rsremote.receive.xmpp.secondary | If secondary=true then primary must be false | false |
| rsremote.receive.xmpp.worker | If true, processes data received from the server; in primary or secondary you may set it as false so it simply distribute data to workers | true |
| rsremote.receive.xmpp.heartbeat | In seconds, interval to check for heartbeat from primary | 20 |
| rsremote.receive.xmpp.failover | In seconds, if heartbeat from primary not received in this time frame, then take over as primary | 60 |
| rsremote.receive.xmpp.uppercase | If true, properties received from the server will be converted to uppercase and sent to the Runbook | true |
| rsremote.receive.xmpp.interval | In seconds, if there is no filter to process, pause | 10 |
| rsremote.receive.xmpp.server | xmpp server to connect to | |
| rsremote.receive.xmpp.port | Port to use with primary ipaddress when creating the gateway connection | |
| rsremote.receive.xmpp.service | service that is using xmpp | |
| rsremote.receive.xmpp.username | Username to use when connecting | |
| rsremote.receive.xmpp.password | Password to use when connecting | |
| rsremote.receive.xmpp.sasl | set to true if you want xmpp to use sasl to secure messages | |
| rsremote.receive.xmpp.saslmechanism | Valid value: DIGEST-MD5, CRAM-MD5, PLAIN, ANONYMOUS | PLAIN |
| rsremote.receive.xmpp.socialpost | true allows this gateway to post and use instant messaging notifications in Actions Pro Social | true |
RSRemote Receive Remedy Gateway Blueprint Configuration
Remedy is deprecated, use remedyx instead.
| Property Name | Description | Default Value |
|---|
| rsremote.receive.remedy.active | set to true to activate the gateway | false |
| rsremote.receive.remedy.username | user name used to connect to remedy with | remedy |
| rsremote.receive.remedy.password | password used to connect to remedy with | |
| rsremote.receive.remedy.host | remedy server hostname or the ipaddress | |
| rsremote.receive.remedy.port | Port Remedy server is listening on, -1 indicates the gateway will use port mapping instead of a fixed port | 1 |
| rsremote.receive.remedy.maxconnection | maximum number of connections allowed to connect to the remedy server | 1 |
| rsremote.receive.remedy.poll | if true access the remedyX server if there is a deployed filter | |
| rsremote.receive.remedy.pollinterval | in seconds 0 means no interval | |
AMQP Gateway Blueprint Configuration
| Property Name | Description | Default Value |
|---|
| rsremote.receive.amqp.active | set to true to activate the gateway | false |
| rsremote.receive.amqp.queue | Actions Pro queue name that the gateway listens on | AMQP |
| rsremote.receive.amqp.primary | Whether this is the primary gateway connection. if primary=true then secondary must be false | true |
| rsremote.receive.amqp.secondary | If secondary=true then primary must be false | false |
| rsremote.receive.amqp.worker | If true, processes data received from the server | true |
| rsremote.receive.amqp.heartbeat | In seconds, interval to check for heartbeat from primary | 20 |
| rsremote.receive.amqp.failover | In seconds, if heartbeat from primary not received in this time frame, then take over as primary | 60 |
| rsremote.receive.amqp.interval | in seconds 0 means no interval | 10 |
| rsremote.receive.amqp.uppercase | If true, properties received from the server will be converted to uppercase and sent to the Runbook | true |
| rsremote.receive.amqp.serverwithportl | comma separated list of server as IP1:port,IP2:port | |
| rsremote.receive.amqp.virtualhost | namespace for exchanges, queue, and bindings | |
| rsremote.receive.amqp.username | username to connect to the amqp with | |
| rsremote.receive.amqp.password | password to connect to the amqp with | |
| rsremote.receive.amqp.ssl | set to true if you want to use ssl | true |
| rsremote.receive.amqp.connectionretry | number of times to retry connection attempts | 30 |
| rsremote.receive.amqp.connectionwait | amount of time to wait before retrying to connect | 10 |
AD Gateway Blueprint Configuration
| Property Name | Description | Default Value |
|---|
| rsremote.receive.ad.active | Set to 'true' to activate the AD. | false |
| rsremote.receive.ad.queue | Actions Pro queue name that the gateway listens to. | AD |
| rsremote.receive.ad.userauth | If 'true' then the gateway may be used for Actions Pro. | false |
| rsremote.receive.ad.grouprequired | If 'true' the user logging in to Actions Pro should have at least 1 AD group assigned. | false |
LDAP Gateway Blueprint Configuration
| Property Name | Description | Default Value |
|---|
| rsremote.receive.ldap.active | Set to 'true' to activate LDAP. | false |
| rsremote.receive.ldap.queue | Actions Pro queue name that the gateway listens to. | LDAP |
| rsremote.receive.ldap.userauth | If 'true' then the gateway maybe used for Actions Pro. | false |
| rsremote.receive.ldap.grouprequired | If 'true' the user logging in to Actions Pro should have at least 1 LDAP group assigned. | false |
TCP Gateway Blueprint Configuration
| Property Name | Description | Default Value |
|---|
| rsremote.receive.tcp.active | Set to 'true' to activate the gateway. | false |
| rsremote.receive.tcp.queue | Actions Pro queue name that the gateway listens on. | TCP |
| rsremote.receive.tcp.primary | Whether this is the primary gateway connection. if primary=true then secondary must be 'false'. | true |
| rsremote.receive.tcp.secondary | Whether this is the primary gateway connection. if primary=true then secondary must be 'false'. | true |
| rsremote.receive.tcp.worker | If 'true', processes data received from the server in primary or secondary you can set it as 'false' to simply distribute data to workers. | true |
| rsremote.receive.tcp.heartbeat | In seconds, interval to check for heartbeat from primary. | 20 |
| rsremote.receive.tcp.failover | In seconds, if heartbeat from primary not received in this time frame, then take over as primary. | 60 |
| rsremote.receive.tcp.interval | In seconds, 0 means no interval. | 10 |
| rsremote.receive.tcp.uppercase | If 'true', properties received from the server will be converted to uppercase and sent to the Runbook' | true |
| rsremote.receive.tcp.timeout | Timeout in milliseconds for a socket to abandon a connection set to 0 for no timeout. | 0 |
HTTP Gateway Blueprint Configuration
| Property Name | Description | Default Value |
|---|
| rsremote.receive.http.active | set to true to activate the gateway | false |
| rsremote.receive.http.queue | queue name tha the gateway listens on | HTTP |
| rsremote.receive.http.primary | Whether this is the primary gateway connection. if primary=true then secondary must be false | true |
| rsremote.receive.http.secondary | Whether this is the primary gateway connection. if primary=true then secondary must be false | true |
| rsremote.receive.http.worker | If true, processes data received from the server | true |
| rsremote.receive.http.heartbeat | In seconds, interval to check for heartbeat from primary | 20 |
| rsremote.receive.http.failover | In seconds, if heartbeat from primary not received in this time frame, then take over as primary | 60 |
| rsremote.receive.http.interval | in seconds 0 means no interval | 10 |
| rsremote.receive.http.uppercase | If true, properties received from the server will be converted to uppercase and sent to the Runbook | true |
| rsremote.receive.http.port | port that the gateway uses for connections | 7777 |
| rsremote.receive.http.ssl | set to true to use ssl | false |
| rsremote.receive.http.sslcertificate | certificate to use for ssl | /opt/resolve/rsremote/config/jetty.jks |
| rsremote.receive.http.sslpassword | password to the keystore | |
| rsremote.receive.http.username | username for the gateway | |
| rsremote.receive.http.password | password for the gateway | |
| rsremote.receive.http.wait_timeout | timeout in seconds for gateway block worksheetid to return | 120 |
TIBCOBESPOKE Gateway Blueprint Configuration
| Property Name | Description | Default Value |
|---|
| rsremote.receive.tibcobespoke.active | set to true to activate the gateway | false |
| rsremote.receive.tibcobespoke.queue | queue name that the gateway listens on | TIBCOBESPOKE |
| rsremote.receive.tibcobespoke.primary | Whether this is the primary gateway connection. if primary=true then secondary must be false | true |
| rsremote.receive.tibcobespoke.secondary | Whether this is the primary gateway connection. if primary=true then secondary must be false | true |
| rsremote.receive.tibcobespoke.worker | If true, processes data received from the server | true |
| rsremote.receive.tibcobespoke.heartbeat | In seconds, interval to check for heartbeat from primary | 20 |
| rsremote.receive.tibcobespoke.failover | In seconds, if heartbeat from primary not received in this time frame, then take over as primary | 60 |
| rsremote.receive.tibcobespoke.interval | in seconds 0 means no interval | 10 |
| rsremote.receive.tibcobespoke.uppercase | If true, properties received from the server will be converted to uppercase and sent to the Runbook | true |
| rsremote.receive.tibcobespoke.processminthread | minimum amount of threads per bus URI | 10 |
| rsremote.receive.tibcobespoke.processmaxthread | maximum amount of threads per bus URI | 15 |
| rsremote.receive.tibcobespoke.rabbitcorepoolsize | pool size for connection between Actions Pro and tibcobespoke | 100 |
| rsremote.receive.tibcobespoke.rabbitmaxpoolsize | maximum pool size for connections between Actions Pro and tibco | 500 |
| rsremote.receive.tibcobespoke.rabbitkeepalivetime | amount of time before killing the tibcobespoke process when communications fail | 120 |
| rsremote.receive.tibcobespoke.rabbitblockingqueuesize | maximum amount of messages allowed in a queue | 50 |
| rsremote.receive.tibcobespoke.tomid | tibcobespoke team specified id for Actions Pro server can be found by looking at /opt/tib/ | |
| rsremote.receive.tibcobespoke.credential | tibco bus credentials | |
| rsremote.receive.tibcobespoke.handlerclassname | name of the handler class specified by tibco team | |
| rsremote.receive.tibcobespoke.logtypes | types of logging to activate in gateway | INFO,WARN,ERROR,FATAL,TIBCO |
| rsremote.receive.tibcobespoke.busjarfiles | location of tibco jar file given by tibco team | |
| rsremote.receive.tibcobespoke.ldlibrarypat | path to ld_library folder installed by the tibco team | |
CASPECTRUM Gateway Blueprint Configuration
| Property Name | Description | Default Value |
|---|
| rsremote.receive.caspectrum.active | set to true to activate the gateway | false |
| rsremote.receive.caspectrum.queue | queue name tha the gateway listens on | HTTP |
| rsremote.receive.caspectrum.primary | Whether this is the primary gateway connection. if primary=true then secondary must be false | true |
| rsremote.receive.caspectrum.secondary | Whether this is the primary gateway connection. if primary=true then secondary must be false | true |
| rsremote.receive.caspectrum.worker | If true, processes data received from the server; in primary or secondary you may set it as false so it simply distribute data to workers | true |
| rsremote.receive.caspectrum.heartbeat | In seconds, interval to check for heartbeat from primary | 20 |
| rsremote.receive.caspectrum.failover | In seconds, if heartbeat from primary not received in this time frame, then take over as primary | 60 |
| rsremote.receive.caspectrum.interval | in seconds 0 means no interval | 10 |
| rsremote.receive.caspectrum.uppercase | If true, properties received from the server will be converted to uppercase and sent to the Runbook | true |
| rsremote.receive.caspectrum.url | url used to connect to caspectrum | http://10.60.0.45:8080/spectrum/restful/ |
| rsremote.receive.caspectrum.httpbasicauthusername | username used to authenticate http connection | |
| rsremote.receive.caspectrum.httpbasicauthpassword | password used to authenticate http connection | |
| rsremote.receive.caspectrum.throttlesize | maximum number of messages to get from ca spectrum in a single query | 1000 |