Previous Topic

Next Topic

Book Contents

Book Index

Control-M/EM general parameters

The following table describes Control-M/EM general system parameters in the CCM.

Parameter

Description

act_chk_inpermitt_gcs_gui

Do not modify this parameter unless requested by BMC Software Customer Support.

Default: N

ActivateApplications4NonAdmin

Determines whether to activate applications for users who do not have administrator rights.

Valid Values:

  • 1: On
  • 0: Off

Default: 1

AlertsLimit

Limits the number of alerts

NOTE: If the value is set to 0, the Control-M client shows unlimited number of alerts.

AllowListEMUserNames

Determines whether users can view a list of user names (used by Control-M for AFT configuration plug-in).

Valid values:

  • 0 - Not permitted
  • 1 - Permitted (default)

AnnotationDefaultCategory

Sets the default value when an annotation description is missing.

Default: Utility

AnnotationDefaultNote

Sets the default value when an annotation note is missing

Default: Command line utility invocation

ApplicationFieldIsMandatory

Determines whether the Application field is mandatory for job definition.

Valid values:

  • 0 - Not mandatory
  • 1 - Mandatory

Default: 0

ApplyAnnotationForAuditContext

Specifies the activities that require user annotations.

Valid values:

  • ALL – All of the activities listed below
  • NONE – None of the activities listed below
  • AUTH – Authentication (logon tries, logouts, password actions)
  • SCHED – Scheduling definition activities
  • J_CONT – Active network activities (control requests)
  • J_INFO – Active job information activities (order, force, hold ...)
  • RES – Quantitative and Control resource activities
  • ALERT – Alerts
  • ACCOUNT – Account management activities
  • OPER – Start and stop components using the Control-M
  • Configuration Manager
  • CONFIG – Configuration operations from Control-M Configuration
  • Manager
  • CTMSEC – Control-M/Server security interface using Control-M
  • Configuration Manager
  • DB_MAINT – Database maintenance operations using Control-M
  • Configuration Manager

Default: AUTH SCHED J_CONT J_INFO RES ALERT ACCOUNT

OPER CONFIG CTMSEC DB_MAINT

AuditCleanupIntervalMinutes

When cleanup of audit information from the Control-M/EM database is automatic, this parameter specifies the interval, in minutes, at which the GUI Server performs its cleanup operations.

Valid values: 60 and up

Default: 360 (minutes)

AuditCleanupOn

Specifies whether cleanup of audit information from the Control-M/EM database should occur automatically.

Note: When automatic cleanup of audit information is activated, the GUI Server first waits the specified number of minutes (as specified in the AuditCleanupIntervalMinutes system parameter) before cleaning the auditing table the first time.

Valid values:

  • 0: Cleanup is performed manually by the user as necessary
  • 1: Cleanup is automatic

Default: 1

AuditFullDefinitionChanges

Determines whether to audit all changes to the job definition when it is updated.

Valid values: 0,1

Default: 1 - Audit all changes when job definition is updated

AuditHistoryDays

When cleanup of audit information from the Control-M/EM database is automatic, this parameter specifies the number of days that audit information is retained before being cleaned from the Control-M/EM database.

Minimum values: 1

Default: 7

AuthenticationMethod

Name of the external authentication plug-in.

Default: null (for internal Control-M/EM authentication)

AutomaticOrderMethodByDefault

Determines whether the default for folders that are created by Order Method is automatic or manual.

Valid values:

  • 1: Automatic Order Method (Daily)
  • 0: None (Manual Order)

Default: 1

bulk_def_size

Default bulk size for database bulk operation.

Valid values: 10-10000

Default: 100

bulk_def_storage_len

Default value for storage length in bulk operation. Must be at least as long as the longest field involved in the bulk operation.

Default: 264

CentralDeployLocation

Defines a network location where the installation packages for Agent Deployment are saved.

NOTE: After you defined the value for this parameter, restart the Control-M/EM Configuration Agent.

Default: Empty

ChallengeResponseTimeout

