Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › Session Methods › AddTrustedHost Method—Creates or Modifies Trusted Host Object

AddTrustedHost Method—Creates or Modifies Trusted Host Object

The AddTrustedHost method creates or modifies a trusted host object in the policy store.

Syntax

The AddTrustedHost method has the following format:

Netegrity::PolicyMgtSession‑>AddTrustedHost(trustedHostName[, trustedHostDescription][, trustedHostIpAddress][, sharedSecret])

Parameters

The AddTrustedHost method accepts the following parameters:

trustedHostName (string)

Specifies the name of the trusted host.

trustedHostDescription (string)

(Optional) Specifies the description of the trusted host.

trustedHostIpAddress (string)

(Optional) Specifies the IP address of the trusted host.

sharedSecret (string)

(Optional) Specifies the shared secret.

Note: You must also define the shared secret in the host configuration file by running the SiteMinder tool smreghost with the -sh option. If you do not use the -sh option to specify the shared secret, SiteMinder automatically generates one.

Return Value

The AddTrustedHost method returns one of the following values:

• PolicyMgtTrustedHost (object)
• undef if the trusted host name already exists

Remarks

You can use the AddTrustedHost method to register the trusted host without first configuring a connection between the Policy Server and the Agent. When you use this method to register the trusted host, you must also run the SiteMinder tool smreghost to define the shared secret in the host configuration file. (The host configuration file is named SmHost.conf by default.) Run smreghost with the -sh option and the shared secret. To retrieve the shared secret in clear text, call the method PolicyMgtTrustedHost‑>GetSecret.

Alternately, you can create the trusted host by calling the method CreateTrustedHost and run smreghost without the -sh option. In this case, SiteMinder automatically creates and configures the trusted host during installation.

Important! SiteMinder generates a random 128-byte ASCII shared secret. When you create the shared secret, it can be any string value. To create a strong shared secret, we strongly recommend that you call the AddTrustedHost method with the sharedSecret parameter set to an empty string. This results in the automatic generation of a shared secret that is random, long, and hard-to-guess.