Vertica

Analytic database management software.

Database · Vertica

Details

IDVertica
ProviderOpenText
CategoryDatabase
From Version5.0.0
Docker Imagedemisto/py3-tools:1.0.0.114656
Supported ModulesAgentix XSIAM

README

This integration was integrated and tested with Vertica v4.1.

Configure Vertica on Cortex XSOAR

  1. Navigate to Settings > Integrations > Servers & Services.
  2. Search for Vertica.
  3. Click Add instance to create and configure a new integration instance.
    • Name: a textual name for the integration instance.
    • Host (myhost.example.com)
    • Database
    • Username
    • Port
  4. Click Test to validate the URLs, token, and connection.

Commands

You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

1. Query the Vertica database


Executes a query on the Vertica database.

Base Command

vertica-query

Input
Argument Name Description Required
query A SQL query to perform on the Vertica database. Required
limit The maximum number of results to return. Optional

 

Context Output
Path Type Description
Vertica.Query string The original query.
Vertica.Row string The content of rows.

 

Command Example
!vertica-query query="SELECT * FROM system_tables ORDER BY table_schema, table_name LIMIT 5;" limit="50"
Context Example
Vertica:{} 2 items
Query:SELECT * FROM system_tables ORDER BY table_schema, table_name LIMIT 5;
Row:[] 5 items
0:{} 8 items
IsAccessibleDuringLockdown:false
IsMonitorable:true
IsSuperuserOnly:true
TableDescription:Access Policy information
TableId:95400
TableName:access_policy
TableSchema:v_catalog
TableSchemaId:8301
1:{} 8 items
IsAccessibleDuringLockdown:false
IsMonitorable:true
IsSuperuserOnly:false
TableDescription:A complete listing of all tables and views
TableId:10206
TableName:all_tables
TableSchema:v_catalog
TableSchemaId:8301
2:{} 8 items
IsAccessibleDuringLockdown:false
IsMonitorable:true
IsSuperuserOnly:false
TableDescription:Audit table for Managing_Users_And_Privileges category
TableId:10338
TableName:audit_managing_users_privileges
TableSchema:v_catalog
TableSchemaId:8301
3:{} 8 items
IsAccessibleDuringLockdown:false
IsMonitorable:true
IsSuperuserOnly:true
TableDescription:List of available branches
TableId:10800
TableName:branches
TableSchema:v_catalog
TableSchemaId:8301
4:{} 8 items
IsAccessibleDuringLockdown:false
IsMonitorable:true
IsSuperuserOnly:true
TableDescription:Current status of existing branches
TableId:117200
TableName:branches_status
TableSchema:v_catalog
TableSchemaId:8301
Human Readable Output

Configuration parameters

  • url — Host (myhost.example.com) (required)
  • database (mydb) — Database (required)
  • credentials — Username (required)
  • port — Port

Commands (1)

  • vertica-query

    Executes a query on the Vertica database.

commonfields:
  id: Vertica
  version: -1
name: Vertica
display: Vertica
category: Database
provider: OpenText
description: Analytic database management software.
configuration:
- display: Host (myhost.example.com)
  name: url
  defaultvalue: ""
  type: 0
  required: true
- display: Database
  name: database (mydb)
  defaultvalue: ""
  type: 0
  required: true
- display: Username
  name: credentials
  defaultvalue: ""
  type: 9
  required: true
- display: Port
  name: port
  defaultvalue: "5433"
  type: 0
  required: false
script:
  script: ''
  type: python
  commands:
  - name: vertica-query
    arguments:
    - name: query
      required: true
      description: A SQL query to perform on the Vertica database.
    - name: limit
      description: The maximum number of results to be returned from the query. (Use 0 for all results).
      defaultValue: "50"
    outputs:
    - contextPath: Vertica.Query
      description: The original query.
      type: string
    - contextPath: Vertica.Row
      description: The content of rows.
      type: string
    description: Executes a query on the Vertica database.
  dockerimage: demisto/py3-tools:1.0.0.114656
  subtype: python3
tests:
- Vertica Test
fromversion: 5.0.0