oracle.oci.oci_healthchecks_ping_monitor_facts – Fetches details about one or multiple PingMonitor 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_ping_monitor_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple PingMonitor resources in Oracle Cloud Infrastructure
Gets a list of configured ping monitors.
Results are paginated based on page and limit. The opc-next-page header provides a URL for fetching the next page.
If monitor_id is specified, the details of a single PingMonitor 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
|
Filters results by compartment.
Required to list multiple ping_monitors.
|
|
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
|
Filters results that exactly match the `displayName` field.
aliases: name |
|
home_region
string
|
Filters results that match the `homeRegion`.
|
|
monitor_id
string
|
The OCID of a monitor.
Required to get a specific ping_monitor.
aliases: id |
|
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 when listing monitors.
|
sort_order
string
|
|
Controls the sort order of results.
|
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 ping_monitor
oci_healthchecks_ping_monitor_facts:
# required
monitor_id: "ocid1.monitor.oc1..xxxxxxEXAMPLExxxxxx"
- name: List ping_monitors
oci_healthchecks_ping_monitor_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
sort_by: id
sort_order: ASC
display_name: display_name_example
home_region: us-phoenix-1
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
ping_monitors
complex
|
on success |
List of PingMonitor resources
Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'home_region': 'us-phoenix-1', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'interval_in_seconds': 56, 'is_enabled': True, 'port': 56, 'protocol': 'ICMP', 'results_url': 'results_url_example', 'targets': [], 'time_created': '2013-10-20T19:20:30+01:00', 'timeout_in_seconds': 56, 'vantage_point_names': []}]
|
|
compartment_id
string
|
on success |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
|
display_name
string
|
on success |
A user-friendly and mutable name suitable for display in a user interface.
Sample:
display_name_example
|
|
freeform_tags
dictionary
|
on success |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{"Department": "Finance"}`
Sample:
{'Department': 'Finance'}
|
|
home_region
string
|
on success |
The region where updates must be made and where results must be fetched from.
Sample:
us-phoenix-1
|
|
id
string
|
on success |
The OCID of the resource.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|
interval_in_seconds
integer
|
on success |
The monitor interval in seconds. Valid values: 10, 30, and 60.
Sample:
56
|
|
is_enabled
boolean
|
on success |
Enables or disables the monitor. Set to 'true' to launch monitoring.
Sample:
True
|
|
port
integer
|
on success |
The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
Returned for get operation
Sample:
56
|
|
protocol
string
|
on success |
Sample:
ICMP
|
|
results_url
string
|
on success |
A URL for fetching the probe results.
Sample:
results_url_example
|
|
targets
list
/ elements=string
|
on success |
A list of targets (hostnames or IP addresses) of the probe.
Returned for get operation
|
|
time_created
string
|
on success |
The RFC 3339-formatted creation date and time of the probe.
Sample:
2013-10-20T19:20:30+01:00
|
|
timeout_in_seconds
integer
|
on success |
The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to `intervalInSeconds` for monitors.
Returned for get operation
Sample:
56
|
|
vantage_point_names
list
/ elements=string
|
on success |
A list of names of vantage points from which to execute the probe.
Returned for get operation
|
Authors¶
Oracle (@oracle)