modify_guard_param

在线编辑

此通用 API 用于更新各种 Guardium 功能的特定参数的值。

使用此参数的函数包括:
注意： 使用 get_all_modifiable_guard_params 可显示可通过此 API 修改的参数列表。

此 API 在 Guardium V10.5 及更高版本中可用。

REST API 语法

此 API 可通过 POST 方法，以 REST 服务的形式使用。 请按如下方式调用此 API：
POST https://[Guardium hostname or IP address]:8443/restAPI/modify_guard_param

参数

参数 值类型 描述
paramName 字符串 必需。 下列各节中描述的其中一个参数。
paramValue 字符串 必需。 参数的新值。
api_target_host 字符串

指定执行 API 所在的目标主机。有效值：
  • all_managed：在所有受管单元上执行，但不在中央管理器上执行
  • all：在所有受管单元和中央管理器上执行
  • group:<group name>: 在 <group name> 标识的所有受管单元上执行
  • 受管单元的主机名或 IP 地址：从中央管理器指定，以便在受管单元上执行。 例如，api_target_host=10.0.1.123。
  • 中央管理器的主机名或 IP 地址：从受管单元指定，以便在中央管理器上执行。 例如，api_target_host=10.0.1.123。

IP 地址必须符合网络的 IP 方式。 在双重 IP 方式下，请使用向中央管理器注册受管单元时使用的 IP 协议。 例如，如果该注册使用的是 IPv6，请指定 IPv6 地址。 主机名与 IP 方式无关，可以在任何方式下使用。

警报参数

参数 值类型 描述
ALERT_VERB_NUM_LIMIT 整数 设置要显示在警报日志中的最大 SQL 动词数。

有效值为 1 到 50 之间的正整数。 缺省值为 10。
ANTLR3_REMOVE_COMMENTS 布尔值 启用或禁用注释记录。
有效值：
  • 0：启用注释记录
  • 1：禁用注释记录

缺省值 = 0
SMTP_TIMEOUT 整数 警报器 SMTP 超时。
STARTTLS 字符串 设置警报程序电子邮件服务器的 TLS 数据加密。
有效值：
  • TLS：使用 TLS 数据加密。
  • SSL：使用 TLS 数据加密。
  • NONE：关闭 TLS 加密。

分析限制参数

分析限制 参数定义用于 部署运行状况仪表板 和其他位置上的 中央管理器限制 磁贴的阈值。 有关详细信息，请参阅部署健康状况仪表板。

参数 值类型 描述
CLASSIFIER_MEMORY_USAGE_THRESHOLD 整数

有效值：1 - 100
HTTP_GIMSERVER_AUTH_CONNECTIONS_THRESHOLD 整数

有效值：1 - 100
HTTP_GIMSERVER_CONNECTIONS_THRESHOLD 整数

有效值：1 - 100
HTTP_GUI_CONNECTIONS_THRESHOLD 整数

有效值：1 - 100
MYSQL_CONNECTIONS_THRESHOLD 整数

有效值：1 - 100
OPEN_HANDLERS_THRESHOLD 整数

有效值：1 - 100
RUNNING_PROCESSES_THRESHOLD 整数

有效值：1 - 100
UNAUTHENTICATED_CONNECTIONS_THRESHOLD 整数

有效值：1 - 100

CyberArk 参数

Draft comment: anu.baskar@ibm.com
1) When does a customer use these parameters? Do these params update the CyberArk config screen in Guardium? 2) Are the param descriptions accurate?

参数 值类型 描述
CYBERARK_USER_NAME 字符串 更新 CyberArk 用户名。
CYBERARK_USER_PASSWORD 加密字符串 更新加密的 CyberArk 保管库用户密码。
CYBERARK_VAULT_WEBSERVER_NAME 字符串 更新 CyberArk 保管库网络服务器名称。

分类参数

参数 值类型 描述
classifier_running_timeout 整数 设置整理进程 (nanny) 的时间限制（以分钟计）。 在超时周期后，nanny 会将分类器进程视为不活动，并将其重新启动。

有效值：5 - 720

缺省值为 30
classifier_gather_data 布尔值 允许或禁止收集系统数据。
有效值：
  • 0：禁止收集系统数据
  • 1：允许收集系统数据
compare_max_row_threshold 整数 更改显示阈值。

缺省值和最大值：1000 行

分类器示例

使用以下示例来修改 classifier_running_timeout 参数的值。
grdapi modify_guard_param paramName=classifier_running_timeout paramValue=50
使用以下示例来修改 classifier_gather_data 参数的值。
>grdapi get_guard_param paramName=classifier_gather_data
ID=0
classifier_gather_data value: false

