CMS parameters

The following table lists the CMS parameters.

Parameter

Description

AdminRequestTimeout

NOTE: Do not change this parameter unless instructed to do so by BMC Software Customer Support. If you are instructed to change this parameter, you must restart the CMS for the change to take effect.

Valid values: Any whole number that is equal to or greater than 20.

CmsCommMode

The mode with which the Configuration Management Server connects to the Control-M/Server Configuration Agent.

Valid values:

  • TCP - A non-secure connection is established.
  • SSL - Connect using SSL only.
  • Auto - The system automatically detects the type of connection that is established.

Default: TCP

CmsCtmNGRefreshInterval

Sets the refresh interval in seconds for collecting host group data.

Valid values: 0-10000 (0 -host group data is not collected)

Default: 900

CmsCtmRefreshInterval

The Configuration Management Server (CMS) refreshes the status and topology of the Control-M/Servers on a regular basis. This system parameter governs the length of time in seconds between each refresh episode.

Valid values: Any whole number that is equal to or greater than 30.

Default: 60

CmsEmRefreshInterval

The CMS refreshes its internal image of Control‑M/EM component status on a regular basis. This system parameter governs the length of time in seconds between each refresh episode.

Valid values: Any whole number that is equal to or greater than 30.

Default: 60

CmsGateAdditionalParams

Valid values: Do not change this parameter unless instructed to do so by BMC Software Customer Support.

CmsHostSpecRetrieverInterval

Determines the number of times in 24 hours to send internal requests to obtain computer specification (used for MANAGED Servers report).

Default: 60

CmsMaxPluggableOutput

Determines the maximum size in KB of stdout and stderr that is read from the pluggable request

Default: 100

CmsXAlertsHost

Specify the host or IP address on which the CMS is forced to receive XAlerts.

Valid values: Any valid host name or IP address.

NOTE: If no value is entered for this parameter, the host name on which the CMS is installed is used.

Default: null

CmsXAlertsPort

Specify the port through which the XAlerts are received.

Valid values: Any valid port.

Default: 0

NOTE: The default value 0 means that any random port is used.

DBCheckSpaceIntervalSeconds

Determines the number of seconds to wait to before checking the database space usage

Default: 36000

DBCheckSpaceWarningPct

Determines the maximum percentage of allowed database space use.

NOTE: An Xalert is issued if the threshold is exceeded.

Default: 90

DiagOutputTimeout

Determines the number of seconds to wait for a response from Control-M/Agent before a timeout occurs for the Get_diag_output request

Default: 30

HAProgressDataRetentionInterval

Determines the number of seconds that the failover or fallback progress information is available after the process completes.

Default: 604800

HandledXAlertHandling

Determines whether handled alerts are sent as an SNMP trap or to a script.

Valid values:

  • 1 - Handled alerts are sent as an SNMP trap and to a script.
  • 0 - Handled alerts are not sent as an SNMP trap and to a script.

NOTE: This parameter is only valid when the XAlertsSendSnmp system parameter has a value of 1, 2, or 3.

Default: 0

IdenticalXAlertTimeDelta

Determines the interval, in minutes, within which an alert is defined as identical to a previous matching alert.

Valid values: Any whole number that is equal to or greater than 0.

Default: 30 minutes

IdenticalXAlertCompareDesc

Determines whether the MESSAGE field is used to compare identical alerts.

Valid values:

  • 1 - Compare the MESSAGE field
  • 0 - Do not compare the MESSAGE field

Default: 0

IdenticalXAlertHandling

Determines whether identical alerts are sent as an SNMP trap or to a script.

Valid values:

  • 1 - Identical alerts are sent as an SNMP trap and to a script
  • 0 - Identical alerts are not sent as an SNMP trap and to a script

NOTE: This parameter is only valid when the XAlertsSendSnmp system parameter has a value of 1, 2, or 3.

Default: 0

ManageSSL_CertExpirDays

Determines the expiration duration of a certificate in the Manage SSL Generate Certificate Wizard.

Valid values: Any whole number that is equal to or greater than 1.

Default: 7300

ManageSSL_CACertExpirDays

