- Release notes
- All how to articles
- System requirements
- Get started
- NetScaler MAS with Citrix XenServer
- NetScaler MAS with Microsoft Hyper-V
- NetScaler MAS with VMware ESXi
- NetScaler MAS with Linux KVM server
- Configure high availability deployment
- Configure disaster recovery for high availability
- Configure on-prem agents for multisite deployment
- Migrate from NetScaler Insight Center to NetScaler MAS
- Migrate Command Center configurations to NetScaler MAS
- Integrate NetScaler MAS with Citrix XenDesktop Director
- Attach an additional disk to NetScaler MAS
- Access control
- StyleBook groups
- 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 NetScaler MAS
- Create a StyleBook to upload SSL certificate and certificate key files to NetScaler MAS
- 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
- Import StyleBooks
- Parameters-default-sources construct
- Helper components
- Optional properties
- Properties-default-sources construct
- Nested components
- Condition construct
- Repeat construct
- Repeat-condition construct
- Nested repeats
- Parameter reference
- Parent reference
- Components reference
- Substitutions reference
- Variable reference
- In-place interpolations
- Built-in functions
- Dependency detection
- Monitor globally distributed sites
- Manage admin partitions of NetScaler instances
- Back up and restore NetScaler instances
- Force a failover to the secondary NetScaler instance
- Force a secondary NetScaler instance to stay secondary
- Create instance groups
- Rediscover multiple NetScaler VPX instances
- Poll NetScaler instances and entities
- Unmanage an instance
- Trace the route to an instance
- 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 NetScaler instances
- View events summary
- Display event severities and SNMP trap details
- Export syslog messages
- Suppress syslog messages
- Configure prune settings for instance events
- Use the SSL dashboard
- Set up notifications for SSL certificate expiry
- Update an installed certificate
- Install SSL certificates on a NetScaler instance
- Create a Certificate Signing Request (CSR)
- Link and unlink SSL certificates
- Configure an enterprise policy
- Poll SSL certificates from NetScaler instances
- 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 NetScaler instance to another
- Reuse executed configuration jobs
- Schedule jobs created by using built in templates
- Use maintenance jobs to upgrade NetScaler SDX instances
- Create configuration jobs for NetScaler SD-WAN WO instances
- Use the master configuration template
- Use jobs to upgrade NetScaler 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
- License requirements
- Logstream overview
- Web Insight
- HDX Insight
- Gateway Insight
- Security Insight
- SSL Insight
- TCP Insight
- WAN 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
OpenStack - integrating NetScaler instances
- Service package isolation policies
- Manual provisioning of NetScaler VPX instance on OpenStack
- Configure layer 7 content switching
- Configure LBaaS V1 using Horizon
- Configure LBaaS V2 using command line
- Shared VLAN support for admin partitions
- Pre-configuration tasks in NetScaler MAS and OpenStack
- Trial licensing workflow
- Integrate with OpenStack Heat services
- Flexible policy-based device allotment
- NSX Manager - manual provisioning of NetScaler instances
- NSX Manager - auto provisioning of NetScaler instances
- NetScaler automation using NetScaler MAS in Cisco ACI hybrid mode
- NetScaler device package in Cisco ACI's cloud orchestrator mode
- OpenStack - integrating NetScaler instances
NetScaler pooled capacity
- Configure NetScaler pooled capacity
- Upgrade a perpetual license in NetScaler VPX to NetScaler pooled capacity
- Upgrading a Perpetual License in NetScaler MPX to NetScaler Pooled Capacity
- Upgrade a perpetual license in NetScaler SDX to NetScaler pooled capacity
- NetScaler pooled capacity on NetScaler instances in cluster mode
- Health monitoring
- Expected behaviors when issues arise
- Configure expiry checks for pooled capacity licenses
- NetScaler VPX check-in and check-out licensing
- NetScaler virtual CPU licensing
- NetScaler pooled capacity
- Manage NetScaler SD-WAN instances
Manage HAProxy instances
- Add HAProxy instances to NetScaler MAS
- 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 NetScaler MAS
- Configure syslog purging interval
- Configure system prune settings
- Enable shell access for non-default users
- Recover inaccessible NetScaler MAS servers
- Assign a host name to a NetScaler MAS server
- Back up and restore your NetScaler MAS 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 NetScaler instances
- Back Up and restore a NetScaler MAS configuration in an HA pair
- Configure a cipher group
- Create SNMP traps, managers, and users
- Configure and view system alarms
- NetScaler MAS as an API proxy server
Back up and restore your NetScaler MAS server in a single-server deployment
In a NetScaler MAS single-server deployment, you can take periodic backups of your NetScaler MAS server. You can either take a partial backup of the server that includes the configuration files, instance details, system data, and so on, or you can take a complete backup of the entire NetScaler MAS server. If your NetScaler MAS becomes unstable, you can use these backed up files to restore your server to a stable state. Citrix recommends that you back up your NetScaler MAS server’s configuration before performing an upgrade or for precautionary reasons.
In a partial backup process, you can back up the following components of your NetScaler MAS server:
- NetScaler MAS Configuration Files:
- Syslog server configuration files
- NTP files
- SSL certificates
- Control Center files
- Backups of NetScaler instances being managed by the NetScaler MAS server.
- Configuration audit templates.
- System data stored on the database:
- List of tenants and users created.
- External authentication server configuration (LDAP, RADIUS, and others).
- Configuration jobs and job templates created.
- Infrastructure and application data stored on the database:
- Data from added and managed NetScaler instances.
- Instance profile details, version details, instance group details, and so on.
- A static application (group of virtual servers) created by the administrator.
- SNMP settings.
In this backup process, you cannot back up analytics data, events, and syslog messages.
Backing Up the NetScaler MAS Configuration
By default, the NetScaler MAS server backs up the configuration every 24 hours (at 00.30 hours). You can also take a backup at a time of your choosing. You can further move a copy of the backed up file to another system.
The backup is stored as a compressed TAR file that can also be encrypted. By default, three backup files are retained in the server. To avoid issues due to non-availability of disk space, you can store a maximum of 10 backup files on your NetScaler MAS server. However, Citrix recommends that you store some copies of your backup files on the server or transfer the files to another system.
To back up a NetScaler MAS configuration:
- Navigate to System > Advanced Settings > Backup Files, and then click Back Up.
To encrypt the backup file, select the Password Protect file checkbox, and then provide a password to encrypt the file.
You can also set a backup file for encryption by navigating to System > System Backup Settings, and then selecting Encrypt Backup File.
Transferring a NetScaler MAS Backup File to an External System
You can transfer a copy of the backup file to another system as a precautionary measure. When you want to restore the configuration, you have to first upload the file to the NetScaler MAS server and then perform the restore operation.
To transfer a NetScaler MAS backup file:
Navigate to System > Advanced Settings > Backup Files.
Select the backup file that you want to move to another system, and then click Transfer.
On the Backup Files page, specify the following parameters:
- Server - IP address of the system where you want to transfer the backed-up file.
- User Name and Password - User credentials of the new system where the backed-up files are being copied.
- Port - Port number of the system the files are being transferred to.
- Transfer Protocol - Protocol being used to make the backup file transfer. You can select SCP, SFTP, or FTP protocols to transfer the backed-up file.
- Directory Path - The location where the backed-up file is being transferred to on the new system.
Alternatively, you can also set the external systems detail by navigating to System > System Backup Settings.
You can delete the backup file from NetScaler MAS after transfer by selecting the Delete file from NetScaler Management and Analytics System after transfer checkbox.
Click OK to make the transfer.
To save a copy of the backup file in your local system, navigate to System > Advanced Settings > Backup Files, select the file you want to copy, and then click Download.
Restoring the NetScaler MAS Configuration from a Backup File
When you restore the NetScaler MAS configuration from a previously backed up file, the restore operation untars the backup file and then restores the configuration. The restore operation deletes the existing configuration and replaces it with the configuration in the backup file.
The restore operation will not succeed if your backup file has been renamed or if the contents within the backup file have been modified.
To restore a NetScaler MAS configuration from a backup file:
- Navigate to System > Advanced Settings > Backup Files.
- Select the backup file that you want to restore, and then click Restore.
On the confirmation dialog box, click Yes.
To restore the configuration from a backup file stored in an external system, you have to upload the backup file to the NetScaler MAS server before performing the restore operation. To upload the file, navigate to System > Advanced Settings > Backup Files, and then click Upload.