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 -c create -d appsrv_domain -t template -s s_set [-p p_set] [-cfg cfg_set | —cfg_from_file cfg_file_path] [-env env_set]

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

Following is an example of the application server create command, including startup settings, ports settings, and a configuration file: 

D:\PT\appserv>psadmin -c create -d HRDOM01 -t small -s PT858/ORACLE/QEDMO/QEDMO
/TESTSRV2/"c:\oracle\product\12.1.0\client_1\bin"/people/password/_____/ENCRYPT 
-p 7200/9020/9200 -cfg_from_file d:\temp\app_cfg_file.txt

The other options are described below.

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

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 Microsoft Windows, the values must be separated by slashes (/):

    DBNAME/DBTYPE/OPR_ID/OPR_PSWD/DOMAIN_ID/ADD_TO_PATH/DB_CNCT_ID/DB_CNCT_PSWD/SERVER_NAME/DOM_CONN_PWD/SEC_PRINCIPAL_PASSWORD/ENABLE_REMOTE_ADMIN/REMOTE_ADMIN_PORT/REMOTE_ADMIN_USRID/REMOTE_ADMIN_PSWD/{ENCRYPT|NOENCRYPT}/REMOTE_ADMIN_SSL_ENABLED/REMOTE_ADMIN_SSL_KEYSTORE/REMOTE_ADMIN_SSL_KEYSTORE_PWD/REMOTE_ADMIN_SSL_KEYSTORE_TYPE/REMOTE_ADMIN_SSL_TRUSTSTORE/REMOTE_ADMIN_SSL_TRUSTSTORE_PWD/REMOTE_ADMIN_SSL_TRUSTSTORE_TYPE

  • In UNIX, the values must be separated by percent signs (%):

    DBNAME%DBTYPE%OPR_ID%OPR_PSWD%DOMAIN_ID%ADD_TO_PATH%DB_CNCT_ID%DB_CNCT_PSWD%SERVER_NAME%DOM_CONN_PWD%SEC_PRINCIPAL_PASSWORD%ENABLE_REMOTE_ADMIN%REMOTE_ADMIN_PORT%REMOTE_ADMIN_USRID%REMOTE_ADMIN_PSWD%{ENCRYPT|NOENCRYPT}%REMOTE_ADMIN_SSL_ENABLED%REMOTE_ADMIN_SSL_KEYSTORE%REMOTE_ADMIN_SSL_KEYSTORE_PWD%REMOTE_ADMIN_SSL_KEYSTORE_TYPE%REMOTE_ADMIN_SSL_TRUSTSTORE%REMOTE_ADMIN_SSL_TRUSTSTORE_PWD%REMOTE_ADMIN_SSL_TRUSTSTORE_TYPE

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) Settings 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, MICROSFT, and DB2ODBC. 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, PS, or VP1, 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 Security Administration: 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.

SERVER_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 and ConnectPswd parameters in the psappsrv.cfg file. If you specify NOENCRYPT, these values appear in clear text in the file. ENCRYPT is the default value.

SEC_PRINCIPAL_PASSWORD

Enter a password for use with Oracle wallet.

ENABLE_REMOTE_ADMIN

Specify whether to enable embedded JMX agents for PeopleSoft Health Center. Enter 1 to enable remote administration, and 0 to disable remote administration. The default is enabled.

When remote administration is enabled, you must also specify values for REMOTE_ADMIN_PORT, REMOTE_ADMIN_USRID, and REMOTE_ADMIN_PSWD.

If you do not explicitly disable remote administration, and you do not provide values for REMOTE_ADMIN_PORT, REMOTE_ADMIN_USRID, and REMOTE_ADMIN_PSWD, the system will generate values for the user ID and password and place the encrypted values in the PSTOOLS section of the psappsrv.cfg file.

See Performance Monitor: Enabling Monitoring of a Component or Domain

REMOTE_ADMIN_PORT

Enter a port number to use for remote administration of domain processes. All embedded JMX agents will use the port in the JMX service URL.

REMOTE_ADMIN_USRID

Enter a user name for remote administration connections.

REMOTE_ADMIN_PSWD

Enter a password for remote administration connections.

REMOTE_ADMIN_SSL_ENABLED

Specify whether to enable SSL for JMX agents. Enter 1 to enable SSL, and 0 to disable SSL. The default is disabled.

When you enable SSL for JMX agents, you must also specify the location, password, and type for the keystore and truststore.