Time interval in seconds after the server issues a request and receives a response from the client. If a response is not received during this interval, the server sends a FAILURE message and terminates the communication.

Default: 60

CheckDifferentHosts

Identifies if the component with the same name should be checked on other machines when registering in the Database.

Valid Values:

  • 1: The component is checked
  • 0: The component is not checked

Default: 1

CheckLimitsSwitch

Determines whether to check if OS resource limits are set appropriately.

Valid values:

  • 1: On
  • 0:Off

Default: 1

CGSCommUserIGd

Defines the ID that GCS uses to identify itself to Convrol-M. This user must be defined in the Control-M with add or delete condition privileges.

Valid values: <String expression>.

Default: GCSERV

ClientSSO

Determines whether the Disable SSO mode checkbox appears in the Control-M login window.

Default: Off

Valid values:

  • On
  • Off

CollectEMStatistics

Determines whether the Control-M/EM Statistics collection mechanism is on or off.

Valid values:

  • 0: Off
  • 1: On

Default: 1

CollectStatisticsByField

Specifies the job field by which statistics are collected for distributed jobs.

Valid values: Control-M job definition fields

Default: Jobname

 

CollectzOSUserDaily

Specifies whether the Gateway automatically requests updates from

Control-M for z/OS for the following information:

  • ordered jobs
  • table list
  • user daily list

The information is saved in the Control-M/EM database.

Valid values:

  • 0 - No requests are sent
  • 1 - Requests are sent

Default: 1

ConsiderDSN

Specifies whether the ordering job and table keys (used when sending job ordering information from Control-M for z/OS to the Gateway) includes dataset names. Typically, the dataset name is changed for each job order.

Valid values:

  • 0 - Do not include the dataset name
  • 1 - Include the dataset name

Default: 1

ControlM_EM_Version

Specifies the Control-M/Enterprise Manager version.

ControlResourceForSMARTTable

Enables definition of Control Resources for SMART and Sub folders in Control-M Servers from release 7.0.00.200, however Control-M/EM clients of versions lower than 7.0.00.300 , can not login to the Control-M/Enterprise Manager.

Valid values:

  • 1: On
  • 0: Off

Default: 0

CTMSyncExceptions

Excludes folders from automatic synchronization (upload/download/delete) by the Gateway where the synchronization mode is set to No Synchronization.

EXAMPLE: If the Control-M synchronization mode is set to Update Control-M/Server and Control-M/EM and this parameter is defined as "A*,B*" folders that start with A or B are not downloaded automatically from Control-M/Server to Control-M/EM and are not uploaded automatically from Control-M/EM to Control-M/Server.

You can set this parameter for each Control-M/Server separately or for all (*).

Valid values: A valid regular expression (see Pattern matching strings).

Default: Empty (no exceptions).

If you modify the value, you must recycle the GUI Server and the Gateway components.

DatabaseCheckInterval

Amount of time between database availability checks by certain server components.

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

Default: 10

DatabasePoolSize

Determines the maximum number of connections to the database retained in the connection pool of each server component.

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

Default: 5

DatabaseRetries

The maximum number of attempts by a server component to perform certain actions with the database.

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

Default: 10

DatabaseRetryInterval

The amount of time between the attempts set in DatabaseRetries.

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

Default: 10

DataSegmentLimitGB

Specifies the data segment size limit in GB.

Default: 2

DefaultAverageTime

Average run time for jobs with no statistics. This value is often used if no statistics are available.

Valid values: Any valid time, entered in the following format: MM:SS

Default: 00:05

DefaultCTMExcludeRBC

Determines Excluded Rule-based Calendar (RBC) support in a newly defined Control-M/Server. The value is overridden by the value set in the Control-M/Server system parameter EXCLUDE_RBC_ENABLED.

Valid values:

  • Y - Supports Excluded RBC in a defined Control-M/Server
  • N - Does not support Excluded RBC in a defined Control-M/Server

Default: Y

If this feature was disabled during the fix pack installation, you need to change RBC names that start with ! and run the enable_exclude_rbc.pl perl script from the <scripts> directory.

