コンテンツにスキップ

sonic-snmp YANG

概要

  • module: sonic-snmp
  • namespace: http://github.com/sonic-net/sonic-snmp
  • revision: 2022-05-13
  • import: ietf-inet-types
  • top container: sonic-snmp

Simple Network Management Protocol (SNMP) agent configuration YANG module for SONiC OS.1

データフロー (自動生成)

flowchart LR
  Y["sonic-snmp"]
  C1[("CONFIG_DB<br/>SNMP")]
  Y --> C1
  D1["snmp-config"]
  C1 --> D1
  C2[("CONFIG_DB<br/>SNMP_COMMUNITY")]
  Y --> C2
  C2 --> D1
  C3[("CONFIG_DB<br/>SNMP_USER")]
  Y --> C3
  C3 --> D1
  C4[("CONFIG_DB<br/>SNMP_AGENT_ADDRESS_CONFIG")]
  Y --> C4
  C4 --> D1

凡例

YANG モジュールから CONFIG_DB テーブル経由で subscribe する daemon/orch までを docs/reference/config-db-orch-map.md から機械生成したミニ図。詳細・例外は本ページ本文を参照。

関連ページ

本 YANG モジュールに対応する CONFIG_DB / CLI / HLD / Topics への相互リンク。inject_yang_xref.py により自動生成されます。

対応 CONFIG_DB

関連 CLI

ツリー

module: sonic-snmp
  +--rw sonic-snmp
     +--rw SNMP
     |  +--rw CONTACT
     |  |  +--rw Contact?    string
     |  +--rw LOCATION
     |     +--rw Location?   string
     +--rw SNMP_COMMUNITY
     |  +--rw SNMP_COMMUNITY_LIST* [name]
     |     +--rw name    string
     |     +--rw TYPE?   enumeration
     +--rw SNMP_USER
     |  +--rw SNMP_USER_LIST* [name]
     |     +--rw name                            string
     |     +--rw SNMP_USER_TYPE                  enumeration
     |     +--rw SNMP_USER_PERMISSION            enumeration
     |     +--rw SNMP_USER_AUTH_TYPE?            string
     |     +--rw SNMP_USER_AUTH_PASSWORD?        string
     |     +--rw SNMP_USER_ENCRYPTION_TYPE?      string
     |     +--rw SNMP_USER_ENCRYPTION_PASSWORD   string
     +--rw SNMP_AGENT_ADDRESS_CONFIG
        +--rw SNMP_AGENT_ADDRESS_CONFIG_LIST* [agent_ip port vrf_name]
           +--rw agent_ip    inet:ip-address
           +--rw port        union
           +--rw vrf_name    union

leaf 一覧

leaf パス 型 必須 デフォルト enum / 範囲 / leafref 説明
Contact sonic-snmp/SNMP/CONTACT/Contact string length 1..255 SNMP System Contact.
Location sonic-snmp/SNMP/LOCATION/Location string length 1..255 SNMP System Location.
name sonic-snmp/SNMP_COMMUNITY/SNMP_COMMUNITY_LIST/name string yes length 4..32 Community name (SNMPv1/v2c).
TYPE sonic-snmp/SNMP_COMMUNITY/SNMP_COMMUNITY_LIST/TYPE enumeration RO, RW Type of community, read-only or read-write.
name sonic-snmp/SNMP_USER/SNMP_USER_LIST/name string yes length 4..32 Name defining the SNMP User.
SNMP_USER_TYPE sonic-snmp/SNMP_USER/SNMP_USER_LIST/SNMP_USER_TYPE enumeration yes noAuthNoPriv, AuthNoPriv, Priv Authentication and encryption method used for the user.
SNMP_USER_PERMISSION sonic-snmp/SNMP_USER/SNMP_USER_LIST/SNMP_USER_PERMISSION enumeration yes RO, RW User permission.
SNMP_USER_AUTH_TYPE sonic-snmp/SNMP_USER/SNMP_USER_LIST/SNMP_USER_AUTH_TYPE string "" SHA, MD5, HMAC-SHA-2, または '' (noAuthNoPriv 時) Authentication type. must で USER_TYPE と整合性確認。
SNMP_USER_AUTH_PASSWORD sonic-snmp/SNMP_USER/SNMP_USER_LIST/SNMP_USER_AUTH_PASSWORD string length 0..64, must で AuthNoPriv/Priv のとき 8 文字以上 Authentication password for the user.
SNMP_USER_ENCRYPTION_TYPE sonic-snmp/SNMP_USER/SNMP_USER_LIST/SNMP_USER_ENCRYPTION_TYPE string "" DES, AES, または '' Encryption type for the user.
SNMP_USER_ENCRYPTION_PASSWORD sonic-snmp/SNMP_USER/SNMP_USER_LIST/SNMP_USER_ENCRYPTION_PASSWORD string yes length 0..64, must で Priv のとき 8 文字以上 Encryption password for the user.
agent_ip sonic-snmp/SNMP_AGENT_ADDRESS_CONFIG/SNMP_AGENT_ADDRESS_CONFIG_LIST/agent_ip inet:ip-address yes SNMP agent listening IP.
port sonic-snmp/SNMP_AGENT_ADDRESS_CONFIG/SNMP_AGENT_ADDRESS_CONFIG_LIST/port union yes inet:port-number または空文字列 SNMP agent listening port number.
vrf_name sonic-snmp/SNMP_AGENT_ADDRESS_CONFIG/SNMP_AGENT_ADDRESS_CONFIG_LIST/vrf_name union yes mgmt, Vrf<name>, または空 VRF name.

leafref / 依存

  • なし
  • unique 制約: SNMP_AGENT_ADDRESS_CONFIG_LIST の (agent_ip, port) ペアは unique

augment / deviation

  • なし

関連 CONFIG_DB / CLI

  • CONFIG_DB: SNMP|CONTACT/LOCATION, SNMP_COMMUNITY|<name>, SNMP_USER|<name>, SNMP_AGENT_ADDRESS_CONFIG|<agent_ip>|<port>|<vrf_name>
  • CLI: config snmp 系（agentaddress / community / user）

関連 YANG モジュール

意味的に関連する SONiC YANG モジュール (slug prefix / curated group / frontmatter related.yang から自動抽出):

関連リファレンス

引用元

  1. sonic-net/sonic-buildimage src/sonic-yang-models/yang-models/sonic-snmp.yang @ 9ea932ec2e18f35e58268ec2e4456b1d4afd65cd ↩