Product Documentation

Managing NetScaler MAS System Settings

Aug 31, 2017

The following table describes how to configure the system settings on your NetScaler MAS.

If you want to … Do this …

Configure the setup wizard settings

Navigate to System > System Administration. Under Set Up NetScaler MAS, select Setup Wizard Settings. You can select the NetScaler MAS Network option to modify network settings, such as IP address of NetScaler MAS, and its password.

You can click System Settings to modify the host name, mode of communication with instance(s), or local time zone.

Configure the network settings

Navigate to System > System Administration. Under Set Up NetScaler MAS, select Network Configuration. You can choose IPV4, IPV6, or both, and enter network parameters.

View SSL certificate

Navigate to System > System Administration. Under Set Up NetScaler MAS, select View SSL Certificate. The GUI displays the SSL certificates and keys installed on the NetScaler MAS.

Change Time Zone

Navigate to System > System Administration. Under System Settings, select Change Time Zone. From the Time Zone drop-down list, select the time zone for your NetScaler MAS appliance's clock.

Change Hostname

Navigate to System > System Administration. Under System Settings, select Change Hostname.  Enter a hostname that will be used to identify your NetScaler MAS, so that when you generate the universal license for NetScaler MAS Gateway, the hostname is displayed in the license.

Change the system settings

Navigate to System > System Administration. Under System Settings, select Change System Settings. Then, select or clear check boxes to enable or disable the following features:

  • Secure Access Only  
  • Enable Session Timeout      
  • Allow Basic Authentication 
  • Enable nsrecover Login       
  • Enable Certificate Download
  • Enable Shell access for non-nsroot User
  • Prompt for user credentials for instance login

Configure the SSL settings

Navigate to System > System Administration. Under System Settings, select Configure SSL Settings to display the current protocol settings and the applied cipher suites.

If you want to modify any of the settings, under Edit Settings, select Protocol Settings or Cipher Suites.

Configure Enable the user experience improvement settings feature

Navigate to System > System Administration. Under System Settings, select Configure User Experience Improvement Settings, and then select the Enable CUXIP check box. If you select this check box, usage statistics are collected for the sole purpose of improving the graphical user interface. The collected data is used only by Citrix engineers and is not shared with anyone.

Upgrade NetScaler MAS

Navigate to System > System Administration. Under the System Administration subheading, select Upgrade NetScaler MAS, and then select the new image file. You can select a file that is already on the NetScaler MAS virtual appliance, or you can upload a file from your local computer.

Reboot NetScaler MAS

Navigate to System > System Administration. Under the System Administration subheading, select Reboot NetScaler MAS.
A dialog box appears, asking you to confirm your action.  Click Yes.

Configure the system prune settings (for pruning old data)

Navigate to System > System Administration. Under Prune Settings, select System Prune Settings.
In the Data to keep (days) field, enter the number of days for which to retain data in the system.

Configure the system backup settings

Navigate to System > System Administration. Under Backup Settings, select System Backup Settings, and then enter the number of system backups to retain on the MAS appliance. You can also elect to encrypt the backup files, and you can specify an external location to which to transfer them. Transferred backup files can be retained on or deleted from the system.

Configure the instance backup settings

Navigate to System > System Administration. Under Backup Settings, select Instance Backup Settings, and enter the time interval (in hours) at which to create a backup file backing up all the instances managed by the NetScaler MAS.

You can specify the number of backup files to retain, and whether to encrypt them so that they cannot be accessed without a password.

View the system statistics 

Navigate to System > Statistics. A line graph displays information such as CPU usage, memory usage, and disk usage. 

View and manage sessions

Navigate to System > Sessions. You can then see all the active sessions, with details.
To terminate a session, select its check box and click Cancel Session.

Add or modify a tenant

Navigate to System > Tenants, and add a new tenant or edit the settings for an existing tenant. You can provide additional information, such as an organizational unit name, department, and URL for the tenant.

Change the user lockout policy

Navigate to System > User Administration. Under User Configuration, select User Lockout Configuration, and then select the Enable User Lockout check box.

You can specify the number of invalid attempts a user can make before their account is disabled, and for how long the user-lockout policy is effective.

Change the password complexity

Navigate to System > User Administration. Under User Configuration, select Password Policy, and then select the Enable Password Complexity check box.

In the Minimum Password Length field, enter the minimum number of characters required for a password on the NetScaler MAS.

Add or modify a user

Navigate to System > User Administration > Users. Under Users, add a new user or edit the settings for an existing user.

When adding a user, you can enable options such as external authentication, session timeout, and assigning the user to specific groups.

Add or modify a user group

Navigate to System > User Administration > Groups. Under Groups, add a new group or edit the settings for an existing group.

When adding a group, you can enable options such as assigning permissions for the group, configuring a session timeout, assigning users to the group, and allowing access to particular or all applications on the NetScaler MAS.

Change the authentication configuration

