oracle.oci.oci_opsi_configurations – Manage an OpsiConfigurations 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_opsi_configurations
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete an OpsiConfigurations resource in Oracle Cloud Infrastructure
For state=present, create an OPSI configuration resource.
This resource has the following action operations in the oracle.oci.oci_opsi_configurations_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 | |
---|---|---|---|
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
|
The OCID of the compartment.
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_item_custom_status
list
/ elements=string
|
|
Specifies whether only customized configuration items or only non-customized configuration items or both have to be returned. By default only customized configuration items are returned.
|
|
config_item_field
list
/ elements=string
|
|
Specifies the fields to return in a config item summary.
|
|
config_items
list
/ elements=dictionary
|
Array of configuration items with custom values. All and only configuration items requiring custom values should be part of this array.
This parameter is updatable.
|
||
config_item_type
string
/ required
|
|
Type of configuration item.
This parameter is updatable.
|
|
name
string
|
Name of configuration item.
This parameter is updatable.
|
||
value
string
|
Value of configuration item.
This parameter is updatable.
|
||
config_items_applicable_context
list
/ elements=string
|
Returns the configuration items filtered by applicable contexts sent in this param. By default configuration items of all applicable contexts are returned.
|
||
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
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
|
||
description
string
|
Description of OPSI configuration.
This parameter is updatable.
|
||
display_name
string
|
User-friendly display name for the OPSI configuration. The name does not have to be unique.
Required for create, 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
|
|
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.
|
||
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.
|
||
opsi_config_field
list
/ elements=string
|
|
Optional fields to return as part of OpsiConfiguration object. Unless requested, these fields will not be returned by default.
|
|
opsi_config_type
string
|
|
OPSI configuration type.
Required for create using state=present, update using state=present with opsi_configuration_id present.
|
|
opsi_configuration_id
string
|
OCID of OPSI configuration resource.
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 OpsiConfigurations.
Use state=present to create or update an OpsiConfigurations.
Use state=absent to delete an OpsiConfigurations.
|
|
system_tags
dictionary
|
System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
This parameter is updatable.
|
||
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 opsi_configurations with opsi_config_type = UX_CONFIGURATION
oci_opsi_configurations:
# required
opsi_config_type: UX_CONFIGURATION
# optional
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
description: description_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
system_tags: null
config_items:
- # required
config_item_type: BASIC
# optional
name: name_example
value: value_example
- name: Update opsi_configurations with opsi_config_type = UX_CONFIGURATION
oci_opsi_configurations:
# required
opsi_config_type: UX_CONFIGURATION
# optional
display_name: display_name_example
description: description_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
system_tags: null
config_items:
- # required
config_item_type: BASIC
# optional
name: name_example
value: value_example
- name: Update opsi_configurations using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with opsi_config_type = UX_CONFIGURATION
oci_opsi_configurations:
# required
opsi_config_type: UX_CONFIGURATION
# optional
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
description: description_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
system_tags: null
config_items:
- # required
config_item_type: BASIC
# optional
name: name_example
value: value_example
- name: Delete opsi_configurations
oci_opsi_configurations:
# required
opsi_configuration_id: "ocid1.opsiconfiguration.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete opsi_configurations using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_opsi_configurations:
# 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 | ||||
---|---|---|---|---|---|---|
opsi_configurations
complex
|
on success |
Details of the OpsiConfigurations resource acted upon by the current operation
Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'config_items': [{'applicable_contexts': [], 'config_item_type': 'BASIC', 'default_value': 'default_value_example', 'metadata': {'config_item_type': 'BASIC', 'data_type': 'data_type_example', 'description': 'description_example', 'display_name': 'display_name_example', 'unit_details': {'display_name': 'display_name_example', 'unit': 'unit_example'}, 'value_input_details': {'allowed_value_type': 'LIMIT', 'max_value': 'max_value_example', 'min_value': 'min_value_example', 'possible_values': []}}, 'name': 'name_example', 'value': 'value_example'}], 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'opsi_config_type': 'UX_CONFIGURATION', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
|
||||
compartment_id
string
|
on success |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||||
config_items
complex
|
on success |
Array of configuration item summary objects.
|
||||
applicable_contexts
list
/ elements=string
|
on success |
List of contexts in Operations Insights where this configuration item is applicable.
|
||||
config_item_type
string
|
on success |
Type of configuration item.
Sample:
BASIC
|
||||
default_value
string
|
on success |
Value of configuration item.
Sample:
default_value_example
|
||||
metadata
complex
|
on success |
|
||||
config_item_type
string
|
on success |
Type of configuration item.
Sample:
BASIC
|
||||
data_type
string
|
on success |
Data type of configuration item. Examples: STRING, BOOLEAN, NUMBER
Sample:
data_type_example
|
||||
description
string
|
on success |
Description of configuration item .
Sample:
description_example
|
||||
display_name
string
|
on success |
User-friendly display name for the configuration item.
Sample:
display_name_example
|
||||
unit_details
complex
|
on success |
|
||||
display_name
string
|
on success |
User-friendly display name for the configuration item unit.
Sample:
display_name_example
|
||||
unit
string
|
on success |
Unit of configuration item.
Sample:
unit_example
|
||||
value_input_details
complex
|
on success |
|
||||
allowed_value_type
string
|
on success |
Allowed value type of configuration item.
Sample:
LIMIT
|
||||
max_value
string
|
on success |
Maximum value limit for the configuration item.
Sample:
max_value_example
|
||||
min_value
string
|
on success |
Minimum value limit for the configuration item.
Sample:
min_value_example
|
||||
possible_values
list
/ elements=string
|
on success |
Allowed values to pick for the configuration item.
|
||||
name
string
|
on success |
Name of configuration item.
Sample:
name_example
|
||||
value
string
|
on success |
Value of configuration item.
Sample:
value_example
|
||||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||||
description
string
|
on success |
Description of OPSI configuration.
Sample:
description_example
|
||||
display_name
string
|
on success |
User-friendly display name for the OPSI configuration. The name does not have to be unique.
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 |
OCID of OPSI configuration resource.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||||
lifecycle_details
string
|
on success |
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
Sample:
lifecycle_details_example
|
||||
lifecycle_state
string
|
on success |
OPSI configuration resource lifecycle state.
Sample:
CREATING
|
||||
opsi_config_type
string
|
on success |
OPSI configuration type.
Sample:
UX_CONFIGURATION
|
||||
system_tags
dictionary
|
on success |
System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
|
||||
time_created
string
|
on success |
The time at which the resource was first created. An RFC3339 formatted datetime string
Sample:
2013-10-20T19:20:30+01:00
|
||||
time_updated
string
|
on success |
The time at which the resource was last updated. An RFC3339 formatted datetime string
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)