oracle.oci.oci_apm_synthetics_monitor – Manage a Monitor resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.3.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
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a Monitor resource in Oracle Cloud Infrastructure
For state=present, creates a new monitor.
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. |
|||
availability_configuration
dictionary
|
This parameter is updatable.
|
||||
max_allowed_failures_per_interval
integer
|
Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
|
||||
min_allowed_runs_per_interval
integer
|
Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
|
||||
batch_interval_in_seconds
integer
|
Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
This parameter is updatable.
|
||||
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 . |
||||
configuration
dictionary
|
This parameter is updatable.
|
||||
client_certificate_details
dictionary
|
Applicable when config_type is 'REST_CONFIG'
|
||||
client_certificate
dictionary
|
Applicable when config_type is 'REST_CONFIG'
|
||||
content
string
/ required
|
Content of the client certificate file.
Required when config_type is 'REST_CONFIG'
|
||||
file_name
string
/ required
|
Name of the certificate file. The name should not contain any confidential information.
Required when config_type is 'REST_CONFIG'
|
||||
private_key
dictionary
|
Applicable when config_type is 'REST_CONFIG'
|
||||
content
string
/ required
|
Content of the private key file.
Required when config_type is 'REST_CONFIG'
|
||||
file_name
string
/ required
|
Name of the private key file.
Required when config_type is 'REST_CONFIG'
|
||||
config_type
string
/ required
|
|
Type of configuration.
|
|||
dns_configuration
dictionary
|
|||||
is_override_dns
boolean
|
|
If isOverrideDns is true, then DNS settings will be overridden.
Applicable when config_type is 'SCRIPTED_REST_CONFIG'
|
|||
override_dns_ip
string
|
Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
Applicable when config_type is 'SCRIPTED_REST_CONFIG'
|
||||
is_certificate_validation_enabled
boolean
|
|
If certificate validation is enabled, then the call will fail in case of certification errors.
Applicable when config_type is one of ['SCRIPTED_BROWSER_CONFIG', 'REST_CONFIG', 'BROWSER_CONFIG']
|
|||
is_default_snapshot_enabled
boolean
|
|
If disabled, auto snapshots are not collected.
Applicable when config_type is one of ['SCRIPTED_BROWSER_CONFIG', 'BROWSER_CONFIG']
|
|||
is_failure_retried
boolean
|
|
If isFailureRetried is enabled, then a failed call will be retried.
|
|||
is_redirection_enabled
boolean
|
|
If redirection is enabled, then redirects will be allowed while accessing target URL.
Applicable when config_type is 'REST_CONFIG'
|
|||
network_configuration
dictionary
|
Required when config_type is 'NETWORK_CONFIG'
|
||||
number_of_hops
integer
|
Number of hops.
Applicable when config_type is 'SCRIPTED_REST_CONFIG'
|
||||
probe_mode
string
|
|
Type of probe mode when TCP protocol is selected.
Applicable when config_type is 'SCRIPTED_REST_CONFIG'
|
|||
probe_per_hop
integer
|
Number of probes per hop.
Applicable when config_type is 'SCRIPTED_REST_CONFIG'
|
||||
protocol
string
|
|
Type of protocol.
Applicable when config_type is 'SCRIPTED_REST_CONFIG'
|
|||
transmission_rate
integer
|
Number of probe packets sent out simultaneously.
Applicable when config_type is 'SCRIPTED_REST_CONFIG'
|
||||
req_authentication_details
dictionary
|
Applicable when config_type is 'REST_CONFIG'
|
||||
auth_headers
list
/ elements=dictionary
|
List of authentication headers. Example: `[{"headerName": "content-type", "headerValue":"json"}]`
Applicable when config_type is 'REST_CONFIG'
|
||||
header_name
string
/ required
|
Name of the header.
Required when config_type is 'REST_CONFIG'
|
||||
header_value
string
|
Value of the header.
Applicable when config_type is 'REST_CONFIG'
|
||||
auth_request_method
string
|
|
Request method.
Applicable when config_type is 'REST_CONFIG'
|
|||
auth_request_post_body
string
|
Request post body.
Applicable when config_type is 'REST_CONFIG'
|
||||
auth_token
string
|
Authentication token.
Applicable when config_type is 'REST_CONFIG'
|
||||
auth_url
string
|
URL to get authentication token.
Applicable when config_type is 'REST_CONFIG'
|
||||
auth_user_name
string
|
User name for authentication.
Applicable when config_type is 'REST_CONFIG'
|
||||
auth_user_password
string
|
User password for authentication.
Applicable when config_type is 'REST_CONFIG'
|
||||
oauth_scheme
string
|
|
Request HTTP OAuth scheme.
Applicable when config_type is 'REST_CONFIG'
|
|||
req_authentication_scheme
string
|
|
Request HTTP authentication scheme.
Applicable when config_type is one of ['SCRIPTED_REST_CONFIG', 'REST_CONFIG']
|
|||
request_headers
list
/ elements=dictionary
|
List of request headers. Example: `[{"headerName": "content-type", "headerValue":"json"}]`
Applicable when config_type is 'REST_CONFIG'
|
||||
header_name
string
/ required
|
Name of the header.
Required when config_type is 'REST_CONFIG'
|
||||
header_value
string
|
Value of the header.
Applicable when config_type is 'REST_CONFIG'
|
||||
request_method
string
|
|
Request HTTP method.
Applicable when config_type is 'REST_CONFIG'
|
|||
request_post_body
string
|
Request post body content.
Applicable when config_type is 'REST_CONFIG'
|
||||
request_query_params
list
/ elements=dictionary
|
List of request query params. Example: `[{"paramName": "sortOrder", "paramValue": "asc"}]`
Applicable when config_type is 'REST_CONFIG'
|
||||
param_name
string
/ required
|
Name of request query parameter.
Required when config_type is 'REST_CONFIG'
|
||||
param_value
string
|
Value of request query parameter.
Applicable when config_type is 'REST_CONFIG'
|
||||
verify_response_codes
list
/ elements=string
|
Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
Applicable when config_type is one of ['SCRIPTED_REST_CONFIG', 'REST_CONFIG', 'BROWSER_CONFIG']
|
||||
verify_response_content
string
|
Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.
Applicable when config_type is 'REST_CONFIG'
|
||||
verify_texts
list
/ elements=dictionary
|
Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.
Applicable when config_type is 'BROWSER_CONFIG'
|
||||
text
string
|
Verification text in the response.
Applicable when config_type is 'BROWSER_CONFIG'
|
||||
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
|
||||
display_name
string
|
Unique name that can be edited. The name should not contain any confidential information.
Required for create using state=present.
Required for update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.This parameter is updatable when
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: name |
||||
force_create
boolean
|
|
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
|
|||
freeform_tags
dictionary
|
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
This parameter is updatable.
|
||||
is_run_now
boolean
|
|
If isRunNow is enabled, then the monitor will run immediately.
This parameter is updatable.
|
|||
is_run_once
boolean
|
|
If runOnce is enabled, then the monitor will run once.
This parameter is updatable.
|
|||
key_by
list
/ elements=string
|
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
|
||||
maintenance_window_schedule
dictionary
|
This parameter is updatable.
|
||||
time_ended
string
|
End time of the maintenance window, expressed in RFC 3339 timestamp format. Example: `2020-02-12T22:47:12.613Z`
|
||||
time_started
string
|
Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example: `2020-02-12T22:47:12.613Z`
|
||||
monitor_id
string
|
The OCID of the monitor.
Required for update using state=present when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
||||
monitor_type
string
|
|
Type of monitor.
Required for create using state=present.
|
|||
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. |
||||
repeat_interval_in_seconds
integer
|
Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
Required for create using state=present.
This parameter is updatable.
|
||||
scheduling_policy
string
|
|
Scheduling policy to decide the distribution of monitor executions on vantage points.
This parameter is updatable.
|
|||
script_id
string
|
The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.
This parameter is updatable.
|
||||
script_parameters
list
/ elements=dictionary
|
List of script parameters in the monitor. This is valid only for SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null. Example: `[{"paramName": "userid", "paramValue":"testuser"}]`
This parameter is updatable.
|
||||
param_name
string
/ required
|
Name of the parameter.
|
||||
param_value
string
/ required
|
Value of the parameter.
|
||||
state
string
|
|
The state of the Monitor.
Use state=present to create or update a Monitor.
Use state=absent to delete a Monitor.
|
|||
status
string
|
|
Enables or disables the monitor.
This parameter is updatable.
|
|||
target
string
|
Specify the endpoint on which to run the monitor. For BROWSER and REST monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80
This parameter is updatable.
|
||||
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 |
||||
timeout_in_seconds
integer
|
Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.
This parameter is updatable.
|
||||
vantage_points
list
/ elements=string
|
A list of public and dedicated vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points, and /dedicatedVantagePoints to fetch dedicated vantage points.
Required for create using state=present.
This parameter is updatable.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create monitor
oci_apm_synthetics_monitor:
# required
monitor_type: SCRIPTED_BROWSER
display_name: display_name_example
vantage_points: [ "vantage_points_example" ]
repeat_interval_in_seconds: 56
apm_domain_id: "ocid1.apmdomain.oc1..xxxxxxEXAMPLExxxxxx"
# optional
script_id: "ocid1.script.oc1..xxxxxxEXAMPLExxxxxx"
status: ENABLED
is_run_once: true
timeout_in_seconds: 56
target: target_example
script_parameters:
- # required
param_name: param_name_example
param_value: param_value_example
configuration:
# required
config_type: SCRIPTED_REST_CONFIG
# optional
req_authentication_scheme: NONE
verify_response_codes: [ "verify_response_codes_example" ]
is_failure_retried: true
dns_configuration:
# optional
is_override_dns: true
override_dns_ip: override_dns_ip_example
network_configuration:
# optional
number_of_hops: 56
probe_per_hop: 56
transmission_rate: 56
protocol: ICMP
probe_mode: SACK
availability_configuration:
# optional
max_allowed_failures_per_interval: 56
min_allowed_runs_per_interval: 56
maintenance_window_schedule:
# optional
time_started: time_started_example
time_ended: time_ended_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
is_run_now: true
scheduling_policy: ALL
batch_interval_in_seconds: 56
- name: Update monitor
oci_apm_synthetics_monitor:
# required
apm_domain_id: "ocid1.apmdomain.oc1..xxxxxxEXAMPLExxxxxx"
monitor_id: "ocid1.monitor.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
vantage_points: [ "vantage_points_example" ]
script_id: "ocid1.script.oc1..xxxxxxEXAMPLExxxxxx"
status: ENABLED
repeat_interval_in_seconds: 56
is_run_once: true
timeout_in_seconds: 56
target: target_example
script_parameters:
- # required
param_name: param_name_example
param_value: param_value_example
configuration:
# required
config_type: SCRIPTED_REST_CONFIG
# optional
req_authentication_scheme: NONE
verify_response_codes: [ "verify_response_codes_example" ]
is_failure_retried: true
dns_configuration:
# optional
is_override_dns: true
override_dns_ip: override_dns_ip_example
network_configuration:
# optional
number_of_hops: 56
probe_per_hop: 56
transmission_rate: 56
protocol: ICMP
probe_mode: SACK
availability_configuration:
# optional
max_allowed_failures_per_interval: 56
min_allowed_runs_per_interval: 56
maintenance_window_schedule:
# optional
time_started: time_started_example
time_ended: time_ended_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
is_run_now: true
scheduling_policy: ALL
batch_interval_in_seconds: 56
- name: Update monitor using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_apm_synthetics_monitor:
# required
display_name: display_name_example
apm_domain_id: "ocid1.apmdomain.oc1..xxxxxxEXAMPLExxxxxx"
# optional
vantage_points: [ "vantage_points_example" ]
script_id: "ocid1.script.oc1..xxxxxxEXAMPLExxxxxx"
status: ENABLED
repeat_interval_in_seconds: 56
is_run_once: true
timeout_in_seconds: 56
target: target_example
script_parameters:
- # required
param_name: param_name_example
param_value: param_value_example
configuration:
# required
config_type: SCRIPTED_REST_CONFIG
# optional
req_authentication_scheme: NONE
verify_response_codes: [ "verify_response_codes_example" ]
is_failure_retried: true
dns_configuration:
# optional
is_override_dns: true
override_dns_ip: override_dns_ip_example
network_configuration:
# optional
number_of_hops: 56
probe_per_hop: 56
transmission_rate: 56
protocol: ICMP
probe_mode: SACK
availability_configuration:
# optional
max_allowed_failures_per_interval: 56
min_allowed_runs_per_interval: 56
maintenance_window_schedule:
# optional
time_started: time_started_example
time_ended: time_ended_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
is_run_now: true
scheduling_policy: ALL
batch_interval_in_seconds: 56
- name: Delete monitor
oci_apm_synthetics_monitor:
# required
apm_domain_id: "ocid1.apmdomain.oc1..xxxxxxEXAMPLExxxxxx"
monitor_id: "ocid1.monitor.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete monitor using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_apm_synthetics_monitor:
# required
display_name: display_name_example
apm_domain_id: "ocid1.apmdomain.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||||
---|---|---|---|---|---|---|
monitor
complex
|
on success |
Details of the Monitor resource acted upon by the current operation
Sample:
{'availability_configuration': {'max_allowed_failures_per_interval': 56, 'min_allowed_runs_per_interval': 56}, 'batch_interval_in_seconds': 56, 'configuration': {'client_certificate_details': {'client_certificate': {'content': 'content_example', 'file_name': 'file_name_example'}, 'private_key': {'content': 'content_example', 'file_name': 'file_name_example'}}, 'config_type': 'BROWSER_CONFIG', 'dns_configuration': {'is_override_dns': True, 'override_dns_ip': 'override_dns_ip_example'}, 'is_certificate_validation_enabled': True, 'is_default_snapshot_enabled': True, 'is_failure_retried': True, 'is_redirection_enabled': True, 'network_configuration': {'number_of_hops': 56, 'probe_mode': 'SACK', 'probe_per_hop': 56, 'protocol': 'ICMP', 'transmission_rate': 56}, 'req_authentication_details': {'auth_headers': [{'header_name': 'header_name_example', 'header_value': 'header_value_example'}], 'auth_request_method': 'GET', 'auth_request_post_body': 'auth_request_post_body_example', 'auth_token': 'auth_token_example', 'auth_url': 'auth_url_example', 'auth_user_name': 'auth_user_name_example', 'auth_user_password': 'example-password', 'oauth_scheme': 'NONE'}, 'req_authentication_scheme': 'OAUTH', 'request_headers': [{'header_name': 'header_name_example', 'header_value': 'header_value_example'}], 'request_method': 'GET', 'request_post_body': 'request_post_body_example', 'request_query_params': [{'param_name': 'param_name_example', 'param_value': 'param_value_example'}], 'verify_response_codes': [], 'verify_response_content': 'verify_response_content_example', 'verify_texts': [{'text': 'text_example'}]}, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_run_now': True, 'is_run_once': True, 'maintenance_window_schedule': {'time_ended': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00'}, 'monitor_type': 'SCRIPTED_BROWSER', 'repeat_interval_in_seconds': 56, 'scheduling_policy': 'ALL', 'script_id': 'ocid1.script.oc1..xxxxxxEXAMPLExxxxxx', 'script_name': 'script_name_example', 'script_parameters': [{'is_overwritten': True, 'is_secret': True, 'monitor_script_parameter': {'param_name': 'param_name_example', 'param_value': 'param_value_example'}}], 'status': 'ENABLED', 'target': 'target_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'timeout_in_seconds': 56, 'vantage_point_count': 56, 'vantage_points': [{'display_name': 'display_name_example', 'name': 'name_example'}]}
|
||||
availability_configuration
complex
|
on success |
|
||||
max_allowed_failures_per_interval
integer
|
on success |
Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
Sample:
56
|
||||
min_allowed_runs_per_interval
integer
|
on success |
Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
Sample:
56
|
||||
batch_interval_in_seconds
integer
|
on success |
Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
Sample:
56
|
||||
configuration
complex
|
on success |
|
||||
client_certificate_details
complex
|
on success |
|
||||
client_certificate
complex
|
on success |
|
||||
content
string
|
on success |
Content of the client certificate file.
Sample:
content_example
|
||||
file_name
string
|
on success |
Name of the certificate file. The name should not contain any confidential information.
Sample:
file_name_example
|
||||
private_key
complex
|
on success |
|
||||
content
string
|
on success |
Content of the private key file.
Sample:
content_example
|
||||
file_name
string
|
on success |
Name of the private key file.
Sample:
file_name_example
|
||||
config_type
string
|
on success |
Type of configuration.
Sample:
BROWSER_CONFIG
|
||||
dns_configuration
complex
|
on success |
|
||||
is_override_dns
boolean
|
on success |
If isOverrideDns is true, then DNS settings will be overridden.
Sample:
True
|
||||
override_dns_ip
string
|
on success |
Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
Sample:
override_dns_ip_example
|
||||
is_certificate_validation_enabled
boolean
|
on success |
If certificate validation is enabled, then the call will fail in case of certification errors.
Sample:
True
|
||||
is_default_snapshot_enabled
boolean
|
on success |
If disabled, auto snapshots are not collected.
Sample:
True
|
||||
is_failure_retried
boolean
|
on success |
If isFailureRetried is enabled, then a failed call will be retried.
Sample:
True
|
||||
is_redirection_enabled
boolean
|
on success |
If redirection is enabled, then redirects will be allowed while accessing target URL.
Sample:
True
|
||||
network_configuration
complex
|
on success |
|
||||
number_of_hops
integer
|
on success |
Number of hops.
Sample:
56
|
||||
probe_mode
string
|
on success |
Type of probe mode when TCP protocol is selected.
Sample:
SACK
|
||||
probe_per_hop
integer
|
on success |
Number of probes per hop.
Sample:
56
|
||||
protocol
string
|
on success |
Type of protocol.
Sample:
ICMP
|
||||
transmission_rate
integer
|
on success |
Number of probe packets sent out simultaneously.
Sample:
56
|
||||
req_authentication_details
complex
|
on success |
|
||||
auth_headers
complex
|
on success |
List of authentication headers. Example: `[{"headerName": "content-type", "headerValue":"json"}]`
|
||||
header_name
string
|
on success |
Name of the header.
Sample:
header_name_example
|
||||
header_value
string
|
on success |
Value of the header.
Sample:
header_value_example
|
||||
auth_request_method
string
|
on success |
Request method.
Sample:
GET
|
||||
auth_request_post_body
string
|
on success |
Request post body.
Sample:
auth_request_post_body_example
|
||||
auth_token
string
|
on success |
Authentication token.
Sample:
auth_token_example
|
||||
auth_url
string
|
on success |
URL to get authentication token.
Sample:
auth_url_example
|
||||
auth_user_name
string
|
on success |
User name for authentication.
Sample:
auth_user_name_example
|
||||
auth_user_password
string
|
on success |
User password for authentication.
Sample:
example-password
|
||||
oauth_scheme
string
|
on success |
Request HTTP OAuth scheme.
Sample:
NONE
|
||||
req_authentication_scheme
string
|
on success |
Request HTTP authentication scheme.
Sample:
OAUTH
|
||||
request_headers
complex
|
on success |
List of request headers. Example: `[{"headerName": "content-type", "headerValue":"json"}]`
|
||||
header_name
string
|
on success |
Name of the header.
Sample:
header_name_example
|
||||
header_value
string
|
on success |
Value of the header.
Sample:
header_value_example
|
||||
request_method
string
|
on success |
Request HTTP method.
Sample:
GET
|
||||
request_post_body
string
|
on success |
Request post body content.
Sample:
request_post_body_example
|
||||
request_query_params
complex
|
on success |
List of request query params. Example: `[{"paramName": "sortOrder", "paramValue": "asc"}]`
|
||||
param_name
string
|
on success |
Name of request query parameter.
Sample:
param_name_example
|
||||
param_value
string
|
on success |
Value of request query parameter.
Sample:
param_value_example
|
||||
verify_response_codes
list
/ elements=string
|
on success |
Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
|
||||
verify_response_content
string
|
on success |
Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.
Sample:
verify_response_content_example
|
||||
verify_texts
complex
|
on success |
Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.
|
||||
text
string
|
on success |
Verification text in the response.
Sample:
text_example
|
||||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||||
display_name
string
|
on success |
Unique name that can be edited. The name should not contain any confidential information.
Sample:
display_name_example
|
||||
freeform_tags
dictionary
|
on success |
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 monitor.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||||
is_run_now
boolean
|
on success |
If isRunNow is enabled, then the monitor will run immediately.
Sample:
True
|
||||
is_run_once
boolean
|
on success |
If runOnce is enabled, then the monitor will run once.
Sample:
True
|
||||
maintenance_window_schedule
complex
|
on success |
|
||||
time_ended
string
|
on success |
End time of the maintenance window, expressed in RFC 3339 timestamp format. Example: `2020-02-12T22:47:12.613Z`
Sample:
2013-10-20T19:20:30+01:00
|
||||
time_started
string
|
on success |
Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example: `2020-02-12T22:47:12.613Z`
Sample:
2013-10-20T19:20:30+01:00
|
||||
monitor_type
string
|
on success |
Type of monitor.
Sample:
SCRIPTED_BROWSER
|
||||
repeat_interval_in_seconds
integer
|
on success |
Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
Sample:
56
|
||||
scheduling_policy
string
|
on success |
Scheduling policy to decide the distribution of monitor executions on vantage points.
Sample:
ALL
|
||||
script_id
string
|
on success |
The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.
Sample:
ocid1.script.oc1..xxxxxxEXAMPLExxxxxx
|
||||
script_name
string
|
on success |
Name of the script.
Sample:
script_name_example
|
||||
script_parameters
complex
|
on success |
List of script parameters. Example: `[{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]`
|
||||
is_overwritten
boolean
|
on success |
If parameter value is default or overwritten.
Sample:
True
|
||||
is_secret
boolean
|
on success |
Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
Sample:
True
|
||||
monitor_script_parameter
complex
|
on success |
|
||||
param_name
string
|
on success |
Name of the parameter.
Sample:
param_name_example
|
||||
param_value
string
|
on success |
Value of the parameter.
Sample:
param_value_example
|
||||
status
string
|
on success |
Enables or disables the monitor.
Sample:
ENABLED
|
||||
target
string
|
on success |
Specify the endpoint on which to run the monitor. For BROWSER and REST monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80
Sample:
target_example
|
||||
time_created
string
|
on success |
The time the resource was created, expressed in RFC 3339 timestamp format. Example: `2020-02-12T22:47:12.613Z`
Sample:
2013-10-20T19:20:30+01:00
|
||||
time_updated
string
|
on success |
The time the resource was updated, expressed in RFC 3339 timestamp format. Example: `2020-02-13T22:47:12.613Z`
Sample:
2013-10-20T19:20:30+01:00
|
||||
timeout_in_seconds
integer
|
on success |
Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.
Sample:
56
|
||||
vantage_point_count
integer
|
on success |
Number of vantage points where monitor is running.
Sample:
56
|
||||
vantage_points
complex
|
on success |
List of public and dedicated vantage points where the monitor is running.
|
||||
display_name
string
|
on success |
Unique name that can be edited. The name should not contain any confidential information.
Sample:
display_name_example
|
||||
name
string
|
on success |
Name of the vantage point.
Sample:
name_example
|
Authors¶
Oracle (@oracle)