IBM Integration Bus, Version 9.0.0.8 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

mqsicreateconfigurableservice command

Use the mqsicreateconfigurableservice command to create an object name for a broker external resource.

You can also use the IBM® Integration Explorer to create configurable services. For more information, see Using the IBM Integration Explorer to work with configurable services.

Supported platforms

  • Windows.
  • Linux and UNIX systems.
  • z/OS®. Run this command by customizing and submitting BIPCRCS. For more information, see Contents of the broker PDSE.

Purpose

For configurable services that you add by using the mqsicreateconfigurableservice command:
  • Use the mqsireportproperties command to view the configurable services.
  • Use the mqsichangeproperties command to modify the configurable services.
  • Use the mqsideleteconfigurableservice command to delete configurable services.

You do not have to use the mqsicreateconfigurableservice command to create EIS providers, because definitions are supplied for you. Use the mqsichangeproperties command to modify EIS providers.

Usage notes

  • Before you run this command, ensure that the broker is running.
  • For some types of configurable service, you must stop and start the integration server for the change to take effect. Check the documentation for the specific configurable service type.

Syntax

Read syntax diagramSkip visual syntax diagram
>>-mqsicreateconfigurableservice--BrokerName-------------------->

>-- -c --ConfigurableService-- -o--ObjectName------------------->

>--+---------------------------------------------------+-------><
   |      .-,------------.                             |   
   |      V              |                             |   
   '- -n----PropertyName-+--+------------------------+-'   
                            |      .-,-------------. |     
                            |      V               | |     
                            '- -v----PropertyValue-+-'     

Parameters

BrokerName
(Required) The name of the broker to modify. This parameter must be the first parameter.
-c ConfigurableService
(Required) The type of external resource (configurable service). Use the mqsireportproperties command to view the list of valid values.

The valid resource types are listed in Configurable services properties.

-o ObjectName
(Required) The name of the object whose properties you want to change.

For example, if the -c parameter is set to JDBCProviders, the expected object name is either an IBM-defined JDBC provider name, or a user-defined JDBC provider name. Default services are provided for the supported databases to which you can connect over JDBC type 4 connections. Use the supplied services as a template when you create a service by using this command. Use the mqsireportproperties command to view the list of default provider names.

-n PropertyName
(Optional) The name of the property that is being changed. The property name must be a valid XML attribute name; for example, a property name cannot start with a number.

The valid property names are listed in Configurable services properties.

-v PropertyValue
(Optional, but required if the -n parameter is specified) The value that is assigned to the property that is specified by the -n parameter. You can specify more than one property name and corresponding value by using commas as separators; for example, -n Name1,Name2 -v Value1,Value2.

