GuardAPI Process Control Functions

Use these GuardAPI commands to execute, copy, upload, list, and delete Process Control Functions.

execute_cls_process

Executes (submits) a classification process. It is equivalent of executing Run Once Now from Classification Process Builder. It submits the job which places the process on the Guardium® Job Queue, from which the appliance runs a single job at a time. Administrators can view the job status by selecting Guardium Monitor > Guardium Job Queue.

Note: Create a classification process before calling this API.

Parameter	Value	Description
processName	string	Name of the classification process
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Example

grdapi execute_cls_process processName="classPolicy1"

execute_assessment

Executes (submits) a security assessment. It is equivalent of executing Run Once Now from Security Assessment Finder. It submits the job. This places the process on the Guardium Job Queue, from which the appliance runs a single job at a time. Administrators can view the job status by selecting Guardium Monitor > Guardium Job Queue.

Note: Create a Security Assessment before calling this API.

Parameter	Value	Description
assessmentDesc		Name of the assessment
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Example

grdapi execute_assessment assessmentDesc="assessment1"

execute_auditProcess

Executes an Audit process. Runs the specified audit process. It is equivalent of executing Run Once Now from Audit Process Builder.

Note: Create an audit process before calling this API.

Note: If the audit report returns a lot of data, the user should execute the audit process from the GUI, due to CLI command heap size limitation.

Parameter	Value	Description
auditProcess		Name of the audit process
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Example

grdapi execute_auditProcess  auditProcess="Appliance Monitoring"

stop_audit_process

The stop_audit_process API can not be used through the GuardAPI command line. This function is only usable as an invocation through a drill down. See the sub-topic, Stop an audit process, in Compliance Workload Automation help topic.

Parameter	Value	Description
process		Name of the audit process
run		The RunID of the audit process
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Example

stop_audit_process

execute_populateGroupFromQuery

Executes a populate group from query. It populates the chosen group by executing a configured query. It is the equivalent of executing Run Once Now from Populate Group From Query Set Up screen. If the group is not configured for import, it displays an error message.

Note: This grdapi can only be used for groups that have already been configured in Populate Group From Query Set Up screen (query should have been chosen and parameters should have been set)

Parameter	Value	Description
groupDesc		Group name
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Example

grdapi execute_populateGroupFromQuery  groupDesc="A test"

grdapi execute_appUserTranslation

Execute an application user translation. Imports the user definitions for all configured applications in Application User Translation Configuration screen. It is equivalent of executing Run Once Now from Application User Translation Configuration screen.

Note: To run this grdapi, must define at least one Application User Detection in Application User Translation Configuration screen. If not a message will be displayed.

Parameter	Value	Description
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Example

grdapi execute_appUserTranslation

execute_flatLogProcess

Merges the flat log information to the internal database. It is equivalent of executing Run Once Now from Flat Log Process screen.

Note: This grdapi can only be executed if Flat Log Process is configured as Process in Flat Log Process screen. If not, an error message will be displayed.

Parameter	Value	Description
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Example

grdapi execute_flatLogProcess

execute_incidentGenProcess

Executes a query which is defined for the selected incident generation process, using the processId, against the policy violations log. It generates incidents based on that query. It is equivalent of executing Run Once Now from Edit Incident Generation Process screen.

Note: Create a Incident Generation Process before calling this API.

Parameter	Value	Description
processID		Process ID of the incident
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Example

grdapi execute_incidentGenProcess   processId=20003

execute_incidentGenProcess_byDetails

Executes a query which is defined for the selected incident generation process, using the query name, against the policy violations log. It generates incidents based on that query. It is equivalent of executing Run Once Now from Edit Incident Generation Process screen.

Note: Create a Incident Generation Process before calling this API.

Parameter	Value	Description
queryName		Query name
categoryName		Category Name
user		User
threshold		Threshold
severity		Severity level
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Example

grdapi  execute_incidentGenProcess_byDetails  queryName="Policy Violation Count" user=admin severity=info

upload_custom_data

Executes (submits) a classification process. Uploads data to the custom table specified by tableName. It is the equivalent of executing Upload from Import Data screen of Custom Table Builder. To run this grdapi, must first configure the specified custom table in Import Table Structure of Custom Table Builder. From the UI, go to Tools/Report Builder/Custom Table Builder, select a Custom Table, click upload data, and select datasource.

Parameter	Value	Description
tableName	existing custom table	Name of custom table
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Example

