Skip to end of metadata
Go to start of metadata
MANAGE-LB-POOL(1)      Xandr CLI Documentation v0.486     MANAGE-LB-POOL(1)
NAME
       manage-lb-pool -
       create/modify/list/list-nodes/list-dns/status/add-node/modify-node/remove-node/activate-node/deactivate-node/show-certificate/get-stats/delete
       load-balancing pools
SYNOPSIS
       manage-lb-pool create --ip address -n name [--type type] [--port port]
       [--method lb_method] [--certificate certificate] [--key private_key]
       [--chain certificate_chain] [--request-string send_string]
       [--search-string receive_string] [--redirect-to URL] [--metadata string
       | --metadata-file path] [ --lb-id lb_id ]
       manage-lb-pool modify (-p pool_id | -n name) [--port port] [--method
       lb_method] [--certificate certificate] [--key private_key] [--chain
       certificate_chain] [ --delete-chain ] [--request-string send_string]
       [--search-string receive_string] [--redirect-to URL] [--metadata string
       | --metadata-file path]
       manage-lb-pool list [-s col_name | -b col_name] [-F perl_expression]
       [-f filters] [--metadata] [ --oc col_name ] [-R] [-v]
       manage-lb-pool list-dns [-s col_name | -b col_name] [-F
       perl_expression] [-f filters] [ --oc col_name ] [-R]
       manage-lb-pool list-nodes (-p pool_id | -n name) [--ip address] [-s
       col_name | -b col_name] [-F perl_expression] [-f filters] [ --oc
       col_name ] [-R]
       manage-lb-pool status (-p pool_id | -n name) [-s col_name | -b
       col_name] [-F perl_expression] [-f filters] [ --oc col_name ] [-R]
       manage-lb-pool add-node (-p pool_id | -n name) --node address[:port]
       [--weight number] [--idempotent]
       manage-lb-pool modify-node (-p pool_id | -n name) --node address:port
       --weight number [--idempotent]
       manage-lb-pool remove-node (-p pool_id | -n name) --node address:port
       [--idempotent]
       manage-lb-pool activate-node (-p pool_id | -n name) --node address:port
       [--idempotent]
       manage-lb-pool deactivate-node (-p pool_id | -n name) --node
       address:port [--idempotent]
       manage-lb-pool show-certificate (-p pool_id | -n name)
       manage-lb-pool get-stats (-p pool_id | -n name) --from-date date
       --to-date date [--side side]
       manage-lb-pool delete (-p pool_id | -n name)
       manage-lb-pool history [-p pool_id] [--depth number]
       manage-lb-pool command [--username username] [--password password]
       manage-lb-pool command -h
       manage-lb-pool (help | -h) [command]
       manage-lb-pool -V
DESCRIPTION
       Note: before you can create a load-balancing pool you must reserve an
       IP. To do so, please use the manage-lb-ip command.
       The manage-lb-pool command is your interface into managing your local
       load-balancing pools. To set up load balancing, you first create a
       pool, and then add individual nodes to that pool.  The pool contains
       all the parameters for load balancing - the external virtual IP address
       (VIP), port, method, type, certificates, and monitoring instructions.
       Each pool has a single externally facing IP address and port.  By
       default the firewall rules are set up for load balancer VIPs to allow
       traffic from all sources.  The load-balancing method determines how the
       F5 will distribute traffic among different nodes.  To read more about
       load-balancing methods and best practices please see:
           http://wiki.Xandr.com/display/documentation/Load+Balancing+Documentation
       There are several types of pools available. The default is a standard
       HTTP pool where all connections are performed over an HTTP protocol.
       Other pool types are listed below; please use the --type parameter when
       creating these types of pools. Note that only RSA private/public keys
       are allowed for HTTPS pools. If you wish to load balance a set of nodes
       on both HTTP and HTTPS you will need to set up two separate pools.
