Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › CLI Group Methods

CLI Group Methods

Add Method—Adds an Agent, Response, Rule, or Nested Group Object to the Group

The Add method adds an agent, response, rule, or nested group object to the group.

Syntax

The Add method has the following format:

Netegrity::PolicyMgtGroup‑>Add(newMember)

Parameters

The Add method accepts the following parameter:

newMember (objectType)

Specifies the member to add to the group. objectType can be any one of the following:

• PolicyMgtAgent
• PolicyMgtResponse
• PolicyMgtRule
• PolicyMgtGroup

Return Value

The Add method returns one of the following values:

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

Contains Method—Determines whether the Group Contains the Specified Agent, Response, Rule, or Nested Group Object

The Contains method determines whether the group contains the specified agent, response, rule, or nested group object.

Syntax

The Contains method has the following format:

Netegrity::PolicyMgtGroup‑>Contains(object)

Parameters

The Contains method accepts the following parameter:

object (objectType)

Specifies the object to check. objectType can be any one of the following:

• PolicyMgtAgent
• PolicyMgtResponse
• PolicyMgtRule
• PolicyMgtGroup

Return Value

The Contains method returns one of the following values:

• 1 if the group contains the specified object
• 0 if the group does not contain the specified object
• undef if the call was unsuccessful

Description Method—Sets or Retrieves the Description of the Group Object

The Description method sets or retrieves the description of the group object.

Syntax

The Description method has the following format:

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

Parameters

The Description method accepts the following parameter:

Description (string)

(Optional) Specifies the description to set.

Return Value

The Description method returns one of the following values:

• A new or existing description
• An empty string if the call was unsuccessful

GetAgent Method—Retrieves the Specified Agent Object from the Group

The GetAgent method retrieves the specified agent object from the group.

Syntax

The GetAgent method has the following format:

Netegrity::PolicyMgtGroup‑>GetAgent(agentName)

Parameters

The GetAgent method accepts the following parameter:

agentName (string)

Specifies the name of the agent to retrieve.

Return Value

The GetAgent method returns one of the following values:

• A PolicyMgtAgent object
• undef if no such agent is found, if the group contains objects of another type, or if the call was unsuccessful

GetAgentGroup Method—Retrieves an Agent Group Object Nested within the Group

The GetAgentGroup method retrieves an agent group object nested within the group.

Syntax

The GetAgentGroup method has the following format:

Netegrity::PolicyMgtGroup‑>GetAgentGroup(groupName)

Parameters

The GetAgentGroup method accepts the following parameter:

groupName (string)

Specifies the name of the agent group to retrieve.

Return Value

The GetAgentGroup method returns one of the following values:

• A PolicyMgtGroup object
• undef if the call was unsuccessful, or if the group does not exist

GetAgentType Method—Retrieves the Type of the Agent Objects Contained in the Group

The GetAgentType method retrieves the type of the agent objects contained in the group (for example, Web Agent).

Syntax

The GetAgentType method has the following format:

Netegrity::PolicyMgtGroup‑>GetAgentType( )

Parameters

The GetAgentType method accepts no parameters:

Return Value

The GetAgentType method returns one of the following values:

• A PolicyMgtAgentType object
• undef if the call was unsuccessful

GetAllAgentGroups Method—Retrieves All the Agent Group Objects Nested within the Group

The GetAllAgentGroups method retrieves all the agent group objects nested within the group.

Syntax

The GetAllAgentGroups method has the following format:

Netegrity::PolicyMgtGroup‑>GetAllAgentGroups( )

Parameters

The GetAllAgentGroups method accepts no parameters.

Return Value

The GetAllAgentGroups method returns one of the following values:

• An array of PolicyMgtGroup objects
• undef if the call is unsuccessful

GetAllAgents Method—Retrieves All the Agent Objects in the Group

The GetAllAgents method retrieves all the agent objects in the group.

Syntax

The GetAllAgents method has the following format:

Netegrity::PolicyMgtGroup‑>GetAllAgents( )

Parameters

The GetAllAgents method accepts no parameters.

Return Value

The GetAllAgents method returns one of the following values:

• An array of PolicyMgtAgent objects
• undef if no agents are found, if the group contains objects of another type, or if the call is unsuccessful

GetAllResponseGroups Method—Retrieves All the Response Group Objects Nested within the Group

The GetAllResponseGroups method retrieves all the response group objects nested within the group.

Syntax

The GetAllResponseGroups method has the following format:

Netegrity::PolicyMgtGroup‑>GetAllResponseGroups( )

Parameters

The GetAllResponseGroups method accepts no parameters.

Return Value

The GetAllResponseGroups method returns one of the following values:

