Application Delivery Management

Create configuration jobs for Citrix SD-WAN WANOP instances

December 31, 2023

Contributed by:

A job is a set of configuration commands that you can create and schedule on one or more managed instances. For Citrix SD-WAN WANOP instances, you can use the following options to create jobs:

Configuration Template: You can use the configuration editor to type in CLI commands, save the configuration as a template, and use it to configure jobs.
Inbuilt Template: You can choose from a list of configuration templates. These templates provide the syntaxes of the CLI commands and allow you to specify values for the variables. The inbuilt templates are listed, with their descriptions in the table below.
File: You can upload a configuration file from your local machine and create jobs.

Once a job is created, you can choose to run the job immediately or schedule the job to be run later. You can also set the execution frequency

Inbuilt Template	Description
EnableCloudBridgeWANOpt	Enables traffic through the Citrix SD-WAN WANOP appliance.
DisableCloudBridgeWANOpt	Disables the traffic through Citrix SD-WAN WANOP appliance.
RestartCloudBridgeWANOpt	Restarts Citrix SD-WAN WANOP appliance.
RestoreConfig	Restores the configuration of Citrix SD-WAN WANOP appliance.
AddLink	Creating or defining links enable the SD-WAN WANOP appliance to prevent congestion and loss on the links and to perform traffic shaping. You can define the maximum bandwidth sent or received over the link and also specify it is LAN side or WAN side traffic.
ConfigureBandwidth	Sets the bandwidth limits and other bandwidth management settings.
AddUser	Adds a new user, for whom you can assign privileges.
AddUserAdvancedPlatform	Adds a new user enables you to assign privileges not available in the `AddUser` template.
AddService-class	Creates a service class for Citrix SD-WAN WANOP appliance with one or more service classes filters and enables it.
SetApplication	Sets the application classifier definition.
AddorRemoveVideoCachingPorts	Adds or removes the port number at which the video source can send or receive data. The default port is 80.
RemoveVideoCachingSource	Removes one or more video caching sources. Specify the video source IP address or domain name.
RemoveAllVideoCaching	Removes all the available video caching sources.
VideoCachingState	Enables or disables the video caching feature on Citrix SD-WAN WANOP appliances.
ClearVideoCaching	Clears either the video cache or the video caching statistics.
SetVideoCaching	Sets the maximum size for cached objects. An object larger than this limit is not cached. By default, the maximum caching object size is 100 MB.
AddVideoCachingSource	Adds the IP address or the domain name of the video source. Includes options to enable or disable video caching for that source.
ConfigureRemoteLicenseServer	Configures the centralized license server. Specify the license server model, IP address and port number.
ConfigureLocalLicenseServer	Sets the license server location as local.
InstallCACert	Installs CA certificates on Citrix SD-WAN WANOP appliance. Specify the certificate name, file name and the keystore password.
InstallCombinedCerKey	Installs a combined SSL certificate-key pair file.
InstallSeperateCertKey	Installs SSL certificate and key as separate files.
EnableWCCP	Enables WCCP deployment mode.
AddWCCPServiceGroup	Adds a new WCCP service-group definition for Citrix SD-WAN WANOP appliance.
DisableWCCP	Disables the WCCP deployment mode.
AddTrafficShapingPolicy	Creates a traffic shaping policy for the Citrix SD-WAN appliance. The policy controls the network bandwidth.
SetTrafficShapingPolicy	Modifies the traffic shaping policy for Citrix SD-WAN WANOP appliance. The policy controls the network bandwidth.
AddVideoPrePopulation	Creates a video pre-population entry, which enables you to download and cache a video in advance. You can also specify when to cache a video.
UpdateVideoPrePopulation	Modifies a video prepopulation entry, which specifies when to cache a video.
AddVideoPrePopulationNow	Configures video prepopulation, enabling you to download and cache a video immediately. You can control how you want to download and cache videos from the URL(s).
VideoPrePopulationState	Changes, starts, updates, or removes video pre-population.
ConfigureSyslogServer	Sets the IP address and the port number of the syslog server.
ConfigureAlert	Configures alert level.

To create a configuration job for Citrix SD-WAN WANOP instances:

In Citrix ADM, navigate to Networks > Configuration Jobs, and then click Create Job.
On the Create Job page, under the Select Configuration tab, specify the Job Name.
In the Instance Type field, select Citrix SD-WAN WO.
In the Configuration Source drop-down list, select an option to create a job.

Note

Select Save as Configuration Template and specify a name to save the configuration as a template and reuse it.
You can review all the variables that you have defined while creating or editing a configuration job in a single consolidated view.
Do one of the following to view all the variables in a single consolidated view:
- While creating a configuration job, navigate to Networks > Configuration Jobs, select Create Job. On the Create Job page, you can review all the variables that you have added while creating the configuration job.
- While editing a configuration job, navigate to Network > Configuration Jobs, select the Job Name and click Edit. On the Configure Job page, you can review all the variables that were added while creating the configuration job.
You can then click the Preview Variables tab to preview the variables in a single consolidated view that you have defined while creating or editing a configuration job.
A new pop-up window appears and displays all the parameters of variables such as Name, Display Name, Type, and default value in a tabular format. You can also edit and modify these parameters. Click the Done button after you have edited or modified any of the parameters.
Click Next, and then on the Select Instances tab, click Add Instances. Select the instances on which you want to run the job, and then click OK.
Click Next, and then on the Specify Variable Values tab, select one of the following options to specify variables for your instances:
- Upload input file for variables values: Click Download Input Key File to download an input file. In the input file, enter values for the variables that you have defined in your commands, and then upload the file to the Citrix ADM server.
- Common variable values for all instances: Enter values for the variables. The variables vary depending on the selected template.
The input files containing the variables values are persisted (with the same file name) in the configuration jobs. You can view and edit these input files that you have used and uploaded earlier while creating or editing the configuration jobs.

To view the run configuration jobs while creating a configuration job, navigate to Network > Configuration Jobs, and click Create Job. In the Create Job page. On the Specify Variable Values tab, select the Common Variable Values for all Instances option to view the uploaded files. To edit the input files, download the input file and then edit and upload the files (keeping the same file name).

To view the already run configuration jobs while editing a configuration job, navigate to Network > Configuration Jobs, select the Job Name and click Edit. In the Configure Job page, on the Specify Variable Values tab, select the Common Variable Values for all Instances option to view the uploaded files. To edit the input files, download the input file and then edit and upload the files (keeping the same file name)
Click Next, on the Job Preview tab, you can evaluate and verify the commands to be run as a job.
Click Next, on the Execute tab, set the following conditions:
- On Command Failure: What to do if a command fails: ignore the errors and continue the job, or stop further execution of the job. Choose an action from the drop-down list.
- Execution Mode: Run the job immediately, or schedule execution for a later time. If you schedule execution for a later time, you must specify the execution frequency settings for the job. Choose the schedule you want the job to follow from the Execution Frequency drop-down list.
Under Execution Settings, select to run the job sequentially (one after the other), or in parallel (at the same time).
To have a job execution report emailed to a list of recipients, select the Email check box in the Receive Execution Report Through section. From the drop-down list that appears, choose an email distribution list. To create an email distribution list, click the + icon and enter the email addresses of the recipients, and email server details.
Click Finish.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Create configuration jobs for Citrix SD-WAN WANOP instances

December 31, 2023

Contributed by:

December 31, 2023

Contributed by:

Create configuration jobs for Citrix SD-WAN WANOP instances

In this article