replace_active_profile

Changes the active profile of the GBDI (Big Data) interface, only if the interface is enabled.

This API is available in Guardium V10.5 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/extractionProfile

GuardAPI syntax

replace_active_profile parameter=value

Parameters

Parameter Value type Description
new_active_profile String Required. An existing profile, which replaces the current profile. For valid values, run grdapi get_extraction_profile_info or call replace_active_profile from the command line with --help=true. Valid values:
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

Change the active profile to sql_all. 

new_active_profile profile_name=sql_all