Navigate to System > Authentication > Authentication. Under Authentication, select Authentication Configuration, and select the

type of authentication server.

Add or modify a RADIUS  server

Navigate to System > Authentication > RADIUS.

Under RADIUS, add a new RADIUS server or edit the settings for an existing RADIUS server by entering or modifying the network parameters.

Add or modify an LDAP server

Navigate to System > Authentication > LDAP.

Under LDAP, add a new LDAP server or edit the settings for an existing LDAP server by entering or modifying the network parameters.

Add or modify a TACACS servers

Navigate to System > Authentication > TACACS.

Under TACACS, add a new TACACS server or edit the settings for an existing TACACS server by entering or modifying the network parameters.

Add or modify a syslog server

Navigate to System > Auditing > Syslog Servers. Under Syslog Servers, add a new syslog server or edit the settings for an existing syslog server by entering or modifying the network parameters.

You can provide additional information by selecting the kind of log levels you want to monitor.

Read syslog messages

Navigate to System > Auditing. Under Audit Messages, select Syslog Messages.

Summaries of all system log files are displayed in the Syslog Viewer. You can select the syslog file you want to view from the File drop-down option. Additionally, syslog files can be further filtered by module, event type, and severity.

Configure the syslog purge settings

Navigate to System > Auditing. Under Settings, select Syslog Purge Settings, and then enter the number of days to retain syslog data before it is deleted from the NetScaler MAS.

View system events

Navigate to System > Events. You can then see all the current events, with details.

Add or modify an NTP server

Navigate to System > NTP Servers to add a new NTP server or edit the settings for an existing NTP server.

Configure NTP parameters

Navigate to System > NTP Servers.

Click NTP Parameters and enter the server’s configuration details in given fields provided.

Enable NTP synchronization

Navigate to System > NTP Servers.

To synchronize the time displayed on the NTP server with your local clock, select the Enable NTP Synchronization check box.

Add or modify cipher groups

Navigate to System > Cipher Groups to add a new cipher group or edit the settings of an existing cipher group.

You must enter a description of your cipher group and assign it to a cipher suite. 

Configure notification settings

Navigate to System > Notifications. Under Settings, select Change Notification Settings.

Choose the actions for which you want to send the notifications, and select Email, SMS, or both.

Configure event digest settings

Navigate to System > Notifications. Under Settings, select Configure Event Digest Settings.

After clearing the Disable Event Digest check box, you can set a recurrence period and choose an email distribution list for sending event digest notifications. 

Add or modify email servers

Navigate to System > Notifications > Email. Under Email, select the Email Servers tab to add a new email server or edit the settings for an existing email server.

You can enable additional checks to ensure that authentication is required for access to the email server, or to specify that your email server supports SSL authentication.

Add or modify email distribution lists

Navigate to System > Notifications > Email. Under Email, select the Email Distribution List tab to add a new email distribution list or edit the settings for an existing email distribution list.

Add or modify SMS servers

Navigate to System > Notifications > SMS. Under SMS, select the SMS Server tab to add a new SMS server or edit the settings for an existing SMS server.

Add or modify SMS distribution lists

Navigate to System > Notifications > SMS. Under SMS, select the SMS Distribution List tab to add a new SMS distribution list or edit the settings for an existing SMS distribution list.

Configure SNMP Engine ID

Navigate to System > SNMP.  Under Settings, select Configure Engine ID and specify the Engine ID.

Configure SNMP MIB

Navigate to System > SNMP.  Under Settings, select Configure SNMP MIB, and enter the SNMP MIB details.

Configure SNMP Traps

Navigate to System > SNMP > Trap Destinations.

Under SNMP Traps, add a new SNMP trap destination or edit the settings for an existing SNMP trap destination.

Add or modify an SNMP manager

Navigate to System > SNMP > Managers.

Under SNMP Manager, add a new SNMP manager or edit the settings for an existing SNMP manager.

Add or modify an SNMP user

Navigate to System > SNMP > Users.

Under SNMP User, add a new SNMP user or edit the settings for an existing SNMP user.

Add or modify SNMP views

Navigate to System > SNMP > Views.

Under SNMP View, add a new SNMP view or edit the settings for an existing SNMP view.

Modify alarms

Navigate to System > Alarms and select the alarm whose settings you want to modify. Alarms help you monitor the health of your NetScaler MAS server.

View the task log

Navigate to System > Diagnostics > Task Logs. You can then see all the task logs, with details.

You can view additional information by selecting a task log and viewing its Device Log, and then viewing the Command Log for the selected device log.

Generate the technical support file

Navigate to System > Diagnostics > Technical Support. Under Technical Support, click Generate Technical Support File to generate an archive (TAR file) of the NetScaler MAS data and statistics, which you can send to Citrix Support for help with debugging an issue.

Configure Dashboard reporting time zone settings

