Home > Veritas Storage Foundation™ Volume Manager Manual Pages

PBXCFG (1)

User Commands

NAME
SYNOPSIS
DESCRIPTION
Arguments
EXAMPLES

NAME

pbxcfg - Used by Symantec product developers to access and modify values in the configuration file or registry.

This utility is primarily intended for Symantec developers and technical support staff. Symantec customers should use this utility only under the guidance of a technical support person.

SYNOPSIS

pbxcfg {-a | -r} -u UserName [-c ConfigFile/Registry] On Windows: pbxcfg {-e | -d } {-m | -w} [-c Registry] On UNIX: pbxcfg {-e | -d} {-m} [-c ConfigFile] pbxcfg -p [-C] [-l] [-m] [-n] [-u] [-c ConfigFile/Registry] pbxcfg -s {-l DebugLevel | -n PortNo} [-c ConfigFile/Registry] pbxcfg -v pbxcfg -h

DESCRIPTION

The Symantec Private Branch Exchange keeps configurable parameters in the configuration file on UNIX or Windows registry. These values are Port Number, Auth User, Debug Level, and Secure Mode.

The operations available to you when using pbxcfg are:

Add or remove entries in the registry/configuration file
Enable or disable entries
Display information
Set entries

Typically, you would invoke pbxcfg to set these values during installation of your product. These values can only be modified by an administrator on Windows or root user on UNIX. The registry information is found under HKEY_LOCAL_MACHINE\Software\VERITAS\VxPBX in the Windows registry or /etc/vx/VxICS/VxPBX.cfg on UNIX platforms.

NOTE: The pbxcfg command also provides a command line argument to set these values at runtime.

Arguments

The command options and their arguments are case insensitive. Any file names and paths inherit the case-sensitive behavior of the operating system. For example, on UNIX, these values are always case-sensitive.

Note: Do not provide argument values that contain commas or special characters unless otherwise noted.

-a, --add

Add entries to the registry/conf file. The added entries are Authorized Users who want access to register services with the exchange service.

-c, --cfgfile ConfigFile/Registry

Configuration file/registry. This argument provides the option to configure at runtime.

-C, --Cluster

Displays whether clustering is enabled.

-d, --disable

Disable entries in the registry/conf file. Entries can be disabled for Secure Mode and Local System users. Disabling Secure Mode forces the PBX Exchange to bypass the user authorization check during registration time, allowing any user to register services with the exchange. Disabling Local System user restricts the local system from user registering services with the exchange. NOTE: the Local System entry can be disabled only on Windows.

-e, --enable

Enable entries in the registry/conf file for secure mode and Local System users. Enabling secure mode forces the PBX Exchange to check the authorization access of a user who wants to register services with the exchange. Enabling Local System user allows the local system user to register services with the PBX exchange.

NOTE: the Local System entry can be enabled only on Windows.

-h, --help

Display all of the options for this command

-l, --debuglevel [DebugLevel]

The level of debugging. Providing this option after -p, displays the current debug level. The DebugLevel is required when setting the level.

Levels range from 0-10 where 0 means no logging and 10 is the most verbose.

-m, --securemode

Providing this option after -e, enables security. Providing this option after -d, disables security.

-n, --portno [PortNo]

The PortNo argument is required when setting the registry entry for the port number using the -s option.

Caution: Changing the port number of the exchange will impact all of the clients and services that have already registered with the exchange and are using the exchange for communication.

-p, --print

Displays the values of the entries in the configuration file or registry. The command allows the flexibility to display all values or only the values of specified entries. The entries that this command prints are Authorized User, Secure Mode, debug level, port number, and cluster configuration information.

-r, --remove

Remove entries from the registry/conf file. The removed entries are authorized users who want access to register services with the exchange.

-s, --set

Sets values for any entries in the registry. The entries that this command sets are Debug Level and Port Number.

-u, --user [UserName]

Authenticated user. The user name is case sensitive on UNIX and case insensitive on Windows. If the Windows environment uses a PDC, the user name should be provided with a domain name, for example NTDOMAIN\UserName. If no PDC is used, the user name should be provided with a machine name, for example, MACHINENAME\UserName.

The UserName argument is required when adding a user or removing a user from the list of authenticated users.

-v, --version

Displays the version of the pbxcfg CLI.

-w, --sysuser

Local System user on Windows. This option does not apply to UNIX.

EXAMPLES

NOTE: The following examples are valid for UNIX, which uses single quotes to enclose option arguments. In Windows, use double-quotes.

Add the user root into the authenticated users list:

pbxcfg -a -u root

Remove the user root from the authenticated users list:

pbxcfg -r -u root

Enable security:

pbxcfg -e -m

Disable security:

pbxcfg -d -m

Display authenticated users:

pbxcfg -p -u

Display the security mode. A value of true means that security is enabled.

pbxcfg -p -m

Display the debug level:

pbxcfg -p -l

Display the port number:

pbxcfg -p -n

Set the Debug Level value to 10, the most verbose:

pbxcfg -s -l 10

Set the port number to 1556:

pbxcfg -s -n 1556

Display all of the options for the pbxcfg command:

pbxcfg -h

Display the version of the pbxcfg CLI:

pbxcfg -v

Display all of the exchange information from the specified configuration file: