add_stream

This command adds a data stream for cloud database service protection. After you define a Guardium cloud DB service account, you can discover or define available data streams and assign them to Guardium collectors.

This API is available in Guardium V10.6 and later.

REST API syntax

This API is available as a REST service with the POST method. Call this API as follows: 
POST https://[Guardium hostname or IP address]:8443/restAPI/datastream

GuardAPI syntax

add_stream parameter=value

Amazon-specific parameters

Parameter Value type Description
activate Boolean Valid values:
  • 0 (false)
  • 1 (true): Start the data stream.

Default = 0 (false)
cloudTitle String Required. The name of the cloud DB service account. For valid values, call add_stream from the command line with --help=true.

For more information, see Define, modify, and delete AWS DB service accounts.
cluster_resource_id String Required. The cluster resource ID for the AWS RDS cluster associated with the stream.
collectorHostNames String Required. The names of your Guardium collectors, for example: collector01.yourcompany.com

For valid values, call add_stream from the command line with --help=true.
consumerGroupName String Required. The consumer group name that you assign from the Guardium® Cloud DB Service Protection page. For more information, see Discover and configure AWS data streams.
db_DNS_endpoint String Required. The DB DNS endpoint.
dbType String The database for this stream. Valid values:
  • AuroraMySQL - Datastreams only
  • AuroraPostgreSQL - Datastreams only
  • Oracle - Native audit only

Default = AuroraPostgreSQL
port String Required. The DB DNS endpoint port.
region String Required. For valid values, call add_stream from the command line with --help=true.
streamName String Required. The name of the stream from the RDS cluster configuration.
api_target_host String

Specifies the target hosts where the API executes. Valid values:
  • all_managed: execute on all managed units but not the central manager
  • all: execute on all managed units and the central manager
  • group:<group name>: execute on all managed units identified by <group name>
  • host name or IP address of a managed unit: specified from the central manager to execute on a managed unit.  For example, api_target_host=10.0.1.123.
  • host name or IP address of the central manager: specified from a managed unit to execute on the central manager. For example, api_target_host=10.0.1.123.

IP addresses must conform to the IP mode of your network. For dual IP mode, use the same IP protocol with which the managed unit is registered with the central manager. For example, if the registration uses IPv6, specify an IPv6 address. The hostname is independent of IP mode and can be used with any mode.

Azure-specific parameters

Parameter Value type Description
activate Boolean Activates data streaming. Valid values:
  • 0 (false)
  • 1 (true): Start the data stream

Default = 0 (false)
cloudTitle String Required. The name of the cloud DB service account. For more information, see Define, modify, and delete Azure cloud database service accounts.
collectorHostNames String Required. The names of your Guardium collectors, for example: collector01.yourcompany.com

For valid values, call add_stream from the command line with --help=true.
consumerGroupName String Required. The Azure consumer group name.
db_DNS_endpoint String Required. The DB DNS endpoint.
dbType String The database for this event hub stream. Valid values:
  • AzureSQL
  • CosmosSQL
  • CosmosMongoDB
  • CosmosCassandra
  • CosmosGremlin
  • CosmosTable

Default = AzureSQL
namespace String The Azure event hub namespace.
port String Required. The DB DNS endpoint port.
storageConnectionString String The Azure storage connection string name
streamName String Required. The event hub name.
api_target_host String

Specifies the target hosts where the API executes. Valid values:
  • all_managed: execute on all managed units but not the central manager
  • all: execute on all managed units and the central manager
  • group:<group name>: execute on all managed units identified by <group name>
  • host name or IP address of a managed unit: specified from the central manager to execute on a managed unit.  For example, api_target_host=10.0.1.123.
  • host name or IP address of the central manager: specified from a managed unit to execute on the central manager. For example, api_target_host=10.0.1.123.

IP addresses must conform to the IP mode of your network. For dual IP mode, use the same IP protocol with which the managed unit is registered with the central manager. For example, if the registration uses IPv6, specify an IPv6 address. The hostname is independent of IP mode and can be used with any mode.