cmci_create – Create CICS and CICSPlex SM definitions¶
Synopsis¶
Create definitional CICS® or CICSPlex® SM resources in CSD and BAS repositories, by initiating POST requests via the CMCI REST API. The CMCI REST API can be configured in CICSPlex SM or stand-alone regions (SMSS). For information about the API, see CMCI REST API. For information about how to compose POST requests, see CMCI POST requests.
Parameters¶
- attributes
The resource attributes to be created or updated. Available attributes can be found in the CICSPlex® SM resource table reference for the target resource type, for example, PROGDEF resource table reference.
required: Falsetype: dict- cmci_cert
Location of the PEM-formatted certificate chain file to be used for HTTPS client authentication.
Can also be specified using the environment variable CMCI_CERT.
Required if cmci_key is specified.
Authentication prioritises certificate authentication if cmci_cert and cmci_key are provided, then basic authentication if cmci_user and cmci_password are provided, and then unauthenticated if none is provided.
required: Falsetype: str- cmci_host
The TCP/IP host name of CMCI connection.
required: Truetype: str- cmci_key
Location of the PEM-formatted file storing your private key to be used for HTTPS client authentication.
Can also be specified using the environment variable CMCI_KEY.
Required if cmci_cert is specified.
Authentication prioritises certificate authentication if cmci_cert and cmci_key are provided, then basic authentication if cmci_user and cmci_password are provided, and then unauthenticated if none is provided.
required: Falsetype: str- cmci_password
The password of cmci_user to pass HTTP basic authentication.
Can also be specified using the environment variable CMCI_PASSWORD.
Required if cmci_user is specified.
Authentication prioritises certificate authentication if cmci_cert and cmci_key are provided, then basic authentication if cmci_user and cmci_password are provided, and then unauthenticated if none is provided.
required: falsetype: str- cmci_port
The port number of the CMCI connection.
required: Truetype: int- cmci_user
The user ID under which the CMCI request will run.
Can also be specified using the environment variable CMCI_USER.
Required if cmci_password is specified.
Authentication prioritises certificate authentication if cmci_cert and cmci_key are provided, then basic authentication if cmci_user and cmci_password are provided, and then unauthenticated if none is provided.
required: falsetype: str- context
If CMCI is installed in a CICSPlex® SM environment, context is the name of the CICSplex or CMAS associated with the request, for example,
PLEX1. To determine whether a CMAS can be specified as context, see the CMAS context entry in the CICSPlex SM resource table reference of a resource. For example, according to the PROGRAM resource table, CMAS context is not supported for PROGRAM.If CMCI is installed in a single region (SMSS), context is the APPLID of the CICS region associate with the request.
The value of context must contain no spaces. context is not case-sensitive.
required: Truetype: str- create_parameters
A list of one or more parameters that control the create operation. Eligible parameters for the CREATE operation can be found in the resource table reference for the target resource type, as listed in the CREATE operation section of the “Valid CPSM operations” table. For example, the valid parameters for a PROGDEF CREATE operation are CSD and RESGROUP, as found in the PROGDEF resource table reference.
required: Falsetype: list- name
Parameter name for the CREATE operation.
required: Truetype: str- value
Parameter value if any. Can be omitted if the parameter requires no value to be supplied, as shown in the resource table reference. For example, the CSD parameter for the PROGDEF CREATE operation doesn’t require a value.
required: Falsetype: str
- insecure
When set to
true, disables SSL certificate trust chain verification when using HTTPS.required: Falsetype: bool- scheme
The HTTP scheme to use when establishing a connection to the CMCI REST API.
required: falsetype: strdefault: httpschoices: http, https- scope
Specifies the name of a CICSplex, CICS region group, CICS region, or logical scope that is associated with the query.
scope is a subset of context and limits the request to particular CICS systems or resources.
scope is optional. If it’s not specified, the request is limited by the value of context alone.
The value of scope must contain no spaces. scope is not case-sensitive.
required: falsetype: str- timeout
HTTP request timeout in seconds
required: Falsetype: intdefault: 30- type
The CMCI external resource name that maps to the target CICS or CICSPlex SM resource type. For a list of CMCI external resource names, see CMCI resource names.
required: Truetype: str
Examples¶
- name: define a BUNDLE in a CSD
cmci_create:
cmci_host: "winmvs2c.hursley.ibm.com"
cmci_port: 10080
context: "iyk3z0r9"
type: "CICSDefinitionBundle"
attributes:
name: PONGALT
bundledir: /u/ibmuser/bundle/pong/pongbundle_1.0.0
csdgroup: JVMGRP
create_parameters:
- name: "csd"
Return Values¶
- changed
- failed
- connect_version
- cpsm_reason
- cpsm_reason_code
- cpsm_response
- cpsm_response_code
- http_status
- http_status_code
- record_count
- records
- request
- body
- method
- url
- feedback
- action
- attribute1
- attribute2
- attribute3
- attribute4
- attribute5
- attribute6
- eibfn
- eibfn_alt
- errorcode
- eyu_cicsname
- keydata
- resp
- resp2
- resp_alt
- installerror
- eibfn
- eyu_cicsname
- cresp1
- cresp2
- errorcode
- ressname
- resver
- inconsistentscope
- eibfn
- eyu_cicsname
- erroroperation
- errorcode
- targetassignment
- targetdescription
- relatedassignment
- relateddescription
- relatedscope
- inconsistentset
- candidatename
- candidateversion
- candidategroup
- candidateassignment
- candidatedescription
- candidateusage
- candidatesystemgroup
- candidatetype
- candidateoverride
- eyu_cicsname
- erroroperation
- existingname
- existingversion
- existinggroup
- existingassignment
- existingdescription
- existingusage
- existingsystemgroup
- existingtype
- existingoverride