local_enable_big_data_interface

Run this command on a collector that was offline or not in the MU group when the profile was activated; or on a collector that is not in the MU group, to add its data included the the extraction defined by the profile. Advanced users can use this command for extracting data from collectors that use a different profile.

For example, two managed units of a central manager run only VA, and the other managed units are tracking other data. You would create a second profile that is a subset of the main profile, and run it only on the specified units. However, the local profile does not have a target for the data; add it using the command: datamart_update_copy_file_info.

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

REST API syntax

This API is available as a REST service with the PUT method. Call this API as follows:

PUT https://[Guardium hostname or IP address]:8443/restAPI/bigDataInterface

GuardAPI syntax

local_enable_big_data_interface parameter=value

Parameters

Parameter Value type Description

profile_name String Required. An existing profile. For valid values, run grdapi get_extraction_profile_info or call local_enable_big_data_interface from the command line with --help=true.

start_date Date When to start sending data to the Big Data datasource. Default = time at which the command is executed. Format is either NOW -<n> <minute | hour | day | week | month; or yyyy-mm-dd hh:mm:ss

Parameter	Value type	Description
profile_name	String	Required. An existing profile. For valid values, run grdapi get_extraction_profile_info or call local_enable_big_data_interface from the command line with `--help=true`.
start_date	Date	When to start sending data to the Big Data datasource. Default = time at which the command is executed. Format is either `NOW -<n> <minute \| hour \| day \| week \| month`; or `yyyy-mm-dd hh:mm:ss`
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.

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.

Examples

To add the managed units adata to the profile sql_all:

local_enable_big_data_interface profile_name=sql_all