Table 7-2 Tasks You Can Perform With mpsadmconfig(1M)
Commands for Tasks
|
What the Command Does
|
-countA[ccessLogEntries]
|
Counts the number of entries in the access log file. Run this task before -viewAccessLogEntries to determine the number of entries in the access log.
|
-viewA[ccessLogEntries]
|
Lets you view the specified entries in the error log file.
Syntax
/usr/sbin/mpsadmconfig [options] -viewAccessLogEntries \'start stop\'
Required Arguments
start The number of the first log entry to display.
stop The number of the last log entry to display.
On UNIX systems, the backslash character is required before the quotes surrounding the start and stop arguments. If the backslash is not provided, the shell evaluates the quotes and pass the arguments without quotes to the command line. As a result, only start is assigned as a parameter for -viewAccessLogEntries, causing the operation to fail.
|
-countE[rrorLogEntries]
|
Counts the number of entries in the error log file. Run this task prior to -viewErrorLogEntries to determine the number of entries in the error log.
|
-viewE[rrorLogEntries]
|
Lets you view the specified entries in the error log file.
Syntax
/usr/sbin/mpsadmconfig [options] -viewErrorLogEntries \'start stop\'
Required Arguments
start The number of the first log entry to display.
stop The number of the last log entry to display.
On UNIX systems, the backslash character is required before the quotes surrounding the start and stop arguments. If the backslash is not provided, the shell evaluates the quotes and pass the arguments without quotes to the command line. As a result, only start is assigned as a parameter for -viewErrorLogEntries, causing the operation to fail.
|
-getAc[cessLog]
|
Retrieves the path for the access log file for this instance of Administration Server.
|
-setAc[cessLog]
|
Specifies the path for the access log file for this instance of Administration Server.
Syntax
/usr/sbin/mpsadmconfig [options] -setAccessLog filename
Required Argument
filename Full path of the new server access log file.
|
-getAdd[resses]
|
Lets you view the IP addresses from which connections are allowed.
|
-setAdd[resses]
|
Specifies the IP addresses from which connections are allowed.
Syntax
/usr/sbin/mpsadmconfig [options] -setAddresses addresses
Required Argument
addresses New IP addresses and host names (separated by spaces) from which connections are allowed.
|
-getAdminUI[D]
|
Retrieves the Administration Server Administrator's user name.
|
-setAdminUI[D]
|
Specifies the Administration Server Administrator's user name.
Syntax
/usr/sbin/mpsadmconfig [options] -setAdminUID uid
Required Argument
uid The new Administration Server Administrator's user ID.
|
-setAdminP[wd]
|
Specifies the Administration Server Administrator's password.
Syntax
/usr/sbin/mpsadmconfig [options] -setAdminPwd password
Required Argument
password The new password for the Administration Server Administrator.
|
-getAdminUs[ers]
|
Retrieves the path of the adminusers file.
|
-setAdminUs[ers]
|
Specifies the path of the adminusers file.
Syntax
/usr/sbin/mpsadmconfig [options] -setAdminUsers adminusers
Required Argument
adminusers New path for the adminusers file.
|
-getCa[cheLifetime]
|
Displays the amount of time for which a user authentication is cached.
|
-setCa[cheLifetime]
|
Specifies the amount of time to cache a user authentication.
Syntax
/usr/sbin/mpsadmconfig [options] -setCacheLifetime msec
Required Argument
msec New cache lifetime in milleseconds.
|
-getCl[assname]
|
Retrieves the Java classname for this instance of Administration Server.
|
-setCl[assname]
|
Enables you to set a new Java classname for this instance of Administration Server.
Syntax
/usr/sbin/mpsadmconfig [options] -setClassname classname
Required Argument
classname New path for the Java class file.
|
-getDe[faultAcceptLanguage]
|
Displays the default language for this instance of Administration Server.
|
-setDe[faultAcceptLanguage]
|
Specifies the default language for this instance of Administration Server.
Syntax
/usr/sbin/mpsadmconfig [options] -setDefaultAcceptLanguage language
Required Argument
language New default language. This is specified with an ISO 639 two letter code. For example, English is en.
|
-getDS[Config]
|
Retrieves the current LDAP server host, port, and base DN, and identifies whether the LDAP server is running SSL.
|
-setDS[Config]
|
Specifies the LDAP server host, port, and base DN, and specifies whether the LDAP server is running SSL.
Syntax
/usr/sbin/mpsadmconfig [options] -setDSConfig \'host port baseDN ssl\'
Required Arguments
host The LDAP Server host name.
port The LDAP Server port number.
baseDN The LDAP Server base DN.
ssl Specify true or false depending on whether the LDAP server is already using the Secure Sockets Layer (SSL) protocol to communicate with this instance of Administration Server.
On UNIX systems, the backslash character is required before the quotes surrounding the these arguments. If the backslash is not provided, the shell evaluates the quotes and pass the arguments without the quotes to the command line. As a result, only host is assigned as a parameter for -setDSConfig, causing the operation to fail.
|
-getU[GDSConfig]
|
Retrieves the current user and group LDAP server information, including the host, port, base DN, and authentication DN.
|
-setU[GDSConfig]
|
Specifies the host, port, base DN, authentication DN, and authentication password for the instance of Directory Server containing the user and group directory.
You can invoke -setUGDSConfig either with or without arguments. If you invoke this task without any arguments, the Directory Server configuration is reset to the installation defaults.
Syntax
/usr/sbin/mpsadmconfig [options] -setUGDSConfig [\'host port baseDN ssl uid pwd\']
Optional Arguments
If you want to override the current user and group settings, you must provide all six of the following arguments:
- host The host name on which the instance of Directory Server is running.
- port The port number on which the instance of Directory Server is running.
- baseDN The base DN for the instance of Directory Server.
- ssl Specify true or false depending on whether the instance of Directory Server is already using the Secure Sockets Layer (SSL) protocol to communicate with this instance of Administration Server.
- uid The Distinguished Name used to bind to the instance of Directory Server. Example: dn:uid=dfauvarque,ou=people,dc=example,dc=com
- pwd The password used to bind to the instance of Directory Server.
On UNIX systems, the backslash character is required before the quotes surrounding these arguments. If the backslash is not provided, the shell evaluates the quotes and pass the arguments without quotes to the command line. As a result, only host is assigned as a parameter for -setUGDSConfig, causing the operation to fail.
The host, port, baseDN, and ssl arguments are used to create the LDAP URL for the ugdsconfig.dirurl attribute. The uid argument is used to set the ugdsconfig.binddn attribute, and the pwd argument is used to set the ugdsconfig.bindpw attribute.
Note that the space character is used to parse these six arguments. Therefore, none of the arguments can have spaces in them. To indicate spaces within an argument, use the + character. For example, to specify cn=directory manager as the value for the uid attribute, enter cn=directory+manager. Since the + character is used in place of the space character, you cannot use it as an actual value.
|
-getE[rrorLog]
|
Retrieves the path for the server error log file.
|
-setE[rrorLog]
|
Specifies the path for the server error log file.
Syntax
/usr/sbin/mpsadmconfig [options] -setErrorLog filename
Required Argument
filename Full path of the new server access log file.
|
-getH[osts]
|
Lets you view the host names from which connections are allowed.
|
-set[Hosts]
|
Specifies the host names from which connections are allowed.
Syntax
/usr/sbin/mpsadmconfig [options] -setHosts hosts
Required Argument
hosts host names from which connections are allowed.
|
-getO[neACLDir]
|
Retrieves the path for the ACL folder.
|
-setO[neACLDir]
|
Specifies the path for the ACL folder.
Syntax
/usr/sbin/mpsadmconfig [options] -setOneACLDir directory
Required Argument
directory Path for the ACL folder.
|
-getPo[rt]
|
Lets you view the port number that this instance of Administration Server is using.
|
-setPo[rt]
|
Specifies the port number that this instance of Administration Server should use.
Syntax
/usr/sbin/mpsadmconfig [options] -setPort port
Required Argument
port Port number that this instance of Administration Server should use.
|
-getSe[rverAddress]
|
Retrieves the IP address of this instance of Administration Server.
|
-setSe[rverAddress]
|
Specifies the IP address that this instance of Administration Server should use.
Syntax
/usr/sbin/mpsadmconfig [options] -setServerAddress address
Required Argument
address IP address that this server should use.
|
-getSy[stemUser]
|
Retrieves the user name that this instance of Administration Server runs as.
|
-setSy[stemUser]
|
Specifies the user name that this instance of Administration Server should run as.
Syntax
/usr/sbin/mpsadmconfig [options] -setSuiteSpotUser user
Required Argument
user User ID that this instance should run as.
|
-r[estart]
|
Restarts this instance of Administration Server.
|
-st[op]
|
Stops this instance of Administration Server.
|