>grdapi modify_guard_param paramName=classifier_gather_data paramValue=1
ID=0
ok

>grdapi get_guard_param paramName=classifier_gather_data
ID=0
classifier_gather_data value: true
ok
使用以下示例来查看和修改 compare_max_row_threshold 参数的值。
grdapi get_guard_param paramName=COMPARE_MAX_ROW_THRESHOLD
ID=0
COMPARE_MAX_ROW_THRESHOLD value: 1000
ok

grdapi modify_guard_param paramName=COMPARE_MAX_ROW_THRESHOLD paramValue=91935
modify_guard_param:
ERR=5059
Error  Parameter Value is greater then MAX allowed : 1000
Error in modify_guard_param. Can not process the request
ok

grdapi modify_guard_param paramName=COMPARE_MAX_ROW_THRESHOLD paramValue=999
ID=0
ok

grdapi get_guard_param paramName=COMPARE_MAX_ROW_THRESHOLD
ID=0
COMPARE_MAX_ROW_THRESHOLD value: 999
ok

数据集市参数

参数 值类型 描述
COPYFILE_THREAD_POOL_CORE_SIZE 整数 仅供内部使用，可调整数据集市线程池的大小。
COPYFILE_THREAD_POOL_IDLE_KEEP_ALIVE_TIME_SEC 整数 仅供内部使用，可调整数据集市线程池的大小。
COPYFILE_THREAD_POOL_MAX_SIZE 整数 仅供内部使用，可调整数据集市线程池的大小。
COPYFILE_THREAD_POOL_MAX_TASKS_WAITING 整数 仅供内部使用，可调整数据集市线程池的大小。
CUSTOM_DATAMART_FILE_REMOVE_EXTRA_BACKSLASH 二进制 在提取过程中删除自定义数据集市文件中多余的反斜线。

数据源参数

参数 值类型 描述
allow_datasource_full_control_by_role 布尔值 控制在数据源上分配角色时，是否会将该数据源的完全控制权授予该角色。
有效值：
  • 否
  • 是

缺省值：false
customtable_running_timeout 整数 设置挂起的定制表数据上载的超时机制（以分钟计）。 数据源挂起后，定制数据上载会在超时周期后停止，并跳至队列中的下一个数据源。
DATASOURCE_CONFIRMATION_EXPIRATION_TIME 整数 删除一个数据源（或一组数据源）需要一个确认号码。 默认情况下，确认号码将在 5 分钟后失效。 使用此参数可将过期时间改为 4 至 60 分钟。
MIN_OPTIMIZE_SIZE 整数 对于指定的数据库，设置优化的最小大小。 大小必须在 1000 到 10000000 之间。

数据源示例

使用以下命令可以修改 customtable_running_timeout 参数的值。
grdapi modify_guard_param paramName=allow_datasource_full_control_by_role paramValue=true customtable_running_timeout paramValue=5
使用以下命令可以修改数据源参数的值。
grdapi modify_guard_param paramName=paramName=customtable_running_timeout paramValue=5

运行状况分析器参数

这些参数控制磁盘 (/var) 上数据库大小和文件的预测。 有关更多信息，请参阅 磁盘上的数据库大小和文件 (/var)。

参数 值类型 描述
HEALTH_ANALYZER_DB_LOOKAHEAD_DAYS 整数 如果预测未来的 HEALTH_ANALYZER_DB_LOOKAHEAD_DAYS 天内将会发生 HEALTH_ANALYZER_DB_USAGE_THRESHOLD，那么发送警报。

缺省值：14
HEALTH_ANALYZER_DB_SAMPLE_DAYS 整数 监视数据库增长情况的过往天数。 使用此参数可预测未来使用情况。

缺省值：7
HEALTH_ANALYZER_DB_USAGE_THRESHOLD 整数 发送警报的数据库大小阈值（以百分比计）。 随 Guardium 系统类型不同，100% 大小的含义也不相同（对于收集器，指 /var 的 50%；对于聚集器，指 /var 的 75%）。

范围为 1 - 100%。 缺省值：50
HEALTH_ANALYZER_VAR_LOOKAHEAD_DAYS 整数 如果预测未来的 HEALTH_ANALYZER_VAR_LOOKAHEAD_DAYS 天内将会发生 HEALTH_ANALYZER_VAR_USAGE_THRESHOLD，那么发送警报。

