get_extraction_profile_info

Lists one or more GBDI (Big Data) profiles and whether they are active, and optionally the datamarts and schedules for each profile.

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

REST API syntax

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

GuardAPI syntax

get_extraction_profile_info parameter=value

Parameters

Parameter Value type Description
profile_name String If specified, it is used as search filter, returning all profile names containing the specified string.
verbose Boolean Valid values:
  • 0 (false): lists the profile name and indicates if a profile is active.
  • 1 (true): lists the datamarts and schedules for each profile.
Default = 0 (false)
verbosity_flags String  
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

View details of the profile sql_all.

get_extraction_profile_info profile_name=sql_all verbose=1