The following sections contain information about settings available with Access Gateways, changing the settings, and their impact on users:
Use the Servers page to view the status of Access Gateways, to modify their configuration, and to perform other actions such as creating a new cluster or stopping and starting an Access Gateway or its Embedded Service Provider.
Click Devices > Access Gateways.
Select one of the following:
Stop: To stop an Access Gateway , select the service, then click Stop. You can use the Restart option to start Access Gateway .
Restart: To stop and start an Access Gateway , select it, then click Restart. If Access Gateway is already stopped, use Restart to start it.
Refresh: To update the list of Access Gateways and the status columns (Status, Health, Alerts, Commands), click Refresh.
To perform an action available in the Actions drop-down menu, select an Access Gateway, then select one of the following:
Schedule Restart: To schedule when the selected Access Gateway must be stopped and then started, select Schedule Restart. On an Access Gateway Service, a restart stops Access Gateway Service, then starts it. For information about how to schedule this command, see Scheduling a Command.
Schedule Stop: To schedule when the selected Access Gateway or cluster must be stopped, select Schedule Stop.
You can use the Restart option to start it again.
For more information about how to schedule this command, see Scheduling a Command
Purge List Now: Click Purge List Now to cause all objects in the current purge list to be purged from the cache of the selected server or cluster.
Purge All Cache: Click Purge All Cache to purge the server cache for the selected server or cluster. All cached content is lost.
When you make certain configuration changes such as updating or changing certificates, changing the IP addresses of web servers, or modifying the rewriter configuration, you are prompted to purge the cache. The cached objects must be updated for users to see the effects of such configuration changes. If your Access Gateways are in a cluster, you need to manage the purge process so your site remains accessible to your users. You must apply the configuration changes to one member of a cluster. When its status returns to healthy and current, issue the command to purge its cache. Then apply the changes to the next cluster member.
IMPORTANT:Do not issue a purge cache command when an Access Gateway has a pending configuration change. Wait until the configuration change is complete.
Update Health from Server: Click this action to send a request to the server for updated health information. If you have selected multiple servers, a request is sent to each one. The health status changes to an animated circle until the reply returns.
Service Provider: Select one of the following actions:
Start Service Provider: To start the Embedded Service Provider associated with the selected Access Gateway, click Start Service Provider. The Embedded Service Provider is the module within Access Gateway that communicates with Identity Server.
The service provider must be restarted whenever you enable or modify logging on Identity Server.
Stop Service Provider: To stop the Embedded Service Provider associated with the selected Access Gateway, click Stop Service Provider. The Embedded Service Provider is the module within Access Gateway that communicates with Identity Server.
When an Access Gateway is not functioning correctly, you must always try stopping and starting the service provider before stopping and starting Access Gateway.
Restart Service Provider: To restart the Embedded Service Provider associated with the selected Access Gateway, click Restart Service Provider. This command stops the Embedded Service Provider and then starts it. The Embedded Service Provider is the module within Access Gateway that communicates with Identity Server.
When an Access Gateway is not functioning correctly, you must always try restarting the service provider before stopping and starting Access Gateway.
Use the following links to manage a cluster or an Access Gateway.
Name: Displays a list of Access Gateway servers and the clusters that can be managed from this Administration Console.
To view or modify the general details of a particular server, click the name of the server.
To view or modify general details of a cluster, click the name of the cluster.
Status: Indicates the configuration status of the clusters and Access Gateways. Possible states are pending, update, current, and update all. For more information, see Configuration Options.
Health: Indicates whether a cluster or an Access Gateway is functional. Click the icon to view additional information about the operational status of an Access Gateway.
For information about the health of a specific Access Gateway, click the health icon on Access Gateway row. For more information, see Section 25.4.1, Monitoring the Health of an Access Gateway.
For information about the health of a Access Gateway cluster, click the health icon on the cluster row. For more information, see Section 25.4.2, Monitoring the Health of an Access Gateway Cluster.
Alerts: Indicates whether any alerts have been sent. If the alert count is non-zero, click the count to view more information.
For information about the alerts of a specific Access Gateway, click the link on Access Gateway row. For more information, see Section 26.2.1, Viewing Access Gateway Alerts.
For information about the alerts sent to the cluster, click the link on the cluster row. For more information, see Section 26.2.2, Viewing Access Gateway Cluster Alerts.
Commands: Indicates the status of the last executed command and whether any commands are pending. Click the link to view more information. For more information, see Section 24.2, Viewing the Command Status of Access Gateway.
Statistics: Provides a link to the statistic pages.
For information about the statistics of a specific Access Gateway, click the View link on Access Gateway row and see Section 23.2.1, Monitoring Access Gateway Statistics.
For information about statistics sent to the cluster, click the View link on the cluster row and see Section 23.2.2, Monitoring Access Gateway Cluster Statistics.
Edit: Provides a link to the configuration page. If the server belongs to a cluster, the Edit link appears on the cluster row. Otherwise, the link is on the server row. See Section 4.2.1, Configuration Overview.
Use the information in this section to modify the Status options described in Step 4.
Click Devices > Access Gateways.
View the Status column and make changes as necessary.
Status |
Description |
---|---|
Current |
Indicates that all configuration changes have been applied. |
Update |
Indicates that a configuration change has been made, but not applied. To apply the changes, click the Update link, then select one of the following:.
|
Update All |
This link is available when a server belongs to a cluster. You can select to update all the servers at the same time, or you can select to update them one at a time. If the modification is a policy or a logging change, then use Update All. If the modification is a configuration change, we recommend that you update the servers one at a time.
When you make the following configuration changes, the Update All option is the only option available and your site will be unavailable while the update occurs:
For more information, see Applying Changes to Access Gateway Cluster Members. |
Update |
If the configuration update contains a configuration error, the Update link is disabled and the Configuration Error icon is displayed. Click the icon to discover which objects have been misconfigured. You need to fix the error by either canceling or modifying the changes before you can perform an update. |
Update All |
If the configuration update contains a configuration error, the Update All and the member Update links are disabled and the Configuration Error icon is displayed. Click the icon to discover which objects have been misconfigured. You need to fix the error by either canceling or modifying the changes before you can perform an update. |
Pending |
Indicates that the server is processing a configuration change, but has not completed the process. |
Locked |
Indicates that another administrator is making configuration changes. Before you proceed with any configuration changes, you need to coordinate with this administrator and wait until Access Gateway has been updated with the other administrator’s changes. |
Use the Schedule New Command page to schedule a command, such as a shutdown, restart, or upgrade.
Click Devices > Access Gateways.
(Conditional) To schedule a shutdown or restart, select a server, then click Actions > Schedule Restart or Schedule Stop. Continue with Step 3.
Fill in the following fields:
Name Scheduled Command: (Required) Specify a name for this scheduled command. This name is used in log files.
Description: (Optional) Specify a reason for the command.
Date & Time: Select the day, month, year, hour, and minute when the command must execute.
The following fields display information about the command you are scheduling:
Type: Displays the type of command that is being scheduled, such as Access Gateway Shutdown, Access Gateway Restart, or Access Gateway Upgrade.
Server: Displays the name of the server that the command is being scheduled for.
Click OK to schedule the command.