Supplied server templates
IBM® z/OS® Connect includes server templates that can be used to create new z/OS Connect Servers with appropriate pre-defined configuration.
Started task Applies to z/OS Connect Servers run by using a z/OS started task procedure.
The following server templates are tagged for the z/OS Connect feature with which they can be used.
To create a server with the supplied template, enter the command from the following template details in the <installation_path>/bin directory. For example /usr/lpp/IBM/zosconnect/v3r0/bin.
For more information about running the zosconnect create command see Creating an IBM z/OS Connect Server, and z/OS Connect command reference.
zosconnect:default
zosConnect-2.0 Applies to zosConnect-2.0.
This template provides a starting point for IBM z/OS Connect Servers.
zosconnect create myServer --template=zosconnect:defaultimsmobile:imsDefault
zosConnect-2.0 Applies to zosConnect-2.0.
This template provides a starting point for z/OS Connect Servers that connect to IMS.
zosconnect create myServer --template=imsmobile:imsDefaultzosconnect:apiRequester
zosConnect-2.0 Applies to zosConnect-2.0.
This template provides a starting point for z/OS Connect Servers that use the API requester feature generated from an OpenAPI 2.0 document.
zosconnect create myServer --template=zosconnect:apiRequesterzosconnect:sampleCicsIpicCatalogManager
zosConnect-2.0 Applies to zosConnect-2.0.
This template provides a z/OS Connect Server zosConnect-2.0 that is configured with an API and CICS® service provider services for the CICS Catalog Manager sample application. The server is configured to communicate with CICS over an IPIC connection.
zosconnect create catalogManager --template=zosconnect:sampleCicsIpicCatalogManagerzosconnect:sampleImsPhonebook
zosConnect-2.0 Applies to zosConnect-2.0.
This template provides a z/OS Connect Server zosConnect-2.0 that is configured with an API and services for the IMS phonebook sample application.
zosconnect create phonebook --template=zosconnect:sampleImsPhonebookzosconnect:sampleImsDatabase
zosConnect-2.0 Applies to zosConnect-2.0.
This template provides a z/OS Connect Server zosConnect-2.0 that is configured with an API and services for the IMS IVP sample application database.
zosconnect create imsDatabase --template=zosconnect:sampleImsDatabasezosconnect:mqDefault
zosConnect-2.0 Applies to zosConnect-2.0.
This template provides a starting point for z/OS Connect Servers zosConnect-2.0 that connect to IBM MQ.
zosconnect create myServer --template=zosconnect:mqDefaultzosconnect:sampleMqStockManager
zosConnect-2.0 Applies to zosConnect-2.0.
This template provides a z/OS Connect Server zosConnect-2.0 that is configured with an API and IBM MQ service provider services for the IBM MQ stock manager sample application. The server is configured to communicate with IBM MQ through a bindings connection.
zosconnect create myServer --template=zosconnect:sampleMqStockManagerzosconnect:sampleDb2ProjectManager
zosConnect-2.0 Applies to zosConnect-2.0.
This template provides a z/OS Connect Server zosConnect-2.0 configured with an API and services for the DB2® project manager sample. This scenario uses the REST client service provider to communicate with Db2.
zosconnect create db2ProjectManager --template=zosconnect:sampleDb2ProjectManagerzosconnect:openAPI3
zosConnect-3.0 Applies to zosConnect-3.0.
This template provides a starting point for z/OS Connect Servers when for deploying an OpenAPI 2.0 or an OpenAPI 3.0 document.
zosconnect create myServer --template=zosconnect:openApi3zosconnect:sample-cics-api
zosConnect-3.0 Applies to zosConnect-3.0.
This template provides a server that is configured with the finished CICS API provider sample tutorial project. For more details on the getting started tutorial, see Creating a CICS z/OS Connect API.
zosconnect create myServer --template=zosconnect:sample-cics-apiBefore starting the server, you must update the bootstrap.properties file and change the supplied sample values.
zosconnect:sample-db2-api
zosConnect-3.0 Applies to zosConnect-3.0.
This template provides a server that is configured with the finished Db2® API provider sample tutorial project. For more details on the getting started tutorial, see Creating a Db2 z/OS Connect API.
zosconnect create myServer --template=zosconnect:sample-db2-apiBefore starting the server, you must update the bootstrap.properties file and change the supplied sample values.
zosconnect:sample-ims-api
zosConnect-3.0 Applies to zosConnect-3.0.
This template provides a server that is configured with the finished IMS API provider sample tutorial project. For more details on the getting started tutorial, see Creating an IMS z/OS Connect API.
zosconnect create myServer --template=zosconnect:sample-ims-apiBefore starting the server, you must update the bootstrap.properties file and change the supplied sample values.
zosconnect:openApi3Requester
zosConnect-3.0 Applies to zosConnect-3.0.
This template provides a starting point for a z/OS Connect Server zosConnect-3.0 that uses an API requester generated from an OpenAPI 2.0 document or an OpenAPI 3.0 document.
zosconnect create myServer --template=zosconnect:openApi3Requesterzosconnect:openApi3RequesterTMRA
zosConnect-3.0 Applies to zosConnect-3.0.
This template provides a starting point for a z/OS Connect Server with the zosConnect-3.0 feature to use an API requester generated from either an OpenAPI 2.0 document or an OpenAPI 3.0 document, for IMS, using the IMS Transaction Manager Resource Adapter.
zosconnect create myServer --template=zosconnect:openApi3RequesterTMRAzosconnect:sampleApiRequesterRedbooks
zosConnect-3.0 Applies to zosConnect-3.0.
This template provides a server that is configured with the API requester Redbooks sample and tutorial. For more details on the getting started tutorial, see Creating an IBM z/OS Connect API requester project and z/OS application.
zosconnect create myServer --template=zosconnect:sampleApiRequesterRedbooks