REMOTE_ADMIN_SSL_KEYSTORE

Specify the location of the keystore for SSL.

REMOTE_ADMIN_SSL_KEYSTORE_PWD

Specify the password for the SSL keystore. The password must be encrypted with PSCipher.

See Security Administration: Using the PSCipher Utility

REMOTE_ADMIN_SSL_KEYSTORE_TYPE

Specify the keystore type, PKCS12 or JKS.

REMOTE_ADMIN_SSL_TRUSTSTORE

Specify the location of the truststore for SSL.

REMOTE_ADMIN_SSL_TRUSTSTORE_PWD

Specify the password for the SSL truststore. The password must be encrypted with PSCipher.

See Security Administration: Using the PSCipher Utility

REMOTE_ADMIN_SSL_TRUSTSTORE_TYPE

Specify the truststore type, PKCS12 or JKS.

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 Microsoft Windows, the values must be separated by slashes.

    WSL_PORT/JSL_PORT/JRAD_PORT/WSL_SSL_PORT/JSL_SSL_PORT

  • In UNIX, the values must be separated by percent signs.

    WSL_PORT%JSL_PORT%JRAD_PORT%WSL_SSL_PORT%JSL_SSL_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 specify WSL_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.

WSL_SSL_PORT

SSL port for Workstation listener. This is the same as the SSL PORT parameter in the Workstation Listener section of the psappsrv.cfg file.

JSL_PORT

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

JSL_SSL_PORT

SSL port for Jolt. This is the same as the SSL 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.

Supply configuration settings in a string with the cfg_set parameter or reference a file with the cfg_file_path parameter.

