Bots From Extension: snmp
Collects the inventory data using SNMP protocol
This extension provides 5 bots.
Bot @snmp:compile-mibs-from-minio
Bot Position In Pipeline: Source
Manually compile MIBs from Minio and store in pysnmp directory inside container.
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 |
|---|---|---|---|
| minio_directory | Text | rda-objects/snmp_mibs/ | Directory in Minio to look for uncompiled MIB files |
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). |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
| 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. |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
| 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. | |
| profile_dataset_name | Text | Profile dataset that contains 'profile_name' and 'oids' columns. | |
| profile_column_name | Text | profiles | Column name in input where the collection profiles are given. This bot will go through each collection profile in this list and collect the data. The profile names should be present in the dataset 'profile_dataset_name' |
| timeout | Text | 10 | Timeout |
| retries | Text | 0 | Number of retries. |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
| 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 | |
| load_mib_modules | Text | yes | Try to get the Column names from OID using pre-loaded MIB files. |
| 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) |
Bot @snmp:snmp-table-conditional
Bot Position In Pipeline: Sink
Collect index OID data and attach to community string for table collection
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. |
|
| index_oid* | Text | Index OID that must be used to do conditional collection. This is for handling specific usecases where index needs to be attached to communityString. |
|
| timeout | Text | 10 | Timeout |
| retries | Text | 0 | Number of retries. |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
| 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) |