If the property value contains a comma, enclose the value with escaped double quotation marks (\" and \"); for example, -n Name1,Name2 -v Value1,\"Value21,Value22\".

UNIX platformOn UNIX systems, if the -v parameter contains a semi-colon (;), enclose the entire string in quotation marks, as shown in the following example:
mqsicreateconfigurableservice IB9NODE -c JDBCProviders -o DB2EXTRA -n connectionUrlFormat 
-v "jdbc:db2://[serverName]:[portNumber]/[databaseName]:user=[user];password=[password];"

The property values are described in Configurable services properties.

Authorization

For information about platform-specific authorizations, see the following topics: If you have enabled broker administration security, you must also set up the authority detailed in Tasks and authorizations for administration security.

Responses

This command returns the following responses:
  • BIP8011 Unable to create configuration data
  • BIP8012 Unable to connect to system components
  • BIP8014 Component cannot be created
  • BIP8073 Invalid broker name
  • BIP8983 Configurable service already exists
  • BIP8984 Configurable service was not found

Examples

Create an Aggregation configurable service that uses a set of queues that is prefixed with SYSTEM.BROKER.AGGR.SET1, and with a timeout of 60 seconds:
mqsicreateconfigurableservice IB9NODE -c Aggregation -o myAggregationService 
-n queuePrefix,timeoutSeconds -v SET1,60 
Create a CICSConnection configurable service for the CICS® instance that is running at tcp://test.cics.ibm.com port 12345. The broker is identified by APPLID BRKApp and qualifier BRKQual. The connection timeout is 10 seconds and the request timeout is 5 seconds in this example:
mqsicreateconfigurableservice IB9NODE -c CICSConnection -o myCICSConnectionService
-n cicsServer,clientApplid,clientQualifier,connectionTimeoutSecs,
requestTimeoutSecs -v tcp://test.cics.ibm.com:12345,BRKApp,BRKQual,10,5
Create a Collector configurable service that uses queues that are prefixed with SYSTEM.BROKER.EDA.SET1, and with a collection expiry of 60 seconds:
mqsicreateconfigurableservice IB9NODE -c Collector -o myCollectorService 
-n queuePrefix,collectionExpirySeconds -v SET1,60 
Create a Connect:Direct® server configurable service on object test, with a host name of 9.122.17.58 and port number 1369:
mqsicreateconfigurableservice IB9NODE -c CDServer -o test
-n Hostname,Port -v 9.122.17.58,1369 
To install a new connector provider call MyProvider that uses the ConnectionFactory MyFactory and has its JAR files in the directory C:\temp\jars:
mqsicreateconfigurableservice IB9NODE -c ConnectorProviders -o MyProvider
-n connectorClassName,jarsURL
–v com.ibm.broker.MyFactory,C:\temp\jars 

To view the Javadoc for the connector API, see Connector API.

Create a CORBA configurable service that specifies the location of the object reference:
mqsicreateconfigurableservice IB9NODE -c CORBA -o myCORBAService
-n namingService,objectReferenceName -v localhost:2809,Europe.region/Market.object
Create an EmailServer configurable service to which the EmailInput node or message flow can refer at run time to connect to an email server. The server is running at pop3://test.email.server.ibm.com on port 12345. In this example, the security identity is identified by mySecurityIdentityObjectName.
mqsicreateconfigurableservice IB9NODE -c EmailServer -o myEmailConfigurableServiceName
-n serverName,securityIdentity -v pop3://test.email.server.ibm.com
:12345,mySecurityIdentityObjectName
Create an FtpServer configurable service:
mqsicreateconfigurableservice IB9NODE -c FtpServer -o Server01 
-n serverName,scanDelay,transferMode,connectionType,securityIdentity 
-v one.hursley.abc.com:123,20,Binary,ACTIVE,secId
Create an FtpServer configurable service to use SFTP without strict host key checking:
mqsicreateconfigurableservice IB9NODE -c FtpServer -o TEST1 
-n protocol,serverName,scanDelay,remoteDirectory,securityIdentity,cipher,compression,strictHostKeyChecking
-v  SFTP,winlnx58,30,.,chbatey,blowfish-cbc,9,no
Create an IMSConnect configurable service for the IMS™ instance IMSA that is running on test.ims.ibm.com port 9999:
mqsicreateconfigurableservice IB9NODE -c IMSConnect -o myIMSConnectService
-n Hostname,PortNumber,DataStoreName -v test.ims.ibm.com,9999,IMSA
Create a JavaClassLoader service:
mqsicreateconfigurableservice IB9NODE -c JavaClassLoader 
-o myJavaClassLoader 
-n includedDeployedJars,sharedJarPath 
-v "jcnapp1.jar","/var/app1/jars"
Add a JMS provider that is called "MyProviderXYZ":
mqsicreateconfigurableservice IB9NODE -c JMSProviders -o JMS_MyProviderXYZ
Add a JMS provider that is called "ProviderABC", with default values for the resource properties:
mqsicreateconfigurableservice IB9NODE -c JMSProviders -o JMS_ProviderABC
Add a JMS provider that is called "BEAV91", specifying the name of an IBM supplied Java™ class that is called com.ibm.broker.apihandler.BEAWebLogicAPIHandler to handle vendor-specific API calls:
mqsicreateconfigurableservice IB9NODE -c JMSProviders -o BEAV91 
-n proprietaryAPIHandler,proprietaryAPIAttr1,proprietaryAPIAttr2,proprietaryAPIAttr3
–v com.ibm.broker.apihandler.BEAWebLogicAPIHandler,weblogic.jndi.WLInitialContextFactory,
t3://19.21.194.126:7001,BEAServerName 
Create a monitoring profile with the name 'mp1' to broker IB9NODE:
mqsicreateconfigurableservice IB9NODE -c MonitoringProfiles -o mp1
Create a PeopleSoftConnection configurable service for the PeopleSoft instance that is running on my.peoplesoft.qa.com:
mqsicreateconfigurableservice IB9NODE -c PeopleSoftConnection 
-o myPeopleSoftAdapter.outadapter -n hostName,port -v "my.peoplesoft.qa.com",9000
Create a Resequence configurable service that uses a set of queues that are prefixed with SYSTEM.BROKER.EDA.SET1, and with a missing message timeout of 60 seconds:
mqsicreateconfigurableservice IB9NODE -c Resequence -o myResequenceService 
-n queuePrefix,missingMessageTimeoutSeconds -v SET1,60 
Create a SAPConnection configurable service for the SAP adapter mySAPAdapter.outadapter that connects to the SAP host test.sap.ibm.com, and uses client 001 for the connections into that server:
mqsicreateconfigurableservice IB9NODE -c SAPConnection -o mySAPAdapter.outadapter 
-n applicationServerHost,client -v test.sap.ibm.com,001

You can set the user name and password for an SAP adapter by using the mqsisetdbparms command.

Create a security profile for a WS-Trust V1.3 STS provider by using Tivoli® Federated Identity Manager (TFIM) V6.2:
mqsicreateconfigurableservice IB9NODE -c SecurityProfiles -o myWSTrustTFIMv62Profile 
-n authentication,mapping,authorization,propagation,mappingConfig 
-v "WS-Trust v1.3 STS","WS-Trust v1.3 STS","WS-Trust v1.3 STS",TRUE,
http://wstrusthost1.ibm.com:9080/TrustServerWST13/services/RequestSecurityToken
The Default Propagation profile is a predefined profile that requests only identity propagation. For more information about creating a security profile for a WS-Trust V1.3 STS provider, LDAP, or TFIM V6.1, see Creating a security profile.
Create a SiebelConnection configurable service for the Siebel adapter mySiebelAdapter.outadapter that connects to the Siebel server "siebel://my.siebel.qa.com/SBA_80/SSEObjMgr_enu".
mqsicreateconfigurableservice IB9NODE -c SiebelConnection -o mySiebelAdapter.outadapter 
-n connectString -v "siebel://my.siebel.qa.com/SBA_80/SSEObjMgr_enu"

You can set the user name and password for a Siebel adapter by using the mqsisetdbparms command.

Create a TCPIPServer configurable service:
mqsicreateconfigurableservice IB9NODE -c TCPIPServer -o ServerPort1452 
-n Port,MaximumConnections,ExpireConnectionSec -v 1452,1000,15  
Create a TCPIPClient configurable service:
mqsicreateconfigurableservice IB9NODE -c TCPIPClient 
-o ClientPort1452HostnameJsmith 
-n Port,Hostname,AlternativeAddresses,MinimumConnections,MaximumConnections 
-v 1452,jsmith.hursley.ibm.com,jones:1111;edwards,5,10  
Create a Timer configurable service that uses a queue that is prefixed with SYSTEM.BROKER.TIMEOUT.SET1, and has a timeout of 5 seconds:
mqsicreateconfigurableservice IB9NODE -c Timer -o myTimerService 
-n queuePrefix,timeoutIntervalSeconds -v SET1,5 
Create a UserDefined service:
mqsicreateconfigurableservice IB9NODE -c UserDefined 
-o HTTP_Timeout -n VerifyRequestTimeout -v 60
Create a WXSServer configurable service to define how a connection to an external WebSphere® eXtreme Scale grid is established. The grid is a secure grid named "myGrid". In the following example, the catalog server for the grid has a host name of server.ibm.com and is on port 2809. The override file xc10Client.xml is being used. The name of the security identity that was created by the mqsisetdbparms command is "xc10".
mqsicreateconfigurableservice IB9NODE -c WXSServer -o xc10 
-n catalogServiceEndPoints,gridName,overrideObjectGridFile,securityIdentity 
-v "server.ibm.com:2809","myGrid","C:\Brokers\WebSphere_eXtreme_Scale\xc10\xc10Client.xml","xc10"

an37200_.htm | Last updated Friday, 21 July 2017