DeleteChunkSize

Maximum number of rows to be deleted by a single SQL statement, used by purge_runinfo and erase_audit_data scripts.

Default: 10,000

Valid values: A whole number equal to or greater than 1.

DirectoryConnRefreshTime

Specifies the time interval, in seconds, passed from last refresh, after which EM refreshes LDAP connection during authentication.

Valid values: 1-60 seconds

Default: 45

DirectoryDefaultDomain

Specifies the default LDAP directory domain name for user authentication

DirectoryServiceAuth

Determines the Directory Service mode for authentication purposes.

Valid values:

  • On - LDAP authentication is used
  • Off - Control-M/EM authentication is used

Default: Off

DirectoryServerChaseRef

Determines if LDAP search action should chase referrals suggested by the server.

Valid values:

  • 1:On
  • 0:Off

Default: 0

DirectoryServerConnAttempts

Specifies the maximum unsuccessful connection attempts allowed to the LDAP server.

Default: 3

DirectoryServerHostPort

The full domain name of the host on which the LDAP server is installed and the port on which to communicate with the LDAP server.

Format: full domain name:port number

Example: CTMhost1.DOMAIN1.level1:389

Default: <null>

Note: Multiple LDAP servers can be defined. This enables Control-M/EM to perform authentication against backup LDAP servers when the primary server is unavailable.

DirectoryServiceSpecialChar

Sets the list of characters considered to be special in LDAP.

Default: \()

DirectoryServiceTimeout

Sets the time interval in seconds for which EM waits for LDAP actions return.

Valid values: 1-60 seconds

Default:10

DirectoryServiceUseEscChar

Determines if the escape character should be overridden in Directory Service when sending the search string.

Valid values:

  • 1: On
  • 0: Off

Default: 1

DirectorySearchUserDN

Stores the LDAP Domain Name (DN) credentials for a special user who has read access to the directory. This parameter is mandatory if the value of the DirectoryServiceType parameter is Active Directory, otherwise it is optional.

If no value is used, the parameter value is interpreted as an anonymous user (Default).

Valid values:Either the URL notated definition of the user ID or its DN.

EXAMPLE:

  • jsmith@PRODUCTION.bmc.com
  • cn=Schemp Anderson, o=family, c=US, dc=hotmail, dc=com

DirectorySearchUserPwd

Stores the LDAP password for the search user defined in the DirectorySearchUserDN parameter who has read access to the directory. Optional if the value of the DirectorySearchUserID parameter is empty or anonymous.

Valid Values: The value is an encrypted password string. which is entered into the parameter value field as regular text and is then converted to an encrypted string before being stored in the database. Thereafter, the displayed value is the encrypted string whenever the parameter is accessed in the System Parameters window. If no value is used, the parameter value is interpreted as blank (Default).

DirectoryServiceType

Defines the LDAP directory type or vendor that is available to the enterprise, for example, Active Directory, iPlanet, Apache Directory. This definition points to the relevant parameter load section in the DirectoryServiceType.cfg configuration file in the ctm_em/etc. The value of this parameter should be listed in this file. By default, two default directory service types (Active Directory and iPlanet) are provided in the configuration file. The default value of this parameter is Active Directory.

DirectoryServiceValidation

Determines the validation level of Directory Service parameters when connecting to LDAP.

Valid values:

  • 0: Specifies that validation is not performed
  • 1: Specifies that only the fields defined in the CCM LDAP configuration window should be validated for existence.

    When LDAP authentication is applied directly on users defined in Control-M/EM Authorizations, LDAP Directory Search User and LDAP Directory Search Base parameters are optional. In all other cases, at least one of these parameters must be used.

  • 2: Specifies that all the fields defined in the CCM LDAP configuration window and the parameters defined in the DirectoryServiceType.cfg file should be validated for successful LDAP access and implementation.

Default: 1

Refresh type: manual

The best configuration duration time can be achieved by setting this parameter to bypass validation actions during Control-M/EM startup or LDAP activation. This can be done after validating your configuration at least once to ascertain that all the configuration values are valid.

