3.2 Starting and Stopping Access Manager Components

Access Manager has three services that can be stopped and started: the Identity Server, the Access Gateway, and the embedded service provider within the Access Gateway. Normally, you do not need to stop and start these services. However, if you need to change certain configuration options, you can be prompted to update the Identity Server or to restart the embedded service provider.

The following sections explain how to update, stop, start, and schedule a restart of the various Access Manager components:

3.2.1 Updating an Identity Server Configuration

Whenever you change an Identity Server configuration, the system prompts you to update the configuration. An Update Servers status is displayed under the Status column on the Servers page. You must click Update Servers to update the configuration so that your changes take effect.

When clicked, this link sends a reconfigure command to all servers that use the configuration. The servers then begin the reconfiguration process. This process occurs without interruption of service to users who are currently logged in.

When you update a configuration, the system blocks inbound requests until the update is complete. The server checks for any current requests being processed. If there are such requests in process, the server waits five seconds and tests again. This process is repeated three times, thus waiting up to fifteen seconds for these requests to be serviced and cleared out. After this period of time, the update process begins. Any remaining requests might have errors.

During the update process, all settings are reloaded with the exception of the base URL. In most cases, user authentications are preserved; however, there are conditions during which some sessions are automatically timed out. These conditions are:

  • A user logged in via an authentication contract that is no longer valid. This occurs if an administrator removes a contract or changes the URI that is used to identify it.

  • A user logged in to a user store that is no longer valid. This occurs if you remove a user store or change its type. Changing the LDAP address to a different directory is not recommended, because the system does not detect the change.

  • A user received authentication from an identity provider that is no longer trusted. This occurs if you remove a trusted identity provider or if the metadata for the provider changed.

Additionally, if you remove a service provider from an identity provider, the identity provider removes the provided authentication to that service provider. This does not cause a timeout of the session to occur.

Changes to the SAML and Liberty protocol profiles can result in the trusted provider having outdated metadata for the Identity Server being reconfigured. This necessitates an update at the other provider and might cause unexpected behavior until that occurs.

  1. In the Administration Console, click Access Manager > Identity Servers, then click the Servers tab.

  2. Select the Identity Server configuration, then click Update Servers.

    This link is available only when you have made changes that require a server update.

3.2.2 Restarting the Identity Server

Starting and stopping an Identity Server terminates active user sessions. These users receive a prompt to log in again.

  1. In the Administration Console, click Access Manager > Identity Servers and select the Identity Server to stop.

  2. Click Stop.

  3. Wait for the Command Status to change from Pending to Complete.

  4. Select the Identity Server, then click Start.

  5. When the Command Status changes to Complete, click Refresh.

    The status icon of the Identity Server should turn green.

3.2.3 Updating the Access Gateway

When a configuration change has been made, but not applied, the Access Gateway is in an Update status on the Access Gateways page. If the Access Gateway is a member of a cluster, the cluster is in an Update All status. You can click Update to apply the configuration change to a single Access Gateway or Update All to apply the configuration change to all members of a cluster.

If the changes have been saved to browser cache, but not to the configuration store, the changes are lost if your session times out before you apply the changes. The Access Gateway remains in an Update status, but when you click Update, there are no changes to apply. If you prefer to update members of a cluster one at a time, it is best to save the changes to the configuration datastore before applying them. Click Edit, then click Save.

When you click Update, three options are displayed:

  • When you have modified services of the Access Gateway, the update option for All Configuration is available. Depending upon what has been modified, updating might cause logged in users to lose data and their connections.

  • When the ESP logging settings have been modified on the Identity Server, the update option for Logging Settings is available. The Logging Settings option causes no interruption in services.

  • If a policy is modified that the server has enabled for a protected resource or a protected resource has a policy enabled or disabled and the policy changes are the only modifications that have occurred, the update option for Policy Settings is available. The Policy Settings option causes no interruption in services.

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:

  • The Identity Server configuration that is used for authentication is changed (Access Gateways > Edit > Reverse Proxy/Authentication, then select a different value for the Identity Server Cluster option).

  • A different reverse proxy is selected to be used for authentication (Access Gateways > Edit > Reverse Proxy/Authentication, then select a different value for the Reverse Proxy option).

  • The protocol or port of the authenticating reverse proxy is modified (Access Gateways > Edit > Reverse Proxy/Authentication > [Name of Reverse Proxy], then change the SSL options or the port options).

  • The published DNS name of the authentication proxy service is modified (Access Gateways > Edit > Reverse Proxy/Authentication > [Name of Reverse Proxy] > [Name of First Proxy Service], then modify the Published DNS Name option).

