e-docs > Tuxedo > Command Reference > Section 1 - Commands |
Command Reference |
Name
tmadmin—BEA Tuxedo bulletin board command interpreter.
Synopsis
tmadmin [ -r ] [ -c ] [ -v ]
Description
With the commands listed in this entry, tmadmin provides for the inspection and modification of bulletin boards and associated entities in a uniprocessor, multiprocessor, or networked environment. The TUXCONFIG and TUXOFFSET environment variables are used to determine the location and offset at which the BEA Tuxedo configuration file is loaded.
If tmadmin is invoked with the -c option, it enters configuration mode. The only valid commands are default, echo, help, quit, verbose, livtoc, crdl, lidl, dsdl, indl, and dumptlog. tmadmin may be invoked in this mode on any node, including inactive nodes. A node is considered active if tmadmin can join the application as an administrative process or client (via a running BBL).
The -r option instructs tmadmin to enter the bulletin board as a client instead of as the administrator; in other words, it requests read-only access. This option is useful if you want to leave the administrator slot unoccupied.
Note: If you decide to use this option, however, be aware that you will not get all the information you get by running tmadmin without the -r option. Specifically, tmadmin -r does not report load values for servers running at remote sites.
Only one tmadmin process can be the administrator at a time. When the -r option is specified by a user other than the BEA Tuxedo administrator and security is turned on, the user is prompted for a password.
The -v option causes tmadmin to display the BEA Tuxedo version number and license number. After printing out the information, tmadmin exits. If the -v option is entered with either of the other two options, the others are ignored; only the information requested by the -v option is displayed.
Normally, tmadmin may be run on any active node within an active application. If it is run on an active node that is partitioned, commands are limited to read-only access to the local bulletin board. These command include bbls, bbparms, bbstat, default, dump, dumptlog, echo, help, interfaceparms, printactiveobject, printclient, printinterface, printfactory, printnet, printqueue, printroute, printserver, printservice, printtrans, printgroup, reconnect, quit, serverparms, serviceparms, and verbose, in addition to the configuration commands. If the partitioned node is the backup node for the MASTER (specified as the second entry on the MASTER parameter in the RESOURCES section of the configuration file), the master command is also available to make this node the MASTER for this part of the partitioned application.
If the application is inactive, tmadmin can be run only on the MASTER processor. In this mode, all of the configuration mode commands are available plus the TLOG commands (crlog, dslog, and inlog) and boot.
Once tmadmin has been invoked, commands may be entered at the prompt (>) according to the following syntax:
command [arguments]
Several commonly occurring arguments can be given defaults via the default command. Commands that accept parameters set via the default command check default to see whether a value has been set. If a value has not been set, an error message is returned.
In a networked or multiprocessor environment, a single bulletin board can be accessed by setting a default machine (the logical machine ID (LMID) as listed in the MACHINES section of the UBBCONFIG file). If the default machine is set to all, all bulletin boards are accessed. If machine is set to DBBL, the distinguished bulletin board is addressed. The default machine is shown as part of the prompt, as in: MASTER>.
If machine is not set via the default command, the DBBL is addressed (the local BBL is used in a SHM configuration).
The machine value for a command can generally be obtained from the default setting (printserver is an example). A caution is required here, however, because some commands (the TLOG commands, for example) act on devices found through TUXCONFIG; a default setting of DBBL or all results in an error. For some commands, such as logstart, you must specify the value of machine on the command line; the value does not appear as an argument to the -m option.
Once set, a default remains in effect until the session is ended, unless changed by another default command. Defaults may be overridden by entering an explicit value on the command line, or unset by entering the value "*". The effect of an override lasts for a single instance of the command.
Output from tmadmin commands is paginated according to the pagination command in use (see the description of the paginate subcommand later in this entry).
There are some commands that have either verbose or terse output. The verbose command can be used to set the default output level. However, each command (except boot, shutdown, and config) takes a -v or -t option to turn on verbose or terse output for that command only. When output is printed in terse mode, some information (for example, LMID or GROUP name, service name, or server name) may be truncated. This type of truncation is indicated by a plus sign, +, at the end of the value. The entire value may be seen by reentering the command in verbose mode.
tmadmin Commands
Commands may be entered either by their full name or their abbreviation (as given in parentheses), followed by any appropriate arguments. Arguments appearing in square brackets, [], are optional; those in curly braces, {}, indicate a selection from mutually exclusive options. Note that command line options that do not appear in square brackets need not appear on the command line (that is, they are optional) if the corresponding default has been set via the default command. Ellipses following a group of options in curly brackets, {}..., indicate that more than one of the options listed may appear on the command line (at least one must appear).
[-i srvid] | -g groupname -i srvid} service[:func]
[-i srvid] -s service | -g groupname -i srvid -s service | -I interface [-g groupname]} newload
[-i srvid] -s service | -g groupname -i srvid -s service | -I interface [-g groupname]} newpri
[-i srvid] -s service | -g groupname -i srvid -s service | -I interface [-g groupname]} newtlim
[-q qaddress] [-s service] [-b blocks] [-o offset] [-z config] [-a { 0 | 1 | 2}] [-I interface] [-B objectid] [-r routingname]
[-q qaddress] [-s service]
Security
When tmadmin runs as the administrator, it does not pass through security since it is already checked to be the application administrator's login ID.
The only time that tmadmin may run as someone other than the application administrator is if the -r option is used to access the application as a client. If such a user invokes tmadmin with the -r option, and if security is turned on for the application, the application password is required to access application data. If standard input is a terminal, tmadmin prompts the user for the password with echo turned off on the reply. If standard input is not a terminal, the password is retrieved from the APP_PW environment variable. If this environment variable is not specified and an application password is required, tmadmin fails.
Environment Variables
tmadmin acts as an application client if the -r option is used or if it cannot register as the application administrator. If this is the case, and if standard input is not from a terminal, the APP_PW environment variable must be set to the application password in a security application.
Diagnostics
If the tmadmin command is entered before the system has been booted, the following message is displayed:
No bulletin board exists. Entering boot mode
>
tmadmin then waits for a boot command to be entered:
If the tmadmin command is entered, without the -c option, on an inactive node that is not the MASTER, the following message is displayed and the command terminates:
Cannot enter boot mode on non-master node.
If an incorrect application password is entered or is not available to a shell script through the environment, a log message is generated and the command terminates, after displaying the following message:
Invalid password entered.
Interoperability
tmadmin may be run on any node within an active interoperating application. However, the commands and command-line arguments available are restricted to those available via tmadmin in the release corresponding to the node on which tmadmin is running. For example, the broadcast, passwd, and printclient commands are not available on Release 4.1 nodes.
Portability
tmadmin is supported on any platform on which the BEA Tuxedo server environment is supported.
Notices
The machine option has no effect in a non-networked uniprocessor environment.
See Also
tmboot(1), tmloadcf(1), tmshutdown(1), compilation(5)
, UBBCONFIG(5)Administering a BEA Tuxedo Application at Run Time