缺省值：14
HEALTH_ANALYZER_VAR_SAMPLE_DAYS 整数 监视 /var 增长情况的天数。 使用此参数可预测未来使用情况。

缺省值：7
HEALTH_ANALYZER_VAR_USAGE_THRESHOLD 整数 发送警报的 /var 大小阈值（以百分比计）。

范围为 1 - 100%。 缺省值：50

检查发动机参数

在 GUI 中配置 数据库发现实例规则 之前，需要通过将 IE_CREATION 参数设置为 1 来启用检查引擎创建。 更多信息，请参阅数据库发现的实例规则和 apply_rules_on_discoveredinstances。

参数 值类型 描述
IE_CREATION 布尔值 要自动创建检查引擎，此参数为必需。 根据是否已在“数据库发现实例规则”页面上启用检查引擎创建，确定 Guardium 是否会在收集器上自动创建检查引擎。
有效值：
  • 0 (false)：禁用检查引擎自动创建。
  • 1 (true)：根据在“数据库发现实例规则”页面上选择的规则，启用检查引擎自动创建。

缺省值 = 0 (false)
IE_PROCESSED_TIMESTAMP 日期

时间戳，用于识别 IE 创建功能已考虑和发现的实例。

管理 SQL 参数

通过这些参数可以管理各种 SQL 详情。

参数 值类型 描述
ALERT_OBJECT_NUM_LIMIT 整数 对象模板变量的一条警报信息中 SQL 对象的最大数量。
DB2_COMMA_DECIMAL_POINT 整数 ANTLR3 DB2 解析器将逗号视为数字精确标记的标志。
DUMP_DATA_FOR_FORENSICS 整数 确定是否将完整的 SQL 详细信息转储到 Kafka 服务器。 完整的 SQL 详细信息可用于取证和分析。 有效值：
  • 0（关）：不转储完整 SQL 详细信息
  • 1（开）：转储完整 SQL 详细信息

缺省值 = 0
LONG_VALUE_SPLIT_IN_CSV 二进制 允许在 CSV 导出过程中将文本分成多行。
MAX_SAVED_CONSTRUCTS 整数 SQL 结构规则的大小。 结果保存在会话中。

nanny 参数

这些参数可以启用并配置将测试消息发送至警报程序或 rsyslog 的功能，以确认它正在与 Guardium 进行通信。

参数 值类型 描述
GENERATE_TOMCAT_DUMP 二进制 触发 Tomcat 核心转储。
NANNY_ALERT_RSYSLOG 整数 控制保姆是否监控 Ryslog 服务器。
NANNY_ALERT_RSYSLOG_FREQ 整数 确定保姆监控 rsyslog 服务器的频率（小时）。
NANNY_TEST_RSYSLOG 整数 确定 nanny 进程是否向 rsyslog 发送测试消息。 有效值：
  • 0 (false)：不向 rsyslog 发送测试消息
  • 1 (true)：将测试消息发送至 rsyslog

成功消息的严重性为 info，错误消息的严重性为 med (error)。

缺省值：1
NANNY_TEST_RSYSLOG_FREQ 整数 确定 nanny 将测试消息发送到 rsyslog 的频率（以小时计）。

缺省值为 0，这表示将频率设置为 5 分钟。
NANNY_TEST_SMTP_ALERTER 整数 确定 nanny 进程是否检查 SMTP 警报程序的状态。

如果设置为 1 (true)，那么 nanny 确定可以连接到服务器端的 SMTP 中继服务器，并将结果报告给 Syslog。 成功消息的严重性为 info，错误消息的严重性为 med (error)。

如果 SMTP 警报程序关闭，那么 Guardium 会尝试将其重新启动，并向 Syslog 报告成功或失败。

有效值：
  • 0 (false)：不测试警报程序
  • 1 (true)：测试警报程序

缺省值：1
NANNY_TEST_SMTP_ALERTER_FREQ 整数 确定 nanny 测试警报程序的频率（以小时计）。

缺省值为 0，这表示将频率设置为 5 分钟。

石英调度程序参数

这些参数为 Quartz 作业调度程序提供输入。

参数 值类型 描述
QUARTZ_LONG_RUNNING_JOB_THRESHOLD 整数 定义 Quartz Scheduler 长时间运行作业阈值 (以分钟为单位)。

缺省值: 600 (分钟)。
QUARTZ_MAX_LONG_RUNNING_JOBS 整数 定义被视为运行状况不佳的长时间运行的 Quartz 调度程序作业的最大数目。