Navigate to System > Analytics Settings. Under Analytics Settings, select Configure Dashboard Reporting Time Zone Settings to set your local time or GMT time zone as the default for the reports displayed on your dashboard.

Configure ICA session timeout

Navigate to System > Analytics Settings. Under Analytics Settings, select Configure ICA Session Timeout and enter the  amount of time for which an ICA session can remain in idle state before being terminated.

Configure analytics features

Navigate to System > Analytics Settings. Under Analytics Settings, select Configure Features to enable mutihop settings and/or adaptive threshold settings.

If you select the Enable Multihop check box, NetScaler MAS collects and correlates the AppFlow records from all appliances deployed with more than one NetScaler appliance between a client and a server.

If you select the Enable Adaptive Threshold check box, a syslog message is sent to the syslog server whenever the number of hits on a URL is greater than it’s threshold value.

Configure database settings

Navigate to System > Analytics Settings. Under Analytics Settings, select Configure Features to enable database index settings and/or database cleanup settings.

By selecting the Enable Database Indexing check box, you can facilitate efficient querying of the NetScaler MAS database.

If you select the Enable Database Cleanup check box, an attempt to clean up the database is repeated if a heavy load on the NetScaler MAS prevents cleanup at its regularly scheduled time.

Configure database cache settings

Navigate to System > Analytics Settings. Under Analytics Settings, select Configure Database Cache Settings to locally store the database content in the cache, so that you can view this content without needing access to the database server.

Configure data record settings

Analytics Settings, select Configure Data Record Settings.

You can enable features for the settings listed here:

  • Data Record Log Settings
  • Data Duration Persistency Settings
  • Web Insight Report Settings
  • Web Insight SLA Data Collection Settings
  • Web Insight URL Data Collection Settings
  • URL Parameter Settings 

Configure SLA Management for specific NetScaler IP addresses

Navigate to System > Analytics Settings > SLA Management. From the list displayed, select the NetScaler IP address of an appliance on which you want to manage SLA over server response time, hits/second, and bandwidth usage.

Configure the duration for which to retain database records for each Insight summarization level

Navigate to System > Analytics Settings > Database Summarization. Specify the duration for which you want to retain Insight data on NetScaler MAS. You can choose to store this data either hourly, daily, and once every minute. 

Add or modify adaptive thresholds

Navigate to System > Analytics Settings > Adaptive Thresholds. Under Adaptive Thresholds, add a new adaptive threshold or edit the settings for an existing adaptive threshold.

The adaptive threshold functionality sets the threshold value for the maximum number of hits on each URL. If the maximum number of hits on a URL is greater than the threshold value set for the URL, a syslog message is sent to an external syslog server. The threshold value interval can be either days or weeks.

Add or modify threshold and alerts

Navigate to System > Analytics Settings > Thresholds. Under Thresholds, add a new threshold or edit the settings for an existing threshold.

You can provide additional action items while creating or modifying a threshold, such as enabling it, sending notifications by email or SMS, or configuring a rule for the threshold.

Upload SSL certificate files and SSL keys

Navigate to System > Advanced Settings > SSL Certificate Files. Under SSL Certificate Files, select the SSL Certificates tab to upload a new SSL certificate.

Similarly, under SSL Certificate Files, select the SSL Keys tab to upload a new SSL key

Add geo database files

Navigate to System > Advanced Settings > Geo Database Files to upload a new geo database file.

View or edit report export schedule/s

Navigate to System > Advanced Settings > Export Schedules. You can then see all the export schedules, with details. You can edit any export schedule from the list displayed here.

Schedule a report export

Navigate to System > Advanced Settings > Export Schedules. To add a new schedule, click the  button on the extreme right, and select the Schedule Export tab. Specify the details and click Schedule.

Use the backup and restore features

Navigate to System > Advanced Settings > Backup Files to create a backup of the current settings of the NetScaler MAS. You can later use these backed up files to restore the NetScaler MAS to the state that you backed up.

Citrix recommends using this feature before performing an upgrade, and in general as a precautionary measure.

Install an SSL certificate

Navigate to System > System Administration. Under Set Up NetScaler MAS, select Install SSL Certificate. You can select a certificate file and SSL key file that are already on the NetScaler MAS virtual appliance, or you can upload the files from your local computer.

You must enter the NetScaler MAS password in the Password field to successfully install the SSL certificate.

Prompt Credentials for Instance Login

Navigate to System Change System Settings. Enable Prompt Credentials for Instance Login to prompt users for their own instance credentials in any configuration operation on NetScaler instances. 

Enable Automatic Data Purge

Navigate to System > System Administration. Under Prune Settings, select System Prune Settings
Select Enable Automatic Data Purge check box to allow NetScaler MAS to purge the data when the disk usage reaches the set threshold value. When this feature is enabled, NetScaler MAS purges data related to events, syslogs, perf reporting, and analytics until disk usage comes below the set threshold value. Click the edit icon to modify the threshold value for disk usage.