tebib lb

Generated from the CLI's own command tree. Run tebib lb --help for the same text in your terminal.

Load balancers: spread TCP or HTTP traffic over healthy VMs.

Commands

tebib lb create

Create a load balancer (public unless --internal).

tebib lb create [OPTIONS] NAME

Argument	Description
NAME required	Load balancer name, unique in the project.

Option	Value	Description
--internal	flag	Only an address in the VPC, no public IP.
--subnet	str	Subnet ID (default: the default subnet).
--security-group	str (repeatable)	Its nodes' groups (repeatable; default: the VPC's default).
--public-ip	str	Use this allocated public IP (default: allocate one).
--listen	str (repeatable)	PROTOCOL:PORT to listen on, e.g. http:80 (repeatable).
--target	str (repeatable)	VM ID to send traffic to (repeatable).
--target-port	int	The VMs' port (default: the listen port).
--algorithm	str	round_robin, least_connections or source_ip (sticky by client address).
--health-protocol	str	tcp or http.
--health-path	str	HTTP check path, e.g. /healthz.
--health-port	int	Check this port instead of the traffic port.
--health-matcher	str	Expected HTTP codes, e.g. "200-399".
--health-interval	int	Seconds between checks (5-300).
--health-timeout	int	Seconds a check may take (2-120).
--healthy-threshold	int	Passes before a target is healthy.
--unhealthy-threshold	int	Failures before it is unhealthy.
--from-file	str	The whole request as JSON (target_groups, listeners...), '-' for stdin.
--description	str	Description.
--tag	KEY=VALUE (repeatable)	Tag as KEY=VALUE; repeat for more tags.
--project, -p	str	Project ID (default: from the profile).
--wait	flag	Wait until the resource is ready (or gone, for deletes).
--timeout	float range	Seconds to wait with --wait. Default: 600.
--output, -o	table | json | yaml	Output format.

tebib lb delete

Delete a load balancer.

tebib lb delete [OPTIONS] ID

Argument	Description
ID required	Load balancer ID (lb-...).

Option	Value	Description
--yes, -y	flag	Don't ask for confirmation.
--wait	flag	Wait until the resource is ready (or gone, for deletes).
--timeout	float range	Seconds to wait with --wait. Default: 600.
--project, -p	str	Project ID (default: from the profile).

tebib lb list

List the project's load balancers.

tebib lb list [OPTIONS]

Option	Value	Description
--project, -p	str	Project ID (default: from the profile).
--limit	int range	Show at most this many items.
--output, -o	table | json | yaml	Output format.

tebib lb set-security-groups

Replace the groups the load balancer's nodes are in.

tebib lb set-security-groups [OPTIONS] LB_ID

Argument	Description
LB_ID required	Load balancer ID (lb-...).

Option	Value	Description
--security-group required	str (repeatable)	Group ID (repeatable, 1-5).
--project, -p	str	Project ID (default: from the profile).
--wait	flag	Wait until the resource is ready (or gone, for deletes).
--timeout	float range	Seconds to wait with --wait. Default: 300.
--output, -o	table | json | yaml	Output format.

tebib lb show

Show one load balancer.

tebib lb show [OPTIONS] ID

Argument	Description
ID required	Load balancer ID (lb-...).

Option	Value	Description
--project, -p	str	Project ID (default: from the profile).
--output, -o	table | json | yaml	Output format.

tebib lb targets

Every target and its health.

tebib lb targets [OPTIONS] LB_ID

Argument	Description
LB_ID required	Load balancer ID (lb-...).

Option	Value	Description
--project, -p	str	Project ID (default: from the profile).
--output, -o	table | json | yaml	Output format.

tebib lb update

Change a load balancer's description or tags.

tebib lb update [OPTIONS] ID

Argument	Description
ID required	Load balancer ID (lb-...).

Option	Value	Description
--description	str	New description.
--tag	KEY=VALUE (repeatable)	Replace ALL tags (KEY=VALUE, repeatable).
--clear-tags	flag	Remove all tags.
--project, -p	str	Project ID (default: from the profile).
--output, -o	table | json | yaml	Output format.

tebib lb listener

Listeners: ports on the load balancer and where they forward.

tebib lb listener add

Listen on a port and forward to a target group.

tebib lb listener add [OPTIONS] LB_ID

Argument	Description
LB_ID required	Load balancer ID (lb-...).

Option	Value	Description
--port required	int range	Port on the load balancer.
--target-group required	str	Target group ID.
--protocol	str	tcp or http (as the target group). Default: tcp.
--project, -p	str	Project ID (default: from the profile).
--wait	flag	Wait until the resource is ready (or gone, for deletes).
--timeout	float range	Seconds to wait with --wait. Default: 300.
--output, -o	table | json | yaml	Output format.

tebib lb listener remove

Stop listening on a port.

tebib lb listener remove [OPTIONS] LB_ID ID

Argument	Description
LB_ID required	Load balancer ID (lb-...).
ID required	Listener ID (lbl-...).

