oracle.oci.oci_oda_imported_package_facts – Fetches details about one or multiple ImportedPackage 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_oda_imported_package_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple ImportedPackage resources in Oracle Cloud Infrastructure
Returns a list of summaries for imported packages in the instance.
If package_id is specified, the details of a single ImportedPackage 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 |
---|---|---|
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.
|
|
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 . |
|
display_name
string
|
Use display_name along with the other options to return only resources that match the given display name exactly.
|
|
name
string
|
List only the information for the package with this name. Package names are unique to a publisher and may not change.
Example: `My Package`
|
|
oda_instance_id
string
/ required
|
Unique Digital Assistant instance identifier.
|
|
package_id
string
|
Unique Digital Assistant package identifier.
Required to get a specific imported_package.
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. |
|
sort_by
string
|
|
Sort on this field. You can specify one sort order only. The default sort field is `TIMECREATED`.
The default sort order for `TIMECREATED` is descending, and the default sort order for `DISPLAYNAME` is ascending.
|
sort_order
string
|
|
Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).
|
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 imported_package
oci_oda_imported_package_facts:
# required
package_id: "ocid1.package.oc1..xxxxxxEXAMPLExxxxxx"
oda_instance_id: "ocid1.odainstance.oc1..xxxxxxEXAMPLExxxxxx"
- name: List imported_packages
oci_oda_imported_package_facts:
# required
oda_instance_id: "ocid1.odainstance.oc1..xxxxxxEXAMPLExxxxxx"
# optional
name: name_example
sort_order: ASC
sort_by: TIMECREATED
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
imported_packages
complex
|
on success |
List of ImportedPackage resources
Sample:
[{'current_package_id': 'ocid1.currentpackage.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'name': 'name_example', 'oda_instance_id': 'ocid1.odainstance.oc1..xxxxxxEXAMPLExxxxxx', 'parameter_values': {}, 'status': 'READY', 'status_message': 'status_message_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'version': 'version_example'}]
|
|
current_package_id
string
|
on success |
ID of the package.
Sample:
ocid1.currentpackage.oc1..xxxxxxEXAMPLExxxxxx
|
|
defined_tags
dictionary
|
on success |
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
|
display_name
string
|
on success |
Display name of the package (can change across versions).
Sample:
display_name_example
|
|
freeform_tags
dictionary
|
on success |
Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{"bar-key": "value"}`
Sample:
{'Department': 'Finance'}
|
|
name
string
|
on success |
Stable name of the package (the same across versions).
Sample:
name_example
|
|
oda_instance_id
string
|
on success |
ID of the host instance.
Sample:
ocid1.odainstance.oc1..xxxxxxEXAMPLExxxxxx
|
|
parameter_values
dictionary
|
on success |
A list of parameter values used to import the package.
Returned for get operation
|
|
status
string
|
on success |
Status of the imported package.
Sample:
READY
|
|
status_message
string
|
on success |
Short message explaining the status of this imported package.
Returned for get operation
Sample:
status_message_example
|
|
time_created
string
|
on success |
When the imported package was created. A date-time string as described in RFC 3339, section 14.29.
Sample:
2013-10-20T19:20:30+01:00
|
|
time_updated
string
|
on success |
When the imported package was last updated. A date-time string as described in RFC 3339, section 14.29.
Sample:
2013-10-20T19:20:30+01:00
|
|
version
string
|
on success |
version of the package.
Sample:
version_example
|
Authors¶
Oracle (@oracle)