Rhino VoLTE TAS 4.1 :: Rhino VoLTE TAS Configuration and Management Guide

Context

The context of notifications within the schema tree is shown. Italicised links are to other pages.

deployment-config:snmp (in snmp-config.yaml)
  notifications
    system-notifications-enabled
    rhino-notifications-enabled
    sgc-notifications-enabled
    targets list
      version
      host
      port
      send-rhino-notifications
      send-system-notifications
      send-sgc-notifications
    categories list
      category
      enabled

Notification configuration.

Data Validation Constraints

system-notifications-enabled = 'false' or count( BXREF LABEL MISSING: snmp-notifications#targets[] ) > 0.0

Validation Error:

You must specify whether to enable system notifications. If enabled, you must also specify at least one system notification target.

rhino-notifications-enabled = 'false' or count( BXREF LABEL MISSING: snmp-notifications#targets[] ) > 0.0

Validation Error:

You must specify whether to enable Rhino notifications. If enabled, you must also specify at least one Rhino notification target.

sgc-notifications-enabled = 'false' or count( BXREF LABEL MISSING: snmp-notifications#targets[] ) > 0.0

Validation Error:

You must specify whether to enable SGC notifications. If enabled, you must also specify at least one SGC notification target.

system-notifications-enabled

/snmp/notifications/system-notifications-enabled

Specifies whether or not system SNMP v2c/3 notifications are enabled. System notifications are: high memory and CPU usage warnings, and system boot notifications.

If you use MetaView Server to monitor your platform, then it is recommended to set this to 'false'.

This node is mandatory.

Conditional

This leaf is only valid when ../../v2c-enabled = 'true' or ../../v3-enabled = 'true'.

Related Constraints

.. has a Data Validation Constraint which references this node. The validation expression refers to this node as system-notifications-enabled.

Conditional node ../targets/send-system-notifications depends on this node. The Conditional expression refers to this node as ../../system-notifications-enabled.

Type boolean

Value: 'true' or 'false'

rhino-notifications-enabled

/snmp/notifications/rhino-notifications-enabled

Specifies whether or not Rhino SNMP v2c/3 notifications are enabled.

Applicable only when there is a Rhino node in your deployment and SNMPv2c and/or SNMPv3 are enabled.

This node is mandatory.

Conditional

This leaf is only valid when ../../v2c-enabled = 'true' or ../../v3-enabled = 'true'.

Related Constraints

Conditional node ../targets/send-rhino-notifications depends on this node. The Conditional expression refers to this node as ../../rhino-notifications-enabled.

.. has a Data Validation Constraint which references this node. The validation expression refers to this node as rhino-notifications-enabled.

Conditional node ../categories depends on this node. The Conditional expression refers to this node as ../rhino-notifications-enabled.

Type boolean

Value: 'true' or 'false'

sgc-notifications-enabled

/snmp/notifications/sgc-notifications-enabled

Specifies whether or not OCSS7 SGC SNMP v2c/3 notifications are enabled.

Applicable only when there is an SMO or an SGC node in your deployment and SNMPv2c and/or SNMPv3 are enabled.

This node is mandatory.

Conditional

This leaf is only valid when ../../v2c-enabled = 'true' or ../../v3-enabled = 'true'.

Related Constraints

.. has a Data Validation Constraint which references this node. The validation expression refers to this node as sgc-notifications-enabled.

Conditional node ../targets/send-sgc-notifications depends on this node. The Conditional expression refers to this node as ../../sgc-notifications-enabled.

Type boolean

Value: 'true' or 'false'

targets list

/snmp/notifications/targets

The list of SNMP notification targets.

Note that you can specify targets even if not using Rhino or system notifications - the targets are also used for the disk and service monitor alerts.

List Structure

version enumeration
host host
port port-number
send-rhino-notifications boolean
send-system-notifications boolean
send-sgc-notifications boolean

The keys are version and host and port.

Related Constraint

.. has a Data Validation Constraint which references this node. The validation expression refers to this node as targets.

version

/snmp/notifications/targets/version

The SNMP notification version to use for this target.

Type enumeration

Value: one of the following

Value Description

Value	Description
`v1`	SNMPv1
`v2c`	SNMPv2c
`v3`	SNMPv3

v1

SNMPv1

v2c

SNMPv2c

v3

SNMPv3

host

/snmp/notifications/targets/host

The target host.

Type host

Description

The host type represents either an IP address or a DNS domain name.

See RFC 6991 for full details.

Value

ip-address: The ip-address type represents an IPv4 address in dotted-quad notation or an IPv6 address in full, mixed, shortened, and shortened-mixed notation.

See RFC 6991 for full details.
or domain-name: The domain-name type represents a DNS domain name. The name SHOULD be fully qualified whenever possible.

See RFC 6991 for full details.

port

/snmp/notifications/targets/port

The target port, normally 162.

Type port-number

Description: The port-number type represents a 16-bit port number of an Internet transport-layer protocol such as UDP, TCP, DCCP, or SCTP.

See RFC 6991 for full details.
Value: a number in the range 0 or more

send-rhino-notifications

/snmp/notifications/targets/send-rhino-notifications

Specifies whether or not to send Rhino SNMP v2c/3 notifications to this target.

Can only be specified if ../rhino-notifications-enabled is true.

Conditional

This leaf is only valid when ../../rhino-notifications-enabled = 'true'.

Type boolean

Value: 'true' or 'false'
Default value: true

send-system-notifications

/snmp/notifications/targets/send-system-notifications

Specifies whether or not to send system SNMP v2c/3 notifications to this target.

Can only be specified if ../system-notifications-enabled is true.

Conditional

This leaf is only valid when ../../system-notifications-enabled = 'true'.

Type boolean

Value: 'true' or 'false'
Default value: true

send-sgc-notifications

/snmp/notifications/targets/send-sgc-notifications

Specifies whether or not to send SGC SNMP v2c/3 notifications to this target.

Can only be specified if ../sgc-notifications-enabled is true.

Conditional

This leaf is only valid when ../../sgc-notifications-enabled = 'true'.

Type boolean

Value: 'true' or 'false'
Default value: true

categories list

/snmp/notifications/categories

Rhino notification categories to enable or disable.

Conditional

This list is only valid when ../rhino-notifications-enabled = 'true'.

List Structure

category enumeration
enabled boolean

The key is category.

Value	Description
`alarm-notification`	Alarm related notifications.
`log-notification`	Log related notifications.
`log-rollover-notification`	Log rollover notifications.
`resource-adaptor-entity-state-change-notification`	Resource adaptor entity state change notifications.
`service-state-change-notification`	Service state change notifications.
`slee-state-change-notification`	SLEE state change notifications.
`trace-notification`	Trace notifications.
`usage-notification`	Usage notifications.

enabled

/snmp/notifications/categories/enabled

Set to 'true' to enable this category. Set to 'false' to disable.

This node is mandatory.

Type boolean

Value: 'true' or 'false'