add_dm_to_profile

A profile is a group of data marts that are activated together. Use this command to create a profile from scratch.

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/datamartInProfile

GuardAPI syntax

add_dm_to_profile parameter=value

Parameters

Parameter Value type Description
category String Informational.
cron_string String The schedule setting for the datamart. Omit this parameter to use the default. It's recommended to use the default, which takes into account all the schedules of Guardium's automatic processes. If you are adding a user-defined DM, there is no default cron_string.
datamart_name String Required. Adds this datamart to the profile. For valid values, call add_dm_to_profile from the command line with --help=true.
profile_name String Required. The datamart is added to this profile. For valid values, call add_dm_to_profile from the command line with --help=true.
unit_type String The type of Guardium® system. Valid values:
  • ANY
  • CM
  • CM/STANDALONE
  • AGGREGATOR
  • COLLECTOR
  • STANDALONE
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.

Example

To add the data mart Export:Full SQL to the user defined profile sql_all.

add_dm_to_profile profile_name=sql_all datamart_name=Export:Full SQL