PURPOSE

dmadmin - TUXEDO System/T Domain Administration Command Interpreter

SYNOPSIS

dmadmin [ -c ]

DESCRIPTION

dmadmin is an interactive command interpreter used for the administration of domain gateway groups defined for a particular TUXEDO System/T application. dmadmin can operate in two modes: administration mode and configuration mode.

dmadmin enters administration mode when called with no parameters. This is the default. In this mode, dmadmin can be run on any active node (excluding workstations) within an active application. Application administrators can use this mode to obtain or change parameters on any active domain gateway group. Application administrators may also use this mode to create, destroy, or reinitialize the DMTLOG for a particular local domain. In this case, the domain gateway group associated with that local domain must not be active, and dmadmin must be run on the machine assigned to the corresponding gateway group.

dmadmin enters configuration mode when it is invoked with the -c option or when the config subcommand is invoked. Application administrators can use this mode to update or add new configuration information to the binary version of the domain configuration file (BDMCONFIG).

dmadmin requires the use of the DOMAIN administrative server (DMADM) for the administration of the BDMCONFIG file and the gateway administrative server (GWADM) for the re-configuration of active DOMAIN gateway groups (there is one GWADM per gateway group).

ADMINISTRATION MODE COMMANDS

Once dmadmin has been invoked, commands may be entered at the prompt (">") according to the following syntax: command [arguments]

Several commonly occurring arguments can be given default values via the default command. Commands that accept parameters set via the default command check default to see if a value has been set. If one hasn't, an error message is returned.

Once set, a default value 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 dmadmin commands is paginated according to the pagination command in use (see the paginate subcommand below).

