oracle.oci.oci_apm_synthetics_script_facts – Fetches details about one or multiple Script 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_apm_synthetics_script_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple Script resources in Oracle Cloud Infrastructure
Returns a list of scripts.
If script_id is specified, the details of a single Script 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 ). |
|
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 . |
|
content_type
string
|
A filter to return only resources that match the content type given.
|
|
display_name
string
|
A filter to return only the resources that match the entire display name.
aliases: name |
|
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. |
|
script_id
string
|
The OCID of the script.
Required to get a specific script.
aliases: id |
|
sort_by
string
|
|
The field to sort by. Only one sort order may be provided. Default order of displayName and contentType is ascending. Default order of timeCreated and timeUpdated is descending. The displayName sort by is case insensitive.
|
sort_order
string
|
|
The sort order to use, either ascending (`ASC`) or descending (`DESC`). Default sort order is ascending.
|
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 script
oci_apm_synthetics_script_facts:
# required
script_id: "ocid1.script.oc1..xxxxxxEXAMPLExxxxxx"
apm_domain_id: "ocid1.apmdomain.oc1..xxxxxxEXAMPLExxxxxx"
- name: List scripts
oci_apm_synthetics_script_facts:
# required
apm_domain_id: "ocid1.apmdomain.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
content_type: content_type_example
sort_order: ASC
sort_by: displayName
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |||
---|---|---|---|---|---|
scripts
complex
|
on success |
List of Script resources
Sample:
[{'content': 'content_example', 'content_file_name': 'content_file_name_example', 'content_size_in_bytes': 56, 'content_type': 'SIDE', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'monitor_status_count_map': {'disabled': 56, 'enabled': 56, 'invalid': 56, 'total': 56}, 'parameters': [{'is_overwritten': True, 'script_parameter': {'is_secret': True, 'param_name': 'param_name_example', 'param_value': 'param_value_example'}}], 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'time_uploaded': '2013-10-20T19:20:30+01:00'}]
|
|||
content
string
|
on success |
The content of the script. It may contain custom-defined tags that can be used for setting dynamic parameters. The format to set dynamic parameters is: `<ORAP><ON>param name</ON><OV>param value</OV><OS>isParamValueSecret(true/false)</OS></ORAP>`. Param value and isParamValueSecret are optional, the default value for isParamValueSecret is false. Examples: With mandatory param name : `<ORAP><ON>param name</ON></ORAP>` With parameter name and value : `<ORAP><ON>param name</ON><OV>param value</OV></ORAP>` Note that the content is valid if it matches the given content type. For example, if the content type is SIDE, then the content should be in Side script format. If the content type is JS, then the content should be in JavaScript format.
Returned for get operation
Sample:
content_example
|
|||
content_file_name
string
|
on success |
File name of the uploaded script content.
Returned for get operation
Sample:
content_file_name_example
|
|||
content_size_in_bytes
integer
|
on success |
Size of the script content.
Returned for get operation
Sample:
56
|
|||
content_type
string
|
on success |
Content type of the script.
Sample:
SIDE
|
|||
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 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.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|||
monitor_status_count_map
complex
|
on success |
|
|||
disabled
integer
|
on success |
Number of disabled monitors using the script.
Sample:
56
|
|||
enabled
integer
|
on success |
Number of enabled monitors using the script.
Sample:
56
|
|||
invalid
integer
|
on success |
Number of invalid monitors using the script.
Sample:
56
|
|||
total
integer
|
on success |
Total number of monitors using the script.
Sample:
56
|
|||
parameters
complex
|
on success |
List of script parameters. Example: `[{"scriptParameter": {"paramName": "userid", "paramValue":"testuser", "isSecret": false}, "isOverwritten": false}]`
Returned for get operation
|
|||
is_overwritten
boolean
|
on success |
If parameter value is default or overwritten.
Sample:
True
|
|||
script_parameter
complex
|
on success |
|
|||
is_secret
boolean
|
on success |
If the parameter value is secret and should be kept confidential, then set isSecret to true.
Sample:
True
|
|||
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
|
|||
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
|
|||
time_uploaded
string
|
on success |
The time the script was uploaded.
Returned for get operation
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)