Try SpotterFetches details about one or multiple View resources in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Fetches details about one or multiple View resources in Oracle Cloud Infrastructure
Gets a list of all views within a compartment.
The collection can be filtered by display name, id, or lifecycle state. It can be sorted on creation time or displayName both in ASC or DESC order. Note that when no lifecycleState query parameter is provided, the collection does not include views in the DELETED lifecycleState to be consistent with other operations of the API.
If I(view_id) is specified, the details of a single View will be returned.
- name: Get a specific view
oci_dns_view_facts:
# required
view_id: "ocid1.view.oc1..xxxxxxEXAMPLExxxxxx"
# optional
if_modified_since: if_modified_since_example
scope: GLOBAL
- name: List views
oci_dns_view_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
sort_order: ASC
sort_by: displayName
lifecycle_state: ACTIVE
scope: GLOBAL
scope:
choices:
- GLOBAL
- PRIVATE
description:
- Specifies to operate only on resources that have a matching DNS scope.
type: str
region:
description:
- 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 C(config_file_location)).
Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm)
for more information on OCI regions.
type: str
sort_by:
choices:
- displayName
- timeCreated
description:
- The field by which to sort views.
type: str
tenancy:
description:
- 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 C(config_file_location)). To get the tenancy OCID, please
refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm)
type: str
view_id:
aliases:
- id
description:
- The OCID of the target view.
- Required to get a specific view.
type: str
api_user:
description:
- 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 C(config_file_location)).
To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
auth_type:
choices:
- api_key
- instance_principal
- instance_obo_user
- resource_principal
- security_token
default: api_key
description:
- The type of authentication to use for making API requests. By default C(auth_type="api_key")
based authentication is performed and the API key (see I(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 C(auth_type="instance_principal")
to use instance principal based authentication when running ansible playbooks within
an OCI compute instance.
type: str
sort_order:
choices:
- ASC
- DESC
description:
- The order to sort the resources.
type: str
cert_bundle:
description:
- 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.
type: str
auth_purpose:
choices:
- service_principal
description:
- The auth purpose which can be used in conjunction with 'auth_type=instance_principal'.
The default auth_purpose for instance_principal is None.
type: str
display_name:
aliases:
- name
description:
- The displayName of a resource.
type: str
compartment_id:
description:
- The OCID of the compartment the resource belongs to.
- Required to list multiple views.
type: str
lifecycle_state:
choices:
- ACTIVE
- DELETED
- DELETING
- UPDATING
description:
- The state of a resource.
type: str
api_user_key_file:
description:
- 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 C(config_file_location)).
If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option
must also be provided.
type: str
if_modified_since:
description:
- The `If-Modified-Since` header field makes a GET or HEAD request method conditional
on the selected representation's modification date being more recent than the date
provided in the field-value. Transfer of the selected representation's data is
avoided if that data has not changed.
type: str
config_profile_name:
description:
- The profile to load from the config file referenced by C(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 C(config_file_location).
type: str
api_user_fingerprint:
description:
- 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 C(config_file_location)). To
get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
config_file_location:
description:
- 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.
type: str
api_user_key_pass_phrase:
description:
- Passphrase used by the key referenced in C(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 C(config_file_location)).
type: str
realm_specific_endpoint_template_enabled:
description:
- 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.
type: bool
views:
contains:
_self:
description:
- The canonical absolute URL of the resource.
returned: on success
sample: _self_example
type: str
compartment_id:
description:
- The OCID of the owning compartment.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
- '**Example:** `{"Operations": {"CostCenter": "42"}}`'
returned: on success
sample:
Operations:
CostCenter: US
type: dict
display_name:
description:
- The display name of the view.
returned: on success
sample: display_name_example
type: str
freeform_tags:
description:
- Free-form tags for this resource. Each tag is a simple key-value pair with
no predefined name, type, or namespace. For more information, see L(Resource
Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
- '**Example:** `{"Department": "Finance"}`'
returned: on success
sample:
Department: Finance
type: dict
id:
description:
- The OCID of the view.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
is_protected:
description:
- A Boolean flag indicating whether or not parts of the resource are unable
to be explicitly managed.
returned: on success
sample: true
type: bool
lifecycle_state:
description:
- The current state of the resource.
returned: on success
sample: ACTIVE
type: str
time_created:
description:
- The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format
with a Z offset, as defined by RFC 3339.
- '**Example:** `2016-07-22T17:23:59:60Z`'
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_updated:
description:
- The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ"
format with a Z offset, as defined by RFC 3339.
- '**Example:** `2016-07-22T17:23:59:60Z`'
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
description:
- List of View resources
returned: on success
sample:
- _self: _self_example
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
is_protected: true
lifecycle_state: ACTIVE
time_created: '2013-10-20T19:20:30+01:00'
time_updated: '2013-10-20T19:20:30+01:00'
type: complex