oracle.oci.oci_compute_app_catalog_listing_facts – Fetches details about one or multiple AppCatalogListing resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.0.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_compute_app_catalog_listing_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple AppCatalogListing resources in Oracle Cloud Infrastructure
Lists the published listings.
If listing_id is specified, the details of a single AppCatalogListing 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
|
A filter to return only resources that match the given display name exactly.
aliases: name |
|
listing_id
string
|
The OCID of the listing.
Required to get a specific app_catalog_listing.
aliases: id |
|
publisher_name
string
|
A filter to return only the publisher that matches the given publisher name exactly.
|
|
publisher_type
string
|
A filter to return only publishers that match the given publisher type exactly. Valid types are OCI, ORACLE, TRUSTED, STANDARD.
|
|
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_order
string
|
|
The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive.
|
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 app_catalog_listing
oci_compute_app_catalog_listing_facts:
# required
listing_id: "ocid1.listing.oc1..xxxxxxEXAMPLExxxxxx"
- name: List app_catalog_listings
oci_compute_app_catalog_listing_facts:
# optional
sort_order: ASC
publisher_name: publisher_name_example
publisher_type: publisher_type_example
display_name: display_name_example
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
app_catalog_listings
complex
|
on success |
List of AppCatalogListing resources
Sample:
[{'contact_url': 'contact_url_example', 'description': 'description_example', 'display_name': 'display_name_example', 'listing_id': 'ocid1.listing.oc1..xxxxxxEXAMPLExxxxxx', 'publisher_logo_url': 'publisher_logo_url_example', 'publisher_name': 'publisher_name_example', 'summary': 'summary_example', 'time_published': '2013-10-20T19:20:30+01:00'}]
|
|
contact_url
string
|
on success |
Listing's contact URL.
Returned for get operation
Sample:
contact_url_example
|
|
description
string
|
on success |
Description of the listing.
Returned for get operation
Sample:
description_example
|
|
display_name
string
|
on success |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Sample:
display_name_example
|
|
listing_id
string
|
on success |
The OCID of the listing.
Sample:
ocid1.listing.oc1..xxxxxxEXAMPLExxxxxx
|
|
publisher_logo_url
string
|
on success |
Publisher's logo URL.
Returned for get operation
Sample:
publisher_logo_url_example
|
|
publisher_name
string
|
on success |
Name of the publisher who published this listing.
Sample:
publisher_name_example
|
|
summary
string
|
on success |
Summary of the listing.
Sample:
summary_example
|
|
time_published
string
|
on success |
Date and time the listing was published, in RFC3339 format. Example: `2018-03-20T12:32:53.532Z`
Returned for get operation
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)