Professional Documents
Culture Documents
WANScaler Client System Guide 070907
WANScaler Client System Guide 070907
Release 4.2 Contains complete documentation for the WANScaler Client and WANScaler Controller. For the WANScaler Appliance, you also need the WANScaler Appliance Installation and Users Guide, release 4.2.
Copyright 2007 by Citrix Systems, Inc. All rights reserved. Citrix, Citrix Systems, WANScaler, Orbital Data, TotalTransport, AutoOptimizer Engine, and Adaptive Rate Control are trademarks of Citrix Systems, Inc. Citrix Systems assumes no responsibility for errors in this document, and retains the right to make changes at any time, without notice.
Portions licensed under the Apache License, Version 2.0 http://www.apache.org/licenses/LICENSE-2.0. Portions licensed under the Gnu Public License, http://www.gnu.org/copyleft/gpl.html, including xmlrpc++, glibc, rpm-libs, beecrypt. Portions licensed under the Gnu Public License with product-specific clauses, including the Linux kernel (http://www.kernel.org/pub/linux/kernel/COPYING), libstdc++, and libgcc. Portions are free software with vendor-specific licensing, including zlib (http://www.gzip.org/zlib/zlib_license.html), net-snmp (http://www.netsnmp.org/about/license.html), openssl (http://www.openssl.org/source/license.html), krb5libs (http://web.mit.edu/kerberos/krb5-1.3/krb5-1.3.6/doc/krb5-install.html), tcp_wrappers (ftp://ftp.porcupine.org/pub/security/tcp_wrappers_license), bzip2-libs (http://sources.redhat.com/bzip2/), popt (http://directory.fsf.org/libs/COPYING.DOC). Elfutils-libelf is licensed under the OSL 1.0 license, http://www.opensource.org. JPGraph licensed under the terms given in http://www.aditus.nu/jpgraph/proversion.php LZS licensed from Hifn corporation, http://www.hifn.com. Iperf licensed under the terms given in http://dast.nlanr.net/Projects/Iperf/ui_license.html. This product includes PHP, freely available from http://www.php.net/. DNE is licensed from Deterministic Networks, http://www.deterministicnetworks.com
CTX112194
Contents
1. Introduction.....................................................................................5 1.1. Who Should Read This Guide ........................................................5 1.2. About the WANScaler Client Solution .............................................5
1.2.1. 1.2.2. 1.2.3. 1.2.4. 1.2.5.
Acceleration Features....................................................................... 6 Supported Clients ............................................................................ 6 Basic Operation............................................................................... 7 Detailed Description of Redirector Mode.............................................. 8 Detailed Description of AG-Inline Mode ..............................................10
2.1.1. Appliances are Used For Local Connections.........................................13 2.1.2. Windows Ethernet Bridging is Not Supported on Client Systems ............13 2.1.3. Many SSL-Based VPNs Will Not Work.................................................13 2.2.1. 2.2.2. 2.2.3. 2.2.4. Put the WANScaler Appliances in a Secure Part of your Network ............13 Port Usage ....................................................................................13 TCP Option Usage and Firewalls ........................................................14 Compatibility Issue with Pre-Release-4.x Appliances ............................14
3. Installation .................................................................................... 20 3.1. Product Contents ...................................................................... 20 3.2. Initial Planning ......................................................................... 20
3.2.1. Appliance Deployment is Critical .......................................................20 3.2.2. Controller Placement is Important.....................................................20 3.2.3. Client Deployment is Easy ...............................................................20
Appliance Pre-Installation........................................................... 21 Controller Pre-Installation .......................................................... 21 Appliance Installation ................................................................ 21 Controller Installation ................................................................ 22
Install the WANScaler Controller Into the Rack ...................................22 Install Ethernet Cables ....................................................................23 Perform Initial Configuration Via the Front Panel .................................23 WANScaler Controller Browser-Based Configuration.............................24 Security: Change the Admin Password...............................................26 Define Accelerated Subnets .............................................................26 Customizing the WANScaler Client Software .......................................28 Downloading..................................................................................28 Installation Troubleshooting .............................................................30 Running the Client For the First Time ................................................31
3.8. Testing the Installation .............................................................. 32 3.9. Troubleshooting Appliances ........................................................ 33 3.10. Troubleshooting Clients ............................................................ 33 3.11. Troubleshooting WANScaler Controllers ...................................... 34
3.9.1. Cabling and Duplexing Problems .......................................................33 3.9.2. Transfers are Not Accelerated ..........................................................33
4. WANScaler Appliance Command Reference......................................... 35 5. WANScaler Client Command Reference .............................................. 35 5.1. Configuration Tab ..................................................................... 35 5.2. Performance Tab....................................................................... 37 5.3. Diagnostics Tab ........................................................................ 38 5.4. Uninstalling the WANScaler Client................................................ 39 5.5. Updating the WANScaler Client ................................................... 39 6. WANScaler Controller Command Reference ........................................ 40 6.1. Dashboard ............................................................................... 40 6.2. Getting Started......................................................................... 41 6.3. Appliances ............................................................................... 42 6.4. Clients..................................................................................... 43 6.5. Client Rules.............................................................................. 44 6.6. Alerts ...................................................................................... 46 6.7. System Settings ....................................................................... 47 6.8. Export/Import/Factory Defaults................................................... 48 6.9. Client Diagnostic Settings........................................................... 48 6.10. HTTPS Configuration ................................................................ 49 6.11. Update Software ..................................................................... 50 6.12. User Setup ............................................................................. 50 6.13. License .................................................................................. 51 6.14. My Profile............................................................................... 52 6.15. Help ...................................................................................... 53 6.16. Logout ................................................................................... 53 7. Specifications................................................................................. 54
1. Introduction
1.1. Who Should Read This Guide
This document tells you how to deploy and administer the WANScaler Client product. It assumes that you are a network administrator with prior experience in installing rack-mount equipment, IP networking, Ethernet networking, and PC software.
Figure 1. WANScaler allows accelerated communications from clients anywhere in the world.
WANScaler_Client_System_Guide_070907.doc
WANScaler accelerates communication between clients and servers: On the client side, the WANScaler Client is a software-based network accelerator that runs on end-users computers. On the server side, the WANScaler Appliance is a rack-mount unit that accelerates the traffic from any number of servers. The WANScaler 8300 Series, 8500 Series, and 8800 Series currently support WANScaler Client deployments.
A second rack-mount unit, the WANScaler Controller, provides secure, centralized management for the entire WANScaler installation. It can exist anywhere on the network.
These optimizations build upon one another. For example, CIFS transfers undergo not only CIFS acceleration, but transport acceleration and disk-based compression as well.
WANScaler_Client_System_Guide_070907.doc
WANScaler_Client_System_Guide_070907.doc
Redirector Mode vs. AG-Inline Mode. There are two variations on the way connections are handled by the Client and Appliance: redirector mode and AG-Inline mode. Redirector mode is always used unless the Appliance is accessed via a Citrix Access Gateway VPN. Redirector mode uses an explicit proxy. The Client readdresses outgoing packets to the Appliances redirector IP address. The Appliance in turn re-addresses the packets to the server, while changing the return address to point to itself rather than the Client. In this mode, the Appliance does not have to be physically inline with the path between the WAN interface and the server (though this is the recommended deployment mode). AG-Inline mode is always used when the Appliance is accessed via a Citrix Access Gateway VPN. Currently supported Access Gateway devices are the Access Gateway Standard Edition, release 4.5.6 and later, and the Access Gateway Advanced Edition, release 4.5 Hotfix 1 and later. AG-Inline mode does not alter addresses at all. The Appliance must be inline with the path between the WAN interface and the server. In AG-inline mode, the Appliance is a transparent, intercepting proxy.
Redirector mode behaves somewhat differently from appliance-to-appliance mode. Appliance-to-appliance mode is an auto-discovering mode that does not use the WANScaler controller or address rewriting. However, a WANScaler appliance can use both methods at once: redirector mode to talk to clients, and appliance-to-appliance mode otherwise.
WANScaler_Client_System_Guide_070907.doc
The user's application opens a TCP connection to the server, sending a TCP SYN packet. Src: 10.0.0.50, Dst: 10.200.0.10
The WANScaler Client looks up the dst address and decides to redirect the connection to the appliance at 10.200.0.201. Src: 10.0.0.50, Dst: 10.200.0.201 (10.200.0.10 is preserved in a TCP option field. Options 24-31 are used for various parameters.)
Server 10.200.0.10
3 4 5 6
The appliance accepts the connection and forwards the packet to the server (using the dst address from the TCP options field), and giving itself as the src. Src: 10.200.0.201, Dst: 10.200.0.10
The server accepts the connection and responds with a TCP SYN-ACK packet. Src: 10.200.0.10, Dst: 10.200.0.201
The appliance rewrites the addresses and forwards the packet to the Client (placing the server address in an option field). Src: 10.200.0.201, Dst: 10.0.0.50
6 The connection is now fully open. The Client and server send
packets back and forth via the appliance. While the addresses are altered in Redirector mode, the port numbers are not, nor is the data encapsulated. Redirector mode is a proxy, not a tunnel. There is no 1:1 relationship between packets (though in the end, the data received is always identical to the data sent). Compression may reduce many input packets into a single output packet. CIFS acceleration will perform speculative read-ahead and write-behind operations. Also, if packets are dropped between appliance and Client, the retransmission is handled by the appliance, not the server, using advanced recovery algorithms.
Figure 3. WANScaler packet flow, showing the address changes used by Redirector mode proxying.
WANScaler_Client_System_Guide_070907.doc
Figure 4. Redirector-mode acceleration takes place between the Client and the appliance closest to the server, ignoring other appliances encountered along the way. The target appliance is selected by the client rules downloaded from the WANScaler Controller.
10
WANScaler_Client_System_Guide_070907.doc
erated over the VPN link, though they may be benefit from site-to-site acceleration, as shown in Figure 1.
Figure 5. Unlike redirector mode, the Client in AG-Inline mode can accelerate only traffic that terminates at the AG-equipped site.
11
WANScaler_Client_System_Guide_070907.doc
Figure 6. WANScaler packet flow, showing the address changes used by Redirector mode proxying.
12
WANScaler_Client_System_Guide_070907.doc
2. Deployment
2.1. Limitations of This Release
2.1.1. Appliances are Used For Local Connections
If the WANScaler Client is on the same LAN as the server, it would be faster if it went direct instead of using the WANScaler appliance. In this release, this case is not detected. Workaround. Disable the WANScaler Client when you bring your PC to an appliance-equipped site.
13
WANScaler_Client_System_Guide_070907.doc
If necessary, it can be configured to any value. However, all appliances and clients must also be configured to use this new port. Ports used for communication with WANScaler Clients. A signaling port is used for signaling connections between the Client and the appliance. By default, this is port 2312. However, this port is blocked by many firewalls. We recommend that you change the setting to port 443 (https), which is allowed through most firewalls. Note: If you use port 443 for the signaling connection, you cant use port HTTPS on port 443 to manage the appliance. The appliance defaults to HTTP management on port 80. If you wish to use HTTPS to manage the appliance, you must use a port other than 443 (such as 9000). Ports used for communication with servers. Communication between the WANScaler Clients and the WANScaler appliances uses the original ports. That is, when a client opens an HTTP connection on port 80, it connects to the appliance on port 80. The appliance in turn contacts the server on port 80. The appliance assumes that it will be able to communicate with the server on any port requested by the client, and the client assumes that it can communicate with the appliance on any desired port. Exceptions to this rule can be created in the WANScaler Controller, but this is usually not necessary if the appliance is installed so that it is subject to the same firewall rules as the servers. When this is done, any connection that would succeed in a direct connection will succeed in an accelerated connection.
14
WANScaler_Client_System_Guide_070907.doc
VPN hardware must be deployed in a way that allows the WANScaler appliance to do its job. In general, this means that the WANScaler appliance should be cabled directly to the LAN-side Ethernet port of the VPN unit. If the VPN unit has only one Ethernet port, the WANScaler appliance should be cabled directly to this, ensuring that the LAN-side VPN traffic must pass through the WANScaler appliance to reach the datacenters server. See Section 2.3 in the WANScaler Appliance Installation and Users Guide, release 4.2.
15
WANScaler_Client_System_Guide_070907.doc
Servers
16
WANScaler_Client_System_Guide_070907.doc
17
WANScaler_Client_System_Guide_070907.doc
On the Tables menu, click Property. This page will list all the editable properties of the .MSI file. We are only interested in a few: Parameter OMSHOST OMSPORT DBCMINSIZE Description WANScaler Controller IP Address WANScaler Controller Port Minimum amount of disk space to use for compression, in megabytes Default None 443 250 Comments Enter the IP address of your WANScaler Controller here. Change to another port if absolutely necessary. Changing this to a larger value (for example, 2000) will improve compression performance, but will prevent installation if there is not enough disk space. The Client will not install unless there is at least DBCMINSIZE + 100 MB of free disk space.
To edit a parameter, double-click on its value, type the new value, and press Enter. When done, use the File -> Save As.. command to save your edited file with a new filename; for example, test.msi.
18
WANScaler_Client_System_Guide_070907.doc
Note: Some users have seen a bug in orca that causes it to truncate files to 1 MB. Check the size of the saved file. If it has been truncated, make a copy of the original file and use the Save command to overwrite the original. Your Client software has now been customized.
19
WANScaler_Client_System_Guide_070907.doc
3. Installation
The procedures in this section will get your units up and running.
The initial installation stages for the WANScaler Controller and WANScaler appliance are almost identical. Follow steps 0-15 for each unit in your installation. The installation procedures for the two unit types diverge once the Web-based management interface is started. Find the instructions for the type of unit you are installing (appliance or WANScaler Controller) after steps 0-15.
20
WANScaler_Client_System_Guide_070907.doc
4. 5. 6.
21
WANScaler_Client_System_Guide_070907.doc
WANScaler Controller
Power
22
WANScaler_Client_System_Guide_070907.doc
LAN
Install the Ethernet cable. The WANScaler Controller uses motherboard port 1, a 1000/100/10 mbps Ethernet port. Because the port auto-senses the Ethernet port and cable type that it is attached to, you can use any appropriate high-quality cable to connect the Controller to your switch. Use the provided blue straight-through cable if convenient.
Version
3b
Host Name
3c.
localhost.local VLAN ID
3d.
Pressing the down button displays the hostname. This cannot be set from the front panel. Skip the VLAN section by pressing the down button again. Pressing the down button again displays the IP address.
0.0.0.0
23
WANScaler_Client_System_Guide_070907.doc
IP Address
3f.
3g.
Netmask
3h.
255.255.255.255
Pressing the middle button allows you to edit the IP address. The left and right buttons move the cursor. The up and down buttons increment and decrement the IP address. Pressing the middle button saves the address. Finally, press the center button to submit the IP address and press it again to verify that you wish to keep it. Pressing the down button once more displays the netmask. Press the middle button to edit the netmask. The up and down buttons will cycle the netmask through the allowed values. Pressing the down button displays the gateway address. Edit as with the IP address. The Controller communicates with the Appliances on Port 443 by default, but you can change this if absolutely necessary. Pressing the down button displays the restart screen. Changes do not take effect until you restart. Press the middle button to restart. If you do not restart, pressing the down button will show a scrolling marquee giving the release and build numbers of the software.
Gateway
3i.
0.0.0.0
Service Port
3j.
443 Restart?
3k.
System Version
24
WANScaler_Client_System_Guide_070907.doc
5.
Once logged in, you will see the main page. Check to make sure that there is a non-zero number on the Appliances Connected line, as shown in Figure 13. If not, there is a connectivity problem.
25
WANScaler_Client_System_Guide_070907.doc
26
WANScaler_Client_System_Guide_070907.doc
Client Detection. When a client connects to the WANScaler Controller (which it will do automatically), it downloads the rules. The status of each client is tracked by the WANScaler controller. The clients are tracked by name, using the same network name they announce to the Windows network. What to Accelerate. Acceleration is most effective when the appliance is close to the server. Acceleration can be harmful if the client forwards traffic to an appliance that is distant from the server, especially if this triangle route introduces a slow or unreliable link. Thus, we recommend that Client rules be configured to to allow a given appliance to accelerate its own site only. This task is performed on the Client Rules page. Rules are evaluated in order, and the action (Accelerate or Exclude) from the first matching rule is taken. For a connection to be accelerated, it must match an Accelerate rule. Otherwise, the connection is made directly with the target server.
Figure 14. Editing the client group. This is where client-appliance-server mapping is performed.
3.
On the Client Rules page, Double-check that Softboost is selected. On the Accelerated Subnets/IP Addresses section: Add an Accelerated rule for each subnet connected to each active appliance. That is, you will specify Accelerate, type in the subnet identifier, and select the appliance that the subnet is attached to. (Note: Only appliances that have successfully connected to the WANScaler Controller will be listed. If your appliance is not listed, you must fix its connectivity problem before continuing.) Repeat for each subnet that is local to a given appliance. Repeat for all appliances.
27
WANScaler_Client_System_Guide_070907.doc
If you wish to use acceleration only for a single port (not recommended), such as port 80 for HTTP, replace the wildcard in the Ports field with this value. To support more than one port, add additional rules, one per port. If you wish to exclude some portion of the included range, add an Exclude rule and move it above the more general rule. For example, if acceleration is not desired on port 80 on 69.59.212.89, add an exclusion in this table. In general, narrow rules (usually exceptions) should be listed first, then general rules. Press the Save link. Changes will not be saved if you navigate away from this page without saving. The default action is to not accelerate; only addresses/ports that match an Accelerated rule (before matching an Excluded rule) are accelerated.
3.7.2. Downloading
1. 2. 3. Obtain the WANScaler Client software (a file in the form of WANScaler*.msi) from your WANScaler representative. Copy the file to the client system by some convenient means (shared filesystem, FTP server, Web download, etc.) The WANScaler*.msi file is an installation file. Close all applications and open windows, then launch the installer it in the usual way (double-click on it in a file window, or use the Run command).
28
WANScaler_Client_System_Guide_070907.doc
4.
The installation program will ask you where to install the software. This directory will be used for both the client software and the disk-based compression history. Together, they require a minimum of 350 MB of disk space.
29
WANScaler_Client_System_Guide_070907.doc
5.
Once the installer finishes, you must restart the system. After restarting, the WANScaler Client will start automatically.
30
WANScaler_Client_System_Guide_070907.doc
7.
Press the Configuration tab. Set the following parameters: Enter the WANScaler Controllers IP address in the Host field in the WANScaler Management System field. (If your software distribution has been customized to pre-populate this field, you can skip this step.)
31
WANScaler_Client_System_Guide_070907.doc
Select an amount of disk space to use for compression, via the Disk Usage: Used by Compression pull-down menu. More is better. 10 GB is not too much, if you have this much disk space available. Press the Save button. 8. The WANScaler accelerator is now running. All traffic to accelerated subnets will now be accelerated, except for CIFS (windows filesystem) connections, which must be killed and restarted before acceleration will take place. To do this reliably, the system must be rebooted.
10. 11.
12.
Send the file a second time. This should yield a compression ratio of at least 100:1, unless the file is large enough to overflow the clients compression history (which was set in Step 7).
32
WANScaler_Client_System_Guide_070907.doc
The Performance page shows the cumulative compression ratio since the WANScaler Client was started. An estimate of the compression benefit can also be made from the throughput graph (where throughput can greatly exceed the link speed, even when the client must share the link with other traffic), or with stopwatch tests. 13. If you succeed at achieving accelerated connections, your installation is up and running! No additional configuration is necessary.
Start by verifying that you can connect to the local WANScaler appliance at its management IP address (using pings or browsing to the Management interface). In inline mode, verify that you can connect through the WANScaler appliance to outside systems.
33
WANScaler_Client_System_Guide_070907.doc
A failure of acceleration (with no accelerated connections listed in the Diagnostics tab usually indicates that something is preventing communication with the Appliance or Controller. Check the Alerts listing on the Client, Appliance, or Controller (whichever is most convenient). Typical causes of connection failures are: The Appliance is not running, or acceleration has been disabled. The Controller is not running or has not been configured. A firewall is stripping WANScaler TCP options at some point between the Client and Appliance (see the WANScaler Installation and Users Guide, Section 3.6). The Client is using an unsupported VPN.
34
WANScaler_Client_System_Guide_070907.doc
35
WANScaler_Client_System_Guide_070907.doc
The Configuration page contains the user-settable commands. These consist of: WANScaler Controller (Must be set): The Host field specifies the IP address of the WANScaler Controller. The Port field specifies the port to use, usually port 443. These values must match those set on the Controller itself. Disk Usage: Allows the user to select the amount of disk space used by compression. More is better. 10 GB is not too much. Acceleration/Flow-Control Mode: Not user-configurable. Reports the mode selected on the Appliance. Choices are hardboost and softboost. Softboost is recommended for use with WANScaler. (Hardboost is an appliance-to-appliance mode.) Client Bandwidth Limits: Not user-configurable in softboost, which is the only supported mode. Acceleration Rules: Gives an abbreviated list of the acceleration rules downloaded from the Controller. The target subnet is shown in the Network column. The Appliance doing the acceleration is listed in the Appliance IP column, along with the Acceleration rules are listed as Accelerated if the Client is connected to the Appliance. Exclusion rules (subnets or ports for which acceleration is explicitly denied) are shown as N/A and Excluded. Save: If changes are made, they do not take effect until the Save button is pressed. Saved changes are persistent across reboots. Enable WANScaler Client: Enables the WANScaler service, if it is stopped. The enabling process takes several seconds, but no connections are broken. The enable/disable choice is persistent across system restarts. Disable WANScaler: The reverse case from the Enable WANScaler button. Accelerated connections will be reset. Status Line: The status line at the bottom of the page gives the current operational status and the revision number of the Client.
36
WANScaler_Client_System_Guide_070907.doc
The Performance page gives the current performance of accelerated connections, as seen by the application. Accelerated/Non-Accelerated Application Throughput. This is a secondby-second performance graph, giving the data delivered to or received from applications in any given second. Accelerated traffic is in blue; non-accelerated traffic is in red. Non-accelerated traffic consists of all traffic that does not match the acceleration rules. Internal buffering by either the application or the WANScaler Client can make this data appear spikier than what is sent over the WAN itself. Compression allows this throughput to exceed the link speed. Bytes Before Compression. This is the amount of data accepted from applications or delivered to them, counting only accelerated connections.
37
WANScaler_Client_System_Guide_070907.doc
Bytes After Compression. This is the amount of data actually send over the WAN link, counting only accelerated connections. Bytes Non-Accelerated. This is the amount of other data send and received, counting both WAN and LAN connections. Compression Ratio. This is the ratio of bytes before compression divided by bytes after compression. This is a cumulative measurement of the compression results since the last system reboot (or the last time the WANScaler server process was started). It is dependent on the amount of repetition seen in the accelerated data. Individual connections vary between 1:1 and 10,000:1 compression.
38
WANScaler_Client_System_Guide_070907.doc
Accelerated Connections: The number of open connections between the WANScaler Client and WANScaler appliances. Non-Accelerated Connections: Open connections that are not being accelerated. Accelerated CIFS Connections: The number of open, accelerated connections with CIFS (Windows filesystem) servers. This is usually the same as the number of mounted network filesystems. Client Name: The name of this client system as seen by the WANScaler Controller. Connection Status: If the client is connected to the WANScaler Controller, this will say Connected. Otherwise, it will say Disconnected. If the client has a WANScaler Controller defined on the Configuration page, it will attempt to stay connected to the WANScaler Controller continuously. However, it will continue to run and accelerate connections in the face of an intermittent connection, so long as it has been able to connect at least once within the last three days.
Start Tracing/Stop Tracing. Your WANScaler representative may ask you to make a connection trace to help pinpoint problems. This button starts and stops the trace. When you stop tracing, a window pops up showing the trace files. These should be sent to your WANScaler representative by the means they recommend.
39
WANScaler_Client_System_Guide_070907.doc
6.1. Dashboard
This is the WANScaler Controller's main page. It gives a top-level view of your WANScaler network, especially the error/warning status ("Alerts"), the number of units connected, and licensing information. Active Alerts. This displays a bar graph of error and warning messages from all the clients and appliances in your WANScaler network. Clicking the graph will take you to the Alerts page. Appliances Connected. Gives the number of appliances currently connected. Each appliance attempts to maintain a continuous connection with the WANScaler Controller. Clicking either link will take you to the Appliances page. WANScaler Clients Connected. Gives the number of WANScaler Clients currently connected. Each client attempts to maintain a continuous connection with the WANScaler Controller, though this may be interrupted due to system shutdown, power management, moving out of wireless range, loss of VPN connectivity, and other events. Clicking either link will take you to the Clients page. WANScaler Controller Version. Identifies the release and build number of the WANScaler Controller. This is useful if you need to contact Support.
40
WANScaler_Client_System_Guide_070907.doc
Displays the "Getting Started" overview of the WANScaler system, which hopefully will not tell you anything that you dont already know by the time you have gotten so far in this manual.
41
WANScaler_Client_System_Guide_070907.doc
6.3. Appliances
The Appliances page lists all the active appliances, gives their status, and provides links to additional information. Name. Gives the name of the appliance. By default, this is the appliance's IP address, but you can edit the field to any name you like. Version. Identifies the release and build number of the WANScaler Appliance. This is useful if you need to contact Support. Connected IP. The IP address of the appliance, as seen by the WANScaler Controller. Network address translation may cause this address to differ from the address as seen by the appliance. Status. Shows a green link if the appliance is connected, a gray link if it is not, and a red link if it requires attention. The link takes you to the Appliance Details page. Redirector Address: Port. This is IP address that the Client uses to connect to the Appliance. The port number is used for the control connection, used by the Client to exchange status information with the Appliance. These values are defined on the WANScaler Client page on the Appliance. Redirector Alias. An additional address that maps to the Appliances Redirector IP. Useful if the network address translation requires that a different address be used depending on which side of a firewall a connection is coming from. When trying to connect to the Appliance, the Client will try the Redirector Address first, then the Alias. Save. If you make changes to appliance configuration, you must press the "Save" link, or your changes will be lost. Delete. Appliances are detected automatically, so the "Delete" link has little effect unless an appliance has been removed permanently. Otherwise, it will soon reappear on the list.
42
WANScaler_Client_System_Guide_070907.doc
6.3.1.1. Appliance Details This page gives additional details for the selected appliance. The Alerts value is also a link that will display any active Alerts for the selected Appliance. The Launch Appliance Console link will navigate to the UI of the Appliance.
6.4. Clients
43
WANScaler_Client_System_Guide_070907.doc
The Clients page is similar to the Appliances page. It lists all known clients and summarizes the properties of each. OS. An icon indicating the operating system of the client. Name. The client's name. This defaults to the name defined on the client system itself, but the field can be edited to any value. Version. The release and build number of the WANScaler Client software. Hostname. The hostname as reported by the client. Connected IP. The IP of the client as seen by the Controller. Status. Enabled if there is an open connection between the Client and Controller; Disconnected otherwise. Save. If you have changed the clients name, this will save it. Delete. Removes the client from the list. The client will be added back to the list if it ever reconnects. Delete Disconnected. This will remove all disconnected clients from the list. They will be added back to the list if they ever reconnect.
The Client Rules page maps subnets or ports to Appliances. Select Hardboost or Softboost: This should always be set to softboost.
44
WANScaler_Client_System_Guide_070907.doc
Rule Type. Rules specify one of two actions: Accelerate or Exclude (do not accelerate). Rules are evaluated in order, and the action specified by the first matching rule is used. Subnet. This entry specifies the subnet covered by the rule. This takes the conventional IP address/netmask format, where the IP address is a dotted quad and the netmask specifies the number of bits in the network portion of the address, such as 10.0.0.0/8 for the Class A network at 10.0.0.0. Ports. Either * or a single port number. Appliance. A pull-down menu listing all known appliances. Add, Insert, Delete, Up, Down. These controls allow you to move, add, or remove rules. The column of radio buttons allows you to select the navigation point. Save. Changes are not stored until you press the "Save" link.
Best Practices: For proper operation, the rules should be defined as follows: For each appliance, add a rule for every subnet on the same LAN as the appliance. For example, an appliance at "172.16.0.102" may be LAN-connected to subnets "172.16.0.0/24" and "172.17.0.0/24". Add a rule for each. Sometimes an appliance accelerates only a single IP address, or a small number of addresses. Enter each of these addresses as well. For example, an appliance that accelerates a single IP address at 69.59.212.183 would have a rule for 69.59.212.183 or 69.59.212.183/32 the two are equivalent. Leave the "Port #" field set to "*".
45
WANScaler_Client_System_Guide_070907.doc
6.6. Alerts
The Alerts page shows all of the current warning or error messages. Some transient alerts time out after the condition (such as high packet loss) has been absent for an hour. Others are persistent until cleared. By unchecking the "Show active alerts only" box, expired alerts can be seen. Most alerts require no administrative action and are for informational purposes only.
46
WANScaler_Client_System_Guide_070907.doc
The Settings page shows a list of system settings: Standard Network Settings: hostname, IP address, netmask, gateway, DNS servers, NTP server, timezone, date/time Service Port: the port used to communicate with WANScaler Clients and appliances. Must be changed on every WANScaler unit in your network if you do not wish to use the default (Port 443). SSL Certificate Lifetime: The WANScaler Controller issues SSL certificates to the appliances and clients it knows about. These certificates expire eventually (and are auto-renewed upon expiration). The lifetime is set here. Allow Only HTTPS Access. By default, the WANScaler Controller can be accessed either by HTTP HTTPS. By checking this box, only HTTPS access is allowed.
47
WANScaler_Client_System_Guide_070907.doc
To save the WANScaler Controller's configuration to a file, press the "export" link. To restore the WANScaler Controller's configuration from a file, press the "import" link. To reset the WANScaler Controller to its factory settings, press the reset link. This will reset the configuration and restore the factory-default admin password.
This page allows core files and other diagnostic material to be uploaded automatically from clients to a specified ftp repository, and a notification to be sent by email that this has happened. To use this feature, enter the hostname or IP address of the FTP server, the port (usually 20), login information, and subdirectory. To receive email on FTP upload attempts, enter a valid email address in the "Diagnostic email" field.
48
WANScaler_Client_System_Guide_070907.doc
Select the "Are client pop up windows allowed?" box if error messages are to be shown to end users. Select the "Automatically upload?" box if client core files are to be uploaded automatically on failures. Press the "Save" link to commit your changes.
This page allows you to add your own HTTPS certificates and private keys to the WANScaler Controller. The controller comes with default certificates and keys, but those provided by your own certificate system (if you have one) are preferred. To use, paste the new certificate or key text into the box provided, and press the "Import" link.
49
WANScaler_Client_System_Guide_070907.doc
This page allows you to update the WANScaler Controller with the latest version of software. When executed, this feature will cause the new version of the software to be downloaded to the WANScaler Controller server and installed. Subsequently, all logged in users will be disconnected. To use, the new version of the WANScaler Controller software must first be obtained from Citrix and downloaded onto your local computer (where you are running your browser). The software will be released in a zipped controller setup file (will end in .gz). Either type the full path to the controller setup file on the local computer or use the browse button to select the file. Press the "Update" link to cause the software to be downloaded and installed. You will be prompted to ensure that this is correct. Click "OK".
This page allows you to add new users to the WANScaler Controller. (To edit your own profile, use the My Profile page instead.) For the benefit of end-users of the WANScaler Client, enter your name, email address, and phone numbers into the fields provided. Additional users can be defined if desired. There are two classes of user: Read-only and Read-write. Only read-write users can make changes to the controller.
50
WANScaler_Client_System_Guide_070907.doc
6.13. License
This page allows you to enter a new license key. Paste the license data into the box and press Import. If there is no valid license, the Missing License message will be displayed, as shown above.
51
WANScaler_Client_System_Guide_070907.doc
6.14. My Profile
This page allows you to modify your contact information or change your password. For the benefit of end-users of the WANScaler Client, enter your name, email address, and phone numbers into the fields provided. This is particularly important for the Admin account.
52
WANScaler_Client_System_Guide_070907.doc
6.15. Help
6.16. Logout
53
WANScaler_Client_System_Guide_070907.doc
7. Specifications
Physical Height Width Depth Weight Power Supply Wattage Voltage Temperature Operating Temperature Storage Temperature 50F to 95F (10C to 35C) 40F to 149F (40C to 65C) 280 100240 VAC, 5060 Hz WANScaler Controller 1.68 in. (4.2 cm) 16.7 in. (42.5 cm) 23.1 in. (58.6 cm) 27 lb (12.27 kg) max.
54
WANScaler_Client_System_Guide_070907.doc