Parameter |
Choices/Defaults |
Comments |
add_ports
|
|
Ports to add to the monitoring policy.
|
add_processes
|
|
Processes to add to the monitoring policy.
|
add_servers
|
|
Servers to add to the monitoring policy.
|
agent
required |
|
Set true for using agent.
|
api_url
|
|
Custom API URL. Overrides the ONEANDONE_API_URL environement variable.
|
auth_token
required |
|
Authenticating API token provided by 1&1.
|
description
|
|
Monitoring policy description. maxLength=256
|
email
required |
|
User's email. maxLength=128
|
monitoring_policy
required |
|
The identifier (id or name) of the monitoring policy used with update state.
|
name
required |
|
Monitoring policy name used with present state. Used as identifier (id or name) when used with absent state. maxLength=128
|
ports
required |
|
Array of ports that will be monitoring.
|
|
protocol
required |
|
Internet protocol.
|
|
port
required |
|
Port number. minimum=1, maximum=65535
|
|
alert_if
required |
Choices:
- RESPONDING
- NOT_RESPONDING
|
Case of alert.
|
|
email_notification
required |
|
Set true for sending e-mail notifications.
|
processes
required |
|
Array of processes that will be monitoring.
|
|
process
required |
|
Name of the process. maxLength=50
|
|
alert_if
required |
Choices:
- RUNNING
- NOT_RUNNING
|
Case of alert.
|
remove_ports
|
|
Ports to remove from the monitoring policy.
|
remove_processes
|
|
Processes to remove from the monitoring policy.
|
remove_servers
|
|
Servers to remove from the monitoring policy.
|
state
|
Choices:
present ←
- absent
- update
|
Define a monitoring policy's state to create, remove, update.
|
thresholds
required |
|
Monitoring policy thresholds. Each of the suboptions have warning and critical, which both have alert and value suboptions. Warning is used to set limits for warning alerts, critical is used to set critical alerts. alert enables alert, and value is used to advise when the value is exceeded.
|
|
cpu
required |
|
Consumption limits of CPU.
|
|
ram
required |
|
Consumption limits of RAM.
|
|
disk
required |
|
Consumption limits of hard disk.
|
|
internal_ping
required |
|
Response limits of internal ping.
|
|
transfer
required |
|
Consumption limits for transfer.
|
update_ports
|
|
Ports to be updated on the monitoring policy.
|
update_processes
|
|
Processes to be updated on the monitoring policy.
|
wait
bool |
|
wait for the instance to be in state 'running' before returning
|
wait_interval
|
Default:
5
|
Defines the number of seconds to wait when using the _wait_for methods
|
wait_timeout
|
Default:
600
|
how long before wait gives up, in seconds
|