Parameter |
Choices/Defaults |
Comments |
add_rules
|
|
A list of rules that will be added to an existing load balancer. It is syntax is the same as the one used for rules parameter. Used in combination with update state.
|
add_server_ips
|
|
A list of server identifiers (id or name) to be assigned to a load balancer. Used in combination with update state.
|
api_url
|
|
Custom API URL. Overrides the ONEANDONE_API_URL environement variable.
|
auth_token
required |
|
Authenticating API token provided by 1&1.
|
datacenter
|
|
ID or country code of the datacenter where the load balancer will be created.
|
description
|
|
Description of the load balancer. maxLength=256
|
health_check_interval
required |
|
Health check period in seconds. minimum=5, maximum=300, multipleOf=1
|
health_check_parse
|
|
Regular expression to check. Required for HTTP health check. maxLength=64
|
health_check_path
|
|
Url to call for cheking. Required for HTTP health check. maxLength=1000
|
health_check_test
required |
Choices:
- NONE
- TCP
- HTTP
- ICMP
|
Type of the health check. At the moment, HTTP is not allowed.
|
load_balancer
required |
|
The identifier (id or name) of the load balancer used with update state.
|
method
required |
Choices:
- ROUND_ROBIN
- LEAST_CONNECTIONS
|
Balancing procedure.
|
name
required |
|
Load balancer name used with present state. Used as identifier (id or name) when used with absent state. maxLength=128
|
persistence
required |
|
Persistence.
|
persistence_time
required |
|
Persistence time in seconds. Required if persistence is enabled. minimum=30, maximum=1200, multipleOf=1
|
remove_rules
|
|
A list of rule ids that will be removed from an existing load balancer. Used in combination with update state.
|
remove_server_ips
|
|
A list of server IP ids to be unassigned from a load balancer. Used in combination with update state.
|
rules
required |
|
A list of rule objects that will be set for the load balancer. Each rule must contain protocol, port_balancer, and port_server parameters, in addition to source parameter, which is optional.
|
state
|
Choices:
present ←
- absent
- update
|
Define a load balancer state to create, remove, or update.
|
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
|