- Release notes
- All how to articles
- Overview
- Data governance
- Licensing
- System requirements
- Get started
-
Deploy
- Citrix ADM with Citrix XenServer
- Citrix ADM with Microsoft Hyper-V
- Citrix ADM with VMware ESXi
- Citrix ADM with Linux KVM server
- Configure high availability deployment
- Configure disaster recovery for high availability
- Configure on-prem agents for multisite deployment
- Migrate Citrix ADM single-server deployment to a high availability deployment
- Migrate from NetScaler Insight Center to Citrix ADM
- Migrate Command Center configurations to Citrix ADM
- Integrate Citrix ADM with Citrix XenDesktop Director
- Attach an additional disk to Citrix ADM
- Configure
- Upgrade
- Authentication
- Access control
- Applications
-
StyleBooks
- StyleBook groups
- Importing and synchronizing StyleBooks from GitHub repository
- Use default StyleBooks
- Business application StyleBooks
-
Create and use custom StyleBooks
- StyleBook to create a load balancing virtual server
- StyleBook to create a basic load balancing configuration
- Create a composite StyleBook
- Use GUI attributes in a custom StyleBook
- Use custom StyleBooks
- Create a StyleBook to upload files to Citrix ADM
- Create a StyleBook to upload SSL certificate and certificate key files to Citrix ADM
- Enable analytics and configure alarms on a virtual server defined in a StyleBook
- Create a Stylebook to perform non-CRUD operations
- Use API to create configurations from StyleBooks
-
StyleBooks grammar
- Header
- Import StyleBooks
- Parameters
- Parameters-default-sources construct
- Substitutions
- Components
- Helper components
- Optional properties
- Properties-default-sources construct
- Nested components
- Condition construct
- Repeat construct
- Repeat-condition construct
- Nested repeats
- Outputs
- Parameter reference
- Parent reference
- Components reference
- Substitutions reference
- Variable reference
- Operations
- Analytics
- Alarms
- Expressions
- In-place interpolations
- Built-in functions
- Dependency detection
-
Networks
-
Instance management
- Monitor globally distributed sites
- How to create tags and assign to instances
- How to search instances using values of tags and properties
- Manage admin partitions of Citrix ADC instances
- Back up and restore Citrix ADC instances
- Force a failover to the secondary Citrix ADC instance
- Force a secondary Citrix ADC instance to stay secondary
- Create instance groups
- Rediscover multiple Citrix ADC VPX instances
- Poll Citrix ADC instances and entities
- Unmanage an instance
- Trace the route to an instance
-
Events
- Use events dashboard
- Set event age for events
- Schedule an event filter
- Set repeated email notifications for events
- Suppress events
- Create event rules
- Modify the reported severity of events that occur on Citrix ADC instances
- View events summary
- Display event severities and SNMP trap details
- Export syslog messages
- Suppress syslog messages
- Configure prune settings for instance events
-
SSL Dashboard
- Use the SSL dashboard
- Set up notifications for SSL certificate expiry
- Update an installed certificate
- Install SSL certificates on a Citrix ADC instance
- Create a Certificate Signing Request (CSR)
- Link and unlink SSL certificates
- Configure an enterprise policy
- Poll SSL certificates from Citrix ADC instances
-
Configuration jobs
- Create a configuration job
- Use record-and-play to create configuration jobs
- Use configuration jobs to replicate configuration from one instance to multiple instances
- Use variables in configuration jobs
- Create configuration jobs from corrective commands
- Replicate running and saved configuration from one Citrix ADC instance to another
- Reuse executed configuration jobs
- Schedule jobs created by using built in templates
- Use maintenance jobs to upgrade Citrix ADC SDX instances
- Create configuration jobs for Citrix SD-WAN WO instances
- Use the master configuration template
- Use jobs to upgrade Citrix ADC instances
- Use configuration templates to create audit templates
- Use SCP (put) command in configuration jobs
- Reschedule jobs configured by using built in templates
- Reuse configuration audit templates in configuration jobs
- Import and export configuration templates
- Maintenance jobs
- Configuration audit
- Network functions
- Network reporting
-
Instance management
-
Analytics
- License requirements
- Logstream overview
- Settings
- Self-service diagnostics for Analytics
- Web Insight
- HDX Insight
- Gateway Insight
- Security Insight
- SSL Insight
- TCP Insight
- WAN Insight
-
Video Insight
- View network efficiency
- Compare the data volume used by optimized and unoptimized ABR videos
- View the type of videos streamed and data volume consumed from your network
- Compare optimized and unoptimized play time of ABR videos
- Compare bandwidth consumption of optimized and unoptimized ABR videos
- Compare optimized and unoptimized number of plays of ABR videos
- View peak data rate for a specific time frame
- Secure Web Gateway Analytics
-
Orchestration
-
OpenStack - integrating Citrix ADC instances
- Prerequisites
- Pre-configuration tasks in Citrix ADM and OpenStack
- Configure LBaaS V1 using Horizon
- Configure LBaaS V2 using command line
- Configure layer 7 content switching
- Manual provisioning of Citrix ADC VPX instance on OpenStack
- Provisioning of Citrix ADM VPX instance on OpenStack using StyleBooks
- Citrix ADC VPX check-in and check-out license and pooled license support for OpenStack environment
- Shared VLAN support for admin partitions
- Trial licensing workflow
- Integrate with OpenStack Heat services
- Service package isolation policies
- Flexible policy-based device allotment
- NSX Manager - manual provisioning of Citrix ADC instances
- NSX Manager - auto provisioning of Citrix ADC instances
- Citrix ADC automation using Citrix ADM in Cisco ACI hybrid mode
- Citrix ADC device package in Cisco ACI's cloud orchestrator mode
-
OpenStack - integrating Citrix ADC instances
-
Manage licenses
- Licenses for Citrix ADM License server in high availability
-
Citrix ADC pooled capacity
- Configure Citrix ADC pooled capacity
- Upgrade a perpetual license in ADC VPX to ADC pooled capacity
- Upgrading a Perpetual License in ADC MPX to ADC Pooled Capacity
- Upgrade a perpetual license in ADC SDX to ADC pooled capacity
- Citrix ADC pooled capacity on ADC instances in cluster mode
- Health monitoring
- Expected behaviors when issues arise
- Configure expiry checks for pooled capacity licenses
- Citrix ADC VPX check-in and check-out licensing
- Citrix ADC virtual CPU licensing
- Manage Citrix SD-WAN instances
-
Manage HAProxy instances
- Add HAProxy instances to Citrix ADM
- HAProxy app dashboard
- Third-party licensing
- Role-based access control for HAProxy instances
- Monitor HAProxy instances
- View the details of frontends configured on HAProxy instances
- View the details of backends configured on HAProxy instances
- View the details of servers configured on HAProxy instances
- View the HAProxy Instances with the highest number of frontends or servers
- Restart an HAProxy instance
- Back up and restore an HAProxy instance
- Edit the HAProxy configuration file
-
Manage system settings
- Configure system backup settings
- Configure a NTP Server
- Upgrade Citrix ADM
- How to reset the password for Citrix ADM
- Configure syslog purging interval
- Configure system prune settings
- Enable shell access for non-default users
- Recover inaccessible Citrix ADM servers
- Assign a host name to a Citrix ADM server
- Back up and restore your Citrix ADM server in a single-server deployment
- View auditing information
- Configure SSL settings
- Monitor CPU, memory, and disk usage
- Configure system notification settings
- Generate a tech support file
- Diagnose and troubleshoot Citrix ADC instances
- Back Up and restore a Citrix ADM configuration in an HA pair
- Configure a cipher group
- Create SNMP traps, managers, and users
- Configure and view system alarms
- Citrix ADM as an API proxy server
- Hybrid and Multi-cloud Deployments
- FAQs
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
This content has been machine translated dynamically.
This content has been machine translated dynamically.
This content has been machine translated dynamically.
Translation failed!
Use variables in configuration jobs
A configuration job is a set of configuration commands that you can execute on one or more managed instances. When you execute the same configuration on multiple instances, you might want to use different values for the parameters used in your configuration. You can define variables that enable you to assign different values for these parameters or execute a job across multiple instances.
For example, consider a basic load balancing configuration where you add a load balancing virtual server, add two services, and bind the services to the virtual server. Now, you might want to have the same configuration on two instances but with different values for the virtual server and services names and IP addresses. You can use the configuration jobs feature to achieve this by using variables to define the names and IP addresses of the virtual server and services.
In this example, the following commands and variables are used:
add lb vserver servername HTTP ipaddress portnumber
add service servicename1 ipaddress1 HTTP 80
add service servicename2 ipaddress2 HTTP 80
bind lb vserver servername servicename1
bind lb vserver servername servicename2
To create a configuration job by defining variables in NetScaler MAS:
-
Navigate to Networks > Configuration Jobs.
-
Click Create Job.
-
On the Create Job page, select the custom job parameters such as the name of the job, the instance type, and the configuration type.
-
In the Configuration Editor, type in the commands to add a load balancing virtual server, two services, and bind the services to the virtual server. Double click to select the values that you want to convert to a variable, and then click Convert to Variable. For example, select the IP address of the load balancing server ipaddress, and click Convert to Variable as shown in the image below.
-
Once you see dollar signs enclose the variable’s value, click on the variable to further specify the details of the variable such as name, display name, and type. You can also click the Advanced option if you want to further specify a default value for your variable. Click Save and then, click Next.
Type in the rest of your commands and define all the variables.
-
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 on 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.
-
You can then rearrange and reorder the commands in the configuration editor as appropriate. You can move the command from one line to another by dragging and dropping the command line. You can also move or rearrange the command line from one line to any target line by simply changing the command line number in the text box.
-
Select the instances you want to run the configuration job on.
-
In the Specify Variable Values tab, select the Upload input file for variable values option and then click Download Input Key File. In our example, you will need to specify the server name on each instance, the IP addresses of the server and services, port numbers, and the service names. Save the file and upload it. If your values aren’t defined accurately, the system might throw an error.
-
The input key file is downloaded to your local system and you can edit it by specifying the variable values for each NetScaler instance you’ve selected previously and click Upload to upload the input key file to NetScaler MAS. Click Next. The input key file downloads to your local system and you can edit it by specifying the variable values for each NetScaler instance that you have selected previously.
Note: In the input key file, the variables are defined at three levels:
- Global level
- Instance-group level
- Instance level
Global variables are variable values that are applied across all instances. Instance group level variable values are applied to all instances that are defined in a group. Instance level variable values are only applied to a specific instance.
NetScaler MAS gives first priority to instance level values. If there are no values provided to the variables for individual instances, NetScaler MAS uses the value provided at the group level. If there are no values provided at group level, NetScaler MAS uses the variable value provided at the global level. If you provide an input for a variable across all three levels, NetScaler MAS uses the instance level value as the default value.
-
Click Upload to upload the input key file to NetScaler MAS. Click Next.
Important
When you upload a CSV file from a Mac, Mac stores the CSV file with semicolons instead of commas. This will cause the configuration to fail when you upload the input file and run the job. If you are using a Mac, use a text editor to make the necessary changes and then upload the file.
-
You can also give common variable values across all instances and click Upload to upload the input key file to NetScaler MAS.
The key 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 executed 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 executed 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).
-
On the Job Preview tab, you can evaluate and verify the commands to be run on each instance or instance group.
-
In the Execute tab, you can choose to execute your job now or schedule it to be executed at a later time. You can also choose what action NetScaler MAS should take if the command fails and if you’d like to send an Email notification regarding the success or failure of the job along with other details.
After configuring your jobs and executing it, you can see the job details by navigating to Networks > Configuration Jobs and select the job you just configured. Click on Details and then, click on Variable Details to see the list of variables added to your job.
Note
The values that you have provided for the variables in STEP 5 are retained by NetScaler MAS when you save the job and exit, or when you schedule a job to be run at a later point of time.