oracle.oci.oci_os_management_hub_module_stream_facts – Fetches details about one or multiple ModuleStream resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.3.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_os_management_hub_module_stream_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple ModuleStream resources in Oracle Cloud Infrastructure
Lists module streams from the specified software source OCID. Filter the list against a variety of criteria including but not limited to its module name and (stream) name.
If module_name is specified, the details of a single ModuleStream 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 . |
|
is_latest
boolean
|
|
Indicates whether to list only the latest versions of packages, module streams, and stream profiles.
|
module_name
string
|
The name of the module.
Required to get a specific module_stream.
|
|
module_name_contains
string
|
A filter to return resources that may partially match the module name given.
|
|
name
string
|
The name of the entity to be queried.
|
|
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. |
|
software_source_id
string
/ required
|
The OCID of the software source.
|
|
sort_by
string
|
|
The field to sort by. Only one sort order may be provided. Default order for moduleName is ascending.
|
sort_order
string
|
|
The sort order to use, either 'ASC' or 'DESC'.
|
stream_name
string
|
The name of the stream of the containing module.
Required to get a specific module_stream.
|
|
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 module_stream
oci_os_management_hub_module_stream_facts:
# required
stream_name: stream_name_example
software_source_id: "ocid1.softwaresource.oc1..xxxxxxEXAMPLExxxxxx"
module_name: module_name_example
- name: List module_streams
oci_os_management_hub_module_stream_facts:
# required
software_source_id: "ocid1.softwaresource.oc1..xxxxxxEXAMPLExxxxxx"
# optional
module_name: module_name_example
name: name_example
is_latest: true
sort_order: ASC
sort_by: moduleName
module_name_contains: module_name_contains_example
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
module_streams
complex
|
on success |
List of ModuleStream resources
Sample:
[{'arch_type': 'X86_64', 'description': 'description_example', 'is_default': True, 'is_latest': True, 'module_name': 'module_name_example', 'name': 'name_example', 'packages': [], 'profiles': [], 'software_source_id': 'ocid1.softwaresource.oc1..xxxxxxEXAMPLExxxxxx'}]
|
|
arch_type
string
|
on success |
The architecture for which the packages in this module stream were built.
Returned for get operation
Sample:
X86_64
|
|
description
string
|
on success |
A description of the contents of the module stream.
Returned for get operation
Sample:
description_example
|
|
is_default
boolean
|
on success |
Indicates if this stream is the default for its module.
Returned for get operation
Sample:
True
|
|
is_latest
boolean
|
on success |
Indicates whether this module stream is the latest.
Sample:
True
|
|
module_name
string
|
on success |
The name of the module that contains the stream.
Sample:
module_name_example
|
|
name
string
|
on success |
The name of the stream.
Sample:
name_example
|
|
packages
list
/ elements=string
|
on success |
A list of packages that are contained by the stream. Each element in the list is the name of a package. The name is suitable to use as an argument to other OS Management Hub APIs that interact directly with packages.
Returned for get operation
|
|
profiles
list
/ elements=string
|
on success |
A list of profiles that are part of the stream. Each element in the list is the name of a profile. The name is suitable to use as an argument to other OS Management Hub APIs that interact directly with module stream profiles. However, it is not URL encoded.
|
|
software_source_id
string
|
on success |
The OCID of the software source that provides this module stream.
Sample:
ocid1.softwaresource.oc1..xxxxxxEXAMPLExxxxxx
|
Authors¶
Oracle (@oracle)