Skip to Main Content
Return to Navigation

Using the PSADMIN Command-Line Interface

This section provides an overview of the PSADMIN command-line interface and discusses how to:

Understanding the PSADMIN Command-Line Interface

In some cases, you might want to use the PSADMIN command-line interface rather than starting the PSADMIN interface and navigating to a particular menu. The command line offers a direct method of carrying out certain server administration tasks. It also enables you to include PSADMIN actions in scripts, and simplifies the task of creating numerous domains that use default server settings.

PSADMIN has several variations of its basic command-line syntax for miscellaneous activities and server administration, which are described in the following sections.

Note: Before you begin using the PSADMIN commands, you should become familiar with PSADMIN and the components that it controls.

Note: When using the PSADMIN command line and specifying paths containing spaces (such as directory paths on Windows), the paths must be enclosed within quotes.

Using the Miscellaneous Commands

Following are the available miscellaneous PSADMIN commands:

Command

Description

psadmin -h

Displays command help and syntax.

psadmin -v

Displays the PSADMIN version number, as in Version 8.52.

psadmin -env

Displays your current environment variables.

psadmin -defaultps_cfg_home

Displays the current PS_CFG_HOME environment variable.

psadmin -replicate -ch <source
 PS_CFG_HOME>

Replicates a PS_CFG_HOME and its configured domains to a new location, where they can be started without manual reconfiguration.

Using the Application Server Commands

For application server administration, PSADMIN has two syntax formats — one for creating new application server domains, and the other for administering existing domains.

Using the Application Server Create Command

Use the following syntax to create a new application server domain:

psadmin -ccreate -ddomain -ttemplate [-ss_set]
[-pp_set]  [-envenv_set]

The create command creates an application server configuration file with the specified domain name, using the specified configuration template.

The domain parameter must be the name of an application server domain that you want to create, for example, HRDMO.

The template parameter must have one of the following values:

  • small

  • medium

  • large

  • developer

The s_set parameter is an optional string of startup values which provide initial configuration settings that you would otherwise specify on the PSADMIN application server Quick-Configure menu. You must enter the startup string as follows:

  • In Windows, the values must be separated by slashes:

    DBNAME/DBTYPE/OPR_ID/OPR_PSWD/DOMAIN_ID/ADD_TO_PATH/CNCT_ID/CNCT_PSWD/SERV_NAME/{ENCRYPT|NOENCRYPT}
  • In UNIX, the values must be separated by percent signs:

    DBNAME%DBTYPE%OPR_ID%OPR_PSWD%DOMAIN_ID
    %ADD_TO_PATH%CNCT_ID%CNCT_PSWD%SERV_NAME%{ENCRYPT|NOENCRYPT}

Important! You must enter these values in the order shown. You can omit required values only by truncating the string from right to left. For example, you can specify DBNAME/DBTYPE, but you can't specify DBNAME/DOMAIN_ID.

These startup settings all have default values if you omit any of them. The default values are generally the values you provided when setting up your PeopleSoft environment, and are the same as they would initially appear on the PSADMIN application server Quick-Configure menu.

The following table describes the startup settings:

Startup (s_set) Setting

Description

DBNAME

Enter the name of the database to which the application server will connect. This is the same as the DBName parameter in the Startup section of the psappsrv.cfg file.

Note: If you don't include the s_set parameter, the value of this setting is the same as the domain name that you specify in the command.

DBTYPE

Enter the database type. Valid values are ORACLE, INFORMIX, SYBASE, MICROSFT, DB2ODBC, and DB2UNIX. This is the same as the DBType parameter in the Startup section of the psappsrv.cfg file.

Note: Notice the spelling of MICROSFT. DB2ODBC is the database type for DB2 z/OS.

OPR_ID

Enter the user ID, such as QEDMO, for the domain to use to connect to the database. This is the same as the UserId parameter in the Startup section of the psappsrv.cfg file.

OPR_PSWD

Enter the user password that is associated with the specified user ID. This is the same as the UserPswd parameter in the Startup section of the psappsrv.cfg file.

