oracle.oci.oci_service_catalog_private_application_facts – Fetches details about one or multiple PrivateApplication 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_service_catalog_private_application_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple PrivateApplication resources in Oracle Cloud Infrastructure
Lists all the private applications in a given compartment.
If private_application_id is specified, the details of a single PrivateApplication 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.
Required to list multiple private_applications.
|
|
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
|
Exact match name filter.
aliases: name |
|
private_application_id
string
|
The unique identifier for the private application.
Required to get a specific private_application.
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
|
|
The field to use to sort listed results. You can only specify one field to sort by. Default is `TIMECREATED`.
|
sort_order
string
|
|
The sort order to apply, either `ASC` or `DESC`. Default is `ASC`.
|
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 private_application
oci_service_catalog_private_application_facts:
# required
private_application_id: "ocid1.privateapplication.oc1..xxxxxxEXAMPLExxxxxx"
- name: List private_applications
oci_service_catalog_private_application_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
private_application_id: "ocid1.privateapplication.oc1..xxxxxxEXAMPLExxxxxx"
sort_by: TIMECREATED
sort_order: ASC
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 | ||
---|---|---|---|---|
private_applications
complex
|
on success |
List of PrivateApplication resources
Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'logo': {'content_url': 'content_url_example', 'display_name': 'display_name_example', 'mime_type': 'mime_type_example'}, 'long_description': 'long_description_example', 'package_type': 'STACK', 'short_description': 'short_description_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
|
||
compartment_id
string
|
on success |
The OCID of the compartment where the private application resides.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
Returned for get operation
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||
display_name
string
|
on success |
The name of the private application.
Sample:
display_name_example
|
||
freeform_tags
dictionary
|
on success |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
Returned for get operation
Sample:
{'Department': 'Finance'}
|
||
id
string
|
on success |
The unique identifier for the private application in Marketplace.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
lifecycle_state
string
|
on success |
The lifecycle state of the private application.
Sample:
CREATING
|
||
logo
complex
|
on success |
|
||
content_url
string
|
on success |
The content URL of the uploaded data.
Sample:
content_url_example
|
||
display_name
string
|
on success |
The name used to refer to the uploaded data.
Sample:
display_name_example
|
||
mime_type
string
|
on success |
The MIME type of the uploaded data.
Sample:
mime_type_example
|
||
long_description
string
|
on success |
A long description of the private application.
Returned for get operation
Sample:
long_description_example
|
||
package_type
string
|
on success |
Type of packages within this private application.
Sample:
STACK
|
||
short_description
string
|
on success |
A short description of the private application.
Sample:
short_description_example
|
||
time_created
string
|
on success |
The date and time the private application was created, expressed in RFC 3339 timestamp format.
Example: `2021-05-26T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
||
time_updated
string
|
on success |
The date and time the private application was last modified, expressed in RFC 3339 timestamp format.
Example: `2021-12-10T05:10:29.721Z`
Returned for get operation
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)