Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › CLI Agent Configuration Methods

CLI Agent Configuration Methods

AddAssociation Method—Adds a Name and Value for this Configuration

The AddAssociation method adds a configuration parameter name and value for this agent configuration.

Syntax

The AddAssociation method has the following format:

Netegrity::PolicyMgtAgentConfig‑>AddAssociation(Name, Value, Flags)

Parameters

The AddAssociation method accepts the following parameters:

Name (string)

Specifies the configuration parameter name.

Value (string)

Specifies the configuration parameter value.

Flag (int)

Specifies the encryption flag value:

• 1 if the name/value pair is stored in encrypted format
• 0 if the name/value pair is stored as plain text

Return Value

The AddAssociation method returns one of the following values:

• A PolicyMgtAssociation Object
• undef if the call was unsuccessful

AddAssociationMultiValue Method—Adds a Multi-valued Configuration Parameter

The AddAssociationMultiValue method adds a multi-valued configuration parameter for this agent configuration. If the specified configuration parameter exists, the new value is concatenated with the old value.

Note: Do not call this method more than once in a session. Otherwise, the new value overwrites the old value.

Syntax

The AddAssociationMultiValue method has the following format:

Netegrity::PolicyMgtAgentConfig‑>AddAssociationMultiValue(Name, valueArray)

Parameters

The AddAssociationMultiValue method accepts the following parameters:

Name (string)

Specifies the configuration parameter name.

valueArray (string array)

Specifies a reference to an array of values associated with this parameter name (for example: \@myarray).

Return Value

The AddAssociationMultiValue method returns one of the following values:

• A PolicyMgtAssociation object
• undef if the call was unsuccessful

Remarks

Multi-valued parameters can be stored only as plain text.

Description Method—Sets or Retrieves the Description of the Agent Configuration Object

The Description method sets or retrieves the description of the agent configuration object.

Syntax

The Description method has the following format:

Netegrity::PolicyMgtAgentConfig‑>Description([Description])

Parameters

The Description method accepts the following parameters:

Description (string)

(Optional) Specifies the description to set.

Return Value

The Description method returns one of the following values:

• The new or existing description of the agent configuration object
• undef if the call was unsuccessful

GetAssociations Method—Retrieves a List of All the Configuration Parameters

The GetAssociations method retrieves a list of all the configuration parameters for this agent configuration.

Syntax

The GetAssociations method has the following format:

Netegrity::PolicyMgtAgentConfig‑>GetAssociations( )

Parameters

The GetAssociations method accepts no parameters.

Return Value

The GetAssociations method returns one of the following values:

• An array of PolicyMgtAssociation objects. Each object includes a configuration parameter name and its associated value.
• undef if no configuration parameter objects exist, or if the call is unsuccessful

Name Method—Sets or Retrieves the Agent Configuration Object Name

The Name method sets or retrieves the agent configuration object name.

Syntax

The Name method has the following format:

Netegrity::PolicyMgtAgentConfig‑>Name([Name])

Parameters

The Name method accepts the following parameters:

Name (string)

(Optional) Specifies the name to set.

Return Value

The Name method returns one of the following values:

• The new or existing agent configuration object name
• undef if the call was unsuccessful

RemoveAssociation Method—Removes a Configuration Parameter

The RemoveAssociation method removes a configuration parameter name/value pair from the agent configuration object.

Syntax

The RemoveAssociation method has the following format:

Netegrity::PolicyMgtAgentConfig‑>RemoveAssociation(assoc)

Parameters

The RemoveAssociation method accepts the following parameter:

assoc (PolicyMgtAssociation)

Specifies the configuration parameter name/value pair to remove.

Return Value

The RemoveAssociation method returns one of the following values:

• 0 on success
• -1 if the call was unsuccessful