DirectoryServerProtocol

Determines the security level of communication with the Directory Server.

Valid values:

  • TCP
  • SSL

Default: TCP

DirectoryUsersSearchRoot

Defines the starting point (domain, country, and so on) in the directory tree structure. The domain name values in this field supports both dot separated or DN format, For example, "PRODUCTION.bmc.com" or "c=us, o=acme, dc=root". You can define multiple starting leafs by separating them with colons (":"). The lookup order is from left to right, according to the domain list order.

If the value of this parameter is NULL then a default value will be used, only if the DirectorySearchUserDN parameter is not blank. The DirectoryUsersSearchRoot parameter can only be left blank if the DirectorySearchUserDN has a configured value. The default value of DirectoryUsersSearchRoot is the domain of the search user. For example, if the DirectorySearchUserDN parameter value is "jsmith@PRODUCTION.bmc.com", then the default value of DirectoryUsersSearchRoot parameter would be "PRODUCTION.bmc.com".

EmailSender

Defines the email address that issues the high availability alert.

EmailServer

Defines the E-mail server that is used to send notifications emails to Control-M Workload Change Manager end users.

EmailRecipients

Defines the email addresses that receive the high availability alerts.

The email addresses must be separated by a comma.

EnableLoadBalancerRouter

Enables you to define a third party Network Load Balancer Router, which sends the jobs to specific Control-M/Agents according to its own load balancing definitions.

Valid Values:

  • True
  • False

Default: False

EnableRemoteBrowsing

Enables you to browse for a script in a file system on a Control-M/Agent node from the job properties pane.

Valid values:

  • Y
  • N

Default: Y

Environment Title

Defines the logical name for the Control-M/EM environment, which appears in the Control-M title bar.

Valid values: Any. Free Text field

GCSCommUserId

Defines the ID that GCS uses to identify itself to Control-M. This user must be defined in the Control-M/Server with Add or Delete permissions.

Default: GCSERV

GlobalCondsTimestampActivation

Sends a Timestamp with every Global condition action (Add or Delete condition).

Valid Values:

  • 0: Disables the feature
  • 1: Enables the feature

Default: 0

NOTE: You should only enable the feature if is supported by Control-M/Server.

HandleAlertsOnRerun

Determines how to handle alerts when a job is rerun.

Valid values:

  • 0: Alerts for this job that are in the Alerts window before the job is rerun are not automatically changed to HANDLED. If the rerun fails, a new alert is displayed in the Alerts window.
  • 1: Alerts for this job that are in the Alerts window before the job is rerun are automatically changed to HANDLED.

Default: 0

HostPort

Defines the hostname and port number or a port range for all components.

NOTE: If you want to define a different host and port/port range for each component instance, you need create additional HostPort system parameters, as described in Defining Control-M/EM system parameters.

Format:

  • Port:<hostname>:<port number> (CTMhost1:1530)
  • Port range:<hostname>:<fromPort-toPort> (CTMhost1:1520-1540)

I18N

Indicates whether the system is configured for CJK languages or Latin1 languages.

Warning: This parameter is automatically set during installation, according to the specified choices, and must not be changed manually.

For more information, see Control-M Installation

Valid values:

  • cjk
  • latin1

Default: latin1 or cjk

IPV_MODE

Determines whether to enable IPV6.

Valid Values:

  • IPV4
  • DUAL (Enables IPV6)

Default: IPV4

How / where to set: In the config.dat file of Control-M/Server and the CONFIG.dat file of Control-M/Agent, set the IPV_MODE parameter to DUAL and then restart both Control-M/Server and Control-M/Agent.

NOTE: If Control-M/Server and/or Control-M/Agent.are installed on AIX, verify that the fix for APAR IV23320 is installed.

If you want to enable IPV6 before installation, see Setting environment variables in UNIX.

Language

Language for the Control-M/EM application. These values are not case-sensitive.

Valid values:

  • use_account_locale — language set for the account and computer us_english
  • english
  • german
  • french
  • spanish

