SNMP configuration.
This node and its descendants are configured in snmp-config.yaml.
- When present
-
Always.
Context
The context of snmp within the schema tree is shown. Italicised links are to other pages.
deployment-config:snmp (in snmp-config.yaml) v1-enabled v2c-enabled v3-enabled trap_type community v3-authentication agent-details notifications sgc
v1-enabled
Enables the use of SNMPv1 if set to 'true'. Note that support for SNMPv1 is deprecated and SNMP v2c should be used instead. Use of v1 is limited to Rhino only and may cause some Rhino statistics to fail to appear correctly or not at all. Set to 'false' to disable SNMPv1.
Type boolean
- Value
-
'true' or 'false'
- Default value
-
false
v2c-enabled
Enables the use of SNMPv2c if set to 'true'. Set to 'false' to disable SNMPv2c.
Related Constraints
Conditional node ../agent-details depends on this node. The Conditional expression refers to this node as ../v2c-enabled.
Conditional node ../community depends on this node. The Conditional expression refers to this node as ../v2c-enabled.
Conditional node ../notifications/system-notifications-enabled depends on this node. The Conditional expression refers to this node as ../../v2c-enabled.
Conditional node ../notifications/sgc-notifications-enabled depends on this node. The Conditional expression refers to this node as ../../v2c-enabled.
Conditional node ../trap_type depends on this node. The Conditional expression refers to this node as ../v2c-enabled.
Conditional node ../notifications/rhino-notifications-enabled depends on this node. The Conditional expression refers to this node as ../../v2c-enabled.
Conditional node ../sgc/v2c-port depends on this node. The Conditional expression refers to this node as ../../v2c-enabled.
Type boolean
- Value
-
'true' or 'false'
- Default value
-
true
v3-enabled
Enables the use of SNMPv3 if set to 'true'. Set to 'false' to disable SNMPv3.
Related Constraints
Conditional node ../v3-authentication depends on this node. The Conditional expression refers to this node as ../v3-enabled.
Conditional node ../sgc/v3-port depends on this node. The Conditional expression refers to this node as ../../v3-enabled.
Conditional node ../notifications/rhino-notifications-enabled depends on this node. The Conditional expression refers to this node as ../../v3-enabled.
Conditional node ../agent-details depends on this node. The Conditional expression refers to this node as ../v3-enabled.
Conditional node ../notifications/sgc-notifications-enabled depends on this node. The Conditional expression refers to this node as ../../v3-enabled.
Conditional node ../notifications/system-notifications-enabled depends on this node. The Conditional expression refers to this node as ../../v3-enabled.
Type boolean
- Value
-
'true' or 'false'
- Default value
-
false
trap_type
Configure the notification type to use when SNMPv2c is enabled.
Conditional
This leaf is only valid when ../v2c-enabled = 'true'.
Type enumeration
- Value
-
one of the following
| Value | Description |
|---|---|
|
Generate TRAP type notifications. |
|
Generate INFORM type notifications. |
- Default value
-
'trap'
community
The SNMPv2c community name.
Conditional
This leaf is only valid when ../v2c-enabled = 'true'.
Type string
- Value
-
a string
- Default value
-
'clearwater'
v3-authentication
See v3-authentication for details of this node and its descendants.
agent-details
See agent-details for details of this node and its descendants.
notifications
See notifications for details of this node and its descendants.
sgc
See sgc for details of this node and its descendants.