Commands may be entered either by their full name or their abbreviation (shown 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 for many commands local_domain_name is a required argument, but note also that it can be set with the default command.

The following commands are available in administration mode:

advertise (adv) -d local_domain_name [{ -all | service}]

Advertise all remote services provided by the named local domain or the specified remote service.

audit (audit) -d local_domain_name [{off | on}]

Activate (on) or deactivate (off) the audit trace for the named local domain. If no option is given, then the current setting will be toggled between the values on and off, and the new setting will be printed. The initial setting is off.

chbktime (chbt) -d local_domain_name -t bktime

Change the blocking timeout for a particular local domain.

config (config)

Enter configuration mode. Commands issued in this mode follow the conventions defined in the section "Configuration Mode Commands" (see below).

crdmlog (crdlog) -d local_domain_name

Create the domain transaction log for the named local domain on the current machine (that is, the machine where dmadmin is running). The command uses the parameters specified in the DMCONFIG file. This command fails if the named local domain is active on the current machine or if the log already exists.

default (d) [-d local_domain_name]

Set the corresponding argument to be the default local domain. Defaults may be unset by specifying "*" as an argument. If the default command is entered with no arguments, the current default values are printed.

dsdmlog (dsdlg) -d local_domain_name [ -y ]

Destroy the domain transaction log for the named local domain on the current machine (that is, the machine where dmadmin is running). An error is returned if a DMTLOG is not defined for this local domain, if the local domain is active, or if outstanding transaction records exist in the log. The term outstanding transactions means that a global transaction has been committed but an end-of-transaction has not yet been written. This command prompts for confirmation before proceeding unless the -y option is specified.

echo (e) [{off | on}]

Echo input command lines when set to on. If no option is given, then the current setting is toggled, and the new setting is printed. The initial setting is off.

forgettrans (ft) -d local_domain_name [ -t tran_id]

Forget one or all heuristic log records for the named local domain. If the transaction identifier tran_id is specified, then only the heuristic log record for that transaction will be forgotten. The transaction identifier tran_id can be obtained from the printtrans command or from the ULOG file.

help (h) [command]

Print help messages. If command is specified, the abbreviation, arguments, and description for that command are printed. Omitting all arguments causes the syntax of all commands to be displayed.

indmlog (indlg) -d local_domain_name [ -y ]

Reinitialize the domain transaction log for the named local domain on the current machine (that is, the machine where dmadmin is running). An error is returned if a DMTLOG is not defined for this local domain, if the local domain is active, or if outstanding transaction records exist in the log. The term outstanding transactions means that a global transaction has been committed but an end-of-transaction has not yet been written. The command prompts for confirmation before proceeding unless the -y option is specified.

paginate (page) [{off | on}]

Paginate output. If no option is given, then the current setting will be toggled, and the new setting is printed. The initial setting is on, unless either standard input or standard output is a non-tty device. Pagination may only be turned on when both standard input and standard output are tty devices. The shell environment variable PAGER may be used to override the default command used for paging output. The default paging command is the indigenous one to the native operating system environment, for example, the command pg is the default on UNIX System operating environments.

passwd (passwd) [ -r ] local_domain_name remote_domain_name

Prompts the administrator for new passwords for the specified local and remote domains. The -r option specifies that existing passwords and new passwords should be encrypted using a new key generated by the system. The password is truncated after at most eight characters.

printdomain (pd) -d local_domain_name

Print information about the named local domain. Information printed includes connected remote domains, global information shared by the gateway processes, and additional information that is dependent on the domain type instantiation.

printstats (pstats) -d local_domain_name

Print statistical and performance information gathered by the named local domain. The information printed is dependent on the domain gateway type.

printtrans (pt) -d local_domain_name

Print transaction information for the named local domain.

quit (q)

Terminate the session.

resume (res) -d local_domain_name [{ -all | service}]

Resume processing of the specified service or for all remote services handled by the named local domain.

stats (stats) -d local_domain_name [{ off | on | reset }]

Activate (on), deactivate (off), or reset (reset) statistics gathering for the named local domain. If no option is given, then the current setting will be toggled between the values on and off, and the new setting will be printed. The initial setting is off.

suspend (susp) -d local_domain_name [{ -all | service}]

Suspend one or all remote services for the named local domain.

unadvertise (unadv) -d local_domain_name [{ -all | service}]

Unadvertise one or all remote services for the named local domain.

verbose (v) [{off | on}]

Produce output in verbose mode. If no option is given, then the current setting will be toggled, and the new setting is printed. The initial setting is off.

! shellcommand

Escape to shell and execute shellcommand.

!!

Repeat previous shell command.

# [text]

Lines beginning with "#" are comment lines and are ignored.

<CR>

Repeat the last command.

CONFIGURATION MODE COMMANDS

The dmadmin command enters configuration mode when executed with the -c option or when the config subcommand is used. In this mode, dmadmin allows run-time updates to the BDMCONFIG file. dmadmin manages a buffer that contains input field values to be added or retrieved, and displays output field values and status after each operation completes. The user can update the input buffer using any available text editor.

dmadmin first prompts for the desired section followed by a prompt for the desired operation.

The prompt for the section is as follows:

Sections:
	1) LOCAL_DOMAINS	2) REMOTE_DOMAINS
	3) LOCAL_SERVICES	4) REMOTE_SERVICES
	5) ROUTING		6) ACCESS_CONTROL
	7) PASSWORDS		8) TDOMAIN
	9) OSITP		10) QUIT
Enter Section [1]:

The number of the default section appears in square brackets at the end of the prompt. You can accept the default by pressing RETURN or ENTER. To select another section enter its number, then press RETURN or ENTER.

dmadmin then prompts for the desired operation.

Operations:
	1) FIRST	2) NEXT
	3) RETRIEVE	4) ADD
	5) UPDATE	6) DELETE
	7) NEW_SECTION	8) QUIT
Enter Operation [1]:

The number of the default operation is printed in square brackets at the end of the prompt. Pressing RETURN or ENTER selects this option. To select another operation enter its number, then press RETURN or ENTER.

The currently supported operations are:

1. FIRST

Retrieve the first record from the specified section. No key fields are needed (they are ignored if in the input buffer).

2. NEXT

Retrieve the next record from the specified section, based on the key fields in the input buffer.

3. RETRIEVE

Retrieve the indicated record from the specified section by key field(s) (see fields description below).

4. ADD

Add the indicated record in the specified section. Any fields not specified (unless required) take their default values as specified in dmconfig(5). The current value for all fields is returned in the output buffer. This operation can only be done by the System/T administrator.

5. UPDATE

Update the record specified in the input buffer in the selected section. Any fields not specified in the input buffer remain unchanged. The current value for all fields is returned in the input buffer. This operation can only be done by the System/T administrator.

6. DELETE