缺省值: 3。
QUARTZ_SCHD_ENABLE_MONITOR 布尔值 启用石英调度程序监视。

缺省值为 0 (off)。

要开启，请设置为 1。

运行时敏感的对象分类器参数

这些参数有助于在运行时识别敏感数据（如信用卡信息）。 更多信息，请参阅运行时敏感对象识别。

参数 值类型 描述
MAX_RSOC_HITS_PER_RETURNED_DATA 整数 定义不使用验证方法的运行时敏感目标识别模式的阈值。

缺省值: 3。

有效值为 1 至 64。
MAX_RSOC_SIGNATURE_HITS_PER_RETURNED_DATA 整数 定义使用验证方法的运行时敏感对象识别模式（如国家身份证或信用卡数据）的阈值。

缺省值为 1。
RUNTIME_SENSITIVE_OBJECT_CLASSIFIER 整数 打开或关闭运行时敏感目标分类。

缺省值为 0 (off)。

要开启，请设置为 1。

智能卡参数

此配置与使用智能卡来登录 Guardium UI 相关。 有关详细信息，请参阅启用智能卡身份验证。

参数 值类型 描述
ENABLE_OCSP_CHECK 二进制

如果开启了智能卡身份验证，则通过 OCSP 检查证书状态。
SMART_CARD_MAPPING_REGEX 字符串 设置“Guardium 门户网站”页面中正则表达式的值，使其与智能卡上的用户信息匹配。

智能卡示例

使用以下命令可以修改 SMART_CARD_MAPPING_REGEX 参数的值。
grdapi modify_guard_param paramName=SMART_CARD_MAPPING_REGEX paramValue="CN?=?(.*?),?OU?=?Test Agency,?OU?=?Test Department,?O?=?Test Government,?C?=?US"

嗅探器参数

使用以下参数来管理嗅探器设置。

参数 值类型 描述
ACTIVE_PARSER_ENGINE 整数
控制 snif 将使用哪个解析器引擎。 选项包括：
  • 1 - 使用 ANTLR3 ，错误由 ANTLR2 重新解析（默认值）
  • 2 - 使用 ANTLR2
  • 3 - 使用 ANTLR3
HOST_SERVICE_OS_NAME_CACHE_SIZE 整数 允许您更改主机名，服务名称或操作系统用户名高速缓存中嗅探器保留值的大小。

缺省值: 2048。

高速缓存大小必须在 1 到 25000 之间。
LOG_GENERAL_RESPONSE_LENGTH 数字 显示是启用还是禁用 store log_general_response_length CLI 命令。

缺省值 :disabled
PE_TRAINING_PHASE_ONE_LENGTH 整数 snif 概率引擎的最短强制培训时间（天数）。
PE_TRAINING_PHASE_TWO_LENGTH 整数

snif 必须在没有新训练数据的情况下进行训练的最短时间（小时）。 遇到新事件时动态扩展。
SAVED_RESPONSE_QUEUE_SIZE 整数 允许您更改已保存响应的队列大小。
SELECTIVE_AUDIT_PRESCREEN_THRESHOLD 整数

如果选择性审核组的成员总数超过此值，Snif 会出于性能目的在内部禁用预审功能。
SNIF_DQ_ARE_LITERALS 整数

控制 snif 默认将哪些数据库类型视为双引号字符串字面量。
SNIF_USE_FEED_ANALYZER_THREAD 整数 Snif 使用饲料分析器线程。
UID_CHAIN_PROCESS_ASYNC 整数 控制 snif 中 UID CHAIN 的同步/异步处理。

SNMP 参数

使用以下参数来设置某些系统 SNMP 设置。

参数 值类型 描述
GUARDIUM_SNMP_TRAP_MSG_OID 字符串 Guardium SNMP 陷阱 OID 的信息。 默认信息为. 1.3.6.1.4.1.18708.1.6.
GUARDIUM_SNMP_TRAP_OID 字符串 指定 Guardium SNMP 陷阱 OID。

使用此参数可将警报器发送 SNMP 陷阱的方式更改为旧值或与监控 SNMP 陷阱的特定服务器一起使用时所需的其他值。 更多信息，请参阅配置警报器。