Default: use_account_locale

LimitGCDistribActivate

Enables and disables limitations on the distribution of global conditions using the Global Conditions Distribution facility.

Valid values:

  • _ 1 – The Global Conditions Distribution facility distributes global

conditions according to limitations defined using the LimitGCSDistribMaxDays and LimitGCSDistribExcludeDates parameters.

  • _ 0 – The Global Conditions Distribution facility imposes no

limitations on the distribution of global conditions.

Default: _1

LimitGCDistribExcludeDates

Dates for which global conditions are distributed, regardless of limitations specified using the LimitGCSDistribMaxDays parameter. Dates are specified in mmdd format and separated with commas.

Default: STAT

LimitGCDistribMaxDays

The range of days within which conditions can be distributed.

Valid values: 1-28

Default: 7

LMGUI_Communication_Cfg

License Manager address. Not yet implemented.

Default: null

LockAccountForMinutes

Time interval, in minutes, after which an account that was automatically locked is automatically unlocked. (Accounts locked by an administrator are not unlocked automatically.) If set to 0, the account is not automatically unlocked but an administrator can manually unlock it.

Valid values:Positive integer values

Default: 0

MainEMServiceContext

Determines the logical name context of GUI Server that the Control-M Self Service Web server must connect to.

Valid values: GUI Server logical name

Default: Empty

MaxAuditsToDelete

When cleanup of audit information from the Control-M/EM database is automatic, this parameter specifies the maximum number of audit records to delete during each automatic cleanup operation. If the number of audit records to clean is higher than this number, no records are deleted and a message is issued to the GUI Server diagnostic log asking you to clean audit records manually using the erase_audit_data script.

Valid values:Positive integer values

Default: 2000

MaxDaysAlertRetained

Defines the number of days the alert is retained in the database.

Default: 30

MaxRecentItemsInList

Defines the number of recent items in any list.

Default: 40

MaxPasswordLength

The maximum number of characters for user passwords.

Note: If a Control-M administrator uses the Authorization facility to set a password, this parameter is ignored.

Valid values: Any value between the MinPasswordLength and 32 (inclusive).

Default: 32

MaxTableJobsToAudit

The maximum number of jobs in the table to be audited.

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

Default: 1000

MeasurementDaysToKeep

Defines the number of days to keep collected metrics data.

Default: 90 days

MFTActiveConnectionsChartUnits

Determines the units that appear in the Bit Rate tab in the Active Connections area.

Valid values:

  • B
  • KB
  • MB
  • GB

Default: KB

MFTRefreshRate

Determines the number of seconds between each refresh in the MFT dashboard.

Default: 60

MFTTrafficLoadChartUnits

Determines the units that appear in the Volume tab in the Traffic Load area.

Valid values:

  • B
  • KB
  • MB
  • GB

Default: KB

MinPasswordLength

The minimum number of characters for user passwords.

Note: If a Control-M administrator uses the Authorization facility to set a password, this parameter is ignored.

Valid values: Any value between 1 and the MaxPasswordLength (inclusive).

Default: 6

NrHandledAlarms

The maximum number of handled alerts saved in the database (in addition to not-yet-handled alerts).

Valid Values:Positive integer values

Default: 2000

Note: When set to 0, there is no maximum number of handled alerts, and they will be deleted if they pass the threshold defined in MaxDaysAlertRetained parameter value.

NumberofConnectionAttempts

Defines the number of connection attempts between the client (CCM or Control-M) and the GUI Server for connection recovery.

Default: 5

NumberOfEstimationRunTime

Defines the maximum number of estimated run times sent from Control-M/EM Server to the client for one cyclic job.

Default: 50

NumberOfPastRunTimes

Defines the maximum number of past run times sent from Control-M/EM Server to the client for one cyclic job.

Default: 50

NumberOfFailedLogins

The number of sequential failed logins after which an account is locked.

Valid values: 0-100

Default: 0 (indicates that “automatic account locking” is not enabled and accounts are never automatically locked).

NumberOfPasswordReplacements

