Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

twc-rs balancer

Manage load balancers

SubcommandDescription
listList all balancers
infoShow detailed info for a balancer
createCreate a new balancer
deleteDelete a balancer by ID
updateUpdate balancer settings
rule-listList rules for a balancer
rule-createCreate a rule for a balancer
rule-deleteDelete a rule from a balancer
ip-listList IPs for a balancer
ip-addAdd an IP to a balancer
ip-removeRemove an IP from a balancer
preset-listList available balancer presets

twc-rs balancer list

List all balancers

ArgumentDescriptionRequiredEnvDefault
--limitMaximum number of balancers to return
--offsetNumber of balancers to skip
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs balancer info

Show detailed info for a balancer

ArgumentDescriptionRequiredEnvDefault
--idBalancer IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs balancer create

Create a new balancer

ArgumentDescriptionRequiredEnvDefault
--nameBalancer nameyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs balancer delete

Delete a balancer by ID

ArgumentDescriptionRequiredEnvDefault
--idBalancer IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs balancer update

Update balancer settings

ArgumentDescriptionRequiredEnvDefault
--idBalancer IDyes
--nameNew balancer name
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs balancer rule-list

List rules for a balancer

ArgumentDescriptionRequiredEnvDefault
--idBalancer IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs balancer rule-create

Create a rule for a balancer

ArgumentDescriptionRequiredEnvDefault
--idBalancer IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs balancer rule-delete

Delete a rule from a balancer

ArgumentDescriptionRequiredEnvDefault
--idBalancer IDyes
--rule-idRule ID to deleteyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs balancer ip-list

List IPs for a balancer

ArgumentDescriptionRequiredEnvDefault
--idBalancer IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs balancer ip-add

Add an IP to a balancer

ArgumentDescriptionRequiredEnvDefault
--idBalancer IDyes
--ipIP address to addyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs balancer ip-remove

Remove an IP from a balancer

ArgumentDescriptionRequiredEnvDefault
--idBalancer IDyes
--ipIP address to removeyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs balancer preset-list

List available balancer presets

ArgumentDescriptionRequiredEnvDefault
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE