Connector, snmp type
Connectors of the snmp type are used for getting data over Simple Network Management Protocol (SNMP) when working with Windows and Linux agents. To process events received over SNMP, you must use the json normalizer. Supported SNMP protocol versions:
Only one snmp connector created in the agent settings can be used in an agent. If you need to use multiple snmp connectors, you must create one or all snmp connectors as a separate resource and select it in the connection settings.
Available settings for a connector of the snmp type are described in the following tables.
Basic settings tab
Setting
|
Description
|
Name
|
Unique name of the resource. The maximum length of the name is 128 Unicode characters.
Required setting.
|
Tenant
|
The name of the tenant that owns the resource.
Required setting.
|
Type
|
Connector type: snmp.
Required setting.
|
Tags
|
Tags for resource search.
Optional setting.
|
Description
|
Description of the resource. The maximum length of the description is 4000 Unicode characters.
|
SNMP resource
|
Settings for connecting to an SNMP resource:
- SNMP version is the version of the SNMP protocol being used.
Required setting. - Host is the name or IP address of the host. Possible formats:
- <
host name > - <
IPv4 address > - <
IPv6 address >
Required setting. - Port is the port number to be used when connecting to the host. Typical values are
161 or 162 .Required setting. - Secret is the secret that stores the credentials for connecting over the Simple Network Management Protocol. The secret type must match the SNMP version.
You can select an existing secret or create a new secret. To create a new secret, select Create new. If you want to edit the settings of an existing secret, click the pencil icon next to it. How to create a secret? To create a secret:
- In the Name field, enter the name of the secret.
- In the User and Password fields, enter the credentials of the user account that the Agent will use to connect to the connector.
- If necessary, enter a description of the secret in the Description field.
- Click the Create button.
The secret is added and displayed in the Secret drop-down list.
Required setting.
You can add multiple connections to SNMP resources or delete an SNMP resource connection. To create a connection to an SNMP resource, click the + SNMP resource button. To delete a connection to an SNMP resource, click the delete icon next to the SNMP resource.
|
Settings
|
Rules for naming the received data, according to which OIDs (object identifiers) are converted to the keys with which the normalizer can interact. Available settings:
- Parameter name is the name for the data type, for example,
Host name or Host uptime .Required setting. - OID is a unique identifier that determines where to look for the required data at the event source, for example,
1.3.6.1.2.1.1.5 .Required setting. - Key is a unique identifier returned in response to a request to the device with the value of the requested parameter, for example,
sysName . You can reference the key when normalizing data.Required setting. - If the MAC address check box is selected, KUMA correctly decodes data where the OID contains information about the MAC address in OctetString format. After decoding, the MAC address is converted to a
String value of the XX:XX:XX:XX:XX:XX format.
You can do the following with rules:
- Add multiple rules. To add a rule, click the + Add button.
- Delete rules. To delete a rule, select the check box next to it and click Delete.
- Clear rule settings. To do so, click the Clear all values button.
|
Advanced settings tab
Setting
|
Description
|
Debug
|
The switch enables resource logging. The toggle switch is turned off by default.
|
Character encoding
|
Character encoding. The default is UTF-8.
|
Page top
[Topic 220753]