The number of password changes that must occur before a password can be reused (if PasswordHistoryOnOff is set to 1).

Note: If a Control-M administrator uses the Authorization facility to set a password, this parameter is ignored.

Valid values: 1-20

Default: 10

NumberOfReportDays

Determines the number of days to keep report data in the database for generating reports about services.

Valid values: 2 and higher

Default: 90

NumberOfReportDaysHistory

Determines the number of days to keep history report data in the database for generating history of services.

Valid values: 2 and higher

Default: 90

OutputAutoLoadLimit

Determines the size of output data that Control-M loads automatically. If the output data size exceeds the threshold, then the user is prompted to save the output data in a separate temporary file.

Default: 10000000

PasswordComplexityOnOff

Indicates if passwords need to comply with complexity rules.

Note: If a Control-M administrator uses the Authorization facility to set a password, this parameter is ignored.

Valid values:

  • 0 (no = off)
  • 1 (yes = on)

Default: 0

PasswordComplexityRules

One, some, or all of the following values separated by a blank space. Multiple values are joined by AND logic.

Note: If a Control-M administrator uses the Authorization facility to set a password, this parameter is ignored.

Valid values:

  • PWD_DIGIT: using digits is mandatory
  • PWD_UPPER: using letters in upper case is mandatory
  • PWD_LOW: using letters in lower case is mandatory
  • PWD_NON_LETDIG: non-alphanumeric characters are mandatory
  • PWD_DIGIT PWD_UPPER PWD_LOW PWD_NON_LETDIG: all of these rules to be satisfied. (Default)

PasswordEncode

Indicates how user passwords are transmitted by clients to the server.

Valid values:

  • 0 - Two-way encryption (encoded). Often used with External Authentication.

    When using the AES algorithm, you can use the default hard-coded string, or the string in the aes_key.txt file, if it exists in the etc directory.

  • 2 - One way encryption.EM local authentication

Default: 2

PasswordExpirationOnOff

Determines whether password expiration parameters should be checked.

Valid values:

  • 0 (off, password expiration is not checked).

Note: When set to 0, other password expiration parameters can be edited but are ignored.

  • 1 (on, password expiration is checked).

Default: 0

PasswordHistoryOnOff

Determines whether password history is recorded.

Note: If a Control-M administrator uses the Authorization facility to set a password, this parameter is ignored.

Valid values:

  • 0 (no). If set to 0, new passwords are not checked against previous passwords.
  • 1 (yes)

Default: 0

PasswordLifetimeDays

Determines the number of days before the password expires. Used in the password expiration date computation by the set_pwd_def_lifetime script.

Valid values: 1 - 365

Default: 60

PermitManualUnlock

This parameter specifies whether non-administrators can manually unlock their own tables (for example, if tables are locked during an abnormal disconnect from the GUI Server).

NOTE: Non-administrators will not be able to unlock other users’ tables.

Valid values:

  • 1 - Users can unlock their own tables
  • 0 - Only administrators can unlock the table

Default: 1

ProxyNewsfeedHostPort

Determines the host and port of the proxy server for all users connecting to the Newsfeed through a proxy server.

Valid values: <host>:<port>

EXAMPLE: Venus:13888

Default: Empty

RecentItemsRetainDays

Defines the maximum number of days recent items are retained in the database.

Default: 60

RemoteBrowseEntriesMaxLimit

Determines the maximum number of objects (files-directories) that are allowed for a Remote Browsing request.

Valid values: Any whole integer

Default: 1000

restricted_cm_admin

Determines how to manage priveliges for users and groups to access and update application plug-in connection profiles.

Valid values:

  • 0: Privileges managed by the CCM (see Privileges)
  • 1: Privileges managed by the cm_admin.xml file.

Default: 0

For more information see Authorizing non-administrators to manage application plug-in connection profiles.

RFAllowReportForJobLevelAuth

Determines whether to allow users with job level authorizations to generate reports from the Reporting Facility.

Valid values:

  • Y
  • N

Default: Y

RFPGUseDeclareFetch