grdapi upload_custom_data tableName="TEST_TABLE"

execute_ldap_user_import

Import LDAP users. It imports Guardium user definitions from an LDAP server configured in LDAP User Import screen. It is equivalent of executing Run Once Now from LDAP User Import screen. (login in as accessmgr /LDAP Import)

Note: LDAP must be configured. Otherwise, the system will give an error message.

Parameter	Value	Description
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Example

grdapi execute_ldap_user_import

policy_install

Install a policy or multiple policies. If multiple policies are to be installed then the policies need to be delimited by a pipe character '|' with policies being in the order you want to be installed. This needs to be done even if only one policy might have had changes.

Install multiple policies with grdapi policy_install command. Install by position by specifying the policies in the order that you want to install.

Even in UI, when you install a policy after another installed policy, it will reinstall all of them. which is the same as grdapi policy_install command.

Parameter	Value	Description
policy		Policy name
api_target_host		In a central management configuration only, allows the user to specify a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Examples

grdapi policy_install policy="Policy 1|Policy 2"

grdapi policy_install policy="policy 20|policy 30|policy 40"

delete_policy

Use the delete_policy command to delete a policy specified by the policyDesc parameter.

Parameter	Value	Description
policyDesc		Policy name.
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Example

grdapi delete_policy policyDesc="Hadoop Policy"

list_policy

Use the list_policy command to display a list of available policies or to display details about a single policy.

Parameter	Value	Description
policyDesc		Policy name. If unspecified, the list_policy command returns a list of available policies.
detail		Accepts values of true or false. The default value is true and returns policy details. Specifying a value of false returns only policy names.
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Examples

Display details of a specific policy:

grdapi list_policy policyDesc="Hadoop Policy"

Display a detailed list of available policies:

grdapi list_policy

Display a list of available policy names (no details):

grdapi list_policy detail=false

copy_rule

Copy a rule <ruleDesc> of <fromPolicy> to the end of <toPolicy> rule's list.

Note: It Copies a rule of <fromPolicy> to the end of <toPolicy> rule's list. Both <fromPolicy> and <toPolicy> must be created, before running this grdapi.

Parameter	Value	Description
ruleDesc		Rule Description
fromPolicy		Policy name
toPolicy		Policy name
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Example

grdapi copy_rule ruleDesc="Rule Description" fromPolicy="policy1"  toPolicy=" policy2  "

clone_policy

Use this GuardAPI command to clone a policy.

Parameter	Value	Description
policyDesc		Policy name
clonedpolicyDesc		Cloned Policy name
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Example

grdapi clone_policy policyDesc="Hadoop Policy" clonedPolicyDesc="Hadoop Policy cloned1"

update_rule

Update policy rule. Update a rule <ruleDesc> of <fromPolicy> for a rule parameter.

See Policies for additional information on the following policy rule parameters that can be altered with the update_rule API call.

Parameter	Value	Description
ruleDesc		Rule Description
fromPolicy		Policy name
newDesc		New Rule Description
clientIP		Client IP
clientNetMask		Client Net Mask
serverIP		Server IP
serverNetMask		Server Net Mask
objectName		Object Name
sourceProgram		Source Program
dbName		Database Name
dbUser		Database User
command		Command
appUserName		Application User Name
dateTime		Date and Time
logFlag		Log Flag
exceptionType		Exception Type
minCount		Minimum Count
continueToNext		Continue to Next
resetInterval		Reset Interval
serviceName		Service Name
osUser		O/S User
dbType		Database Type
netProtocol		Net Protocol
clientMac		Client MAC
fieldName		Field Name
pattern		Patter
appEventExists		Application Event Exists
eventType		Event Type
appEventStrValue		Application Event String Value
appEventNumValue		Application Event Number Value
appEventDate		Application Event Date
eventUserName		Event User Name
errorCode		Error Code
severity		Severity
category		Category
classification		Classification
dataPattern		Data Pattern
sqlPattern		SQL Pattern
xmlPattern		XML Patter
mvcSystem		MVS™ System
clientIpNotFlag		Client IP Not Flag
serverIpNotFlag		Server IP Not Flag
objectNameNotFlag		Object Name Not Flag
sourceProgramNotFlag		Source Program Not Flag
dbNameNotFlag		Database Name Not Flag
dbUserNotFlag		Database User Not Flag
commandNotFlag		Command Not Flag
appUserNameNotFlag		Application User Name Not Flag
exceptionTypeIdNotFlag		Exception Type ID Not FLag
serviceNameNotFlag		Service Name Not Flag
osUserNotFlag		O/S User Not Flag
clientMacNotFlag		Client MAC Not Flag
fieldNameNotFlag		Field Name Not Flag
errorCodeNotFlag		Error Code Not Flag
replacementChar		Replacement Character
messageTemplate		Message Template
recordsAffectedThreshold		Records Affected Threshold
matchedReturnedTreshold		Matched Returned Treshold
clientIpGroup		Client IP Group
serverIpGroup		Server IP Group
objectGroup		Object Group
objectCommandGroup		Object Command Group
objectFieldGroup		Object Field Group
dbUserGroup		Database User Group
commandsGroup		Commands Group
dbNameGroup		Database Name Group
sourceProgramGroup		Source Program Group
appUserGroup		Application User Group
serviceNameGroup		Service Name Group
osUserGroup		O/S User Group
netProtocolGroup		Net Protocol Group
fieldNameGroup		Field Name Group
errorGroup		Error Group
appEventStrGroup		Application Event String Group
clientProgramUserServerInstanceGroup		Client Program User Server Instance Group
quarantineMinutes		Quarantine Minutes
clientInfo		Use for DB2 and DB2_COLLECTION_PROFILE
clientInGroup		Use for DB2_COLLECTION_PROFILE
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Example

