oracle.oci.oci_golden_gate_deployment_upgrade_facts – Fetches details about one or multiple DeploymentUpgrade resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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_golden_gate_deployment_upgrade_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple DeploymentUpgrade resources in Oracle Cloud Infrastructure
Lists the Deployment Upgrades in a compartment.
If deployment_upgrade_id is specified, the details of a single DeploymentUpgrade will be returned.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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 that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.
Required to list multiple deployment_upgrades.
|
|
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 . |
|
deployment_id
string
|
The OCID of the deployment in which to list resources.
|
|
deployment_upgrade_id
string
|
A unique Deployment Upgrade identifier.
Required to get a specific deployment_upgrade.
aliases: id |
|
display_name
string
|
A filter to return only the resources that match the entire 'displayName' given.
aliases: name |
|
lifecycle_state
string
|
|
A filter to return only the resources that match the 'lifecycleState' given.
|
realm_specific_endpoint_template_enabled
boolean
|
|
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
|
|
The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is descending. Default order for 'displayName' is ascending. If no value is specified timeCreated is the default.
|
sort_order
string
|
|
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 |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific deployment_upgrade
oci_golden_gate_deployment_upgrade_facts:
# required
deployment_upgrade_id: "ocid1.deploymentupgrade.oc1..xxxxxxEXAMPLExxxxxx"
- name: List deployment_upgrades
oci_golden_gate_deployment_upgrade_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
deployment_id: "ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx"
lifecycle_state: CREATING
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 | |
---|---|---|---|
deployment_upgrades
complex
|
on success |
List of DeploymentUpgrade resources
Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'deployment_id': 'ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx', 'deployment_upgrade_type': 'MANUAL', 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_cancel_allowed': True, 'is_reschedule_allowed': True, 'is_rollback_allowed': True, 'is_security_fix': True, 'is_snoozed': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'lifecycle_sub_state': 'RECOVERING', 'ogg_version': 'ogg_version_example', 'previous_ogg_version': 'previous_ogg_version_example', 'release_type': 'MAJOR', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_finished': '2013-10-20T19:20:30+01:00', 'time_ogg_version_supported_until': '2013-10-20T19:20:30+01:00', 'time_released': '2013-10-20T19:20:30+01:00', 'time_schedule': '2013-10-20T19:20:30+01:00', 'time_schedule_max': '2013-10-20T19:20:30+01:00', 'time_snoozed_until': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
|
|
compartment_id
string
|
on success |
The OCID of the compartment being referenced.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|
defined_tags
dictionary
|
on success |
Tags defined for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
|
deployment_id
string
|
on success |
The OCID of the deployment being referenced.
Sample:
ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx
|
|
deployment_upgrade_type
string
|
on success |
The type of the deployment upgrade: MANUAL or AUTOMATIC
Sample:
MANUAL
|
|
description
string
|
on success |
Metadata about this specific object.
Sample:
description_example
|
|
display_name
string
|
on success |
An object's Display Name.
Sample:
display_name_example
|
|
freeform_tags
dictionary
|
on success |
A 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 |
The OCID of the deployment upgrade being referenced.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|
is_cancel_allowed
boolean
|
on success |
Indicates if cancel is allowed. Scheduled upgrade can be cancelled only if target version is not forced by service, otherwise only reschedule allowed.
Sample:
True
|
|
is_reschedule_allowed
boolean
|
on success |
Indicates if reschedule is allowed. Upgrade can be rescheduled postponed until the end of the service defined auto-upgrade period.
Sample:
True
|
|
is_rollback_allowed
boolean
|
on success |
Indicates if rollback is allowed. In practice only the last upgrade can be rolled back. - Manual upgrade is allowed to rollback only until the old version isn't deprecated yet. - Automatic upgrade by default is not allowed, unless a serious issue does not justify.
Sample:
True
|
|
is_security_fix
boolean
|
on success |
Indicates if OGG release contains security fix.
Sample:
True
|
|
is_snoozed
boolean
|
on success |
Indicates if upgrade notifications are snoozed or not.
Sample:
True
|
|
lifecycle_details
string
|
on success |
Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
Sample:
lifecycle_details_example
|
|
lifecycle_state
string
|
on success |
Possible lifecycle states.
Sample:
CREATING
|
|
lifecycle_sub_state
string
|
on success |
Possible GGS lifecycle sub-states.
Sample:
RECOVERING
|
|
ogg_version
string
|
on success |
Version of OGG
Sample:
ogg_version_example
|
|
previous_ogg_version
string
|
on success |
Version of OGG
Sample:
previous_ogg_version_example
|
|
release_type
string
|
on success |
The type of release.
Sample:
MAJOR
|
|
system_tags
dictionary
|
on success |
The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags.
Example: `{orcl-cloud: {free-tier-retain: true}}`
|
|
time_created
string
|
on success |
The time the resource was created. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.
Sample:
2013-10-20T19:20:30+01:00
|
|
time_finished
string
|
on success |
The date and time the request was finished. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.
Sample:
2013-10-20T19:20:30+01:00
|
|
time_ogg_version_supported_until
string
|
on success |
The time until OGG version is supported. After this date has passed OGG version will not be available anymore. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.
Sample:
2013-10-20T19:20:30+01:00
|
|
time_released
string
|
on success |
The time the resource was released. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.
Sample:
2013-10-20T19:20:30+01:00
|
|
time_schedule
string
|
on success |
The time of upgrade schedule. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.
Sample:
2013-10-20T19:20:30+01:00
|
|
time_schedule_max
string
|
on success |
Indicates the latest time until the deployment upgrade could be rescheduled. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.
Sample:
2013-10-20T19:20:30+01:00
|
|
time_snoozed_until
string
|
on success |
The time the upgrade notifications are snoozed until. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.
Sample:
2013-10-20T19:20:30+01:00
|
|
time_started
string
|
on success |
The date and time the request was started. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.
Sample:
2013-10-20T19:20:30+01:00
|
|
time_updated
string
|
on success |
The time the resource was last updated. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)