Citrix

Produktdokumentation



Ganzes Dokument herunterladen

Managing Built-in Tasks

Dec. 18, 2015

Built-in tasks are a set of predefined configuration tasks that you can execute on one or more managed devices. These tasks help you address the most commonly used configuration changes of the discovered devices. Command Center supports built-in tasks for both NetScaler and CloudBridge devices.

You can execute the built-in tasks instantly or schedule them for execution at a later time. You can view the execution log to check the task status and view the list of tasks scheduled for execution. You can also export a built-in task as an XML file. Note that you cannot modify or delete built-in tasks.

Use the following procedures for managing built-in tasks:

Upgrading NetScaler with Built-in Tasks

The built-in upgrade tasks that you can execute on NetScaler devices are:

  • SoftwareUpgrade-9.xto10.x: Upgrade one or more devices from the 9.x release to any version of the 10.x release of NetScaler.
  • SoftwareUpgrade-Within10.x: Upgrade one or more devices from the 10.x release to a newer 10.x version.
  • SoftwareUpgrade-Within9.x: Upgrade one or more devices from the 9.0 release to 9.1 or 9.2 releases of NetScaler, or from any version of 9.1 or 9.2 release to a newer version of 9.1 or 9.2. release. To execute this task, you must have the upgrade file present on the Command Center server or your local system, and you must specify the correct image file.
  • SoftwareUpgrade-8.xto9.x: Upgrade one or more devices from the 8.x release to any version of the 9.1 or 9.2 release of NetScaler . You must specify the upgrade file and/or the 9.x license file, and you must have these files present on the Command Center server or your local system. Note that image and license files are not prepackaged with Command Center, and you must copy these files from an appropriate location. When the user input screen prompts you, select the correct image and license files for the upgrade.
  • SoftwareUpgrade-8.xto9.0: Upgrade one or more devices from the 8.x release to any version of the 9.0 release of NetScaler, or from the 9.0 release to a newer version of 9.0.
  • SoftwareUpgrade-Within8.x: Upgrade one or more devices from the 8.0 release to a newer 8.x version. To execute this task, you must have the upgrade file present on the Command Center server or your local system, and you must specify the correct image file.

Configuring NetScaler with Built-in Tasks

The built-in configuration tasks that you can execute on NetScaler devices are:

  • ConfigureCompression Policy: Configure compression policies on NetScaler devices.
  • InstallSSLCert: Upload and install SSL certificates from the Command Center server to the discovered NetScaler devices.
  • ConfigureFilterPolicy: Configure filter policies on NetScaler devices.
  • NSConfigureSyslogServer: Configure syslog server settings on NetScaler devices.

Importing Application Templates with Built-in Tasks

You can import an application template to multiple NetScaler appliances using the Command Center built-in configuration task ImportApplicationTemplate.

Consider that you have an application template with configuration for optimizing traffic for an application. You want to import this template to ten other NetScaler devices that require a similar AppExpert application configuration. You can import the application template to the ten NetScaler devices simultaneously using the ImportApplicationTemplate built-in task.

Note: This feature works only with NetScaler release 9.3 application templates.

Configuring Parameter Values Across NetScaler Devices with Built-In Tasks

Updated: 2015-04-02

You can now configure parameter values across different NetScaler devices by applying a global configuration template and an input file. Specify the parameter names in the global configuration template, specify the parameter values in the input file, and then execute the task on multiple devices.
Note: The task is executed sequentially on all the devices.

The following code is an example for an input file:

<?xml version="1.0" encoding="UTF-8" ?> 
<properties> 
<global> 
    <param name="CC_Trap_Dest" value="100.10.10.1"/> 
    <param name="HostName" value="NS433"/> 
</global> 
<device name="10.102.43.3"> 
    <param name="NSIP" value="10.102.43.3"/> 
    <param name="HostName" value="NS433"/> 
    <param name="LBSERVER1" value="server43http"/> 
</device> 
<device name="10.102.40.20"> 
    <param name="NSIP" value="10.102.40.20"/> 
    <param name="LBSERVER1" value="server20http"/> 
    <param name="CC_Trap_Dest" value="15.3.4.6"/> 
</device> 
<!-- HA PAIR--> 
<device name="10.102.43.154-10.102.43.155"> 
    <param name="NSIP" value="10.102.43.154"/> 
    <param name="HostName" value="NS43HA"/> 
    <param name="LBSERVER1" value="haserver43http"/> 
    <param name="CC_Trap_Dest" value="15.3.4.5"/> 
</device> 
</properties> 

The following code is an example for a command in the template file:

add snmp trap specific <CC_Trap_Dest> -communityName public 
set ns config -IPAddress <NSIP> -netmask 255.255.255.0 
set ns hostName <HostName> 
add lb vserver <LBSERVER1> HTTP
Note: Click the Downloads button on the Command Center server to download the following sample files:
  • Sample NetScaler Global Configuration Template File
  • Sample NetScaler Global Configuration Input File
