Product Documentation

NetScaler Gateway Plug-in Upgrade Control

Sep 16, 2015

Overview

System Administrators control how the NetScaler plug-in performs when its version does not match the NetScaler Gateway revision. The new options control the plug-in upgrade behavior for Mac, Windows or Linux operating systems.

There are two places where the upgrade option is set in the NetScaler user interface:

  • At the Global Settings
  • At the Session Profile level

For each client type, NetScaler Gateway allows the following three options to control plug-in upgrade behavior:

a.     Always

The plug-in always gets upgraded whenever there is a mismatch between the end user plug-in version and the NetScaler build version. This is the default behavior. Choose this option if you don’t want multiple plug-in versions running in your enterprise.

b.     Essential (and security)

The plug-in gets upgraded only when necessary. The decision to upgrade is based on a predefined version compatibility list on the NetScaler appliance and a similar list on the plug-in.
The compatibility list changes when a security vulnerability is discovered in a build. Therefore, you will not miss any security updates with this option. 

c.     Never

The plug-in does not get upgraded.

CLI Parameters for Controlling VPN Plug-in Upgrade

NetScaler Gateway supports two types of plugins (EPA and VPN) for Windows, Mac, and Linux operating systems. To support plug-in upgrade control at the session level, NetScaler Gateway supports three session profile parameters named WindowsinPluginUpgrade, MacPluginUpgrade and LinuxPluginUpgrade.

These parameters are available at global, virtual server, group, and user level.  Each parameter can have a value of Always, Essential or Never.

For each OS plug-in, these values affect the upgrade process as follows:

1.     Always:

The plug-in gets auto-upgraded if there is a version mismatch

2.     Essential:

The plug-in gets upgraded only when it is essential. If the given upgrade is essential or not will be         determined using “compatibleFrom” and “compatibleTill” attributes. See Attribute Descriptions for more information.

3.     Never:

The plug-in never gets upgraded.

CLI Parameters for Controlling EPA Plug-in Upgrade

NetScaler Gateway supports EPA plug-ins for Windows, Mac, and Linux operating systems. To support plug-in upgrade control at the session level, NetScaler Gateway supports three session profile parameters named WindowsEPAPluginUpgrade, MacEPAPluginUpgrade and LinuxEPA PluginUpgrade.

The parameter is available at the virtual server level.  The parameter value can be Always, Essential or Never.

For each OS plug-in, these values affect the upgrade process as follows:

1. Always:
The plug-in gets auto-upgraded if there is a version mismatch.

2. Essential:
The plug-in gets upgraded only when it is essential. If the given upgrade is essential or not will be determine using “compatibleFrom” and “compatibleTill” attributes. See Attribute Descriptions for more information.

3. Never:
The plug-in never gets upgraded.

Attribute Descriptions

Attribute Name Description

Name      type

Name of the plug-in. It is unique for each plug-in binary and has the following format:
OS type + hyphen (-) + Plugin type.

In the case of multiple plug-ins for the same OS:
OS type + hyphen + Plugin type + space + some identifier. Only characters before spaces are used for plug-in matching.

Example: Win-EPA, Mac-VPN, Ubuntu-VPN old Kernel, Ubuntu-VPN latest Kernel

The first word identifies the type of plug-in.
For example, win-EPA, Mac-VPN, Ubuntu-VPN.

Version

The plug-in binary version.

Path

The file path for downloading the plug-in that indicates the relative path from the NETSCALER GATEWAY FQDN. The plug-in downloads from following URL NETSCALER GATEWAY FQDN + this path attribute.

CompatibleFrom

The lowest version number in the range of plug-in versions compatible with the current NetScaler software version.
If the upgrade type is set to essential, any plug-in with a version number lower than this value gets upgraded.

CompatibleTill

The highest version number in the range of plug-in versions compatible with the current NetScaler software version.
If the upgrade type is set to essential, any plug-in with a version number higher than this value gets downgraded.
Typically, no value is specified, so a plug-in never gets downgraded.

UpgradeAction

Policy for applying an upgrade when a version mismatch occurs. Possible values
Always: Upgrade will happen for version mismatches.
Essential: Upgrade will happen for critical upgrades.
Never: Upgrade will never transpire.

VPN Configuration

Follow these steps for the VPN configuration of Windows, Linux and Mac plug-ins.

  1. Go to NetScaler Gateway>Policies>Session.
localized image

     2. Select the desired session policy, and then click Edit.

localized image

     3. Click the + icon.

localized image

    4. Select the Client Experience tab.

localized image

     5. These dialog boxes affect the upgrade behavior. The options available are

• Always
• Essential
• Never

      The default is Always.

localized image

      6.     Select the check box to the right of each option. Select the
             frequency to apply the upgrade behavior.

localized image

EPA Configuration

Follow these steps for the EPA configuration of Windows, Linux and Apple plug-ins.

       1.     Go to NetScaler Gateway > Virtual Servers.

localized image

       2. Select a Server and click the Edit button. 

localized image

      3.     Click the pencil icon.

localized image

      4. Click More

localized image

       5.     The dialog boxes that appear affect the upgrade behavior. The options available are 

  • Always
  • Essential
  • Never
localized image

Plug-in Upgrade Compability List

localized image
Code Kopieren