LR Product Documentation Documentation Release 2.5 The LR Team February 10, 2015
Contents 1 Getting Started Guide 1 1.1 Overview................................................. 1 1.2 About the Examples........................................... 1 1.3 Contents................................................. 1 2 CLI Reference 3 2.1 Overview................................................. 3 2.2 Contents................................................. 3 3 About This Guide 13 4 LR Manager Guide 15 4.1 Overview................................................. 15 4.2 About the Examples........................................... 15 4.3 Contents................................................. 15 5 Indices and tables 17 i
ii
CHAPTER 1 Getting Started Guide 1.1 Overview This guide is your starting point to learn about LR. We ll walk you through installing LR, as well the basics that you need to know to use the command line interface (CLI). The guide then continues with configuring basic examples, including management access, configuring a load balancer (reverse proxy), including SSL setup, and configuring a forward proxy. 1.2 About the Examples We provide a detailed architecture example, including all naming, IP addresses, and other settings, so you can focus on understanding how to use the software, not on what to name things. At the end of the guide, we have a complete annotated example of everything you configured for you to refer to. After completing this example configuration, you will be better prepared to plan for your LR implementation. 1.3 Contents 1
2 Chapter 1. Getting Started Guide
CHAPTER 2 CLI Reference 2.1 Overview 2.2 Contents 2.2.1 About this CLI Reference Guide 2.2.2 Deprecated CLI Commands 2.2.3 CLI General Reference 2.2.4 Boot Mode Commands boot Configure version to use to reload the system. Use Whenever you upgrade LR, the system retains the previous version, including all configuration settings at the time of the upgrade. If needed, you can reload any previous version by setting the version you want to reload using the boot command. To see the previous versions available, use the following commands: bash "ls /base/persist" Note: Be sure to use write to save your change after using the boot command, then use reload to actually reload to the specified version. Default Setting Current system software version 3
Command Mode configure Syntax boot system <version> Configure version of LR to reload Parameter Type Description version String Version to reload Related Commands 1. Reload Mode Commands 2. Upgrade Command 3. REST API Reference - boot 2.2.5 Exit Command 2.2.6 Overview 2.2.7 Contents Boot Mode Commands boot Configure version to use to reload the system. Use Whenever you upgrade LR, the system retains the previous version, including all configuration settings at the time of the upgrade. If needed, you can reload any previous version by setting the version you want to reload using the boot command. To see the previous versions available, use the following commands: bash "ls /base/persist" Note: Be sure to use write to save your change after using the boot command, then use reload to actually reload to the specified version. Default Setting Current system software version Command Mode configure 4 Chapter 2. CLI Reference
Syntax boot system <version> Configure version of LR to reload Parameter Type Description version String Version to reload Related Commands 1. Reload Mode Commands 2. Upgrade Command 3. REST API Reference - boot Exit Command Reload Mode Commands Reload Configure version to use to reload the system. Use Whenever you upgrade LR, the system retains the previous version, including all configuration settings at the time of the upgrade. If needed, you can reload any previous version by setting the version you want to reload using the boot command. To see the previous versions available, use the following commands: bash "ls /base/persist" Note: Be sure to use write to save your change after using the boot command, then use reload to actually reload to the specified version. Default Setting Current system software version Command Mode configure Syntax boot system <version> Configure version of LR to reload Parameter Type Description version String Version to reload Related Commands REST API Reference - boot Reload Mode Commands Upgrade Command 2.2. Contents 5
Upgrade Command boot Configure version to use to reload the system. Use Whenever you upgrade LR, the system retains the previous version, including all configuration settings at the time of the upgrade. If needed, you can reload any previous version by setting the version you want to reload using the boot command. To see the previous versions available, use the following commands: bash "ls /base/persist" Note: Be sure to use write to save your change after using the boot command, then use reload to actually reload to the specified version. Default Setting Current system software version Command Mode configure Syntax boot system <version> Configure version of LR to reload Parameter Type Description version String Version to reload Related Commands Reload Mode Commands Upgrade Command REST API Reference - boot Virtual IP Mode Commands Use the following commands to configure virtual IPs. virtual-ip Create or modify a virtual IP for reverse proxy (load balancing) or forward proxy. Use For either a load balancing or forward proxy use case, the system requires at least one virtual IP. The virtual IP is a configuration object that represents the interface that clients connect to. You can create as many virtual IPs as you need. For an overview of how virtual IPs are used in a load balancing use case, see LR Overview. We recommend giving each virtual IP a meaningful name that helps identify the virtual IP. For example, you might use the application or service type (such as serving similar web content) or security settings (such as SSL) in the name. 6 Chapter 2. CLI Reference
Use to set the IP address or IP address range and port for the virtual IP. This designates the IP addresses that the system will accept traffic for. Note: For most reverse proxy configurations, the IP address of each virtual IP must also be configured as an IP address on the data interface. If the IP address of the virtual IP is not also configured on a data interface, the system displays the following warning when you set the admin status to online: WARNING: virtual-ip test2 has ARP reply disabled until the IP address is configured on a system interface. You can set either a specific IP address and port or a range of IP addresses for a specific port. The range includes both addresses you specify as the range start and end. A range cannot overlap any other range on the system for the same port. If a virtual IP has a specific IP assigned to it that falls within the range of another virtual IP, the system sends all traffic to the virtual IP with the specific IP address. Caution: When attaching a virtual IP to a forward proxy, the virtual IP must not include any of the system s own IP addresses. For a virtual IP with a single IP address, do not set the virtual IP s IP address to one of the system s own IP addresses. For a virtual IP with a range of addresses, you must ensure that the IP address range does not contain any of the system s own IP addresses. This may mean you need to break the virtual IP into multiple virtual IPs. See Configuring a range for a virtual IP with forward proxy for more detail and an example. The system handles routed virtual IPs. Even if you set a large range of IP addresses for a virtual IP, the system only sends an ARP reply if an IP address in the range is configured on an interface. However, the system will accept traffic for any IP address in the range. Command Mode configure Syntax Create or modify a virtual IP for load balancing virtual-ip <name> IPv4 or IPv6 address of interface for client access virtual-ip <name> ip <addr> <port> Set the base that the virtual IP will inherit from virtual-ip <name> ip <addr> <port> base <basename> Set a range of IPv4 or IPv6 addresses for client access [no] virtual-ip <name> ip range <startaddr> <endaddr> <port> Set a range of IPv4 or IPv6 addresses for client access and set the base that the virtual IP will inherit from [no] virtual-ip <name> ip range <startaddr> <endaddr> <port> base <base_name> Create or modify a virtual IP base for virtual IPs to inherit virtual-ip base <name> Create or modify a virtual IP base for virtual IPs to inherit no base Configure version of LR to reload 2.2. Contents 7
Parameter Type Description addr IPAddr IPv4 or IPv6 address for interface configured for client access basename Word Name of base that the virtual IP will inherit from endaddr IPv4Addr Ending IPv4 or IPv6 address for interface configured for client access name Word Name of the virtual IP port Integer Port number to connect to on the real server startaddr IPv4Addr Starting IPv4 or IPv6 address for interface configured for client access Related Commands 1. REST API Reference - virtualip admin-status Bring an object, such as a health monitor, real server, or virtual IP, online or offline. After you create an object, you must bring it online. Use You typically set the offline status only when you want to disable the object or block connections to the web server during maintenance or system reconfiguration. Default Setting offline 2.2.8 Reload Mode Commands Reload Configure version to use to reload the system. Use Whenever you upgrade LR, the system retains the previous version, including all configuration settings at the time of the upgrade. If needed, you can reload any previous version by setting the version you want to reload using the boot command. To see the previous versions available, use the following commands: bash "ls /base/persist" Note: Be sure to use write to save your change after using the boot command, then use reload to actually reload to the specified version. Default Setting Current system software version Command Mode configure 8 Chapter 2. CLI Reference
Syntax boot system <version> Configure version of LR to reload Parameter Type Description version String Version to reload Related Commands Reload Mode Commands Upgrade Command REST API Reference - boot 2.2.9 Upgrade Command boot Configure version to use to reload the system. Use Whenever you upgrade LR, the system retains the previous version, including all configuration settings at the time of the upgrade. If needed, you can reload any previous version by setting the version you want to reload using the boot command. To see the previous versions available, use the following commands: bash "ls /base/persist" Note: Be sure to use write to save your change after using the boot command, then use reload to actually reload to the specified version. Default Setting Current system software version Command Mode configure Syntax boot system <version> Configure version of LR to reload Parameter Type Description version String Version to reload 2.2. Contents 9
Related Commands Reload Mode Commands Upgrade Command REST API Reference - boot 2.2.10 Virtual IP Mode Commands Use the following commands to configure virtual IPs. virtual-ip Create or modify a virtual IP for reverse proxy (load balancing) or forward proxy. Use For either a load balancing or forward proxy use case, the system requires at least one virtual IP. The virtual IP is a configuration object that represents the interface that clients connect to. You can create as many virtual IPs as you need. For an overview of how virtual IPs are used in a load balancing use case, see LR Overview. We recommend giving each virtual IP a meaningful name that helps identify the virtual IP. For example, you might use the application or service type (such as serving similar web content) or security settings (such as SSL) in the name. Use to set the IP address or IP address range and port for the virtual IP. This designates the IP addresses that the system will accept traffic for. Note: For most reverse proxy configurations, the IP address of each virtual IP must also be configured as an IP address on the data interface. If the IP address of the virtual IP is not also configured on a data interface, the system displays the following warning when you set the admin status to online: WARNING: virtual-ip test2 has ARP reply disabled until the IP address is configured on a system interface. You can set either a specific IP address and port or a range of IP addresses for a specific port. The range includes both addresses you specify as the range start and end. A range cannot overlap any other range on the system for the same port. If a virtual IP has a specific IP assigned to it that falls within the range of another virtual IP, the system sends all traffic to the virtual IP with the specific IP address. Caution: When attaching a virtual IP to a forward proxy, the virtual IP must not include any of the system s own IP addresses. For a virtual IP with a single IP address, do not set the virtual IP s IP address to one of the system s own IP addresses. For a virtual IP with a range of addresses, you must ensure that the IP address range does not contain any of the system s own IP addresses. This may mean you need to break the virtual IP into multiple virtual IPs. See Configuring a range for a virtual IP with forward proxy for more detail and an example. The system handles routed virtual IPs. Even if you set a large range of IP addresses for a virtual IP, the system only sends an ARP reply if an IP address in the range is configured on an interface. However, the system will accept traffic for any IP address in the range. Command Mode configure 10 Chapter 2. CLI Reference
Syntax Create or modify a virtual IP for load balancing virtual-ip <name> IPv4 or IPv6 address of interface for client access virtual-ip <name> ip <addr> <port> Set the base that the virtual IP will inherit from virtual-ip <name> ip <addr> <port> base <basename> Set a range of IPv4 or IPv6 addresses for client access [no] virtual-ip <name> ip range <startaddr> <endaddr> <port> Set a range of IPv4 or IPv6 addresses for client access and set the base that the virtual IP will inherit from [no] virtual-ip <name> ip range <startaddr> <endaddr> <port> base <base_name> Create or modify a virtual IP base for virtual IPs to inherit virtual-ip base <name> Create or modify a virtual IP base for virtual IPs to inherit no base Configure version of LR to reload Parameter Type Description addr IPAddr IPv4 or IPv6 address for interface configured for client access basename Word Name of base that the virtual IP will inherit from endaddr IPv4Addr Ending IPv4 or IPv6 address for interface configured for client access name Word Name of the virtual IP port Integer Port number to connect to on the real server startaddr IPv4Addr Starting IPv4 or IPv6 address for interface configured for client access Related Commands 1. REST API Reference - virtualip admin-status Bring an object, such as a health monitor, real server, or virtual IP, online or offline. After you create an object, you must bring it online. Use You typically set the offline status only when you want to disable the object or block connections to the web server during maintenance or system reconfiguration. 2.2. Contents 11
Default Setting offline 12 Chapter 2. CLI Reference
CHAPTER 3 About This Guide blah 13
14 Chapter 3. About This Guide
CHAPTER 4 LR Manager Guide 4.1 Overview 4.2 About the Examples 4.3 Contents 15
16 Chapter 4. LR Manager Guide
CHAPTER 5 Indices and tables genindex modindex search 17