cics-bundle:deploy

Full name:

com.ibm.cics:cics-bundle-maven-plugin:1.0.6-SNAPSHOT:deploy

Description:

This mojo deploys a CICS bundle to the specified CICS region using the CICS bundle deployment API. A matching bundle definition must be provided in the CSD in advance.

The deploy goal is not bound by default, so will not run unless specifically configured. You might choose to configure the deploy goal to run inside a specific profile, so that a developer can choose whether to deploy their bundle with a command-line parameter to switch Maven profiles.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Binds by default to the lifecycle phase: verify.

Required Parameters

Name Type Since Description
<bunddef> String - The name of the bundle definition that will install this bundle. Must be present already in the CSD relating to the configured cicsplex/region, and must be configured with the correct bundle directory according to the bundle deployment API configuration and the name of the bundle the user is deploying.
User property is: cicsbundle.bunddef.
<csdgroup> String - The CSD group containing the bundle definition to be installed.
User property is: cicsbundle.csdgroup.

Optional Parameters

Name Type Since Description
<bundle> String - The filename of the bundle archive file to be deployed.
User property is: cicsbundle.bundle.
<cicsplex> String - Required for a CICSPlex SM environment, ignored in an SMSS environment. The name of the CICSplex the bundle should be installed into. Specifying this parameter overrides any value provided within a Maven settings server entry.
User property is: cicsbundle.cicsplex.
<classifier> String - The classifier of a bundle attached to this project which is to be deployed. If a value for the @bundle parameter is supplied, this classifier is ignored.
User property is: cicsbundle.classifier.
<insecure> boolean - When connecting to the CICS bundle deployment API, do not check that the trust chain of the host certificate is valid, do not verify that the host name of certificate matches host name of server.
Default value is: false.
User property is: cicsbundle.insecure.
<password> String - The password to authenticate with. Specifying this parameter overrides any value provided within a Maven settings server entry.
User property is: cicsbundle.password.
<region> String - Required for a CICSPlex SM environment, ignored in an SMSS environment. The name of the region the bundle should be installed into. Specifying this parameter overrides any value provided within a Maven settings server entry.
User property is: cicsbundle.region.
<serverId> String - The ID of a server configured in your Maven settings
<url> String - The CMCI URL that the CICS bundle deployment API is available on. For example `https://yourcicshost.com:9080`. Specifying this parameter overrides any value provided within a Maven settings server entry.
User property is: cicsbundle.url.
<username> String - The username to authenticate with. Specifying this parameter overrides any value provided within a Maven settings server entry.
User property is: cicsbundle.username.

Parameter Details

<bunddef>

The name of the bundle definition that will install this bundle. Must be present already in the CSD relating to the configured cicsplex/region, and must be configured with the correct bundle directory according to the bundle deployment API configuration and the name of the bundle the user is deploying.
  • Type: java.lang.String
  • Required: Yes
  • User Property: cicsbundle.bunddef

<bundle>

The filename of the bundle archive file to be deployed.
  • Type: java.lang.String
  • Required: No
  • User Property: cicsbundle.bundle

<cicsplex>

Required for a CICSPlex SM environment, ignored in an SMSS environment. The name of the CICSplex the bundle should be installed into. Specifying this parameter overrides any value provided within a Maven settings server entry.
  • Type: java.lang.String
  • Required: No
  • User Property: cicsbundle.cicsplex

<classifier>

The classifier of a bundle attached to this project which is to be deployed. If a value for the @bundle parameter is supplied, this classifier is ignored.
  • Type: java.lang.String
  • Required: No
  • User Property: cicsbundle.classifier

<csdgroup>

The CSD group containing the bundle definition to be installed.
  • Type: java.lang.String
  • Required: Yes
  • User Property: cicsbundle.csdgroup

<insecure>

When connecting to the CICS bundle deployment API, do not check that the trust chain of the host certificate is valid, do not verify that the host name of certificate matches host name of server.
  • Type: boolean
  • Required: No
  • User Property: cicsbundle.insecure
  • Default: false

<password>

The password to authenticate with. Specifying this parameter overrides any value provided within a Maven settings server entry.
  • Type: java.lang.String
  • Required: No
  • User Property: cicsbundle.password

<region>

Required for a CICSPlex SM environment, ignored in an SMSS environment. The name of the region the bundle should be installed into. Specifying this parameter overrides any value provided within a Maven settings server entry.
  • Type: java.lang.String
  • Required: No
  • User Property: cicsbundle.region

<serverId>

The ID of a server configured in your Maven settings
  • Type: java.lang.String
  • Required: No

<url>

The CMCI URL that the CICS bundle deployment API is available on. For example `https://yourcicshost.com:9080`. Specifying this parameter overrides any value provided within a Maven settings server entry.
  • Type: java.lang.String
  • Required: No
  • User Property: cicsbundle.url

<username>

The username to authenticate with. Specifying this parameter overrides any value provided within a Maven settings server entry.
  • Type: java.lang.String
  • Required: No
  • User Property: cicsbundle.username