oracle.oci.oci_container_engine_addon_facts – Fetches details about one or multiple Addon resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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_container_engine_addon_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple Addon resources in Oracle Cloud Infrastructure
List addon for a provisioned cluster.
If addon_name is specified, the details of a single Addon will be returned.
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 |
---|---|---|
addon_name
string
|
The name of the addon.
Required to get a specific addon.
|
|
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.
|
|
cluster_id
string
/ required
|
The OCID of the cluster.
|
|
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 . |
|
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. |
|
sort_by
string
|
|
The optional field to sort the results by.
|
sort_order
string
|
|
The optional order in which to sort the results.
|
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 |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific addon
oci_container_engine_addon_facts:
# required
addon_name: addon_name_example
cluster_id: "ocid1.cluster.oc1..xxxxxxEXAMPLExxxxxx"
- name: List addons
oci_container_engine_addon_facts:
# required
cluster_id: "ocid1.cluster.oc1..xxxxxxEXAMPLExxxxxx"
# optional
sort_order: ASC
sort_by: NAME
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
addons
complex
|
on success |
List of Addon resources
Sample:
[{'addon_error': {'code': 'code_example', 'message': 'message_example', 'status': 'status_example'}, 'configurations': [{'key': 'key_example', 'value': 'value_example'}], 'current_installed_version': 'current_installed_version_example', 'lifecycle_state': 'CREATING', 'name': 'name_example', 'time_created': '2013-10-20T19:20:30+01:00', 'version': 'version_example'}]
|
||
addon_error
complex
|
on success |
The error info of the addon.
|
||
code
string
|
on success |
A short error code that defines the upstream error, meant for programmatic parsing. See API Errors.
Sample:
code_example
|
||
message
string
|
on success |
A human-readable error string of the upstream error.
Sample:
message_example
|
||
status
string
|
on success |
The status of the HTTP response encountered in the upstream error.
Sample:
status_example
|
||
configurations
complex
|
on success |
Addon configuration details.
Returned for get operation
|
||
key
string
|
on success |
configuration key name
Sample:
key_example
|
||
value
string
|
on success |
configuration value name
Sample:
value_example
|
||
current_installed_version
string
|
on success |
current installed version of the addon
Sample:
current_installed_version_example
|
||
lifecycle_state
string
|
on success |
The state of the addon.
Sample:
CREATING
|
||
name
string
|
on success |
The name of the addon.
Sample:
name_example
|
||
time_created
string
|
on success |
The time the cluster was created.
Sample:
2013-10-20T19:20:30+01:00
|
||
version
string
|
on success |
selected addon version, or null indicates autoUpdate
Sample:
version_example
|
Authors¶
Oracle (@oracle)