snmp
AsterNOS Model for snmp-agent
YANG Tree Diagram
/home/admin/jenkins/workspace/asternos-mgmt_dev_campus/doc/resource/yang/asternos-snmp.yang:137: error: unexpected keyword "description"
module: asternos-snmp
+--rw snmp
+--rw global
| +--rw enabled? boolean
+--rw snmp-communities
| +--rw snmp-community* [community-name]
| +--rw community-name string
| +--rw community-permission? enumeration
+--rw snmp-users
| +--rw snmp-user* [user-name]
| +--rw user-name string
| +--rw authen-mode? enumeration
| +--rw authen-key string
| +--rw privacy-mode? enumeration
| +--rw privacy-key string
| +--rw user-type? enumeration
| +--rw permission? enumeration
+--rw snmp-sources
| +--rw snmp-source* [source-ip udp-port vrf-name]
| +--rw source-ip inet:ip-address-no-zone
| +--rw udp-port uint16
| +--rw vrf-name vrf:vrf-ref
+--rw snmp-traps
| +--rw snmp-trap* [trap-type]
| +--rw trap-type enumeration
| +--rw trap-ip inet:ip-address-no-zone
| +--rw vrf-name? vrf:vrf-ref
| +--rw udp-port? uint16
| +--rw community-name? string
| +--rw user-name string
+--rw system-usage-threshold
+--rw cpu-usage? uint16
+--rw memory-usage? uint16Resources
Resource List
Path | Access |
|---|---|
/snmp | Read-Write |
/snmp/global | Read-Write |
/snmp/global/enabled | Read-Write |
/snmp/snmp-communities | Read-Write |
/snmp/snmp-communities/snmp-community | Read-Write |
/snmp/snmp-communities/snmp-community/community-name | Read-Write |
/snmp/snmp-communities/snmp-community/community-permission | Read-Write |
/snmp/snmp-users | Read-Write |
/snmp/snmp-users/snmp-user | Read-Write |
/snmp/snmp-users/snmp-user/user-name | Read-Write |
/snmp/snmp-users/snmp-user/authen-mode | Read-Write |
/snmp/snmp-users/snmp-user/authen-key | Read-Write |
/snmp/snmp-users/snmp-user/privacy-mode | Read-Write |
/snmp/snmp-users/snmp-user/privacy-key | Read-Write |
/snmp/snmp-users/snmp-user/user-type | Read-Write |
/snmp/snmp-users/snmp-user/permission | Read-Write |
/snmp/snmp-sources | Read-Write |
/snmp/snmp-sources/snmp-source | Read-Write |
/snmp/snmp-sources/snmp-source/source-ip | Read-Write |
/snmp/snmp-sources/snmp-source/udp-port | Read-Write |
/snmp/snmp-sources/snmp-source/vrf-name | Read-Write |
/snmp/snmp-traps | Read-Write |
/snmp/snmp-traps/snmp-trap | Read-Write |
/snmp/snmp-traps/snmp-trap/trap-type | Read-Write |
/snmp/snmp-traps/snmp-trap/trap-ip | Read-Write |
/snmp/snmp-traps/snmp-trap/vrf-name | Read-Write |
/snmp/snmp-traps/snmp-trap/udp-port | Read-Write |
/snmp/snmp-traps/snmp-trap/community-name | Read-Write |
/snmp/snmp-traps/snmp-trap/user-name | Read-Write |
/snmp/system-usage-threshold | Read-Write |
/snmp/system-usage-threshold/cpu-usage | Read-Write |
/snmp/system-usage-threshold/memory-usage | Read-Write |
Detailed Nodes
/snmp
Path
/snmp
Node Type
container
Description
SNMP(Simple Network Management Protocol) container support to set snmp-agent
Access
Read-Write
/snmp/global
Path
/snmp/global
Node Type
container
Description
SNMP global configuration.
Access
Read-Write
/snmp/global/enabled
Path
/snmp/global/enabled
Node Type
leaf
Description
startup or stop SNMP docker container.
Access
Read-Write
Data Type
<YANG type boolean>
Constraints
Valid in [true, false]
/snmp/snmp-communities
Path
/snmp/snmp-communities
Node Type
container
Description
SNMP agent communities list.
Access
Read-Write
/snmp/snmp-communities/snmp-community
Path
/snmp/snmp-communities/snmp-community
Node Type
list
Description
SNMP agent community configuration.
Access
Read-Write
/snmp/snmp-communities/snmp-community/community-name
Path
/snmp/snmp-communities/snmp-community/community-name
Node Type
leaf
Description
SNMP agent community name, 'public' is the default value.
Access
Read-Write
Data Type
<YANG type string>
/snmp/snmp-communities/snmp-community/community-permission
Path
/snmp/snmp-communities/snmp-community/community-permission
Node Type
leaf
Description
permission of the snmp community.
Access
Read-Write
Data Type
<YANG type enumeration>
Constraints
Enumeration with options:
- RO
- RW
/snmp/snmp-users
Path
/snmp/snmp-users
Node Type
container
Description
SNMP agent users list.
Access
Read-Write
/snmp/snmp-users/snmp-user
Path
/snmp/snmp-users/snmp-user
Node Type
list
Description
SNMP agent user configuration.
Access
Read-Write
/snmp/snmp-users/snmp-user/user-name
Path
/snmp/snmp-users/snmp-user/user-name
Node Type
leaf
Access
Read-Write
Data Type
<YANG type string>
Constraints
String with length: 1 to 32
/snmp/snmp-users/snmp-user/authen-mode
Path
/snmp/snmp-users/snmp-user/authen-mode
Node Type
leaf
Description
Enables authentication of the user.
Access
Read-Write
Data Type
<YANG type enumeration>
Constraints
Multiple constraints:
- Enumeration with options:
- MD5
- SHA
- When condition: ../user-type != 'noAuthNoPriv'
/snmp/snmp-users/snmp-user/authen-key
Path
/snmp/snmp-users/snmp-user/authen-key
Node Type
leaf
Description
The key used in MD5 or SHA based authentication algorithms for user authentication.
Access
Read-Write
Data Type
<YANG type string>
Constraints
Multiple constraints:
- When condition: ../authen-mode
- String with length: 8 to 64
Mandatory
Yes
/snmp/snmp-users/snmp-user/privacy-mode
Path
/snmp/snmp-users/snmp-user/privacy-mode
Node Type
leaf
Description
Enables privacy related configuration of the user.
Access
Read-Write
Data Type
<YANG type enumeration>
Constraints
Multiple constraints:
- When condition: ../authen-mode and ../user-type = 'Priv'
- Enumeration with options:
- DES
- AES
/snmp/snmp-users/snmp-user/privacy-key
Path
/snmp/snmp-users/snmp-user/privacy-key
Node Type
leaf
Description
A secret key used by the DES or AES based encryption algorithm for authentication password.
Access
Read-Write
Data Type
<YANG type string>
Constraints
Multiple constraints:
- When condition: ../privacy-mode
- String with length: 8 to 64
Mandatory
Yes
/snmp/snmp-users/snmp-user/user-type
Path
/snmp/snmp-users/snmp-user/user-type
Node Type
leaf
Description
The Authentication type, which contain 3 ways, noAuthNoPriv(no key) and AuthNoPriv(only auth key) and Priv(both auth and priv keys)
Access
Read-Write
Data Type
<YANG type enumeration>
Constraints
Enumeration with options:
- noAuthNoPriv
- AuthNoPriv
- Priv
/snmp/snmp-users/snmp-user/permission
Path
/snmp/snmp-users/snmp-user/permission
Node Type
leaf
Description
permission of the snmp user agent.
Access
Read-Write
Data Type
<YANG type enumeration>
Constraints
Enumeration with options:
- RO
- RW
/snmp/snmp-sources
Path
/snmp/snmp-sources
Node Type
container
Description
SNMP agent sources list.
Access
Read-Write
/snmp/snmp-sources/snmp-source
Path
/snmp/snmp-sources/snmp-source
Node Type
list
Description
SNMP agent source configuration.
Access
Read-Write
/snmp/snmp-sources/snmp-source/source-ip
Path
/snmp/snmp-sources/snmp-source/source-ip
Node Type
leaf
Access
Read-Write
Data Type
<YANG type ip-address-no-zone>
Constraints
Multiple constraints:
- An IPv6 address without a zone index. This type, derived from the type ipv6-address, may be used in situations where the zone is known from the context and no zone index is needed.
- An IPv4 address without a zone index. This type, derived from the type ipv4-address, may be used in situations where the zone is known from the context and no zone index is needed.
/snmp/snmp-sources/snmp-source/udp-port
Path
/snmp/snmp-sources/snmp-source/udp-port
Node Type
leaf
Description
Set snmp source udp port, default: 161
Access
Read-Write
Data Type
<YANG type uint16>
Constraints
Valid range: 0 to 65535
/snmp/snmp-sources/snmp-source/vrf-name
Path
/snmp/snmp-sources/snmp-source/vrf-name
Node Type
leaf
Description
Set snmp source vrf, default: default(if use default, will set '' in CONFIG_DB)
Access
Read-Write
Data Type
<YANG type vrf-ref>
Constraints
LeafRef pointing to: asternos-vrf:vrf-ref
/snmp/snmp-traps
Path
/snmp/snmp-traps
Node Type
container
Description
SNMP agent traps list.
Access
Read-Write
/snmp/snmp-traps/snmp-trap
Path
/snmp/snmp-traps/snmp-trap
Node Type
list
Description
SNMP agent trap configuration.
Access
Read-Write
/snmp/snmp-traps/snmp-trap/trap-type
Path
/snmp/snmp-traps/snmp-trap/trap-type
Node Type
leaf
Description
SNMP agent trap type.
Access
Read-Write
Data Type
<YANG type enumeration>
Constraints
Enumeration with options:
- v1
- v2c
- v3
/snmp/snmp-traps/snmp-trap/trap-ip
Path
/snmp/snmp-traps/snmp-trap/trap-ip
Node Type
leaf
Description
SNMP agent trap ip address.
Access
Read-Write
Data Type
<YANG type ip-address-no-zone>
Constraints
Multiple constraints:
- An IPv6 address without a zone index. This type, derived from the type ipv6-address, may be used in situations where the zone is known from the context and no zone index is needed.
- An IPv4 address without a zone index. This type, derived from the type ipv4-address, may be used in situations where the zone is known from the context and no zone index is needed.
Mandatory
Yes
/snmp/snmp-traps/snmp-trap/vrf-name
Path
/snmp/snmp-traps/snmp-trap/vrf-name
Node Type
leaf
Description
Set snmp trap vrf
Access
Read-Write
Data Type
<YANG type vrf-ref>
Constraints
LeafRef pointing to: asternos-vrf:vrf-ref
/snmp/snmp-traps/snmp-trap/udp-port
Path
/snmp/snmp-traps/snmp-trap/udp-port
Node Type
leaf
Description
SNMP agent trap udp port, default: 162
Access
Read-Write
Data Type
<YANG type uint16>
Constraints
Valid range: 0 to 65535
/snmp/snmp-traps/snmp-trap/community-name
Path
/snmp/snmp-traps/snmp-trap/community-name
Node Type
leaf
Description
SNMP agent trap community name.
Access
Read-Write
Data Type
<YANG type string>
Constraints
When condition: ../trap-type = 'v1' or ../trap-type = 'v2c'
/snmp/snmp-traps/snmp-trap/user-name
Path
/snmp/snmp-traps/snmp-trap/user-name
Node Type
leaf
Description
SNMP agent trap user name.
Access
Read-Write
Data Type
<YANG type string>
Constraints
When condition: ../trap-type = 'v3'
Mandatory
Yes
/snmp/system-usage-threshold
Path
/snmp/system-usage-threshold
Node Type
container
Description
SNMP system usage threshold configuration.
Access
Read-Write
/snmp/system-usage-threshold/cpu-usage
Path
/snmp/system-usage-threshold/cpu-usage
Node Type
leaf
Description
when cpu usage up to the threshold, the overload msg will be trapped
Access
Read-Write
Data Type
<YANG type uint16>
Constraints
Valid range: 0 to 100
/snmp/system-usage-threshold/memory-usage
Path
/snmp/system-usage-threshold/memory-usage
Node Type
leaf
Description
when memory usage up to the threshold, the overload msg will be trapped
Access
Read-Write
Data Type
<YANG type uint16>
Constraints
Valid range: 0 to 100