oracle.oci.oci_compute_cloud_at_customer_ccc_upgrade_schedule_facts – Fetches details about one or multiple CccUpgradeSchedule resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Returns a list of Compute Cloud@Customer upgrade schedules.

  • If ccc_upgrade_schedule_id is specified, the details of a single CccUpgradeSchedule will be returned.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
access_level
string
    Choices:
  • RESTRICTED
  • ACCESSIBLE
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.
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
  • security_token
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.
ccc_upgrade_schedule_id
string
Compute Cloud@Customer upgrade schedule OCID.
Required to get a specific ccc_upgrade_schedule.

aliases: id
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 in which to list resources.
compartment_id_in_subtree
boolean
    Choices:
  • no
  • yes
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.
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 resources that match the entire display name given.

aliases: name
display_name_contains
string
A filter to return only resources whose display name contains the substring.
lifecycle_state
string
    Choices:
  • ACTIVE
  • NEEDS_ATTENTION
  • DELETED
  • FAILED
A filter to return resources only when their lifecycleState matches the given lifecycleState.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
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.
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'.
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 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

Return Values

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

Key Returned Description
ccc_upgrade_schedules
complex
on success
List of CccUpgradeSchedule resources

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'}]
 
compartment_id
string
on success
Compartment OCID for the Compute Cloud@Customer upgrade schedule.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
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'}}
 
description
string
on success
An optional description of the Compute Cloud@Customer upgrade schedule. Avoid entering confidential information.
Returned for get operation

Sample:
description_example
 
display_name
string
on success
Compute Cloud@Customer upgrade schedule display name. Avoid entering confidential information.

Sample:
display_name_example
 
events
complex
on success
List of preferred times for Compute Cloud@Customer infrastructures associated with this schedule to be upgraded.
Returned for get operation
   
description
string
on success
A description of the Compute Cloud@Customer upgrade schedule time block.

Sample:
description_example
   
name
string
on success
Generated name associated with the event.

Sample:
name_example
   
schedule_event_duration
string
on success
The duration of this block of time. The duration must be specified and be of the ISO-8601 format for durations.

Sample:
schedule_event_duration_example
   
schedule_event_recurrences
string
on success
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.

Sample:
schedule_event_recurrences_example
   
time_start
string
on success
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.

Sample:
2013-10-20T19:20:30+01:00
 
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
Upgrade schedule OCID. This cannot be changed once created.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
infrastructure_ids
list / elements=string
on success
List of Compute Cloud@Customer infrastructure OCIDs that are using this upgrade schedule.
Returned for get operation
 
lifecycle_details
string
on success
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

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
Lifecycle state of the resource.

Sample:
ACTIVE
 
system_tags
dictionary
on success
System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
 
time_created
string
on success
The time the upgrade schedule was created, using an RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the upgrade schedule was updated, using an RFC3339 formatted datetime string.
Returned for get operation

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


Authors

  • Oracle (@oracle)