Policy Server Guides › Policy Server Administration Guide › Policy Server Tools › XPSConfig—Manage Product Parameters

XPSConfig—Manage Product Parameters

XPSConfig is an interactive command-line utility that allows administrators and members of operations to view product parameters and, if allowed, edit their settings. While you may have your own product-specific configuration tool using XPS programming interfaces, XPSConfig is available so that this is not a requirement.

For each vendor and installed product, XPSConfig manages the parameters or named settings that are defined in the product's Data Dictionary. Each product can read, write, and validate its own parameter settings.

To use XPSConfig, you must be an administrator with XPSConfig rights.

Parameters have the following attributes:

• Name

  Specifies the name of the parameter.

  Limits:

  • Names must start with a letter or underscore and contain only letters, numbers, and underscores.
  • Names can be up to 32 characters in length.
  • Names are not case-sensitive.
• Type

  Specifies the data type of the parameter value:

  Logical | Numeric | String
  

  • Logical

    Specifies a Boolean value: TRUE or FALSE.

  • Numeric

    Specifies an integer.

  • String

    Specifies a string of characters.

• Scope

  Specifies the value or scope of the parameter:

  Ask | Global | Local | Managed | Overrideable | Read Only
  

  • Ask

    Specifies that the value is managed by the product, not by XPS, and that the value is read only.

  • Global

    Specifies that the value is stored in the policy store and accessible by all Policy Servers sharing that policy store.

  • Local

    Specifies that each Policy Server stores its own value.

  • Managed

    Specifies that the value is managed by the product, not by XPS, and that the value is read-write.

  • Overrideable

    Specifies that a value stored locally on a Policy Server can override a value stored globally on a shared policy store.

  • Read Only

    Specifies that the value is both the default value and read only.

• Export

  Specifies whether the parameter is included in exports of the policy store.

  Type: Boolean

• Report

  Specifies whether the parameter is included in capabilities reporting for the Policy Server.

  Type: Boolean

• RemoteAccess

  Specifies what type of access the remote API has to the parameter:

  None | Read | ReadWrite
  

• Description

  Describes the purpose of the parameter.

• LicenseType

  Specifies the type of license limit:

  None | SoftLimit | HardLimit | ExpDate
  

  • None

    Specifies that the parameter is not a license limit.

  • SoftLimit

    Specifies that the parameter is a soft or advisory license limit.

  • HardLimit

    Specifies that the parameter is a hard or absolute license limit.

  • ExpDate

    Specifies that the parameter is the date on which the license expires.

• Default Value

  Specifies a default value for use when the current value is undefined.

  Note: If the default value is undefined, its value is specified according to its data type:

  • String

    space

  • Number

    zero

  • Boolean

    FALSE

• Visible

  Specifies whether the parameter is visible to XPSConfig.

  Type: Boolean

Syntax

XPSConfig has the following format:

XPSConfig [-vendor vendor] [-product product]
[-?] [-vT | -vI | -vW | -vE | -vF]
[-l log_path] [-e err_path] [-r rec_path]

Parameters

XPSConfig includes the following options:

• -vendor

  (Optional) Specifies the name of the vendor whose data you want to view.

• -product

  (Optional) Specifies the name of the product whose data you want to view.

• -?

  (Optional) Displays help information for this utility.

• -vT | -vI | -vW | -vE | -vF

  (Optional) Specifies when to log error information to the error file and how much information to log.

  • -vT

    Logs detailed information so that you can TRACE errors.

  • -vI

    Logs information in case there is an error.

  • -vW

    Logs error information in the event of a WARNING, ERROR, or FATAL error.

  • -vE

    Logs error information in the event of an ERROR or FATAL error.

  • -vF

    Logs error information in the event of a FATAL error.

• -l

  (Optional) Outputs logging information to the specified location.

  Default: stdout

• -e

  (Optional) Outputs error information to the specified location.

  Default: stderr

• -r

  (Optional) Outputs a record of the session to the specified location.