grdapi update_rule ruleDesc="Rule Description" fromPolicy="policy1"  serviceName="ANY"

change_rule_order

Change policy rule order. Change the ordered position of a rule within a policy.

Parameter	Value	Description
fromPolicy		Policy name
order		New order position for Rule
ruleDesc		Rule Description
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Example

grdapi change_rule_order ruleDesc="Copy of policy1 exception1"  fromPolicy="policy1"  order=10

list_policy_rules

List the rules for a policy.

Parameter	Value	Description
policy		Policy name
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Example

grdapi list_policy_rules  policy="policy1"

delete_rule

Remove a rule from a policy.

Parameter	Value	Description
fromPolicy		Policy name
toPolicy		Policy name
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Example

grdapi delete_rule ruleDesc="Copy (3) of policy1 exception1"  fromPolicy="policy1"

uninstall_policy_rule

Use the uninstall_policy_rule command to uninstall the policy rule(s) specified by the policy and ruleName parameters.

Parameter	Value	Description
policy		Policy name.
ruleName		Rule name(s). Specify multiple policy rules using the pipe character, for example `ruleName="rule1\|rule2\|rule3`.
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Examples

Uninstall a single policy rule:

grdapi uninstall_policy_rule policy="Hadoop Policy" ruleName="Low interest Objects: Allow"

Uninstall multiple policy rules:

grdapi uninstall_policy_rule policy="Hadoop Policy" ruleName="Low interest Objects: Allow|Low Interest Commands: Allow"

reinstall_policy_rule

Use the reinstall_policy_rule command to reinstall the policy rule(s) specified by the policy and ruleName parameters.

Parameter	Value	Description
policy		Policy name.
ruleName		Rule name(s). Specify multiple policy rules using the pipe character, for example `ruleName="rule1\|rule2\|rule3`.
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Examples

Reinstall a single policy rule:

grdapi reinstall_policy_rule policy="Hadoop Policy" ruleName="Low interest Objects: Allow"

Reinstall multiple policy rules:

grdapi reinstall_policy_rule policy="Hadoop Policy" ruleName="Low interest Objects: Allow|Low Interest Commands: Allow"

delete_Audit_process_result

Use this command to delete any audit process results.

Parameter	Value	Description
ExecutionDateFrom		When did audit process begin
ExecutionDateTo		When did audit process end
ProcessName		Required. What is name of audit process
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Example

grdapi delete_Audit_process_result ExecutionDateFrom=, ExecutionDateTo=, ProcessName=abab

create_api_parameter_mapping

Map API parameters to Domain entities and attributes so the parameters can be populated by report values on API call generation or API automation.

Note: The Mapping GuardAPI Parameters to Domain Entities and Attributes in GuardAPI Input Process Generation shows the domains, entities and attributes of the system and has a GUI interface to invoke this API function.

Parameter	Value	Description
functionName		Name of the API function
parameterName		Name of the parameter within the API function to be mapped
domain		Any of the Guardium reporting domains such as Access, Alert, Discovered Instances, Exceptions, Group Tracking, etc.
entityLabel		Any of the entities for the reporting domain
attributeLabel		Any of the attributes within the entity
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Example

