Previous Topic: Log File DescriptionsNext Topic: Published Policy Server Information

Policy Server Guides › Policy Server Administration Guide › Publishing Diagnostic Information

Publishing Diagnostic Information

Diagnostic Information Overview

The Policy Server includes a command line tool for publishing diagnostic information about a SiteMinder deployment. Using the tool, you can publish information about Policy Servers, policy stores, user directories, Agents, and custom modules.

Use the Command Line Interface

The Policy Server includes a command that can be executed at the command line to publish information. The command is located in the installation_dir/siteminder/bin directory.

To publish information, use smpolicysrv command, followed by the -publish switch. For example:

smpolicysrv -publish <optional file_name>

Note: On Windows systems, do not run the smpolicysrv command from a remote desktop or Terminal Services window. The smpolicysrv command depends on inter-process communications that do not work if you run the smpolicysrv process from a remote desktop or Terminal Services window.

Important! Before running a SiteMinder utility or executable on Windows Server 2008, open the command-line window with administrator permissions. Open the command-line window this way, even if your account has administrator privileges.

Specify a Location for Published Information

Published information is written in XML format to a specified file. The specified file name is saved in the following registry key:

HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Netegrity\SiteMinder\CurrentVersion\
Publish

This key is located in the system registry on Windows systems, and in the install_dir/registry/sm.registry file on UNIX. The default value of the registry setting is:

policy_server_install_dir>\log\smpublish.xml

If you execute smpolicysrv -publish from a command line, and you do not supply a path and file name, the value of the registry setting determines the location of the published XML file.

Note: On Windows systems, do not run the smpolicysrv command from a remote desktop or Terminal Services window. The smpolicysrv command depends on inter-process communications that do not work if you run the smpolicysrv process from a remote desktop or Terminal Services window.

Important! Before running a SiteMinder utility or executable on Windows Server 2008, open the command-line window with administrator permissions. Open the command-line window this way, even if your account has administrator privileges.

To specify a location and generate output in an XML file

  1. From a command line, navigate to: 
    installation_dir/siteminder/bin
  2. Type the following command: 
    smpolicysrv -publish path_and_file_name

    For example, on Windows:

    smpolicysrv -publish c:\netegrity\siteminder\published-data.txt

    For example, on UNIX:

    smpolicysrv -publish /netegrity/siteminder/published-data.txt

    The Policy Server generates XML output in the specified location and updates the value of the HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Netegrity\
    SiteMinder\CurrentVersion\Publish registry key to match the location you specified.

Published Data

This section outlines the information that may be published for the following: