`orca loadbalancer`¶

Manage Octavia load balancers.

The reference below is generated from the live CLI by mkdocs-click. It always reflects the version installed.

orca loadbalancer¶

Manage load balancers, listeners, pools & members (Octavia).

Usage:

orca loadbalancer [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

amphora: Manage Octavia amphorae (admin).
amphora-failover: [deprecated, use 'loadbalancer amphora failover' instead]
amphora-list: [deprecated, use 'loadbalancer amphora list' instead]
amphora-show: [deprecated, use 'loadbalancer amphora show' instead]
create: Create a load balancer.
delete: Delete a load balancer.
healthmonitor: Manage Octavia health monitors.
healthmonitor-create: [deprecated, use 'loadbalancer healthmonitor create' instead]
healthmonitor-delete: [deprecated, use 'loadbalancer healthmonitor delete' instead]
healthmonitor-list: [deprecated, use 'loadbalancer healthmonitor list' instead]
healthmonitor-set: [deprecated, use 'loadbalancer healthmonitor set' instead]
healthmonitor-show: [deprecated, use 'loadbalancer healthmonitor show' instead]
l7policy: Manage Octavia L7 policies (compound noun).
l7policy-create: [deprecated, use 'loadbalancer l7policy create' instead]
l7policy-delete: [deprecated, use 'loadbalancer l7policy delete' instead]
l7policy-list: [deprecated, use 'loadbalancer l7policy list' instead]
l7policy-set: [deprecated, use 'loadbalancer l7policy set' instead]
l7policy-show: [deprecated, use 'loadbalancer l7policy show' instead]
l7rule: Manage Octavia L7 rules (compound noun).
l7rule-create: [deprecated, use 'loadbalancer l7rule create' instead]
l7rule-delete: [deprecated, use 'loadbalancer l7rule delete' instead]
l7rule-list: [deprecated, use 'loadbalancer l7rule list' instead]
l7rule-set: [deprecated, use 'loadbalancer l7rule set' instead]
l7rule-show: [deprecated, use 'loadbalancer l7rule show' instead]
list: List load balancers.
listener: Manage Octavia listeners.
listener-create: [deprecated, use 'loadbalancer listener create' instead]
listener-delete: [deprecated, use 'loadbalancer listener delete' instead]
listener-list: [deprecated, use 'loadbalancer listener list' instead]
listener-set: [deprecated, use 'loadbalancer listener set' instead]
listener-show: [deprecated, use 'loadbalancer listener show' instead]
member: Manage Octavia pool members.
member-add: [deprecated, use 'loadbalancer member add' instead]
member-list: [deprecated, use 'loadbalancer member list' instead]
member-remove: [deprecated, use 'loadbalancer member remove' instead]
member-set: [deprecated, use 'loadbalancer member set' instead]
member-show: [deprecated, use 'loadbalancer member show' instead]
pool: Manage Octavia pools.
pool-create: [deprecated, use 'loadbalancer pool create' instead]
pool-delete: [deprecated, use 'loadbalancer pool delete' instead]
pool-list: [deprecated, use 'loadbalancer pool list' instead]
pool-set: [deprecated, use 'loadbalancer pool set' instead]
pool-show: [deprecated, use 'loadbalancer pool show' instead]
set: Update a load balancer.
show: Show load balancer details.
stats: Inspect Octavia load-balancer stats.
stats-show: [deprecated, use 'loadbalancer stats show' instead]
status: Inspect Octavia load-balancer status.
status-show: [deprecated, use 'loadbalancer status show' instead]

orca loadbalancer amphora¶

Manage Octavia amphorae (admin).

Usage:

orca loadbalancer amphora [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

failover: Trigger a failover for an amphora (admin).
list: List amphora (admin).
show: Show amphora details (admin).

orca loadbalancer amphora failover¶

Trigger a failover for an amphora (admin).

Usage:

orca loadbalancer amphora failover [OPTIONS] AMPHORA_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer amphora list¶

List amphora (admin).

Usage:

orca loadbalancer amphora list [OPTIONS]

Options:

Name	Type	Description	Default
`--lb-id`	text	Filter by load balancer ID.	None
`--status`	text	Filter by amphora status.	None
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer amphora show¶

Show amphora details (admin).

Usage:

orca loadbalancer amphora show [OPTIONS] AMPHORA_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer amphora-failover¶

Trigger a failover for an amphora (admin).

Usage:

orca loadbalancer amphora-failover [OPTIONS] AMPHORA_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer amphora-list¶

List amphora (admin).

Usage:

orca loadbalancer amphora-list [OPTIONS]

Options:

Name	Type	Description	Default
`--lb-id`	text	Filter by load balancer ID.	None
`--status`	text	Filter by amphora status.	None
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer amphora-show¶

Show amphora details (admin).

Usage:

orca loadbalancer amphora-show [OPTIONS] AMPHORA_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer create¶

Create a load balancer.

Examples: orca loadbalancer create my-lb --subnet-id

Usage:

orca loadbalancer create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--subnet-id`	text	VIP subnet ID.	`Sentinel.UNSET`
`--description`	text	Description.	``
`--provider`	text	Provider (e.g. amphora, ovn).	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer delete¶

Delete a load balancer.

Usage:

orca loadbalancer delete [OPTIONS] LB_ID

Options:

Name	Type	Description	Default
`--cascade`	boolean	Delete LB and all child resources.	`False`
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer healthmonitor¶

Manage Octavia health monitors.

Usage:

orca loadbalancer healthmonitor [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create: Create a health monitor.
delete: Delete a health monitor.
list: List health monitors.
set: Update a health monitor.
show: Show health monitor details.

orca loadbalancer healthmonitor create¶

Create a health monitor.

Usage:

orca loadbalancer healthmonitor create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--pool-id`	text	Pool ID.	`Sentinel.UNSET`
`--type`	choice (`HTTP` \| `HTTPS` \| `PING` \| `TCP` \| `TLS-HELLO` \| `UDP-CONNECT`)	N/A	`Sentinel.UNSET`
`--delay`	integer	Probe interval (seconds).	`Sentinel.UNSET`
`--timeout`	integer	Probe timeout (seconds).	`Sentinel.UNSET`
`--max-retries`	integer	Max retries (1-10).	`3`
`--url-path`	text	HTTP URL path to probe.	`/`
`--expected-codes`	text	Expected HTTP codes.	`200`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer healthmonitor delete¶

Delete a health monitor.

Usage:

orca loadbalancer healthmonitor delete [OPTIONS] HM_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer healthmonitor list¶

List health monitors.

Usage:

orca loadbalancer healthmonitor list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer healthmonitor set¶

Update a health monitor.

Usage:

orca loadbalancer healthmonitor set [OPTIONS] HM_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--delay`	integer	Probe interval (seconds).	None
`--timeout`	integer	Probe timeout (seconds).	None
`--max-retries`	integer	Max retries.	None
`--url-path`	text	HTTP URL path to probe.	None
`--expected-codes`	text	Expected HTTP codes.	None
`--enable` / `--disable`	boolean	Enable or disable the health monitor.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer healthmonitor show¶

Show health monitor details.

Usage:

orca loadbalancer healthmonitor show [OPTIONS] HM_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer healthmonitor-create¶

Create a health monitor.

Usage:

orca loadbalancer healthmonitor-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--pool-id`	text	Pool ID.	`Sentinel.UNSET`
`--type`	choice (`HTTP` \| `HTTPS` \| `PING` \| `TCP` \| `TLS-HELLO` \| `UDP-CONNECT`)	N/A	`Sentinel.UNSET`
`--delay`	integer	Probe interval (seconds).	`Sentinel.UNSET`
`--timeout`	integer	Probe timeout (seconds).	`Sentinel.UNSET`
`--max-retries`	integer	Max retries (1-10).	`3`
`--url-path`	text	HTTP URL path to probe.	`/`
`--expected-codes`	text	Expected HTTP codes.	`200`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer healthmonitor-delete¶

Delete a health monitor.

Usage:

orca loadbalancer healthmonitor-delete [OPTIONS] HM_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer healthmonitor-list¶

List health monitors.

Usage:

orca loadbalancer healthmonitor-list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer healthmonitor-set¶

Update a health monitor.

Usage:

orca loadbalancer healthmonitor-set [OPTIONS] HM_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--delay`	integer	Probe interval (seconds).	None
`--timeout`	integer	Probe timeout (seconds).	None
`--max-retries`	integer	Max retries.	None
`--url-path`	text	HTTP URL path to probe.	None
`--expected-codes`	text	Expected HTTP codes.	None
`--enable` / `--disable`	boolean	Enable or disable the health monitor.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer healthmonitor-show¶

Show health monitor details.

Usage:

orca loadbalancer healthmonitor-show [OPTIONS] HM_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7policy¶

Manage Octavia L7 policies (compound noun).

Usage:

orca loadbalancer l7policy [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create: Create an L7 policy.
delete: Delete an L7 policy.
list: List L7 policies.
set: Update an L7 policy.
show: Show L7 policy details.

orca loadbalancer l7policy create¶

Create an L7 policy.

Examples: orca loadbalancer l7policy-create --listener-id --action REJECT orca loadbalancer l7policy-create --listener-id \ --action REDIRECT_TO_POOL --redirect-pool-id

Usage:

orca loadbalancer l7policy create [OPTIONS]

Options:

Name	Type	Description	Default
`--listener-id`	text	Listener to attach the policy to.	`Sentinel.UNSET`
`--action`	choice (`REDIRECT_TO_POOL` \| `REDIRECT_TO_URL` \| `REJECT` \| `REDIRECT_PREFIX`)	Policy action.	`Sentinel.UNSET`
`--name`	text	Policy name.	None
`--description`	text	Description.	None
`--position`	integer	Policy position (order).	None
`--redirect-pool-id`	text	Pool to redirect to (REDIRECT_TO_POOL).	None
`--redirect-url`	text	URL to redirect to (REDIRECT_TO_URL).	None
`--redirect-prefix`	text	URL prefix to redirect to (REDIRECT_PREFIX).	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7policy delete¶

Delete an L7 policy.

Usage:

orca loadbalancer l7policy delete [OPTIONS] L7POLICY_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7policy list¶

List L7 policies.

Usage:

orca loadbalancer l7policy list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7policy set¶

Update an L7 policy.

Usage:

orca loadbalancer l7policy set [OPTIONS] L7POLICY_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--action`	choice (`REDIRECT_TO_POOL` \| `REDIRECT_TO_URL` \| `REJECT` \| `REDIRECT_PREFIX`)	New action.	None
`--position`	integer	New position.	None
`--redirect-pool-id`	text	New redirect pool ID.	None
`--redirect-url`	text	New redirect URL.	None
`--enable` / `--disable`	boolean	Enable or disable.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7policy show¶

Show L7 policy details.

Usage:

orca loadbalancer l7policy show [OPTIONS] L7POLICY_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7policy-create¶

Create an L7 policy.

Examples: orca loadbalancer l7policy-create --listener-id --action REJECT orca loadbalancer l7policy-create --listener-id \ --action REDIRECT_TO_POOL --redirect-pool-id

Usage:

orca loadbalancer l7policy-create [OPTIONS]

Options:

Name	Type	Description	Default
`--listener-id`	text	Listener to attach the policy to.	`Sentinel.UNSET`
`--action`	choice (`REDIRECT_TO_POOL` \| `REDIRECT_TO_URL` \| `REJECT` \| `REDIRECT_PREFIX`)	Policy action.	`Sentinel.UNSET`
`--name`	text	Policy name.	None
`--description`	text	Description.	None
`--position`	integer	Policy position (order).	None
`--redirect-pool-id`	text	Pool to redirect to (REDIRECT_TO_POOL).	None
`--redirect-url`	text	URL to redirect to (REDIRECT_TO_URL).	None
`--redirect-prefix`	text	URL prefix to redirect to (REDIRECT_PREFIX).	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7policy-delete¶

Delete an L7 policy.

Usage:

orca loadbalancer l7policy-delete [OPTIONS] L7POLICY_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7policy-list¶

List L7 policies.

Usage:

orca loadbalancer l7policy-list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7policy-set¶

Update an L7 policy.

Usage:

orca loadbalancer l7policy-set [OPTIONS] L7POLICY_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--action`	choice (`REDIRECT_TO_POOL` \| `REDIRECT_TO_URL` \| `REJECT` \| `REDIRECT_PREFIX`)	New action.	None
`--position`	integer	New position.	None
`--redirect-pool-id`	text	New redirect pool ID.	None
`--redirect-url`	text	New redirect URL.	None
`--enable` / `--disable`	boolean	Enable or disable.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7policy-show¶

Show L7 policy details.

Usage:

orca loadbalancer l7policy-show [OPTIONS] L7POLICY_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7rule¶

Manage Octavia L7 rules (compound noun).

Usage:

orca loadbalancer l7rule [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create: Create an L7 rule.
delete: Delete an L7 rule.
list: List L7 rules for a policy.
set: Update an L7 rule.
show: Show L7 rule details.

orca loadbalancer l7rule create¶

Create an L7 rule.

Examples: orca loadbalancer l7rule-create \ --type PATH --compare-type STARTS_WITH --value /api

Usage:

orca loadbalancer l7rule create [OPTIONS] L7POLICY_ID

Options:

Name	Type	Description	Default
`--type`	choice (`COOKIE` \| `FILE_TYPE` \| `HEADER` \| `HOST_NAME` \| `PATH` \| `SSL_CONN_HAS_CERT` \| `SSL_VERIFY_RESULT` \| `SSL_DN_FIELD`)	Rule type.	`Sentinel.UNSET`
`--compare-type`	choice (`CONTAINS` \| `ENDS_WITH` \| `EQUAL_TO` \| `REGEX` \| `STARTS_WITH`)	Comparison type.	`Sentinel.UNSET`
`--value`	text	Value to compare against.	`Sentinel.UNSET`
`--key`	text	Key (for HEADER, COOKIE rules).	None
`--invert`	boolean	Invert the match result.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7rule delete¶

Delete an L7 rule.

Usage:

orca loadbalancer l7rule delete [OPTIONS] L7POLICY_ID L7RULE_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7rule list¶

List L7 rules for a policy.

Usage:

orca loadbalancer l7rule list [OPTIONS] L7POLICY_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7rule set¶

Update an L7 rule.

Usage:

orca loadbalancer l7rule set [OPTIONS] L7POLICY_ID L7RULE_ID

Options:

Name	Type	Description	Default
`--type`	choice (`COOKIE` \| `FILE_TYPE` \| `HEADER` \| `HOST_NAME` \| `PATH` \| `SSL_CONN_HAS_CERT` \| `SSL_VERIFY_RESULT` \| `SSL_DN_FIELD`)	New rule type.	None
`--compare-type`	choice (`CONTAINS` \| `ENDS_WITH` \| `EQUAL_TO` \| `REGEX` \| `STARTS_WITH`)	New comparison type.	None
`--value`	text	New value.	None
`--key`	text	New key.	None
`--invert` / `--no-invert`	boolean	Invert match.	None
`--enable` / `--disable`	boolean	Enable or disable the rule.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7rule show¶

Show L7 rule details.

Usage:

orca loadbalancer l7rule show [OPTIONS] L7POLICY_ID L7RULE_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7rule-create¶

Create an L7 rule.

Examples: orca loadbalancer l7rule-create \ --type PATH --compare-type STARTS_WITH --value /api

Usage:

orca loadbalancer l7rule-create [OPTIONS] L7POLICY_ID

Options:

Name	Type	Description	Default
`--type`	choice (`COOKIE` \| `FILE_TYPE` \| `HEADER` \| `HOST_NAME` \| `PATH` \| `SSL_CONN_HAS_CERT` \| `SSL_VERIFY_RESULT` \| `SSL_DN_FIELD`)	Rule type.	`Sentinel.UNSET`
`--compare-type`	choice (`CONTAINS` \| `ENDS_WITH` \| `EQUAL_TO` \| `REGEX` \| `STARTS_WITH`)	Comparison type.	`Sentinel.UNSET`
`--value`	text	Value to compare against.	`Sentinel.UNSET`
`--key`	text	Key (for HEADER, COOKIE rules).	None
`--invert`	boolean	Invert the match result.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7rule-delete¶

Delete an L7 rule.

Usage:

orca loadbalancer l7rule-delete [OPTIONS] L7POLICY_ID L7RULE_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7rule-list¶

List L7 rules for a policy.

Usage:

orca loadbalancer l7rule-list [OPTIONS] L7POLICY_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7rule-set¶

Update an L7 rule.

Usage:

orca loadbalancer l7rule-set [OPTIONS] L7POLICY_ID L7RULE_ID

Options:

Name	Type	Description	Default
`--type`	choice (`COOKIE` \| `FILE_TYPE` \| `HEADER` \| `HOST_NAME` \| `PATH` \| `SSL_CONN_HAS_CERT` \| `SSL_VERIFY_RESULT` \| `SSL_DN_FIELD`)	New rule type.	None
`--compare-type`	choice (`CONTAINS` \| `ENDS_WITH` \| `EQUAL_TO` \| `REGEX` \| `STARTS_WITH`)	New comparison type.	None
`--value`	text	New value.	None
`--key`	text	New key.	None
`--invert` / `--no-invert`	boolean	Invert match.	None
`--enable` / `--disable`	boolean	Enable or disable the rule.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer l7rule-show¶

Show L7 rule details.

Usage:

orca loadbalancer l7rule-show [OPTIONS] L7POLICY_ID L7RULE_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer list¶

List load balancers.

Usage:

orca loadbalancer list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer listener¶

Manage Octavia listeners.

Usage:

orca loadbalancer listener [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create: Create a listener.
delete: Delete a listener.
list: List listeners.
set: Update a listener.
show: Show listener details.

orca loadbalancer listener create¶

Create a listener.

Usage:

orca loadbalancer listener create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--lb-id`	text	Load balancer ID.	`Sentinel.UNSET`
`--protocol`	choice (`HTTP` \| `HTTPS` \| `TCP` \| `UDP` \| `TERMINATED_HTTPS`)	N/A	`Sentinel.UNSET`
`--port`	integer	Listen port.	`Sentinel.UNSET`
`--default-pool-id`	text	Default pool ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer listener delete¶

Delete a listener.

Usage:

orca loadbalancer listener delete [OPTIONS] LISTENER_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer listener list¶

List listeners.

Usage:

orca loadbalancer listener list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer listener set¶

Update a listener.

Usage:

orca loadbalancer listener set [OPTIONS] LISTENER_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--default-pool-id`	text	New default pool ID.	None
`--connection-limit`	integer	Max connections (-1 for unlimited).	None
`--enable` / `--disable`	boolean	Enable or disable the listener.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer listener show¶

Show listener details.

Usage:

orca loadbalancer listener show [OPTIONS] LISTENER_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer listener-create¶

Create a listener.

Usage:

orca loadbalancer listener-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--lb-id`	text	Load balancer ID.	`Sentinel.UNSET`
`--protocol`	choice (`HTTP` \| `HTTPS` \| `TCP` \| `UDP` \| `TERMINATED_HTTPS`)	N/A	`Sentinel.UNSET`
`--port`	integer	Listen port.	`Sentinel.UNSET`
`--default-pool-id`	text	Default pool ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer listener-delete¶

Delete a listener.

Usage:

orca loadbalancer listener-delete [OPTIONS] LISTENER_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer listener-list¶

List listeners.

Usage:

orca loadbalancer listener-list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer listener-set¶

Update a listener.

Usage:

orca loadbalancer listener-set [OPTIONS] LISTENER_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--default-pool-id`	text	New default pool ID.	None
`--connection-limit`	integer	Max connections (-1 for unlimited).	None
`--enable` / `--disable`	boolean	Enable or disable the listener.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer listener-show¶

Show listener details.

Usage:

orca loadbalancer listener-show [OPTIONS] LISTENER_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer member¶

Manage Octavia pool members.

Usage:

orca loadbalancer member [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

add: Add a member to a pool.
list: List members in a pool.
remove: Remove a member from a pool.
set: Update a pool member.
show: Show member details.

orca loadbalancer member add¶

Add a member to a pool.

Usage:

orca loadbalancer member add [OPTIONS] POOL_ID

Options:

Name	Type	Description	Default
`--address`	text	Member IP address.	`Sentinel.UNSET`
`--port`	integer	Member port.	`Sentinel.UNSET`
`--subnet-id`	text	Member subnet ID.	None
`--weight`	integer	Weight (0-256).	`1`
`--name`	text	Member name.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer member list¶

List members in a pool.

Usage:

orca loadbalancer member list [OPTIONS] POOL_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer member remove¶

Remove a member from a pool.

Usage:

orca loadbalancer member remove [OPTIONS] POOL_ID MEMBER_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer member set¶

Update a pool member.

Usage:

orca loadbalancer member set [OPTIONS] POOL_ID MEMBER_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--weight`	integer	New weight (0-256).	None
`--enable` / `--disable`	boolean	Enable or disable the member.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer member show¶

Show member details.

Usage:

orca loadbalancer member show [OPTIONS] POOL_ID MEMBER_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer member-add¶

Add a member to a pool.

Usage:

orca loadbalancer member-add [OPTIONS] POOL_ID

Options:

Name	Type	Description	Default
`--address`	text	Member IP address.	`Sentinel.UNSET`
`--port`	integer	Member port.	`Sentinel.UNSET`
`--subnet-id`	text	Member subnet ID.	None
`--weight`	integer	Weight (0-256).	`1`
`--name`	text	Member name.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer member-list¶

List members in a pool.

Usage:

orca loadbalancer member-list [OPTIONS] POOL_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer member-remove¶

Remove a member from a pool.

Usage:

orca loadbalancer member-remove [OPTIONS] POOL_ID MEMBER_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer member-set¶

Update a pool member.

Usage:

orca loadbalancer member-set [OPTIONS] POOL_ID MEMBER_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--weight`	integer	New weight (0-256).	None
`--enable` / `--disable`	boolean	Enable or disable the member.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer member-show¶

Show member details.

Usage:

orca loadbalancer member-show [OPTIONS] POOL_ID MEMBER_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer pool¶

Manage Octavia pools.

Usage:

orca loadbalancer pool [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create: Create a pool.
delete: Delete a pool.
list: List pools.
set: Update a pool.
show: Show pool details.

orca loadbalancer pool create¶

Create a pool.

Usage:

orca loadbalancer pool create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--listener-id`	text	Listener ID to attach to.	None
`--lb-id`	text	Load balancer ID (if no listener).	None
`--protocol`	choice (`HTTP` \| `HTTPS` \| `PROXY` \| `TCP` \| `UDP`)	N/A	`Sentinel.UNSET`
`--algorithm`	choice (`ROUND_ROBIN` \| `LEAST_CONNECTIONS` \| `SOURCE_IP`)	Load balancing algorithm.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer pool delete¶

Delete a pool.

Usage:

orca loadbalancer pool delete [OPTIONS] POOL_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer pool list¶

List pools.

Usage:

orca loadbalancer pool list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer pool set¶

Update a pool.

Usage:

orca loadbalancer pool set [OPTIONS] POOL_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--algorithm`	choice (`ROUND_ROBIN` \| `LEAST_CONNECTIONS` \| `SOURCE_IP`)	New LB algorithm.	None
`--enable` / `--disable`	boolean	Enable or disable the pool.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer pool show¶

Show pool details.

Usage:

orca loadbalancer pool show [OPTIONS] POOL_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer pool-create¶

Create a pool.

Usage:

orca loadbalancer pool-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--listener-id`	text	Listener ID to attach to.	None
`--lb-id`	text	Load balancer ID (if no listener).	None
`--protocol`	choice (`HTTP` \| `HTTPS` \| `PROXY` \| `TCP` \| `UDP`)	N/A	`Sentinel.UNSET`
`--algorithm`	choice (`ROUND_ROBIN` \| `LEAST_CONNECTIONS` \| `SOURCE_IP`)	Load balancing algorithm.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer pool-delete¶

Delete a pool.

Usage:

orca loadbalancer pool-delete [OPTIONS] POOL_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer pool-list¶

List pools.

Usage:

orca loadbalancer pool-list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer pool-set¶

Update a pool.

Usage:

orca loadbalancer pool-set [OPTIONS] POOL_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--algorithm`	choice (`ROUND_ROBIN` \| `LEAST_CONNECTIONS` \| `SOURCE_IP`)	New LB algorithm.	None
`--enable` / `--disable`	boolean	Enable or disable the pool.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer pool-show¶

Show pool details.

Usage:

orca loadbalancer pool-show [OPTIONS] POOL_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer set¶

Update a load balancer.

Usage:

orca loadbalancer set [OPTIONS] LB_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--enable` / `--disable`	boolean	Enable or disable the load balancer.	None
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer show¶

Show load balancer details.

Usage:

orca loadbalancer show [OPTIONS] LB_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer stats¶

Inspect Octavia load-balancer stats.

Usage:

orca loadbalancer stats [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

show: Show load balancer statistics.

orca loadbalancer stats show¶

Show load balancer statistics.

Usage:

orca loadbalancer stats show [OPTIONS] LB_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer stats-show¶

Show load balancer statistics.

Usage:

orca loadbalancer stats-show [OPTIONS] LB_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer status¶

Inspect Octavia load-balancer status.

Usage:

orca loadbalancer status [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

show: Show load balancer operating status tree.

orca loadbalancer status show¶

Show load balancer operating status tree.

Usage:

orca loadbalancer status show [OPTIONS] LB_ID

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca loadbalancer status-show¶

Show load balancer operating status tree.

Usage:

orca loadbalancer status-show [OPTIONS] LB_ID

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`