Delete the record specified in the input buffer from the selected section. This operation can only be done by the System/T administrator.

7. NEW SECTION

Clear the input buffer (all fields are deleted). After this operation, dmadmin immediately prompts for the section again.

8. QUIT

Exit the program gracefully (dmadmin is terminated). A value of q for any prompt also exits the program.

For configuration operations, the effective user identifier must match the System/T administrator user identifier (UID) for the machine on which this program is executed. When a record is updated or added, all default values and validations used by dmloadcf(1) are enforced.

dmadmin then prompts whether or not to edit the input buffer. Enter editor to add/modify fields [n]?Entering a value of y will put the input buffer into a temporary file and execute the text editor. The environment variable EDITOR is used to determine which editor to be used; the default is "ed". The input format is in field name/field value pairs and is described in the CONFIGURATION INPUT FORMAT section below. The field names associated with each DMCONFIG section are listed in tables in the subsections below. The semantics of the fields and associated ranges, default values, restrictions, etc, are described in dmconfig(5). In most cases, the field name is the same as the KEYWORD in the DMCONFIG file, prefixed with "TA_". When the user completes editing the input buffer, dmadmin reads it. If more than one line occurs for a particular field name, the first occurrence is used and other occurrences are ignored. If any errors occur, a syntax error will be printed and dmadmin prompts whether or not to correct the problem. Enter editor to correct?

If the problem is not corrected (response n), then the input buffer will contain no fields. Otherwise, the editor is executed again.

Finally, dmadmin asks if the operation should be done. Perform operation [y]?

When the operation completes, dmadmin prints the return value as in Return value TAOKfollowed by the output buffer fields. The process then begins again with a prompt for the section. All output buffer fields are available in the input buffer unless the buffer is cleared.

Entering break at any time restarts the interaction at the prompt for the section.

When "QUIT" is selected, dmadmin prompts for authorization to create a backup ASCII version of the configuration: Unload BDMCONFIG file into ASCII backup [y]?If a backup is selected, dmadmin prompts for the file name. Backup filename [DMCONFIG]?On success, dmadmin indicates that a backup was created, otherwise an error is printed.

CONFIGURATION INPUT FORMAT

Input packets consist of lines formatted as follows: fldname<tabs>fldval

The field name is separated from the field value by one or more tabs (or spaces).

Lengthy field values can be continued on the next line by having the continuation line begin with one or more tabs (which are dropped when read back into dmadmin).

Empty lines consisting of a single newline character are ignored.

To enter an unprintable character in the field value or to start a field value with a tab, use a backslash followed by the two-character hexadecimal representation of the desired character (see ASCII(5) in a UNIX reference manual). A space, for example, can be entered in the input data as \20. A backslash can be entered using two backslash characters. dmadmin recognizes all input in this format, but its greatest usefulness is for non-printing characters.

CONFIGURATION LIMITATIONS

The following are general limitations of the dynamic domain re-configuration capability:

-

Values for key fields (as indicated in the following sections) may not be modified. Key fields can be modified, when the system is down, by reloading the configuration file.

 

-

Dynamic deletions cannot be applied when local domains are active (the corresponding gateway group is running).

RESTRICTIONS FOR CONFIGURATION FIELD IDENTIFIERS/UPDATES

The following sections describe, for each DMCONFIG section, what the field identifiers are associated with each DMCONFIG field, what the field type of the identifier is, and when the field can be updated. All applicable field values are returned with the retrieval operations. Fields that are allowed and/or required for adding a record are described in dmconfig(5). Fields indicated below as key are key fields that are used to uniquely identify a record within section. These key fields are required to be in the input buffer when updates are done and are not allowed to be updated dynamically. The Update column indicates when a field can be updated. The possible values are:

Yes

-- Can be updated at any time.

 

NoGW

-- Cannot be updated dynamically while the gateway group representing the local domain is running.

 

No

-- Cannot be updated dynamically while at least one gateway group is running.

CONFIGURING THE DM_LOCAL_DOMAINS SECTION

The following table lists the fields in the *DM_LOCAL_DOMAINS section.

CONFIGURING THE DM_REMOTE_DOMAINS SECTION

The following table lists the fields in the *DM_REMOTE_DOMAINS section.

CONFIGURING THE DM_TDOMAIN SECTION

