Skip to end of metadata
Go to start of metadata
MANAGE-LB-IP(1)        Xandr CLI Documentation v0.486       MANAGE-LB-IP(1)
NAME
       manage-lb-ip - list/list-dns/reserve/modify/release LB IP addresses
SYNOPSIS
       manage-lb-ip list [-a | -r] [-s col_name | -b col_name] [-F
       perl_expression] [-f filters] [ --oc col_name ] [-R]
       manage-lb-ip list-dns [-a | -r] [-s col_name | -b col_name] [-F
       perl_expression] [-f filters] [ --oc col_name ] [-R]
       manage-lb-ip reserve --ip address [-d description ] [--dns dns_name]
       manage-lb-ip modify --ip address -d description
       manage-lb-ip modify-dns --ip address --dns dns_name
       manage-lb-ip release --ip address
       manage-lb-ip history [--ip address] [--depth number]
       manage-lb-ip command [--username username] [--password password]
       manage-lb-ip command -h
       manage-lb-ip (help | -h) [command]
       manage-lb-ip -V
DESCRIPTION
       Before you can create a load-balancing pool you must reserve an IP. The
       load-balancer IP is a floating virtual IP (or VIP) that once reserved
       is dedicated to you and cannot be used by any other customer.  Firewall
       rules on LB VIPs have been opened up so that any source address is
       allowed. The IP can be used for more than one LB pool as long as there
       is a unique VIP-port combination.
OPTIONS
       --ip
           IP address to reserve or release. Must be a composite string
           ’<datacenter_id>:<ip_address>’, e.g. ’NYM1:192.168.128.1’,
           ’LAX1:192.168.128.2’.
       -a, --available
           List available LB IP addresses.
       -r, --reserved
           List LB IP addresses that you have already reserved.
       -d, --description
           Optional custom description to attach to the IP address.
       --dns
           The desired DNS name for the IP address. See the section DNS NAMES
           below for more details.
       --depth
           Number of most recent operations to show in history. Default is 20.
       -s, --sort
           Column name(s) for sorting (ip, status, description). Use --sort
           <column_name1>{,<column_nameN>}.
       -b, --rsort
           Column name(s) for reverse sorting.
       -f, --filter
           Filter results by column name (ip, status, description). 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 description=www.mycompany.com,blue.
       -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 form.
       --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
   list
           List all available load-balancer IPs.
           Required Parameters: none
           Optional Parameters: (-a/--available | -r/--reserved), (-s/--sort |
           -b/--rsort), -F/--server-side-filter, -f/--filter, --oc, -R/--raw
   list-dns
           Show list of load-balancer IPs with their DNS names.
           Required Parameters: none
           Optional Parameters: --metadata, (-s/--sort | -b/--rsort),
           -F/--server-side-filter, -f/--filter, --oc, -R/--raw
   reserve
           Reserve a new load-balancer IP address and optionally create a DNS
           record for the reserved address.
           Required Parameters: --ip
           Optional Parameters: -d/--description, --dns
   modify
           Change or add a description for a reserved load-balancer IP.
           Required Parameters: --ip, -d/--description
           Optional Parameters: none
   modify-dns
           Modify the DNS name for the specified load-balancer IP address.
           Required Parameters: --ip, --dns
   release
           Release a previously reserved load-balancer IP. If a DNS record for
           the reserved address exists, it will be removed.
           Required Parameters: --ip
           Optional Parameters: none
   history
           Show history of operations on load-balancer IPs. If no particular
           IP is specified then operations on all IPs will be displayed.
           Required Parameters: none
           Optional Parameters: --ip, --depth
   help
           Show help.
           Required Parameters: none
           Optional Parameters: list, reserve, modify, release, history
DNS NAMES
       Please note that fully qualified DNS names must end with a dot ’.’. DNS
       names without the terminating dot will have the default DNS domain
       appended to them. You can list your DNS domains, determine which domain
       is the default domain, and change the default DNS domain with the
       command manage-dns-domain.
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-ip list -F ’$ip =~ /NYM2/ && $status eq "available"’
           List available IPs in NYM2.
       manage-lb-ip list -F ’$status =~ /used/ && !$description’
           List used IPs that do not have a description.
SEE ALSO
       manage-instance, manage-server, manage-lb-pool, manage-vlan, manage-
       gslb-zone, manage-gslb-domain, manage-gslb-group, manage-storage
0.486                             2018-02-13                   MANAGE-LB-IP(1)