Points to Note
  • In the template file, a parameter name must be enclosed in angle brackets-< >. Example: <NSIP>, <CC_Trap_Dest>
  • Parameter names specified in template file must be defined in the input file.
  • In the input file:
    • The global parameters must be defined within the global tag.
    • All parameter values for specific devices must be defined within the device tag.
    • If the parameter names and their values are available in both the global tag and device tag, the values in the device tag takes precedence.
    • An HA pair is specified by adding a hyphen. Example: 1.1.1.1-2.2.2.2.

Limitation

In the input file, within the device tag, you can only specify the device IP address and not the hostname of the device.

To execute the built-in task

  1. On the Configuration tab, navigate to Configuration > Built-in Tasks, and in the right-pane, click NetScaler tab.
  2. Select DeployMasterConfig and click Execute.

Upgrading CloudBridge with Built-in Tasks

Updated: 2014-08-12

The built-in upgrade task that you can execute on a CloudBridge device is:

  • Software Upgrade: Use this task to upgrade one or more CloudBridge devices to a newer release of the CloudBridge software by specifying the path to the installation file of the software version to which you want to upgrade.
Note: This task is supported only on CloudBridge VPX, CloudBridge 600, Repeater 8500 and Repeater 8800 appliances.

Configuring CloudBridge with Built-in Tasks

Updated: 2014-10-17

The built-in configuration tasks that you can execute on CloudBridge devices are:

  • EnableCloudBridge: Enable traffic through CloudBridge devices.
  • DisableCloudBridge: Disable traffic through CloudBridge devices.
  • Configure Alert: Configure an alert (alert name and level) on CloudBridge devices.
  • Configure Sys Log Server: Configure a new system log server for CloudBridge devices.
  • Add User: Set up a new user account on selected devices and assign privileges.
  • ConfigureBandwidth-5.xandearlier: Configure the bandwidth parameters of CloudBridge devices of version 5.x and earlier.
  • ConfigureBandwidth-6.xandlater: Configure the bandwidth parameters of CloudBridge devices of version 6.x and later.
  • RestoreConfig: Restore the configuration on a CloudBridge device from any configuration file.
  • ConfigureRemoteLicenseServer: Configure multiple CloudBridge VPX devices to use a centralized licensing server. You can configure parameters, such as IP address, port of the licensing server, and the license model.
  • ConfigureLocalLicenseServer: Configure multiple CloudBridge VPX devices to use local licensing server.
  • RestartCloudBridge: Restart the CloudBridge devices.
  • InstallCACert : Install CA certificates for CloudBridge devices.
  • InstallCombinedCertKey: Install combined certificate key for CloudBridge devices.
  • InstallSeparateCertKey: Install separate certificate key for CloudBridge devices.
  • AddWCCPServiceGroup: Add a new WCCP service-group definition for one or more CloudBridge devices
  • EnableWCCP: Enable the WCCP deployment mode on one or more CloudBridge devices
  • DisableWCCP: Disable the WCCP deployment mode on one or more CloudBridge devices
  • SetApplication: Create or modify an application on a CloudBridge device
  • SetTrafficShapingPolicy: Modify the traffic shaping policy for one or more CloudBridge devices
  • AddTrafficShappingPolicy: Add a traffic shaping policy for one or more CloudBridge devices.
  • AddService: Create a service class for CloudBridge devices with one or more service class filters and enable the service class.
  • AddLink: Creates a link for regulation and reporting for CloudBridge devices.
  • SoftwareUpgrade: Software Upgrade for CloudBridge devices.
  • AddUser: Add a new user and assign the privileges.
  • AddVideoCachingSource: Add the IP address or domain name of the video source, and enable, disable, or exclude video caching from that source.
  • AddorRemoveVideoCachingPorts: Add or remove port numbers at which the video source can receive or send data. Default port is 80.
  • SetVideoCaching: Update the DNS suffix, maximum object size, policy file, or X-Forwarded-For configuration for video caching.
    • DNS Suffix: Convert the host name of the video caching source to a domain name.
    • Object Size: Maximum size for cached objects. An object larger than this limit is not cached.
    • Policy File: Policy rules for video caching.
    • X-Forwarded-For: Identify the client IP address for all HTTP requests that the appliance proxies.
  • RemoveVideoCachingSource: Remove one or more video caching sources.
  • RemoveAllVideoCaching: Remove all video caching sources.
  • ClearVideoCaching: Clear the video cache, or clear video caching statistics.
  • VideoCachingState: Enable or disable the video caching feature on one or more CloudBridge appliances.
  • AddVideoPrePopulationNow: Configure video prepopulation to specify how you want to download and cache videos from the URL(s).
  • AddorUpdateVideoPrePopulation: Add or modify a video prepolution entry to schedule it for a specified time period.
  • VideoPrePulationState: Start or disable video prepopulation.
Note: The export option and customize option are not available for the following built-in tasks:
  • AddWCCPServiceGroup
  • EnableWCCP
  • DisableWCCP
  • SetApplication
  • SetTrafficShapingPolicy
  • AddTrafficShappingPolicy
  • AddService