默认陷阱 OID 为. 1.3.6.1.4.1.18708.1.1.1
SNMP_AUTHENTICATION_PASSWORD 加密 SNMP 验证口令。
SNMP_ENCRYPTION_PASSWORD 加密 SNMP 加密口令。
SNMP_ENGINE_ID 字符串 如果需要，请更改 SNMP 引擎标识。 使用 show system snmp engineid CLI 命令可查看当前引擎标识。
注: 引擎标识必须唯一。
SNMP_USER_AUTHENTICATION_TYPE 字符串 v3 的 SNMP 用户身份验证类型。
SNMP_USER_ENCRYPTION_TYPE 字符串 v3 的 SNMP 用户加密类型。
SNMPV3_USER 字符串 创建新的 SNMP V3 用户帐户。 Guardium 建议您使用 store system snmp user CLI 命令来创建新用户。
SNMP_VERSION 字符串 为此机器设置 SNMP 版本。

有效值 = v2c 或 v3

Syslog TCP 参数

这些参数管理系统日志中的 TPC 接收。

参数 值类型 描述
SYSLOG_TCP_RECEPTION_ON 整数 控制是否开启系统日志 TCP 接收。

缺省值: 1 (off)

设置为 0 以开启。
SYSLOG_TCP_RECEPTION_PORT 整数 指定要用于系统日志 TCP 接收的端口。

缺省值: 10514。

端口号必须介于 1 与 65535 之间。

威胁分析参数

参数 值类型 描述
EI_FAILED_LOGIN_DB_USER_THRESHOLD 数字 威胁分析失败登录的数据库用户阈值。 缺省值: 2。
EI_GRANT_DORMANT_WEEKS_DEFINITION 数字 将用户注册为休眠以进行威胁分析的无活动周数。 缺省值: 8。

脆弱性评估参数

Draft comment: anu.baskar@ibm.com
are the descriptions accurate?

参数 值类型 描述
ALLOW_NULL_SERVICE_FOR_VA_SUMMARY 二进制 退伍军人事务部摘要的名称。

如果服务中出现 NULL，则设为 DEFAULT。

Draft comment: anu.baskar@ibm.com
What does NULL in service mean? When does the customer need this?
INAPPLICABLE_TEST_RESULT_STATUS 二进制

允许您从漏洞评估测试报告中包含或排除不支持的数据库版本的测试分数。

0：排除测试分数为 "NOT APPLICABLE（不适用）"的测试结果。

1: 包括测试结果为 "不适用 "的测试。
提示： 对于定义了支持数据库版本范围的漏洞评估测试，如果数据源版本不在该范围内，测试将返回 "NOT APPLICABLE（不适用）"分值。
SAVE_TEST_RESULT_DETAIL_STRING 二进制

控制检测结果的详细信息。

默认 = true，在测试结果中包含详细信息。

如果为假，则测试结果中不包含详细信息。

其他参数

参数 值类型 描述
ENABLE_GUARDIUM_INSIGHT_STREAMING 二进制 用于 Guardium Insight 流媒体。 启用或禁用到 Guardium Insights 的数据流。
有效值：
  • 真：启用 Insights 流
  • 假（默认）：禁用 Insights 流
注意： 此设置会将流量发送到 Guardium Insights。 验证 Guardium Insights 是否已配置为接收和分析来自 Guardium 系统的流量。
ESCAPE_FOR_ARCSIGHT 二进制

不推荐。
FUTURE_PARTITION_EXPAND_DELAY_HOURS 整数 创建未来分区前的最长延迟时间。 仅在 Guardium 技术支持部门的建议下更改此参数。

默认值 = 0。
INFORMIX_SAVED_RESPONSE_QUEUE_SIZE 整数 Informix 保存响应的队列大小。
Draft comment: miriam.lezak@ibm.com
no info available
KEEP_NUMBER_OF_JAVACORE_BUNDLE 整数 要保留的 javacore 文件包的数量。 数字必须在 1 到 30 之间。 缺省值: 3。
LDAP_CONN_TIMEOUT_MILLISEC 整数 设置 LDAP 测试连接超时前的毫秒数。

默认 = 5000（5 秒）

该值必须在 1000 到 300000 ms 之间。
PATCH_PRESERVATION 整数 控制是否保留失败的修补程序。 当设置为 1（开启）时，如果补丁失败，您可以进行修正，然后重新运行补丁，而无需再次下载。

默认 = 0（关闭）。
SIZE_OF_RAW_STATEMENT_MAP 整数 控制原始语句映射的大小。 要查看原始语句映射的当前大小，请使用 get_guard_param 命令。 例如：
>grdapi get_guard_param paramName="SIZE_OF_RAW_STATEMENT_MAP"

默认 = 2048
WAF_F5_METHOD 整数 客户特定参数。 不再使用。
Draft comment: miriam.lezak@ibm.com
need more info