oracle.oci.oci_integration_instance – Manage an IntegrationInstance resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.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, start, stop.

Requirements

The below requirements are needed on the host that executes this module.

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
    Choices:
  • service_principal
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
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
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
    Choices:
  • UCM
  • GOV
  • OIC4SAAS
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
force_create
boolean
    Choices:
  • no ←
  • yes
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
    Choices:
  • STANDARD
  • ENTERPRISE
  • STANDARDX
  • ENTERPRISEX
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
    Choices:
  • no
  • yes
Bring your own license.
Required for create using state=present.
This parameter is updatable.
is_file_server_enabled
boolean
    Choices:
  • no
  • yes
The file server is enabled or not.
This parameter is updatable.
is_visual_builder_enabled
boolean
    Choices:
  • no
  • yes
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
    Choices:
  • no
  • yes
The Integration service's VCN is allow-listed to allow integrations to call back into other integrations
network_endpoint_type
string / required
    Choices:
  • PUBLIC
The type of network endpoint.
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
    Choices:
  • DEVELOPMENT
  • PRODUCTION
Shape
state
string
    Choices:
  • present ←
  • absent
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
    Choices:
  • no
  • yes ←
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.

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
    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:

Key Returned Description
integration_instance
complex
on success
Details of the IntegrationInstance resource acted upon by the current operation