Determines whether to enable the UseDeclareFetch option in Reporting Facility with PostgreSQL database.

Valid values:

  • 0: Not enabled
  • 1: Enabled

Default: 1

RunTimeDeleteHistChunkSize

Indicates the maximum number of rows in the database of historical data to be deleted, each time a deletion is performed.

Valid values:Positive integer values

Default: 25000

Note: This system parameter is relevant only if Control-M/Forecast is installed.

RunTimeDeleteHistInterval

Interval in seconds between the deletion of historical records.

Valid values:Positive integer values

Default: 21600

NOTE: This system parameter is relevant only if Control-M/Forecast is installed.

SecondsBetweenConnAttempts

Defines the time interval in seconds between connection attempts.

Default: 5

SendAlarmToScript

Full path name of the script that is activated when an alert is generated.

This script is activated only if the value of SendSnmp is either 1 or 2.

Valid values:Full path name of the script that is activated when an alert is generated.

Default: script_name

When Alert data is sent as input to a script, the parameters are sent in the following format:

call_type: "<call_type>" alert_id: "<alert_id> "

data_center: "<data_center> " memname: "<memname> "

order_id: "<order_id>" severity: "<severity>" status:

"<status> " send_time: "<send_time>" last_user:

"<last_user> " last_time: "<last_time> " message:

"<message>" run_as: "<run_as>" sub_application: "<sub_application> "

application: "<application> " job_name: "<job_name> "

host_id: "<host_id> " alert_type: "<alert_type>"

closed_from_em: "<closed_from_em> " ticket_number:

"<ticket_number> " run_counter: "<run_counter> "

notes: “<notes>”

NOTE: The last data field is visible only if the SendAlertNotesSnmp parameter is set to 1, and in Control-M/EM 7.0.00 fix pack 2 and later.

EXAMPLE: for testing SNMP traps when enabling this parameter

On UNIX:

#!/bin/sh

echo $* > /tmp/snmptest.out

On Windows:

echo %* > c:\snmptest.out

NOTE: On Windows, double back-slashes should be used as a delimiter.

SendAlertNotesSnmp

Specifies whether Alerts NOTES data field text should be sent to SNMP and script.

Valid values:

  • 0 - field is not sent to SNMP and script
  • 1 - field is sent to SNMP and script

Default: 0

NOTE: The SendAlertNotesSnmp parameter is available for Control-M/EM 7.0.00 fix pack 2 and later.

SendPre800NamesAlarmScript

Enables you to set alert field names and to send alarm exit scripts written before Version 8.0.00.

Valid values:

  • 0: Does not enable you to set alert field names and alarm exit scripts written before version 8.0.00
  • 1: Enables you to set alert field names and alarm exit scripts written before version 8.0.00

Default: 0

SendRuntimeEstimations

Specifies whether BIM runtime information updates are sent to the GUI.

Valid values:

  • 0 - disables the Show/Hide Time field from the View tab in the Montoring domain
  • 1 - enables the Show/Hide Time field from the View tab in the Monitoring domain

Default: 0

SendSnmp

Indicates where Alert data is to be sent.

Valid values:

  • 0 - SNMP only
  • 1 - User-defined script only
  • 2 - SNMP and user-defined script

Default: 0

NOTE: Alert data is sent to SNMP (values 0 or 2) only if the value of the SnmpSendActive parameter is set to 1.

ShowNewsfeedDomain

Determines whether the Newsfeed domain appears in the Control-M client.

Valid values:

  • 0 - Hide
  • 1 - Show

Default: 1

SnmpHost

Host name or list of host names (if a list, using semi-colons (;) as delimiters) to send the SNMP trap on an alert. Specific ports can be set using a colon (:) as a delimiter.

Valid values:Valid hostname or ip address

Default: <no_host>

Example: dhost1;jhost2;myhost3:2000

SnmpSendActive

Determines whether SNMP messages for Active Alerts are generated. Valid values.

Valid values:

  • 0—SNMP messages for Active alerts are not generated
  • 1—SNMP messages for Active alerts are generated

