oracle.oci.oci_budget_alert_rule – Manage a BudgetAlertRule 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_budget_alert_rule
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a BudgetAlertRule resource in Oracle Cloud Infrastructure
For state=present, creates a new Alert Rule.
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 |
---|---|---|
alert_rule_id
string
|
The unique Alert Rule OCID.
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 |
|
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. |
budget_id
string
/ required
|
The unique budget OCID.
|
|
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.
|
|
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: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
|
|
description
string
|
The description of the alert rule.
This parameter is updatable.
|
|
display_name
string
|
The name of the alert rule. Avoid entering confidential information.
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
|
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`
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.
|
|
msg
string
|
The message to be sent to the recipients when the alert rule is triggered.
This parameter is updatable.
aliases: message |
|
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.
|
recipients
string
|
The audience that receives the alert when it triggers. An empty string is interpreted as null.
This parameter is updatable.
|
|
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 BudgetAlertRule.
Use state=present to create or update a BudgetAlertRule.
Use state=absent to delete a BudgetAlertRule.
|
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 |
|
threshold
float
|
The threshold for triggering the alert, expressed as a whole number or decimal value. If the thresholdType is ABSOLUTE, the threshold can have at most 12 digits before the decimal point, and up to two digits after the decimal point. If the thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to two digits after the decimal point.
Required for create using state=present.
This parameter is updatable.
|
|
threshold_type
string
|
|
The type of threshold.
Required for create using state=present.
This parameter is updatable.
|
type
string
|
|
The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).
Required for create using state=present.
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 budget_alert_rule
oci_budget_alert_rule:
# required
type: ACTUAL
threshold: 3.4
threshold_type: PERCENTAGE
budget_id: "ocid1.budget.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
recipients: recipients_example
description: description_example
msg: msg_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update budget_alert_rule
oci_budget_alert_rule:
# required
budget_id: "ocid1.budget.oc1..xxxxxxEXAMPLExxxxxx"
alert_rule_id: "ocid1.alertrule.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
type: ACTUAL
threshold: 3.4
threshold_type: PERCENTAGE
recipients: recipients_example
description: description_example
msg: msg_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update budget_alert_rule using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_budget_alert_rule:
# required
display_name: display_name_example
budget_id: "ocid1.budget.oc1..xxxxxxEXAMPLExxxxxx"
# optional
type: ACTUAL
threshold: 3.4
threshold_type: PERCENTAGE
recipients: recipients_example
description: description_example
msg: msg_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete budget_alert_rule
oci_budget_alert_rule:
# required
budget_id: "ocid1.budget.oc1..xxxxxxEXAMPLExxxxxx"
alert_rule_id: "ocid1.alertrule.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete budget_alert_rule using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_budget_alert_rule:
# required
display_name: display_name_example
budget_id: "ocid1.budget.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
budget_alert_rule
complex
|
on success |
Details of the BudgetAlertRule resource acted upon by the current operation
Sample:
{'budget_id': 'ocid1.budget.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'ACTIVE', 'message': 'message_example', 'recipients': 'recipients_example', 'threshold': 10, 'threshold_type': 'PERCENTAGE', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'type': 'ACTUAL', 'version': 56}
|
|
budget_id
string
|
on success |
The OCID of the budget.
Sample:
ocid1.budget.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: `{"Operations": {"CostCenter": "42"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
|
description
string
|
on success |
The description of the alert rule.
Sample:
description_example
|
|
display_name
string
|
on success |
The name of the alert rule. Avoid entering confidential information.
Sample:
display_name_example
|
|
freeform_tags
dictionary
|
on success |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`
Sample:
{'Department': 'Finance'}
|
|
id
string
|
on success |
The OCID of the alert rule.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|
lifecycle_state
string
|
on success |
The current state of the alert rule.
Sample:
ACTIVE
|
|
message
string
|
on success |
Custom message sent when an alert is triggered.
Sample:
message_example
|
|
recipients
string
|
on success |
The delimited list of email addresses to receive the alert when it triggers. Delimiter characters can be a comma, space, TAB, or semicolon.
Sample:
recipients_example
|
|
threshold
float
|
on success |
The threshold for triggering the alert. If the thresholdType is PERCENTAGE, the maximum value is 10000.
Sample:
10
|
|
threshold_type
string
|
on success |
The type of threshold.
Sample:
PERCENTAGE
|
|
time_created
string
|
on success |
The time the budget was created.
Sample:
2013-10-20T19:20:30+01:00
|
|
time_updated
string
|
on success |
The time the budget was updated.
Sample:
2013-10-20T19:20:30+01:00
|
|
type
string
|
on success |
The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).
Sample:
ACTUAL
|
|
version
integer
|
on success |
The version of the alert rule. Starts from 1 and increments by 1.
Sample:
56
|
Authors¶
Oracle (@oracle)