Determines the expiration duration of a site CA in the Manage SSL Generate Certificate Wizard.

Valid values: Any whole number that is equal to or greater than 2.

Default: 7300

ManageSSL_CertKeyLengthBits

Determines the number of bits of the certificate key in the Manage SSL Generate Certificate Wizard.

Valid values: 1024, 2048, 3072, 4096

Default: 1024

MaxXAlerts2Send2Client

Valid values: Do not change this parameter unless instructed to do so by BMC Software Customer Support.

Determines the maximum number of exception alerts sent from the CMS to the Exception Alerts window.

Default: 2000

RemoteCmdTimeout

The amount of time, in seconds, that the CMS will wait for a reply to a remote request sent through the Configuration Management Server to Control-M/Server, Control-M/Agent, and Application Plug-Ins, before timing out.

An example of such a request is a ping agent request.

Valid values: Any whole number that is equal to or greater than 30.

Default: 300

RunInfoStatsPurgeDays

The number of days to retain deleted statistics, after which the statistics will be deleted when automatic purge is performed.

Valid values: Any whole number that is equal to or greater than 1.

Default: 100 days

RunInfoStatsPurgeInterval

Interval, in minutes, between activations of automatic purging of periodic statistics by the CMS.

NOTE: To disable automatic purging, set the value to 0.

Valid values: Any whole number that is equal to or greater than 1.

Default: 30

UsageAlertsState

Determines whether Usage Alerts are enabled.

Valid values:

  • 0 - Disabled
  • 1 - Enabled

Default: 0

VMCleanupIntervalMinutes

Interval, in minutes, between activations of automatic job history cleanup by the CMS.

NOTE: To disable automatic cleanup, set the value to 0.

Valid values: Any whole number that is equal to or greater than 30.

Default: 30

VMMaxDaysRetainCurJobsHistory

The number of days after which the history of the current jobs should be deleted automatically.

NOTE: A job version is deleted only when all of the following are true:

  • The version exceeds VMVersionsNumberToKeep.
  • The version exceeds VMMaxDaysRetainCurJobsHistory.
  • Automatic cleanup has run, as determined by VMCleanupIntervalMinutes.

Valid values: Any whole number that is equal to or greater than 0.

Default: 0

VMNumDaysRetainDeletedJobs

The number of days to retain deleted jobs and their history. Deleted tables will also be deleted according to this value.

Valid values: Any whole number that is equal to or greater than 1.

Default: 180

XAlertsSendSnmp

Determines whether an alert will be sent as an SNMP trap, to a script, both, or neither.

Valid values:

  • 0 - Not active
  • 1 - Sent as an SNMP trap
  • 2 - Sent to a script
  • 3 Sent as an SNMP trap and to a script

Default: 0

XAlertsMaxAge

Determines, in days, how long XAlerts are saved before they are deleted by the Configuration Management Server.

Valid values: Any whole number that is equal to or greater than 0.

Default: 180 days

XAlertsMaxHandled

The maximum number of handled XAlerts that are displayed in the Exception Alerts window.

Valid values: Any whole number that is equal to or greater than 0.

Default: 100

XAlertsSnmpHosts

Specifies the host names of the machines to which you want to send the SNMP trap.

Valid values: Any host name or IP address. Separate multiple hosts with a semicolon. To add a specific port for each host, enter the host name followed by a colon and the port number.

EXAMPLE:XAlertsmachine:7000;SNMPmachine;Scriptsmachine:7001

Default: null

XAlertsSend2Script

Specify the full path and file name of the script to be sent. This parameter is used only when the XAlertsSendSnmp system parameter is set to either 2 or 3.

Valid values: Any full path and file name.

Default: null

XAlertsDisableMsgIDs

Specify the message IDs for which no XAlerts are sent. By default, no message IDs are listed. Use a comma to separate multiple message IDs.

Default: none

XAlertsMinSeverityFilter

Specify the severity level filter. XAlerts with a value equal to or greater than the specified severity level are sent to the Exception Alerts window.

Valid Values:

  • Warning
  • Error
  • Severe

Default: Warning

Parent Topic

Control-M/EM system parameters