The *DM_TDOMAIN section contains the network addressing parameters required by TDOMAIN type domains. The following lists the fields in this section:

If the domain identifier (TA_LDOM) is a local domain identifier, then the TA_NWADDR and TA_NWDEVICE fields can be updated if the gateway group representing that local domain is not running.

CONFIGURING THE DM_OSITP SECTION

The *DM_OSITP section contains the network addressing parameters required by OSITP type domains. The following lists the fields in this section:

If the domain identifier (TA_LDOM) is a local domain identifier, then the other fields in this table can be updated if the gateway group representing that local domain is not running.

CONFIGURING THE DM_LOCAL_SERVICES SECTION

The following table lists the fields in the *DM_LOCAL_SERVICES section.

CONFIGURING THE DM_REMOTE_SERVICES SECTION

The following table lists the fields in the *DM_REMOTE_SERVICES section.

CONFIGURING THE DM_ROUTING SECTION

The following table lists the fields in the *DM_ROUTING section.

CONFIGURING THE DM_ACCESS_CONTROL SECTION

The following table lists the fields in the *DM_ACCESS_CONTROL section.

CONFIGURING THE DM_PASSWORDS SECTION

The following table lists the fields in the *DM_PASSWORDS section.

The TA_LPWD and TA_RPWD show the existence of a defined password for the local and/or the remote domain. Passwords are not displayed. If an UPDATE operation is selected, the value of the corresponding field must be set to U. The program will then prompt with echo turned off for the corresponding passwords.

DIAGNOSTICS IN CONFIGURATION MODE

dmadmin fails if it cannot allocate an FML typed buffer, if it cannot determine the /etc/passwd entry for the user, or if it cannot reset the environment variables FIELDTBLS or FLDTBLDIR.

The return value printed by dmadmin after each operation completes indicates the status of the requested operation. There are three classes of return values.

The following return values indicate a problem with permissions or a TUXEDO System/T communications error. They indicate that the operation did not complete successfully.

[TAEPERM] The calling process specified an ADD, UPDATE, or DELETE operation but it is not running as the System/T administrator. Update operations must be run by the administrator (that is, the user specified in the UID attribute of the RESOURCES section of the TUXCONFIG file).

[TAESYSTEM] A TUXEDO System/T error has occurred. The exact nature of the error is written to userlog(3cbl).

[TAEOS] An operating system error has occurred.

[TAETIME] A blocking timeout occurred. The input buffer is not updated so no information is returned for retrieval operations. The status of update operations can be checked by doing a retrieval on the record that was being updated.

The following return values indicate a problem in doing the operation itself and generally are semantic problems with the application data in the input buffer. The string field TA_STATUS will be set in the output buffer and will contain short text describing the problem. The string field TA_BADFLDNAME will be set to the field name for the field containing the value that caused the problem (assuming the error can be attributed to a single field).

[TAECONFIG] An error occurred while reading the BDMCONFIG file.

[TAEDUPLICATE] The operation attempted to add a duplicate record.

[TAEINCONSIS] A field value or set of field values are inconsistently specified.

[TAENOTFOUND] The record specified for the operation was not found.

[TAENOSPACE] The operation attempted to do an update but there was not enough space in the BDMCONFIG file.

[TAERANGE] A field value is out of range or is invalid.

[TAEREQUIRED] A field value is required but not present.

[TAESIZE] A field value for a string field is too long.

[TAEUPDATE] The operation attempted to do an update that is not allowed. The following return values indicate that the operation was successful.

[TAOK] The operation succeeded. No updates were done to the BDMCONFIG file.

[TAUPDATED] The operation succeeded. Updates were made to the BDMCONFIG file.

When using dmunloadcf to print entries in the configuration, optional field values are not printed if they are not set (for strings) or 0 (for integers). These fields will always appear in the output buffer when using dmadmin. In this way, it makes it easier for the administrator to retrieve an entry and update a field that previously was not set. The entry will have the field name followed by a tab but no field value.

CONFIGURATION EXAMPLE

In the following example, dmadmin is used to add a new remote domain. For illustration purposes, ed(1) is used for the editor.

