oracle.oci.oci_devops_repository_mirror_record_facts – Fetches details about one or multiple RepositoryMirrorRecord resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 4.13.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_devops_repository_mirror_record_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple RepositoryMirrorRecord resources in Oracle Cloud Infrastructure
Returns a list of mirror entry in history within 30 days.
If mirror_record_type is specified, the details of a single RepositoryMirrorRecord 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.
|
|
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 . |
|
mirror_record_type
string
|
|
The field of mirror record type. Only one mirror record type can be provided: current - The current mirror record. lastSuccessful - The last successful mirror record.
Required to get a specific repository_mirror_record.
|
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. |
|
repository_id
string
/ required
|
Unique repository identifier.
|
|
sort_order
string
|
|
The sort order to use. Use either ascending or descending.
|
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 repository_mirror_record
oci_devops_repository_mirror_record_facts:
# required
mirror_record_type: current
repository_id: "ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx"
- name: List repository_mirror_records
oci_devops_repository_mirror_record_facts:
# required
repository_id: "ocid1.repository.oc1..xxxxxxEXAMPLExxxxxx"
# optional
sort_order: ASC
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
repository_mirror_records
complex
|
on success |
List of RepositoryMirrorRecord resources
Sample:
[{'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'freeform_tags': {'Department': 'Finance'}, 'mirror_status': 'NONE', 'time_completed': '2013-10-20T19:20:30+01:00', 'time_ended': '2013-10-20T19:20:30+01:00', 'time_enqueued': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00', 'work_request_id': 'ocid1.workrequest.oc1..xxxxxxEXAMPLExxxxxx'}]
|
|
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: `{"foo-namespace": {"bar-key": "value"}}`
Returned for list operation
Sample:
{'Operations': {'CostCenter': 'US'}}
|
|
freeform_tags
dictionary
|
on success |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: `{"bar-key": "value"}`
Returned for list operation
Sample:
{'Department': 'Finance'}
|
|
mirror_status
string
|
on success |
Mirror status of current mirror entry. QUEUED - Mirroring Queued RUNNING - Mirroring is Running PASSED - Mirroring Passed FAILED - Mirroring Failed
Sample:
NONE
|
|
time_completed
string
|
on success |
The time to complete a mirror operation.
Returned for list operation
Sample:
2013-10-20T19:20:30+01:00
|
|
time_ended
string
|
on success |
The time taken to complete a mirror operation. Value is null if not completed.
Returned for get operation
Sample:
2013-10-20T19:20:30+01:00
|
|
time_enqueued
string
|
on success |
The time to enqueue a mirror operation.
Sample:
2013-10-20T19:20:30+01:00
|
|
time_started
string
|
on success |
The time to start a mirror operation.
Sample:
2013-10-20T19:20:30+01:00
|
|
work_request_id
string
|
on success |
Workrequest ID to track current mirror operation.
Sample:
ocid1.workrequest.oc1..xxxxxxEXAMPLExxxxxx
|
Authors¶
Oracle (@oracle)