OPTIONS
       --node
           Nodes to be added, modified, removed, activated, or deactivated in
           LB pool. Use --node ip_address1:port1{,ip_addressN:portN} where {}
           indicates an optional parameter. For example, --node
           8.12.230.92:80,8.12.230.93:8080. Please note that port is optional
           for add-node command; the current pool port will be used as a
           default. However, port is mandatory for modify-node, remove-node,
           activate-node, and deactivate-node commands. You can add a single
           node multiple times with different ports.
       --ip
           IP address that you have reserved for the pool. Must be a composite
           string ’<datacenter_id>:<ip_address>’, e.g. ’NYM1:192.168.128.1’,
           ’LAX1:192.168.128.2’. See manage-lb-ip for more information.
       --lb-id
           Load balancer on which to create a new pool. If not specified the
           pool will be created on the most heavily weighted load balancer.
           See manage-lb list.
       -n, --name
           Name of the load-balancing pool. Use only alphanumeric characters
           and underscores and dashes. Note: must be specified as a composite
           string ’<datacenter_id>:<pool_name>’ (e.g. ’NYM1:devel’,
           ’LAX1:pool2’) when the following actions are being performed:
           modify, delete, status, add-node, modify-node, remove-node,
           activate-node, deactivate-node, show-certificate, get-stats.
       --type
           Type of load-balancing pool. Here are currently supported values.
               ’http’ - all connections are performed over HTTP protocol.
               ’https’ - all connections are performed over HTTPS protocol
               only.
               ’https_offload’ - client side traffic is passed over HTTPS but
               server side traffic is passed over HTTP protocol only.
               ’http_fast’ - a scaled down version of HTTP type optimized for
               speed under ideal traffic conditions.
               ’http_secure_redirect’ - redirects users to HTTPS when they
               connect to a VIP using HTTP.
               ’https_redirect’ - redirects users to a different HTTPS URL
               when they connect to a VIP using HTTPS. See also the
               --redirect-to option.
               ’http_persistent’ - a version of HTTP type with enabled session
               persistence.
               ’https_persistent’ - a version of HTTPS type with enabled
               session persistence.
               ’https_offload_persistent’ - a version of HTTPS offload type
               with enabled session persistence.
               ’smtp’ - all connections are performed over SMTP protocol.
           Default is ’http’.
       --redirect-to
           Specifies the redirect destination URL.
       --port
           External port for the pool. Default is 80.
       -p, --pool-id
           ID of the pool you are managing. Must be a composite string
           ’<datacenter_id>:<pool_id>’, e.g. ’NYM1:1’, ’LAX1:210’. To see
           pool_ids, use manage-lb-pool list.
       --method
           Method used for load balancing. Possible values are: round_robin,
           fastest_node_address, least_connection_member,
           observed_node_address, ratio_member. Default value is round_robin.
           Not available for HTTP secure redirect.
       --certificate
           Path to certificate file. The certificate must contain an RSA
           public key. Available only for HTTPS, HTTPS persistent, HTTPS
           offload, and HTTPS offload persistent.
       --key
           Path to private key file. Only unencrypted RSA private keys are
           supported. Available only for HTTPS, HTTPS persistent, HTTPS
           offload, and HTTPS offload persistent.
       --chain
           Path to intermediate certificate chain file. Available only for
           HTTPS, HTTPS persistent, HTTPS offload, and HTTPS offload
           persistent.
       --delete-chain
           Delete existing intermediate certificate chain file. Avoid
           unnecessary data transfer to clients if you update your certificate
           and no longer require a previously existing intermediate
           certificate chain file.
       --request-string
           When checking the status of a node the load balancer will connect
           on the specified IP and port and send this string.  This request
           should include the HTTP method, the URI to request from the node,
           and the HTTP version.  A good way to emulate this yourself is to
           telnet to the node on the specified IP address and port and type in
           the request_string. The default is ’GET / HTTP/1.0\r\n\r\n’. Not
           available for SMTP and HTTP secure redirect.
       --search-string
           This is the string that the load balancer will look for in response
           to the request_string.  If no search_string is specified then any
           valid content that is returned will work.  Default is ’200 OK’. The
           load balancer will search for this value in both the HTTP response
           header and HTTP response body, and the request is treated as
           successful if it is found in either part of the response. Not
           available for SMTP and HTTP secure redirect.
       --weight
           Weight given to the node. Use --weight number1{,numberN} where {}
           indicates an optional parameter (the number(s) may belong to the
           range [1 ... 100] only). Note: number of comma-separated values
           must correspond to the number of values specified by the --node
           parameter. For example, if you set weights 3,1 for your two nodes,
           the load balancer will send three requests to the first node for
           each request to the second node. Available only for pools with the
           ratio_member load-balancing method. Default is 1.
       --idempotent
           You can use this option with commands add-node, remove-node,
           modify-node, activate-node, and deactivate-node. The effect of this
           option is to ignore nodes that are already in the desired state.
           For example, if you are trying the add nodes X and Y to an LB pool,
           and the node X is already in the LB pool, the command will not
           display an error but it will proceed with adding the node Y to the
           pool, and report that the node Y has been added.
       --metadata
           An arbitrary string that should be set as pool’s metadata. Also you
           can use the --metadata optional parameter for including pool’s
           metadata into output of the list command. Please note, the --raw
           optional parameter will be enabled in this case implicitly.
       --metadata-file
           Path to file whose content should be uploaded as pool’s metadata.
       --from-date
           Beginning of time interval for get-stats command. Allowed format:
           YYYY-MM-DD.
       --to-date
           End of time interval for get-stats command. Allowed format: YYYY-
           MM-DD.
       --side
           Side of load-balancing pool for get-stats command. Can be ’server’
           (get statistics for traffic gone through internal/private side of
           the F5, i.e., traffic between nodes and the F5) or ’client’ (get
           statistics for client side traffic, i.e., traffic between the F5
           and external clients). Default is ’server’.
       --depth
           Number of most recent operations to show in history. Default is 20.
       -v, --verbose
           Output data in verbose mode (show columns load balancer ID and load
           balancer name).
       -s, --sort
           Column name(s) for sorting (id, name, type, method, ip, port,
           status, request_string, search_string, is_custom, metadata, node,
           pool_id, instance_id, weight). Use --sort
           <column_name1>{,<column_nameN>}.
       -b, --rsort
           Column name(s) for reverse sorting.
       -f, --filter
           Filter results by column name (id, name, type, method, ip, port,
           status, request_string, search_string, is_custom, metadata, node,
           pool_id, instance_id, weight). Use --filter
           <column_name1>=<pattern1>{,<patternN>}
           {<column_name2>=<pattern2>{,<patternN>} where {} indicates an
           optional parameter. Do not use a space between multiple patterns.
           For example, --filter type=http,https.
       -F, --server-side-filter
           Filters results on the server side before they are passed to the
           client. The value for this option is a perl expression which
           controls whether rows are included in the result set returned to
           the client. Server and client side filtering can be freely
           combined. See the section SERVER SIDE FILTERING for more details.
       --oc
           Specify a comma separated list of data columns to return in list
           output.
       -R, --raw
           Output data in tab-delimited format.
       --username
           Username for API, same as for Customer Portal. Could be specified
           in CLI config file "rpc.cfg" (expected locations: /etc/Xandr,
           ~/.Xandr, or the current working directory).
       --password
           Password for API, same as for Customer Portal. If password isn’t
           specified, you’ll be asked to enter it. Note that specifying a
           password on the command line should be considered insecure.
           Password could be specified in CLI config file, but to keep the
           password safe, the file should not be accessible to anyone but
           yourself. To ensure this, set the file access mode to 400 or 600.
       -V, --version
           Version of the command-line interface you are currently using.
       -h, --help
           Display help.
COMMANDS
   create
           Create a new pool.
           Required Parameters: --ip, -n/--name
           Optional Parameters: --type, --port, --method, --certificate,
           --key, --chain, --request-string, --search-string, --redirect-to,
           (--metadata | --metadata-file), --lb-id
   modify
           Modify your pool.
           Required Parameters: (-p/--pool-id | -n/--name)
           Optional Parameters: --port, --method, --certificate, --key,
           --chain, --delete-chain, --request-string, --search-string,
           --redirect-to, (--metadata | --metadata-file)
   list
           Show list of pools and their pool-ids.
           Required Parameters: none
           Optional Parameters: --metadata, (-s/--sort | -b/--rsort),
           -F/--server-side-filter, -f/--filter, --oc, -R/--raw, -v/--verbose
   list-dns
           Show list of pools and their DNS names.
           Required Parameters: none
           Optional Parameters: (-s/--sort | -b/--rsort),
           -F/--server-side-filter, -f/--filter, --oc, -R/--raw
   list-nodes
           Show list of all nodes in all pools. Specifying --pool-id, --name,
           or --ip will significantly improve the performance of this
           operation.
           Required Parameters: none
           Optional Parameters: (-p/--pool-id | -n/--name), --ip, (-s/--sort |
           -b/--rsort), -F/--server-side-filter, -f/--filter, --oc, -R/--raw
   status
           List status of all nodes in pool. Not available for HTTP secure
           redirect.
           Required Parameters: (-p/--pool-id | -n/--name)
           Optional Parameters: (-s/--sort | -b/--rsort),
           -F/--server-side-filter, -f/--filter, --oc, -R/--raw
   add-node
           Add a node to your pool. Not available for HTTP secure redirect.
           Required Parameters: (-p/--pool-id | -n/--name), --node
           Optional Parameters: --weight, --idempotent
   modify-node
           Modify a node in your pool. Available only for pools with the
           ratio_member load-balancing method.
           Required Parameters: (-p/--pool-id | -n/--name), --node, --weight
           Optional Parameters: --idempotent
   remove-node
           Remove a node from your pool. Not available for HTTP secure
           redirect.
           Required Parameters: (-p/--pool-id | -n/--name), --node
           Optional Parameters: --idempotent
   activate-node
           Activate an inactive pool node. Not available for HTTP secure
           redirect.
           Required Parameters: (-p/--pool-id | -n/--name), --node
           Optional Parameters: --idempotent
   deactivate-node
           Deactivate an active pool node. This switches the node to an
           inactive state, removing it from the load balancer without removing
           it from the pool. Not available for HTTP secure redirect.
           Required Parameters: (-p/--pool-id | -n/--name), --node
           Optional Parameters: --idempotent
   show-certificate
           Show certificate, key, and intermediate certificate chain.
           Available only for HTTPS, HTTPS persistent, HTTPS offload, and
           HTTPS offload persistent.
           Required Parameters: (-p/--pool-id | -n/--name)
           Optional Parameters: none
   get-stats
           Show load-balancing usage statistics (megabits per second in/out,
           requests per second) during the specified time interval (maximum is
           one month).
           Required Parameters: (-p/--pool-id | -n/--name), --from-date,
           --to-date
           Optional Parameters: --side
   delete
           Delete your pool.
           Required Parameters: (-p/--pool-id | -n/--name)
           Optional Parameters: none
   history
           Show history of operations on pools. If no particular pool is
           specified then operations on all pools will be displayed.
           Required Parameters: none
           Optional Parameters: -p/--pool-id, --depth
   help
           Show help.
           Required Parameters: none
           Optional Parameters: create, modify, list, list-nodes, status, add-
           node, remove-node, activate-node, deactivate-node, show-
           certificate, get-stats, delete, history
SERVER SIDE FILTERING
       You can use the -F option to filter the result set on the server side
       before the results are passed to the client. The value for the -F
       option is a perl expression which, when evaluates to true, causes the
       row to be included in the result set, and when false, it causes this
       row to be excluded from the result set passed to the client. You can
       further refine the displayed results using client side filtering and
       ordering options -f, -s, and -b. The perl expression is limited to
       using variables, comparison operators, regular expressions,
       parentheses, and a few other operations. Function calls and loops are
       not allowed. Variable names match column names with the dollar sign
       prepended to them as is customary in perl.
   Examples:
       manage-lb-pool list -F ’$id eq "LAX1:1238"’
           List only the LB pool LAX1:1238.
       manage-lb-pool list -F ’$type eq "http" && $is_custom’
           List custom http LB pools.
       manage-lb-pool list -F ’$name =~ /redirect/’
           List LB pools whose name matches the perl regular expression
           ’redirect’.
DEPRECATED
       We have replaced underscores ’_’ with dashes ’-’ in all CLI parameter
       names to be more compliant with standard syntax. The following manage-
       lb-pool options are affected.
       Deprecated Parameters: --request_string, --search_string, --pool_id
SEE ALSO
       manage-instance, manage-server, manage-lb-ip, manage-vlan, manage-gslb-
       zone, manage-gslb-domain, manage-gslb-group, manage-storage, manage-
       dns-domain
0.486                             2018-02-13                 MANAGE-LB-POOL(1)