Configure Simple Network Management Protocol (SNMP)

Required configuration items

Additional configuration items

To configure the SNMP agent on your TX64 device:


  1. Log into Digi Remote Manager, or log into the local Web UI as a user with full Admin access rights.
  2. Access the device configuration:

    1. Locate your device as described in Use Digi Remote Manager to view and manage your device.
    2. Click the Device ID.
    3. Click Settings.
    4. Click to expand Config.

    1. On the menu, click System. Under Configuration, click Device Configuration.

      The Configuration window is displayed.

  3. Click Services > SNMP.
  4. Click Enable.
    • To limit access to specified IPv4 addresses and networks:
      1. Click IPv4 Addresses.
      2. For Add Address, click .
      3. For Address, enter the IPv4 address or network that can access the device's SNMP agent. Allowed values are:
        • A single IP address or host name.
        • A network designation in CIDR notation, for example, 192.168.1.0/24.
        • any: No limit to IPv4 addresses that can access the SNMP agent.
      4. Click again to list additional IP addresses or networks.
    • To limit access to specified IPv6 addresses and networks:
      1. Click IPv6 Addresses.
      2. For Add Address, click .
      3. For Address, enter the IPv6 address or network that can access the device's SNMP agent. Allowed values are:
        • A single IP address or host name.
        • A network designation in CIDR notation, for example, 2001:db8::/48.
        • any: No limit to IPv6 addresses that can access the SNMP agent.
      4. Click again to list additional IP addresses or networks.
    • To limit access to hosts connected through a specified interface on the device:
      1. Click Interfaces.
      2. For Add Interface, click .
      3. For Interface, select the appropriate interface from the dropdown.
      4. Click again to allow access through additional interfaces.
    • To limit access based on firewall zones:
      1. Click Zones. By default, there are three firewall zones already configured: Internal, Edge, and IPsec.
      2. For Add Zone, click .
      3. For Zone, select the appropriate firewall zone from the dropdown.

        See Firewall configuration for information about firewall zones.

      4. Click again to allow access through additional firewall zones.
  6. Type the Username used to connect to the SNMP agent.
  7. Type the Password used to connect to the SNMP agent.
  8. (Optional) For Port, type the port number. The default is 161.
  9. (Optional) Multicast DNS (mDNS) is disabled by default. mDNS is a protocol that resolves host names in small networks that do not have a DNS server. To enable mDNS, click Enable mDNS.
  10. (Optional) Select the Authentication type, either MD5 or SHA1. The default is MD5.
  11. (Optional) Type the Privacy passphrase. If not set, the password, entered above, is used.
  12. (Optional) Select the Privacy protocol, either DES or AES128. The default is DES.
  13. (Optional) Add Dynamic SNMP Properties to expose specific details about your device for SNMP monitoring that are not included in the standard MIB. To query the runtime database to find the device property you want to expose to SNMP, see Use digidevice runtime to access the runtime database.

    1. Click .

    2. For Property, type the device property (e.g., "system.cpu_temp" or "system.name").
    3. Click again to add another dynamic SNMP property.
  14. (Optional) Enable read-only access to SNMP version 2c.
    1. Click Enable version 2c access to enable read-only access to SNMP version 2c.
    2. The Community Name field displays. The default name is public. You can change the name if needed.
  15. Click Apply to save the configuration and apply the change.
  1. Select the device in Remote Manager and click Actions > Open Console, or log into the TX64 local command line as a user with full Admin access rights.

    Depending on your device configuration, you may be presented with an Access selection menu. Type admin to access the Admin CLI.

  2. At the command line, type config to enter configuration mode:

    > config
(config)>

  3. Enable the SNMP agent:
    (config)> service snmp enable true
(config)>
    • To limit access to specified IPv4 addresses and networks:
      (config)> add service snmp acl address end value
(config)>

      Where value can be:

      • A single IP address or host name.
      • A network designation in CIDR notation, for example, 192.168.1.0/24.
      • any: No limit to IPv4 addresses that can access the SNMP service.

      Repeat this step to list additional IP addresses or networks.

    • To limit access to specified IPv6 addresses and networks:
      (config)> add service snmp acl address6 end value
(config)>

      Where value can be:

      • A single IP address or host name.
      • A network designation in CIDR notation, for example, 2001:db8::/48.
      • any: No limit to IPv6 addresses that can access the SNMP service.

      Repeat this step to list additional IP addresses or networks.

    • To limit access to hosts connected through a specified interface on the TX64 device:
      (config)> add service snmp acl interface end value
(config)>

      Where value is an interface defined on your device.

      Use ... network interface ? to display interface information:

      (config)> ... network interface ?

Interfaces

Additional Configuration
-------------------------------------------
 setupip              Setup IP  
 setuplinklocalip       Setup Link-local IP
 lan1                   LAN1
 loopback               Loopback 
 wan1                   WAN1 
 wwan1                  WWAN1
 wwan2                  WWAN2

(config)>

      Repeat this step to list additional interfaces.

    • To limit access based on firewall zones:
      (config)> add service snmp acl zone end value
(config)>

      Where value is a firewall zone defined on your device, or the any keyword.

      Type ... firewall zone ? at the config prompt:

      (config)> ... firewall zone ?

Zones: A list of groups of network interfaces that can be referred to by packet
filtering rules and access control lists.

 Additional Configuration
 -------------------------------------------------------------------------------
  any
  dynamic_routes
  edge
  external
  hotspot
  internal
  ipsec
  loopback
  setup

(config)>

      Repeat this step to include additional firewall zones.

  5. Set the name of the user that will be used to connect to the SNMP agent.
    (config)> service snmp username name
(config)>
  6. Set the password for the user that will be used to connect to the SNMP agent:
    (config)> service snmp password pwd
(config)>
  7. (config)> service snmp port port
(config)>

  8. mDNS is a protocol that resolves host names in small networks that do not have a DNS server. For the SNMP agent, mDNS is disabled by default. To enable: 

    (config)> service snmp mdns enable true
(config>

  9. (config)> service snmp auth_type SHA1
(config)> 
  10. (config)> service snmp privacy pwd
(config)>
  11. (config)> service snmp privacy_protocol AES128
(config)>
  12. (config) service snmp runt> add end value 
(config)>

    Where value can be any element in the runtime table you want to expose to SNMP monitoring (for example, "system.cpu_temp" or "system.name").

  13. (config)> service snmp enable 2c true
(config)>

    The community name is set to public by default. You can change it if desired.

    (config)> service snmp community_name <name>
(config)>

    Where name is the new community name.

  14. Save the configuration and apply the change.
    (config)> save
Configuration saved.
>
  15. Type exit to exit the Admin CLI.

    Depending on your device configuration, you may be presented with an Access selection menu. Type quit to disconnect from the device.