Default: 0

SubApplicationFieldIsMandatory

Enables you to set a mandatory Sub Application field for job definition.

Valid Values:

  • 0: Not mandatory
  • 1: Mandatory

Default: 0

UnsupportedClientVersions

For BMC Software Customer Support use only.

Valid values: List of releases separated by semicolons. For example, 7.0.00.100;7.0.00.200

Default: 0

UserAuditOn

Indicates if the user will be required to enter details about the type of operation being performed and the reason for its performance, which will be saved as an annotation to the audit report, before completing the operation. UserAuditOn must be defined as 1 for UserAuditAnnotationOn to activate.

Valid values:

  • 0 (no) - When 0, the UserAuditAnnotation parameter is ignored.
  • 1 (yes)

Default: 0

Refresh Type: Manual

UseAutoReconnect

Defines the reconnection invocation method.

Valid values:

  • 1: Automatic
  • 0: Manual

Default: 1

UsezOSTimeZone

Enables the to user to override the GMT value and ignore the value sent by Control-M/Server. Relevant Control-M/server for z/OS.

Valid values:

  • 1: Override values
  • 0: Cannot override values

Default: 0

ViewSysoutHeadSizeKB

Displays the first KB of the output file.

Valid values:

  • 1: First KB of the output file
  • 0: Whole file

Default: 0

ViewSysoutTailSizeKB

Displays the last KB of the output file.

Valid values:

  • 1: Last KB of the output file
  • 0: Whole file

Default: 0

VMAdditionalJobsRelateFields

Additional job related key fields to be defined by a user.

BMC Software recommends that you not use the same job name (or mem name, in Control-M for z/OS) for multiple jobs. If you use the same name for multiple jobs, use this field to identify additional key fields that Control-M/EM can use to distinguish between different jobs with the same name/mem name, so as not to confuse or switch their job histories.

A space must be used as a delimiter between key field values:

HOST_ID OWNER CMD_LINE

Recommended Values: DESCRIPTION, MEM_LIB, HOST_ID, OWNER, DAYS_CAL, WEEKS_CAL, CONF_CAL, CMD_LINE, FROM_TIME, TO_TIME, ACTIVE_FROM, ACTIVE_TILL

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

Default: <empty>

Refresh Type: Manual

VMVersionsNumberToKeep

The number of versions of the job to keep, including the current version.

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.

BMC Software recommends not setting a value greater than 30 because of possible performance degradation.

To deactivate version history, set the parameter to 1 (keep current version only).

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

Default: 2 (current version, and one history version)

Refresh Type: Manual

WarningPasswordExpirationDays

Number of days prior to password expiration during which a warning message is generated when certain utilities or scripts are run or a successful logon occurs.

Valid values: 0-90

Default: 0 (no warning is generated)

WarningSSLExpirationDays

Number of days prior to certificate expiration during which the GUI server generates a warning message in the CCM.

Valid values: 1-365

Default: 60

WorkloadHistoryMaximumNum

Defines the Maximum number of workload versions in the database.

Default: 100

WorkspaceSharing

Enables users to view a Workspace owned by other users.

Valid values:

  • 0: Disables users to view a Workspace owned by other users
  • 1: Enables users to view a Workspace owned by other users

Default: 1

XAlertsEnableSending

Determines whether the option to send exception alerts is enabled or disabled.

Valid values:

  • 1 - Enable
  • 0 - Disable

Default: 1

XCTMDoForceAudit

Enables a XCTM Do Force Audit

Valid values:

  • Yes: Enables you to perform a Cross Control-M Job Order audit.
  • No

Default: No

XCTMDoForceRetryIntSeconds

Defines the number of seconds that Control-M/EM waits in case of temporary failure, before trying to perform the force request.

Default: 300

XCTMDoForceRetryTimeoutMinuts

Defines the number of minutes in which Control-M/EM tries to perform a force request.

Default: 1440

XCTMDoForceUser

Defines a user ID where authorization is enforced.

Default: use_job_owner

Parent Topic

Control-M/EM system parameters