Previous Topic: CLI Host Configuration MethodsNext Topic: CLI IP Configuration Methods


CLI Initialization Methods

CreateSession Method—Creates a Policy Server Session

The CreateSession method creates a Policy Server session. A session is required before Policy Server objects can be manipulated. All necessary initializations and logging are performed at this stage.

Syntax

The CreateSession method has the following format:

Netegrity::PolicyMgtAPI‑>CreateSession(username, userpwd[, clientIP])

Parameters

The CreateSession method accepts the following parameters:

username (string)

Specifies the administrator's login ID.

userpwd (string)

Specifies the administrator's password.

clientIP (string)

(Optional) Specifies the IP address of the local machine.

The CreateSession method returns one of the following values:

DisableAudit Method—Sets the Flag to Enable or Disable Auditing

The DisableAudit method sets a flag to enable or disable auditing.

Syntax

The DisableAudit method has the following format:

Netegrity::PolicyMgtAPI‑>DisableAudit([auditFlag])

Parameters

The DisableAudit method accepts the following parameter:

auditFlag (int)

(Optional) Specifies the value to set the flag:

Return Value

The DisableAudit method returns one of the following values:

Remarks

Reads or sets the enabled state for the following operations:

The default state is enabled. The enabled state reverts to the default at the start of each new session.

Attempting to set the enabled state has no effect after the PolicyMgtAPI‑>CreateSession method is called.

DisableCacheUpdates Method—Deprecated

The DisbleCacheUpdates method is deprecated in SiteMinder v6.0. Caches affected by this method are automatically enabled.

DisableManagementWatchDog Method—Reads or sets the Enabled State of the SiteMinder Management Watchdog

The DisableManagementWatchdog method reads or sets the enabled state of the SiteMinder Management Watchdog.

Note: The watchdog is used internally and should not be disabled.

Syntax

The DisableManagementWatchdog method has the following format:

Netegrity::PolicyMgtAPI‑>DisableManagementWatchDog([watchDogFlag])

Parameters

The DisableManagementWatchdog method accepts the following parameter:

watchDogFlag (int)

(Optional) Specifies the value of the flag to set:

Return Value

The DisableManagementWatchdog method returns one of the following values:

Remarks

The default state is enabled. The enabled state reverts to the default at the start of each new session.

Attempting to set the enabled state has no effect after PolicyMgtAPI‑>CreateSession is called.

DisableValidation Method—Reads or Sets the Enabled State for Validation of Policy Server Objects

The DisableValidation method reads or sets the enabled state regarding validation of Policy Server objects.

Syntax

The DisableValidation method has the following format:

Netegrity::PolicyMgtAPI‑>DisableValidation([validationFlag])

Parameters

The DisableValidation method accepts the following parameter:

validationFlag (int)

(Optional) Specifies the value to set the flag::

Return Value

The DisableValidation method returns one of the following values:

Remarks

The default state is enabled. The enabled state reverts to the default at the start of each new session.

Attempting to set the enabled state has no effect after the PolicyMgtAPI‑>CreateSession method is called.

EnableCache Method—Deprecated

The EnableCache method is deprecated in SiteMinder v6.0. Beginning with this release, caches affected by this method are automatically enabled.

LoadAgentTypeDictionary Method—Reads or Sets the Enabled State for the Agent Type Dictionary

The LoadAgentTypeDirectory method reads or sets the enabled state for the loading of the agent type dictionary by the Policy Server.

Syntax

The LoadAgentTypeDirectory method has the following format:

Netegrity::PolicyMgtAPI‑>LoadAgentTypeDictionary([loadFlag])

Parameters

The LoadAgentTypeDirectory method accepts the following parameter:

loadFlag (int)

(Optional) Specifies the value to set the flag:

0 to disable loading the agent type dictionary

1 to enable loading the agent type dictionary

Return Value

The LoadAgentTypeDirectory method returns one of the following values:

Remarks

The default state is disabled. The enabled state reverts to the default at the start of each new session.

Attempting to set the enabled state has no effect after the PolicyMgtAPI‑>CreateSession method is called.

New Method—Constructor for the Policy Management API

The New method is the constructor for the Policy Management API. This method must be called before the Policy Management API can be used.

Syntax

The New method has the following format:

Netegrity::PolicyMgtAPI‑>New( )

Parameters

The New method accepts no parameters.

Return Value

The New method returns one of the following values:

PreLoadCache Method—Reads or Sets the Enabled State for Preloading of Caches

The PreLoadCache method reads or sets the enabled state for preloading of caches by the Policy Server.

Syntax

The PreLoadCache method has the following format:

Netegrity::PolicyMgtAPI‑>PreLoadCache([cacheFlag])

Parameters

The PreLoadCache method accepts the following parameter:

cacheFlag (int)

(Optional) Specifies the value to set the flag:

Return Value

The PreLoadCache method returns one of the following values:

Remarks

The default state is disabled. The enabled state reverts to the default at the start of each new session.

Attempting to set the enabled state has no effect after the PolicyMgtAPI‑>CreateSession method is called.

Note: By disabling this flag, you can reduce the time it takes for Policy Management scripts to make policy store changes.

PrintDebugTrace Method—Enables or Disables Printing Debug (Trace) Information Example

The PrintDebugTrace method enables or disables the printing of debug (trace) information to the console.

Syntax

The PrintDebugTrace method has the following format:

Netegrity::PolicyMgtAPI‑>PrintDebugTrace([debugFlag])

Parameters

The PrintDebugTrace method accepts the following parameter:

debugFlag (int)

(Optional) Specifies the value to set the flag:

Return Value

The PrintDebugTrace method returns one of the following values: