update_group_by_desc

This command updates the configuration of a group identified by its description.

This API is available in Guardium V9.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/update_group_by_desc

GuardAPI syntax

update_group_by_desc parameter=value

Parameters

Parameter Value type Description
category String Update the category. A category is an optional label that is used to group policy violations and groups for reporting.
desc String Required. Identifies the group by its description.
GroupType String Update the group type. For a list of valid group types, see the type parameter of the create_group API.
tuple_parameters String Required. Valid values:
  • client_ip
  • client_host_name
  • server_ip
  • server_host_name
  • source_program
  • db_name
  • db_user
  • os_user
  • db_type
  • net_protocol
  • server_port
  • sender_ip
  • analyzed_client_ip
  • incident
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

Use this command to update the group named A group to use the group type OBJECTS and the category New category:

grdapi update_group_by_desc desc="A group" GroupType=OBJECTS category="New category"