DOMAIN_ID

Enter a domain ID, such as TESTSRV1, TESTSRV2, and so on. This does not need to match the domain name. This name is important only because the Tuxedo Web Monitor uses it to identify application server domains on each machine. This is the same as the Domain ID parameter in the Domain Settings section of the psappsrv.cfg file.

ADD_TO_PATH

(Optional) Enter the directory path that contains your connectivity software or database drivers. This is the same as the Add to PATH parameter in the Domain Settings section of the psappsrv.cfg file.

Note: If this value contains spaces, it must be in double quotes (" "). For example:"c:\Program Files".

Important! If you want this setting to be blank, but you can't truncate the string to this point (you still need to specify a value for CNCT_ID), you can specify a value of “_____” (five underscores without the quotes) in this position. PSADMIN interprets this as a blank value.

CNCT_ID

Enter the connect ID, which is required for all platforms. This is the same as the ConnectId parameter in the Startup section of the psappsrv.cfg file.

See Connect ID.

CNCT_PSWD

Enter the password that is associated with the connect ID. This is the same as the ConnectPswd parameter in the Startup section of the psappsrv.cfg file.

SERV_NAME

(Optional) If your RDBMS requires that you specify the server name on which the database resides, enter the appropriate server name. This is the same as the ServerName parameter in the Startup section of the psappsrv.cfg file.

Important! If you want this setting to be blank, but you can't truncate the string to this point (you still need to specify the ENCRYPT setting), you can specify a value of “_____” (five underscores without the quotes) in this position. PSADMIN interprets this as a blank value.

ENCRYPT | NOENCRYPT

Specify ENCRYPT to encrypt the values of the UserPswd andConnectPswd parameters in the psappsrv.cfg file. If you specify NOENCRYPT (the default value), these values appear in clear text in the file.

The p_set parameter is an optional string of port numbers that you would otherwise specify on the PSADMIN application server Quick-Configure menu. Typically, you include this parameter only if you have more than one domain on the same application server machine or if you need to provide a specific value due to your environment or testing needs. Otherwise, you should accept the defaults for easy configuration.

You must specify the port numbers as follows:

  • In Windows, the values must be separated by slashes.

    WSL_PORT/JSL_PORT/JRAD_PORT
  • In UNIX, the values must be separated by percent signs.

    WSL_PORT%JSL_PORT%JRAD_PORT

Important! You must enter these values in the order shown. You can omit values only by truncating the string from right to left. For example, you can specify WSL_PORT/JSL_PORT, but you can't specifyWSL_PORT/JRAD_PORT. These port numbers all have default values if you omit any of them. The default values are the values you provided when setting up your PeopleSoft environment, and are the same as they would initially appear on the PSADMIN application server Quick-Configure menu.

The following table describes the port settings:

Port (p_set) Setting

Description

WSL_PORT

Workstation listener port number. This is the same as the Port parameter in the Workstation Listener section of the PSAPPSRV.CFG file.

Note: Specify this value only if you intend for the domain to support Windows workstations connecting in the development environment.

JSL_PORT

Jolt port number. This is the same as the Port parameter in the JOLT Listener section of the PSAPPSRV.CFG file.

JRAD_PORT

Jolt internet relay port number. This is the same as the Listener Port parameter in the JOLT Relay Adapter section of the PSAPPSRV.CFG file.

Note: Specify this value only if you intend for the domain to support browser deployment, and your web server resides on a separate machine from the application server.

The env_set specifies domain environment settings, having the following format:

ENVAR_NAME1=ENVVAR_VALUE1#ENVAR_NAME2=ENVVAR_VALUE2

Following is an example of the application server create command:

D:\PT\appserv>psadmin -c create -d HRDOM01 -t small -s PT852803/ORACLE/QEDMO/QEDMO
/TESTSRV2/"c:\oracle\product\11.1.0\client_1\bin"/people/peop1e/_____/ENCRYPT 
-p 7200/9020/9200

When you launch the command, you'll see progress messages similar to the following:

