oracle.oci.oci_healthchecks_http_probe_result_facts – Fetches details about one or multiple HttpProbeResult 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_healthchecks_http_probe_result_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple HttpProbeResult resources in Oracle Cloud Infrastructure
Gets the HTTP probe results for the specified probe or monitor, where the probeConfigurationId is the OCID of either a monitor or an on-demand probe.
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 . |
|
probe_configuration_id
string
/ required
|
The OCID of a monitor or on-demand probe.
|
|
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_order
string
|
|
Controls the sort order of results.
|
start_time_greater_than_or_equal_to
float
|
Returns results with a `startTime` equal to or greater than the specified value.
|
|
start_time_less_than_or_equal_to
float
|
Returns results with a `startTime` equal to or less than the specified value.
|
|
target
string
|
Filters results that match the `target`.
|
|
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: List http_probe_results
oci_healthchecks_http_probe_result_facts:
# required
probe_configuration_id: "ocid1.probeconfiguration.oc1..xxxxxxEXAMPLExxxxxx"
# optional
start_time_greater_than_or_equal_to: 3.4
start_time_less_than_or_equal_to: 3.4
sort_order: ASC
target: target_example
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
http_probe_results
complex
|
on success |
List of HttpProbeResult resources
Sample:
[{'connect_end': 1.2, 'connect_start': 1.2, 'connection': {'address': 'address_example', 'connect_duration': 1.2, 'port': 56, 'secure_connect_duration': 1.2}, 'dns': {'addresses': [], 'domain_lookup_duration': 1.2}, 'domain_lookup_end': 1.2, 'domain_lookup_start': 1.2, 'duration': 1.2, 'encoded_body_size': 56, 'error_category': 'NONE', 'error_message': 'error_message_example', 'fetch_start': 1.2, 'is_healthy': True, 'is_timed_out': True, 'key': 'key_example', 'probe_configuration_id': 'ocid1.probeconfiguration.oc1..xxxxxxEXAMPLExxxxxx', 'protocol': 'HTTP', 'request_start': 1.2, 'response_end': 1.2, 'response_start': 1.2, 'secure_connection_start': 1.2, 'start_time': 1.2, 'status_code': 56, 'target': 'target_example', 'vantage_point_name': 'vantage_point_name_example'}]
|
||
connect_end
float
|
on success |
The time immediately after the vantage point finishes establishing the connection to the server to retrieve the resource.
Sample:
1.2
|
||
connect_start
float
|
on success |
The time immediately before the vantage point starts establishing the connection to the server to retrieve the resource.
Sample:
1.2
|
||
connection
complex
|
on success |
|
||
address
string
|
on success |
The connection IP address.
Sample:
address_example
|
||
connect_duration
float
|
on success |
Total connect duration, calculated using `connectEnd` minus `connectStart`.
Sample:
1.2
|
||
port
integer
|
on success |
The port.
Sample:
56
|
||
secure_connect_duration
float
|
on success |
The duration to secure the connection. This value will be zero for insecure connections. Calculated using `connectEnd` minus `secureConnectionStart`.
Sample:
1.2
|
||
dns
complex
|
on success |
|
||
addresses
list
/ elements=string
|
on success |
The addresses returned by DNS resolution.
|
||
domain_lookup_duration
float
|
on success |
Total DNS resolution duration, in milliseconds. Calculated using `domainLookupEnd` minus `domainLookupStart`.
Sample:
1.2
|
||
domain_lookup_end
float
|
on success |
The time immediately before the vantage point finishes the domain name lookup for the resource.
Sample:
1.2
|
||
domain_lookup_start
float
|
on success |
The time immediately before the vantage point starts the domain name lookup for the resource.
Sample:
1.2
|
||
duration
float
|
on success |
The total duration from start of request until response is fully consumed or the connection is closed.
Sample:
1.2
|
||
encoded_body_size
integer
|
on success |
The size, in octets, of the payload body prior to removing any applied content-codings.
Sample:
56
|
||
error_category
string
|
on success |
The category of error if an error occurs executing the probe. The `errorMessage` field provides a message with the error details. * NONE - No error * DNS - DNS errors * TRANSPORT - Transport-related errors, for example a "TLS certificate expired" error. * NETWORK - Network-related errors, for example a "network unreachable" error. * SYSTEM - Internal system errors.
Sample:
NONE
|
||
error_message
string
|
on success |
The error information indicating why a probe execution failed.
Sample:
error_message_example
|
||
fetch_start
float
|
on success |
The time immediately before the vantage point starts to fetch the resource.
Sample:
1.2
|
||
is_healthy
boolean
|
on success |
True if the probe result is determined to be healthy based on probe type-specific criteria. For HTTP probes, a probe result is considered healthy if the HTTP response code is greater than or equal to 200 and less than 300.
Sample:
True
|
||
is_timed_out
boolean
|
on success |
True if the probe did not complete before the configured `timeoutInSeconds` value.
Sample:
True
|
||
key
string
|
on success |
A value identifying this specific probe result. The key is only unique within the results of its probe configuration. The key may be reused after 90 days.
Sample:
key_example
|
||
probe_configuration_id
string
|
on success |
The OCID of the monitor or on-demand probe responsible for creating this result.
Sample:
ocid1.probeconfiguration.oc1..xxxxxxEXAMPLExxxxxx
|
||
protocol
string
|
on success |
Sample:
HTTP
|
||
request_start
float
|
on success |
The time immediately before the vantage point starts requesting the resource from the server.
Sample:
1.2
|
||
response_end
float
|
on success |
The time immediately after the vantage point receives the last byte of the response or immediately before the transport connection is closed, whichever comes first.
Sample:
1.2
|
||
response_start
float
|
on success |
The time immediately after the vantage point's HTTP parser receives the first byte of the response.
Sample:
1.2
|
||
secure_connection_start
float
|
on success |
The time immediately before the vantage point starts the handshake process to secure the current connection.
Sample:
1.2
|
||
start_time
float
|
on success |
The date and time the probe was executed, expressed in milliseconds since the POSIX epoch. This field is defined by the PerformanceResourceTiming interface of the W3C Resource Timing specification. For more information, see Resource Timing.
Sample:
1.2
|
||
status_code
integer
|
on success |
The HTTP response status code.
Sample:
56
|
||
target
string
|
on success |
The target hostname or IP address of the probe.
Sample:
target_example
|
||
vantage_point_name
string
|
on success |
The name of the vantage point that executed the probe.
Sample:
vantage_point_name_example
|
Authors¶
Oracle (@oracle)