oracle.oci.oci_oce_instance – Manage an OceInstance resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.5.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_oce_instance.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete an OceInstance resource in Oracle Cloud Infrastructure
For state=present, creates a new OceInstance.
This resource has the following action operations in the oracle.oci.oci_oce_instance_actions module: change_compartment.
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 | |
|---|---|---|---|
|
add_on_features
list
/ elements=string
|
a list of add-on features for the ocm instance
This parameter is updatable.
|
||
|
admin_email
string
|
Admin Email for Notification
Required for create using state=present.
|
||
|
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. |
||
|
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.
|
||
|
description
string
|
OceInstance description
This parameter is updatable.
|
||
|
dr_region
string
|
disaster recovery paired ragion name
This parameter is updatable.
|
||
|
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_access_token
string
|
Identity Cloud Service access token identifying a stripe and service administrator user
Required for create using state=present.
|
||
|
identity_stripe
dictionary
|
|||
|
service_name
string
/ required
|
Name of the Identity Cloud Service instance in My Services to be used. Example: `secondstripe`
|
||
|
tenancy
string
/ required
|
Value of the Identity Cloud Service tenancy. Example: `idcs-8416ebdd0d674f84803f4193cce026e9`
|
||
|
instance_access_type
string
|
|
Flag indicating whether the instance access is private or public
|
|
|
instance_license_type
string
|
|
Flag indicating whether the instance license is new cloud or bring your own license
This parameter is updatable.
|
|
|
instance_usage_type
string
|
|
Instance type based on its usage
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.
|
||
|
lifecycle_details
string
|
|
Details of the current state of the instance lifecycle
This parameter is updatable.
|
|
|
name
string
|
OceInstance Name
Required for create using state=present.
Required for update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set. |
||
|
object_storage_namespace
string
|
Object Storage Namespace of Tenancy
Required for create using state=present.
|
||
|
oce_instance_id
string
|
unique OceInstance 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 |
||
|
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. |
||
|
state
string
|
|
The state of the OceInstance.
Use state=present to create or update an OceInstance.
Use state=absent to delete an OceInstance.
|
|
|
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 |
||
|
tenancy_id
string
|
Tenancy Identifier
Required for create using state=present.
|
||
|
tenancy_name
string
|
Tenancy Name
Required for create using state=present.
|
||
|
upgrade_schedule
string
|
Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version
|
||
|
waf_primary_domain
string
|
Web Application Firewall(WAF) primary domain
This parameter is updatable.
|
||
|
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 oce_instance
oci_oce_instance:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
name: name_example
tenancy_id: "ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx"
idcs_access_token: idcs_access_token_example
tenancy_name: tenancy_name_example
object_storage_namespace: object_storage_namespace_example
admin_email: admin_email_example
# optional
identity_stripe:
# required
service_name: service_name_example
tenancy: tenancy_example
upgrade_schedule: upgrade_schedule_example
instance_access_type: PUBLIC
description: description_example
waf_primary_domain: waf_primary_domain_example
instance_license_type: NEW
instance_usage_type: PRIMARY
add_on_features: [ "add_on_features_example" ]
dr_region: us-phoenix-1
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update oce_instance
oci_oce_instance:
# required
oce_instance_id: "ocid1.oceinstance.oc1..xxxxxxEXAMPLExxxxxx"
# optional
description: description_example
waf_primary_domain: waf_primary_domain_example
instance_license_type: NEW
instance_usage_type: PRIMARY
add_on_features: [ "add_on_features_example" ]
lifecycle_details: STANDBY
dr_region: us-phoenix-1
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update oce_instance using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_oce_instance:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
name: name_example
# optional
description: description_example
waf_primary_domain: waf_primary_domain_example
instance_license_type: NEW
instance_usage_type: PRIMARY
add_on_features: [ "add_on_features_example" ]
lifecycle_details: STANDBY
dr_region: us-phoenix-1
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete oce_instance
oci_oce_instance:
# required
oce_instance_id: "ocid1.oceinstance.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete oce_instance using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_oce_instance:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
name: name_example
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Oracle (@oracle)