oracle.oci.oci_optimizer_profile – Manage a Profile 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_optimizer_profile
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a Profile resource in Oracle Cloud Infrastructure
For state=present, creates a new profile.
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 | ||
---|---|---|---|---|
aggregation_interval_in_days
integer
|
The time period over which to collect data for the recommendations, measured in number of days.
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
|
The OCID of the tenancy. The tenancy is the root 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_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. For more information, see Resource Tags.
Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
|
|||
description
string
|
Text describing the profile. Avoid entering confidential information.
Required for create using state=present.
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 applied without any predefined name, type, or namespace. For more information, see Resource Tags. 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.
|
|||
levels_configuration
dictionary
|
Required for create using state=present.
This parameter is updatable.
|
|||
items
list
/ elements=dictionary
|
The array of configuration levels.
|
|||
level
string
|
The pre-defined profile level.
|
|||
recommendation_id
string
|
The unique OCID of the recommendation.
|
|||
name
string
|
The name assigned to the profile. Avoid entering confidential information.
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. |
|||
profile_id
string
|
The unique OCID of the profile.
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 Profile.
Use state=present to create or update a Profile.
Use state=absent to delete a Profile.
|
||
target_compartments
dictionary
|
This parameter is updatable.
|
|||
items
list
/ elements=string / required
|
The list of OCIDs attached to the compartments specified in the current profile override.
|
|||
target_tags
dictionary
|
This parameter is updatable.
|
|||
items
list
/ elements=dictionary / required
|
The list of tags specified in the current profile override.
|
|||
tag_definition_name
string
/ required
|
The name you use to refer to the tag, also known as the tag key.
|
|||
tag_namespace_name
string
/ required
|
The name of the tag namespace.
|
|||
tag_value_type
string
/ required
|
|
Specifies which tag value types in the `tagValues` field result in overrides of the recommendation criteria.
When the value for this field is `ANY`, the `tagValues` field should be empty, which enforces overrides to the recommendation for resources with any tag values attached to them.
When the value for this field value is `VALUE`, the `tagValues` field must include a specific value or list of values. Overrides to the recommendation criteria only occur for resources that match the values in the `tagValues` fields.
|
||
tag_values
list
/ elements=string
|
The list of tag values. The tag value is the value that the user applying the tag adds to the tag key.
|
|||
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 profile
oci_optimizer_profile:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
description: description_example
levels_configuration:
# optional
items:
- # optional
recommendation_id: "ocid1.recommendation.oc1..xxxxxxEXAMPLExxxxxx"
level: level_example
name: name_example
# optional
aggregation_interval_in_days: 56
defined_tags: {'Operations': {'CostCenter': 'US'}}
freeform_tags: {'Department': 'Finance'}
target_compartments:
# required
items: [ "items_example" ]
target_tags:
# required
items:
- # required
tag_namespace_name: tag_namespace_name_example
tag_definition_name: tag_definition_name_example
tag_value_type: VALUE
# optional
tag_values: [ "tag_values_example" ]
- name: Update profile
oci_optimizer_profile:
# required
profile_id: "ocid1.profile.oc1..xxxxxxEXAMPLExxxxxx"
# optional
description: description_example
aggregation_interval_in_days: 56
defined_tags: {'Operations': {'CostCenter': 'US'}}
freeform_tags: {'Department': 'Finance'}
levels_configuration:
# optional
items:
- # optional
recommendation_id: "ocid1.recommendation.oc1..xxxxxxEXAMPLExxxxxx"
level: level_example
target_compartments:
# required
items: [ "items_example" ]
target_tags:
# required
items:
- # required
tag_namespace_name: tag_namespace_name_example
tag_definition_name: tag_definition_name_example
tag_value_type: VALUE
# optional
tag_values: [ "tag_values_example" ]
name: name_example
- name: Update profile using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_optimizer_profile:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
name: name_example
# optional
description: description_example
aggregation_interval_in_days: 56
defined_tags: {'Operations': {'CostCenter': 'US'}}
freeform_tags: {'Department': 'Finance'}
levels_configuration:
# optional
items:
- # optional
recommendation_id: "ocid1.recommendation.oc1..xxxxxxEXAMPLExxxxxx"
level: level_example
target_compartments:
# required
items: [ "items_example" ]
target_tags:
# required
items:
- # required
tag_namespace_name: tag_namespace_name_example
tag_definition_name: tag_definition_name_example
tag_value_type: VALUE
# optional
tag_values: [ "tag_values_example" ]
- name: Delete profile
oci_optimizer_profile:
# required
profile_id: "ocid1.profile.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete profile using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_optimizer_profile:
# 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:
Key | Returned | Description | |||
---|---|---|---|---|---|
profile
complex
|
on success |
Details of the Profile resource acted upon by the current operation
Sample:
{'aggregation_interval_in_days': 56, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'levels_configuration': {'items': [{'level': 'level_example', 'recommendation_id': 'ocid1.recommendation.oc1..xxxxxxEXAMPLExxxxxx'}]}, 'lifecycle_state': 'ACTIVE', 'name': 'name_example', 'target_compartments': {'items': []}, 'target_tags': {'items': [{'tag_definition_name': 'tag_definition_name_example', 'tag_namespace_name': 'tag_namespace_name_example', 'tag_value_type': 'VALUE', 'tag_values': []}]}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
|
|||
aggregation_interval_in_days
integer
|
on success |
The time period over which to collect data for the recommendations, measured in number of days.
Sample:
56
|
|||
compartment_id
string
|
on success |
The OCID of the tenancy. The tenancy is the root compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
|||
description
string
|
on success |
Text describing the profile. Avoid entering confidential information.
Sample:
description_example
|
|||
freeform_tags
dictionary
|
on success |
Simple key-value pair applied without any predefined name, type, or namespace. For more information, see Resource Tags. Exists for cross- compatibility only.
Example: `{"bar-key": "value"}`
Sample:
{'Department': 'Finance'}
|
|||
id
string
|
on success |
The unique OCID of the profile.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|||
levels_configuration
complex
|
on success |
|
|||
items
complex
|
on success |
The array of configuration levels.
|
|||
level
string
|
on success |
The pre-defined profile level.
Sample:
level_example
|
|||
recommendation_id
string
|
on success |
The unique OCID of the recommendation.
Sample:
ocid1.recommendation.oc1..xxxxxxEXAMPLExxxxxx
|
|||
lifecycle_state
string
|
on success |
The profile's current state.
Sample:
ACTIVE
|
|||
name
string
|
on success |
The name assigned to the profile. Avoid entering confidential information.
Sample:
name_example
|
|||
target_compartments
complex
|
on success |
|
|||
items
list
/ elements=string
|
on success |
The list of OCIDs attached to the compartments specified in the current profile override.
|
|||
target_tags
complex
|
on success |
|
|||
items
complex
|
on success |
The list of tags specified in the current profile override.
|
|||
tag_definition_name
string
|
on success |
The name you use to refer to the tag, also known as the tag key.
Sample:
tag_definition_name_example
|
|||
tag_namespace_name
string
|
on success |
The name of the tag namespace.
Sample:
tag_namespace_name_example
|
|||
tag_value_type
string
|
on success |
Specifies which tag value types in the `tagValues` field result in overrides of the recommendation criteria.
When the value for this field is `ANY`, the `tagValues` field should be empty, which enforces overrides to the recommendation for resources with any tag values attached to them.
When the value for this field value is `VALUE`, the `tagValues` field must include a specific value or list of values. Overrides to the recommendation criteria only occur for resources that match the values in the `tagValues` fields.
Sample:
VALUE
|
|||
tag_values
list
/ elements=string
|
on success |
The list of tag values. The tag value is the value that the user applying the tag adds to the tag key.
|
|||
time_created
string
|
on success |
The date and time the profile was created, in the format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
|||
time_updated
string
|
on success |
The date and time the profile was last updated, in the format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)