Copying application server configuration files...
Copying [D:\PT\appserv\small.cfx] to [D:\PT_SERVER\8.52\appserv\HRDOM01\
psappsrv.cfg]
Stripping Annotations...
Copying [D:\PT\appserv\small.cfx] to [D:\PT_SERVER\8.52\appserv\HRDOM01\
psappsrv.cfx]
Copying Jolt repository file...
Domain created.
Performing load prechecks ...
Loading validation table...
  setting DBName=PT852803
  setting DBType=ORACLE
  setting UserId=QEDMO
  setting UserPswd=sgDcfYICragaN1Bz+MTRxf9CAk21Bqlkn/DFpUQAaTs=
  setting ConnectId=people
  setting ConnectPswd=kyD3QPxnrag=
  setting ServerName=
  setting Port=7200
  setting Port=9020
  setting Listener Port=9200
  setting Domain ID=TESTSRV2
  setting Add to PATH=c:\oracle\product\11.1.0\client_1\bin
New CFG file written with modified Startup parameters

Log Directory entry not found in configuration file.
Setting Log Directory to the default... [PS_SERVDIR\LOGS]
Spawning disabled for server PSAPPSRV.
WARNING: PSSAMSRV is configured with Min instance set to 1. To avoid loss of 
service, configure Min instance to atleast 2.
Configuration file successfully created.
CFG setting changes completed, loading configuration...
Domain configuration complete.

Using the Application Server Administration Commands

Use the following syntax to administer an existing application server domain:

               psadmin -ccommand -ddomain

The domain parameter must be the name of an application server domain that you want to administer, for example, HR846DMO.

The valid values of the command parameter are as follows:

Command

Example

Result of the Example

boot

psadmin -c boot -d PSDMO

Boots an application server domain named PSDMO.

parallelboot

psadmin -c parallelboot -d PSDMO

Boots an application server domain named PSDMO, using the parallel boot option.

configure

psadmin -c configure -d PSDMO

Reloads the domain configuration for the PSDMO domain.

pslist

psadmin -c pslist -d PSDMO

Displays the processes that have been booted for the PSDMO domain. This includes the system process ID for each process.

shutdown

psadmin -c shutdown -d PSDMO

Shuts down the PSDMO application server domain, by using a normal shutdown method.

In a normal shutdown, the domain waits for users to complete their tasks and turns away new requests before terminating all of the processes in the domain.

shutdown!

psadmin -c shutdown! -d PSDMO

Shuts down the PSDMO application server domain by using a forced shutdown method.

In a forced shutdown, the domain immediately terminates all of the processes in the domain.

sstatus

psadmin -c sstatus -d PSDMO

Displays the Tuxedo processes and PeopleSoft server processes that are currently running in the PSDMO application server domain.

cstatus

psadmin -c cstatus -d PSDMO

Displays the currently connected users in the PSDMO application server domain.

qstatus

psadmin -c qstatus -d PSDMO

Displays status information about the individual queues for each server process in the PSDMO application server domain.

preload

psadmin -c preload -d PSDMO

Preloads the server cache for the PSDMO domain.

cleanipc

psadmin -c cleanipc -d PSDMO

Cleans the IPC resources for the PSDMO domain.

purge

psadmin -c purge -d PSDMO

Purges the cache for the PSDMO domain.

import

