oracle.oci.oci_media_services_stream_cdn_config_facts – Fetches details about one or multiple StreamCdnConfig 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_media_services_stream_cdn_config_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Lists the StreamCdnConfig.

  • If stream_cdn_config_id is specified, the details of a single StreamCdnConfig 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.
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
A filter to return only the resources that match the entire display name given.

aliases: name
distribution_channel_id
string
The Stream Distribution Channel identifier this CdnConfig belongs to.
Required to list multiple stream_cdn_configs.
lifecycle_state
string
    Choices:
  • ACTIVE
  • NEEDS_ATTENTION
  • DELETED
A filter to return only the resources with lifecycleState matching the given lifecycleState.
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.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'ASC' or 'DESC'.
stream_cdn_config_id
string
Unique StreamCdnConfig identifier.
Required to get a specific stream_cdn_config.

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_cdn_config
  oci_media_services_stream_cdn_config_facts:
    # required
    stream_cdn_config_id: "ocid1.streamcdnconfig.oc1..xxxxxxEXAMPLExxxxxx"

- name: List stream_cdn_configs
  oci_media_services_stream_cdn_config_facts:
    # required
    distribution_channel_id: "ocid1.distributionchannel.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    lifecycle_state: ACTIVE
    display_name: display_name_example
    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
stream_cdn_configs
complex
on success
List of StreamCdnConfig resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'config': {'edge_hostname': 'edge_hostname_example', 'edge_path_prefix': 'edge_path_prefix_example', 'edge_token_key': 'edge_token_key_example', 'edge_token_salt': 'edge_token_salt_example', 'is_edge_token_auth': True, 'origin_auth_secret_key_a': 'origin_auth_secret_key_a_example', 'origin_auth_secret_key_b': 'origin_auth_secret_key_b_example', 'origin_auth_secret_key_nonce_a': 'origin_auth_secret_key_nonce_a_example', 'origin_auth_secret_key_nonce_b': 'origin_auth_secret_key_nonce_b_example', 'origin_auth_sign_encryption': 'SHA256-HMAC', 'origin_auth_sign_type': 'ForwardURL', 'type': 'EDGE'}, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'distribution_channel_id': 'ocid1.distributionchannel.oc1..xxxxxxEXAMPLExxxxxx', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_enabled': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'ACTIVE', 'lifecyle_details': 'lifecyle_details_example', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
 
compartment_id
string
on success
Compartment Identifier.

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

   
edge_hostname
string
on success
The hostname of the CDN edge server to use when building CDN URLs.

Sample:
edge_hostname_example
   
edge_path_prefix
string
on success
The path to prepend when building CDN URLs.

Sample:
edge_path_prefix_example
   
edge_token_key
string
on success
The encryption key to use for edge token authentication.

Sample:
edge_token_key_example
   
edge_token_salt
string
on success
Salt to use when encrypting authentication token.

Sample:
edge_token_salt_example
   
is_edge_token_auth
boolean
on success
Whether token authentication should be used at the CDN edge.

Sample:
True
   
origin_auth_secret_key_a
string
on success
The shared secret key A, two for errorless key rotation.

Sample:
origin_auth_secret_key_a_example
   
origin_auth_secret_key_b
string
on success
The shared secret key B, two for errorless key rotation.

Sample:
origin_auth_secret_key_b_example
   
origin_auth_secret_key_nonce_a
string
on success
Nonce identifier for originAuthSecretKeyA (used to determine key used to sign).

Sample:
origin_auth_secret_key_nonce_a_example
   
origin_auth_secret_key_nonce_b
string
on success
Nonce identifier for originAuthSecretKeyB (used to determine key used to sign).

Sample:
origin_auth_secret_key_nonce_b_example
   
origin_auth_sign_encryption
string
on success
The type of encryption used to compute the signature.

Sample:
SHA256-HMAC
   
origin_auth_sign_type
string
on success
The type of data used to compute the signature.

Sample:
ForwardURL
   
type
string
on success
The name of the CDN configuration type.

Sample:
EDGE
 
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"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
The CDN Configuration identifier or display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.

Sample:
display_name_example
 
distribution_channel_id
string
on success
Distribution Channel Identifier.

Sample:
ocid1.distributionchannel.oc1..xxxxxxEXAMPLExxxxxx
 
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"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
Unique identifier that is immutable on creation.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_enabled
boolean
on success
Whether publishing to CDN is enabled.

Sample:
True
 
lifecycle_details
string
on success
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
Returned for list operation

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the CDN Configuration.

Sample:
ACTIVE
 
lifecyle_details
string
on success
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
Returned for get operation

Sample:
lifecyle_details_example
 
system_tags
dictionary
on success
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

 
time_created
string
on success
The time when the CDN Config was created. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time when the CDN Config was updated. An RFC3339 formatted datetime string.

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


Authors

  • Oracle (@oracle)