CLI Trusted Host Methods

Contents
casso10
Contents
GetDescription Method Retrieves Description of Trusted Host
The GetDescription method retrieves the description of the trusted host.
Syntax
The GetDescription method has the following format:
Netegrity::PolicyMgtTrustedHost->GetDescription()
Parameters
The GetDescription method accepts no parameters.
Return Value
The GetDescription method returns the following value:
  • trusted_host_description
GetIPAddress Method Retrieves IP Address of Trusted Host
The GetIPAddress method retrieves the IP address of the trusted host.
Syntax
The GetIPAddress method has the following format:
Netegrity::PolicyMgtTrustedHost->GetIPAddress()
Parameters
The GetIPAddress method accepts no parameters.
Return Value
The GetIPAddress method returns the following value:
  • trusted_host_ip_address
GetName Method Retrieves Name of Trusted Host
The GetName method retrieves the name of the trusted host.
Syntax
The GetName method has the following format:
Netegrity::PolicyMgtTrustedHost->GetName()
Parameters
The GetName method accepts no parameters.
Return Value
The GetName method returns the following value:
  • trusted_host_name
GetSecret Method Retrieves Shared Secret of Trusted Host
The GetSecret method retrieves the shared secret of the trusted host in clear text.
Syntax
The GetSecret method has the following format:
Netegrity::PolicyMgtTrustedHost->GetSecret()
Parameters
The GetSecret method accepts no parameters.
Return Value
The GetSecret method returns one of the following values:
  • trusted_host_shared_secret
  • undef
    if the call is unsuccessful
RolloverEnabled Method Sets or Retrieves Shared Secret Rollover Flag
The RolloverEnabled method sets or retrieves the shared secret rollover flag that specifies whether shared secret rollover is enabled for this trusted host.
Syntax
The RolloverEnabled method has the following format:
Netegrity::PolicyMgtTrustedHost->RolloverEnabled([rolloverEnabled])
Parameters
The RolloverEnabled method accepts the following parameter:
  1. rolloverEnabled
    (int)
    (Optional) Specifies a new value for the shared secret rollover flag.
    • value = 1
      Specifies that shared secret rollover is enabled for this trusted host.
    • value = 0
      Specifies that shared secret rollover is
      not
      enabled for this trusted host.
Return Value
The RolloverEnabled method returns the new or existing value for the shared secret rollover flag:
  • value = 1
    Specifies that shared secret rollover is enabled for this trusted host.
  • value = 0
    Specifies that shared secret rollover is
    not
    enabled for this trusted host.
  • undef
    Specifies that the call is unsuccessful.
Remarks
If shared secret rollover is enabled for this trusted host, it must also be enabled in the PolicyMgtSharedSecretPolicy object in the policy store domain where the trusted host is registered. If shared secret rollover is not enabled in this object, call the method PolicyMgtSharedSecretPolicy->Enabled to enable it.
SetSecret Method Sets Shared Secret of Trusted Host
The SetSecret method sets the shared secret of the trusted host.
Syntax
The SetSecret method has the following format:
Netegrity::PolicyMgtTrustedHost->SetSecret([
sharedSecret
])
Parameters
The SetSecret method accepts the following parameter:
  1. sharedSecret
    (string)
    (Optional) Specifies the shared secret to set for the trusted host.
    Note:
    If no shared secret is specified,
    CA Single Sign-On
    generates a random 128-byte ASCII shared secret for the trusted host.
Return Value
The SetSecret method returns one of the following values:
  • shared_secret (string)
    Specifies the new shared secret for the trusted host.
  • "" (empty string)
    Specifies that the call is unsuccessful.
Remarks
When you use this method to set the shared secret, you must also run the
CA Single Sign-On
tool smreghost to define the new shared secret in the host configuration file. (The host configuration file is named SmHost.conf by default.) Run smreghost with the -sh option. For more information, see the method PolicyMgtSession>AddTrustedHost.
Note:
You can schedule shared secret rollovers, so that they happen automatically.