How are the lb commands grouped in the Web CLI (service, backend, backend-group, hc, certificate, ...)?

Short answer

The lb branch consists of 26 resource commands corresponding to the screens in the Load Balancer - ADC section: vService and traffic (service, vhost, backend, backend-group, condition, action), profiles (hc, cache, compression, log, notification, page, limits, report, timeouts, trusted-proxy), certificate and TLS (certificate, ca, ssl-security, certificate-request, client-certificate, private-key, pki-profile, pki-issued, acme-dns-provider) and protection (threat-protection). Most of the resources have the same five commands: list, show, add, update and delete. Some resources have additional actions: status and restart in service, CSR and internal CA operations in certificate, create in ca, and update-many in five resources. In the service, certificate, action, condition and hc resources, the type field is written first in the add command.

How Does It Work?

1. A command is built with three words: the branch (lb), the resource (e.g. service) and the action (e.g. list). Tab lists the available words at each step.
2. Required fields are written right after the action, without -- and in a specific order; optional fields come in the --field value form; the rules are in the Field writing rules section.
3. In resources with a type field, the type is written first in the add command; this selection determines the fields that open: service → type, certificate → type, action → type, condition → criteria, hc → checkType.
4. show and delete take the record without the field name being written (delete can take multiple records); update asks for id first. The record name is listed and selected with Tab.

Command Groups

Resource	Commands	Equivalent in the interface
service	The five commands, update-many, status list, status id, restart	Load Balancer vService List
vhost	status list, status id, restart	Shared frontend (Virtual Hosting)
backend · backend-group	The five commands, update-many	Backend Services · Backend Groups (Pools)
condition · action	The five commands; add asks for the type field first	Conditions (Policy Match) · Actions (Policy Actions)
hc	The five commands, update-many; add asks for the type field first	Health Checks
cache · compression · log · notification · page · limits · report · timeouts · trusted-proxy	The five commands	Profiles (L4-L7 Behavior Sets)
certificate	The five commands, create-csr, issue-internal, renew-internal; add asks for the type field first	SSL/TLS Certificates
ca	The five commands, create	Certificate Authorities (CA)
ssl-security · certificate-request · client-certificate · private-key · pki-profile · pki-issued · acme-dns-provider	The five commands	Certificates & PKI screens
threat-protection	list, show, update, update-many	Bot/DDoS Management

lb Commands in TR7

• The commands run with the role permission of the user: the lb branch is bound to the Load Balancer permission area; the certificate, PKI, ACME and ssl-security resources require the certificate permission (lb · Permission).
• There is no separate command for turning a vService on and off; the --active field is updated. restart is used for restarting (Can I restart a vService without interruption (soft / hard restart)?):

lb service update id <vService> --active false
lb service update id <vService> --active true
lb service restart poolId <vService>

• The threat-protection record is created together with the vService; for this reason, there are no add and delete commands, and it is only updated.
• Actions outside the five commands: The actions outside the five commands. For certificate operations: Can I create a CSR on TR7?
• Writing the fields: How are array / object fields (e.g. listen) entered in the CLI? · Bulk update: Can I change the same field on multiple objects at once?

Common Misconceptions

• "There are separate enable and disable commands for turning a vService on and off." Turning it on and off is done with the --active field of the lb service update command.
• "The Bot/DDoS record is created with add." The threat-protection record is created together with the vService; it is only updated.
• "The certificate commands run with the Load Balancer permission." The certificate and PKI commands are bound to the certificate permission.
• "In the update command, the record name is written directly." In the update command, id is written before the record (lb service update id <vService>), followed by the fields to be changed; show and delete, on the other hand, take the record directly.

How it is done in the documentation

• lb · Command Map
• lb · The Same Five Commands on Every Resource
• lb · The Actions Outside the Five Commands
• lb · The Field Writing Rules
• API7 Docs

Related questions

• Can I manage the Load Balancer configuration via CLI or API?
• How are array / object fields (e.g. listen) entered in the CLI?
• Can I change the same field on multiple objects at once?