The cfg_set parameter is an optional string of configuration settings from the psappsrv.cfg file. Use the number sign (#) to separate each setting, and surround the string with double quotes if any of the values include spaces. For example: 

"[PSAPPSRV]/Min Instances=2#[PSAPPSRV]/Max Instances=8"

If you include a password that has a number sign (#), you must precede it with a slash (\). For example:

"[Security]/DomainConnectionPwd=password\##[Workstation Listener]/Port=7000"

Alternatively, you can supply configuration settings in a file. Specify the path and file name with the parameter cfg_file_path. Use this option rather than cfg_set if you are supplying passwords that contain special characters. Each line specifies a psappsrv.cfg file section, a parameter and value, with this format: 

[<Section>]/<Param Name>=<Param Value> 
[<Section>]/<Param Name>=<Param Value>

For example:

[Domain Settings]/Domain ID=APPDOM  
[PSAPPSRV]/Min Instances=2  
[PSAPPSRV]/Max Instances=8  
[PSAPPSRV]/Max Fetch Size=15000  
[Security]/DomainConnectionPwd=password  
[JOLT Listener]/Port=9033  
[JOLT Listener]/Address=0.0.0.0  
[Workstation Listener]/Port=7000

The configuration parameters are described elsewhere in this document, organized by section name. See Understanding Application Server Domain Parameters.

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

ENVAR_NAME1=ENVVAR_VALUE1#ENVAR_NAME2=ENVVAR_VALUE2

For example: 

TM_BOOTTIMEOUT=120#TM_RESTARTSRVTIMEOUT=120#TM_BOOTPRESUMEDFAIL=Y

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

Copying application server configuration files...
Copying [D:\PT\appserv\small.cfx] to [D:\PT_SERVER\8.59\appserv\HRDOM01\
psappsrv.cfg]
Stripping Annotations...
Copying [D:\PT\appserv\small.cfx] to [D:\PT_SERVER\8.59\appserv\HRDOM01\
psappsrv.cfx]
Copying Jolt repository file...
Domain created.
Performing load prechecks ...
Loading validation table...
  setting DBName=PT858DMO
  setting DBType=ORACLE
  setting UserId=QEDMO
  setting UserPswd=encrypted_password
  setting ConnectId=people
  setting ConnectPswd=encrypted_password
  setting ServerName=
  setting Port=7200
  setting Port=9020
  setting Listener Port=9200
  setting Domain ID=TESTSRV2
  setting Add to PATH=c:\oracle\product\12.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 -c command -d appsrv_domain

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

The valid values of the command parameter are as follows:

Note:

The examples in this table include line feeds for readability.

Command Example Result of the Example

start

 
psadmin -c start 
-d PSDMO

Starts an application server domain named PSDMO.

parallelboot

 
psadmin -c parallelboot 
-d PSDMO

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

configure

 
psadmin -c configure 
-d PSDMO
[-cfg cfg_set]
[-cfg_from_file cfg_file_path]
[-u feature_set]

Reloads the domain configuration for the PSDMO domain.

See the following section Using the Application Server Configure Command.

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.

stop

 
psadmin -c stop 
-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.

kill

 
psadmin -c kill 
-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 -noarch
psadmin -c purge 
-d PSDMO -arch archive_directory
psadmin -c purge 
-d PSDMO -log log_comments

Purges the cache for the PSDMO domain.

You may use the following options as required:

  • Use the -noarch option if you do not want to archive the purged cache.

  • Use the -arch archive_directory option to quarantine the purged cache in the specified location.

  • Use -log log_comments to add the specified comments to the purge cache log entry.

import

 
psadmin -c import 
PS_CFG_HOME -n NEWAPPDOM

Imports the domain configuration from a specified PS_CFG_HOME location or a specified configuration file. See the following section Using the Application Server Import Commands for examples.

addmsgsrv

 
psadmin -c addmsgsrv 
-d PSDMO -s MSGSRV 
-t type ch1,ch2,ch3

Add a message server named MSGSRV (-s) to the domain PSDMO.

Specify PUB, SUB, or BRK as the type (-t). The channels for the server are ch1, ch2, and ch3.

rmmsgsrv

 
psadmin -c rmmsgsrv 
-d PSDMO -s MSGSRV

Remove a message server named MSGSRV (-s) from the domain PSDMO.

See Integration Broker Administration: Understanding Messaging Server Administration

Using the Application Server Configure Commands

Use these commands to configure an existing application server domain.

psadmin -c configure -d appsrv_domain [-cfg cfg_set | -cfg_from_file cfg_file_path] [-u feature_set]

Supply configuration settings in a string with cfg_set. or reference a file with cfg_file_path. See the discussion earlier in this section.

Use the -u feature_set option to enable or disable a set of features in the existing domain. To construct feature_set:

  1. Access PS_CFG_HOME/appserv/appsrv_domain/psappsrv.ubx.

  2. In the *FEATURES section, make a note of the {"-define-"} field for the feature you want to include.

    For example, the {"-define-"} field for Analytic Servers is {ANALYTICSRV}.

    *FEATURES
{"-label-"},{"-define-"},{"-on-"},{"-servers-"},{"-Oracle Env Manager Label-"}
...
{Analytic Servers},{ANALYTICSRV},{Yes},{PSANALYTICSRV},{Analytic Servers (PSANALYTICSRV)}

  3. Use the value from the {"-define-"} field in this format for feature_set.

    Use a slash (/) on Microsoft Windows to separate features.

    {FEATURE}=Yes|No/{FEATURE}=Yes|No...

    Use a percent sign (%) on UNIX to separate features.

    {FEATURE}=Yes|No%{FEATURE}=Yes|No...

For example, use this command to disable WSL and enable Analytic Servers in an application server domain.

On Microsoft Windows:

psadmin -c configure -d appsrv_domain -u "{WSL}=No/{ANALYTICSRV}=Yes"

On UNIX:

psadmin -c configure -d appsrv_domain -u "{WSL}=No%{ANALYTICSRV}=Yes"

Using the Application Server Import Commands

Use these commands to import an application server domain configuration:

  • To import a domain from the location PS_CFG_HOME, use the following command.

    Use this command if there is a single domain in PS_CFG_HOME.

    psadmin -c import ps_cfg_home_path

  • To import a domain when PS_CFG_HOME has more than one domain, use the following command.

    The imported domain has the same name as the original domain.

    psadmin -c import ps_cfg_home_path —d appsrv_domain

  • To import a domain to a new name, from a multi-domain PS_CFG_HOME, use the following command:

    psadmin -c import ps_cfg_home_path —d appsrv_domain —n new_domain_name

  • To import a domain to a new name, from a multi-domain PS_CFG_HOME.

    Specify the path to a template file and use the following command.

    psadmin -c import ps_cfg_home_path —d appsrv_domain —n new_domain_name —t template_path

  • Use a configuration file to import a domain to a new name.

    Supply the path and name for psappsrv.cfg for config_file_path.

    psadmin -c import config_file_path —n new_domain_name

  • Use a configuration file to import a domain to a new name.

    Specify the path and name for psappsrv.cfg for config_file_path, and specify the path to a template file.

    psadmin -c import config_file_path —n new_domain_name —t template_path