grdapi create_api_parameter_mapping functionName="create_group" parameterName="desc" domain="Group Tracking" entityLabel="Group" attributeLabel="Group Description"

list_param_mapping_for_function

List the parameter mappings for an API function.

Parameter	Value	Description
functionName		Name of the API function
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Example

grdapi list_param_mapping_for_function functionName="create_group"

delete_api_parameter_mapping

Delete API Parameter Mappings for Domain Entities and Attributes. Remove the parameter mappings for an API function.

Parameter	Value	Description
functionName		Name of the API function
parameterName		Name of the parameter within the API function to be mapped
domain		Any of the Guardium reporting domains such as Access, Alert, Discovered Instances, Exceptions, Group Tracking, etc.
entityLabel		Any of the entities for the reporting domain
attributeLabel		Any of the attributes within the entity
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Example

grdapi delete_api_parameter_mapping functionName="create_group" parameterName="desc" domain="Group Tracking" entityLabel="Group" attributeLabel="Group Description"

close_default_events

Close all the events defined on a specific process/task/execution. Close all the events defined on a specific process/task/execution for tasks of type report. Specially needed if for example there is a task with a default event that returned a large number of records, such task can not be signed unless all the events are closed.

Parameter	Value	Description
eventStatus		Required. Event status. Must be a valid status for the default event defined for the audit task and must be a final status.
execDate		Required. Execution Date and Time
processDesc		Required. Audit process description.
taskDesc		Required. Audit task description.
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

Example

grdapi close_default_events eventStatus=Done execDate="2010-03-01 08:00:00" processDesc="Audit Process" taskDesc="Task Description"

create_quarantine_allowed_until

Use in Policies.

Parameter	Value	Description
allowedUntil		Required.
dbUser		Required. Database user
serverIP		Required. Server IP
serverName		Required. Server name
Type		Required. Value must be one of: normal, DB2z, or IMS.
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

create_quarantine_until

Use in Policies.

Parameter	Value	Description
quarantineUntil		Required.
dbUser		Required. Database user
serverIP		Required. Server IP
serverName		Required. Server name
Type		Required. Value must be one of: normal, DB2z, or IMS.
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

delete_quarantine_until

Use in Policies.

Parameter	Value	Description
quarantineUntil		Required.
dbUser		Required. Database user
serverIP		Required. Server IP
serverName		Required. Server name
Type		Required. Value must be one of: normal, DB2z, or IMS.
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

must_gather

Use grdapi must_gather command to collect information on the state of the Guardium system that can be used by Guardium Support. See Basic information for IBM Support for further information on this topic.

Parameter	Value	Description
commandsList		String - required
description		String - required
duration		Integer - required
emailDestination		String - required
invokingUser		String - required
maxLength		Integer - required
pmrNumber		String - required
start		Date - required
timestamp		Date - required
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

restart_job_queue_listener

Use the restart_job_queue_listener command to restart the job queue listener if the job queue fails to start, does not run waiting jobs, or if a job appears stuck in running or stopping status for a prolonged period of time. Issuing this command immediately restarts the job queue, and any currently executing jobs will be halted and restarted.

Example:

grdapi restart_job_queue_listener

The restart_job_queue_listener command does not accept any parameters.

update_quarantine_allowed_until

Use in Policies.

Parameter	Value	Description
allowedUntil		Required.
dbUser		Required. Database user
serverIP		Required. Server IP
serverName		Required. Server name
Type		Required. Value must be one of: normal, DB2z, or IMS.
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.

update_quarantine_until

Use in Policies.

Parameter	Value	Description
quarantineUntil		Required.
dbUser		Required. Database user
serverIP		Required. Server IP
serverName		Required. Server name
Type		Required. Value must be one of: normal, DB2z, or IMS.
api_target_host	hostname or IP address	Optional parameter that specifies the target host(s) to execute the API. When not specified, it defaults to the unit on which command is executed. Valid values: all_managed: for all managed units all: all managed units and CM group:<group name>: where group name is a group of managed units from CM only, the host name or IP of any managed unit, for example, `api_target_host=10.0.1.123` from managed unit, the host name or IP of the CM Guardium V10.1 and 10.1.2: In a central management configuration only, specifies a target host where the API will execute. On a Central Manager (CM) the value is the host name or IP of any managed units. On a managed unit it is the host name or IP of the CM.