Try SpotterFetches details about one or multiple CccUpgradeSchedule 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 CccUpgradeSchedule resources in Oracle Cloud Infrastructure
Returns a list of Compute Cloud@Customer upgrade schedules.
If I(ccc_upgrade_schedule_id) is specified, the details of a single CccUpgradeSchedule will be returned.
- name: Get a specific ccc_upgrade_schedule
oci_compute_cloud_at_customer_ccc_upgrade_schedule_facts:
# required
ccc_upgrade_schedule_id: "ocid1.cccupgradeschedule.oc1..xxxxxxEXAMPLExxxxxx"
- name: List ccc_upgrade_schedules
oci_compute_cloud_at_customer_ccc_upgrade_schedule_facts:
# optional
ccc_upgrade_schedule_id: "ocid1.cccupgradeschedule.oc1..xxxxxxEXAMPLExxxxxx"
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
compartment_id_in_subtree: true
access_level: RESTRICTED
lifecycle_state: ACTIVE
display_name: display_name_example
display_name_contains: display_name_contains_example
sort_order: ASC
sort_by: timeCreated
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:
- timeCreated
- displayName
description:
- The field to sort by. Only one sort order may be provided. Default order for timeCreated
is descending. Default order for displayName is ascending.
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
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 sort order to use, either 'ASC' or 'DESC'.
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
access_level:
choices:
- RESTRICTED
- ACCESSIBLE
description:
- Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this
to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions
directly or indirectly (permissions can be on a resource in a subcompartment). When
set to RESTRICTED permissions are checked and no partial results are displayed.
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:
- A filter to return only resources that match the entire display name given.
type: str
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the compartment in which to list resources.
type: str
lifecycle_state:
choices:
- ACTIVE
- NEEDS_ATTENTION
- DELETED
- FAILED
description:
- A filter to return resources only when their lifecycleState matches the given lifecycleState.
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
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
display_name_contains:
description:
- A filter to return only resources whose display name contains the substring.
type: str
ccc_upgrade_schedule_id:
aliases:
- id
description:
- Compute Cloud@Customer upgrade schedule L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
- Required to get a specific ccc_upgrade_schedule.
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
compartment_id_in_subtree:
description:
- Default is false. When set to true, the hierarchy of compartments is traversed and
all compartments and sub-compartments in the tenancy are returned. Depends on the
'accessLevel' setting.
type: bool
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
ccc_upgrade_schedules:
contains:
compartment_id:
description:
- Compartment L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
for the Compute Cloud@Customer upgrade schedule.
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.
Example: `{"foo-namespace": {"bar-key": "value"}}`'
returned: on success
sample:
Operations:
CostCenter: US
type: dict
description:
description:
- An optional description of the Compute Cloud@Customer upgrade schedule. Avoid
entering confidential information.
- Returned for get operation
returned: on success
sample: description_example
type: str
display_name:
description:
- Compute Cloud@Customer upgrade schedule display name. Avoid entering confidential
information.
returned: on success
sample: display_name_example
type: str
events:
contains:
description:
description:
- A description of the Compute Cloud@Customer upgrade schedule time block.
returned: on success
sample: description_example
type: str
name:
description:
- Generated name associated with the event.
returned: on success
sample: name_example
type: str
schedule_event_duration:
description:
- The duration of this block of time. The duration must be specified and
be of the ISO-8601 format for durations.
returned: on success
sample: schedule_event_duration_example
type: str
schedule_event_recurrences:
description:
- Frequency of recurrence of schedule block. When this field is not included,
the event is assumed to be a one time occurrence. The frequency field
is strictly parsed and must conform to RFC-5545 formatting for recurrences.
returned: on success
sample: schedule_event_recurrences_example
type: str
time_start:
description:
- The date and time when the Compute Cloud@Customer upgrade schedule event
starts, inclusive. An RFC3339 formatted UTC datetime string. For an event
with recurrences, this is the date that a recurrence can start being applied.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
description:
- List of preferred times for Compute Cloud@Customer infrastructures associated
with this schedule to be upgraded.
- Returned for get operation
returned: on success
type: complex
freeform_tags:
description:
- 'Simple key-value pair that is applied without any predefined name, type or
scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`'
returned: on success
sample:
Department: Finance
type: dict
id:
description:
- Upgrade schedule L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
This cannot be changed once created.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
infrastructure_ids:
description:
- List of Compute Cloud@Customer infrastructure L(OCIDs,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
that are using this upgrade schedule.
- Returned for get operation
returned: on success
sample: []
type: list
lifecycle_details:
description:
- A message describing the current state in more detail. For example, the message
can be used to provide actionable information for a resource in a Failed state.
- Returned for get operation
returned: on success
sample: lifecycle_details_example
type: str
lifecycle_state:
description:
- Lifecycle state of the resource.
returned: on success
sample: ACTIVE
type: str
system_tags:
description:
- 'System tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`'
returned: on success
sample: {}
type: dict
time_created:
description:
- The time the upgrade schedule was created, using an RFC3339 formatted datetime
string.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_updated:
description:
- The time the upgrade schedule was updated, using an RFC3339 formatted datetime
string.
- Returned for get operation
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
description:
- List of CccUpgradeSchedule resources
returned: on success
sample:
- compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
defined_tags:
Operations:
CostCenter: US
description: description_example
display_name: display_name_example
events:
- description: description_example
name: name_example
schedule_event_duration: schedule_event_duration_example
schedule_event_recurrences: schedule_event_recurrences_example
time_start: '2013-10-20T19:20:30+01:00'
freeform_tags:
Department: Finance
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
infrastructure_ids: []
lifecycle_details: lifecycle_details_example
lifecycle_state: ACTIVE
system_tags: {}
time_created: '2013-10-20T19:20:30+01:00'
time_updated: '2013-10-20T19:20:30+01:00'
type: complex