Bots From Extension: cisco-fso
Cisco FSO Data Cloud Exporter
This extension provides 6 bots.
Bot @cisco-fso:export-logs
Bot Position In Pipeline: Sink
Export logs and events to Cisco FSO Data Cloud
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 |
|---|---|---|---|
| source_type* | Text | Source Type (ex: vcenter) | |
| entity_type* | Text | Entity Type | |
| namespace* | Text | Namespace | |
| body_column* | Text | Log message body | |
| severity_column* | Text | Severity number (1-TRACE, 5-DEBUG, 9-INFO, 17-ERROR, 21-FATAL) | |
| exclude_namespace_attrs | Text | Excludes to add namespace as prefix to the specified list of comma separated attributes | |
| event_type_column | Text | Specify event type column name. | |
| event_attr_columns | Text | Specify comma separated column names to include in event attributes | |
| timestamp_column | Text | timestamps | Specify timestamp column to send timestamp value in milliseconds |
| status_column | Text | fso_export_status | Output column name which contains status of export to Cisco FSO Data Cloud |
| telemetry_sdk_name | Text | cfx_rda | Provide telemetry sdk name, '_rda' will be appended to this sdk name, default is 'cfx_rda'. |
Bot @cisco-fso:export-logs-generic
Bot Position In Pipeline: Sink
Export generic logs and events without mappings, namespace for resource attributes to Cisco FSO Data Cloud
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 |
|---|---|---|---|
| body_column* | Text | Log message body | |
| severity_column* | Text | Severity number (1-TRACE, 5-DEBUG, 9-INFO, 17-ERROR, 21-FATAL) | |
| status_column | Text | fso_export_status | Output column name which contains status of export to Cisco FSO Data Cloud |
| timestamp_column | Text | timestamps | Specify timestamp column to send timestamp value in milliseconds |
Bot @cisco-fso:export-metrics
Bot Position In Pipeline: Sink
Export metrics to Cisco FSO Data Cloud
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 |
|---|---|---|---|
| source_type* | Text | Source Type (ex: vcenter) | |
| entity_type* | Text | Entity Type | |
| namespace* | Text | Namespace | |
| metric_name_column* | Text | Metric name column | |
| value_column* | Text | Metric value column | |
| value_type_column* | Text | Metric value type column (must be one of long or float) | |
| exclude_namespace_attrs | Text | Excludes to add namespace as prefix to the specified list of comma separated attributes | |
| timestamp_column | Text | timestamps | Specify timestamp column to send timestamp value in milliseconds |
| time_interval | Text | 5 | Specify time interval in minutes. Default is 5 minutes |
| status_column | Text | fso_export_status | Output column name which contains status of export to Cisco FSO Data Cloud |
| telemetry_sdk_name | Text | cfx_rda | Provide telemetry sdk name, '_rda' will be appended to this sdk name, default is 'cfx_rda'. |
Bot @cisco-fso:export-relations
Bot Position In Pipeline: Sink
Export relationships to Cisco FSO Data Cloud
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 |
|---|---|---|---|
| from_namespace* | Text | From Namespace | |
| from_entity_type_attr* | Text | Column name which has source entity type attribute name | |
| from_entity_type_value* | Text | Column name which has source entity type attribute value | |
| from_entity_id_attr* | Text | Column name which has source entity ID attribute name | |
| from_entity_id_value* | Text | Column name which has source entity ID attribute value | |
| include_from_entity_attrs | Text | List of attribute names to include in from_entity attributes | |
| to_namespace* | Text | To namespace | |
| to_entity_type_attr* | Text | Column name which has destination entity type attribute | |
| to_entity_type_value* | Text | Column name which has destination entity type attribute value | |
| to_entity_id_attr* | Text | Column name which has destination entity ID attribute name | |
| to_entity_id_value* | Text | Column name which has destination entity ID attribute value | |
| include_to_entity_attrs | Text | List of attribute names to include in to_entity attributes | |
| timestamp_column | Text | timestamps | Specify timestamp column to send timestamp value in milliseconds |
| time_interval | Text | 5 | Specify time interval in minutes. Default is 5 minutes |
| exclude_namespace_attrs | Text | Excludes to add namespace as prefix to the specified list of comma separated attributes | |
| status_column | Text | fso_export_status | Output column name which contains status of export to Cisco FSO Data Cloud |
| telemetry_sdk_name | Text | cfx_rda | Provide telemetry sdk name, default is 'cfx_rda'. |
| topology_metric_name | Text | cfx.rda_topology_update | Provide topology update metric name, default is 'cfx.rda_topology_update'. |
Bot @cisco-fso:export-resources
Bot Position In Pipeline: Sink
Export Resources to Cisco FSO Data Cloud
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 |
|---|---|---|---|
| source_type* | Text | Source Type (ex: vcenter) | |
| entity_type* | Text | Entity Type | |
| namespace* | Text | Namespace | |
| exclude_namespace_attrs | Text | Excludes to add namespace as prefix to the specified list of comma separated attributes | |
| timestamp_column | Text | timestamps | Specify timestamp column to send timestamp value in milliseconds |
| time_interval | Text | 5 | Specify time interval in minutes. Default is 5 minutes |
| status_column | Text | fso_export_status | Output column name which contains status of export to Cisco FSO Data Cloud |
| telemetry_sdk_name | Text | cfx_rda | Provide telemetry sdk name, default is 'cfx_rda'. |
| topology_metric_name | Text | cfx.rda_topology_update | Provide topology update metric name, default is 'cfx.rda_topology_update'. |
Bot @cisco-fso:query-entities
Bot Position In Pipeline: Source Sink
Query Entities from Cisco FSO Data Cloud
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 |
|---|---|---|---|
| entity_type* | Text | Entity Type | |
| namespace* | Text | Namespace | |
| since | Text | -24h | Query entities based on Cisco FSO UQL Query 'Since' clause. Default is '-24h' |