|
|
|
|
|
|
Utilities Reference
This section covers the following utilities that are commonly used for eLink OSI TP:
DMADM
/Domain administrative server.
SYNOPSIS
DMADM SRVGRP = "identifier"
SRVID = "number"
REPLYQ = "N"
DESCRIPTION
The /DOMAIN administrative server DMADM is a Tuxedo-supplied server that provides run-time access to the BDMCONFIG file. When DMADM is booted, the BDMCONFIG environment variable should be set to the pathname of the file containing the binary version of the DMCONFIG file.
DMADM is described in the *SERVERS section of the UBBCONFIG file as a server running within a group, e.g., DMADMGRP. There should be only one instance of the DMADM running in this group and it must not have a reply queue (REPLYQ must be set to "N").
The following server parameters can also be specified for the DMADM server in the *SERVERS section: SEQUENCE, ENVFILE, MAXGEN, GRACE, RESTART, RQPERM and SYSTEM_ACCESS.
PORTABILITY
DMADM is supported as a Tuxedo-supplied server on non-/WS System operating systems.
INTEROPERABILITY
The initial release of eLink OSI TP can only be installed on a node running Tuxedo Release 6.5 or Release 7.1.
EXAMPLES
The following example illustrates the definition of the administrative server and a gateway group in the UBBCONFIG file.
#
*GROUPS
DMADMGRP LMID=mach1 GRPNO=1
gwgrp LMID=mach1 GRPNO=2
#
*SERVERS
DMADM SRVGRP="DMADMGRP" SRVID=1001 REPLYQ=N RESTART=Y GRACE=0
GWADM SRVGRP="gwgrp" SRVID=1002 REPLYQ=N RESTART=Y GRACE=0
GWOSITP SRVGRP="gwgrp" SRVID=1003 RQADDR="gwgrp"
RESTART=Y MIN=1 MAX=1
SEE ALSO
Tuxedo /Domain Guide, Tuxedo Administrator's Guide
dmadmin
OSITP 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 OSITP 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.
Note: dmadmin is one of the three methods you can use to modify your configuration. Refer to Methods for Modifying Configurations for more information.
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 no value is set, 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 definition for the paginate subcommand).
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
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) 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 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 udmloadcf 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 that follows. 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, default values, restrictions, etc., are described in dmconfig. In most cases, the field name is the same as the KEYWORD in the DMCONFIG file, prefixed with "TA_DM". 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 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 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. 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:
RESTRICTIONS FOR CONFIGURATION FIELD IDENTIFIERS/
UPDATES
The following sections describe, for each DMCONFIG section, what the field identifiers are for 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. The following fields indicated 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_
DOMAINS SECTION
The following table lists the fields in the DM_LOCAL_DOMAINS section.
Refer to the DM_LOCAL_DOMAINS Section in Understanding the DMCONFIG File for information about some of these fields information.
CONFIGURING THE DM_REMOTE_
DOMAINS SECTION
The following table lists the fields in the DM_REMOTE_DOMAINS section.
|
Field Identifier |
Field Type |
Update |
Notes |
|---|---|---|---|
|
TA_DOMAINID |
string |
No |
|
|
TA_RDOM |
string |
No |
key |
|
TA_TYPE |
string |
No |
format: {TDOMAIN | OSITP | OSITPX | SNA} |
Refer to the DM_REMOTE_DOMAINS Section in Understanding the DMCONFIG File for related information about some of these fields.
CONFIGURING THE DM_OSITPX SECTION
The DM_OSITPX 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.
Refer to the DM_OSITPX Section in Understanding the DMCONFIG File for related information about some of these fields.
CONFIGURING THE DM_LOCAL_
SERVICES SECTION
The following table lists the fields in the DM_LOCAL_SERVICES section.
Refer to the DM_LOCAL_SERVICES Section in Understanding the DMCONFIG File for related information about some of these fields.
CONFIGURING THE DM_REMOTE_
SERVICES SECTION
The following table lists the fields in the DM_REMOTE_SERVICES section.
Refer to the DM_REMOTE_SERVICES Section in Understanding the DMCONFIG File for related information about some of these fields.
CONFIGURING THE DM_ROUTING SECTION
The following table lists the fields in the DM_ROUTING section.
|
Field Identifier |
Field Type |
Update |
Notes |
|---|---|---|---|
|
TA_ROUTINGNAME |
string |
No |
key |
|
TA_FIELD |
string |
Yes |
|
|
TA_RANGE |
string |
Yes |
|
|
TA_BUFTYPE |
string |
Yes |
|
Refer to the DM_ROUTING Section in Understanding the DMCONFIG File for related information.
CONFIGURING THE DM_ACCESS_
CONTROL SECTION
The following table lists the fields in the DM_ACCESS_CONTROL section.
|
Field Identifier |
Field Type |
Update |
Notes |
|---|---|---|---|
|
TA_ACLNAME |
string |
No |
key |
|
TA_RDOM |
string |
Yes |
|
Refer to the DM_ACCESS_CONTROL Section in Understanding the DMCONFIG File for related information.
CONFIGURING THE DM_PASSWORDS SECTION
The following table lists the fields in the DM_PASSWORDS section.
|
Field Identifier |
Field Type |
Update |
Notes |
|---|---|---|---|
|
TA_LDOM |
string |
No |
key |
|
TA_RDOM |
string |
No |
key |
|
TA_LPWD |
string |
Yes |
format: { Y | N | U } |
|
TA_RPWD |
string |
Yes |
format: { Y | N | U } |
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 an OSITP 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. For illustration purposes, ed is used for the editor.
$EDITOR=vi dmadmin -c
dmadmin - Copyright (c) 1996-1999 BEA Systems, Inc.
Portions * Copyright 1986-1997 RSA Data Security, Inc.
All Rights Reserved.
Distributed under license by BEA Systems, Inc.
Tuxedo is a registered trademark.
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]:3
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
In VI...
a
TA_RDOM B05
TA_DOMAINID BA.BANK05
TA_TYPE OSITPX
wq!
Perform operation [y]?
Return value TAUPDATED
Buffer contents:
TA_OPERATION 4
TA_CLASS 3
TA_OCCURS 1
TA_DMINPRIORITY 0
TA_STATUS CMDGW_CAT:1761: INFO: Update completed successfully
TA_TYPE OSITPX
TA_DOMAINID BA.BANK05
TA_RDOM B05
TA_CODEPAGE
TA_DMACLPOLICY LOCAL
TA_DMCONNPRINCIPALNAME
TA_DMLOCALPRINCIPALNAME
TA_DMPRIORITY_TYPE LOCAL_RELATIVE
TA_DMCREDENTIALPOLICY LOCAL
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 [3]:
Operations:
1) FIRST 2) NEXT
3) RETRIEVE 4) ADD
5) UPDATE 6) DELETE
7) NEW_SECTION 8) QUIT
Enter Operation [4]:7
Buffer cleared
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 [3]:19
Operations:
1) FIRST 2) NEXT
3) RETRIEVE 4) ADD
5) UPDATE 6) DELETE
7) NEW_SECTION 8) QUIT
Enter Operation [7]:4
Enter editor to add/modify fields [n]? y
From VI editor...
a
TA_OSITPX B05
TA_NWADDR 206.189.43.44
TA_AET {1.3.9999.1},{1}
wq!
Perform operation [y]?
Return value TAUPDATED
Buffer contents:
TA_OPERATION 4
TA_CLASS 19
TA_OCCURS 1
TA_MULTIPLEXING 0
TA_MINENCRYPTBITS 0
TA_MAXENCRYPTBITS 0
TA_STATUS CMDGW_CAT:1761: INFO: Update completed successfully
TA_NWADDR 206.189.43.44
TA_AET {1.3.9999.1},{1}
TA_OSITPX B05
TA_TSEL
TA_TAILORPATH
TA_PSEL
TA_SSEL
TA_EXTENSIONS
TA_DNSRESOLUTION STARTUP
TA_OPTIONS
TA_XATMIENCODING PRELIMINARY
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 [19]:q
Unload BDMCONFIG file into ASCII backup [y]? y
Backup filename [DMCONFIG]?
Configuration backed up in DMCONFIG
q
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 OSITP 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.
SEE ALSO
Tuxedo /Domain Guide
GWADM
/Domain gateway administrative server.
SYNOPSIS
GWADM SRVGRP = "identifier" SRVID = "number" REPLYQ = "N"
CLOPT = "-A -- [-a {on | off}] [-s services]
[-t {on | off}]"
DESCRIPTION
The gateway administrative server GWADM is a Tuxedo-supplied server that provides administrative functions for a /Domain gateway group.
GWADM should be defined in the *SERVERS section of the UBBCONFIG file as a server running within a particular gateway group, that is, SRVGRP must be set to the corresponding GRPNAME tag specified in the *GROUPS section. The SVRID parameter is also required and its value must consider the maximum number of gateways allowed within the gateway group.
There should be only one instance of a GWADM per /Domain gateway group, and it should NOT be part of the MSSQ defined for the gateways associated with the group. Also, GWADM should have the REPLYQ attribute set to N.
The CLOPT option is a string of command line options that is passed to the GWADM when it is booted. This string has the following format:
CLOPT="-A -- <gateway group runtime parameters>"
The following runtime parameters are recognized for a gateway group
The GWADM server must be booted before the corresponding gateways.
PORTABILITY
GWADM is supported on Tuxedo-supplied servers, using non-/WS operating systems.
INTEROPERABILITY
The initial release of eLink OSI TP can only be installed on a node running Tuxedo Release 6.5 or Release 7.1.
EXAMPLES
The following example illustrates the definition of the administrative server in the UBBCONFIG file.
#
*GROUPS
DMADMGRP GRPNO=1
gwgrp GRPNO=2
#
*SERVERS
DMADM SRVGRP="DMADMGRP" SRVID=1001 RESTART=Y GRACE=0
GWADM SRVGRP="gwgrp" SRVID=1002 RESTART=Y GRACE=0
CLOPT="-A -- -a on -t on"
GWTDOMAIN SRVGRP="gwgrp" SRVID=1003
RESTART=Y MIN=1 MAX=1
SEE ALSO
dmadmin, tmboot
dmconfig, DMADM, servopts, ubbconfig
Tuxedo /Domain Guide
Tuxedo Administrator's Guide
|
|
|
|
|
|
Copyright © 2002 BEA Systems, Inc. All rights reserved.
|