Bots From Extension: asset-discovery
Collects the inventory data using SNMP/CLI protocols
This extension provides 3 bots.
Bot @asset-discovery:collector
Bot Position In Pipeline: Sink
Inventory data collection using collection rules.
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 |
|---|---|---|---|
| jobname | Text | Custom job name to attach to the output | |
| seed_addresses_col* | Text | Column name in the input datset that contains IP addresses | |
| collection_group_rules | Text | default | comma separated rule names saved in minio |
| snmp_access | Text | yes | Enable SNMP Collection. (True/False) |
| cli_access | Text | no | Enable CLI Collection. (True/False) |
| basic_inventory | Text | yes | Collect basic discovery. (yes/no) |
| extended_inventory | Text | no | Collect extended discovery. (yes/no) |
| cdp_discovery | Text | no | Enable CDP Discovery. (True/False) |
| lldp_discovery | Text | no | Enable LLDP Discovery. (True/False) |
| arp_discovery | Text | no | Enable ARP Discovery. (True/False) |
| site_code | Text | site code for pstream | |
| return_dataset | Text | yes | Return the data to the pipeline after completion (yes/no) |
| status_pstream | Text | asset_inventory_collection_status_stream | Pstream name to write the collection status to |
| query_pstream_name | Text | Pstream name to get the list of successful credentials.(pstream must contain 'auth_state', 'ip_address', 'used_cred', and 'protocol' columns) |
|
| query | Text | Query the data in given persistent stream via CFXQL. 'query_pstream_name' field is mandatory to support query pstream |
|
| concurrent_discovery | Text | 100 | Number of worker threads to run in parallel |
| max_repititions | Text | Max Repetitions SNMP Bulk Walk Table Operation. | |
| max_rows | Text | 100000 | Max SNMP Rows to be collected for SNMP Table Operations (0 means no limit, default:100,000) |
| max_calls | Text | Max SNMP Calls for SNMP Table Operations (0 means no limit) | |
| max_time | Text | 1800 | Max time in seconds for an SNMP Table Operation (0 means no limit, default:1800) |
| mgmt_addresses | Text | Comma separated management addresses | |
| credential_types | Text | snmp-cred,device-snmpv1v2,device-snmp-v3,device-host-ssh | Comma separated credential types |
| collection_profile | Text | normal | Collection profile to use (quick/normal/slow/slow-vpn) |
| credentials | Text | Comma separated cedential ids from vault | |
| max_discovery_hops | Text | 8 | Maximum discovery hops |
| dedupe_mac_address | Text | no | Dedupe on MAC Address (yes/no) |
| dedupe_serial_number | Text | yes | Dedupe on serial number (yes/no) |
| keep_raw | Text | no | Keep raw data (yes/no) |
Bot @asset-discovery:get-collection-files
Bot Position In Pipeline: Sink
Retrieve collection data from objectstore location.
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 |
|---|---|---|---|
| path_column* | Text | Column name that contains path to object in Objectstore bucket. | |
| groups | Text | comma separated collection groups to retrieve from device. | |
| return_success_groups | Text | no | Retrieve only successful groups from the device collection. |
| concurrent_discovery | Text | 10 | Number of workers to run in parallel. |
Bot @asset-discovery:update-outputs-purge-policy
Bot Position In Pipeline: Source
Update the purge policy for output files from minio.
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 |
|---|---|---|---|
| retention_days* | Text | 15 | Number of days to retain the output files in objectstore. |