To execute the built-in tasks

On the Configuration tab, navigate to Configuration > Built-in Tasks, and in the right-pane, click CloudBridge tab.

Upgrading CloudBridge Advanced Platform with Built-in Tasks

Updated: 2015-04-02

The built-in upgrade tasks that you can execute on CloudBridge Advanced Platforms are:

  • UpgradeSoftware: Use the uploaded upgrade file to upgrade the CloudBridge Advanced Platform and all its components.
    Note: While executing the task, Command Center displays the Management Service IP address.

Uploading Upgrade Files to NetScaler SDX with Built-in Tasks

Updated: 2015-03-18

You can upload the NetScaler upgrade files to multiple NetScaler SDX appliances at the same time.

  • UploadNetScalerImage: Upload the NetScaler image to one or more NetScaler SDX appliances.
  • UpgradeXVA: Upload the XenServer Virtual Appliance (XVA) image to one or more NetScaler SDX appliances.

Viewing Built-in Tasks

You can view the built-in tasks by device family and category. The NetScaler device family also includes NetScaler VPX and NetScaler Gateway Enterprise devices.

To view built-in tasks by device family and category

  1. On the Configuration tab, in the left pane, under Configuration, click Built-in Tasks.
  2. In the right pane, under Built-in Tasks, you can view the built-in tasks.

Executing Built-in Tasks

Updated: 2014-04-15

You can execute a built-in task on multiple devices at the same time. You can either select devices individually or select a device list for the tasks. You can execute the same task several times on different devices or device lists. You can also preview a task (the commands and rollback commands) before executing it.

To execute built-in tasks

  1. On the Configuration tab, in the left pane, under Configuration, click Built-in Tasks.
  2. In the right pane, under Built-in Tasks, click the task you want to execute, and from the Action drop-down list, click Execute, and then follow the wizard instructions. Alternately, right-click the task, click Execute, and then follow the wizard instructions.

Viewing the Execution Log for Specific Built-in Tasks

Updated: 2014-04-15

After executing a task, you can view the execution details of that task instantly or at a later time.

To view the execution log for built-in tasks

  1. On the Configuration tab, in the left pane, under Configuration, click Built-in Tasks.
  2. In the right pane, under Built-in Tasks, click either the NetScaler tab or CloudBridge tab.
  3. Select the task whose execution details you want to view, and from the Action drop-down list, select Execution Log, and then follow the wizard instructions. Alternately, right-click the task, click Execution Log, and then follow the wizard instructions.
  4. Under Execution Log, you can view the following:
    • Task Name: Specifies the task name.
    • Device Name: Specifies the IP address of the device on which the task is executed.
    • Start Time: Specifies the time when the task started.
    • End Time: Specifies the time when the task ended.
    • Executed By: Specifies the NetScaler or CloudBridge user who started the task.
    • Status: Specifies the completion status of the task, such as Success, Failed, and Queued.
    • Annotation: Specifies a message that is annotated when executing the task.

Note: You can also view an execution log for all executed tasks, including custom tasks, by clicking Execution Log under Configuration in the left pane.

Scheduling Built-in Tasks

Updated: 2014-04-16

You can schedule built-in tasks to execute at a later period or recur at regular intervals. For example, you can schedule tasks to be executed at specific hours daily, at specific hours on specific days of the week, and at specific hours on specific days of the month.

You can also view the details of all the built-in tasks that you have scheduled.

To schedule built-in tasks

  1. On the Configuration tab, in the left pane, under Configuration, click Built-in Tasks.
  2. In the right pane, under Built-in Tasks, select the task you want to execute, click Schedule, and then follow the wizard instructions. Alternately, right-click the task and click Schedule, and then follow the wizard instructions.

Note: To view scheduled built-in tasks, in the right pane, under Built-in Tasks, on the bottom bar, click Scheduled Tasks. You can stop, resume, or remove a scheduled built-in task.

Exporting Built-in Tasks

Updated: 2014-04-16

You can save the built-in tasks in XML format on the Command Center server. This XML file, also known as task file, can be used to create a new custom task in the existing server or can be copied to another Command Center server.

Note: The location of the exported file is CC_Home\provisioningtemplates\exportedtemplates.
Note: The export option is not available for the following built-in tasks:
  • AddWCCPServiceGroup
  • EnableWCCP
  • DisableWCCP
  • SetApplication
  • SetTrafficShapingPolicy
  • AddTrafficShappingPolicy
  • AddService

To export built-in tasks

  1. On the Configuration tab, in the left pane, under Configuration, click Built-in Tasks.
  2. In the right pane, under Built-in Tasks, select the task you want to export, and from the Action drop-down list, click Export. Alternately, right-click the task, and then click Export.
  3. Under Export Task, in Name, type a name for the task file, and then click OK. A message appears confirming that the selected task is successfully exported.
Back to Top