Bots From Extension: rda_agents
RDA Agent Based Bots
This extension provides 43 bots.
Bot @agent:agent-alertproc-companion:alertproccompanionagent:canResolveAlerts
Bot Position In Pipeline: Sink
[Agent: agent-alertproc-companion, Group: alertproccompanionagent] Check whether a alert can be resolved based on the correlation policy definition.
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 |
|---|---|---|---|
| alert_id* | Text | Name of the column containing Alert IDs |
Bot @agent:agent-alertproc-companion:alertproccompanionagent:getAlertsForCorrelationParent
Bot Position In Pipeline: Sink
[Agent: agent-alertproc-companion, Group: alertproccompanionagent] Get list of alerts for the given correlation parent.
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 |
|---|---|---|---|
| correlationParentId* | Text | Name of the column containing Correlation Parent Id | |
| offset | Text | offset of the result to fetch. Parameter can be used for batching query. | |
| maxResults | Text | Max results to fetch for a Correlation Parent Id. . Parameter can be used for batching query. |
Bot @agent:agent-alertproc:alertprocagent:clearAlerts
Bot Position In Pipeline: Sink
[Agent: agent-alertproc, Group: alertprocagent] Clear Alerts
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 |
|---|---|---|---|
| alert_id* | Text | Name of the column containing Alert IDs | |
| cleared_notes | Text | Cleared Notes | |
| cleared_by | Text | Cleared By |
Bot @agent:agent-alertproc:alertprocagent:reviveSuppressedAlerts
Bot Position In Pipeline: Sink
[Agent: agent-alertproc, Group: alertprocagent] Revive Suppressed Alerts
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 |
|---|---|---|---|
| alert_id* | Text | Name of the column containing Alert ID |
Bot @agent:agent-alertproc:alertprocagent:savePolicy
Bot Position In Pipeline: Sink
[Agent: agent-alertproc, Group: alertprocagent] Create or Update policy definition applied on alerts to CORRELATE or SUPPRESS.
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 |
|---|---|---|---|
| customer_id* | Text | Customer Id for which policy is created/updated | |
| project_id* | Text | Project Id for which policy is created/updated | |
| policy_type* | Text | Policy type ex.:SUPPRESS/SUPPRESS_FLAPPING/CORRELATE_GROUP | |
| name* | Text | Name of the policy | |
| severity* | Text | severity | |
| description | Text | Description of the policy | |
| precedence* | Text | Precedenc for the policy | |
| criteria | Text | Filter to apply on alerts | |
| group_by | Text | Specify group by comma separated attributes, which is used while doing correlation of the alerts | |
| revive_on_expiry | Text | Specify whether to auto revive on group expiry, allowed values yes/no | |
| auto_resolve_on_expiry | Text | Specify whether to auto resolve on group expiry, allowed values yes/no | |
| schedule* | Text | Selection Criteria |
Bot @agent:agent-alertproc:alertprocagent:updateExternalTicketToAlerts
Bot Position In Pipeline: Sink
[Agent: agent-alertproc, Group: alertprocagent] Update External ticket number to alerts for a given incident.
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 |
|---|---|---|---|
| incidentid* | Text | Incident of an alert. | |
| roomid | Text | projectId for which incident is created. | |
| external_ticket_id | Text | External ticket id. | |
| external_ticket_number* | Text | External Ticket Number to be updated for alerts. |
Bot @agent:agent-collab:collabagent:addExternalTicket
Bot Position In Pipeline: Sink
[Agent: agent-collab, Group: collabagent] Input Dataset. Insert a new record in to TeamIncident
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
Bot @agent:agent-collab:collabagent:append-message
Bot Position In Pipeline: Sink
[Agent: agent-collab, Group: collabagent] Input Dataset. Add a new collab activity message for each incident
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
Bot @agent:agent-collab:collabagent:create-ticket
Bot Position In Pipeline: Sink
[Agent: agent-collab, Group: collabagent] Input Dataset. For each Incident, creates ITSM Ticket
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
Bot @agent:agent-collab:collabagent:external-ticket
Bot Position In Pipeline: Sink
[Agent: agent-collab, Group: collabagent] Input Dataset. For each Incident, get the corresponding external ticket
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
Bot @agent:agent-collab:collabagent:getAlertSource
Bot Position In Pipeline: Source Sink
[Agent: agent-collab, Group: collabagent] Get Alert Source for the given Incident
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 |
|---|---|---|---|
| project_id* | Text | The ProjectId | |
| incident_id* | Text | The IncidentID linked to the Incident and ExternalTicket | |
| field_name* | Text | Alert Source field name. Default 'Alert_Source') |
Bot @agent:agent-collab:collabagent:getExternalTicket
Bot Position In Pipeline: Source Sink
[Agent: agent-collab, Group: collabagent] Get Linked External Ticket Info for the given OIA Incident
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 |
|---|---|---|---|
| project_id* | Text | The ProjectId linked to the Incident and ExternalTicket | |
| incident_id | Text | The IncidentID linked to the Incident and ExternalTicket | |
| ticket_id | Text | The External TicketId linked to the Incident and ExternalTicket | |
| ticket_number | Text | The External TicketNumber linked to the Incident and ExternalTicket | |
| team_id | Text | The TeamID linked to the Incident and ExternalTicket | |
| collab_type | Text | The CollabType linked to the Incident and ExternalTicket |
Bot @agent:agent-collab:collabagent:getIncidentAlertAttributes
Bot Position In Pipeline: Source Sink
[Agent: agent-collab, Group: collabagent] Get Incident Alert Attributes for the given OIA IncidentId
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 |
|---|---|---|---|
| project_id* | Text | The ProjectId | |
| incident_id | Text | The IncidentID | |
| source_key | Text | The Incident SourceKey | |
| alert_id | Text | The AlertId | |
| fields | Text | Specify fields that are to fetched from each alert | |
| mode | Text | Concatinated Columns or Seperate Columns? Works with fields |
Bot @agent:agent-collab:collabagent:getIncidentAlerts
Bot Position In Pipeline: Source Sink
[Agent: agent-collab, Group: collabagent] Get Incident Alerts for the given OIA IncidentId
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 |
|---|---|---|---|
| project_id* | Text | The ProjectId | |
| incident_id* | Text | The IncidentID | |
| alert_id | Text | The AlertId | |
| fields | Text | Specify fields that are to fetched from each alert | |
| mode | Text | Concatinated Columns or Seperate Columns? Works with fields | |
| alerts_count | Text | Number of latest alerts to pull | |
| line_break | Text | Line break to use. <br> (default) or /n |
Bot @agent:agent-collab:collabagent:getIncidentData
Bot Position In Pipeline: Source Sink
[Agent: agent-collab, Group: collabagent] Get Incident Details for the given OIA IncidentId
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 |
|---|---|---|---|
| project_id* | Text | The ProjectId linked to the Incident | |
| incident_id* | Text | The IncidentID | |
| fields | Text | Specify fields that are to fetched from each alert | |
| mode | Text | Concatinated Columns or Seperate Columns? Works with fields | |
| line_break | Text | Line break to use. <br> (default) or /n |
Bot @agent:agent-collab:collabagent:getOperationMode
Bot Position In Pipeline: Source Sink
[Agent: agent-collab, Group: collabagent] Gets if this should be Create or Update
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 |
|---|---|---|---|
| project_id* | Text | The ProjectId | |
| incident_id* | Text | The IncidentID linked to the Incident and ExternalTicket | |
| collab_type | Text | For which specific CollabType? |
Bot @agent:agent-collab:collabagent:getTeamAttributes
Bot Position In Pipeline: Source Sink
[Agent: agent-collab, Group: collabagent] Get All Team and Attributes for a given Collaboration Type
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 |
|---|---|---|---|
| project_id* | Text | The ProjectId | |
| collab_type | Text | Fetch the teams matching collabType. Ex ServiceNow | |
| team_name | Text | Fetch the teams matching Name. Ex PC-SRMV | |
| attribute | Text | Auto Share Attribute (autoShareAttributes) |
Bot @agent:agent-collab:collabagent:team-attributes
Bot Position In Pipeline: Sink
[Agent: agent-collab, Group: collabagent] Input Dataset. For each Incident, get the applicable team and attributes
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
Bot @agent:agent-collab:collabagent:update-ticket
Bot Position In Pipeline: Sink
[Agent: agent-collab, Group: collabagent] Input Dataset. For each Incident, updates ITSM Ticket
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
Bot @agent:agent-config:configagent:getTeamsByCollabType
Bot Position In Pipeline: Source Sink
[Agent: agent-config, Group: configagent] Get All Teams for a given Collaboration Type
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 |
|---|---|---|---|
| collab_type | Text | Fetch the teams matching collabType. Ex ServiceNow |
Bot @agent:agent-irm:irmagent:addIncidents
Bot Position In Pipeline: Sink
[Agent: agent-irm, Group: irmagent] Add new incident
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
Bot @agent:agent-irm:irmagent:getIncidentAlertsCount
Bot Position In Pipeline: Source Sink
[Agent: agent-irm, Group: irmagent] Fetch alerts' count by ipaddress for an incident
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 |
|---|---|---|---|
| roomId | Text | The room-id for which the alerts counts are to be fetched | |
| incidentId* | Text | The incident-id for which the alerts counts are to be fetched |
Bot @agent:agent-irm:irmagent:getIncidentDetails
Bot Position In Pipeline: Source Sink
[Agent: agent-irm, Group: irmagent] get incident details
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 |
|---|---|---|---|
| roomId* | Text | The room-id for which the incident details are to be fetched | |
| incidentId* | Text | the incident ID whose details are to be fetched |
Bot @agent:agent-irm:irmagent:getOiaConfigFile
Bot Position In Pipeline: Source Sink
[Agent: agent-irm, Group: irmagent] get response of getOiaConfigFile
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 |
|---|---|---|---|
| roomId | Text | The room-id for which the configured file is to be fetched. If it is not provided then global file details will be fetched. |
|
| filepath* | Text | Path of the configuration file under incident-rooms minio bucket |
Bot @agent:agent-irm:irmagent:updateIncidents
Bot Position In Pipeline: Sink
[Agent: agent-irm, Group: irmagent] Update existing incident details
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
Bot @agent:agent-irm:irmagent:updateOiaConfigFile
Bot Position In Pipeline: Source Sink
[Agent: agent-irm, Group: irmagent] get response of updateOiaConfigFile
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 |
|---|---|---|---|
| roomId | Text | The room-id for which the configured file is to be updated. If it is not provided then the updated file will be applied for all projects/rooms/customers |
|
| filepath* | Text | Path of the configuration file under incident-rooms MINIO bucket | |
| data* | Text | Stringified JSON object which contains the updated data to be saved at specified file path in MINIO |
Bot @agent:agent-ml:mlagent:alerts-cluster-retrain
Bot Position In Pipeline: Sink
[Agent: agent-ml, Group: mlagent] Create new experiment and run clustering on it
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
Bot @agent:agent-ml:mlagent:ml-model-meta-retriever
Bot Position In Pipeline: Source Sink
[Agent: agent-ml, Group: mlagent] Retrive ML model meta data and save in context
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 |
|---|---|---|---|
| experiment_name* | Text | Name of the Experiment to use | |
| version_name | Text | Name of the Version to use. if not provided default will use latest version | |
| tenant_id* | Text | Id of the Customer/Tenant to use. can be passes as $tenantId and replaced in backend |
Bot @agent:cfx-edgecollector:ec-group-01:access-verification
Bot Position In Pipeline: Source Sink
[Agent: cfx-edgecollector, Group: ec-group-01] Perform access verification
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 | Name of the job | |
| protocol | Text | Verify only specified protocols.(SNMP/SSH/ICMP/WINRM) | |
| site_code | Text | Name of the site code |
Bot @agent:cfx-edgecollector:ec-group-01:create-profile
Bot Position In Pipeline: Source Sink
[Agent: cfx-edgecollector, Group: ec-group-01] create profile
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 |
|---|---|---|---|
| name* | Text | Name of the profile | |
| retries* | Text | retrie count | |
| timeout* | Text | timeout | |
| sleep_between_requests* | Text | sleep time between requests | |
| max_repetitions* | Text | max repetitions | |
| ping_count* | Text | ping count | |
| ping_timeout* | Text | ping timeout |
Bot @agent:cfx-edgecollector:ec-group-01:createJob
Bot Position In Pipeline: Source Sink
[Agent: cfx-edgecollector, Group: ec-group-01] Creates a discovery job
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 | Name of the job | |
| seed_addresses* | Text | Seed IP Addresses. EX: 10.12.13.11-10.12.13.21,10.12.13.25,10.12.13.8 | |
| seed_exclude_addresses | Text | Exclude seed IP Addresses. EX: 10.12.13.11-10.12.13.21,10.12.13.25,10.12.13.8 | |
| seed_contain_addresses | Text | Contains To seed IP Addresses. EX: 10.12.13.11-10.12.13.21,10.12.13.25,10.12.13.8 | |
| mgmt_addresses | Text | Management IP Addresses. EX: 10.12.13.11-10.12.13.21,10.12.13.25,10.12.13.8 | |
| snmp_access | Text | Enable SNMP Collection. (True/False) | |
| cli_access | Text | Enable CLI Collection. (True/False) | |
| dedupe_serial_number | Text | Enable Dedupe Serial Number. (True/False) | |
| dedupe_mac_address | Text | Enable Dedupe MAC Address. (True/False) | |
| basic_inventory | Text | Enable Basic Inventory collection. (True/False) | |
| extended_inventory | Text | Enable Extended Inventory collection. (True/False) | |
| cdp_discovery | Text | Enable CDP Discovery. (True/False) | |
| lldp_discovery | Text | Enable LLDP Discovery. (True/False) | |
| arp_discovery | Text | Enable ARP Discovery. (True/False) | |
| dns_resolve | Text | Enable DNS Lookup. (True/False) | |
| icmp_ping | Text | Enable Trigger ICMP request to update ARP table. (True/False) | |
| icmp_addresses | Text | ICMP seed addresses. EX: 10.12.13.11-10.12.13.21,10.12.13.25,10.12.13.8 | |
| keep_raw | Text | Enable Keep raw files. (True/False) | |
| max_discovery_hops | Text | Maximum discovery hops count. EX: 8 | |
| get_seed_from_SVIs | Text | Enable Get seed from SVIs (Switch Virtual Interfaces). (True/False) | |
| wait_time_between_ICMP_req | Text | Wait time between ICMP request in milliseconds. EX: 1 | |
| wait_time_between_ICMP_iteration | Text | Wait time between ICMP iteration in minutes. EX: 3 | |
| wait_time_to_start_discovery | Text | Wait time to start discovery in minutes. EX: 5 | |
| credentials | Text | List of credential sources. | |
| tags | Text | List of tags | |
| collection_profile | Text | collection profile type | |
| rerun_flags | Text | Set rerun flags for job. Valid values are 'fresh-start', 'rerun-failed', 'run-successful', 'run-inprogress' and 'run-partialfailed' |
|
| access_verification | Text | Enable access verification. By default it will be enabled. (True/False) | |
| credential_types | Text | Comma separated list of credential types. Possible values are SNMPV1V2, SNMPV3, SSH | |
| credential_patterns | Text | Comma separated list of credential patterns. |
Bot @agent:cfx-edgecollector:ec-group-01:delete-file
Bot Position In Pipeline: Source Sink
[Agent: cfx-edgecollector, Group: ec-group-01] Delete given job file 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 |
|---|---|---|---|
| jobName* | Text | Name of the job | |
| older_than* | Text | Number of days to delete older files |
Bot @agent:cfx-edgecollector:ec-group-01:deleteJob
Bot Position In Pipeline: Source Sink
[Agent: cfx-edgecollector, Group: ec-group-01] Delete given job
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 | Name of the job |
Bot @agent:cfx-edgecollector:ec-group-01:get-discovery-file-list
Bot Position In Pipeline: Source Sink
[Agent: cfx-edgecollector, Group: ec-group-01] List all the discovery files
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 | Name of the job |
Bot @agent:cfx-edgecollector:ec-group-01:get-job-logs
Bot Position In Pipeline: Source Sink
[Agent: cfx-edgecollector, Group: ec-group-01] Get logs of given job
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 | Name of the job |
Bot @agent:cfx-edgecollector:ec-group-01:get-job-status
Bot Position In Pipeline: Source Sink
[Agent: cfx-edgecollector, Group: ec-group-01] Get the status of the job
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 | Name of the job | |
| db_name | Text | Name of the database table. Valid values are 'seed','inprogress','successful','duplicate','partial','failed' and 'deviceidentity' |
Bot @agent:cfx-edgecollector:ec-group-01:get-profiles
Bot Position In Pipeline: Source Sink
[Agent: cfx-edgecollector, Group: ec-group-01] Get list of profiles
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
Bot @agent:cfx-edgecollector:ec-group-01:getJobList
Bot Position In Pipeline: Source Sink
[Agent: cfx-edgecollector, Group: ec-group-01] Get all job list
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 | Name of the job |
Bot @agent:cfx-edgecollector:ec-group-01:runDiscovery
Bot Position In Pipeline: Source Sink
[Agent: cfx-edgecollector, Group: ec-group-01] Run the job to collect device data
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 | Name of the job | |
| configure_time_limit | Text | Configure time limit to exit the bot execution(in seconds), if the bot execution exceeds the configured time limit, it will exit the bot execution |
|
| max_time | Text | Max time in seconds for an SNMP Table Operation (0means no limit, default:1800) | |
| worker_threads | Text | Number of collection worker threads | |
| rerun_flags | Text | Set rerun flags for job. Valid values are 'fresh-start', 'rerun-failed', 'run-successful', 'run-inprogress' and 'run-partialfailed' |
|
| pstream_name | Text | Pstream name to get the list of successful credentials.(pstream must contain 'auth_state', 'ip_address', 'used_cred', and 'protocol' columns) |
|
| access_verification | Text | Enable access verification. (True/False) | |
| site_code | Text | Name of the site code | |
| query | Text | Query the data in given persistent stream via CFXQL. 'pstream_name' field is mandatory to support query pstream |
Bot @agent:cfx-edgecollector:ec-group-01:update-profile
Bot Position In Pipeline: Source Sink
[Agent: cfx-edgecollector, Group: ec-group-01] update profile
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 |
|---|---|---|---|
| name* | Text | Name of the profile | |
| retries | Text | retrie count | |
| timeout | Text | timeout | |
| sleep_between_requests | Text | sleep time between requests | |
| max_repetitions | Text | max repetitions | |
| ping_count | Text | ping count | |
| ping_timeout | Text | ping timeout |
Bot @agent:cfx-edgecollector:ec-group-01:update-properties-file
Bot Position In Pipeline: Source Sink
[Agent: cfx-edgecollector, Group: ec-group-01] Update properties file
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 |
|---|---|---|---|
| zipfile_upload_retry_count | Text | Zipfile upload retry count | |
| zipfile_upload_wait_seconds | Text | Zipfile upload wait time in seconds | |
| http_request_connect_timeout_seconds | Text | Http request connect timeout in seconds | |
| discovery_identity_ignore | Text | Discovery identity ignore | |
| discovery_log_retention_days | Text | Discovery log retention days | |
| export_data_retention_days | Text | Export data retention days | |
| edgecollector_discoveryfile_retention_days | Text | Edgecollector discovery file retention days | |
| discovery_device_cli_connect_retry_count | Text | Discovery device cli connect retry count | |
| discovery_device_cli_connect_retry_delay_seconds | Text | Discovery device cli connect retry delay seconds | |
| discovery_device_cli_connect_banner_timeout_seconds | Text | Discovery device cli connect banner timeout seconds | |
| discovery_cli_xml_parsing_enabled | Text | Discovery cli xml parsing enabled | |
| discovery_juniper_device_cli_command_execution_timeout_seconds | Text | Discovery juniper device cli command execution timeout seconds | |
| discovery_cisco_device_cli_command_execution_timeout_seconds | Text | Discovery cisco device cli command execution timeout seconds | |
| discovery_device_dedupe_consider_count | Text | Discovery device dedupe consider count | |
| discovery_device_snmp_bulkwalk_ignorenonincreasingoid | Text | Discovery device snmp bulkwalk ignore non increasing oid | |
| discovery_device_snmp_bulkwalk_ignorenonincreasingoid_devices | Text | Discovery device snmp bulkwalk ignore non increasing oid devices | |
| incremental_discovery_target_ipaddress | Text | Incremental discovery target ipaddress | |
| incremental_discovery_target_access_key | Text | Incremental discovery target access_key | |
| incremental_discovery_target_secret_key | Text | Incremental discovery target secret_key | |
| incremental_discovery_job_executio_time_seconds | Text | Incremental discovery job executio time seconds | |
| discovery_host_command_execution_timeout_minutes | Text | Discovery host command execution timeout minutes | |
| incremental_discovery_job_execution_wait_time_seconds | Text | Incremental discovery job execution wait time seconds | |
| discovery_device_snmp_management_ipaddress_values | Text | Discovery device snmp management ipaddress values | |
| datadir_data_retention_days | Text | Data directory retention days |
Bot @agent:cfx-edgecollector:ec-group-01:updateJob
Bot Position In Pipeline: Source Sink
[Agent: cfx-edgecollector, Group: ec-group-01] Update a discovery job
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 | Name of the job | |
| seed_addresses | Text | Seed IP Addresses. EX: 10.12.13.11-10.12.13.21,10.12.13.25,10.12.13.8 | |
| seed_exclude_addresses | Text | Exclude seed IP Addresses. EX: 10.12.13.11-10.12.13.21,10.12.13.25,10.12.13.8 | |
| seed_contain_addresses | Text | Contains To seed IP Addresses. EX: 10.12.13.11-10.12.13.21,10.12.13.25,10.12.13.8 | |
| mgmt_addresses | Text | Management IP Addresses. EX: 10.12.13.11-10.12.13.21,10.12.13.25,10.12.13.8 | |
| snmp_access | Text | Enable SNMP Collection. (True/False) | |
| cli_access | Text | Enable CLI Collection. (True/False) | |
| dedupe_serial_number | Text | Enable Dedupe Serial Number. (True/False) | |
| dedupe_mac_address | Text | Enable Dedupe MAC Address. (True/False) | |
| basic_inventory | Text | Enable Basic Inventory collection. (True/False) | |
| extended_inventory | Text | Enable Extended Inventory collection. (True/False) | |
| cdp_discovery | Text | Enable CDP Discovery. (True/False) | |
| lldp_discovery | Text | Enable LLDP Discovery. (True/False) | |
| arp_discovery | Text | Enable ARP Discovery. (True/False) | |
| dns_resolve | Text | Enable DNS Lookup. (True/False) | |
| icmp_ping | Text | Enable Trigger ICMP request to update ARP table. (True/False) | |
| icmp_addresses | Text | ICMP seed addresses. EX: 10.12.13.11-10.12.13.21,10.12.13.25,10.12.13.8 | |
| keep_raw | Text | Enable Keep raw files. (True/False) | |
| max_discovery_hops | Text | Maximum discovery hops count. EX: 8 | |
| get_seed_from_SVIs | Text | Enable Get seed from SVIs (Switch Virtual Interfaces). (True/False) | |
| wait_time_between_ICMP_req | Text | Wait time between ICMP request in milliseconds. EX: 1 | |
| wait_time_between_ICMP_iteration | Text | Wait time between ICMP iteration in minutes. EX: 3 | |
| wait_time_to_start_discovery | Text | Wait time to start discovery in minutes. EX: 5 | |
| credentials | Text | List of credential sources. | |
| tags | Text | List of tags | |
| collection_profile | Text | collection profile type | |
| rerun_flags | Text | Set rerun flags for job. Valid values are 'fresh-start', 'rerun-failed', 'run-successful', 'run-inprogress' and 'run-partialfailed' |
|
| access_verification | Text | Enable access verification. (True/False) | |
| credential_types | Text | Comma separated list of credential types. Possible values are SNMPV1V2, SNMPV3, SSH | |
| credential_patterns | Text | Comma separated list of credential patterns. |
Bot @agent:rda-event-gateway:event_gateway_site01:get-status
Bot Position In Pipeline: Source Sink
[Agent: rda-event-gateway, Group: event_gateway_site01] List all endpoints configured at this gateway and current status
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