Bots From Extension: snmp
Collects the inventory data using SNMP protocol
This extension provides 3 bots.
Bot @snmp:snmp-bulkwalk
Bot Position In Pipeline: Sink
Collect snmp through bulk walk
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| ip_column* | Text | Column name in the input datset that contains IP addresses | |
| secret_names | Text | Comma separated list of names of the secret from the vault. If not provided, all secrets of type 'snmp-cred' will be tried until connection is established. |
|
| oids* | Text | List of OIDs to collect. If each oid is not ending with .0, the .0 is appended to it. | |
| timeout | Text | 10 | Timeout |
| retries | Text | 0 | Number of retries. |
| non_repeaters | Text | 1 | Non repeaters |
| max_repetitions | Text | 10 | Maximum repetitions. |
| max_rows | Text | 100000 | Max SNMP Rows to be collected for SNMP Table Operations (0 means no limit, default:100,000). |
| return_type | Text | dataset | Returns the response as dataset or writes to a pstream. expects 'dataset' or 'pstream'. |
| pstream_name | Text | Name of the pstream to write. Must be provided if return_type is pstream | |
| use_last_successful_cred | Text | yes | Look for the last successful secret in the pstream_name and use that first during collection. pstream should have 'target_ip', 'collection_status' and 'secret' columns. |
| lexicographic_mode | Text | no | Walk SNMP agent's MIB till the end (if yes), otherwise (if no) stop iteration when allresponse MIB variables leave the scope of initial MIB variables in varBinds. |
| ignore_non_increasing_oid | Text | no | Continue iteration even if response MIB variables (OIDs) are not greater then request MIB variables. |
| max_calls | Text | 0 | Max SNMP Calls for SNMP Table Operations (0 means no limit) |
Bot @snmp:snmp-get
Bot Position In Pipeline: Sink
Collect snmp scalar mib values
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| ip_column* | Text | Column name in the input datset that contains IP addresses | |
| secret_names | Text | Comma separated names of the secret from the vault. If not provided, all secrets of type 'snmp-cred' will be tried until connection is established. |
|
| oids* | Text | List of OIDs to collect. If each oid is not ending with .0, the .0 is appended to it. | |
| timeout | Text | 10 | Timeout |
| retries | Text | 0 | Number of retries. |
| return_type | Text | dataset | Returns the response as dataset or writes to a pstream. expects 'dataset' or 'pstream'. |
| pstream_name | Text | Name of the pstream to write. Must be provided if return_type is pstream | |
| use_last_successful_cred | Text | yes | Look for the last successful secret in the pstream_name and use that first during collection. pstream should have 'target_ip', 'collection_status' and 'secret' columns. |
Bot @snmp:snmp-table
Bot Position In Pipeline: Sink
Collect snmp data through table/columns oids
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| ip_column* | Text | Column name in the input datset that contains IP addresses | |
| secret_names | Text | Comma separated names of the secret from the vault. If not provided, all secrets of type 'snmp-cred' will be tried until connection is established. |
|
| oids* | Text | Comma separated list of OIDs to collect. If each oid is not ending with .0, the .0 is appended to it. |
|
| timeout | Text | 10 | Timeout |
| retries | Text | 0 | Number of retries. |
| return_type | Text | dataset | Returns the response as dataset or writes to a pstream. expects 'dataset' or 'pstream'. |
| pstream_name | Text | Name of the pstream to write. Must be provided if return_type is pstream | |
| use_last_successful_cred | Text | yes | Look for the last successful secret in the pstream_name and use that first during collection. pstream should have 'target_ip', 'collection_status' and 'secret' columns. |
| max_rows | Text | 100000 | Max SNMP Rows to be collected for SNMP Table Operations (0 means no limit, default:100,000). |
| lexicographic_mode | Text | no | Walk SNMP agent's MIB till the end (if yes), otherwise (if no) stop iteration when allresponse MIB variables leave the scope of initial MIB variables in varBinds. |
| ignore_non_increasing_oid | Text | no | Continue iteration even if response MIB variables (OIDs) are not greater then request MIB variables. |
| max_calls | Text | 0 | Max SNMP Calls for SNMP Table Operations (0 means no limit) |