Try SpotterFetches details about one or multiple AppCatalogListingResourceVersion resources in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Fetches details about one or multiple AppCatalogListingResourceVersion resources in Oracle Cloud Infrastructure
Gets all resource versions for a particular listing.
If I(resource_version) is specified, the details of a single AppCatalogListingResourceVersion will be returned.
- name: Get a specific app_catalog_listing_resource_version
oci_compute_app_catalog_listing_resource_version_facts:
# required
resource_version: resource_version_example
listing_id: "ocid1.listing.oc1..xxxxxxEXAMPLExxxxxx"
- name: List app_catalog_listing_resource_versions
oci_compute_app_catalog_listing_resource_version_facts:
# required
listing_id: "ocid1.listing.oc1..xxxxxxEXAMPLExxxxxx"
# optional
sort_order: ASC
region:
description:
- 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 C(config_file_location)).
Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm)
for more information on OCI regions.
type: str
tenancy:
description:
- 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 C(config_file_location)). To get the tenancy OCID, please
refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm)
type: str
api_user:
description:
- 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 C(config_file_location)).
To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
auth_type:
choices:
- api_key
- instance_principal
- instance_obo_user
- resource_principal
- security_token
default: api_key
description:
- The type of authentication to use for making API requests. By default C(auth_type="api_key")
based authentication is performed and the API key (see I(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 C(auth_type="instance_principal")
to use instance principal based authentication when running ansible playbooks within
an OCI compute instance.
type: str
listing_id:
aliases:
- id
description:
- The OCID of the listing.
required: true
type: str
sort_order:
choices:
- ASC
- DESC
description:
- The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME
sort order is case sensitive.
type: str
cert_bundle:
description:
- 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.
type: str
auth_purpose:
choices:
- service_principal
description:
- The auth purpose which can be used in conjunction with 'auth_type=instance_principal'.
The default auth_purpose for instance_principal is None.
type: str
resource_version:
description:
- Listing Resource Version.
- Required to get a specific app_catalog_listing_resource_version.
type: str
api_user_key_file:
description:
- 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 C(config_file_location)).
If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option
must also be provided.
type: str
config_profile_name:
description:
- The profile to load from the config file referenced by C(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 C(config_file_location).
type: str
api_user_fingerprint:
description:
- 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 C(config_file_location)). To
get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
config_file_location:
description:
- 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.
type: str
api_user_key_pass_phrase:
description:
- Passphrase used by the key referenced in C(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 C(config_file_location)).
type: str
realm_specific_endpoint_template_enabled:
description:
- 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.
type: bool
app_catalog_listing_resource_versions:
contains:
accessible_ports:
description:
- List of accessible ports for instances launched with this listing resource
version.
- Returned for get operation
returned: on success
sample: []
type: list
allowed_actions:
description:
- Allowed actions for the listing resource.
- Returned for get operation
returned: on success
sample: []
type: list
available_regions:
description:
- List of regions that this listing resource version is available.
- For information about regions, see L(Regions and Availability Domains,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm).
- 'Example: `["us-ashburn-1", "us-phoenix-1"]`'
- Returned for get operation
returned: on success
sample: []
type: list
compatible_shapes:
description:
- Array of shapes compatible with this resource.
- You can enumerate all available shapes by calling L(ListShapes,https://docs.cloud.oracle.com/en-
us/iaas/api/#/en/iaas/latest/Shape/ListShapes).
- 'Example: `["VM.Standard1.1", "VM.Standard1.2"]`'
- Returned for get operation
returned: on success
sample: []
type: list
listing_id:
description:
- The OCID of the listing this resource version belongs to.
returned: on success
sample: ocid1.listing.oc1..xxxxxxEXAMPLExxxxxx
type: str
listing_resource_id:
description:
- OCID of the listing resource.
returned: on success
sample: ocid1.listingresource.oc1..xxxxxxEXAMPLExxxxxx
type: str
listing_resource_version:
description:
- Resource Version.
returned: on success
sample: listing_resource_version_example
type: str
time_published:
description:
- 'Date and time the listing resource version was published, in L(RFC3339,https://tools.ietf.org/html/rfc3339)
format. Example: `2018-03-20T12:32:53.532Z`'
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
description:
- List of AppCatalogListingResourceVersion resources
returned: on success
sample:
- accessible_ports: []
allowed_actions: []
available_regions: []
compatible_shapes: []
listing_id: ocid1.listing.oc1..xxxxxxEXAMPLExxxxxx
listing_resource_id: ocid1.listingresource.oc1..xxxxxxEXAMPLExxxxxx
listing_resource_version: listing_resource_version_example
time_published: '2013-10-20T19:20:30+01:00'
type: complex