CLI Agent Methods

Contents
sm1252sp1
Contents
ConvertFromLegacy Method Converts a v4.x Agent to a v5.x Agent
The ConvertFromLegacy method converts a v4.x agent to a v5.x agent.
Syntax
The ConvertFromLegacy method has the following format:
Netegrity::PolicyMgtAgent->ConvertFromLegacy( )
Parameters
The ConvertFromLegacy method accepts no parameters.
Return Value
The ConvertFromLegacy method returns one of the following values:
  • 0 on success
  • -1 on failure
ConvertToLegacy Method Converts a v5.x Agent to a v4.x Agent
The ConvertToLegacy method converts a v5.x agent to a v4.x agent.
Syntax
The ConvertToLegacy method has the following format:
Netegrity::PolicyMgtAgent->ConvertToLegacy( )
Parameters
The ConvertToLegacy method accepts no parameters.
Return Value
The ConvertToLegacy method returns one of the following values:
  • 0 on success
  • -1 on failure
Description Method Sets or Retrieves the Agent Description
The Description method sets or retrieves the agent description.
Syntax
The Description method has the following format:
Netegrity::PolicyMgtAgent->Description([agentDesc])
Parameters
The Description method accepts the following parameter:
  1. agentDesc
    (string)
    (Optional) Specifies the description to set.
Return Value
The Description method returns one of the following values:
  • New or existing description of the agent
  • An empty string if unsuccessful
IPAddress Method Sets or Retrieves the Agent's IP Address
The IPAddress method sets or retrieves the agent's IP address.
Syntax
The IPAddress method has the following format:
Netegrity::PolicyMgtAgent->IPAddress([ipAddress])
Parameters
The IPAddress method accepts the following parameter:
  1. ipAddress
    (string)
    (Optional) Specifies the IP address to set.
Return Value
The IPAddress method returns one of the following values:
  • A new or existing agent IP address
  • undef
    if the call was unsuccessful
Name Method Sets or Retrieves the Name of the Agent
The Name method sets or retrieves the name of the agent.
Syntax
The Name method has the following format:
Netegrity::PolicyMgtAgent->Name([agentName])
Parameters
The Name method accepts the following parameter:
  1. agentName
    (string)
    (Optional) Specifies the name to assign to the agent.
Return Value
The Name method returns one of the following values:
  • The new or existing name of the agent
  • undef if the call was unsuccessful
RealmHintAttrID Method Sets or Retrieves the Hint Attribute
The RealmHintAttrID method sets or retrieves the hint attribute for a RADIUS agent.
Syntax
The RealmHintAttrID method has the following format:
Netegrity::PolicyMgtAgent->RealmHintAttrID([hintID])
Parameters
The RealmHintAttrID method accepts the following parameter:
  1. hintID
    (int)
    (Optional) Specifies the hint attribute ID to set.
Return Value
The RealmHintAttrID method returns one of the following values:
  • New or existing realm hint attribute to set for the RADIUS agent
  • -1 if unsuccessful
SharedSecret Method Sets or Retrieves the Shared Secret for a v4.x Agent
The SharedSecret method sets or retrieves the shared secret for a v4.x agent. This is the same shared secret used in the Web agent configuration.
Syntax
The SharedSecret method has the following format:
Netegrity::PolicyMgtAgent->SharedSecret([sharedSecret])
Parameters
The SharedSecret method accepts the following parameter:
  1. sharedSecret
    (string)
    (Optional) Specifies the shared secret to set.
    Return Value
The SharedSecret method returns one of the following values:
  • The new or existing shared secret
  • undef if the call was unsuccessful