- 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!
Back up NetScaler SD-WAN WO instances
You can back up the current state of an instance and later use the backed-up files to restore the instance to the same state. It is a good practice to back up an instance before you upgrade the instance or for precautionary reasons. A backup of a stable system enables you to restore the system to a stable point in case it becomes unstable. There are multiple ways to perform backups and restores on a NetScaler SD-WAN WO instance. You can maually backup and restore instances using the GUI, CLI, or use NetScaler MAS to perform backups. NetScaler MAS backs up the current state of your managed NetScaler SD-WAN WO instances using NITRO calls, Secure Shell (SSH) protocol, and Secure Copy (SCP) protocol.
Configuring Instance Backup Settings
Before you take a backup of the NetScaler SD-WAN WO instance in NetScaler MAS, you have to configure the instance backup settings on NetScaler MAS.
To configure instance backup settings:
-
In NetScaler MAS, navigate to System > System Administration. In the right-hand pane, under Backup Settings, select Instance Backup Settings.
-
Select Enable Instance Backups. This option is enabled by default.
-
Select Password Protect File to encrypt the backup file. Encrypting the backup file ensures that the sensitive information in the backup file is secure.
-
In the Number of Backup Files to retain field, specify the number of backup files to retain in NetScaler MAS. You can retain up to 50 backup files.
Note
Each backup file requires some storage requirement. Citrix recommends that you store an optimal number of backup files on NetScaler MAS as per your requirement.
-
Set the Backup Scheduling settings. Choose one of the following options:
- Interval Based - A backup file is created in NetScaler MAS after the specified interval elapses. The default backup interval is 12 hours.
- Time Based - You can specify the time in “hours:minutes” format at which the backup should happen. NetScaler MAS allows up to four daily backups to happen on the instances.
Note
Ignore the NetScaler Settings section; these settings are not applicable for NetScaler SD-WAN WO instances.
-
Select Enable External Transfer to transfer the instance backup files to an external location. Enter the values for the following fields:
- Server: IP address of the external server.
- User Name: User name of the external server
- Password: Password of the external server.
- Port: Port number used to communicate with the external server.
- Transfer Protocol: Protocol to be used for transferring the backup files from NetScaler MAS to the external server.
You can also delete the backup file from NetScaler MAS after transferring it to the external server.
-
Click OK.
Note
NetScaler MAS sends an SNMP trap or a Syslog notification to itself when there is a backup failure for any of the selected NetScaler SD-WAN WO instances.
Creating a Backup of NetScaler SD-WAN WO Instance
The procedure to create a backup for NetScaler SD-WAN WO instance is applicable for an admin user, using the default nsroot profile.
For information on, how a custom user can take back up of a NetScaler SD-WAN WO instance see, Creating a Backup of NetScaler SD-WAN WO Instance for Custom Users section in this topic. .
Ensure that a NetScaler SD-WAN WO instance is added to NetScaler MAS for more information see, Adding Instance to NetScaler MAS.
To create a backup for NetScaler SD-WAN WO Instance:
-
In NetScaler MAS, navigate to Networks > Instances > NetScaler SD-WAN WO.
-
Select the NetScaler SD-WAN WO instance that you want to back up, and then click Backup/Restore.
-
On the Backup Files page, click Back Up.
-
Encrypt your backup file by using any one of the following options:
- Select Password Protected file, and enter a password to encrypt the backup files.
- Select Use Global Password to use the global password that you specified on the instance backup settings page.
-
Click Create Backup
Creating a Backup of NetScaler SD-WAN WO Instance for Custom Users
If you have created a custom user with admin privileges in NetScaler SD-WAN WO instance, use the following procedure to add an instance and take back up of that instance using NetScaler MAS.
Backup operation by custom users is not supported on 400/800/1000WS/2000/2000WS/3000/4000/5000/4100/5100 SD-WAN WO platforms.
Note
Citrix recommends you to use the default nsroot profile, while creating backup of NetScaler SD-WAN advanced platforms in NetScaler MAS.
To add a NetScaler SD-WAN WO Instance and take a backup for a custom user:
-
In NetScaler MAS, navigate to Networks > Instances > NetScaler SD-WAN WO and click Add.
-
In the IP Address field, enter the IP address of the NetScaler SD-WAN WO instance.
-
Click + next to Profile Name field to create a new profile. The Create NetScaler SD-WAN WO Profile window appears.
-
In the Profile Name field, enter a name for the profile.
-
In the User Name field, enter the username of the custom user that you create on the SD-WAN WO instance.
-
In the Password field, enter the password that you set for the custom user in the SD-WAN WO instance.
-
In the Community field, enter the SNMP communication string configured on the SD-WAN WO appliance. ( for example: public)
-
Click Create.
-
In the Profile Name field, select the newly created profile and click OK.
-
Navigate to Networks > Instances > NetScaler SD-WAN WO.
-
Select the NetScaler SD-WAN WO instance that you just added, and then click Backup/Restore.
-
On the Backup Files page, click Back Up.
-
Encrypt your backup file by using any one of the following options:
- Select Password Protected file, and enter a password to encrypt the backup files.
- Select Use Global Password to use the global password that you specified on the instance backup settings page.
Note
You can download the encrypted backup file to your local machine, but you cannot view its contents. Only NetScaler MAS can use these backup file for restore purpose. Restoring encrypted backup will prompt for password.
-
Click Create Backup.
Important
- For a NetScaler SD-WAN WO VPX appliance, NetScaler MAS backs up only the CB broker configuration file.
- For an advanced NetScaler SD-WAN WO platform, NetScaler MAS backs up the following:·
- CB broker configuration file
- NTP configuration file
- DNS
- SNMPD configuration file
- Syslog configuration file
- SSL certificate, keys and policies
- SVM Database file
- Components (in XML format)
- Resources (in XML format)
The files that are backed up in the respective folders are listed in the following table. Note that if a folder name is followed by a “*”, all files in that folder are backed up.
Directory Sub-Directory or Files /br_broker/ CB-6bbb660a/ ws.conf /etc/ resolv.conf /mps/ mps_devices.xml /mpsconfig/ ssl/*, ntp.conf, snmpd.conf, syslog.conf /mpsdb/ mpsdb_dump.sql /ns/ NS-6cbb660a/* /var/ mps/policy/*, mps/ssl_certs/ sdx_default_ssl_cert, mps/ssl_keys/ sdx_default_ssl_key, mps/tenants/*