$ EDITOR=ed dmadmin
> config
Sections:
	1) LOCAL_DOMAINS	2) REMOTE_DOMAINS
	3) LOCAL_SERVICES	4) REMOTE_SERVICES
	5) ROUTING		6) ACCESS_CONTROL
	7) PASSWORDS		8) TDOMAIN
	9) OSITP		10) QUIT
Enter Section [1]: 2
Operations:
	1) FIRST	2) NEXT
	3) RETRIEVE	4) ADD
	5) UPDATE	6) DELETE
	7) NEW_SECTION	8) QUIT
Enter Operation [1]: 4
Enter editor to add/modify fields [n]? y
a
TA_RDOM		B05
TA_DOMAINID		BA.BANK05
TA_TYPE		TDOMAIN
w
53
q
Perform operation [y]? <return>
Return value TAUPDATED
Buffer contents:
TA_OPERATION	4
TA_SECTION	2
TA_DOMAINID	BA.BANK05
TA_RDOM	B05
TA_TYPE	TDOMAIN
TA_STATUS	Update completed successfully
Operations:
	1) FIRST	2) NEXT
	3) RETRIEVE	4) ADD
	5) UPDATE	6) DELETE
	7) NEW_SECTION	8) QUIT
Enter Operation [4]: 7
Sections:
	1) LOCAL_DOMAINS	2) REMOTE_DOMAINS
	3) LOCAL_SERVICES	4) REMOTE_SERVICES
	5) ROUTING		6) ACCESS_CONTROL
	7) PASSWORDS		8) TDOMAIN
	9) OSITP		10) QUIT
Enter Section [1]: 8
Operations:
	1) FIRST	2) NEXT
	3) RETRIEVE	4) ADD
	5) UPDATE	6) DELETE
	7) NEW_SECTION	8) QUIT
Enter Operation [6]: 4
Enter editor to add/modify fields [n]? y
a
TA_RDOM		B05
TA_NWADDR		0x00020401c0066d05
TA_NWDEVICE	/dev/tcp
w
55
q
Perform operation [y]? <return>
Return value TAUPDATED
Buffer contents:
TA_OPERATION	4
TA_SECTION	8
TA_RDOM	B05
TA_NWADDR	0x00020401c0066d05
TA_NWDEVICE	/dev/tcp
TA_STATUS	Update completed successfully
Operations:
	1) FIRST	2) NEXT
	3) RETRIEVE	4) ADD
	5) UPDATE	6) DELETE
	7) NEW_SECTION	8) QUIT
Enter Operation [4]: 8
> quit
The dmadmin program ends.

SECURITY

If dmadmin is run with the application administrator's UID, it assumes a trusted user and Security is bypassed. If dmadmin is run with another user ID, and if the security option is enabled in the TUXCONFIG file, then the corresponding application password is required to start the dmadmin program. If standard input is a terminal, then dmadmin will prompt the user for the password with echo turned off. If standard input is not a terminal, the password is retrieved from the environment variable, APP_PW. If this environment variable is not specified and an application password is required, then dmadmin will fail to start.

When running with another user ID (other than the UID of the administrator) only a limited set of commands is available.

ENVIRONMENT VARIABLES

dmadmin resets the FIELDTBLS and FLDTBLDIR environment variables to pick up the ${TUXDIR}/udataobj/dmadmin field table. Hence, the TUXDIR environment variable should be set correctly.

If the application requires security and the standard input to dmadmin is not from a terminal, then the APP_PW environment variable must be set to the corresponding application password.

The TUXCONFIG environment variable should be set to the pathname of the TUXEDO System/T configuration file.

GENERAL DIAGNOSTICS

If the dmadmin command is entered before the system has been booted, the following message is displayed: No bulletin board exists. Only logging commands are available.

dmadmin then prompts for the corresponding commands.

If an incorrect application password is entered or is not available to a shell script through the environment, then a log message is generated, the following message is displayed, and the command terminates: Invalid password entered.

INTEROPERABILITY

dmadmin must be installed on TUXEDO System/T R4.2.2 or later. Other nodes in the same domain with an R4.2.2 gateway may be TUXEDO System/T R4.1 or later.

PORTABILITY

dmadmin is supported as a TUXEDO System/T-supplied administrative tool on UNIX operating systems only.

SEE ALSO

dmloadcf(1),
BEA TUXEDO /Domain Guide