Use the NSCONFIG utility to help you debug existing NameServer configurations defined in a properties file, such as the ubroker.properties file. This utility displays the property settings associated with a NameServer configuration, and checks that the syntax and values are valid.

The NSCONFIG utility runs locally, on the machine on which the AdminService is running. The utility does not run across the network.

Syntax

Operating system Syntax
Windows 
nsconfig
  [
       [
          [ -name name-server ]
          [ -propfile path-to-properties-file ]
          [ -validate ]
       ]
    | -help
  ]

Parameters

-name name-server
Specifies which existing NameServer configuration to examine. The name must match the name of an existing NameServer configuration in the specified properties file. If you do not specify a NameServer, the NSCONFIG utility analyzes all NameServer configurations defined in the properties file specified by the -propfile parameter.
-propfile path-to-properties-file
Specifies a filename or pathname to a file that contains the property settings to be validated, for example test.properties. If a filename or pathname is not specified, it defaults to the installation version of the ubroker.properties file, such as:
  • %DLC%\properties\ubroker.properties in Windows
  • $DLC/properties/ubroker.properties on UNIX
-validate
Checks the syntax and values of property settings defined in the specified properties file.
-help
Displays command-line help.

Notes

  • A single NameServer can simultaneously support all of the AppServer, WebSpeed and DataServer products using OpenEdge Management or OpenEdge Explorer.

  • The ubroker.properties file stores all the configuration definitions for each instance of the NameServer, AppServer, DataServer and WebSpeed Transaction Server products. Each configuration definition contains environment variables, registry entries if Windows, and property settings for each product instance. OpenEdge Management/OpenEdge Explorer and certain command-line utilities, such as NSCONFIG, use this file to store, validate and manage the configurations for the products.

    The ubroker.properties file is installed in the properties subdirectory of the OpenEdge installation directory. For example, %DLC%\properties\ubroker.properties in Windows.

    The file consists of a hierarchical structure of configuration entities, where parent entities provide configuration information that you can override or extend in each child entity. Each configuration entity has a name that begins the entity definition, and the definition contains configuration settings for one or more product instances.

    The NameServer configurations in ubroker.properties can include:

    Configuration entity name Configuration entity function
    [UBroker] Defines default property settings for all NameServer, AppServer, DataServer, and WebSpeed Transaction Server brokers.
    [NameServer] Defines default property settings for all instances of a NameServer.
    [NameServer.product-instance-name] Defines property settings for this instance of a NameServer. The ubroker.properties file can contain several of these entities each with a unique product-instance-name.

    Parent entities provide default values for all of their child entities. For example, the parent [UBroker] contains a set of definitions that can be inherited by its child [NameServer], and then again by its child [NameServer.product-instance-name]. However, at any child level, a redefinition of any value supersedes the default value of its parent. All children from the redefinition level down inherit this new value.

    Optionally, you can edit the ubroker.properties file using a text editor such as Notepad. If you want to manually edit this file to create or modify a product configuration, begin by making a backup copy from the installed ubroker.properties file (and naming it for example, test.properties). Once you edit the properties file, use the relevant validation utility such as NSCONFIG to validate the changes and make sure there are no syntax errors or conflicts.