4 MBeans and JMX Operations
This chapter lists all the MBeans and related operations in JMX Agent.
- Admin MBean
- Tuxedo Domain MBean
- Tuxedo Machine MBean
- Tuxedo Group MBean
- Tuxedo Server MBean
- Tuxedo System Server Mbean
- Tuxedo Bridge MBean
- Tuxedo TMS Mbean
- Tuxedo /T Domain Gateway
- Tuxedo Mainframe Adapter Gateway for SNA
- Tuxedo Mainframe Adapter Gateway for TCP
- Tuxedo Web Service Gateway
- Tuxedo Workstation Listener
- Tuxedo Jolt Listener
- Tuxedo Event Broker
- Tuxedo Queue Server
- Tuxedo QTMQ Server
- Tuxedo ART Batch System Target
4.1 Admin MBean
MBean Name
DefaultJMXDomain:type=adminBean
- Boot Domain
- Change the domain to active state.
- Input
- tuxconfig: The tuxconfig path of master machine.
- Signature
void bootDomain(String tuxconfig, Boolean onlyAppServers, boolean onlyAdminServers) throws USGException, SYSException, TUXException
- Shutdown Domain
- Make the domain to deactive state. When onlyAppServers and onlyAdminServers are false, this method stops all administrative, TMS, and gateway servers, and servers listed in the SERVERS section of the configuration file named by the TUXCONFIG environment variable, and removes the IPC resources associated with them. For each group, all servers in the SERVERS section, if any, are shut down, followed by any associated gateway servers (for foreign groups) and TMS servers. Administrative servers are shut down last. Application servers without SEQUENCE parameters are shut down first in reverse order of the server entries in the configuration file, followed by servers with SEQUENCE parameters that are shut down from high to low sequence number. If two or more servers in the SERVERS section of the configuration file have the same SEQUENCE parameter, this method may shut down these servers in parallel. Each entry in the SERVERS section may have an optional MIN and MAX parameter.
- Boot Machine
- For each group whose associated LMID parameter is lmid, all TMS and gateway servers associated with the group are booted and all servers in the SERVERS section associated with those groups are executed.
- Signature
void bootMachine(String tuxconfig, String lmid, Boolean isBootBBL) throws USGException, SYSException, TUXException- Shutdown Machine
- For each group whose associated LMID parameter is lmid, all servers in the SERVERS section associated with the group are shut down, followed by any TMS and gateway servers associated with the group.
- Signature
void bootGroup(String tuxconfig, String grpname)throws USGException, SYSException, TUXException
- Shutdown Group
- All servers in the SERVERS section associated with the specified group (that is, for which the SRVGRP parameter is set to grpname) are shut down, followed by all TMS and gateway servers for the group. TMS servers are shut down based on the TMSNAME and TMSCOUNT parameters for the group entry. For a foreign group, the gateway servers for the associated entry in the HOST section are shut down based on GATENAME and GATECOUNT. Shutting down a gateway implies not only that the process itself is stopped; it also implies that the administrative service for the gateway and all advertised foreign services are unadvertised.
Note:
Must connect the JMX Agent in the master machine.- Signature
void shutdownGroup(String tuxconfig, String grpname, Integer delay, String signal)throws USGException, SYSException, TUXException, JMXConnectionException- Boot Server
- All servers in the SERVERS section whose SRVID parameter is serverID are executed.
- Input
- tuxconfig: The tuxconfig path of the machine which group is located in. groupname: The namename of Tuxedo group. serverID: The SVRID
- Signature
void bootServer(String tuxconfig, String groupname, Integer serverID) throws USGException, SYSException, TUXException
- Activate All Servers with Same Name
- All servers in the SERVERS section are executed by server name and MIN value. Servers with a MIN=0 value are not executed.
- Input
- tuxconfig: The tuxconfig path of the machine which the group is located in. aout: The Tuxedo server name
- Signature
- void bootServer(String tuxconfig, String aout) throws USGException, SYSException, TUXException
- Boot Server
- All servers in the SERVERS section whose SRVID parameter is serverID are executed.
- Activate All Servers with Same Name
- All servers in the SERVERS section are executed by server name and MIN value. Servers with a MIN=0 value are not executed. Note: Must connect the JMX Agent in the master machine.
- Input
- tuxconfig: The tuxconfig path of the machine which the group is located in.
- Signature
void bootServer(String tuxconfig, String aout)throws USGException, SYSException, TUXException- Input
- tuxconfig: The tuxconfig path of the machine which group is located in.
- Signature
void bootServer(String tuxconfig, String groupname, Integer serverID) throws USGException, SYSException, TUXException
- Shutdown Server
- All servers in the SERVERS section for which the SRVID parameter is set to serverID are shut down. Do not enter a value for SRVID greater than 30,000; this indicates system processes (that is, TMSs or gateway servers) that should only be shut down via the shutdownMachine or shutdownGroup.
Parent topic: MBeans and JMX Operations
4.2 Tuxedo Domain MBean
Parent topic: MBeans and JMX Operations
4.2.1 MBean Name
“<DOMAINID>_<IPCKEY>:type=tuxedo_domain”.
Parent topic: Tuxedo Domain MBean
4.2.1.1 Operations
- CreateMachine
- Create a Tuxedo machine instance and an MBean with tuxedo_machine type. The machine target will not be booted after the creation action. You need to create the bridge target then boot the machine.
- Signature
-
void createMachine (String pmid, String lmid, String tuxconfig, String tuxdir, String appdir) throws MBeanException, SYSException,TUXException, JMXConnectionException, USGException
- Signature
-
CompositeData getParameters() throws SYSException, JMXConnectionException, TUXException, OpenDataException;
- Signature
-
Object getParameter(String parameterName) throws USGException, TUXException, SYSException, JMXConnectionException;
- SetParameter
- Set value for the attribute in T_DOMAIN which has the same IPCKEY with this MBean.
- Input:
- parameterName The MIB attribute name.
- Signature
-
void setParameter(String parameterName, Object parameterValue) throws TUXException, USGException, SYSException, JMXConnectionException, MBeanException;
| MIB attribute Type | OpenType |
|---|---|
| string | String |
| int | Integer |
| short | Short |
| long | Long |
| carray | String |
- Signature
Object setParameters(CompositeData parameters) throws USGException, SYSException, TUXException, JMXConnectionException, MBeanException;
- Get Routings
- Get the routings from T_ROUTING class.
- Signature
- TabularData getRoutings () throws SYSException, TUXException, JMXConnectionException;
- Add Routing
- Add routing to T_ROUTING class. Please make sure the MAXRFT and MAXDRT is validate for add routing.
- Input:
-
Parameter Name Corresponding MIB Attribute routingNameTA_ROUTINGNAMEroutingTypeTA_ROUTINGTYPEbufTypeTA_BUFTYPEfieldTA_FIELDrangesTA_RANGES
- Signature
void addRouting(String routingName, String routingType, String bufType, String field, String ranges) throws SYSException, TUXException, JMXConnectionException, OpenDataException;- Delete Routing
- Delete routing from this domain.
- Input:
-
Parameter Name Corresponding MIB Attribute routingNameTA_ROUTINGNAMEbufTypeTA_BUFTYPEfieldTA_FIELDtypeTA_TYPE
- Signature
-
void deleteRouting(String routingName, String buftype , String field, String type) throws SYSException, TUXException, JMXConnectionException;
- Set Routing Parameters
- Set the attributes value in T_ROUTING.
- Input:
-
Parameter Name Corresponding MIB Attribute routingNameTA_ROUTINGNAME bufTypeTA_BUFTYPE fieldTA_FIELD typeTA_TYPE parametersThe list of MIB attributes and values in the format of CompositeData.
- Signature
-
void setRoutingParameters (String routingName, String buftype, String field, String type, CompositeData parameters) throws USGException, TUXException, JMXConnectionException, SYSException;
- Set Routing Parameter
- Set the attribute value in T_ROUTING.
- Input:
-
Parameter Name Corresponding MIB Attribute routingNameTA_ROUTINGNAME bufTypeTA_BUFTYPE fieldTA_FIELD typeTA_TYPE parameterNameThe MIB attribute Name parameterValueThe MIB attribute value
- Signature
void setRoutingParameter(String routingName, String buftype, String field, String type, String parameterName, String parameterValue) throws JMXConnectionException, SYSException, USGException, TUXException;- Get Routing Parameter
- Get the attribute’s value in T_ROUTING.
- Input:
-
Parameter Name Corresponding MIB Attribute routingNameTA_ROUTINGNAME bufTypeTA_BUFTYPE fieldTA_FIELD typeTA_TYPE parameterNameThe MIB attribute Name
- Signature:
-
Object getRoutingParameter(String routingName, String buftype, String field, String type, String parameterName) USGException, TUXException, JMXConnectionException, SYSException; - Swap
- Swap the master and backup which is configured in MASTER parameter.
- Signature
-
void swap() throws TUXException, JMXConnectionException,SYSException
Parent topic: MBean Name
4.3 Tuxedo Machine MBean
This section contains the following topics:
Parent topic: MBeans and JMX Operations
4.3.1 MBean Name
“<DOMAINID>_<IPCKEY>:type= tuxedo_machine,LMID=<LMID>”.Parent topic: Tuxedo Machine MBean
4.3.1.1 Operations
- Create Group
- Create a Tuxedo group instance and an MBean with tuxedo_group type. The created target is not active. You need to invoke the active method for the activation.
- Signature
-
void createGroup (String groupName, Integer groupNo) throws SYSException, MBeanException, USGException, TUXException, JMXConnectionException - Create Bridge
- Create a Tuxedo Bridge instance and an MBean with tuxedo_bridge type. The created target is not active. You need to invoke the active method for the activation.
- Signature
-
void createBridge (String lmid, String naddr, String nlsaddr) throws SYSException, MBeanException, USGException, TUXException, JMXConnectionException - GetParameter
- Get value for the attribute in T_MACHINE which has the same LMID with this MBean.
- Input:
- parameterName: The MIB attribute name.
- Signature
- Object getParameter(String parameterName) throws USGException, TUXException, SYSException, JMXConnectionException;
- GetParameters
- Get value for all attributes in T_ MACHINE which has the same LMID with this MBean.
- Signature
-
compositeData getParameters() throws SYSException, JMXConnectionException, TUXException, OpenDataException;
- Signature
-
void setParameter(String parameterName, String parameterValue) throws TUXException, USGException, SYSException, JMXConnectionException, MBeanException;
- Input
- Refer to the input for SetParameters
- Signature
-
Object setParameters(CompositeData parameters) throws USGException, SYSException, TUXException, JMXConnectionException, MBeanException; - deleteRecursively
- Delete all the Tuxedo instances and child instances associated with the MBean
- Signature
-
void deleteRecursively () throws MBeanException, TUXException, JMXConnectionException, SYSException, USGException; - Delete
- Delete the Tuxedo instances associated with this MBean.
Note:
MBeans which located at the same machine with this target must be deleted first.
- Signature
-
void delete() throws TUXException, USGException, SYSException, JMXConnectionException, MBeanException;
- Migrate
- All servers running on the machine are migrated to their alternate location. RESTART=Y must be configured in server section for all the servers which need be migrated.
- Clean
- Initiate cleanup/scanning activities on and relating to the indicated machine. If there are dead clients or servers on the machine, they will be detected at this time. If the machine has been partitioned from the application MASTER site, global bulletin board entries for that machine will be removed. This combination is allowed when the application is in the
ACTivestate and the machine is in either theACTiveorPARtitionedstate. Successful return for a non-partitioned machine leaves the state unchanged. Successful return for a partitioned machine leaves the object in theINActivestate. - Signature
void clean() throws MBeanException, JMXConnectionException, TUXException, SYSException
- Get Native Clients
- Get all the native clients which are running on the machine.
- Output
-
Column Name Note TA_CLIENTIDKeyTA_CLTNAME- TA_USRNAME- TA_TIMESTART- TA_IDLETIME- TA_STATE-
- Signature
-
TabularData getNativeClients() throws TUXException, JMXConnectionException, SYSException - Suspend
- Suspend the client from making service requests
(
tpcall()ortpacall()), initiating conversations (tpconnect()), beginning transactions (tpbegin()), and enqueuing new requests (tpenqueue()). Clients within a transaction will be permitted to make these calls until they abort or commit the current transaction, at which time they will become suspended. Invocations of these routines will result in aTPESYSTEMerror return and a system log message being generated indicating the situation. State change allowed only when in theACTivestate. Successful return leaves the object in theSUSpendedstate.
- Resume
- Change the client`s state from “SUSpended” to “ACTive”. Successful return leaves the object in the “ACTive” state.
- Input
- clientID: Client identifier.
- Signature
-
void resume(String clientId) throws TUXException, SYSException, JMXConnectionException
- Kill Client
- Abortively deactivate the client. State change allowed only when in the “ACTive” or “SUSpended” state. Limitation: The system may not be able to kill the client due to platform or signaling restrictions. In this case, a native client will be abortively terminated at its next access to ATMI.
- Input
- clientId: Client identifier.
- Signature
-
void killClient(String clientId) throws TUXException, SYSException, JMXConnectionException
| Column Name | Note |
|---|---|
TA_COORDLMID
|
- |
TA_TPTRANID
|
Key
|
TA_XID
|
- |
TA_STATE
|
- |
TA_TIMEOUT
|
- |
TA_GRPCOUNT
|
- |
TA_GRPINDEX
|
- |
TA_GRPNO
|
- |
TA_GSTATE
|
- |
- Abort Transaction
- Abort the transaction for the application. State change allowed only when in the ACTive, ABortonlY, or COMcalled states. Successful return leaves the transaction in the ABorteD state.
- Input
- TPTRANID: (TA_TPTRANID) Transaction identifier as returned from tpsuspend() mapped to a string representation.
- Signature
-
void abortTransaction(StringTPTRANID, String XID) throws TUXException, JMXConnectionException, SYSException - Get ULOGs
- Get ULOGs in the machine.
- Input
- date: Date of user log file found or to be accessed. In the format of MMDDYY
Parent topic: MBean Name
4.4 Tuxedo Group MBean
This section contains the following topics:
Parent topic: MBeans and JMX Operations
4.4.1 MBean Name
“<DOMAINID>_<IPCKEY>:type=tuxedo_group,group_name=<GROUPNAME>”.
Parent topic: Tuxedo Group MBean
4.4.1.1 Operations
- Create Server
- Create a Tuxedo Server instance and an MBean with tuxedo_server/tuxedo_system_server/ tuxedo_domain_gateway/ tuxedo_event_broker/ tuxedo_jolt_listener/ tuxedo_TMA_gateway_SNA/ tuxedo_TMA_gateway_TCP/ tuxedo_LMS/ tuxedo_webservice_gateway/ tuxedo_workstation_listener type depends on the aoutserver name.
- Signature
-
void createServer (String aout, Integer srvID) throws SYSException, MBeanException, USGException, TUXException, JMXConnectionException; - GetParameter
- Get value for the attribute in T_GROUP which has the same group name with this MBean.
- Input:
- parameterName: The MIB attribute name.
- Signature
-
void setParameter(String parameterName, String parameterValue) throws TUXException, USGException, SYSException, JMXConnectionException, MBeanException; - GetParameters
- Get values for all attribute in T_ GROUP which has the same group name with this MBean.
- Signature
-
CompositeData getParameters() throws SYSException, JMXConnectionException, TUXException, OpenDataException; - SetParameter
- Set value for the attribute in T_ GROUP which has the same group name with this MBean.
- Input:
- parameterName: The MIB attribute name.
- Signature:
-
void setParameter(String parameterName, String parameterValue) throws TUXException, USGException, SYSException, JMXConnectionException, MBeanException; - SetParameters
- Set value for the attributes in T_ GROUP which has the same group name with this MBean.
- Input
- Refer to the input for SetParameters
- Signature
-
Object setParameters(CompositeData parameters) throws USGException, SYSException, TUXException, JMXConnectionException, MBeanException; - CreateTMS
- Create TMS.
| Parameter Name | Corresponding MIB Attribute | Notes |
|---|---|---|
rmsName
|
TA_RMSNAME | Those fields can be set to null for the TMS configured on Group section. |
rmid
|
TA_RMID | |
tmsName
|
TA_TMSNAME | - |
- Signature
-
void createTMS (String rmsName, Integer rmid, String tmsName); - deleteRecursively
- Delete all the Tuxedo instances and Child instances associated with the MBean
- Signature
-
void deleteRecursively () throws MBeanException, TUXException, JMXConnectionException, SYSException, USGException;
- Delete
- Delete all Tuxedo instances associated with the MBean.
- Signature
-
void delete() throws TUXException, USGException, SYSException, JMXConnectionException, MBeanException; - Migrate
- If the configuration file specifies the
MIGRATEoption and an alternate location for the group, all servers in the group are migrated to the alternate location.Note:
TheRESTRART=Ymust be configured in ubbconfig for all the servers which need migration. must be configured in ubbconfig for all the servers which need migration. - Signature
void migrate()throws Exception
Parent topic: MBean Name
4.5 Tuxedo Server MBean
This section contains the following topics:
Parent topic: MBeans and JMX Operations
4.5.1 MBean Name
“<DOMAINID>_<IPCKEY>: tuxedo_server,group_name=< SRVGRP>, SRVID=<SRVID>”.Parent topic: Tuxedo Server MBean
4.5.1.1 Operations
- GetParameter
- Get value for the attribute in T_SERVER which has the same SRVID and SRVGRP with this MBean.
- Input:
- parameterName: The MIB attribute name. For example: “TA_MAX”.
- Signature
-
Object getParameter(String parameterName) throws USGException, TUXException, SYSException, JMXConnectionException; - GetParameters
- Get all attribute and values in T_ SERVER with the MBean’s SRVID and SRVGRP.
- Signature
-
CompositeData getParameters() throws SYSException, JMXConnectionException, TUXException, OpenDataException; - SetParameter
- Set value for the attribute in T_ SERVER which has the same SRVID and SRVGRP with this MBean.
- Input:
- parameterName: The MIB attribute name.
- Signature:
-
void setParameter(String parameterName, String parameterValue) throws TUXException, USGException, SYSException, JMXConnectionException, MBeanExcepti - SetParameters
- Set value for the attributes in T_ SERVER which has the same SRVID and SRVGRP with this MBean.
- Input
- Refer to the input for SetParameters
- Signature
-
OObject setParameters(CompositeData parameters) throws USGException, SYSException, TUXException, JMXConnectionException, MBeanException; - Delete
- Delete both the MBean and all Tuxedo instances associated with the MBean.
- Signature
void delete() throws TUXException, USGException, SYSException, JMXConnectionException, MBeanException;- Set Service parameter
- Set value for the attribute in T_ SERVICE which has the same SRVID and SRVGRP with this MBean.
- Input
- serviceName: name of service.
- Signature
void setServiceParameter(String serviceName, String parameterName, String parameterValue) throws TUXException, SYSException, JMXConnectionException, USGException;- Get Service Parameter
- Get the value of attribute in T_ SERVICE which has the same SRVID and SRVGRP with this MBean.
- Input
- serviceName: name of service.
- Signature
Object getServiceParameter(String serviceName, String parameterName) throws MBeanException, TUXException, JMXConnectionException,SYSException;- Delete Service
- Delete service from T_SERVICE.
- Input
- serviceName: name of Tuxedo service.
- Signature
Object deleteService (String serviceName) throws SYSException, TUXException, USGException, JMXConnectionException, MBeanException;- Get Service
- Get all the services from T_SERVICE
- Output
- TablarData columns:
| Column Name | Note |
|---|---|
TA_ROUTINGNAME
|
- |
TA_BUFTYPE
|
- |
TA_STATE
|
- |
TA_AUTOTRAN
|
- |
TA_LOAD
|
- |
TA_PRIO
|
- |
TA_SVCTIMEOUT
|
- |
TA_TRANTIME
|
- |
TA_SVCTYPE
|
- |
TA_SVCRNAM
|
- |
- Signature
-
TabularData getServices()throws SYSException, TUXException, JMXConnectionException - Suspend Service
- Limitation: State change not permitted for service names
(
TA_SERVICENAME) beginning with the reserved string “_”. - Input
- serviceName: TA_SERVICENAME Service name.
- Signature
-
void suspendService(String serviceName) throws USGException, JMXConnectionException, TUXException, SYSException - Resume Service
- Activate (advertise) the service instance. State change allowed only when in the “INActive”, “SUSpended” or “INValid” states. For the purpose of determining permissions for this state transition, the active object permissions are considered (that is, --x--x--x). Successful return leaves the object in the “ACTive” state.
Parent topic: MBean Name
4.6 Tuxedo System Server Mbean
Following server be modeled as system server MBean.
| system server MBean |
|---|
| AUTHSVR |
| GAUTHSVR |
| KAUTHSVR |
| LAUTHSVR |
| TMMETADATA |
| TMQFORWARD |
| DMADM |
| GWADM |
| JREPSVR |
MBean Name
“<DOMAINID>_<IPCKEY>:type=tuxedo_system_server,group_name=<GROUPNAME>,SRVID=<SRVID>”.
Parent topic: MBeans and JMX Operations
4.6.1 Operations
- GetParameter
- Get value for the attribute in T_SERVER which has the same SRVID and SRVGRP with this MBean.
- Input:
- parameterName: The MIB attribute name. For example: “TA_MAX”.
- Signature
-
Object getParameter(String parameterName) throws USGException, TUXException, SYSException, JMXConnectionException; - GetParameters
- Get all attribute and values in T_ SERVER which has the same SRVID and SRVGRP with this MBean.
- Signature
-
CompositeData getParameters() throws SYSException, JMXConnectionException, TUXException, OpenDataException; - SetParameter
- Set value for the attribute in T_ SERVER which has the same SRVID and SRVGRP with this MBean.
- Input:
- parameterName: The MIB attribute name.
- Signature:
-
void setParameter(String parameterName, String parameterValue) throws TUXException, USGException, SYSException, JMXConnectionException, MBeanException; - SetParameters
- Set value for the attributes in T_ SERVER which has the same SRVID and SRVGRP with this MBean.
- Input
- Refer to the input for SetParameters
- Signature
-
Object setParameters(CompositeData parameters) throws USGException, SYSException, TUXException, JMXConnectionException, MBeanException; - Delete
- Delete both the MBean and all Tuxedo instances associated with the MBean.
- Signature
-
void delete() throws TUXException, USGException, SYSException, JMXConnectionException, MBeanException;
Parent topic: Tuxedo System Server Mbean
4.7 Tuxedo Bridge MBean
Parent topic: MBeans and JMX Operations
4.7.1 MBean Name
“<DOMAINID>_<IPCKEY>:type= tuxedo_bridge, LMID=<LMID>”.LMID: specify the LMID parameter associated with the Tuxedo Machine where the bridge is running.Parent topic: Tuxedo Bridge MBean
4.7.1.1 Operations
- GetParameter
- Get value for the attribute in T_BRIDGE which has the same LMID with this MBean.
- Input:
- parameterName: The MIB attribute name. For example: “TA_SENTNUM”.
- Signature
Object getParameter(String parameterName) throws USGException, TUXException, SYSException, JMXConnectionException;- GetParameters
- Get all attribute and values in T_ BRIDGE with which has the same LMID with this MBean.
- Signature
-
CompositeData getParameters() throws SYSException, JMXConnectionException, TUXException, OpenDataException; - Get Remote Link Parameter
- Get remote link`s parameter value.
- Input:
- remoteLMID: The LMID for remote machine.
- Signature
-
Object getRemoteLinkParameter(String remoteLMID, String parameterName) throws TUXException,JMXConnectionException, SYSException; - Get Remote Links
- Get all network connections in this bridge server.
- Output
-
Column Name Note TA_LMIDKey TA_STATEString
- Signature
-
TabularData getRemoteLinks ()throws TUXException, JMXConnectionException, SYSException - Set Remote Link Parameters
- Set the parameter for remote link in T_BRIDGE class
- Signature
-
setRemoteLinkParameters(String remoteLMID, CompositeData parameters) throws TUXException, JMXConnectionException, SYSException, USGException - Suspend Remote Link
- Suspend the
remote linkby closing the connection between the indicated logical machines. State change allowed only when in theACTivestate. Successful return leaves the object in theSUSpendedstate. Limitation: Note that since the statistics reported are from the viewpoint of the source logical machine, resetting those statistics will cause them to be out of sync with the statistics reported by the destination logical machine for the same connection. - Input
- remoteLmid: Remote machine's LMID.
- Signature
-
void suspend (String remoteLmid)throws USGException, TUXException, SYSException, JMXConnectionException; - Resume Remote Link
- Reactivate the connection. This operation will fail if remoteLmid is null, if the remoteLmid is equals to the bridge Mean’s lmid, if either of the two machines is not active, or if the source logical machine is not reachable. For the purpose of determining permissions for this state transition, the active object permissions are considered (that is, --x--x--x). Successful return leaves the object in the PENding state.
- Input
- remoteLmid: Remote machine's LMID.
- Signature
-
void resume(String remoteLmid)throws USGException, TUXException, SYSException, JMXConnectionException - Deactivate Remote Link
- Close the connection between the indicated logical machines.
This operation will fail if only remoteLmid is null, if the
remoteLmid is equals to the bridge mbean`s lmid or if the two
machines are not connected. State change allowed only when in the
ACTivestate. Successful return leaves the object in theINActivestate. - Input
- remoteLmid: Remote machine's LMID.
- Signature
-
void deactive(String remoteLmid)throws USGException, TUXException, SYSException, JMXConnectionException
Parent topic: MBean Name
4.8 Tuxedo TMS Mbean
Parent topic: MBeans and JMX Operations
4.8.1 MBean Name
“<DOMAINID>_<IPCKEY>:type= tuxedo_TMS,group_name=<GROUPNAME>,aout=<TMSNAME>,rmsname=<RMSNAME>”.RMSNAME: specifies the RMSNAME parameter associated with the Tuxedo TMS.
Parent topic: Tuxedo TMS Mbean
4.8.1.1 Operations
- GetParameter
- Get value for the attribute in T_SERVER which has the same SRVID, SRVGRP, RMSNAME and TMSNAME with this MBean.
- Input:
- parameterName: The MIB attribute name.
- Signature
-
Object getParameter(String parameterName) throws USGException, TUXException, SYSException, JMXConnectionException; - GetParameters
- Get all attribute and values in T_ SERVER which has the same SRVID, SRVGRP, RMSNAME and TMSNAME with this MBean.
- Signature
-
CompositeData getParameters() throws SYSException, JMXConnectionException, TUXException, OpenDataException;
- SetParameter
- Set value for the attribute in T_ SERVER which has the same SRVID, SRVGRP, RMSNAME and TMSNAME with this MBean.
- Input:
- parameterName: The MIB attribute name.
- Signature:
-
void setParameter(String parameterName, String parameterValue) throws TUXException, USGException, SYSException, JMXConnectionException, MBeanException; - SetParameters
- Set value for the attributes in T_ SERVER which has the same SRVID, SRVGRP, RMSNAME and TMSNAME with this MBean.
- Input
- Refer to the input for “SetParameters”
- Signature
-
Object setParameters(CompositeData parameters) throws USGException, SYSException, TUXException, JMXConnectionException, MBeanException; - Delete
- Delete both the MBean and all Tuxedo instances associated with the MBean.
- Signature
-
void delete() throws TUXException, USGException, SYSException, JMXConnectionException, MBeanException;
Parent topic: MBean Name
4.9 Tuxedo /T Domain Gateway
Parent topic: MBeans and JMX Operations
4.9.1 MBean Name
“<DOMAINID>_<IPCKEY>:type= tuxedo_domain_gateway,group_name=<GROUPNAME>,SRVID=<SRVID>”.Parent topic: Tuxedo /T Domain Gateway
4.9.1.1 Operations
- GetParameters
- Refer to GetParameters
- SetParameter
- Refer to SetParameter
- SetParameters
- Refer to SetParameters
- Delete
- Refer to Delete
Parent topic: MBean Name
4.10 Tuxedo Mainframe Adapter Gateway for SNA
Parent topic: MBeans and JMX Operations
4.10.1 MBean Name
“<DOMAINID>_<IPCKEY>:type= tuxedo_TMA_gateway_SNA,group_name=<GROUPNAME>,SRVID=<SRVID>”.Parent topic: Tuxedo Mainframe Adapter Gateway for SNA
4.10.1.1 Operations
- GetParameter
- Refer to GetParameter
- GetParameters
- Refer to GetParameters
- SetParameter
- Refer to SetParameter
- SetParameters
- Refer to SetParameters
- Delete
- Refer to Delete
Parent topic: MBean Name
4.11 Tuxedo Mainframe Adapter Gateway for TCP
Parent topic: MBeans and JMX Operations
4.11.1 MBean Name
“<DOMAINID>_<IPCKEY>:type= tuxedo_TMA_gateway_TCP,group_name=<GROUPNAME>,SRVID=<SRVID>”.Parent topic: Tuxedo Mainframe Adapter Gateway for TCP
4.11.2 Operations
- GetParameter
- Refer to GetParameter
- GetParameters
- Refer to Operations
- SetParameter
- Refer SetParameter
- SetParameters
- Refer to SetParameters
- Delete
- Refer to Delete
Parent topic: Tuxedo Mainframe Adapter Gateway for TCP
4.12 Tuxedo Web Service Gateway
Parent topic: MBeans and JMX Operations
4.12.1 MBean Name
“<DOMAINID>_<IPCKEY>:type= tuxedo_webservice_gateway,group_name=<GROUPNAME>,SRVID=<SRVID>”.Parent topic: Tuxedo Web Service Gateway
4.12.1.1 Operations
- GetParameter
- Refer to GetParameter
- GetParameters
- Refer to GetParameters
- SetParameter
- Refer to SetParameter
- SetParameters
- Refer to SetParameters
- Delete
- Refer to Delete
Parent topic: MBean Name
4.13 Tuxedo Workstation Listener
Parent topic: MBeans and JMX Operations
4.13.1 MBean Name
“<DOMAINID>_<IPCKEY>:type= tuxedo_workstation_listener,group_name=<GROUPNAME>,SRVID=<SRVID>”.Parent topic: Tuxedo Workstation Listener
4.13.1.1 Operations
- GetParameter
- Get value for the attribute in T_WSL .
- Input:
- parameterName: The MIB attribute name.
- Signature
-
Object getParameter(String parameterName) throws USGException, TUXException, SYSException, JMXConnectionException; - GetParameters
- Get all attribute and values in T_ WSL.
- Signature
-
CompositeData getParameters() throws SYSException, JMXConnectionException, TUXException, OpenDataException; - SetParameter
- Set value for the attribute in T_ WSL.
- Input:
- parameterName: The MIB attribute name.
- Signature:
-
void setParameter(String parameterName, String parameterValue) throws TUXException, USGException, SYSException, JMXConnectionException, MBeanException; - SetParameters
- Input
- Refer to the input for SetParameters
- Set value for the attributes in T_ WSL.
- Refer to the input for SetParameters
- Input
- Refer to the input for SetParameters
- Signature
-
Object setParameters(CompositeData parameters) throws USGException, SYSException, TUXException, JMXConnectionException, MBeanException;
- Delete
- Refer to Delete
- Signature
- Object getHandlerParameter(String clientId, String parameterName) throw USGException, TUXException, JMXConnectionException, SYSException;
- Get Handlers
- Get all handlers associated with the WSL.
- Signature
-
TabularData getHandlers(String clientId) throws TUXException, JMXConnectionException, SYSException;
- Suspend Handler
- Change the State of WSH to “SUSpended”. Note: State changes to the “SUSpended” state are transitive to all clients associated with this WSH as is the resetting of a “SUSpended” WSH to “ACTive”. Additionally, “SUSpended” WSH clients will not be assigned any additional incoming clients by the WSL.
- Signature
-
void suspendHandler (String clientId) throws TUXException, JMXConnectionException, SYSException, USGException, MBeanException; - Resume Handler
- Set the State of WSH to “ACTive”.
- Input
- clientId: Client identifier for this WSH.
- Signature
-
void resumeHandler (String clientId)) throws TUXException, JMXConnectionException, SYSException, USGException, MBeanException; - Kill Handler
- Set the State of WSH to “DEAD”, and all connections being handled by the targeted WSH to be dropped abortively.
- Input
- clientId: Client identifier for this WSH.
- Signature
-
void killHandler (String clientId) throws TUXException, JMXConnectionException, SYSException, MBeanException, USGException; - Get Clients
- Get all the clients associated with the WSH.
- Input
- wshClientID: WSH`s identifier.
- Signature
-
TabularData getWSClients(String wshClientID) throws TUXException, JMXConnectionException, SYSException - Suspend Client
- Suspend the
clientobject from making service requests (tpcall()ortpacall()), initiating conversations (tpconnect()), beginning transactions (tpbegin()), and enqueuing new requests (tpenqueue()). Clients within a transaction will be permitted to make these calls until they abort or commit the current transaction, at which time they will become suspended. Invocations of these routines will result in aTPESYSTEMerror return and a system log message being generated indicating the situation. State change allowed only when in theACTivestate. Successful return leaves the object in theSUSpendedstate. - Input:
- clientId: Client identifier.
- Signature
-
Void suspendClient(String clientId) throws TUXException, JMXConnectionException, SYSException; - Resume Client
- Activate a
SUSpendedclient object. State change allowed only when in theSUSpendedstate. Successful return leaves the object in theACTivestate. - Input:
- clientId: Client identifier.
- Signature:
-
void resumeClient (String clientId) throws TUXException, JMXConnectionException, SYSException;
Parent topic: MBean Name
4.14 Tuxedo Jolt Listener
Parent topic: MBeans and JMX Operations
4.14.1 MBean Name
“<DOMAINID>_<IPCKEY>:type= tuxedo_jolt_listener,group_name=<GROUPNAME>,SRVID=<SRVID>”.Parent topic: Tuxedo Jolt Listener
4.14.1.1 Operations
- GetParameter
- Get value for the attribute in T_JSL .
- Input:
- parameterName: The MIB attribute name.
- Signature
-
Object getParameter(String parameterName) throws USGException, TUXException, SYSException, JMXConnectionException; - GetParameters
- Get all attribute and values in T_ JSL.
- Signature
-
CompositeData getParameters() throws SYSException, JMXConnectionException, TUXException, OpenDataException; - SetParameter
- Set value for the attribute in T_ JSL.
- Input:
- parameterName: The MIB attribute name.
- Signature:
-
void setParameter(String parameterName, String parameterValue) throws TUXException, USGException, SYSException, JMXConnectionException, MBeanException; - SetParameters
- Set value for the attributes in T_ JSL.
- Input
- Refer to the input for “SetParameters
- Signature
-
Object setParameters(CompositeData parameters) throws USGException, SYSException, TUXException, JMXConnectionException, MBeanException; - Delete JSL
- Refer to Delete
- Get Handlers
- Get all handlers associated with the JSL.
- Signature
-
TabularData getHandlers() throws TUXException, JMXConnectionException, SYSException; - Suspend Handler
- Change the State of JSH to “SUSpended”.
- Input
- clientId: Client identifier for JSH.
- Signature
-
void suspendHandler (String clientId) throws TUXException, JMXConnectionException, SYSException; - Resume Handler
- Activate a
SUSpendedJSH object. - Input
- clientId: Client identifier for JSH.
- Signature
-
void resumeHandler (String clientId) throws TUXException, JMXConnectionException, SYSException;
Parent topic: MBean Name
4.15 Tuxedo Event Broker
Parent topic: MBeans and JMX Operations
4.15.1 MBean Name
“<DOMAINID>_<IPCKEY>:type= tuxedo_event_broker,group_name=<GROUPNAME>,SRVID=<SRVID>”.Parent topic: Tuxedo Event Broker
4.15.1.1 Operations
- GetParameter
- Refer to “GetParameter”
- GetParameters
- Refer to “GetParameters”
- SetParameter
- Refer to “SetParameter”
- SetParameters
- Refer to “SetParameters”
- Delete
- Refer to “Delete”
Parent topic: MBean Name
4.16 Tuxedo Queue Server
Parent topic: MBeans and JMX Operations
4.16.1 MBean Name
“<DOMAINID>_<IPCKEY>:type= tuxedo_queue_server,group_name=<GROUPNAME>,SRVID=<SRVID>”.Parent topic: Tuxedo Queue Server
4.16.1.1 Operations
- GetParameter
- Refer to GetParameter
- GetParameters
- Refer to GetParameters
- SetParameter
- Refer to SetParameter
- SetParameters
- Refer to SetParameters
- Delete
- Refer to Delete
Parent topic: MBean Name
4.17 Tuxedo QTMQ Server
Parent topic: MBeans and JMX Operations
4.17.1 MBean Name
“<DOMAINID>_<IPCKEY>:type= tuxedo_OTMQ_server,group_name=<GROUPNAME>,SRVID=<SRVID>”.
Parent topic: Tuxedo QTMQ Server
4.17.1.1 Operations
- GetParameter
- Refer to “GetParameter”
- GetParameters
- SetParameter
- GetParamenters
- Refer to GetParameters
- SetParameter
- Refer to SetParameter
- SetParameters
- Refer to “SetParameters”.
- Create Queue
-
Parameter Name Value Note qnamestring [1..127] Queue Name. Required input field. qorderPRIO | TIME | LIFO | FIFO | EXPIR | null Queue order. Optional input field. The default value is FIFO. outoforderNONE | TOP | MSGID | null Out-of-ordering enqueuing. Optional input field. The default value is NONE. maxRetriesA number and >= 0 && <= 4 byte long. Max Retry number. Optional input field. The default value is 0. retryDelayA number and >= 0 && <= 4 byte long Retry delay in seconds. Optional input field. The default value is 0. defaultDeliveryPolicypersist | nonpersist | null Default delivery policy. Optional input field.The default value is persist cmdstring[0..127] | null The command to be automatically executed when the high water mark for persistent (disk-based) messages is reached. Optional input field. defaultExpirationTime {+seconds | NONE} Expiration time for messages enqueued with no explicit expiration time. Optional input field. The format is +seconds where seconds is the number of seconds allowed to lapse between the time that the queue manager successfully completes the operation and the time that the message is to expire. If seconds is set to zero (0) the message expires immediately. The value of this attribute may also be set to the string NONE. The NONE string indicates that messages enqueued to the queue with no explicit expiration time do not expire. You may change the expiration time for messages already in a queue with the TA_EXPIRETIME attribute of the T_OTMQMSG class in the APPQ_MIB. qType {P|S|M|U|null} Optional input field. The default value is U. primaryQueue string[1..127]|null Primary Queue. Optional input field. isPermanentActive {Y|N|null} Permanent Active/or not. Optional input field. The default value is “Y”. comfirmStyle { EO|EI|II|null } Confirm style. Optional input field. The default value is EO
- Signature
Void createQueue(String qname, String qorder, String outoforder, Integer maxRetries, Integer retryDelay, String defaultDeliveryPolicy, String cmd, String defaultExpirationTime, String qType, String primaryQueue, Boolean isPermanentActive, String comfirmStyle) throws TUXException, JMXConnectionException, SYSException, USGException;
Parent topic: MBean Name
4.18 Tuxedo ART Batch System Target
Parent topic: MBeans and JMX Operations
4.18.1 MBean Name
“<DOMAINID>_<IPCKEY>:type= tuxedo_batch_system,name=Batch_System”.Parent topic: Tuxedo ART Batch System Target
4.18.1.1 Operations
- Input:
batchName: job name- Output:
-
Column Name Note JES2_JOB_IDJob ID JES2_JOB_NAMEJob Name JES2_JOB_STATUSJob Status JES2_JOB_SUBMITTIMEThe time when the job is submitted JES2_JOB_EXECTIMEThe time when the job is executed JES2_JOB_ENDTIMEThe time when the job is ended JES2_JOB_CLASSJob class JES2_JOB_TYPRUNJob TYPRUNdefinitionJES2_JOB_PRTYJob priority JES2_JOB_SCRIPTJob script file name JES2_JOB_OWNERJob owner JES2_JOB_EXECMACThe machine name that the job is/was running on JES2_JOB_CURRENTCurrent running step JES2_JOB_EXECSTATUSJob executing status JES2_JOB_MSGJob executing message JES2_JOB_FILEINFOJob file accessing information JES2_JOB_TYPEJob type JES2_JOB_CPUINFOCPU usage in each step JES2_JOB_USRSECUser CPU usage seconds JES2_JOB_USRUSECUser CPU usage microseconds JES2_JOB_SYSSECSystem CPU usage seconds JES2_JOB_SYSUSECSystem CPU usage microseconds
- Signature:
-
TabularData getBatchs(String batchName, Integer batchID, String batchClass, String batchOwner)throws MBeanException
- Signature:
-
TabularData getBatchFiles()throws MBeanException - submitBatch
- Submits a job
- Input:
-
batchScript: job script file name - Output:
-
Column Name Note JES2_JOB_IDJob ID JES2_JOB_NAMEJob name JES2_JOB_TYPRUNJob TYPRUNdefinitionJES2_JOB_ERRORError message when failing
- Signature:
-
TabularData submitBatch(String batchScript, String batchOwner, - cancelBatch
- Cancels job(s)
- Input:
- Refer to the input of getBatchs
- Output:
-
Column Name Note JES2_JOB_IDJob ID JES2_JOB_NAMEJob name JES2_JOB_ERRORError message when failing
- purgeBatch
- Purges job(s)
- Input:
- Refer to the input of getBatchs
- Output:
- Refer to the output of cancelBatch
- Signature
-
TabularData purgeBatch(String batchName, Integer batchId,String batchClass, String batchOwner) throws SYSException,TUXException, JMXConnectionException - holdBatch
- Holds job(s)
- Input:
- Refer to the input of getBatchs
- Output:
- Refer to the output of cancelBatch
- Signature:
-
TabularData holdBatch(String batchName, Integer batchId,String batchClass, String batchOwner) throws SYSException,TUXException, JMXConnectionException - releaseBatch
- Releases job(s)
- Input:
- Refer to the input of getBatchs
- Output:
- Refer to the output of cancelBatch
- Signature:
-
TabularData releaseBatch(String batchName, Integer batchId, String batchClass, String batchOwner) throws SYSException, TUXException, JMXConnectionException - getBatchSysOuts
- Gets the job sysout
- Input:
batchID: job id- Output:
-
Column Name Note JES2_JOB_SCRIPTJob log file name JES2_FILE_CONTENTJob log file content
Parent topic: MBean Name