Attribute definition for the Netlsnr agent
Prev Resource type definition for the Netlsnr agent Next

Attribute definition for the Netlsnr agent

Review the description of the Netlsnr agent attributes. The agent attributes are classified as required, optional, and internal.

Table: Required attributes for Netlsnr agent lists the required attributes for Netlsnr agent. You must assign values to the required attributes.

Table: Required attributes for Netlsnr agent

Required attributes

Type and dimension

Definition

Owner

string-scalar

The Oracle user who has privileges to start or stop the listener process.

The agent also supports LDAP users as Oracle user.

Home

string-scalar

The $ORACLE_HOME path to Oracle binaries and configuration files. For example, you could specify the path as /opt/ora_home.

Do not append a slash (/) at the end of the path.

Table: Optional attributes for Netlsnr agent lists the optional attributes for Netlsnr agent. You can configure the optional attributes if necessary.

Table: Optional attributes for Netlsnr agent

Optional attributes

Type and dimension

Definition

TnsAdmin

string-scalar

The $TNS_ADMIN path to directory in which the Listener configuration file resides (listener.ora).

Default is /var/opt/oracle.

Listener

string-scalar

Name of Listener. The name for Listener is considered case-insensitive by the Netlsnr agent and the Oracle database server.

Default is LISTENER.

LsnrPwd

string-scalar

The VCS encrypted password used to stop and monitor the listener. This password is set in the Listener configuration file.

Encrypt passwords only when entering them using the command-line. Passwords must be encrypted using the VCS Encrypt utility.

EnvFile

string-scalar

Specifies the full path name of the file that is sourced by the entry point scripts. This file contains the environment variables set by the user for the Oracle listener environment such as LD_LIBRARY_PATH and so on.

The syntax for the contents of the file depends on the login shell of Owner. This file must readable by Owner. The file must not contain any prompts for user input.

IMF

integer-association

This resource-type level attribute determines whether the Netlsnr agent must perform intelligent resource monitoring. You can also override the value of this attribute at resource-level.

This attribute includes the following keys:

  • Mode: Define this attribute to enable or disable intelligent resource monitoring.

    Valid values are as follows:

    • 0 - Does not perform intelligent resource monitoring

    • 1 - Performs intelligent resource monitoring for offline resources and performs poll-based monitoring for online resources

    • 2 - Performs intelligent resource monitoring for online resources and performs poll-based monitoring for offline resources

    • 3 - Performs intelligent resource monitoring for both online and for offline resources

    Default: 3

  • MonitorFreq: This key value specifies the frequency at which the agent invokes the monitor agent function. The value of this key is an integer.

    Default: 5

    You can set this attribute to a non-zero value in some cases where the agent requires to perform poll-based resource monitoring in addition to the intelligent resource monitoring.

    After the resource registers with the AMF kernel driver, the agent calls the monitor agent function as follows:

    • After every (MonitorFreq x MonitorInterval) number of seconds for online resources

    • After every (MonitorFreq x OfflineMonitorInterval) number of seconds for offline resources

  • RegisterRetryLimit: If you enable intelligent resource monitoring, the agent invokes the netlsnr_imf_register agent function to register the resource with the AMF kernel driver. The value of the RegisterRetryLimit key determines the number of times the agent must retry registration for a resource. If the agent cannot register the resource within the limit that is specified, then intelligent monitoring is disabled until the resource state changes or the value of the Mode key changes.

    Default: 3

See Enabling and disabling intelligent resource monitoring for agents manually.

MonScript

string-scalar

Pathname to the script provided for detail monitoring. By default, the detail monitoring is enabled to monitor the listener process.

Note:

If the value of the attribute MonScript is set to an empty string, the agent disables detail monitoring.

The pathname to the supplied detail monitoring script is /opt/VRTSagents/ha/bin/Netlsnr/LsnrTest.pl.

MonScript also accepts a pathname relative to /opt/VRTSagents/ha. A relative pathname should start with "./", as in the path ./bin/Netlsnr/LsnrTest.pl.

LevelTwoMonitorFreq

integer-scalar

Specifies the frequency at which the agent for this resource type must perform second-level or detailed monitoring.

If you enabled detail monitoring, then set the value of the LevelTwoMonitorFreq attribute.

Default = 0

Encoding

string-scalar

Specifies operating system encoding that corresponds to Oracle encoding for the displayed Oracle output.

Default is "".

IntentionalOffline

For future use.

Do not change the value of this attribute.

Default = 0

Table: Internal attributes for Netlsnr agent lists the internal attribute for Netlsnr agent. This attribute is for internal use only. Veritas recommends not to modify the value of this attribute.

Table: Internal attributes for Netlsnr agent

Optional Attributes

Type and Dimension

Definition

AgentDirectory

static-string

Specifies the location of binaries, scripts, and other files related to the Netlsnr agent.

Default is /opt/VRTSagents/ha/bin/Netlsnr.

More Information

Encrypting Oracle database user and listener passwords

Prev Up Next
Resource type definition for the Netlsnr agent Home Resource type definition for the ASMInst agent