psadmin -c import 
c:\ptinstalls\pt85x\...
\psappsrv.cfg` -n NEWSRVR

Imports a domain configuration.

See PSADMIN command line help for all possible options.

Using the Process Scheduler Commands

For Process Scheduler administration, PSADMIN has two syntax formats — one for creating new Process Scheduler configurations, and the other for administering existing configurations.

Using the Process Scheduler Create Command

Use the following syntax to create a new Process Scheduler configuration:

psadmin -pcreate -ddomain -ttemplate
[-psps_set] [-envenv_set]

The PSADMIN create command creates a Process Scheduler configuration file for the specified database, using the specified configuration template.

The template parameter must be the name of a .cfx file located in PS_HOME\appserv\prcs, without the extension. This represents the operating system platform on which you're running PeopleSoft Process Scheduler. For example, to use the template file called windows.cfx on a Windows machine, specify the value windows.

The ps_set parameter is an optional string of startup values which provide initial configuration settings that you would otherwise specify on the PSADMIN Process Scheduler Quick-Configure menu. You must enter the startup string as follows:

  • In Windows, the values must be separated by slashes.

    DBNAME/DBTYPE/PRCSSERVER/OPR_ID/OPR_PSWD/CNCT_ID/CNCT_PSWD/SERV_NAME/LOGOUT_DIR/
    SQRBIN/ADD_TO_PATH/DBBIN/CRYSTALBIN/{ENCRYPT|NOENCRYPT}
  • In UNIX, the values must be separated by commas.

    DBNAME,DBTYPE,PRCSSERVER,OPR_ID,OPR_PSWD,CNCT_ID,CNCT_PSWD,SERV_NAME,LOGOUT_DIR,
    SQRBIN,ADD_TO_PATH,{ENCRYPT|NOENCRYPT}

    Note: The UNIX syntax does not include the DBBIN setting.

Important! You must enter these values in the order shown. You can omit required values only by truncating the string from right to left. For example, you can specify DBNAME/DBTYPE, but you can't specifyDBNAME/LOGOUT_DIR.

These startup settings all have default values if you omit any of them. The default values are generally the values you provided when setting up your PeopleSoft environment, and are the same as they would initially appear on the PSADMIN Process Scheduler Quick-Configure menu.

Note: Because these PeopleSoft Process Scheduler settings are already documented in the PeopleSoft Process Scheduler PeopleBook, this section provides only a basic overview of the relationship between the settings on the command line and the equivalent settings on the PSADMIN Process Scheduler Quick-Configure menu.

The following table describes the startup settings:

Startup (ps_set) Setting

Description

DBNAME

This is the equivalent of the DBName parameter on the PSADMIN Process Scheduler Quick-Configure menu.

Note: If you don't include the ps_set parameter, the value of this setting is the same as the database name that you specify in the command.

DBTYPE

This is the equivalent of the DBType parameter on the PSADMIN Process Scheduler Quick-Configure menu.

PRCSSERVER

This is the equivalent of the PrcsServer parameter on the PSADMIN Process Scheduler Quick-Configure menu.

OPR_ID

This is the equivalent of the UserId parameter on the PSADMIN Process Scheduler Quick-Configure menu.

OPR_PSWD

Enter the user password that is associated with the specified user ID. This is the equivalent of the UserPswd parameter on the PSADMIN Process Scheduler Quick-Configure menu.

CNCT_ID

This is the equivalent of the ConnectId parameter on the PSADMIN Process Scheduler Quick-Configure menu.

CNCT_PSWD

This is the equivalent of the ConnectPswd parameter on the PSADMIN Process Scheduler Quick-Configure menu.

SERV_NAME

(Optional) This is the equivalent of the ServerName parameter on the PSADMIN Process Scheduler Quick-Configure menu.

Important! If you want this setting to be blank, but you can't truncate the string to this point (you still need to specify a value for LOGOUT_DIR), you can specify a value of “_____” (five underscores without the quotes) in this position. PSADMIN interprets this as a blank value.

LOGOUT_DIR

This is the equivalent of the Log/Output Dir parameter on the PSADMIN Process Scheduler Quick-Configure menu.

Note: If this value contains spaces, it must be in double quotes (" "). For example:"c:\psft app\log_output".

SQRBIN

This is the equivalent of the SQRBIN parameter on the PSADMIN Process Scheduler Quick-Configure menu.

Note: If this value contains spaces, it must be in double quotes (" "). For example:"C:\PeopleTools\bin\sqr\MSS\binw".

ADD_TO_PATH

(Optional) This is the equivalent of the AddToPATH parameter on the PSADMIN Process Scheduler Quick-Configure menu.

Note: If this value contains spaces, it must be in double quotes (" "). For example:"%WINDIR%\SYSTEM32;c:\Program Files".

CRYSTALBIN

(Windows only) Enter the Crystal installation path. This is equivalent to the Crystal Path parameter in the PSADMIN Process Scheduler Quick-Configure menu.

Note: If a valid path is not entered, error messages related to PS ODBC and Crystal Runtime will appear when PSADMIN loads the configuration.

Note: If this value contains spaces, it must be in double quotes (" ").

Important! If you want this setting to be blank, but you can't truncate the string to this point, you can specify a value of "_____" (five underscores without the quotes) in this position. PSADMIN interprets this as a blank value.

DBBIN

(Windows only) This is the equivalent of the DBBIN parameter on the PSADMIN Process Scheduler Quick-Configure menu.

Note: If this value contains spaces, it must be in double quotes (" "). For example:"C:\my apps\db\MSSQL\Binn".

ENCRYPT | NOENCRYPT

Specify ENCRYPT to encrypt the values of the UserPswd andConnectPswd parameters in the psprcs.cfg file. If you specify NOENCRYPT (the default value), these values appear in clear text in the file.

The env_set specifies domain environment settings, having the following format:

ENVAR_NAME1=ENVVAR_VALUE1#ENVAR_NAME2=ENVVAR_VALUE2

Following is an example of the Process Scheduler create command:

psadmin -p create -d PSHRDB1 -t nt -ps PSHRDB1/MICROSFT/PSNT/
PS/PS/people/peop1e/_____/"c:\psft app\log_output"/c:\psfthr\bin\sqr\MSS\binw/
c:\WINNT\SYSTEM32/C:\Program Files\BusinessObjects\BusinessObjects Enterprise 12.0\win32_x86
/c:\apps\db\mssql\binn/ENCRYPT

Using the Process Scheduler Administration Commands

Use the following syntax to administer an existing Process Scheduler configuration:

psadmin -pcommand -ddatabase

The database parameter must be the name of a database that's associated with a PeopleSoft Process Scheduler Server Agent, for example, PSHRDMO.

The valid values of the command parameter are as follows:

Command

Example

Result of the Example

start

psadmin -p start -d psdmo

Starts a Process Scheduler.

stop

psadmin -p stop -d psdmo

Stops a Process Scheduler.

configure

psadmin -p configure -d psdmo

Configures a Process Scheduler.

status

psadmin -p status -d psdmo

Displays the status of a Process Scheduler.

cleanipc

psadmin -p cleanipc -d psdmo

Cleans the IPC resources for specified domain

kill

psadmin -p kill -d psdmo

Kills the domain (similar to forced shutdown).

Using the Search Server Commands

Use the following syntax to administer an existing search server domain:

psadmin -s command -d domain

The domain parameter must be the name of the search server domain that you want to administer, for example, PSSRCH. The valid values of the command parameter are as follows:

Command

Example

Result of the Example

create

psadmin -s create -d PSSRCH 
-t <template>

Creates a domain with the specified name and template.

boot

psadmin -s boot -d PSSRCH

Boots a search server.

configure

psadmin -s configure 
-d PSSRCH

Configures a search server.

shutdown

psadmin -s shutdown -d PSSRCH

Shuts down the domain, by using a normal shutdown method. In a normal shutdown, the domain waits for current transactions to complete and turns away new requests before terminating all of the processes in the domain.

shutdown!

psadmin -s shutdown! 
-d PSSRCH

Shuts down the domain by using a forced shutdown method. In a forced shutdown, the domain immediately terminates all of the processes in the domain.

sstatus

psadmin -s sstatus -d PSSRCH

Displays the Tuxedo processes and PeopleSoft server processes that are currently running in the domain.

cstatus

psadmin -s cstatus -d PSSRCH

Displays the currently connected users/clients.

qstatus

psadmin -s qstatus -d PSSRCH

Displays status information about the individual queues for each server process in the application server domain.

cleanipc

psadmin -p cleanipc -d PSSRCH

Cleans the IPC resources for the domain.

Working with PSADMIN Exit Codes

The following table lists most PSADMIN command line options for the application server and Process Scheduler server and their return codes. This can provide insight into the return codes displayed when using PSADMIN from the command line or in scripts. In general, PSADMIN returns 0 for success and non-zero when an error occurs.

Note: N/A indicates the command is not applicable to that server.

Command

Application Server

Process Scheduler

-v

0

N/A

-h

0

N/A

-env

0

N/A

-defaultPS_CFG_Home

0

N/A

-invalid

-10

N/A

-create -d <domain_name> -t <template> 

0

0

-create -d  <domain_name> -t <invalid_template> 

275

275

create -d <already_existing_domain> -t <template> 

265

1

create -d <domain_name> -t <template> -s <s_set>

0

N/A

create -d <domain_name> -t <invalid_template> -s <s_set>

1

N/A

create -d <domain_name> -t <template> -s <s_set>  -p <p_set>

0

N/A

create -d database -t template -ps ps_set

N/A

0

create -d database -t template -silent

N/A

0

delete -d <domain_name>

0

0

delete -d <nonexistent_domain> 

235

235

configure -d <domain_name>

0

0

configure -d <nonexistent_domain>

235

235

boot -d <domain_name>

0

N/A

boot -d <nonexistent_domain>

235

N/A

parallelboot -d <domain_name>

-1

N/A

parallelboot -d <nonexistent_domain>

235

N/A

shutdown -d <domain_name>

0

N/A

shutdown -d <nonexistent_domain> 

235

N/A

shutdown! -d <domain_name

0

N/A

shutdown! -d <nonexistent_domain> 

235

N/A

cleanipc -d <domain_name>

0

0

cleanipc -d <nonexistent_domain> 

235

235

sstatus -d <domain_name>

0

0

cstatus -d <domain_name> 

0

0

sstatus -d <domain_name>

0

0

sstatus -d <nonexistent_domain>

235

235

cstatus -d <nonexistent_domain>

235

235

qstatus -d <nonexistent_domain>

235

235

status -d <domain>

N/A

0

status -d <nonexistent_domain>

N/a

235

start -d <domain_name>

0

0

start -d <nonexistent_domain> 

235

235

stop -d <domain_name>

0

0

stop -d <nonexistent_domain>

235

235

kill -d <domain_name>

0

N/A

kill -d <nonexistent_domain>

235

235

import <path>

0

0

import <path> -d <domain_name>

0

0

import <path> -d <domain_name> -n <new_name>

0

0

import <path> -n <name>			

0

0

import <path> -d <already_existing_domain>

0

0

import <path> -d <already_existing_domain>  -r 

0

0

import <path> -d <domain> -n <name> -t <template>

0

N/A

purge -d <domain_name> -noarch

0

N/A

purge -d <domain_name> -arch <archive_directory>			

0

N/A

purge -d <domain_name> -noarch

0

N/A

addmsgsrv -d <domain_name> -s <sname> -t <type> <ch1,ch2,...>

0

N/A

addmsgsrv -d <domain_name> -s <sname> -t <type>

-1

N/A

addmsgsrv -d <nonexistent_domain> -s <sname> -t <type> <ch1,ch2...>

235

N/A

rmmsgsrv -d <domain> -s <sname>

0

N/A

rmmsgsrv -d <nonexistent_domain> -s <sname>

235

N/A

rmmsgsrv -d <domain_name> -s <nonexistent_sname>

25

N/A

preload -d  <domain_name>   

PreloadFileCache not set in PSAPPSRV.CFG.

-1

N/A

preload -d  <domain_name> 

PreloadFileCache set in PSAPPSRV.CFG but not in database.

1

N/A

preload -d  <domain_name> 

PreloadFileCache set in PSAPPSRV.CFG and in database.

0

N/A

preload -d  <nonexistent_domain> 

235

N/A

stop -d <domain_name>

Domain is not started.

1

0

pslist -d  <domain_name>

0

0

pslist -d <domain_name>

Domain is not started.

0

0

pslist -d  <nonexistent_domain>

235

235

purge -d <domain_name> -noarch  -log <log_comments>

0

235

purge -d <domain_name> -arch <archive_dir>  -log <log_comments>

0

235