Skip to content
AsterNOS
Ask AI

snmp

AsterNOS Model for snmp-agent

/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?   uint16

Resources

Section titled “Resources”

Resource List

Section titled “Resource List”
PathAccess
/snmpRead-Write
/snmp/globalRead-Write
/snmp/global/enabledRead-Write
/snmp/snmp-communitiesRead-Write
/snmp/snmp-communities/snmp-communityRead-Write
/snmp/snmp-communities/snmp-community/community-nameRead-Write
/snmp/snmp-communities/snmp-community/community-permissionRead-Write
/snmp/snmp-usersRead-Write
/snmp/snmp-users/snmp-userRead-Write
/snmp/snmp-users/snmp-user/user-nameRead-Write
/snmp/snmp-users/snmp-user/authen-modeRead-Write
/snmp/snmp-users/snmp-user/authen-keyRead-Write
/snmp/snmp-users/snmp-user/privacy-modeRead-Write
/snmp/snmp-users/snmp-user/privacy-keyRead-Write
/snmp/snmp-users/snmp-user/user-typeRead-Write
/snmp/snmp-users/snmp-user/permissionRead-Write
/snmp/snmp-sourcesRead-Write
/snmp/snmp-sources/snmp-sourceRead-Write
/snmp/snmp-sources/snmp-source/source-ipRead-Write
/snmp/snmp-sources/snmp-source/udp-portRead-Write
/snmp/snmp-sources/snmp-source/vrf-nameRead-Write
/snmp/snmp-trapsRead-Write
/snmp/snmp-traps/snmp-trapRead-Write
/snmp/snmp-traps/snmp-trap/trap-typeRead-Write
/snmp/snmp-traps/snmp-trap/trap-ipRead-Write
/snmp/snmp-traps/snmp-trap/vrf-nameRead-Write
/snmp/snmp-traps/snmp-trap/udp-portRead-Write
/snmp/snmp-traps/snmp-trap/community-nameRead-Write
/snmp/snmp-traps/snmp-trap/user-nameRead-Write
/snmp/system-usage-thresholdRead-Write
/snmp/system-usage-threshold/cpu-usageRead-Write
/snmp/system-usage-threshold/memory-usageRead-Write

Detailed Nodes

Section titled “Detailed Nodes”

/snmp

Section titled “/snmp”

Path

/snmp

Node Type

container

Description

SNMP(Simple Network Management Protocol) container support to set snmp-agent

Access

Read-Write

/snmp/global

Section titled “/snmp/global”

Path

/snmp/global

Node Type

container

Description

SNMP global configuration.

Access

Read-Write

/snmp/global/enabled

Section titled “/snmp/global/enabled”

Path

/snmp/global/enabled

Node Type

leaf

Description

startup or stop SNMP docker container.

Access

Read-Write

Data Type

Constraints

Valid in [true, false]

/snmp/snmp-communities

Section titled “/snmp/snmp-communities”

Path

/snmp/snmp-communities

Node Type

container

Description

SNMP agent communities list.

Access

Read-Write

/snmp/snmp-communities/snmp-community

Section titled “/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

Section titled “/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

/snmp/snmp-communities/snmp-community/community-permission

Section titled “/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

Constraints

Enumeration with options:

  • RO
  • RW

/snmp/snmp-users

Section titled “/snmp/snmp-users”

Path

/snmp/snmp-users

Node Type

container

Description

SNMP agent users list.

Access

Read-Write

/snmp/snmp-users/snmp-user

Section titled “/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

Section titled “/snmp/snmp-users/snmp-user/user-name”

Path

/snmp/snmp-users/snmp-user/user-name

Node Type

leaf

Access

Read-Write

Data Type

Constraints

String with length: 1 to 32

/snmp/snmp-users/snmp-user/authen-mode

Section titled “/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

Constraints

Multiple constraints:

  • Enumeration with options:
  • MD5
  • SHA
  • When condition: ../user-type != ‘noAuthNoPriv’

/snmp/snmp-users/snmp-user/authen-key

Section titled “/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

Constraints

Multiple constraints:

  • When condition: ../authen-mode
  • String with length: 8 to 64

Mandatory

Yes

/snmp/snmp-users/snmp-user/privacy-mode

Section titled “/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

Constraints

Multiple constraints:

  • When condition: ../authen-mode and ../user-type = ‘Priv’
  • Enumeration with options:
  • DES
  • AES

/snmp/snmp-users/snmp-user/privacy-key

Section titled “/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

Constraints

Multiple constraints:

  • When condition: ../privacy-mode
  • String with length: 8 to 64

Mandatory

Yes

/snmp/snmp-users/snmp-user/user-type

Section titled “/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

Constraints

Enumeration with options:

  • noAuthNoPriv
  • AuthNoPriv
  • Priv

/snmp/snmp-users/snmp-user/permission

Section titled “/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

Constraints

Enumeration with options:

  • RO
  • RW

/snmp/snmp-sources

Section titled “/snmp/snmp-sources”

Path

/snmp/snmp-sources

Node Type

container

Description

SNMP agent sources list.

Access

Read-Write

/snmp/snmp-sources/snmp-source

Section titled “/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

Section titled “/snmp/snmp-sources/snmp-source/source-ip”

Path

/snmp/snmp-sources/snmp-source/source-ip

Node Type

leaf

Access

Read-Write

Data Type

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

Section titled “/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

Constraints

Valid range: 0 to 65535

/snmp/snmp-sources/snmp-source/vrf-name

Section titled “/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

Constraints

LeafRef pointing to: asternos-vrf:vrf-ref

/snmp/snmp-traps

Section titled “/snmp/snmp-traps”

Path

/snmp/snmp-traps

Node Type

container

Description

SNMP agent traps list.

Access

Read-Write

/snmp/snmp-traps/snmp-trap

Section titled “/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

Section titled “/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

Constraints

Enumeration with options:

  • v1
  • v2c
  • v3

/snmp/snmp-traps/snmp-trap/trap-ip

Section titled “/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

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

Section titled “/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

Constraints

LeafRef pointing to: asternos-vrf:vrf-ref

/snmp/snmp-traps/snmp-trap/udp-port

Section titled “/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

Constraints

Valid range: 0 to 65535

/snmp/snmp-traps/snmp-trap/community-name

Section titled “/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

Constraints

When condition: ../trap-type = ‘v1’ or ../trap-type = ‘v2c’

/snmp/snmp-traps/snmp-trap/user-name

Section titled “/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

Constraints

When condition: ../trap-type = ‘v3’

Mandatory

Yes

/snmp/system-usage-threshold

Section titled “/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

Section titled “/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

Constraints

Valid range: 0 to 100

/snmp/system-usage-threshold/memory-usage

Section titled “/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

Constraints

Valid range: 0 to 100