• An array of PolicyMgtGroup objects
• undef if no response groups are found, if the group contains objects of another type, or if the call is unsuccessful.

GetAllResponses Method—Retrieves All the Response Objects in the Group

The GetAllResponses method retrieves all the response objects in the group.

Syntax

The GetAllResponses method has the following format:

Netegrity::PolicyMgtGroup‑>GetAllResponses( )

Parameters

The GetAllResponses method accepts no parameters.

Return Value

The GetAllResponses method returns one of the following values:

• An array of PolicyMgtResponse objects
• undef if no response objects are found, if the group contains objects of another type, or if the call is unsuccessful.

GetAllRuleGroups Method—Retrieves All the Rule Group Objects Nested within the Group

The GetAllRuleGroups method retrieves all the rule group objects nested within the group.

Syntax

The GetAllRuleGroups method has the following format:

Netegrity::PolicyMgtGroup‑>GetAllRuleGroups( )

Parameters

The GetAllRuleGroups method accepts no parameters.

Return Value

The GetAllRuleGroups method returns one of the following values:

• An array of PolicyMgtGroup objects
• undef if no rule groups are found, if the groups contains objects of another type, or if the call is unsuccessful.

GetAllRules Method—Retrieves All the Rule Objects in the Group

The GetAllRules method retrieves all the rule objects in the group.

Syntax

The GetAllRules method has the following format:

Netegrity::PolicyMgtGroup‑>GetAllRules( )

Parameters

The GetAllRules method accepts no parameters.

Return Value

The GetAllRules method returns one of the following values:

• An array of PolicyMgtRule objects
• undef if no rule objects are found, if the group contains objects of another type, or if the call is unsuccessful

GetResponse Method—Retrieves the Specified Response Object from the Group

The GetResponse method retrieves the specified response object from the group.

Syntax

The GetResponse method has the following format:

Netegrity::PolicyMgtGroup‑>GetResponse(responseName)

Parameters

The GetResponse method accepts the following parameter:

responseName (type)

Specifies the name of the response to retrieve.

Return Value

The GetResponse method returns one of the following values:

• A PolicyMgtResponse object
• undef if no such response is found, if the group contains objects of another type, or if the call is unsuccessful

GetResponseGroup Method—Retrieves a Response Group Object Nested within the Group

The GetResponseGroup method retrieves a response group object nested within the group.

Syntax

The GetResponseGroup method has the following format:

Netegrity::PolicyMgtGroup‑>GetResponseGroup(groupName)

Parameters

The GetResponseGroup method accepts the following parameter:

groupName (string)

Specifies the name of the response group to retrieve.

Return Value

The GetResponseGroup method returns one of the following values:

• A PolicyMgtGroup object
• undef if the group does not exist, or if the call is unsuccessful

GetRule Method—Retrieves the Specified Rule Object from the Group

The GetRule method retrieves the specified rule object from the group.

Syntax

The GetRule method has the following format:

Netegrity::PolicyMgtGroup‑>GetRule(ruleName)

Parameters

The GetRule method accepts the following parameter:

ruleName (string)

Specifies the name of the rule to retrieve.

Return Value

The GetRule method returns one of the following values:

• A PolicyMgtRule object
• undef if no such rule is found, if the group contains objects of another type, or if the call is unsuccessful

GetRuleGroup Method—Retrieves a Rule Group Object Nested within the Group

The GetRuleGroup method retrieves a rule group object nested within the group.

Syntax

The GetRuleGroup method has the following format:

Netegrity::PolicyMgtGroup‑>GetRuleGroup(groupName)

Parameters

The GetRuleGroup method accepts the following parameter:

groupName (string)

Specifies the name of the rule group to retrieve.

Return Value

The GetRuleGroup method returns one of the following values:

• A PolicyMgtGroup object
• undef if the group does not exist, or if the call is unsuccessful

Name Method—Sets or Retrieves the Name of the Group Object

The Name method sets or retrieves the name of the group object.

Syntax

The Name method has the following format:

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

Parameters

The Name method accepts the following parameter:

Name (string)

(Optional) Specifies the name to set.

Return Value

The Name method returns one of the following values:

• The new or existing name
• undef if the call is unsuccessful

Remove Method—Removes the Specified Group Member from the Group

The Remove method removes the specified group member from the group.

Syntax

The Remove method has the following format:

Netegrity::PolicyMgtGroup‑>Remove(member)

Parameters

The Remove method accepts the following parameters:

member (objectType)

Specifies the group member to remove, which can be any of the following object types:

• PolicyMgtAgent
• PolicyMgtResponse
• PolicyMgtRule
• PolicyMgtGroup

Return Value

The Remove method returns one of the following values:

• 0 on success
• undef if the call is unsuccessful