oracle.oci.oci_integration_instance – Manage an IntegrationInstance resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.3.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install oracle.oci.
To use it in a playbook, specify: oracle.oci.oci_integration_instance.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete an IntegrationInstance resource in Oracle Cloud Infrastructure
For state=present, creates a new Integration Instance.
This resource has the following action operations in the oracle.oci.oci_integration_instance_actions module: change_compartment, change_integration_instance_network_endpoint, change_private_endpoint_outbound_connection, enable_process_automation, start, stop.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
|
alternate_custom_endpoints
list
/ elements=dictionary
|
A list of alternate custom endpoints to be used for the integration instance URL (contact Oracle for alternateCustomEndpoints availability for a specific instance).
This parameter is updatable.
|
|||
|
certificate_secret_id
string
|
Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. All certificates should be stored in a single base64 encoded secret Note the update will fail if this is not a valid certificate.
This parameter is updatable.
|
|||
|
hostname
string
/ required
|
A custom hostname to be used for the integration instance URL, in FQDN format.
This parameter is updatable.
|
|||
|
api_user
string
|
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See
config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|||
|
api_user_fingerprint
string
|
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See
config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|||
|
api_user_key_file
string
|
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See
config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided. |
|||
|
api_user_key_pass_phrase
string
|
Passphrase used by the key referenced in
api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location). |
|||
|
auth_purpose
string
|
|
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
|
||
|
auth_type
string
|
|
The type of authentication to use for making API requests. By default
auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance. |
||
|
cert_bundle
string
|
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
|
|||
|
compartment_id
string
|
Compartment Identifier.
Required for create using state=present.
Required for update when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.Required for delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set. |
|||
|
config_file_location
string
|
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
|
|||
|
config_profile_name
string
|
The profile to load from the config file referenced by
config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location. |
|||
|
consumption_model
string
|
|
Optional parameter specifying which entitlement to use for billing purposes. Only required if the account possesses more than one entitlement.
|
||
|
custom_endpoint
dictionary
|
This parameter is updatable.
|
|||
|
certificate_secret_id
string
|
Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. All certificates should be stored in a single base64 encoded secret Note the update will fail if this is not a valid certificate.
This parameter is updatable.
|
|||
|
hostname
string
/ required
|
A custom hostname to be used for the integration instance URL, in FQDN format.
This parameter is updatable.
|
|||
|
defined_tags
dictionary
|
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
|
|||
|
display_name
string
|
Integration Instance Identifier.
Required for create using state=present.
Required for update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.This parameter is updatable when
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: name |
|||
|
domain_id
string
|
The OCID of the identity domain, that will be used to determine the corresponding Idcs Stripe and create an Idcs application within the stripe. This parameter is mutually exclusive with parameter: idcsAt, i.e only one of two parameters should be specified.
|
|||
|
force_create
boolean
|
|
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
|
||
|
freeform_tags
dictionary
|
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
This parameter is updatable.
|
|||
|
idcs_at
string
|
IDCS Authentication token. This is required for all realms with IDCS. Its optional as its not required for non IDCS realms.
|
|||
|
integration_instance_id
string
|
Unique Integration Instance identifier.
Required for update using state=present when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
|||
|
integration_instance_type
string
|
|
Standard or Enterprise type, Oracle Integration Generation 2 uses ENTERPRISE and STANDARD, Oracle Integration 3 uses ENTERPRISEX and STANDARDX
Required for create using state=present.
This parameter is updatable.
|
||
|
is_byol
boolean
|
|
Bring your own license.
Required for create using state=present.
This parameter is updatable.
|
||
|
is_file_server_enabled
boolean
|
|
The file server is enabled or not.
This parameter is updatable.
|
||
|
is_visual_builder_enabled
boolean
|
|
Visual Builder is enabled or not.
This parameter is updatable.
|
||
|
key_by
list
/ elements=string
|
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
|
|||
|
message_packs
integer
|
The number of configured message packs
Required for create using state=present.
This parameter is updatable.
|
|||
|
network_endpoint_details
dictionary
|
||||
|
allowlisted_http_ips
list
/ elements=string
|
Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response.
|
|||
|
allowlisted_http_vcns
list
/ elements=dictionary
|
Virtual Cloud Networks allowed to access this network endpoint.
|
|||
|
allowlisted_ips
list
/ elements=string
|
Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response.
|
|||
|
id
string
/ required
|
The Virtual Cloud Network OCID.
|
|||
|
is_integration_vcn_allowlisted
boolean
|
|
The Integration service's VCN is allow-listed to allow integrations to call back into other integrations
|
||
|
network_endpoint_type
string
/ required
|
|
The type of network endpoint.
|
||
|
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
||
|
region
string
|
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See
config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions. |
|||
|
shape
string
|
|
Shape
|
||
|
state
string
|
|
The state of the IntegrationInstance.
Use state=present to create or update an IntegrationInstance.
Use state=absent to delete an IntegrationInstance.
|
||
|
tenancy
string
|
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See
config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm |
|||
|
wait
boolean
|
|
Whether to wait for create or delete operation to complete.
|
||
|
wait_timeout
integer
|
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.
|
|||
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create integration_instance
oci_integration_instance:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
integration_instance_type: STANDARD
is_byol: true
message_packs: 56
# optional
idcs_at: idcs_at_example
consumption_model: UCM
network_endpoint_details:
# required
network_endpoint_type: PUBLIC
# optional
allowlisted_http_ips: [ "allowlisted_http_ips_example" ]
allowlisted_http_vcns:
- # required
id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
# optional
allowlisted_ips: [ "allowlisted_ips_example" ]
is_integration_vcn_allowlisted: true
shape: DEVELOPMENT
domain_id: "ocid1.domain.oc1..xxxxxxEXAMPLExxxxxx"
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
is_file_server_enabled: true
is_visual_builder_enabled: true
custom_endpoint:
# required
hostname: hostname_example
# optional
certificate_secret_id: "ocid1.certificatesecret.oc1..xxxxxxEXAMPLExxxxxx"
alternate_custom_endpoints:
- # required
hostname: hostname_example
# optional
certificate_secret_id: "ocid1.certificatesecret.oc1..xxxxxxEXAMPLExxxxxx"
- name: Update integration_instance
oci_integration_instance:
# required
integration_instance_id: "ocid1.integrationinstance.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
integration_instance_type: STANDARD
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
is_byol: true
message_packs: 56
is_file_server_enabled: true
is_visual_builder_enabled: true
custom_endpoint:
# required
hostname: hostname_example
# optional
certificate_secret_id: "ocid1.certificatesecret.oc1..xxxxxxEXAMPLExxxxxx"
alternate_custom_endpoints:
- # required
hostname: hostname_example
# optional
certificate_secret_id: "ocid1.certificatesecret.oc1..xxxxxxEXAMPLExxxxxx"
- name: Update integration_instance using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_integration_instance:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
integration_instance_type: STANDARD
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
is_byol: true
message_packs: 56
is_file_server_enabled: true
is_visual_builder_enabled: true
custom_endpoint:
# required
hostname: hostname_example
# optional
certificate_secret_id: "ocid1.certificatesecret.oc1..xxxxxxEXAMPLExxxxxx"
alternate_custom_endpoints:
- # required
hostname: hostname_example
# optional
certificate_secret_id: "ocid1.certificatesecret.oc1..xxxxxxEXAMPLExxxxxx"
- name: Delete integration_instance
oci_integration_instance:
# required
integration_instance_id: "ocid1.integrationinstance.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete integration_instance using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_integration_instance:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Oracle (@oracle)