oracle.oci.oci_marketplace_listing_package_facts – Fetches details about one or multiple ListingPackage 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_marketplace_listing_package_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple ListingPackage resources in Oracle Cloud Infrastructure
Gets the list of packages for a listing.
If you plan to launch an instance from an image listing, you must first subscribe to the listing. When you launch the instance, you also need to provide the image ID of the listing resource version that you want.
Subscribing to the listing requires you to first get a signature from the terms of use agreement for the listing resource version. To get the signature, issue a GetAppCatalogListingAgreements API call. The AppCatalogListingResourceVersionAgreements object, including its signature, is returned in the response. With the signature for the terms of use agreement for the desired listing resource version, create a subscription by issuing a CreateAppCatalogSubscription API call.
To get the image ID to launch an instance, issue a GetAppCatalogListingResourceVersion API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a LaunchInstance API call.
If package_version is specified, the details of a single ListingPackage 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.
|
|
compartment_id
string
|
The unique identifier for the compartment.
|
|
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 . |
|
listing_id
string
/ required
|
The unique identifier for the listing.
|
|
package_type
string
|
A filter to return only packages that match the given package type exactly.
|
|
package_version
string
|
The version of the package. Package versions are unique within a listing.
Required to get a specific listing_package.
|
|
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 field to use to sort listed results. You can only specify one field to sort by. `TIMERELEASED` displays results in descending order by default. You can change your preference by specifying a different sort order.
|
sort_order
string
|
|
The sort order to use, either `ASC` or `DESC`.
|
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 listing_package
oci_marketplace_listing_package_facts:
# required
listing_id: "ocid1.listing.oc1..xxxxxxEXAMPLExxxxxx"
package_version: package_version_example
# optional
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
- name: List listing_packages
oci_marketplace_listing_package_facts:
# required
listing_id: "ocid1.listing.oc1..xxxxxxEXAMPLExxxxxx"
# optional
package_version: package_version_example
package_type: package_type_example
sort_by: TIMERELEASED
sort_order: ASC
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |||
---|---|---|---|---|---|
listing_packages
complex
|
on success |
List of ListingPackage resources
Sample:
[{'app_catalog_listing_id': 'ocid1.appcataloglisting.oc1..xxxxxxEXAMPLExxxxxx', 'app_catalog_listing_resource_version': 'app_catalog_listing_resource_version_example', 'description': 'description_example', 'image_id': 'ocid1.image.oc1..xxxxxxEXAMPLExxxxxx', 'listing_id': 'ocid1.listing.oc1..xxxxxxEXAMPLExxxxxx', 'operating_system': {'name': 'name_example'}, 'package_type': 'ORCHESTRATION', 'package_version': 'package_version_example', 'pricing': {'currency': 'USD', 'international_market_price': {'currency_code': 'USD', 'currency_symbol': 'currency_symbol_example', 'rate': 1.2}, 'pay_go_strategy': 'PER_OCPU_LINEAR', 'rate': 10, 'type': 'FREE'}, 'regions': [{'code': 'code_example', 'countries': [{'code': 'code_example', 'name': 'name_example'}], 'name': 'name_example'}], 'resource_id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'resource_link': 'resource_link_example', 'time_created': '2013-10-20T19:20:30+01:00', 'variables': [{'data_type': 'STRING', 'default_value': 'default_value_example', 'description': 'description_example', 'hint_message': 'hint_message_example', 'is_mandatory': True, 'name': 'name_example'}], 'version': 'version_example'}]
|
|||
app_catalog_listing_id
string
|
on success |
The ID of the listing resource associated with this listing package. For more information, see AppCatalogListing in the Core Services API.
Returned for get operation
Sample:
ocid1.appcataloglisting.oc1..xxxxxxEXAMPLExxxxxx
|
|||
app_catalog_listing_resource_version
string
|
on success |
The resource version of the listing resource associated with this listing package.
Returned for get operation
Sample:
app_catalog_listing_resource_version_example
|
|||
description
string
|
on success |
Description of this package.
Returned for get operation
Sample:
description_example
|
|||
image_id
string
|
on success |
The ID of the image corresponding to the package.
Returned for get operation
Sample:
ocid1.image.oc1..xxxxxxEXAMPLExxxxxx
|
|||
listing_id
string
|
on success |
The ID of the listing this package belongs to.
Sample:
ocid1.listing.oc1..xxxxxxEXAMPLExxxxxx
|
|||
operating_system
complex
|
on success |
Returned for get operation
|
|||
name
string
|
on success |
The name of the operating system.
Sample:
name_example
|
|||
package_type
string
|
on success |
The specified package's type.
Sample:
ORCHESTRATION
|
|||
package_version
string
|
on success |
The version of the specified package.
Returned for list operation
Sample:
package_version_example
|
|||
pricing
complex
|
on success |
|
|||
currency
string
|
on success |
The currency of the pricing model.
Sample:
USD
|
|||
international_market_price
complex
|
on success |
|
|||
currency_code
string
|
on success |
The currency of the pricing model.
Sample:
USD
|
|||
currency_symbol
string
|
on success |
The symbol of the currency
Sample:
currency_symbol_example
|
|||
rate
float
|
on success |
The pricing rate.
Sample:
1.2
|
|||
pay_go_strategy
string
|
on success |
The type of pricing for a PAYGO model, eg PER_OCPU_LINEAR, PER_OCPU_MIN_BILLING, PER_INSTANCE. Null if type is not PAYGO.
Sample:
PER_OCPU_LINEAR
|
|||
rate
float
|
on success |
The pricing rate.
Sample:
10
|
|||
type
string
|
on success |
The type of the pricing model.
Sample:
FREE
|
|||
regions
complex
|
on success |
The regions where you can deploy the listing package. (Some packages have restrictions that limit their deployment to United States regions only.)
|
|||
code
string
|
on success |
The code of the region.
Sample:
code_example
|
|||
countries
complex
|
on success |
Countries in the region.
|
|||
code
string
|
on success |
A code assigned to the item.
Sample:
code_example
|
|||
name
string
|
on success |
The name of the item.
Sample:
name_example
|
|||
name
string
|
on success |
The name of the region.
Sample:
name_example
|
|||
resource_id
string
|
on success |
The unique identifier for the package resource.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|||
resource_link
string
|
on success |
Link to the orchestration resource.
Returned for get operation
Sample:
resource_link_example
|
|||
time_created
string
|
on success |
The date and time this listing package was created, expressed in RFC 3339 timestamp format.
Example: `2016-08-25T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
|||
variables
complex
|
on success |
List of variables for the orchestration resource.
Returned for get operation
|
|||
data_type
string
|
on success |
The data type of the variable.
Sample:
STRING
|
|||
default_value
string
|
on success |
The variable's default value.
Sample:
default_value_example
|
|||
description
string
|
on success |
A description of the variable.
Sample:
description_example
|
|||
hint_message
string
|
on success |
A brief textual description that helps to explain the variable.
Sample:
hint_message_example
|
|||
is_mandatory
boolean
|
on success |
Whether the variable is mandatory.
Sample:
True
|
|||
name
string
|
on success |
The name of the variable.
Sample:
name_example
|
|||
version
string
|
on success |
The package version.
Returned for get operation
Sample:
version_example
|
Authors¶
Oracle (@oracle)