Bots From Extension: diagnostictools
Diagnostictools - Bots to run diagnostics on host like ping, traceroute and tcp check
This extension provides 7 bots.
Bot @diagnostictools:checkport
Bot Position In Pipeline: Sink
Checks whether asked port is open on the target host.
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 |
|---|---|---|---|
| column_name_host* | Text | Column name which contains one or more ip addresses of the target hosts where port status is to be checked. Supported ip address(s) format example: 192.168.10.10,192.168.10.11 or 192.168.20.0/24 or 192.168.30.10-192.168.30.100 or all of these ip formats as comma separated values. |
|
| column_name_port* | Text | Column name which contains single port number to be checked whether its open or not | |
| timeout_in_seconds | Text | 2 | Max timeout seconds to wait for checking individual port open status |
Bot @diagnostictools:checkssl
Bot Position In Pipeline: Sink
Run SSL Verification on host
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 |
|---|---|---|---|
| column_name* | Text | Column name which contain one or more ip addresses. Supported ip address(s) format example: 192.168.10.10,192.168.10.11 or 192.168.20.0/24 or 192.168.30.10-192.168.30.100 or all of these ip formats as comma separated values. |
|
| port_col_name* | Text | Column Name which contains port number | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @diagnostictools:ping
Bot Position In Pipeline: Sink
Verifies network access using ping command over ICMP protocol for one or more ip addresses.
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 |
|---|---|---|---|
| count | Text | 3 | Specify number of packets to be verified from a ping response. |
| column_name_host* | Text | Column name which contain one or more ip addresses. Supported ip address(s) format example: 192.168.10.10,192.168.10.11 or 192.168.20.0/24 or 192.168.30.10-192.168.30.100 or all of these ip formats as comma separated values. |
|
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @diagnostictools:snmp
Bot Position In Pipeline: Sink
Check device access using snmp credentials.
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 which contain one or more ip addresses. Supported ip address(s) format example: 192.168.10.10,192.168.10.11 or 192.168.20.0/24 or 192.168.30.10-192.168.30.100 or all of these ip formats as comma separated values. |
|
| oid | Text | 1.3.6.1.2.1.1.5.0 | OID to do an snmpget to verify the access. the sysName.0 (1.3.6.1.2.1.1.5.0) oid is used as default to test the connection. (Assumed to be a scalar MIB) |
| secret_names | Text | comma separated list of secrets from the vault. If not provided, all secrets of type 'snmp-cred' will be tried until connection is established. |
|
| 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 @diagnostictools:ssh-access-check
Bot Position In Pipeline: Sink
Check device access using SSH credentials.
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 which contain one or more ip addresses. Supported ip address(s) format example: 192.168.10.10,192.168.10.11 or 192.168.20.0/24 or 192.168.30.10-192.168.30.100 or all of these ip formats as comma separated values. |
|
| secret_names | Text | comma separated list of secrets from the vault. If not provided, all secrets of type 'ssh-cred' will be tried until connection is established. |
|
| timeout | Text | 10 | Timeout |
| 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 @diagnostictools:tcpportcheck
Bot Position In Pipeline: Sink
Verifies TCP Port access for one or more ip addresses
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 |
|---|---|---|---|
| column_name* | Text | Column name which contain one or more ip addresses. Supported ip address(s) format example: 192.168.10.10,192.168.10.11 or 192.168.20.0/24 or 192.168.30.10-192.168.30.100 or all of these ip formats as comma separated values. |
|
| port_col_name* | Text | Column Name which contains port number | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
| timeout | Text | 3.0 | Timeout |
Bot @diagnostictools:traceroute
Bot Position In Pipeline: Sink
Traces the network path for one or more ip addresses.
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 |
|---|---|---|---|
| column_name_host* | Text | Column name which contain one or more ip addresses. Supported ip address(s) format example: 192.168.10.10,192.168.10.11 or 192.168.20.0/24 or 192.168.30.10-192.168.30.100 or all of these ip formats as comma separated values. |
|
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |