5 TXST Command and Variable Reference

This chapter contains the following sections:

• TXST Command Categories Overview
  
• Browse Commands
  
• Control Commands
  
• Editing Commands
  
• Information Commands
  
• Life Cycle Commands
  
• TXST Variable Reference
  
• Jython Class for Tuxedo Mbeans
  

5.1 TXST Command Categories Overview

TXST commands are divided into the following categories.

Command Category	Description
Browse Commands	Navigate the hierarchy of configuration or runtime beans and control the prompt display.
Control Commands	Connect to or disconnect from JMX agent or Tuxedo Domain. Exit TXST.
Editing Commands	Create or delete Mbean. Get or set parameters of Mbean.
Information Commands	Interrogate Mbeans and configuration of TXST.
Life Cycle Commands	Start, stop, suspend, resume, and migrate specified Mbean.

5.2 Browse Commands

This section contains the following commands:

• cd
  
• prompt
  
• pwd
  

5.2.1 cd

Use with TXST: online(connected to domain)

• Description
  
• Syntax
  
• Examples
  

5.2.1.1 Description

Navigates the hierarchy of beans. This command uses a model that is similar to navigating a file system in a Windows or UNIX command shell. For example, to navigate back to a bean, enter cd('..'). The character string ‘. .’(dot-dot), refers to the directory immediately above the current directory. To get back to the root bean after navigating to a bean that is deep in the hierarchy, enter cd(‘/’).

You can navigate to beans in the current hierarchy and to any child or instance.

The cd command returns a stub of the bean instance, if one exists. In the event of an error, the command returns a TXSTException.

5.2.1.2 Syntax

cd(mbeanName)

Argument	Definition
mbeanName	Path to the bean in the namespace.

5.2.1.3 Examples

The following example navigates the hierarchy of beans. The first command navigates to the simple bean instance, the second, to the GROUP1 bean instance, and the last back up two levels to the original directory location.

txst:simpapp_38075:/> cd(‘lmid1’)
txst:simpapp_38075:/lmid1> cd('lmid1')
txst:simpapp_38075:/lmid1> cd('GROUP1')
txst:simpapp_38075:/lmid1/GROUP1> cd('../..')
txst:simpapp_38075:/>

5.2.2 prompt

Use with TXST: online(connected to domain)

• Description
  
• Syntax
  
• Examples
  

5.2.2.1 Description

Toggles the display of path information at the prompt, when entered without an argument. This command is useful when the prompt becomes too long due to the length of the path.

You can also explicitly specify on or off as an argument to the command. When you specify off, TXST hides the TXST prompt and defaults to the Jython prompt. By default, the TXST prompt displays the navigation path information.

When you disable the prompt details, to determine your current location in the hierarchy, you can use the pwd command, as described in pwd.

5.2.2.2 Syntax

prompt(onoff = None)

Argument

Definition

onoff

Optional. Hides or displays TXST prompt. Valid values include off or on. The off argument hides the TXST prompt. If you run prompt('off'), when using TXST online, the prompt defaults to the Jython prompt. You can create a new prompt using Jython syntax. For more information about programming using Jython, seehttp://www.jython.org. In this case, if you subsequently enter the prompt command without arguments, TXST displays the TXST command prompt with the path information. To disable the path information, enter prompt() again, or enter prompt('off'). The on argument displays the default TXST prompt, including the path information. In this case, if you subsequently enter the prompt command without arguments, TXST displays the TXST command prompt without the path information. To display the path information, enter prompt() again or enter prompt('on').

5.2.2.3 Examples

The following example hides and then redisplays the path information at the prompt:

txst:simpapp_38075> cd('simple')
  txst: simpapp_38075/simple> cd('GROUP1')
  txst: simpapp_38075/simple/GROUP1> prompt('off')
  >>>prompt()
  txst: simpapp_38075/simple/GROUP1>

5.2.3 pwd

Use with TXST: offline or online

Description

Displays the current location in the bean hierarchy. This command is useful when you have turned off the prompt display of the path information using the prompt command, as described in prompt.

Syntax

pwd()

Examples

The following example displays the current location in the bean hierarchy.

txst:simpapp_38075/simple/GROUP1> pwd()
' /simple/GROUP1’

• Description
  

5.2.3.1 Description

Description

Displays the current location in the bean hierarchy. This command is useful when you have turned off the prompt display of the path information using the prompt command, as described in prompt.

Syntax

pwd()

Examples

The following example displays the current location in the bean hierarchy.

txst:simpapp_38075/simple/GROUP1> pwd()
' /simple/GROUP1’

5.3 Control Commands

• connect
  
• connectDomain
  
• disconnectDomain
  
• disconnect
  
• exit
  

5.3.1 connect

Use with TXST: offline

• Description
  
• Syntax
  
• SECURITY
  

5.3.1.1 Description

Connects TXST to a Tuxedo Domain or JMX agent.

If the monitored Tuxedo domain enables authentication and Authorization, TXST must provide credentials when it attaches a Tuxedo domain. If authentication passed, the following tasks are executed afterwards. If authentication failed, the connection is rejected. For now, we only support plaintext password.

5.3.1.2 Syntax

connect(url, domainId, ipckey, appPassword, userName, password)

Argument	Definition
url	Listen address and listen port of the server instance, specified using the following format: [protocol://]listen-address:listen-port. If you only supply the argument url, it will connect to jmx instead of domain.
domainId	[optional]The domain's id defined in UBB.
ipckey	[optional]The ipckey defined in UBB. Value is string.
userName	[optional]Name representing the client.
password	[optional]Used for user authentication.
appPasswd	[optional]Application password.

Examples

txst: /offline> connect('//slce04cn03.us.oracle.com:5037', 'simpapp', ‘38075’)
txst:simpapp_38075:/>

Above example shows how to connect to domain.

Or

txst: /offline> connect('//slce04cn03.us.oracle.com:5037')
txst: slce04cn03.us.oracle.com_5037:/>

This is an instance of connecting to jmx.

5.3.1.3 SECURITY

• APP_PW

  Provide tuxedo application password for authentication.

• USR_AUTH,ACL,MANDATORY_ACL

  Provide application password, user name and user password for authentication

  The client name of Tuxedo users used by TXST must be ‘tpsysadm’, otherwise connect will fail with authentication.

  In the event of an error, the command returns a TXSTException.

  The client must connect master machine, otherwise it might have no right to execute ‘start’ command.

• In the event of an error, the command returns a TXSTException.

5.3.2 connectDomain

Use with TXST: online(connected to JMX agent)

Description

Connects TXST to a Tuxedo Domain from JMX agent. You must connect to jmx before invoking this command. Except without argument url, for the other information, please refer connect.

Syntax

connectDomain(domainId, ipckey, appPassword, userName, password)

Argument	Definition
domainId	The domain's id defined in UBB.
ipckey	The ipckey defined in UBB.
userName	[optional]Name representing the client.
password	[optional]Used for user authentication.
appPasswd	[optional]Application password.

• Examples
  

5.3.2.1 Examples

txst:bjlinux16.cn.oracle.com_5037>connectDomain('simpapp', '58103') txst:simpapp_58103:/>

5.3.3 disconnectDomain

Use with TXST: online(connected to domain)

• Description
  
• Syntax
  
• Examples
  

5.3.3.1 Description

Disconnect TXST from a Tuxedo domain instance and go back to jmx agent connection.

In the event of an error, the command returns a TXSTException.

5.3.3.2 Syntax

disconnectDomain()

5.3.3.3 Examples

txst:simpapp_38075:/simple/GROUP1>disconnectDomain()

txst:bjlinux16.cn.oracle.com_5037>

5.3.4 disconnect

Use with TXST: online

• Description
  
• Examples
  

5.3.4.1 Description

Disconnects TXST from a Tuxedo instance. The disconnect command does not cause TXST to exit the interactive scripting shell; it closes the current Tuxedo instance connection and resets all the variables while keeping the interactive shell alive.

In the event of an error, the command returns a TXSTException.

Syntax

disconnect()

5.3.4.2 Examples

txst:simpapp_38075:/simple/GROUP1>disconnect()

txst: /offline>

5.3.5 exit

Use with TXST: online or offline

• Description
  
• Syntax
  

5.3.5.1 Description

Exits TXST from the user session and closes the scripting shell. By default, TXST calls system.exit(0). If you would like to exit with a different exit code, you can specify a value using the exitcode argument.

5.3.5.2 Syntax

exit( [exitcode])

Argument	Definition
exitcode	Optional. Exit code to set when exiting TXST.

Examples

txst:simpapp_38075:/>exit(1);

c:\jython\bin>

5.4 Editing Commands

This section contains the following commands:

• create
  
• delete
  
• get
  
• set
  

5.4.1 create

Use with TXST: online(connected to domain)

• Description
  
• Syntax
  
• Examples
  

5.4.1.1 Description

Creates a bean of the specified type for the current bean.

The create command returns a stub for the newly created bean except for queue.

In the event of an error, the command returns a TXSTException.

5.4.1.2 Syntax

create(name, childtype,**argv)

Argument	Definition
name	Name of the bean that you are creating. You can specify the full pathname of bean. Meaning of name is different from childtype:Machine->pmid. Group->groupName. Bridge->lmid. Group->groupName. Server->aout. TMS->tmsName. Queue->qname.
childtype	Type of bean that you are creating. The valid value should be MACHINE, GROUP, BRIDGE, SERVER, TMS or QUEUE.
argv	The other additional parameters for this bean.

Note:

argv, the additional parameters depend on the childMBeanType.

Except creating queue, the return value will be the instance of Mbean which you create. For queue, the return value will be None.

• Machine
  • lmid
  • tuxconfig
  • tuxdir
  • appdir
• Group
  • groupNo
• Bridge
  • naddr
  • nlsaddr
• Server
  • srvID
• TMS
  • rmsName
  • rmid
• Queue
  • qorder
  • outoforder
  • maxRetries
  • retryDelay
  • defaultDeliveryPolicy
  • cmd
  • defaultExpirationTime
  • qType
  • primaryQueue
  • isPermanentActive
  • comfirmStyle

5.4.1.3 Examples

The following example creates a bean of type server named simpserv for the current bean, storing the stub as server1:

txst:simpapp_38075:/simple/GROUP1> srv1 = create(“simpserv”, "SERVER", srvID =40)
txst:simpapp_38075:/simple/GROUP1> ls(‘c’)
childBean:
server simpserv_1
server simpserv_2
server simpserv_40

5.4.2 delete

Use with TXST: online(connected to domain)

• Description
  
• Syntax
  
• Examples
  

5.4.2.1 Description

Deletes an instance of a bean of the specified type for the current bean.

In the event of an error, the command returns a TXSTException.

Note:

All targets which belong to this bean must be deleted first.

5.4.2.2 Syntax

delete(name, force)

Argument	Definition
name	Name of the bean to delete.
force	[Optional] If force is True, it will delete the specified bean and all the targets belong to it. Otherwise, it will fail if there are targets belong to this bean. The default value for this argument is False.

5.4.2.3 Examples

The following example deletes the bean of type server named simpserv_1:

txst:simpapp_38075:/simple/GROUP1>delete(“simpserv_40”) txst:simpapp_38075:/simple/GROUP1>ls(‘c’)

childBean:

server simpserv_1

server simpserv_2

5.4.3 get

Use with TXST: online(connected to domain)

• Description
  
• Syntax
  
• Examples
  

5.4.3.1 Description

Returns the value of the specified attribute, or the dictionary of the specified attributes

In the event of an error, the command returns a TXSTException.

Note: You can list all attributes and their current values by entering ls(‘b’).

5.4.3.2 Syntax

get(attrs=None, path=None)

Argument	Definition
attrs	Name of the attribute to be displayed. You can specify the full pathname of the attribute. If no pathname is specified, the attribute is displayed for the current object. If fullpath is set, attrs must not include pathname. You can specify a set of attribute's name, if so, the attribute's name must not include pathname. You also needn't specify the attributes, if so, get() will return all the attributes' value.
path	Optional. You can specify the object's pathname. The object can be others rather than current object. If not setting pathname, the attribute is displayed for the current object.

5.4.3.3 Examples

txst:simpapp_38075:/simple/GROUP1>delete(“simpserv_40”)
txst:simpapp_38075:/simple/GROUP1>ls(‘c’)
childBean:
server simpserv_1
server simpserv_2

5.4.4 set

Use with TXST: online(connected to domain)

• Description
  
• Syntax
  
• Attributes
  
• Examples
  

5.4.4.1 Description

Sets the specified attribute value for the specified bean

You can list all attributes and their current values by entering ls(‘b’)

In the event of an error, the command returns a TXSTException.

5.4.4.2 Syntax

set(attrs,[path])

Argument	Definition
attrs	The dictionary which stores the attributes and their values.
path	Optional. You can specify the object's pathname. The object can be others rather than current object. If not setting pathname, the attribute is set for the current object.

5.4.4.3 Attributes

attrName	Name of the attribute to be set. It is the key in dictionary
value	Value of the attribute to be set. It is the value in dictionary

5.4.4.4 Examples

txst:simpapp_38075:/simple/>a = {"TA_SEC_PRINCIPAL_NAME":"SEC"}
txst:simpapp_38075:/simple/>set (a)
or
txst:simpapp_38075:/>a = {"TA_SEC_PRINCIPAL_NAME":"SEC"}
txst:simpapp_38075:/>set (a, “/simple”)

5.5 Information Commands

• find
  
• getMBean
  
• getPath
  
• getPath(bean)
  
• lookup
  
• redirect
  
• ls
  
• startRecording
  
• stopRecording
  
• easeSyntax
  

5.5.1 find

Use with TXST: online(connected to domain)

• Description
  
• Syntax
  
• Examples
  

5.5.1.1 Description

Finds MBeans in the hierarchy.

TXST returns the pathname to the MBean that is specified by name.

In the event of an error, the command returns a TXSTException.

5.5.1.2 Syntax

find([name], [beanType], [path])

Argument	Definition
name	Name of the MBean that you want to find. It is a Jython regular expression. If you want to match the name entirely, please add "^" at the beginning and add "$" at the end. For example. "^simpserv_1$'
beanType	Optional. Type of the MBean to find. If type is not set, it will search for all Mbeans which is specified by name. 'machine', 'group' or 'server' is valid.
path	Optional. You can specify the object's pathname. The object can be others rather than current object. If not setting pathname, the attribute is set for the current object.

5.5.1.3 Examples

txst:simpapp_38075:/simple/GROUP1>find(name=’simpserv’,type=’server’)

/simple/GROUP1/simpserv_1

/simple/GROUP1/simpserv_2

5.5.2 getMBean

Use with TXST: online(connected to domain)

• Description
  
• Syntax
  
• Examples
  

5.5.2.1 Description

Returns the MBean by browsing to the specified path.

In the event of an error, the command returns a TXSTException.

5.5.2.2 Syntax

getMBean(path)

Argument	Definition
path	Path name to the MBean in the current hierarchy.

5.5.2.3 Examples

The following example returns the MBean specified by the path.

txst:simpapp_38075:/simple/GROUP1>com=getMBean(“/simple/GROUP1/simpserv_1”)
txst:simpapp_38075:/simple/GROUP1>com.getType()
‘server’

5.5.3 getPath

This section contains the following topics:

• Description
  
• Syntax
  
• Examples
  

5.5.3.1 Description

Returns the MBean’s path for the specified MBean instance

In the event of an error, the command returns a TXSTException.

5.5.3.2 Syntax

getPath(bean)

Table 5-1 getPath Argument Definition

Argument	Definition
bean	MBean instance for which you want to return the MBean path.

5.5.3.3 Examples

The following example returns the MBean specified by the path.

txst:simpapp_38075:/simple/GROUP1>com=getMBean(“/simple/GROUP1/simpserv_1”)
txst:simpapp_38075:/simple/GROUP1>cd(‘..’)
txst:simpapp_38075:/simple>path=getPath(com)
txst:simpapp_38075:/simple>print path
GROUP1/simpserv_1

5.5.4 getPath(bean)

• Description
  
• Syntax
  
• Examples
  

5.5.4.1 Description

Returns the MBean’s path for the specified MBean instance

In the event of an error, the command returns a TXSTException

5.5.4.2 Syntax

getPath(bean)

Argument	Definition
bean	MBean instance for which you want to return the MBean path.

5.5.4.3 Examples

The following example returns the MBean specified by the path.

txst:simpapp_38075:/simple/GROUP1>com=getMBean(“/simple/GROUP1/simpserv_1”
)
txst:simpapp_38075:/simple/GROUP1>cd(‘..’)
txst:simpapp_38075:/simple>path=getPath(com)
txst:simpapp_38075:/simple>print path
GROUP1/simpserv_1

5.5.5 lookup

Use with TXST: online(connected to domain)

• Description
  
• Syntax
  
• Examples
  

5.5.5.1 Description

Looks up the specified MBean. The MBean must be a child of the current MBean

In the event of an error, the command returns a TXSTException.

5.5.5.2 Syntax

lookup(name, [childtype])

Argument	Definition
name	Name of the MBean that you want to lookup. It is a Jython regular expression. If you want to match the name entirely, please add "^" at the beginning and add "$" at the end. For example. "^simpserv_1$'
childtype	Optional. The type of the MBean that you want to lookup. The type which depends on current MBean should be as below: Domain->'machine' Machine->'bridge', 'group' Group->'server'

5.5.5.3 Examples

The following example looks up the specified server, simpserv_1, and stores the returned stub in the sbean variable.

txst:simpapp_38075:/simple/GROUP1>sbean=lookup(‘^simpserv_1$’,’server’)
txst:simpapp_38075:/simple/GROUP1>sbean[0].getName()
‘simpserv_1’
or
txst:simpapp_38075:/simple/GROUP1>sbean=lookup(”simpserv”,’server’)
txst:simpapp_38075:/simple/GROUP1>sbean[0].getName()
‘simpserv_1’
txst:simpapp_38075:/simple/GROUP1>sbean[1].getName()
‘simpserv_2’

5.5.6 redirect

Use with TXST: online(connected to domain)

• Description
  
• Syntax
  
• Limitation:
  
• Examples
  

5.5.6.1 Description

Redirects TXST output to the specified filename.

In the event of an error, the command returns a TXSTException.

5.5.6.2 Syntax

redirect(outputFile, [toStdOut])

Argument	Definition
outputFile	Name of the file to which you want to record the TXST commands. The filename can be absolute or relative to the directory from which you enter the command.
toStdOut	Optional. Boolean value specifying whether the output should be sent to stdout. This argument defaults to true, indicating that the output will be sent to stdout.

5.5.6.3 Limitation:

After invoking redirect when toStdOut is TRUE, sys.stdout is assigned to TXST’s internal Pyobject which only supports the following functions: write(), writelines(), flush(), close()

After invoking redirect when toStdOut is FALSE, sys.stdout is assigned to FileOutputStream’s object.

5.5.6.4 Examples

The following example begins redirects TXST output to thelogs/txst.log file in the current directory:

txst:simpapp_38075:/ redirect('./logs/txst.log')

5.5.7 ls

Use with TXST: online(connected to domain)

• Description
  
• Examples
  

5.5.7.1 Description

Lists all the child beans and/or attributes for the current bean.

You can optionally control the output by specifying an argument. If no argument is specified, the command lists all child beans and attributes in the domain. The output is returned as a string.

In the event of an error, the command returns a TXSTException.

Syntax

ls( ['a' | 'c' | 'b' ], [path] )

Argument	Definition
a	Optional. Displays all the attribute names and values for the current bean.
c	Optional. Displays all the child beans that are contained in the current bean. This argument is the default.
b	Optional. Displays all parameter names and values for the current bean.
s	Optional. Display additional info for the current Mbean. Each type mbean may have different additional info.
Path	Optional. Path name to the MBean in the current hierarchy for which you want to list all child beans and attributes.

5.5.7.2 Examples

The following example displays all the child beans, and attribute names and values for the MBean GROUP1:

txst:simpapp_38075:/simple/GROUP1>ls()

5.5.8 startRecording

Use with TXST: online(connected to domain)

• Description
  
• Syntax
  
• Limitation
  
• Examples
  

5.5.8.1 Description

Records all user interactions with TXST. This command is useful for capturing commands for replay. In the event of an error, the command returns a TXSTException.

5.5.8.2 Syntax

startRecording(recordFile)

Argument	Definition
recordFile	Name of the file to which you want to record the commands. The filename can be absolute or relative to the directory from which you invoked TXST.

5.5.8.3 Limitation

This command doesn’t take effect when TXST works as a Jython Module, because the interpreter is InteractiveInterpreter but not TXSTInterpreter. This command depends on TXSTInterpreter.

5.5.8.4 Examples

The following example begins recording commands in the record.py file:txst:simpapp_38075:/> startRecording('c:/myScripts/record.py')

5.5.9 stopRecording

Use with TXST: online(connected to domain)

• Description
  
• Syntax
  
• Limitation
  
• Examples
  

5.5.9.1 Description

Stops recording TXST commands. For information about starting a recording

In the event of an error, the command returns a TXSTException.

5.5.9.2 Syntax

stopRecording()

5.5.9.3 Limitation

This command doesn’t take effect when TXST works as a Jython Module, because the interpreter is InteractiveInterpreter but not TXSTInterpreter. This command depends on TXSTInterpreter.

5.5.9.4 Examples

txst:simpapp_38075:/> stopRecording()

5.5.10 easeSyntax

Use with TXST: online or offline

• Description
  
• Syntax
  
• Examples
  

5.5.10.1 Description

This command allow users to invoke some commands without typing the parenthese.

If you want to turn off the easy syntax mode, just simply issue this command again.

The supported commands are as follows:

cd, ls, find,connect,startRecording, migrate, resume, shutdown, start, suspend, prompt, disconnect, pwd, stopRecording, stopRedirect, easeSyntax, exit.

5.5.10.2 Syntax

easeSyntax()

Examples

txst:simpapp_58103:/>easeSyntax()

easeSyntax on now.

txst:simpapp_58103:/>ls c

childBean:

tuxedo_machine L1

5.5.10.3 Examples

txst:simpapp_58103:/>easeSyntax()
easeSyntax on now.
txst:simpapp_58103:/>ls c
childBean:
tuxedo_machine L1

5.6 Life Cycle Commands

This section contains the following commands:

• migrate
  
• resume
  
• shutdownDomain
  
• startDomain
  
• shutdown
  
• start
  
• suspend
  

5.6.1 migrate

Use with TXST: online(connected to domain)

• Description
  
• Syntax
  
• Examples
  

5.6.1.1 Description

Migrates the servers in the specified scope to an alternate location. This command only is supported by Machine MBean and Group’s.

In the event of an error, the command returns a TXSTException.

5.6.1.2 Syntax

migrate( name )

Argument	Definition
name	Optional. Name of the Machine MBean or Group's in which the server should be migrated. If not specified, this argument default is current MBean.

5.6.1.3 Examples

txst:simpapp_38075:/simple/GROUP1> migrate()

or

txst:simpapp_38075:/> migrate(“/simple/GROUP1”)

5.6.2 resume

Use with TXST: online(connected to domain)

• Description
  
• Syntax
  
• Examples
  

5.6.2.1 Description

Resume an object that is suspended.

In the event of an error, the command returns a TXSTException.

5.6.2.2 Syntax

resume( targetName, Mbean )

Argument	Definition
targetName	The Name of object to resume Machine->client Server->service Bridge->remoteLmid WSH->handler JSH->handler
Mbean	Optional. Name of the MBean which object will be suspend. The argument defaults to the current MBean. Support the following MBeans: Machine, Server, Bridge, WSH, JSH

5.6.2.3 Examples

Resume the client named ‘clientID’ which belongs to machine ‘simple’:

txst:simpapp_38075:/simple> resume(“clientID”)
or
txst:simpapp_38075:/> resume(“clientID”, “/simple”)

5.6.3 shutdownDomain

Use with TXST: online(connected to domain)

• Description
  
• Syntax
  
• Examples
  

5.6.3.1 Description

Gracefully shutdown the tuxedo domain. If domain is shutdown successfully, TXST will disconnect from domain and go back to connect jmx.

In the event of an error, the command returns a TXSTException.

Note:

• JMX client must connect to master node, otherwise this command will fail.
• TXST must connect to domain, otherwise this command will fail.

5.6.3.2 Syntax

shutdownDomain()

5.6.3.3 Examples

txst:simpapp_58103:/>shutdownDomain()
Shutting down server processes ...
Server Id = 1 Group Id = GROUP1 Machine = L1: SIGTERM
Shutting down admin processes ...
Server Id = 0 Group Id = L1 Machine = L1: shutdown succeeded
2 processes stopped.
txst:bjlinux16.cn.oracle.com_5037>

5.6.4 startDomain

Use with TXST: online(connected to JMX agent)

• Description
  
• Syntax
  
• Examples
  

5.6.4.1 Description

Start the tuxedo domain. If invoking is success, you can connect to domain.

In the event of an error, the command returns a TXSTException.

Note:

• TXST must connect to JMX agent, otherwise this command will fail.
• This command will fail if TXST is connected to domain.

5.6.4.2 Syntax

startDomain(tuxconfig)

Argument	Definition
tuxconfig	The TUXCONFIG of tuxedo instance.

5.6.4.3 Examples

txst:bjlinux16.cn.oracle.com_5037>startDomain('/nfs/users/bosguo/workspace/txst/simpapp/tuxconfig')
INFO: Oracle Tuxedo, Version 12.1.3.0.0 beta, 64-bit, Patch Level (none)
Booting admin processes ...
exec BBL -A :
process id=1996 ... Started.
Booting server processes ...
exec server -A :
process id=1999 ... Started.
2 processes started.
txst:bjlinux16.cn.oracle.com_5037>

5.6.5 shutdown

Use with TXST: online(connected to domain)

• Description
  
• Syntax
  
• Examples
  

5.6.5.1 Description

Gracefully shuts down the specified object

In the event of an error, the command returns a TXSTException.

Note:

JMX client must connect to master node, otherwise this command will fail.

5.6.5.2 Syntax

shutdown( name )

Argument

Definition

name

Optional. Name of the MBean to shutdown. This argument specifies the MBean with two ways. First, name could be the valid path of the Mbean. For instance, '/SITE1/QUEGRP' is a path of group. If no specified, this argument default is current MBean. TMS is not supported by this method. Second, name could contain the information of 'AOUT' and the location which the related servers are located in. These two parts must be connected by ':'. And this method is only valid for Server. For instance, '/SITE1: simpserv' means the servers which belong to 'SITE1'. Support the following MBeans: Machine, Group, Server

5.6.5.3 Examples

shutdown the server ‘simpserv_01’
txst:simpapp_38075:/simple/GROUP1/simpserv_01> shutdown()
 
#simpserv_01 is shutdown.
or
shutdown the servers which AOUT is ‘simpserv’ in machine simple
txst:simpapp_38075:/simple>shutdown(“/simple:simpserv”)
 
#simpserv_01, simpserv_02 are shutdown.

5.6.6 start

Use with TXST: online(connected to domain)

• Description
  
• Syntax
  
• Examples
  

5.6.6.1 Description

Start the specified object

In the event of an error, the command returns a TXSTException.

Note:

JMX client must connect to master node, otherwise this command will fail.

5.6.6.2 Syntax

start ( name)

Argument

Definition

name

Optional. Name of the MBean to start. This argument specifies the MBean with two ways. First, name could be the valid path of the Mbean. For instance, '/SITE1/QUEGRP' is a path of group. If no specified, this argument default is current MBean. TMS is not supported by this method. Second, name could contain the information of 'AOUT' and the location which the related servers are located in. These two parts must be connected by ':'. This method is only valid for Server . For instance, '/SITE1: simpserv' means the servers which belong to 'SITE1'. Support the following MBeans: Machine, Group, Server

5.6.6.3 Examples

boot the server ‘simpserv_01’
txst:simpapp_38075:/simple/GROUP1/simpserv_01> start()
 
#simpserv_01 is booted.
or
boot the server which AOUT is ‘simpserv’
txst:simpapp_38075:/simple>start(“/simple:simpserv”)
 
#simpserv_01, simpserv_02 are booted.

5.6.7 suspend

Use with TXST: online(connected to domain)

• Description
  
• Syntax
  
• Examples
  

5.6.7.1 Description

Suspends the specified object.

In the event of an error, the command returns a TXSTException.

5.6.7.2 Syntax

suspend(targetName, Mbean)

Argument	Definition
targetName	The Name of object to suspend Machine->client Server->service Bridge->remoteLmid WSH->handler JSH->handler
Mbean	Optional. Name of the MBean which object will be suspend. The argument defaults to the current MBean. Support the following MBeans: Machine, Server, Bridge, WSH, JSH

5.6.7.3 Examples

Suspend the client named ‘clientID’ which belongs to machine ‘simple’
txst:simpapp_38075:/simple> suspend(“clientID”)
or
txst:simpapp_38075:/> suspend(“clientID”, “simple”)

5.7 TXST Variable Reference

Following table describes TXST variables and their common usage.

Variable	Description
cmo	Current Management Object. The cmo variable is set to the bean instance to which you navigate using TXST. You use this variable to perform any create, get, set, or invoke method on the current bean instance. By default, this variable is initialized to the root of all configuration management objects, DomainMBean.
connected	Boolean value specifying whether TXST is connected to a running server. TXST sets this variable to true when connected to a running server; otherwise, TXST sets it to false.
domainMbean	Name of the domain to which TXST is connected.
exitonerror	Boolean value specifying whether TXST terminates script execution when it encounters an exception. This variable defaults to true, indicating that script execution is terminated when TXST encounters an error. This variable is not applicable when running TXST in interactive mode.
mbsc	MBeanServerConnection object that corresponds to the current location in the hierarchy.
recording	Boolean value specifying whether TXST is recording commands. TXST sets this variable to true when the startRecording command is entered; otherwise, TXST sets this variable to false.

5.8 Jython Class for Tuxedo Mbeans

In TXST, all the Tuxedo Mbeans have corresponding Jython class. Jython class has a set of function to implements corresponding Mbean’s operations. This section describes the Jython class in TXST.

• Mbean
  
• DomainMbean
  
• GroupMbean
  
• BridgeMbean
  
• ServerMbean
  
• SystemServerMbean
  
• TDomainGatewayMbean
  
• EventBrokerMbean
  
• QueueServerMbean
  
• WebServiceGatewayMbean
  
• WorkstationListenerMbean
  
• JoltListenerMbean
  
• ARTBatchSystemMbean
  

5.8.1 Mbean

This is the root class for other classes in TXST. It provides a set of basic operation.

• getName
  
• getType
  
• getMbeanName
  

5.8.1.1 getName

get the object’s name

5.8.1.2 getType

get the object’s type

5.8.1.3 getMbeanName

get the MBean’s objectName.

5.8.2 DomainMbean

Inherited from MBean

• CreateMachine
  
• GetParameters
  
• GetParameter
  
• SetParameters
  
• SetParameter
  
• GetRoutings
  
• Add Routing
  
• DeleteRouting
  
• SetRoutingParameter
  
• SetRoutingParameters
  
• GetRoutingParameter
  
• Swap
  
• Tuxedo_Domain
  
• MachineMbean
  

5.8.2.1 CreateMachine

• Syntax
  

5.8.2.1.1 Syntax

CreateMachine(pmid,lmid,tuxconfig,tuxdir,appdir)

This function invokes JMX interface createMachine of Domain Mbean. For more information, refer to Tuxedo Domain MBean.

5.8.2.2 GetParameters

Thsi section contains the following topics:

• Syntax
  
• Output
  

5.8.2.2.1 Syntax

GetParameter(name)

This function invokes JMX interface getParameter of Domain Mbean. For more information, refer to Tuxedo Domain MBean.

5.8.2.2.2 Output

A dictionary which includes all attributes and values.

This function invokes JMX interface getParameters of Domain Mbean. For more information, refer to Tuxedo Domain MBean.

5.8.2.3 GetParameter

• Syntax
  
• Output
  

5.8.2.3.1 Syntax

GetParameters()

5.8.2.3.2 Output

A dictionary which includes all attributes and values.

This function invokes JMX interface getParameters of Domain Mbean. For more information, refer to Tuxedo Domain MBean.

5.8.2.4 SetParameters

• Syntax
  
• Input
  

5.8.2.4.1 Syntax

SetParameters(data)

5.8.2.4.2 Input

data: A dictionary which includes the attributes and values to be set.

This function invokes JMX interface setParameters of Domain Mbean. For more information, refer to Tuxedo Domain MBean.

5.8.2.5 SetParameter

• Syntax
  

5.8.2.5.1 Syntax

SetParameter(name, value)

This function invokes JMX interface setParameter of Domain Mbean. For more information, refer to Tuxedo Domain MBean

5.8.2.6 GetRoutings

• Syntax
  
• Output
  

5.8.2.6.1 Syntax

GetRoutings()

5.8.2.6.2 Output

A list includes all attributes and values of all routings.

This function invokes JMX interface getRouting of Domain Mbean. For more information, refer to Tuxedo Domain MBean.

5.8.2.7 Add Routing

• Syntax
  

5.8.2.7.1 Syntax

AddRouting(routingName,routingType,bufType,field,ranges)

This function invokes JMX interface addRouting of Domain Mbean. For more information, refer to Tuxedo Domain MBean.

5.8.2.8 DeleteRouting

• Syntax
  

5.8.2.8.1 Syntax

DeleteRouting(routingName,buftype,field,type)

This function invokes JMX interface deleteRouting of Domain Mbean. For more information, refer to Tuxedo Domain MBean.

5.8.2.9 SetRoutingParameter

• Syntax
  

5.8.2.9.1 Syntax

SetRoutingParameter(routingName,buftype,field,type, parameterName,parameterValue)

This function invokes JMX interface setRoutingParameter of Domain Mbean. For more information, refer to Tuxedo Domain MBean.

5.8.2.10 SetRoutingParameters

This section contains the following topics:

• Syntax
  
• Input
  

5.8.2.10.1 Syntax

SetRoutingParameters(routingName,buftype,field,ta_type,attrs)

5.8.2.10.2 Input

attrs: A dictionary includes the attributes and values to be set.

This function invokes JMX interface setRoutingParameters of Domain Mbean. For more information, refer to Tuxedo Domain MBean.

5.8.2.11 GetRoutingParameter

• Syntax
  
• Output
  

5.8.2.11.1 Syntax

GetRoutingParameter(routingName,buftype,field,type,parameterName)

5.8.2.11.2 Output

A dictionary includes the attribute and the value.

This function invokes JMX interface getRoutingParameter of Domain Mbean. For more information, refer to Tuxedo Domain MBean.

5.8.2.12 Swap

• Syntax
  

5.8.2.12.1 Syntax

Swap()

This function invokes JMX interface swap of Domain Mbean. For more information, refer to Tuxedo Domain MBean.

5.8.2.13 Tuxedo_Domain

• Syntax
  
• Output
  

5.8.2.13.1 Syntax

Tuxedo_Domain()

5.8.2.13.2 Output

Field Name	Description
TA_AUTOTRAN	Refer to Oracle® Tuxedo Reference Guide
TA_TRANTIME
TA_IPCKEY
TA_MASTER
TA_MODEL
TA_DOMAINID
TA_UID
TA_GID
TA_PERM
TA_MAXACCESSERS
TA_MAXSERVERS
TA_MAXSERVICES
TA_MAXGROUPS
TA_MAXNETGROUPS
TA_MAXMACHINES
TA_MAXQUEUES
TA_MAXACLGROUPS
TA_MAXGTT
TA_MAXCONV
TA_MAXBUFTYPE
TA_MAXBUFSTYPE
TA_MAXDRT
TA_MAXRFT
TA_MAXRTDATA
TA_MAXSPDATA
TA_MAXTRANTIME
TA_CMTRET
TA_LDBAL
TA_SYSTEM_ACCESS
TA_OPTIONS
TA_USIGNAL
TA_SECURITY
TA_SSL_RENEGOTIATION
TA_AUTHSVC
TA_SCANUNIT
TA_SANITYSCAN
TA_DBBLWAIT
TA_BBLQUERY
TA_BLOCKTIME
TA_NOTIFY
TA_SEC_PRINCIPAL_NAME
TA_SEC_PRINCIPAL_LOCATION
TA_SEC_PRINCIPAL_PASSVAR
TA_SIGNATURE_AHEAD
TA_SIGNATURE_BEHIND
TA_SIGNATURE_REQUIRED
TA_ENCRYPTION_REQUIRED

5.8.2.14 MachineMbean

Inherited from MBean

• CreateGroup
  
• CreateBridge
  
• GetParameters
  
• GetParameter
  
• SetParameters
  
• SetParameter
  
• DeleteRecursively
  
• Delete
  
• Migrate
  
• Clean
  
• GetNativeClients
  
• Suspend
  
• Resume
  
• KillClient
  
• GetTransactions
  
• AbortTransaction
  
• GetUlog
  
• Client_Connections
  
• Machine_Operation_Statistics
  
• Tuxedo_machines
  

5.8.2.14.1 CreateGroup

• Syntax
  

5.8.2.14.1.1 Syntax

CreateGroup(groupName,groupNo)

This function invokes JMX interface createGroup of Machine Mbean.

5.8.2.14.2 CreateBridge

• Syntax
  

5.8.2.14.2.1 Syntax

CreateBridge(lmid,naddr,nlsaddr)

This function invokes JMX interface createBridge of Machine Mbean.

5.8.2.14.3 GetParameters

This section contains the following topics:

• Syntax
  
• Output
  

5.8.2.14.3.1 Syntax

GetParameters()

5.8.2.14.3.2 Output

A dictionary which includes all attributes and values.

This function invokes JMX interface getParameters of Machine Mbean.

5.8.2.14.4 GetParameter

• Syntax
  

5.8.2.14.4.1 Syntax

GetParameter(name)

This function invokes JMX interface getParameter of Machine Mbean.

5.8.2.14.5 SetParameters

This section contains the following topics:

• Syntax
  
• Input
  

5.8.2.14.5.1 Syntax

SetParameters(data)

5.8.2.14.5.2 Input

data: A dictionary which includes the attributes and values to be set.

This function invokes JMX interface setParameters of Machine Mbean.

5.8.2.14.6 SetParameter

• Syntax
  

5.8.2.14.6.1 Syntax

SetParameter(name, value)

This function invokes JMX interface setParameter of Machine Mbean.

5.8.2.14.7 DeleteRecursively

• Syntax
  

5.8.2.14.7.1 Syntax

DeleteRecursively()

Invokes JMX interface deleteRecursively of Machine Mbean.

5.8.2.14.8 Delete

• Syntax
  

5.8.2.14.8.1 Syntax

Delete()

Invokes JMX interface delete of Machine Mbean.

5.8.2.14.9 Migrate

• Syntax
  

5.8.2.14.9.1 Syntax

Migrate()

Invokes JMX interface migrate of Machine Mbean.

5.8.2.14.10 Clean

• Syntax
  

5.8.2.14.10.1 Syntax

Clean()

Invokes JMX interface clean of Machine Mbean.

5.8.2.14.11 GetNativeClients

• Syntax
  

5.8.2.14.11.1 Syntax

GetNativeClients()

Invokes JMX interface getNativeClients of Machine Mbean.

5.8.2.14.12 Suspend

This section contains the following topics:

• Syntax
  

5.8.2.14.12.1 Syntax

Suspend(clientId)

Invokes JMX interface suspend of Machine Mbean.

5.8.2.14.13 Resume

This section contains the following topics:

• Syntax
  

5.8.2.14.13.1 Syntax

Resume(clientId)

Invokes JMX interface resume of Machine Mbean.

5.8.2.14.14 KillClient

This section contains the following topics:

• Syntax
  

5.8.2.14.14.1 Syntax

KillClient(clientId)

Invokes JMX interface killClient of Machine Mbean.

5.8.2.14.15 GetTransactions

This section contains the following topics:

• Syntax
  
• Output
  

5.8.2.14.15.1 Syntax

GetTransactions()

5.8.2.14.15.2 Output

A list includes all transactions’ attributes.

This function invokes JMX interface get Transations of Machine Mbean.

5.8.2.14.16 AbortTransaction

• Syntax
  

5.8.2.14.16.1 Syntax

AbortTransaction(transId,xId)

Invokes JMX interface abortTransaction of Machine Mbean.

5.8.2.14.17 GetUlog

This section contains the following topics:

• Syntax
  
• Output
  

5.8.2.14.17.1 Syntax

GetUlog(date, startTime, endTime, line,ulogCat, serverity, totalLine)

5.8.2.14.17.2 Output

A list includes all attributes of ulogs.

Invokes JMX interface getULog of Machine Mbean.

5.8.2.14.18 Client_Connections

This section contains the following topics:

• Syntax
  
• Output
  

5.8.2.14.18.1 Syntax

Client_Connections()

5.8.2.14.18.2 Output

CLIENT_CONNECTION_NUMBER_MBEAN

Field Name	Description
TA_CURCLIENTS	Native Clients Number
TA_CURWSCLIENTS	Workstation Clients Number
TA_CURJOLTCLIENTS	Jolt Clients Number

5.8.2.14.19 Machine_Operation_Statistics

This section contains the following topics:

• Syntax
  
• Output:
  

5.8.2.14.19.1 Syntax

Machine_Operation_Statistics ()

5.8.2.14.19.2 Output:

Field Name	Description
TA_NUMCONV	Following MIB attribute in T_Machine is returned. For information about attribute definition, refer to Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TA_NUMDEQUEUE
TA_NUMENQUEUE
TA_NUMPOST
TA_NUMREQ
TA_NUMSUBSCRIBE
TA_NUMTRAN
TA_NUMTRANABT
TA_NUMTRANCMT
TA_WKCOMPLETED
TA_TIMESTART
TA_CURTIME

5.8.2.14.20 Tuxedo_machines

This section contains the following topics:

• Syntax
  
• Output
  

5.8.2.14.20.1 Syntax

Tuxedo_machines()

5.8.2.14.20.2 Output

Field Name	Description
TA_PMID	For information about these MIB attributes in T_MACHINE, refer to Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference
TA_LMID
TA_APPDIR
TA_TUXCONFIG
TA_TUXDIR
TA_UID
TA_GID
TA_PERM
TA_BRTHREADS
TA_MAXACCESSERS
TA_MAXWSCLIENTS
TA_MAXACLCACHE
TA_MAXCONV
TA_MAXPENDINGBYTES
TA_MAXGTT
TA_TYPE
TA_CMPLIMIT
TA_TMNETLOAD
TA_SPINCOUNT
TA_TLOGDEVICE
TA_TLOGOFFSET
TA_TLOGNAME
TA_TLOGSIZE
TA_ULOGPFX
TA_TUXOFFSET
TA_ENVFILE	For information about these MIB attributes in T_MACHINE, refer to Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference
TA_SEC_PRINCIPAL_NAME
TA_SEC_PRINCIPAL_LOCATION
TA_SEC_PRINCIPAL_PASSVAR
TA_SIGNATURE_REQUIRED
TA_ENCRYPTION_REQUIRED
TA_SICACHEENTRIESMAX

5.8.3 GroupMbean

Inherited from MBean

• CreateServer
  
• GetParameters
  
• GetParameter
  
• SetParameters
  
• SetParameter
  
• CreateTMS
  
• DeleteRecursively
  
• Delete
  
• Migrate
  
• Tuxedo_groups
  

5.8.3.1 CreateServer

This section contains the following topics:

• Syntax
  

5.8.3.1.1 Syntax

CreateServer(aout,srvID)

Invokes JMX interface createServer of Group Mbean.

5.8.3.2 GetParameters

This section contains the following topics:

• Syntax
  
• Output
  

5.8.3.2.1 Syntax

GetParameters()

5.8.3.2.2 Output

A dictionary which includes all attributes and values.

This function invokes JMX interface getParameters of Group Mbean.

5.8.3.3 GetParameter

• Syntax
  

5.8.3.3.1 Syntax

GetParameter(name)

This function invokes JMX interface getParameter of Group Mbean.

5.8.3.4 SetParameters

• Syntax
  
• Input
  

5.8.3.4.1 Syntax

SetParameters(data)

5.8.3.4.2 Input

data: A dictionary which includes the attributes and values to be set.

This function invokes JMX interface setParameters of Group Mbean.

5.8.3.5 SetParameter

• Syntax
  

5.8.3.5.1 Syntax

SetParameter(name, value)

This function invokes JMX interface setParameter of Group Mbean.

5.8.3.6 CreateTMS

Syntax

CreateTMS(rmsName,rmid,tmsName)

Invokes JMX interface createTMS of Group Mbean.

• Syntax:
  

5.8.3.6.1 Syntax:

CreateTMS(rmsName,rmid,tmsName)

Invokes JMX interface createTMS of Group Mbean.

5.8.3.7 DeleteRecursively

Syntax

DeleteRecursively()

Invokes JMX interface deleteRecursively of Group Mbean.

5.8.3.8 Delete

• Syntax
  

5.8.3.8.1 Syntax

Delete()

Invokes JMX interface delete of Group Mbean.

5.8.3.9 Migrate

• Syntax
  

5.8.3.9.1 Syntax

Migrate()

Invokes JMX interface migrate of Group Mbean.

5.8.3.10 Tuxedo_groups

• Syntax
  
• Output
  

5.8.3.10.1 Syntax

Tuxedo_groups()

5.8.3.10.2 Output

Field Name	Description
TA_SRVGRP	For information about these MIB attributes in T_GROUP, refer to Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TA_LMID
TA_GRPNO
TA_TMSNAME
TA_ENVFILE
TA_TMSCOUNT
TA_SEC_PRINCIPAL_NAME
TA_SEC_PRINCIPAL_LOCATION
TA_SEC_PRINCIPAL_PASSVAR
TA_SIGNATURE_REQUIRED
TA_ENCRYPTION_REQUIRED
TA_OPENINFO
TA_CLOSEINFO
TA_MRM

5.8.4 BridgeMbean

Inherited from MBean

• GetParameters
  
• GetParameter
  
• GetRemoteLinks
  
• GetRemoteLinkParameter
  
• SetRemoteLinkParameters
  
• SuspendRemoteLink
  
• ResumeRemoteLink
  
• DeactivateRemoteLink
  
• Bridge_Remote_Link_Statistics
  
• Bridge_Queue_Statistics
  
• Tuxedo_ECM_Bridge
  

5.8.4.1 GetParameters

Syntax

GetParameters()

• Output
  

5.8.4.1.1 Output

A dictionary which includes the attributes.

This function invokes JMX interface getParameters() of Bridge Mbean.

5.8.4.2 GetParameter

Syntax

GetParameter(name)

This function invokes JMX interface getParameter() of Bridge Mbean.

5.8.4.3 GetRemoteLinks

• Syntax
  
• Output
  

5.8.4.3.1 Syntax

GetRemoteLinks ()

5.8.4.3.2 Output

A list which includes the attributes.

This function invokes JMX interface getRemoteLinks () of Bridge Mbean.

5.8.4.4 GetRemoteLinkParameter

This section contains the following topics:

• Syntax
  

5.8.4.4.1 Syntax

GetRemoteLinkParameter(lmid, name)

This function invokes JMX interface getRemoteLinkParameter () of Bridge Mbean.

5.8.4.5 SetRemoteLinkParameters

This section contains the following topics:

• Syntax
  

5.8.4.5.1 Syntax

SetRemoteLinkParameters (lmid, data)

Input

data: A dictionary which includes the attributes.

This function invokes JMX interface setRemoteLinkParameters () of Bridge Mbean.

5.8.4.6 SuspendRemoteLink

This section contains the following topics:

• Syntax
  

5.8.4.6.1 Syntax

SuspendRemoteLink (lmid)

This function invokes JMX interface suspend () of Bridge Mbean.

5.8.4.7 ResumeRemoteLink

Syntax

ResumeRemoteLink (lmid)

This function invokes JMX interface resume () of Bridge Mbean.

5.8.4.8 DeactivateRemoteLink

This section contains the following topics:

• Syntax
  

5.8.4.8.1 Syntax

DeactivateRemoteLink (lmid)

This function invokes JMX interface deactive () of Bridge Mbean.

5.8.4.9 Bridge_Remote_Link_Statistics

This section contains the following topics:

• Syntax
  
• Output
  

5.8.4.9.1 Syntax

Bridge_Remote_Link_Statistics()

5.8.4.9.2 Output

REMOTE_LINK_STATISTICS_MBEAN

Field Name	Description
TA_LMID	Destination logical machine identifier (LMID2) for network connection.
TA_MONINBOUNDNUM	Total Inbound Network Messages since bridge was started.
TA_MONOUTBOUNDNUM	Total Outbound Network Messages since bridge was started.
TA_MONINBOUNDBYT	Total Inbound Network Messages size in bytes since bridge was stated.
TA_MONOUTBOUNDBYT	Total Outbound Network Messages size in bytes since bridge was stated.
TA_SENTNUM	Number of messages sent from the source logical machine to the destination logical machine.
TA_SENTBYT	Number of bytes sent from the source logical machine to the destination logical machine.
TA_SENDNUM	Number of messages sends from the source logical machine to the destination logical machine.
TA_SENDBYT	Number of bytes sends from the source logical machine to the destination logical machine.
TA_TIMERESTART	Restart Time, in seconds, since 00:00:00 UTC, January 1, 1970
TA_CURTIME	Current time, in seconds, since 00:00:00 UTC, January 1, 1970
TA_CONTIME	Connection time, in seconds, since 00:00:00 UTC, January 1, 1970

5.8.4.10 Bridge_Queue_Statistics

This section contains the following topics:

• Syntax
  
• Output
  

5.8.4.10.1 Syntax

Bridge_Queue_Statistics()

5.8.4.10.2 Output

BRIDGE_QUEUE_STATISTICS_MBEAN

Field Name	Description
TA_MSG_QNUM	Number of messages currently on the queue.

5.8.4.11 Tuxedo_ECM_Bridge

This section contains the following topics:

• Syntax
  
• Output
  

5.8.4.11.1 Syntax

Tuxedo_ECM_Bridge()

5.8.4.11.2 Output

TUXEDO_ECM_BRIDGE_MBEAN

Field Name	Description
TA_LMID	For information about these MIB attributes in T_MACHINE, refer to Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TA_NADDR
TA_BRIDGE
TA_NLSADDR
TA_FADDR
TA_FRANGE
TA_MINENCRYPTBITS
TA_MAXENCRYPTBITS

5.8.5 ServerMbean

Inherited from MBean

• GetParameters
  
• GetParameter
  
• SetParameters
  
• SetParameter
  
• Delete
  
• SetServiceParam
  
• GetServiceParam
  
• DeleteService
  
• GetServices
  
• SuspendService
  
• ResumeService
  
• Server_Statistics
  
• Service_Statistics
  
• IPC_Queue_Statistics
  
• Tuxedo_servers
  

5.8.5.1 GetParameters

This section contains the following topics:

• Syntax
  
• Output
  

5.8.5.1.1 Syntax

GetParameters()

5.8.5.1.2 Output

A dictionary which includes all attributes and values.

This function invokes JMX interface getParameters of Server Mbean.

5.8.5.2 GetParameter

This section contains the following topics:

• Syntax
  

5.8.5.2.1 Syntax

GetParameter(name)

This function invokes JMX interface getParameter of Server Mbean.

5.8.5.3 SetParameters

This section contains the following topics:

• Syntax
  
• Input
  

5.8.5.3.1 Syntax

SetParameters(data)

5.8.5.3.2 Input

data: A dictionary which includes the attributes and values to be set.

This function invokes JMX interface setParameters of Server Mbean.

5.8.5.4 SetParameter

This section contains the following topics:

• Syntax
  

5.8.5.4.1 Syntax

SetParameter(name, value)

This function invokes JMX interface setParameter of Server Mbean.

5.8.5.5 Delete

• Syntax
  

5.8.5.5.1 Syntax

Delete()

This function invokes JMX interface delete of Server Mbean.

5.8.5.6 SetServiceParam

• Syntax
  

5.8.5.6.1 Syntax

SetServiceParam(serviceName,parameterName,parameterValue)

Invokes JMX interface setServiceParameter of Server Mbean.

5.8.5.7 GetServiceParam

• Syntax
  
• Output
  

5.8.5.7.1 Syntax

GetServiceParam(serviceName,parameterName)

5.8.5.7.2 Output

A dictionary includes the attribute name and value.

Invokes JMX interface getServiceParameter of Server Mbean.

5.8.5.8 DeleteService

• Syntax
  

5.8.5.8.1 Syntax

DeleteService(serviceName)

Invokes JMX interface deleteService of Server Mbean.

5.8.5.9 GetServices

This section contains the following topics:

• Syntax
  
• Output
  

5.8.5.9.1 Syntax

GetServices()

5.8.5.9.2 Output

A list includes all services’ attributes.

Invokes JMX interface getServices of Server Mbean.

5.8.5.10 SuspendService

This section contains the following topics:

• Syntax
  

5.8.5.10.1 Syntax

SuspendService(serviceName)

Invokes JMX interface suspendService of Server Mbean.

5.8.5.11 ResumeService

This section contains the following topics:

• Syntax
  

5.8.5.11.1 Syntax

ResumeService(serviceName)

Invokes JMX interface resumeService of Server Mbean.

5.8.5.12 Server_Statistics

This section contains the following topics:

• Syntax
  
• Output
  

5.8.5.12.1 Syntax

Server_Statistics()

5.8.5.12.2 Output

Field Name	Description
TA_BASESRVID	For information about these MIB attributes in T_SERVER, refer to Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TA_SRVID
TA_STATE
TA_NUMDISPATCHTHREADS
TA_NUMCONV
TA_NUMDEQUEUE
TA_NUMENQUEUE
TA_NUMPOST
TA_NUMREQ
TA_NUMSUBSCRIBE
TA_NUMTRAN
TA_NUMTRANABT
TA_NUMTRANCMT
TA_TOTWORKL
TA_TIMERESTART
TA_CURTIME

5.8.5.13 Service_Statistics

This section contains the following topics:

• Syntax:
  
• Output
  

5.8.5.13.1 Syntax:

Service_Statistics()

5.8.5.13.2 Output

SERVICE_STATISTICS_MBEAN

Field Name	Description
TA_SERVICENAME	Service name
TA_SRVID	Unique (within the server group) server identification number.
TA_TOTMSGSIZEMEGA	Total Message size since service was started. The unit is Mega
TA_TOTMSGSIZEBYTE	Total Message size, since service was started, in byte mod 1048576.
TA_TOTEXECTIMESEC	Total execution time since service was started. The unit is seconds.
TA_TOTEXECTIMEUSEC	Total execution time, since service was started, in microseconds mod 1000000.
TA_TOTCPUTIMESEC	Total CPU time since service was started. The unit is seconds.
TA_TOTCPUTIMEUSEC	Total CPU time, since service was started, in microseconds mod 1000000.
TA_TOTSUCCNUM	Total successes request number since service was started.
TA_TOTSFAILNUM	Total system failure request number since service was started.
TA_TOTUFAILNUM	Total user failure request number since service was started.
TA_TIMERESTART	Time, in seconds, since 00:00:00 UTC, January 1, 1970, as returned by the time(2) system call on T_SERVER:TA_LMID, when the server was last started or restarted.
TA_CURTIME	Current time, in seconds, since 00:00:00 UTC, January 1, 1970, as returned by the time(2) system call on T_SERVER:TA_LMID.

5.8.5.14 IPC_Queue_Statistics

This section contains the following topics:

• Syntax
  
• Output
  

5.8.5.14.1 Syntax

IPC_Queue_Statistics()

5.8.5.14.2 Output

IPC_QUEUE_STATISTICS_MBEAN

Field Name	Description
TA_RQADDR	Symbolic address of the request queue for an active server offering this service. See T_SERVER:TA_RQADDR for more information on this attribute.
TA_SRVID	Unique (within the server group) server identification number for an active server offering this service. See T_SERVER:TA_SRVID for more information on this attribute.
TA_MSG_QNUM	Number of messages currently on the queue.

5.8.5.15 Tuxedo_servers

This section contains the following topics:

• Syntax
  
• Output
  

5.8.5.15.1 Syntax

Tuxedo_servers()

5.8.5.15.2 Output

TUXEDO_ECM_SERVERS_MBEAN

Field Name	Description
TA_SERVERNAME	For information about these MIB attributes in T_SERVER, refer to Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TA_SRVGRP
TA_SRVID
TA_CLOPT
TA_SEQUENCE
TA_MIN
TA_MAX
TA_ENVFILE
TA_CONV
TA_RQADDR
TA_RQPERM
TA_REPLYQ
TA_RPPERM
TA_RCMD
TA_MAXGEN
TA_GRACE
TA_RESTART
TA_SYSTEM_ACCESS
TA_MAXDISPATCHTHREADS
TA_MINDISPATCHTHREADS
TA_THREADSTACKSIZE
TA_SEC_PRINCIPAL_NAME
TA_SEC_PRINCIPAL_LOCATION
TA_SEC_PRINCIPAL_PASSVAR
TA_SICACHEENTRIESMAX
TA_CONCURR_STRATEGY

5.8.6 SystemServerMbean

Inherited from MBean

• GetParameters
  
• GetParameter
  
• SetParameters
  
• SetParameter
  
• Delete
  
• System_Server_Number
  
• TMSMbean
  
• TMS_Transaction_Statistics
  
• Tuxedo_TMS
  

5.8.6.1 GetParameters

This section contains the following topics:

• Syntax
  
• Output:
  

5.8.6.1.1 Syntax

GetParameters()

5.8.6.1.2 Output:

A dictionary which includes all attributes and values.

This function invokes JMX interface getParameters of System Server Mbean.

5.8.6.2 GetParameter

This section contains the following topics:

• Syntax
  

5.8.6.2.1 Syntax

GetParameter(name)

This function invokes JMX interface getParameter of System Server Mbean.

5.8.6.3 SetParameters

This section contains the following topics:

• Syntax
  
• Input
  

5.8.6.3.1 Syntax

SetParameters(data)

5.8.6.3.2 Input

data: A dictionary which includes the attributes and values to be set.

This function invokes JMX interface setParameters of System Server Mbean.

5.8.6.4 SetParameter

This section contains the following parameters:

• Syntax
  

5.8.6.4.1 Syntax

SetParameter(name, value)

This function invokes JMX interface setParameter of System Server Mbean.

5.8.6.5 Delete

This section contains the following topic:

• Syntax
  

5.8.6.5.1 Syntax

Delete()

This function invokes JMX interface delete of System Server Mbean.

5.8.6.6 System_Server_Number

This section contains the following topics:

• Syntax
  
• Output
  

5.8.6.6.1 Syntax

System_Server_Number()

5.8.6.6.2 Output

SYSTEM_SERVER_NUMBER_MBEAN

Field Name	Description
TA_SRVID	For information about these MIB attributes in T_SERVER, refer to Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TA_BASESRVID
TA_STATE

5.8.6.7 TMSMbean

Inherited from MBean

• GetParameters
  
• GetParameter
  
• SetParameters
  
• SetParameter
  

5.8.6.7.1 GetParameters

This section contains the following topics:

• Syntax
  
• Output
  

5.8.6.7.1.1 Syntax

GetParameters()

5.8.6.7.1.2 Output

A dictionary which includes the attributes.

This function invokes JMX interface getParameters() of TMS Mbean.

5.8.6.7.2 GetParameter

This section contains the following topics:

• Syntax
  

5.8.6.7.2.1 Syntax

GetParameter(name)

This function invokes JMX interface getParameter() of TMS Mbean.

5.8.6.7.3 SetParameters

This section contains the following topics:

• Syntax
  
• Input
  

5.8.6.7.3.1 Syntax

SetParameters(data)

5.8.6.7.3.2 Input

data: A dictionary which includes the attributes.

This function invokes JMX interface setParameters() of TMS Mbean.

5.8.6.7.4 SetParameter

This section contains the following topics:

• Syntax
  

5.8.6.7.4.1 Syntax

SetParameter(name, value)

This function invokes JMX interface setParameter() of TMS Mbean.

5.8.6.8 TMS_Transaction_Statistics

This section contains the following topics:

• Syntax:
  
• Output:
  

5.8.6.8.1 Syntax:

TMS_Transaction_Statistics()

5.8.6.8.2 Output:

TMS_TRANSACTION_STATISTICS_MBEAN

Field Name	Description
TA_SRVID	For information about these MIB attributes in T_SERVER, refer to Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TA_BASESRVID
TA_GRPNO
TA_NUMTRANABT
TA_NUMTRANCMT
TA_TIMERESTART
TA_CURTIME
TA_STATE

5.8.6.9 Tuxedo_TMS

This section contains the following topics:

• Syntax
  
• Output
  

5.8.6.9.1 Syntax

Tuxedo_TMS()

5.8.6.9.2 Output

Field Name	Description
TA_SRVGRP	For information about the MIB attributes, refer to Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TA_GRPNO
TA_LMID
TA_TMSNAME
TA_TMSCOUNT
TA_OPENINFO
TA_CLOSEINFO

5.8.7 TDomainGatewayMbean

Inherited from MBean

• GetParameters
  
• GetParameter
  
• SetParameters
  
• SetParameter
  
• Delete
  
• GetACLs
  
• AddACL
  
• DeleteACL
  
• UpdateACL
  
• GetEventIns
  
• AddEventIn
  
• DeleteEventIn
  
• GetEventOuts
  
• AddEventOut
  
• DeleteEventOut
  
• GetExports
  
• AddExport
  
• DeleteExport
  
• UpdateExport
  
• GetImports
  
• AddImport
  
• DeleteImport
  
• UpdateImport
  
• GetLocals
  
• AddLocal
  
• DeleteLocal
  
• UpdateLocal
  
• GetPasswords
  
• AddPassword
  
• DeletePassword
  
• ReCryptPasswords
  
• GetRemotes
  
• AddRemote
  
• DeleteRemote
  
• UpdateRemote
  
• GetResources
  
• SetResources
  
• GetRoutings
  
• AddRouting
  
• DeleteRouting
  
• UpdateRouting
  
• GetTDomain
  
• AddTDomain
  
• DeleteTDomain
  
• SetTDomain
  
• Remote_Link_Statistics
  
• Domain_Gateway_Transaction_Statistics
  

5.8.7.1 GetParameters

This section contains the following topics:

• Syntax
  
• Output
  

5.8.7.1.1 Syntax

GetParameters()

5.8.7.1.2 Output

A dictionary which includes the attributes.

This function invokes JMX interface getParameters() of /T domain gateway Mbean.

5.8.7.2 GetParameter

This section contains the following topics:

• Syntax
  

5.8.7.2.1 Syntax

GetParameter(name)

This function invokes JMX interface getParameter() of /T domain gateway Mbean.

5.8.7.3 SetParameters

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.3.1 Syntax

SetParameters(data)

5.8.7.3.2 Input

data: A dictionary which includes the attributes.

This function invokes JMX interface setParameters() of /T domain gateway Mbean.

5.8.7.4 SetParameter

• Syntax
  

5.8.7.4.1 Syntax

SetParameter(name, value)

This function invokes JMX interface setParameter() of /T domain gateway Mbean.

5.8.7.5 Delete

This section contains the following topics:

• Syntax
  

5.8.7.5.1 Syntax

Delete()

This function invokes JMX interface delete() of /T domain gateway Mbean.

5.8.7.6 GetACLs

This section contains the following topics:

• Input
  
• Output:
  

5.8.7.6.1 Input

Section

GetACLs(filter)

filter: A dictionary which includes the attributes and values.

5.8.7.6.2 Output:

ACL list

This function invokes JMX interface getACLs() of /T domain gateway Mbean.

5.8.7.7 AddACL

Syntax

AddACL(parameters)

• Syntax
  
• Input
  

5.8.7.7.1 Syntax

AddACL(parameters)

5.8.7.7.2 Input

parameters: A dictionary which includes the attributes and values.

This function invokes JMX interface addACL() of /T domain gateway Mbean.

5.8.7.8 DeleteACL

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.8.1 Syntax

DeleteACL(ACLName)

5.8.7.8.2 Input

ACLName: name of ACL which is to be deleted.

This function invokes JMX interface deleteACL () of /T domain gateway Mbean.

5.8.7.9 UpdateACL

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.9.1 Syntax

UpdateACL(ACLName,parameters)

5.8.7.9.2 Input

ACLName: name of ACL which is to be updated.

parameters: A dictionary which includes the attributes and values.

This function invokes JMX interface updateACL () of /T domain gateway Mbean.

5.8.7.10 GetEventIns

This section contains the following topics:

• Syntax
  
• Input
  
• Output
  

5.8.7.10.1 Syntax

GetEventIns(filter)

5.8.7.10.2 Input

filter: A dictionary which includes the attributes and values.

5.8.7.10.3 Output

Events list

This function invokes JMX interface getEventInss() of /T domain gateway Mbean.

5.8.7.11 AddEventIn

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.11.1 Syntax

AddEventIn(parameters)

5.8.7.11.2 Input

parameters: A dictionary which includes the attributes and values.

This function invokes JMX interface addEventIn() of /T domain gateway Mbean.

5.8.7.12 DeleteEventIn

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.12.1 Syntax

DeleteEventIn(eventName, lAccessPoint)

5.8.7.12.2 Input

eventName: name of a particular remote event, which should be subscribed by local domain subscriber.

1AccessPoint: the name of a local domain access point, which is allowed to receive this event from remote domain(s)

This function invokes JMX interface deleteEventIn () of /T domain gateway Mbean.

5.8.7.13 GetEventOuts

This section contains the following topics:

• Syntax
  
• Input
  
• Output
  

5.8.7.13.1 Syntax

GetEventOuts(filter)

5.8.7.13.2 Input

filter: A dictionary which includes the attributes and values.

5.8.7.13.3 Output

Events list

This function invokes JMX interface getEventOutss() of /T domain gateway Mbean.

5.8.7.14 AddEventOut

• Syntax
  
• Input
  

5.8.7.14.1 Syntax

AddEventOut(parameters)

5.8.7.14.2 Input

parameters: A dictionary which includes the attributes and values.

This function invokes JMX interface addEventOut() of /T domain gateway Mbean.

5.8.7.15 DeleteEventOut

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.15.1 Syntax

DeleteEventOut(eventName,lAccessPoint,rAccessPointList)

5.8.7.15.2 Input

• eventName: the name of a particular local event, which can be posted to remote domains.
• lAccessPoint: the name of a local domain access point, which is allowed to send this event to remote domains.
• rAccessPointList: the remote domain access point which this event is sent to.

This function invokes JMX interface deleteEventOut () of /T domain gateway Mbean.

5.8.7.16 GetExports

This section contains the following topics:

• Syntax
  
• Input
  
• Output
  

5.8.7.16.1 Syntax

GetExports(filter)

5.8.7.16.2 Input

filter: A dictionary which includes the attributes and values.

5.8.7.16.3 Output

Local resources list

This function invokes JMX interface getExports() of /T domain gateway Mbean.

5.8.7.17 AddExport

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.17.1 Syntax

AddExport(parameters)

5.8.7.17.2 Input

parameters: A dictionary which includes the attributes and values.

This function invokes JMX interface addExport() of /T domain gateway Mbean.

5.8.7.18 DeleteExport

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.18.1 Syntax

DeleteExport(resourceName,lAccessPoint)

5.8.7.18.2 Input

• resourceName: The local resource name
• lAccessPoint: The local access point name through which this local resource is available.

This function invokes JMX interface deleteExport () of /T domain gateway Mbean.

5.8.7.19 UpdateExport

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.19.1 Syntax

UpdateExport (resourceName, lAccessPoint, parameters)

5.8.7.19.2 Input

• resourceName: The local resource name.
• lAccessPoint: The local access point name through which this local resource is available.
• parameters: A dictionary which includes the attributes and values.

This function invokes JMX interface updateExport () of /T domain gateway Mbean.

5.8.7.20 GetImports

This section contains the following topics:

• Syntax
  
• Input
  
• Output
  

5.8.7.20.1 Syntax

GetImports(filter)

5.8.7.20.2 Input

filter: A dictionary which includes the attributes and values.

5.8.7.20.3 Output

Remote resources list

This function invokes JMX interface getImports() of /T domain gateway Mbean.

5.8.7.21 AddImport

• Syntax
  
• Input
  

5.8.7.21.1 Syntax

AddImport(parameters)

5.8.7.21.2 Input

parameters: A dictionary which includes the attributes and values.

This function invokes JMX interface addImport() of /T domain gateway Mbean.

5.8.7.22 DeleteImport

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.22.1 Syntax

DeleteImport(resourceName,lAccessPoint, rAccessPointList)

5.8.7.22.2 Input

• resourceName: The remote resource name used for entries of resource type SERVICE (the service name), QSPACE (the queue space name), and QNAME (the queue name).
• lAccessPoint: The name of the local domain access point through which this remote resource should be made available.
• rAccessPointList: the remote domain access point through which this remote resource should be imported.

This function invokes JMX interface deleteImport () of /T domain gateway Mbean.

5.8.7.23 UpdateImport

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.23.1 Syntax

UpdateImport (resourceName,lAccessPoint, rAccessPointList,
            parameters)

5.8.7.23.2 Input

• resourceName: The remote resource name used for entries of resource type SERVICE (the service name), QSPACE (the queue space name), and QNAME (the queue name).
• lAccessPoint: The name of the local domain access point through which this remote resource should be made available.
• rAccessPointList: the remote domain access point through which this remote resource should be imported.
• parameters: A dictionary which includes the attributes and values.

This function invokes JMX interface updateImport () of /T domain gateway Mbean.

5.8.7.24 GetLocals

• Syntax
  
• Input
  
• Output
  

5.8.7.24.1 Syntax

GetLocals(filter)

5.8.7.24.2 Input

filter: A dictionary which includes the attributes and values.

5.8.7.24.3 Output

local domain access points list

This function invokes JMX interface getLocals() of /T domain gateway Mbean.

5.8.7.25 AddLocal

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.25.1 Syntax

AddLocal(parameters)

5.8.7.25.2 Input

parameters: A dictionary which includes the attributes and values.

This function invokes JMX interface addLocal() of /T domain gateway Mbean.

5.8.7.26 DeleteLocal

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.26.1 Syntax

DeleteLocal(accessPoint)

5.8.7.26.2 Input

accessPoint: a user-specified local domain access point identifier

This function invokes JMX interface deleteLocal () of /T domain gateway Mbean.

5.8.7.27 UpdateLocal

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.27.1 Syntax

UpdateLocal (accessPoint, parameters)

5.8.7.27.2 Input

• accessPoint: a user-specified local domain access point identifier
• parameters: A dictionary which includes the attributes and values.

This function invokes JMX interface updateLocal () of /T domain gateway Mbean.

5.8.7.28 GetPasswords

This section contains the following topics:

• Syntax
  
• Input
  
• Output
  

5.8.7.28.1 Syntax

GetPasswords(filter)

5.8.7.28.2 Input

filter: A dictionary which includes the attributes and values.

5.8.7.28.3 Output

Password list

This function invokes JMX interface getPasswords() of /T domain gateway Mbean.

5.8.7.29 AddPassword

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.29.1 Syntax

AddPassword(parameters)

5.8.7.29.2 Input

parameters: A dictionary which includes the attributes and values.

This function invokes JMX interface addPassword() of /T domain gateway Mbean.

5.8.7.30 DeletePassword

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.30.1 Syntax

DeletePassword(lAccessPoint, rAccessPoint)

5.8.7.30.2 Input

• lAccessPoint: The name of the local domain access point to which the password applies.
• rAccessPoint: The name of the remote domain access point to which the password applies.

This function invokes JMX interface deletePassword () of /T domain gateway Mbean.

5.8.7.31 ReCryptPasswords

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.31.1 Syntax

ReCryptPasswords(lAccessPoint, rAccessPoint)

5.8.7.31.2 Input

• lAccessPoint: The name of the local domain access point to which the password applies.
• rAccessPoint: The name of the remote domain access point to which the password applies.

This function invokes JMX interface deletePassword () of /T domain gateway Mbean.

5.8.7.32 GetRemotes

• Syntax
  
• Input
  
• Output
  

5.8.7.32.1 Syntax

GetRemotes(filter)

5.8.7.32.2 Input

filter: A dictionary which includes the attributes and values.

5.8.7.32.3 Output

Remote domain access points list

This function invokes JMX interface getRemotes() of /T domain gateway Mbean.

5.8.7.33 AddRemote

• Syntax
  
• Input
  

5.8.7.33.1 Syntax

AddRemote(parameters)

5.8.7.33.2 Input

parameters: A dictionary which includes the attributes and values.

This function invokes JMX interface addRemote() of /T domain gateway Mbean.

5.8.7.34 DeleteRemote

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.34.1 Syntax

DeleteRemote(accessPoint,dmtype)

5.8.7.34.2 Input

• accessPoint: a user-specified remote domain access point identifier
• dmtype : The type of domain for this remote domain access point

This function invokes JMX interface deleteRemote () of /T domain gateway Mbean.

5.8.7.35 UpdateRemote

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.35.1 Syntax

UpdateRemote (accessPoint,dmtype,parameters)

5.8.7.35.2 Input

• accessPoint: a user-specified remote domain access point identifier
• dmtype : The type of domain for this remote domain access point
• parameters: A dictionary which includes the attributes and values.

This function invokes JMX interface updateRemote () of /T domain gateway Mbean.

5.8.7.36 GetResources

This section contains the following topics:

• Syntax
  
• Input
  
• Output
  

5.8.7.36.1 Syntax

GetResources(filter)

5.8.7.36.2 Input

filter: A dictionary which includes the attributes and values.

5.8.7.36.3 Output

Resource list

This function invokes JMX interface getResources() of /T domain gateway Mbean.

5.8.7.37 SetResources

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.37.1 Syntax

SetResources(parameters)

5.8.7.37.2 Input

parameters: A dictionary which includes the attributes and values.

This function invokes JMX interface setResources() of /T domain gateway Mbean.

5.8.7.38 GetRoutings

This section contains the following topics:

• Syntax
  
• Input
  
• Output
  

5.8.7.38.1 Syntax

GetRoutings(filter)

5.8.7.38.2 Input

filter: A dictionary which includes the attributes and values.

5.8.7.38.3 Output

Routing list

This function invokes JMX interface getRoutings() of /T domain gateway Mbean.

5.8.7.39 AddRouting

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.39.1 Syntax

AddRouting(parameters)

5.8.7.39.2 Input

parameters: A dictionary which includes the attributes and values.

This function invokes JMX interface addRouting() of /T domain gateway Mbean.

5.8.7.40 DeleteRouting

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.40.1 Syntax

DeleteRouting(routingName, bufType)

5.8.7.40.2 Input

• routingName: The name of the routing criteria table entry
• bufType: The type of buffer

This function invokes JMX interface deleteRouting () of /T domain gateway Mbean.

5.8.7.41 UpdateRouting

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.41.1 Syntax

UpdateRouting (routingName, bufType, parameters)

5.8.7.41.2 Input

• routingName: The name of the routing criteria table entry
• bufType: The type of buffer
• parameters: A dictionary which includes the attributes and values.

This function invokes JMX interface updateRouting () of /T domain gateway Mbean.

5.8.7.42 GetTDomain

This section contains the following topics:

• Syntax
  
• Input
  
• Output
  

5.8.7.42.1 Syntax

GetTDomains(filter)

5.8.7.42.2 Input

filter: A dictionary which includes the attributes and values.

5.8.7.42.3 Output

TDomain specific configuration list

This function invokes JMX interface getTDomain() of /T domain gateway Mbean.

5.8.7.43 AddTDomain

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.43.1 Syntax

AddTDomain(parameters)

5.8.7.43.2 Input

parameters: A dictionary which includes the attributes and values.

This function invokes JMX interface addTDomain() of /T domain gateway Mbean.

5.8.7.44 DeleteTDomain

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.44.1 Syntax

DeleteTDomain (accessPoint, nwaddr, lAccessPoint)

5.8.7.44.2 Input

• accessPoint: The local or remote domain access point name for which this entry provides the TDomain-specific configuration data. bufType: The type of buffer
• nwaddr: Specifies the network address associated with the access point
• lAccessPoint: a local domain access point found in the DM_LOCAL section for a TDomain session record in the BDMCONFIG file.

This function invokes JMX interface deleteTDomain () of /T domain gateway Mbean.

5.8.7.45 SetTDomain

This section contains the following topics:

• Syntax
  
• Input
  

5.8.7.45.1 Syntax

SetTDomain (accessPoint, nwaddr, lAccessPoint,parameters)

5.8.7.45.2 Input

• accessPoint: The local or remote domain access point name for which this entry provides the TDomain-specific configuration data.
• nwaddr: Specifies the network address associated with the access point
• lAccessPoint: a local domain access point found in the DM_LOCAL section for a TDomain session record in the BDMCONFIG file.
• parameters: A dictionary which includes the attributes and values.

This function invokes JMX interface SetTDomain () of the /T domain gateway Mbean.

5.8.7.46 Remote_Link_Statistics

This section contains the following topics:

• Syntax
  
• Output
  

5.8.7.46.1 Syntax

Remote_Link_Statistics()

5.8.7.46.2 Output

REMOTE_LINK_STATISTICS_MBEAN

Field Name	Description
TA_DMRACCESSPOINT	Remote Domain ID
TA_STATE	Connection Status
TA_MONINBOUNDNUM	Number of inbound network messages
TA_MONOUTBOUNDNUM	Number of outbound network messages
TA_MONINBOUNDBYT	Inbound network message size in bytes
TA_MONOUTBOUNDBYT	Outbound network message size in bytes
TA_MONNUMPEND	Pending Network Messages
TA_MONBYTESPEND	Pending Network Messages Bytes
TA_MONNUMWAITRPLY	Outstanding Network Requests
TA_CONTIME	Connection time, in seconds, since 00:00:00 UTC, January 1, 1970

5.8.7.47 Domain_Gateway_Transaction_Statistics

This section contains the following topics:

• Syntax
  
• Output
  

5.8.7.47.1 Syntax

Domain_Gateway_Transaction_Statistics()

5.8.7.47.2 Output

Field Name	Description
TA_NUMTRANCMT	For information about the MIB attributes, refer to Oracle® Tuxedo Reference Guide.
TA_NUMTRANABT
TA_TIMERESTART
TA_CURTIME

5.8.8 EventBrokerMbean

Inherited from MBean

• GetParameters
  
• GetParameter
  
• SetParameters
  
• SetParameter
  
• Delete
  
• Event_Statistics
  

5.8.8.1 GetParameters

This section contains the following topics:

• Syntax
  
• Output
  

5.8.8.1.1 Syntax

GetParameters()

5.8.8.1.2 Output

A dictionary which includes the attributes.

This function invokes JMX interface getParameters() of event broker Mbean.

5.8.8.2 GetParameter

This section contains the following topics:

• Syntax
  

5.8.8.2.1 Syntax

GetParameter(name)

This function invokes JMX interface getParameter() of event broker Mbean.

5.8.8.3 SetParameters

This section contains the following topics:

• Syntax
  
• Input
  

5.8.8.3.1 Syntax

SetParameters(data)

5.8.8.3.2 Input

data: A dictionary which includes the attributes.

This function invokes JMX interface setParameters() of event broker Mbean.

5.8.8.4 SetParameter

This section contains the following topics:

• Syntax
  

5.8.8.4.1 Syntax

SetParameter(name, value)

This function invokes JMX interface setParameter() of event broker Mbean.

5.8.8.5 Delete

This section contains the following topics:

• Syntax
  

5.8.8.5.1 Syntax

Delete()

This function invokes JMX interface delete() of event broker Mbean.

5.8.8.6 Event_Statistics

This section contains the following topics:

• Syntax
  
• Output
  

5.8.8.6.1 Syntax

Event_Statistics()

5.8.8.6.2 Output

Field Name	Description
TA_MONEVTSVCNUM	Notified Events
TA_MONEVTUNSOLNUM	Notified Events by Unsolicited Message
TA_MONEVTQUENUM	Notified Events by Queue Message
TA_MONEVTCMDNUM	Notified Events by Command Line
TA_MONEVTULOGNUM	Notified Events by USERLOG
TA_TIMERESTART	Restart Time, in seconds, since 00:00:00 UTC, January 1, 1970
TA_CURTIME	Current time, in seconds, since 00:00:00 UTC, January 1, 1970

5.8.9 QueueServerMbean

Inherited from MBean

• GetParameters
  
• GetParameter
  
• SetParameters
  
• SetParameter
  
• Delete
  
• Queue_Space_Statistics
  
• Queue_Space_Peak
  
• Queue_Statistics
  
• Tuxedo_Q_QSPACE
  
• Tuxedo_Q_QUEUE
  

5.8.9.1 GetParameters

• Syntax
  
• Output
  

5.8.9.1.1 Syntax

GetParameters()

5.8.9.1.2 Output

A dictionary which includes the attributes.

This function invokes JMX interface getParameters() of OTMQ Mbean.

5.8.9.2 GetParameter

This section contains the following topics:

• Syntax
  

5.8.9.2.1 Syntax

GetParameter(name)

This function invokes JMX interface getParameter() of OTMQ Mbean.

5.8.9.3 SetParameters

This section contains the following topics:

• Syntax
  
• Input
  

5.8.9.3.1 Syntax

SetParameters(data)

5.8.9.3.2 Input

data: A dictionary which includes the attributes.

This function invokes JMX interface setParameters() of OTMQ Mbean.

5.8.9.4 SetParameter

This section contains the following topics:

• Syntax
  

5.8.9.4.1 Syntax

SetParameter(name, value)

This function invokes JMX interface setParameter() of OTMQ Mbean.

5.8.9.5 Delete

• Syntax
  

5.8.9.5.1 Syntax

Delete()

This function invokes JMX interface delete() of OTMQ Mbean.

5.8.9.6 Queue_Space_Statistics

This section contains the following topics:

• Syntax
  
• Output
  

5.8.9.6.1 Syntax

Queue_Space_Statistics()

5.8.9.6.2 Output

Field Name	Description
TA_APPQSPACENAME	Following MIB Attributes in T_APPQSPACE is returned. For information about the attributes, refer to Oracle® Tuxedo Reference Guide
TA_STATE
TA_CURACTIONS
TA_CURCURSORS
TA_CURHANDLES
TA_CURMEMNONPERSIST
TA_CURMSG
TA_CURPROC
TA_CURQUEUES
TA_CURTMPQUEUES
TA_CURTRANS

5.8.9.7 Queue_Space_Peak

This section contains the following topics:

• Syntax
  
• Output
  

5.8.9.7.1 Syntax

Queue_Space_Peak()

5.8.9.7.2 Output

Field Name	Description
TA_APPQSPACENAME	Following MIB Attributes in T_APPQSPACE is returned. For information about the attributes, refer to Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference
TA_HWACTIONS
TA_HWCURSORS
TA_HWHANDLES
TA_HWMEMNONPERSIST
TA_HWMSG
TA_HWOWNERS
TA_HWPROC
TA_HWQUEUES
TA_HWTMPQUEUES
TA_HWTRANS

5.8.9.8 Queue_Statistics

This section contains the following topics:

• Syntax
  
• Output
  

5.8.9.8.1 Syntax

Queue_Statistics()

5.8.9.8.2 Output

QUEUE_STATISTICS_MBEAN

Field Name	Description
TA_APPQNAME	Following MIB Attributes in T_APPQ is returned. For information about the attributes, refer to Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference.
TA_APPQSPACENAME
TA_CURBLOCKS
TA_CURNONPERSISTBYTES
TA_CURMSG
TA_CURNONPERSISTMSG

5.8.9.9 Tuxedo_Q_QSPACE

• Syntax
  
• Output
  

5.8.9.9.1 Syntax

Tuxedo_Q_QSPACE()

5.8.9.9.2 Output

TUXEDO_ECM_SLASH_QUEUE_QSPACE_MBEAN

Field Name	Description
TA_APPQSPACENAME	Following MIB Attributes in T_APPQSPACE is returned. For information about the attributes, refer to Oracle Tuxedo File Formats, Data Descriptions, MIBs, and System Processes Reference
TA_QMCONFIG
TA_LMID
TA_IPCKEY
TA_ERRORQNAME
TA_MAXACTIONS
TA_MAXCURSORS
TA_MAXHANDLES
TA_MAXMSG
TA_MAXOWNERS
TA_MAXPAGES
TA_MAXPROC
TA_MAXQUEUES
TA_MAXTMPQUEUES
TA_MAXTRANS
TA_MEMNONPERSIST

5.8.9.10 Tuxedo_Q_QUEUE

• Syntax
  
• Output
  

5.8.9.10.1 Syntax

Tuxedo_Q_QUEUE()

5.8.9.10.2 Output

Field Name	Description
TA_APPQNAME	Following MIB Attributes in T_APPQ is returned. For information about the attributes, refer to Oracle® Tuxedo Reference Guide.
TA_APPQSPACENAME
TA_QMCONFIG
TA_LMID
TA_APPQORDER

5.8.10 WebServiceGatewayMbean

This section contains the following topics:

• GetParameter
  
• GetParameter
  
• SetParameter
  
• SetParameters
  
• Delete
  
• Web_Service_Gateway_Statistics
  

5.8.10.1 GetParameter

This section contains the following topic:

• Syntax
  

5.8.10.1.1 Syntax

GetParameter(parameterName)

This function invokes JMX interface getParameter(parameterName) of Tuxedo Web Service Gateway Mbean.

5.8.10.2 GetParameter

This section contains the following topics:

• Syntax
  

5.8.10.2.1 Syntax

GetParameters(parameterName)

This function invokes JMX interface getParameters(parameterName) of Tuxedo Web Service Gateway Mbean.

5.8.10.3 SetParameter

This section contains the following topics:

• Syntax
  

5.8.10.3.1 Syntax

SetParameter(parameterName, parameterValue)

This function invokes JMX interface setParameter(parameterName, parameterValue) of Tuxedo Web Service Gateway Mbean.

5.8.10.4 SetParameters

This section contains the following topics:

• Syntax
  
• Input
  

5.8.10.4.1 Syntax

SetParameters(date)

5.8.10.4.2 Input

The parameter “data” type is dictionary which includes parameter names and values. It’ll be converted to CompositeData type to invoke JMX interface.

This function invokes JMX interface setParameters(parameters) of Tuxedo Web Service Gateway Mbean.

5.8.10.5 Delete

This section contains the following topic:

• Syntax
  

5.8.10.5.1 Syntax

Delete()

This function invokes JMX interface delete() of Tuxedo Web Service Gateway Mbean.

5.8.10.6 Web_Service_Gateway_Statistics

This section contains the following topics:

• Syntax
  
• Output
  

5.8.10.6.1 Syntax

Web_Service_Gateway_Statistics()

5.8.10.6.2 Output

Field Name	Description
TA_MONTHRNUM	Active Threads
TA_MONINTALTIME	Inbound Process Time
TA_MONINREQNUM	Inbound request number
TA_MONOUTREQNUM	Outbound request number
TA_MONOUTALTIME	Outbound Process Time
TA_MONINOWFAIL	Inbound One-Way Failures
TA_MONINOWSUCC	Inbound One-Way Successes
TA_MONINRPCFAIL	Inbound RPC Failures
TA_MONINRPCSUCC	Inbound RPC Successes
TA_MONOUTOWFAIL	Outbound One-Way Failures
TA_MONOUTOWSUCC	Outbound One-Way Successes
TA_MONOUTRPCFAIL	Outbound RPC Failures
TA_MONOUTRPCSUCC	Outbound RPC Successes
TA_MONINBOUNDPEND	Inbound Pending Requests
TA_MONOUTBOUNDPEND	Outbound Pending Requests
TA_TIMERESTART	Restart Time, in seconds, since 00:00:00 UTC, January 1, 1970
TA_CURTIME	Current time, in seconds, since 00:00:00 UTC, January 1, 1970

5.8.11 WorkstationListenerMbean

This section contains the following topic

• GetParameter
  
• GetParameters
  
• SetParameter
  
• SetParameters
  
• Delete
  
• Get Handler Parameter
  
• Get Handlers
  
• Suspend Handler
  
• Resume Handler
  
• Kill Handler
  
• Get Clients
  
• Suspend Client
  
• Resume Client
  
• Kill Client
  
• Workstation_Listener_Statistics
  

5.8.11.1 GetParameter

The section contains the following topic:

• Syntax
  

5.8.11.1.1 Syntax

GetParameter(parameterName)

This function invokes JMX interface getParameter(parameterName) of Tuxedo Workstation Listener Mbean.

5.8.11.2 GetParameters

This section contains the following topic:

• Syntax
  
• Output
  

5.8.11.2.1 Syntax

GetParameters()

5.8.11.2.2 Output

The original type is CompositeData and the final output type is converted to dictionary.

This function invokes JMX interface getParameters() of Tuxedo Workstation Listener Mbean.

5.8.11.3 SetParameter

This section contains the following topics:

• Syntax
  

5.8.11.3.1 Syntax

SetParameter(parameterName, parameterValue)

This function invokes JMX interface setParameter(parameterName, parameterValue) of Tuxedo Workstation Listener Mbean.

5.8.11.4 SetParameters

• Syntax
  
• Input
  

5.8.11.4.1 Syntax

SetParameters(date)

5.8.11.4.2 Input

The parameter “data” type is dictionary which includes parameter names and values. It’ll be converted to CompositeData type to invoke JMX interface.

This function invokes JMX interface setParameters(parameters) of Tuxedo Workstation Listener Mbean.

5.8.11.5 Delete

This section contains the following topics:

• Syntax
  

5.8.11.5.1 Syntax

Delete()

This function invokes JMX interface delete() of Tuxedo Workstation Listener Mbean.

5.8.11.6 Get Handler Parameter

The section contains the following topic:

• Syntax
  

5.8.11.6.1 Syntax

GetHandlerParameter(clientId, parameterName)

This function invokes JMX interface getHandlerParameter() of Tuxedo Workstation Listener Mbean.

5.8.11.7 Get Handlers

The section contains the following topic:

• Syntax
  
• Output
  

5.8.11.7.1 Syntax

GetHandlers(ClientId)

5.8.11.7.2 Output

The original type is TabularData and the final output type is converted to list.

This function invokes JMX interface getHandlers(clientId) of Tuxedo Workstation Listener Mbean.

5.8.11.8 Suspend Handler

The section contains the following topic:

• Syntax
  

5.8.11.8.1 Syntax

SuspendHandler(clientId)

This function invokes JMX interface suspendHandler(clientId) of Tuxedo Workstation Listener Mbean.

5.8.11.9 Resume Handler

The section contains the following topic:

• Syntax
  

5.8.11.9.1 Syntax

ResumeHandler(clientId)

This function invokes JMX interface resumeHandler(clientId) of Tuxedo Workstation Listener Mbean.

5.8.11.10 Kill Handler

This section contains the following topic:

• Syntax
  

5.8.11.10.1 Syntax

KillHandler(clientId)

This function invokes JMX interface killHandler(clientId) of Tuxedo Workstation Listener Mbean.

5.8.11.11 Get Clients

This section contains the following topic:

• Syntax
  
• Output
  

5.8.11.11.1 Syntax

GetClients(wshClientID)

5.8.11.11.2 Output

The original type is TabularData and the final output type is converted to list.

This function invokes JMX interface getWSClients(clientId) of Tuxedo Workstation Listener Mbean.

5.8.11.12 Suspend Client

This section contains the following topic:

• Syntax
  

5.8.11.12.1 Syntax

SuspendClient(clientId)

This function invokes JMX interface suspendClient(clientId) of Tuxedo Workstation Listener Mbean.

5.8.11.13 Resume Client

This section contains the following topic:

• Syntax
  

5.8.11.13.1 Syntax

ResumeClient(clientId)

This function invokes JMX interface resumeClient(clientId) of Tuxedo Workstation Listener Mbean.

5.8.11.14 Kill Client

This section contains the following topic:

• Syntax
  

5.8.11.14.1 Syntax

KillClient(clientId)

This function invokes JMX interface killClient(clientId) of Tuxedo Workstation Listener Mbean.

5.8.11.15 Workstation_Listener_Statistics

This section contains the following topics:

• Syntax
  
• Output
  

5.8.11.15.1 Syntax

Workstation_Listener_Statistics()

5.8.11.15.2 Output

Field Name	Description
TA_CURHANDLERS	This field displays the number of currently active handlers associated with this workstation listener (WSL).
TA_CURCLIENTS	This field displays the number of clients, both native and workstation, currently logged in to this machine.
TA_TOTNUMREQ	Total Request Number
TA_OUTSREQNUM	Outstanding Requests
TA_TIMERESTART	This field displays the amount of time since restart.
TA_CURTIME	This field displays the current time (in seconds) since 00:00:00 UTC, January 1, 1970

5.8.12 JoltListenerMbean

This section contains the following topics:

• GetParameter
  
• GetParameters
  
• SetParameter
  
• SetParameters
  
• Delete JSL
  
• Get Handlers
  
• Suspend Handler
  
• Resume Handler
  
• Jolt_Listener_Statistics
  

5.8.12.1 GetParameter

This section contains the following topics:

• Syntax
  

5.8.12.1.1 Syntax

GetParameter(parameterName)

This function invokes JMX interface getParameter(parameterName) of Tuxedo Jolt Listener Mbean.

5.8.12.2 GetParameters

This section contains the following topics:

• Syntax
  
• Output
  

5.8.12.2.1 Syntax

GetParameters()

5.8.12.2.2 Output

The original type is CompositeData and the final output type is converted to dictionary.

This function invokes JMX interface getParameters() of Tuxedo Jolt Listener Mbean.

5.8.12.3 SetParameter

This section contains the following topics::

• Syntax
  

5.8.12.3.1 Syntax

SetParameter(parameterName, parameterValue)

This function invokes JMX interface setParameter(parameterName, parameterValue) of Tuxedo Jolt Listener Mbean.

5.8.12.4 SetParameters

This section contains the following topics:

• Syntax
  
• Input:
  

5.8.12.4.1 Syntax

SetParameters(date)

5.8.12.4.2 Input:

The parameter “data” type is dictionary which includes parameter names and values. It’ll be converted to CompositeData type to invoke JMX interface.

This function invokes JMX interface setParameters(parameters) of Tuxedo Jolt Listener Mbean.

5.8.12.5 Delete JSL

• Syntax
  

5.8.12.5.1 Syntax

Delete ()

This function invokes JMX interface delete() of Tuxedo Jolt Listener Mbean.

5.8.12.6 Get Handlers

• Syntax
  
• Output
  

5.8.12.6.1 Syntax

GetHandlers()

5.8.12.6.2 Output

The original type is TabularData and the final output type is converted to list.

This function invokes JMX interface getHandlers() of Tuxedo Jolt Listener Mbean.

5.8.12.7 Suspend Handler

• Syntax
  

5.8.12.7.1 Syntax

SuspendHandler(clientId)

This function invokes JMX interface suspendHandler(clientId) of Tuxedo Jolt Listener Mbean.

5.8.12.8 Resume Handler

• Syntax
  

5.8.12.8.1 Syntax

ResumeHandler(clientId)

This function invokes JMX interface resumeHandler(clientId) of Tuxedo Jolt Listener Mbean.

5.8.12.9 Jolt_Listener_Statistics

• Syntax
  
• Output
  

5.8.12.9.1 Syntax

Jolt_Listener_Statistics()

5.8.12.9.2 Output

LISTENER_STATISTICS_MBEAN

Field Name	Description
TA_CURHANDLERS	Active Handlers
TA_CURCLIENTS	Clients
TA_TOTREQNUM	Requests
TA_OUTSREQNUM	Outstanding Requests
TA_TIMERESTART	Restart Time, in seconds, since 00:00:00 UTC, January 1, 1970
TA_CURTIME	Current time, in seconds, since 00:00:00 UTC, January 1, 1970

5.8.13 ARTBatchSystemMbean

Inherited from MBean

• GetBatchs
  
• CancelBatch
  
• PurgeBatch
  
• HoldBatch
  
• ReleaseBatch
  
• GetBatchSysOuts
  
• SubmitBatch
  
• GetGDGFiles
  
• GetBatchFiles
  

5.8.13.1 GetBatchs

This section contains the following topics:

• Syntax
  
• Output
  

5.8.13.1.1 Syntax

GetBatchs(batchName, batchID, batchClass,
            batchOwner)

5.8.13.1.2 Output

A list which contains result.

This function invokes JMX interface getBatchs() of ART batch system Mbean.

5.8.13.2 CancelBatch

• Syntax
  
• Output
  

5.8.13.2.1 Syntax

CancelBatch(batchName, batchID, batchClass,
            batchOwner)

5.8.13.2.2 Output

A list which contains result.

This function invokes JMX interface cancelBatch() of ART batch system.

5.8.13.3 PurgeBatch

• Syntax
  
• Output
  

5.8.13.3.1 Syntax

PurgeBatch(batchName, batchID, batchClass,
            batchOwner)

5.8.13.3.2 Output

A list which contains result.

This function invokes JMX interface purgeBatch() of ART batch system Mbean.

5.8.13.4 HoldBatch

• Syntax
  
• Output
  

5.8.13.4.1 Syntax

HoldBatch(batchName, batchID, batchClass,
            batchOwner)

5.8.13.4.2 Output

A list which contains result.

This function invokes JMX interface holdBatch () of ART batch system Mbean.

5.8.13.5 ReleaseBatch

• Syntax
  
• Output
  

5.8.13.5.1 Syntax

ReleaseBatch(batchName, batchID, batchClass,
            batchOwner)

5.8.13.5.2 Output

A list which contains result.

This function invokes JMX interface releaseBatch() of ART batch system Mbean.

5.8.13.6 GetBatchSysOuts

• Syntax
  
• Output
  

5.8.13.6.1 Syntax

GetBatchSysOuts(batchID)

5.8.13.6.2 Output

A list which contains result.

This function invokes JMX interface getBatchSysOuts() of ART batch system Mbean.

5.8.13.7 SubmitBatch

• Syntax
  
• Output
  

5.8.13.7.1 Syntax

SubmitBatch (batchScript, batchOwner,
            batchEJROption,

batchShellOption, batchDBLogin, batchMTEnv)

5.8.13.7.2 Output

A list which contains result.

This function invokes JMX interface submitBatch() of ART batch system Mbean.

5.8.13.8 GetGDGFiles

• Syntax
  
• Output
  

5.8.13.8.1 Syntax

GetGDGFiles(batched, fileName)

5.8.13.8.2 Output

A dictionary which contains result.

This function invokes JMX interface getGDGFiles() of ART batch system Mbean.

5.8.13.9 GetBatchFiles

• Syntax
  
• Output
  

5.8.13.9.1 Syntax

GetBatchFiles()

5.8.13.9.2 Output

A list which contains result.

This function invokes JMX interface getBatchFiles () of ART batch system Mbean.