3.2.4 Restarting the Access Gateway Service Provider

To stop and start the Access Gateway service provider:

  1. In the Administration Console, click Access Manager > Access Gateways, then select the Access Gateway, then click Actions.

  2. Click Service Provider > Restart Service Provider, then click OK.

    In a few seconds, the Health icon of the Access Gateway should turn green.

3.2.5 Starting the Access Gateway Service Provider

When an Access Gateway is removed from a cluster configuration, the embedded service provider is stopped. It should remain stopped until you have reconfigured the Access Gateway. When you have finished the reconfiguration, you should start the embedded service provider.

  1. In the Administration Console, click Access Manager > Access Gateways, then select the Access Gateway, then click Actions.

  2. Click Service Provider > Start Service Provider, then click OK.

    In a few seconds, the Health icon of the Access Gateway should turn green.

3.2.6 Stopping the Access Gateway Service Provider

Stopping the embedded service provider is a quick way to make the Access Gateway inaccessible to users.

  1. In the Administration Console, click Access Manager > Access Gateways, then select the Access Gateway, then click Actions.

  2. Click Service Provider > Stop Service Provider, then click OK.

    In a few seconds, the status icon of the Access Gateway should turn red.

3.2.7 Rebooting the Access Gateway

Rebooting the Access Gateway makes all protected resources unavailable until the Access Gateway returns to a server status of green. The Access Gateway is stopped, and the operating system is rebooted.

  1. In the Administration Console, click Access Manager > Access Gateways, then select the Access Gateway.

  2. Click Reboot.

    In a few minutes, the status icon of the Access Gateway should turn green.

3.2.8 Scheduling a Reboot of the Access Gateway

Rebooting the Access Gateway makes all protected resources unavailable until the Access Gateway returns to a server status of green. Scheduling this event allows you to pick the best time for your resources to be momentarily unavailable.

  1. In the Administration Console, click Access Manager > Access Gateways, select the Access Gateway, then click Actions.

  2. Click Schedule Reboot.

    The following field displays information about the command you are scheduling.

    Type: Displays the type of command that is being scheduled, such as Access Gateway Shutdown, Access Gateway Reboot, Access Gateway Upgrade, Device Configuration.

  3. Fill in the following fields:

    Name Scheduled Command: (Required) Specifies a name for this scheduled command. This name is used in log and trace files.

    Description: (Optional) Provides a field to describe the reason for the command.

    Date & Time: The drop-down menus allow you to select the day, month, year, hour, and minute when the command should execute.

  4. Click OK.

3.2.9 Stopping the Access Gateway

You should stop the Access Gateway only when you plan to turn off the power or to configure boot options for troubleshooting. After you have stopped the Access Gateway, you must have physical access to the machine to start it.

  1. In the Administration Console, click Access Manager > Access Gateways, select the Access Gateway, then click Shutdown.

  2. To confirm the shutdown, click OK.

The machine is physically turned off. Before you start the Access Gateway again, you can modify the boot options on a NetWare Access Gateway. For information about these boot options, see Section 40.3.1, Additional Options During the Boot Process.

3.2.10 Scheduling the Shutdown of the Access Gateway

You should stop the Access Gateway only when you plan to turn off the power or to configure boot options for troubleshooting. After you have stopped the Access Gateway, you must have physical access to the machine to start it. Scheduling this event allows you to pick the best time for the Access Gateway to be unavailable.

  1. In the Administration Console, click Access Manager > Access Gateways, select the Access Gateway, then click Actions.

  2. Click Schedule Shutdown.

    The following field displays 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, Access Gateway Upgrade, Device Configuration.

  3. Fill in the following fields:

    Name Scheduled Command: (Required) Specifies a name for this scheduled command. This name is used in log and trace files.

    Description: (Optional) Provides a field to describe the reason for the command.

    Date & Time: The drop-down menus allow you to select the day, month, year, hour, and minute when the command should execute.

  4. Click OK.

    The machine is turned off when the scheduled command executes.

Before you start the Access Gateway again, you can modify the boot options on a NetWare Access Gateway. For information about these boot options, see Section 40.3.1, Additional Options During the Boot Process.