oracle.oci.oci_os_management_module_stream_on_managed_instance_facts – Fetches details about one or multiple ModuleStreamOnManagedInstance resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.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_module_stream_on_managed_instance_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple ModuleStreamOnManagedInstance resources in Oracle Cloud Infrastructure

  • Retrieve a list of module streams, along with a summary of their status, from a managed instance. Filters may be applied to select a subset of module streams based on the filter criteria.

  • The ‘moduleName’ attribute filters against the name of a module. It accepts strings of the format “<module>”. If this attribute is defined, only streams that belong to the specified module are included in the result set. If it is not defined, the request is not subject to this filter.

  • The “status” attribute filters against the state of a module stream. Valid values are “ENABLED”, “DISABLED”, and “ACTIVE”. If the attribute is set to “ENABLED”, only module streams that are enabled are included in the result set. If the attribute is set to “DISABLED”, only module streams that are not enabled are included in the result set. If the attribute is set to “ACTIVE”, only module streams that are active are included in the result set. If the attribute is not defined, the request is not subject to this filter.

  • When sorting by the display name, the result set is sorted first by the module name and then by the stream name.

Requirements

The below requirements are needed on the host that executes this module.

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
    Choices:
  • service_principal
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
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
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 ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect.
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.
managed_instance_id
string / required
OCID for the managed instance
module_name
string
The name of a module. This parameter is required if a streamName is specified.
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
    Choices:
  • TIMECREATED
  • DISPLAYNAME
The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'asc' or 'desc'.
stream_name
string
The name of the stream of the containing module. This parameter is required if a profileName is specified.
stream_status
string
    Choices:
  • ENABLED
  • DISABLED
  • ACTIVE
The status of the stream
A stream with the "ENABLED" status can be used as a source for installing profiles. Streams with this status are also "ACTIVE".
A stream with the "DISABLED" status cannot be the source for installing profiles. To install profiles and packages from this stream, it must be enabled.
A stream with the "ACTIVE" status can be used as a source for installing profiles. The packages that comprise the stream are also used when a matching package is installed directly. In general, a stream can have this status if it is the default stream for the module and no stream has been explicitly enabled.
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

Examples

- name: List module_stream_on_managed_instances
  oci_os_management_module_stream_on_managed_instance_facts:
    # required
    managed_instance_id: "ocid1.managedinstance.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    module_name: module_name_example
    stream_name: stream_name_example
    stream_status: ENABLED
    sort_order: ASC
    sort_by: TIMECREATED

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
module_stream_on_managed_instances
complex
on success
List of ModuleStreamOnManagedInstance resources

Sample:
[{'module_name': 'module_name_example', 'profiles': [{'module_name': 'module_name_example', 'profile_name': 'profile_name_example', 'status': 'INSTALLED', 'stream_name': 'stream_name_example', 'time_modified': '2013-10-20T19:20:30+01:00'}], 'software_source_id': 'ocid1.softwaresource.oc1..xxxxxxEXAMPLExxxxxx', 'status': 'ENABLED', 'stream_name': 'stream_name_example', 'time_modified': '2013-10-20T19:20:30+01:00'}]
 
module_name
string
on success
The name of the module that contains the stream.

Sample:
module_name_example
 
profiles
complex
on success
The set of profiles that the module stream contains.

   
module_name
string
on success
The name of the module that contains the stream profile

Sample:
module_name_example
   
profile_name
string
on success
The name of the profile

Sample:
profile_name_example
   
status
string
on success
The status of the profile.
A profile with the "INSTALLED" status indicates that the profile has been installed.
A profile with the "AVAILABLE" status indicates that the profile is not installed, but can be.

Sample:
INSTALLED
   
stream_name
string
on success
The name of the stream that contains the profile

Sample:
stream_name_example
   
time_modified
string
on success
The date and time of the last status change for this profile, as described in RFC 3339, section 14.29.

Sample:
2013-10-20T19:20:30+01:00
 
software_source_id
string
on success
The OCID of the software source that provides this module stream.

Sample:
ocid1.softwaresource.oc1..xxxxxxEXAMPLExxxxxx
 
status
string
on success
The status of the stream
A stream with the "ENABLED" status can be used as a source for installing profiles. Streams with this status are also "ACTIVE".
A stream with the "DISABLED" status cannot be the source for installing profiles. To install profiles and packages from this stream, it must be enabled.
A stream with the "ACTIVE" status can be used as a source for installing profiles. The packages that comprise the stream are also used when a matching package is installed directly. In general, a stream can have this status if it is the default stream for the module and no stream has been explicitly enabled.

Sample:
ENABLED
 
stream_name
string
on success
The name of the stream.

Sample:
stream_name_example
 
time_modified
string
on success
The date and time of the last status change for this profile, as described in RFC 3339, section 14.29.

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)