oracle.oci.oci_apm_synthetics_monitor_result_facts – Fetches details about a MonitorResult resource 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_apm_synthetics_monitor_result_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about a MonitorResult resource in Oracle Cloud Infrastructure
Gets the results for a specific execution of a monitor identified by OCID. The results are in a HAR file, Screenshot, Console Log or Network details.
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 ). |
|
apm_domain_id
string
/ required
|
The APM domain ID the request is intended for.
|
|
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 . |
|
execution_time
string
/ required
|
The time the object was posted.
|
|
monitor_id
string
/ required
|
The OCID of the monitor.
|
|
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. |
|
result_content_type
string
/ required
|
The result content type: zip or raw.
|
|
result_type
string
/ required
|
The result type: har, screenshot, log, or network.
|
|
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 |
|
vantage_point
string
/ required
|
The vantagePoint name.
|
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 monitor_result
oci_apm_synthetics_monitor_result_facts:
# required
apm_domain_id: "ocid1.apmdomain.oc1..xxxxxxEXAMPLExxxxxx"
monitor_id: "ocid1.monitor.oc1..xxxxxxEXAMPLExxxxxx"
vantage_point: vantage_point_example
result_type: result_type_example
result_content_type: result_content_type_example
execution_time: execution_time_example
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
monitor_result
complex
|
on success |
MonitorResult resource
Sample:
{'execution_time': 'execution_time_example', 'monitor_id': 'ocid1.monitor.oc1..xxxxxxEXAMPLExxxxxx', 'result_content_type': 'result_content_type_example', 'result_data_set': [{'byte_content': None, 'name': 'name_example', 'string_content': 'string_content_example', 'timestamp': '2013-10-20T19:20:30+01:00'}], 'result_type': 'result_type_example', 'vantage_point': 'vantage_point_example'}
|
||
execution_time
string
|
on success |
The specific point of time when the result of an execution is collected.
Sample:
execution_time_example
|
||
monitor_id
string
|
on success |
The OCID of the monitor.
Sample:
ocid1.monitor.oc1..xxxxxxEXAMPLExxxxxx
|
||
result_content_type
string
|
on success |
Type of result content. Example: Zip or Raw file.
Sample:
result_content_type_example
|
||
result_data_set
complex
|
on success |
Monitor result data set.
|
||
byte_content
string
|
on success |
Data content in byte format. Example: Zip or Screenshot.
Sample:
null
|
||
name
string
|
on success |
Name of the data.
Sample:
name_example
|
||
string_content
string
|
on success |
Data content in string format. Example: HAR.
Sample:
string_content_example
|
||
timestamp
string
|
on success |
The time when the data was generated, expressed in RFC 3339 timestamp format. Example: `2020-02-13T22:47:12.613Z`
Sample:
2013-10-20T19:20:30+01:00
|
||
result_type
string
|
on success |
Type of result. Example: HAR, Screenshot, Log or Network.
Sample:
result_type_example
|
||
vantage_point
string
|
on success |
The name of the public or dedicated vantage point.
Sample:
vantage_point_example
|
Authors¶
Oracle (@oracle)