![]() |
![]() |
e-docs > Tuxedo > Command Reference > Section 1 - Commands |
Command Reference
|
Name
dmadmin—BEA Tuxedo Domains 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 BEA Tuxedo application involved in a Domains configuration. This page describes the use of dmadmin for TDomain gateways, TOP END domain gateways (TEDG), SNA Gateways (SNAX), and OSI TP gateways of the BEA Tuxedo Domains component. For a description of the BEA Tuxedo Domains component, see Using the BEA Tuxedo Domains Component
.dmadmin can operate in two modes: administration mode and configuration mode.
dmadmin enters administration mode when called with no parameters. Administration mode is the default mode. 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 Domains transaction log for a particular local domain access point. In this case, the domain gateway group associated with that local domain access point 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 Domains configuration file (BDMCONFIG).
dmadmin requires the use of the Domains administrative server (DMADM) for the administration of the BDMCONFIG file, and the gateway administrative server (GWADM) for the reconfiguration of active domain gateway groups. There is one DMADM process running for each BEA Tuxedo application involved in a Domains configuration, and there is one GWADM process running for each domain 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 defaults 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 has not been set, an error message is returned.
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 an * (asterisk) 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 in the discussion that follows).
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_access_point_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:
[-R remote_domain_access_point_name]
[-R remote_domain_access_point_name]
remote_domain_access_point_name
service}]
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 of the BDMCONFIG file is as follows:
Section:
1) RESOURCES 2) LOCAL_DOMAINS
3) REMOTE_DOMAINS 4) LOCAL_SERVICES
5) REMOTE_SERVICES 6) ROUTING
7) ACCESS_CONTROL 8) PASSWORDS
9) TDOMAINS 10) OSITPS
11) SNADOMS 12) LOCAL_REMOTE_USER
13) REMOTE_USERS 14) SNACRMS
15) SNASTACKS 16) SNALINKS
18) TOPEND 19) OSITPX
q) 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:
For configuration operations, the effective user identifier must match the BEA Tuxedo administrator user identifier (UID) for the machine on which this program is executed. When a record is updated or added, all defaults and validations used by dmloadcf(1) are enforced.
dmadmin then prompts you to indicate whether you want to edit the input buffer:
Enter editor to add/modify fields [n]?
Entering a value of y puts the input buffer into a temporary file and executes the text editor. The environment variable EDITOR is used to determine which editor is to be used; the default is ed, a UNIX text editor. The input format is a set of field name/field value pairs and is described in the Configuration Input Format. The field names associated with each DMCONFIG section are listed in tables in the subsections that follow. The semantics of the fields and associated ranges, defaults, restrictions, and so on are described in DMCONFIG(5)
, DMCONFIG for GWTOPEND(5), and DM_MIB(5). In many 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 is included for a particular field name, the first line is used and other lines are ignored. If any errors occur, a syntax error is printed and dmadmin prompts you to indicate whether you want to edit the file to correct the problem:Enter editor to correct?
If the problem is not corrected (response n), the input buffer will contain no fields. Otherwise, the editor is executed again.
Finally, dmadmin asks whether the operation should be executed:
Perform operation [y]?
When the operation completes, dmadmin prints the return value as in Return value TAOK followed 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 text version of the configuration file:
Unload BDMCONFIG file into ASCII backup [y]?
If a backup is selected, dmadmin prompts for a filename:
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 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 Domains reconfiguration capability:
Domains Terminology Improvements
For BEA Tuxedo release 7.1 or later, the Domains MIB uses improved class and attribute terminology to describe the interaction between local and remote domains. The improved terminology has been applied to the DM_MIB reference page, classes, and error messages, and to the DMCONFIG reference page, section names, parameter names, and error messages. Although the improved terminology has not been applied to the dmadmin user interface, dmadmin understands both the previous and the improved DMCONFIG terminology.
For backwards compatibility, aliases are provided between the DMCONFIG terminology used prior to BEA Tuxedo 7.1 and the improved Domains MIB terminology. In BEA Tuxedo release 7.1 or later, dmadmin accepts both versions of the DMCONFIG terminology. For details, see Domains Terminology Improvements
in the DM_MIB(5) reference page.Restrictions for Configuration Field Identifiers/
Updates
The following sections describe, for each DMCONFIG section, the field identifiers associated with each DMCONFIG field, the field type of each identifier, and when each 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)
, DMCONFIG for GWTOPEND(5), and DM_MIB(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:Configuring the DM_LOCAL Section
The following table lists the fields in the DM_LOCAL section (also known as the DM_LOCAL_DOMAINS section). At the dmadmin operation prompt, enter 2 (LOCAL_DOMAINS) to access this section.
Configuring the DM_REMOTE Section The following table lists the fields in the DM_REMOTE section (also known as the DM_REMOTE_DOMAINS section). At the dmadmin operation prompt, enter 3 (REMOTE_DOMAINS) to access this section.
Configuring the DM_TDOMAIN Section The DM_TDOMAIN section contains the network addressing parameters required by TDOMAIN type domains. The following table lists the fields in this section.
For a local domain access point identifier (TA_LDOM), the TA_NWADDR and TA_NWDEVICE fields can be updated if the gateway group associated with that local domain access point is not running. Configuring the DM_TOPEND Section The DM_TOPEND section contains the network addressing parameters required by TOPEND type domains. The following table lists the fields in this section.
If
then the TA_NWADDR, TA_NWDEVICE, TA_TP_SYSTEM, and TA_TE_PWD fields can be updated. If the domain identifier is a remote domain access point (TA_RDOM), then the TA_NWADDR, TA_NWDEVICE, and TA_TP_SYSTEM fields cannot be updated while any gateway group is running (No). Note that TE_TE_PWD applies only to local domain access points (TA_LDOM).
Configuring the DM_OSITP Section
The DM_OSITP section contains the network addressing parameters for OSI TP 1.3 required by OSITP type domains. The following table lists the fields in this section.
For a local domain access point identifier (TA_LDOM), the other fields in this table can be updated if the gateway group associated with that local domain access point is not running. Configuring the DM_OSITPX Section The DM_OSITPX section contains the network addressing parameters for OSI TP 4.0 or later required by OSITPX type domains. The following table lists the fields in this section. Note: You must be running BEA Tuxedo release 8.0 or later to be able to use the DM_OSITPX section.
For a local domain access point identifier (TA_LDOM), the other fields in this table can be updated if the gateway group associated with that local domain access point is not running. Configuring the DM_EXPORT Section The following table lists the fields in the DM_EXPORT section (also known as the DM_LOCAL_SERVICES section). At the dmadmin operation prompt, enter 4 (LOCAL_SERVICES) to access this section.
Configuring the DM_IMPORT Section The following table lists the fields in the DM_IMPORT section (also known as the DM_REMOTE_SERVICES section). At the dmadmin operation prompt, enter 5 (REMOTE_SERVICES) to access this section.
Configuring the DM_ROUTING Section The following table lists the fields in the DM_ROUTING section.
Configuring the DM_ACCESS_ The following table lists the fields in the DM_ACCESS_CONTROL section.
CONTROL Section
Configuring the DM_ The following table lists the fields in the DM_PASSWORDS section. This section only applies to TDomain gateways.
PASSWORDS Section
The TA_LPWD and TA_RPWD show the existence of a defined password for the local and/or the remote domain access point. 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 BEA Tuxedo communications error. They indicate that the operation did not complete successfully.
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).
The following return values indicate that the operation was successful.
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 access point. For illustration purposes, ed(1) is used for the editor.
$ EDITOR=ed dmadmin
> config
Sections:
1) RESOURCES 2) LOCAL_DOMAINS
3) REMOTE_DOMAINS 4) LOCAL_SERVICES
5) REMOTE_SERVICES 6) ROUTING
7) ACCESS_CONTROL 8) PASSWORDS
9) TDOMAINS 10) OSITPS
11) SNADOMS 12) LOCAL_REMOTE_USER
13) REMOTE_USERS 14) SNACRMS
15) SNASTACKS 16) SNALINKS
18) TOPEND 19) OSITPX
q) QUIT
Enter Section [1]:
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
Section:
1) RESOURCES 2) LOCAL_DOMAINS
3) REMOTE_DOMAINS 4) LOCAL_SERVICES
5) REMOTE_SERVICES 6) ROUTING
7) ACCESS_CONTROL 8) PASSWORDS
9) TDOMAINS 10) OSITPS
11) SNADOMS 12) LOCAL_REMOTE_USER
13) REMOTE_USERS 14) SNACRMS
15) SNASTACKS 16) SNALINKS
18) TOPEND 19) OSITPX
q) QUIT
Enter Section [1]: 9
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 using the UID of the application administrator, it is assumed that the user is a trusted user and security is bypassed. If dmadmin is run with another user ID, and the security option is enabled in the TUXCONFIG file, the corresponding application password is required to start the dmadmin program. If standard input is a terminal, 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, 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, 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 BEA Tuxedo 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, a log message is generated, the following message is displayed, and the command terminates: Invalid password entered.
Interoperability
dmadmin must be installed on BEA Tuxedo release 5.0 or later. Other nodes in the same domain with a release 5.0 gateway may be BEA Tuxedo release 4.1 or later.
Portability
The dmadmin administrative tool is supported on any platform on which the BEA Tuxedo server environment is supported.
See Also
dmloadcf(1), tmadmin(1), topendpasswd(1), DMADM(5)
, DMCONFIG(5), DMCONFIG for GWTOPEND(5)Using the BEA Tuxedo Domains Component
Using the BEA Tuxedo TOP END Domain Gateway with ATMI Applications
![]() |
![]() |
![]() |
![]() |
||
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |