SNMP

This schema extension contains models for SNMP Communities and SNMP Clients. A community links to the devices it is configured on; any further wiring, to a tenant for instance, is left to you.

Details

• Dependencies:
  • base

Nodes

CommunityV2

• Label: SNMP v1/v2c
• Description: SNMP v1/v2c community configuration.
• Namespace: Snmp
• Icon: iconoir:community
• Human Friendly ID: name__value
• Inherit From: SnmpCommunity

Attributes

name	description	kind	optional	default_value	choices
community_string		Password	False
access		Dropdown	False		read_only, read_write

CommunityV3

• Label: SNMP v3
• Description: SNMP version 3 configuration with enhanced security.
• Namespace: Snmp
• Icon: iconoir:community
• Human Friendly ID: name__value
• Inherit From: SnmpCommunity

Attributes

name	description	kind	optional	default_value	choices
username		Text	False
auth_protocol		Dropdown	False		none, md5, sha
auth_password		Password	True
privacy_protocol		Dropdown	False		none, des, aes
privacy_password		Password	True
security_level		Dropdown	False		no_auth_no_priv, auth_no_priv, auth_priv

Client

• Label: SNMP Client
• Description: Represents an SNMP client that interacts with SNMP Community.
• Namespace: Snmp
• Icon: ph:user-list-light
• Human Friendly ID: name__value

Attributes

name	description	kind	optional	default_value	choices
name		Text	False
client_description		Text	True

Relationships

name	peer	optional	cardinality	kind
ip_addresses	IpamIPAddress	True	many	Attribute
communities	SnmpCommunity	True	many	Attribute

Generics

Community

• Label: SNMP Community
• Description: Generic model for SNMP community configurations.
• Namespace: Snmp
• Icon: iconoir:community
• Human Friendly ID: name__value

Attributes

name	description	kind	optional	default_value	choices
name		Text	False
description		Text	True

Relationships

name	peer	optional	cardinality	kind
clients	SnmpClient	True	many	Component
devices	DcimGenericDevice	True	many	Attribute

Code

version: '1.0'
generics:
- name: Community
  namespace: Snmp
  description: Generic model for SNMP community configurations.
  label: SNMP Community
  icon: iconoir:community
  include_in_menu: true
  human_friendly_id:
  - name__value
  order_by:
  - name__value
  display_label: name__value
  attributes:
  - name: name
    kind: Text
    unique: true
    optional: false
    order_weight: 1000
  - name: description
    kind: Text
    optional: true
    order_weight: 1100
  relationships:
  - name: clients
    peer: SnmpClient
    kind: Component
    cardinality: many
    optional: true
    order_weight: 1900
  - name: devices
    peer: DcimGenericDevice
    label: Devices
    kind: Attribute
    cardinality: many
    optional: true
    identifier: snmp_community__device
    description: Devices this community is configured on.
    order_weight: 1800
nodes:
- name: CommunityV2
  namespace: Snmp
  description: SNMP v1/v2c community configuration.
  label: SNMP v1/v2c
  icon: iconoir:community
  include_in_menu: true
  menu_placement: SnmpCommunity
  inherit_from:
  - SnmpCommunity
  human_friendly_id:
  - name__value
  order_by:
  - name__value
  display_label: name__value
  attributes:
  - name: community_string
    kind: Password
    optional: false
    order_weight: 1300
  - name: access
    kind: Dropdown
    choices:
    - name: read_only
      label: Read-Only
      description: Read-only access.
    - name: read_write
      label: Read-Write
      description: Read-write access.
    optional: false
    order_weight: 1200
- name: CommunityV3
  namespace: Snmp
  description: SNMP version 3 configuration with enhanced security.
  label: SNMP v3
  icon: iconoir:community
  include_in_menu: true
  menu_placement: SnmpCommunity
  inherit_from:
  - SnmpCommunity
  human_friendly_id:
  - name__value
  order_by:
  - name__value
  display_label: name__value
  attributes:
  - name: username
    kind: Text
    optional: false
    order_weight: 1300
  - name: auth_protocol
    kind: Dropdown
    label: Authentication Protocol
    choices:
    - name: none
      label: None
      description: No authentication.
    - name: md5
      label: MD5
      description: MD5 authentication.
    - name: sha
      label: SHA
      description: SHA authentication.
    optional: false
    order_weight: 1400
  - name: auth_password
    kind: Password
    label: Authentication Password
    optional: true
    order_weight: 1500
  - name: privacy_protocol
    kind: Dropdown
    label: Privacy Protocol
    choices:
    - name: none
      label: None
      description: No privacy.
    - name: des
      label: DES
      description: DES encryption.
    - name: aes
      label: AES
      description: AES encryption.
    optional: false
    order_weight: 1600
  - name: privacy_password
    kind: Password
    label: Privacy Password
    optional: true
    order_weight: 1700
  - name: security_level
    kind: Dropdown
    label: Security Level
    choices:
    - name: no_auth_no_priv
      label: NoAuthNoPriv
      description: No authentication and no privacy.
    - name: auth_no_priv
      label: AuthNoPriv
      description: Authentication but no privacy.
    - name: auth_priv
      label: AuthPriv
      description: Both authentication and privacy.
    optional: false
    order_weight: 1200
- name: Client
  namespace: Snmp
  description: Represents an SNMP client that interacts with SNMP Community.
  label: SNMP Client
  icon: ph:user-list-light
  include_in_menu: true
  menu_placement: SnmpCommunity
  human_friendly_id:
  - name__value
  order_by:
  - name__value
  display_label: name__value
  attributes:
  - name: name
    kind: Text
    unique: true
    optional: false
    order_weight: 1000
  - name: client_description
    kind: Text
    label: Description
    optional: true
    order_weight: 1100
  relationships:
  - name: ip_addresses
    peer: IpamIPAddress
    label: IP Addresses
    kind: Attribute
    cardinality: many
    optional: true
    description: Authorized SNMP client address.
    order_weight: 1150
  - name: communities
    peer: SnmpCommunity
    kind: Attribute
    cardinality: many
    optional: true
    order_weight: 1200