Option	Value	Description
--yes, -y	flag	Don't ask for confirmation.
--project, -p	str	Project ID (default: from the profile).
--wait	flag	Wait until the resource is ready (or gone, for deletes).
--timeout	float range	Seconds to wait with --wait. Default: 300.
--output, -o	table | json | yaml	Output format.

tebib lb listener set-target-group

Forward a listener to another target group.

tebib lb listener set-target-group [OPTIONS] LB_ID ID GROUP_ID

Argument	Description
LB_ID required	Load balancer ID (lb-...).
ID required	Listener ID (lbl-...).
GROUP_ID required	Target group ID.

Option	Value	Description
--project, -p	str	Project ID (default: from the profile).
--wait	flag	Wait until the resource is ready (or gone, for deletes).
--timeout	float range	Seconds to wait with --wait. Default: 300.
--output, -o	table | json | yaml	Output format.

tebib lb target

Targets: VMs in a target group.

tebib lb target add

Send a target group's traffic to a VM too.

tebib lb target add [OPTIONS] LB_ID GROUP_ID VM_ID

Argument	Description
LB_ID required	Load balancer ID (lb-...).
GROUP_ID required	Target group ID (lbtg-...).
VM_ID required	VM ID (same VPC).

Option	Value	Description
--port	int range	The VM's port (default: the group's).
--project, -p	str	Project ID (default: from the profile).
--wait	flag	Wait until the resource is ready (or gone, for deletes).
--timeout	float range	Seconds to wait with --wait. Default: 300.
--output, -o	table | json | yaml	Output format.

tebib lb target remove

Stop sending traffic to a target.

tebib lb target remove [OPTIONS] LB_ID GROUP_ID TARGET_ID

Argument	Description
LB_ID required	Load balancer ID (lb-...).
GROUP_ID required	Target group ID (lbtg-...).
TARGET_ID required	Target ID (lbt-...).

Option	Value	Description
--project, -p	str	Project ID (default: from the profile).
--wait	flag	Wait until the resource is ready (or gone, for deletes).
--timeout	float range	Seconds to wait with --wait. Default: 300.
--output, -o	table | json | yaml	Output format.

tebib lb target-group

Target groups: VMs with a port, an algorithm and a health check.

tebib lb target-group add

Add a target group.

tebib lb target-group add [OPTIONS] LB_ID NAME

Argument	Description
LB_ID required	Load balancer ID (lb-...).
NAME required	Group name, unique in the load balancer.

Option	Value	Description
--port required	int range	The targets' port.
--protocol	str	tcp or http. Default: tcp.
--algorithm	str	round_robin, least_connections or source_ip (sticky by client address).
--proxy-protocol	flag	TCP only: send PROXY protocol v2.
--target	str (repeatable)	VM ID (repeatable).
--health-protocol	str	tcp or http.
--health-path	str	HTTP check path, e.g. /healthz.
--health-port	int	Check this port instead of the traffic port.
--health-matcher	str	Expected HTTP codes, e.g. "200-399".
--health-interval	int	Seconds between checks (5-300).
--health-timeout	int	Seconds a check may take (2-120).
--healthy-threshold	int	Passes before a target is healthy.
--unhealthy-threshold	int	Failures before it is unhealthy.
--project, -p	str	Project ID (default: from the profile).
--wait	flag	Wait until the resource is ready (or gone, for deletes).
--timeout	float range	Seconds to wait with --wait. Default: 300.
--output, -o	table | json | yaml	Output format.

tebib lb target-group remove

Remove a target group no listener uses.

tebib lb target-group remove [OPTIONS] LB_ID GROUP_ID

Argument	Description
LB_ID required	Load balancer ID (lb-...).
GROUP_ID required	Target group ID (lbtg-...).

Option	Value	Description
--yes, -y	flag	Don't ask for confirmation.
--project, -p	str	Project ID (default: from the profile).
--wait	flag	Wait until the resource is ready (or gone, for deletes).
--timeout	float range	Seconds to wait with --wait. Default: 300.
--output, -o	table | json | yaml	Output format.

tebib lb target-group update

Change a target group. A new health check replaces the whole old one.

tebib lb target-group update [OPTIONS] LB_ID GROUP_ID

Argument	Description
LB_ID required	Load balancer ID (lb-...).
GROUP_ID required	Target group ID (lbtg-...).

Option	Value	Description
--port	int range	New default port.
--algorithm	str	round_robin, least_connections or source_ip (sticky by client address).
--proxy-protocol, --no-proxy-protocol	flag	TCP only.
--health-protocol	str	tcp or http.
--health-path	str	HTTP check path, e.g. /healthz.
--health-port	int	Check this port instead of the traffic port.
--health-matcher	str	Expected HTTP codes, e.g. "200-399".
--health-interval	int	Seconds between checks (5-300).
--health-timeout	int	Seconds a check may take (2-120).
--healthy-threshold	int	Passes before a target is healthy.
--unhealthy-threshold	int	Failures before it is unhealthy.
--project, -p	str	Project ID (default: from the profile).
--wait	flag	Wait until the resource is ready (or gone, for deletes).
--timeout	float range	Seconds to wait with --wait. Default: 300.
--output, -o	table | json | yaml	Output format.