update_cas_host_instance

This command enables or disables a Configuration Auditing System (CAS) template.

Use this command to enable or disable a CAS host instance by setting the enabled parameter to 1 (enabled) or 0 (disabled). Use the list_cas_host_instances API to find the datasourceName and templateSetLabel parameter values.

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_host_instance

GuardAPI syntax

update_cas_host_instance parameter=value

Parameters

Parameter Value type Description
datasourceName String Required. The data source used for this host instance.
enabled Boolean Required. Enables or disables the host instance. Valid values:
  • 0 (false)
  • 1 (true)
templateSetLabel String Required. The name of the template set that is associated with the host instance.
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 host instance:
  1. Call list_cas_host_instances to find the datasourceName and templateSetLabel.
     grdapi list_cas_host_instances hostName=9.70.150.111

    Id, datasourceName(#), datasourceName, templateSetLabel(#), templateSetLabel, hostName, osType, dbType
c0d2327c8dd550549f2579ab44819a54c3db5e6a, 20002, System (9.70.150.111), 16, Default Unix Template Set, 9.70.150.129, UNX, N_A
ok
  2. Call update_cas_host_instance, and enable the host instance
    grdapi update_cas_host_instance datasourceName=20002 templateSetLabel=16  enabled=1

    ID=c0d2327c8dd550549f2579ab44819a54c3db5e6a
ok