GuardAPI CAS Functions

add_cas_host_conf

This command creates, and optionally activates, a new CAS Instance Configuration. A CAS Instance Configuration associates a CAS template set with a CAS host, providing all of the access (login) information needed to apply the template to the host OS or database.

Parameters

Parameter

Description

host

Required string. A CAS agent must be running on that host and reporting to this Guardium appliance (otherwise the CAS host will not be found in Guardium's CAS_AUDIT_HOST table).

instanceName

Required string. Must provide a unique name for this CAS Instance configuration (this is not the database instance name).

templateSetLabel

Required string. Must identify a CAS template set defined on the system. These are defined in the CAS_AUDIT_CONFIG_TEMPLATE_SET table. The default template sets are listed below:

Guardium Unix Template Set

Guardium Unix/DB2 Assessment

Guardium Unix/DB2 Template Set

Guardium Unix/Informix Assessment

Guardium Unix/Informix Template Set

Guardium Unix/MySQL Assessment

Guardium Unix/MySQL Template Set

Guardium Unix/Oracle Assessment

Guardium Unix/Oracle Template Set

Guardium Unix/Sybase Assessment

Guardium Unix/Sybase Template Set

Guardium Windows Template Set

Guardium Windows/DB2 Assessment

Guardium Windows/DB2 Template Set

Guardium Windows/Informix Assessment

Guardium Windows/Informix Template Set

Guardium Windows/MSSQL Assessment

Guardium Windows/MSSQL Template Set

Guardium Windows/MySQL Assessment

Guardium Windows/MySQL Template Set

Guardium Windows/Oracle Assessment

Guardium Windows/Oracle Template Set

Guardium Windows/Sybase Assessment

Guardium Windows/Sybase Template Set

osUser

All of these parameters are optional, and correspond to fields on the CAS Instance Configuration Panel. The requirements for each field vary depending on the operating system and database type. See the CAS Hosts topic for a detailed description of all fields.

dbInstance

dbUser

dbPassword

dbHomeDir

dbPort

enabled

Optional boolean.

Example

grdapi add_cas_host_conf instanceName="An api test1" templateSetLabel=" Guardium Unix/Sybase Assessment"  host=192.168.2.100 osUser=sybase15 dbInstance=sn0ostri dbUser=sa dbHomeDir=/opt/sybase15 dbPort=4200 enabled=true dbPassword=abc123

Error Codes

ERR

Description

600

Could not complete the operation - must specify a value for templateSetLabel

601

Could not complete the operation - invalid templateSetLabel

602

Could not complete the operation - must specify a value for hostName

603

Could not complete the operation - invalid hostName

604

Could not complete the operation - must specify a value for instanceName

605

Could not complete the operation - The specified Template Set and host have different OS types.

606

Could not complete the operation - An Instance with the same name is already configured on this host.

607

Could not complete the operation - duplicate instance name.

608

Could not complete the operation - The dbPassword does not match the reTypedPassword.

609

Error while adding cas host configuration.

remove_cas_host_conf

Removes the specified CAS Instance Configuration (deactivating the instance if it is currently enabled on the host).

Parameters

Parameter

Description

host

Required string. A CAS agent must be running on that host and reporting to this Guardium appliance (otherwise the CAS host will not be found in Guardium's CAS_AUDIT_HOST table).

instanceName

Required string. The name of the CAS Instance configuration to be removed.

Example

grdapi remove_cas_host_conf instanceName="mms_mssql2" host=192.168.2.100

Error Codes

ERR

Description

602

Could not complete the operation - must specify a value for hostName

603

Could not complete the operation - invalid hostName

604

Could not complete the operation - must specify a value for instanceName

620

Could not complete the operation - instanceName does not exist.

621

Error while removing cas host configuration.

update_cas_host_conf

This command updates a CAS Instance Configuration.

Parameters

See the Parameters for add_cas_host_conf, above.

Example

grdapi update_cas_host_conf instanceName="An api test1" templateSetLabel="Guardium Unix/Sybase Template Set" host=192.168.2.100

Error Codes

ERR

Description

601

Could not complete the operation - invalid templateSetLabel

602

Could not complete the operation - must specify a value for hostName

603

Could not complete the operation - invalid hostName

604

Could not complete the operation - must specify a value for instanceName

605

Could not complete the operation - The specified Template Set and host have different OS types.

620

Could not complete the operation - instanceName does not exist.

640

Error while updating cas host configuration.

641

Could not complete the operation - The specified Template Set and CAS instance have different DB types.