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

CreateTrustedHost Method—Creates Trusted Host Object

The CreateSAMLAuthScheme method creates a trusted host object in the policy store, registers the trusted host with the Policy Server, and if registration is successful, creates the local registration file. Use this method when the Policy Server is connected to the agent host. When there is no connection between the Policy Server and the agent host, call the method PolicyMgtSession‑>AddTrustedHost instead.

Syntax

The CreateTrustedHost method has the following format:

Netegrity::PolicyMgtSession‑>CreateTrustedHost(trustedHostName [,ipAddress][, adminName][, adminPassword][, hostConfigName][, registrationDataFileName])

Parameters

The CreateTrustedHost method accepts the following parameters:

trustedHostName (string)

Specifies the name of the trusted host.

ipAddress (string)

(Optional) Specifies the IP address of the Policy Server.

adminName (string)

(Optional) Specifies the name of a Policy Server administrator.

adminPassword (string)

(Optional) Specifies the administrator's password.

hostConfigName (string)

(Optional) Specifies the name of the host configuration object.

registrationDataFileName (string)

(Optional) Specifies the name of the file where registration data is written when the host is successfully registered with the Policy Server.

Note: This filename is specified by calling the Agent API method Connect. The file is stored and managed by SiteMinder.

Return Value

The CreateTrustedHost method returns one of the following values:

• PolicyMgtTrustedHost (object)
• undef if the call is unsuccessful or if the trusted host name already exists