oracle.oci.oci_streaming_stream_pool_facts – Fetches details about one or multiple StreamPool 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_streaming_stream_pool_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • List the stream pools for a given compartment ID.

  • If stream_pool_id is specified, the details of a single StreamPool will be returned.

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 OCID of the compartment.
Required to list multiple stream_pools.
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.
lifecycle_state
string
    Choices:
  • CREATING
  • ACTIVE
  • DELETING
  • DELETED
  • FAILED
  • UPDATING
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
name
string
A filter to return only resources that match the given name exactly.
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:
  • NAME
  • TIMECREATED
The field to sort by. You can provide no more than one sort order. By default, `TIMECREATED` sorts results in descending order and `NAME` sorts results in ascending order.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'asc' or 'desc'.
stream_pool_id
string
The OCID of the stream pool.
Required to get a specific stream_pool.

aliases: id
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: Get a specific stream_pool
  oci_streaming_stream_pool_facts:
    # required
    stream_pool_id: "ocid1.streampool.oc1..xxxxxxEXAMPLExxxxxx"

- name: List stream_pools
  oci_streaming_stream_pool_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    name: name_example
    sort_by: NAME
    sort_order: ASC
    lifecycle_state: CREATING

Return Values

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

Key Returned Description
stream_pools
complex
on success
List of StreamPool resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'custom_encryption_key': {'key_state': 'ACTIVE', 'kms_key_id': 'ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx'}, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'endpoint_fqdn': 'endpoint_fqdn_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_private': True, 'kafka_settings': {'auto_create_topics_enable': True, 'bootstrap_servers': 'bootstrap_servers_example', 'log_retention_hours': 56, 'num_partitions': 56}, 'lifecycle_state': 'CREATING', 'lifecycle_state_details': 'lifecycle_state_details_example', 'name': 'name_example', 'private_endpoint_settings': {'nsg_ids': [], 'private_endpoint_ip': 'private_endpoint_ip_example', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx'}, 'time_created': '2013-10-20T19:20:30+01:00'}]
 
compartment_id
string
on success
Compartment OCID that the pool belongs to.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
custom_encryption_key
complex
on success
Returned for get operation

   
key_state
string
on success
Life cycle State of the custom key

Sample:
ACTIVE
   
kms_key_id
string
on success
Custom Encryption Key (Master Key) ocid.

Sample:
ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}'

Sample:
{'Operations': {'CostCenter': 'US'}}
 
endpoint_fqdn
string
on success
The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a Stream object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.
Returned for get operation

Sample:
endpoint_fqdn_example
 
freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross- compatibility only. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the stream pool.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_private
boolean
on success
True if the stream pool is private, false otherwise. If the stream pool is private, the streams inside the stream pool can only be accessed from inside the associated subnetId.

Sample:
True
 
kafka_settings
complex
on success
Returned for get operation

   
auto_create_topics_enable
boolean
on success
Enable auto creation of topic on the server.

Sample:
True
   
bootstrap_servers
string
on success
Bootstrap servers.

Sample:
bootstrap_servers_example
   
log_retention_hours
integer
on success
The number of hours to keep a log file before deleting it (in hours).

Sample:
56
   
num_partitions
integer
on success
The default number of log partitions per topic.

Sample:
56
 
lifecycle_state
string
on success
The current state of the stream pool.

Sample:
CREATING
 
lifecycle_state_details
string
on success
Any additional details about the current state of the stream.
Returned for get operation

Sample:
lifecycle_state_details_example
 
name
string
on success
The name of the stream pool.

Sample:
name_example
 
private_endpoint_settings
complex
on success
Returned for get operation

   
nsg_ids
list / elements=string
on success
The optional list of network security groups that are associated with the private endpoint of the stream pool.

   
private_endpoint_ip
string
on success
The private IP associated with the stream pool in the associated subnetId. The stream pool's FQDN resolves to that IP and should be used - instead of the private IP - in order to not trigger any TLS issues.

Sample:
private_endpoint_ip_example
   
subnet_id
string
on success
The subnet id from which the private stream pool can be accessed. Trying to access the streams from another network location will result in an error.

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
 
time_created
string
on success
The date and time the stream pool was created, expressed in in RFC 3339 timestamp format.
Example: `2018-04-20T00:00:07.405Z`

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


Authors

  • Oracle (@oracle)