update_cas_template

This command modifies specified parameters in a Configuration Auditing System (CAS) template.

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

GuardAPI syntax

update_cas_template parameter=value

Parameters

Parameter Value type Description
enabled Boolean Enable or disable the template. Valid values:
  • 0 (false)
  • 1 (true)
isEditable Boolean Set the ability for users to modify to the template. Valid values:
  • 0 (false)
  • 1 (true)
period Integer Change the number of minutes to wait between tests.
saveData Boolean Enable or disable whether to save previous versions of the template item. Valid values:
  • 0 (false)
  • 1 (true)
template String A new name for this template.
templateId Long Required. The internal ID for this template. If needed you can find the template ID by using the list_cas_templatesAPI.
useMD5 Boolean Enables or disable using the uses the MD5 algorithm. Valid values:
  • 0 (false)
  • 1 (true)
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

The following example shows how to find and update information within a CAS template:
  1. Call list_cas_templates to find the template ID and other information about a template to update.
     grdapi list_cas_templates templateSetLabel=testSet
ID=20001
    Id, auditType, template, enabled, period, useMD5, saveData, isEditable
20000, FILE, tempTest, true, 3600, false, false, true
ok
  2. Call update_cas_template to change the name and time period.
    grdapi update_cas_template templateId=20000 template=newName period=5

    ID=20000
ok
  3. Call list_cas_templates again to show the changes/
grdapi list_cas_templates templateSetLabel=testSet
ID=20001
Id, auditType, template, enabled, period, useMD5, saveData, isEditable
20000, FILE, newName, true, 5, false, false, true
ok