apply_rules_on_discoveredinstances

This API pulls information that is defined in the Database Discovered Instances Rules UI and immediately applies the rules to the S-TAPs on the primary collectors. Run apply_rules_on_discoveredinstances only on Guardium managed units or stand-alone systems.

For more information about discovered instances rules, see Database discovered instances rules.

This API is available in Guardium V10.6 and V11.1 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/applyRules

GuardAPI syntax

apply_rules_on_discoveredinstances parameter=value

Parameters

Parameter Value type Description

Parameter	Value type	Description
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

>grdapi apply_rules_on_discoveredinstances api_target_host=10.0.1.123

>grdapi apply_rules_on_discoveredinstances debug=2

Sample output

ID=0
Global rules are enabled.
Collector rules are enabled.
Number of discovered instances: 9
Processed timestamp: 2022-05-03 06:49:24.0
Updated timestamp: Tue May 03 17:59:40 EDT 2022

Warnings: []0.0.234.157=

    addedEngines=[]
    discoveredInstances=[b91c2e6854c67370f32f72a6c7c9fe844d15652a, 79cbfb016426dd4cbce50aa2c57a3468c7e1d185, ca9bfe29dcb02d136648b229828f40333e839e93]
    excludedEngines=[]
    excludedInstances=[]
    filteredInstances=[b91c2e6854c67370f32f72a6c7c9fe844d15652a]
    ignoredEngines=[oracle_0.0.234.157(1521,1521,DB_1), oracle_0.0.234.157(1521,1521,DB_2)]
    messages=[]
    replacedEngines=[]

0.0.234.158=

    addedEngines=[]
    discoveredInstances=[e6f108f9a197db3040aa3647093605a8da12345, 4cb7c413c01c615abdb249bb2231ec54c8612345, 4ef2ec20cf2449cc9876ba417a65a2ba1a12345]
    excludedEngines=[]
    excludedInstances=[]
    filteredInstances=[4ef2ec20cf2449cc9876ba417a65a2ba1a12345]
    ignoredEngines=[oracle_0.0.234.158(1521,1521,DB_0), oracle_0.0.234.158(1521,1521,DB_1)]
    messages=[]
    replacedEngines=[]
 ...