Sample:
{'alternate_custom_endpoints': [{'alias': 'alias_example', 'certificate_secret_id': 'ocid1.certificatesecret.oc1..xxxxxxEXAMPLExxxxxx', 'certificate_secret_version': 56, 'hostname': 'hostname_example'}], 'attachments': [{'is_implicit': True, 'target_id': 'ocid1.target.oc1..xxxxxxEXAMPLExxxxxx', 'target_instance_url': 'target_instance_url_example', 'target_role': 'PARENT', 'target_service_type': 'target_service_type_example'}], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'consumption_model': 'UCM', 'custom_endpoint': {'alias': 'alias_example', 'certificate_secret_id': 'ocid1.certificatesecret.oc1..xxxxxxEXAMPLExxxxxx', 'certificate_secret_version': 56, 'hostname': 'hostname_example'}, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'idcs_info': {'idcs_app_display_name': 'idcs_app_display_name_example', 'idcs_app_id': 'ocid1.idcsapp.oc1..xxxxxxEXAMPLExxxxxx', 'idcs_app_location_url': 'idcs_app_location_url_example', 'idcs_app_name': 'idcs_app_name_example', 'instance_primary_audience_url': 'instance_primary_audience_url_example'}, 'instance_url': 'instance_url_example', 'integration_instance_type': 'STANDARD', 'is_byol': True, 'is_file_server_enabled': True, 'is_visual_builder_enabled': True, 'lifecycle_state': 'CREATING', 'message_packs': 56, 'network_endpoint_details': {'allowlisted_http_ips': [], 'allowlisted_http_vcns': [{'allowlisted_ips': [], 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}], 'is_integration_vcn_allowlisted': True, 'network_endpoint_type': 'PUBLIC'}, 'shape': 'DEVELOPMENT', 'state_message': 'state_message_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
 
alternate_custom_endpoints
complex
on success
A list of alternate custom endpoints used for the integration instance URL.

   
alias
string
on success
When creating the DNS CNAME record for the custom hostname, this value must be specified in the rdata.

Sample:
alias_example
   
certificate_secret_id
string
on success
Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.

Sample:
ocid1.certificatesecret.oc1..xxxxxxEXAMPLExxxxxx
   
certificate_secret_version
integer
on success
The secret version used for the certificate-secret-id (if certificate-secret-id is specified).

Sample:
56
   
hostname
string
on success
A custom hostname to be used for the integration instance URL, in FQDN format.

Sample:
hostname_example
 
attachments
complex
on success
A list of associated attachments to other services

   
is_implicit
boolean
on success
* If role == `PARENT`, the attached instance was created by this service instance * If role == `CHILD`, this instance was created from attached instance on behalf of a user

Sample:
True
   
target_id
string
on success
The OCID of the target instance (which could be any other OCI PaaS/SaaS resource), to which this instance is attached.

Sample:
ocid1.target.oc1..xxxxxxEXAMPLExxxxxx
   
target_instance_url
string
on success
The dataplane instance URL of the attached instance

Sample:
target_instance_url_example
   
target_role
string
on success
The role of the target attachment. * `PARENT` - The target instance is the parent of this attachment. * `CHILD` - The target instance is the child of this attachment.

Sample:
PARENT
   
target_service_type
string
on success
The type of the target instance, such as "FUSION".

Sample:
target_service_type_example
 
compartment_id
string
on success
Compartment Identifier.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
consumption_model
string
on success
The entitlement used for billing purposes.

Sample:
UCM
 
custom_endpoint
complex
on success

   
alias
string
on success
When creating the DNS CNAME record for the custom hostname, this value must be specified in the rdata.

Sample:
alias_example
   
certificate_secret_id
string
on success
Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.

Sample:
ocid1.certificatesecret.oc1..xxxxxxEXAMPLExxxxxx
   
certificate_secret_version
integer
on success
The secret version used for the certificate-secret-id (if certificate-secret-id is specified).

Sample:
56
   
hostname
string
on success
A custom hostname to be used for the integration instance URL, in FQDN format.

Sample:
hostname_example
 
defined_tags
dictionary
on success
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
Integration Instance Identifier, can be renamed.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
Unique identifier that is immutable on creation.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
idcs_info
complex
on success

   
idcs_app_display_name
string
on success
The IDCS application display name associated with the instance

Sample:
idcs_app_display_name_example
   
idcs_app_id
string
on success
The IDCS application ID associated with the instance

Sample:
ocid1.idcsapp.oc1..xxxxxxEXAMPLExxxxxx
   
idcs_app_location_url
string
on success
URL for the location of the IDCS Application (used by IDCS APIs)

Sample:
idcs_app_location_url_example
   
idcs_app_name
string
on success
The IDCS application name associated with the instance

Sample:
idcs_app_name_example
   
instance_primary_audience_url
string
on success
The URL used as the primary audience for integration flows in this instance type: string

Sample:
instance_primary_audience_url_example
 
instance_url
string
on success
The Integration Instance URL.

Sample:
instance_url_example
 
integration_instance_type
string
on success
Standard or Enterprise type, Oracle Integration Generation 2 uses ENTERPRISE and STANDARD, Oracle Integration 3 uses ENTERPRISEX and STANDARDX

Sample:
STANDARD
 
is_byol
boolean
on success
Bring your own license.

Sample:
True
 
is_file_server_enabled
boolean
on success
The file server is enabled or not.

Sample:
True
 
is_visual_builder_enabled
boolean
on success
VisualBuilder is enabled or not.

Sample:
True
 
lifecycle_state
string
on success
The current state of the integration instance.

Sample:
CREATING
 
message_packs
integer
on success
The number of configured message packs (if any)

Sample:
56
 
network_endpoint_details
complex
on success

   
allowlisted_http_ips
list / elements=string
on success
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
complex
on success
Virtual Cloud Networks allowed to access this network endpoint.

     
allowlisted_ips
list / elements=string
on success
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
on success
The Virtual Cloud Network OCID.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
   
is_integration_vcn_allowlisted
boolean
on success
The Integration service's VCN is allow-listed to allow integrations to call back into other integrations

Sample:
True
   
network_endpoint_type
string
on success
The type of network endpoint.

Sample:
PUBLIC
 
shape
string
on success
Shape

Sample:
DEVELOPMENT
 
state_message
string
on success
An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Sample:
state_message_example
 
time_created
string
on success
The time the the IntegrationInstance was created. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the IntegrationInstance was updated. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)