Viewing and Modifying Gateway Settings

  1. Click Devices > Access Gateways.

  2. Select one of the following options:

    Option

    Description

    New Cluster

    To create a new cluster of Access Gateways. A cluster can be one or more Access Gateways. See Creating a New Cluster.

    Stop

    To stop an Access Gateway Appliance, select the appliance, then click Stop. You must have physical access to Access Gateway Appliance machine to start it again. To stop an Access Gateway Service, select the service, then click Stop. You can use the Restart option to start Access Gateway Service.

    Restart

    To restart an Access Gateway Appliance, select the appliance, then click Restart. Access Gateway Appliance is stopped, the operating system is rebooted, and then the appliance is started. To stop and start an Access Gateway Service, select it, then click Restart. If Access Gateway Service is already stopped, use Restart to start it.

    Refresh

    To update the list of Access Gateways and the status columns, click Refresh.

  3. Select an Access Gateway, and then select one of the following options:

    Option

    Description

    Assign to Cluster

    To add the selected Access Gateway to a cluster, select Assign to Cluster, then select the cluster. This Access Gateway is reconfigured with the configuration of the primary cluster server.

    Access Gateway Appliance can only be added to a cluster of Access Gateway Appliance. Access Gateway Service can only be added to a cluster of Access Gateway Service.

    Remove from Cluster

    To remove the selected Access Gateway from a cluster, select Remove from Cluster. Access Gateway retains its configuration from the cluster, but no traffic is sent to it until it is reconfigured. You can assign it to a different cluster and have it updated with this cluster’s configuration, or you can delete all of its reverse proxies and start a new configuration.

    Delete

    To remove a selected Access Gateway from the list of servers that can be managed from this Administration Console, select Delete. If Access Gateway is a member of a cluster, you must first remove it from the cluster before deleting it.

    IMPORTANT:When an Access Gateway is deleted from Administration Console, you cannot manage it. To access it again, manually trigger an auto-import.

    Scheduled Restart

    To schedule when a selected Access Gateway must be stopped and then started, select Schedule Restart. On an Access Gateway Appliance, a restart stops the operating system, then starts the operating system and Access Gateway. 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.

    Scheduled Stop

    To schedule when a selected Access Gateway or cluster must be stopped, select Schedule Stop.

    • When you stop an Access Gateway Appliance, you shut down Access Gateway Appliance and the operating system. You must have physical access to the machine to start it again.

    • When you stop an Access Gateway Service, you stop just Access Gateway Service. You can use the Restart option to start it again.

    For more information, see Scheduling a Command.

    Purge List Now

    Click this to purge all objects in the current purge list from the cache of the selected server or cluster.

    Purge All Cache

    Click this to purge the server cache for the selected server or cluster. All cached content is cleared.

    When you change certain configuration 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 configuration changes. If Access Gateways are in a cluster, you need to manage the purge process so your site remains accessible to your users. You must apply 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 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

    • Start Service Provider: Starts Embedded Service Provider (ESP) associated with the selected Access Gateway. ESP is the module within Access Gateway that communicates with Identity Server.

      You must restart ESP whenever you enable or modify logging on Identity Server.

    • Stop Service Provider: Stops ESP associated with the selected Access Gateway.

      When Access Gateway does not function correctly, stop and start ESP before stopping and starting Access Gateway.

    • Restart Service Provider: Restarts ESP associated with the selected Access Gateway.

      When an Access Gateway does not function correctly, restart ESP before stopping and starting Access Gateway.

  4. Use the following links to manage a cluster or an Access Gateway:

    Option

    Description

    Name

    Displays a list of Access Gateways and clusters that you can manage from this Administration Console.

    • To view or modify details of a particular server, click the server name.

    • To view or modify details of a cluster, click the cluster namer.

    Status

    Indicates the configuration status of the clusters and Access Gateways. For more information, see Status 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.

    Alerts

    Indicates whether any alerts have been sent. If the alert count is non-zero, click the count to view more information.

    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 26.2, Viewing the Command Status of Access Gateway.

    Statistics

    Provides a link to the statistic pages.

    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 3.3.1, Configuration Overview.