3.4 Managing General Details of the Access Gateway

The Server Details page allows you to perform general maintenance actions on the selected Access Gateway.

  1. In the Administration Console, click Devices > Access Gateways > [Name of Access Gateway].

  2. Select one of the following options:

    Edit: Click this option to edit the general details of the Access Gateway. See Section 3.4.1, Changing the Name of an Access Gateway and Modifying Other Server Details.

    New IP: Click this action to trigger a scan to detect new IP addresses. This might take some time. If you have used a system utility to add an IP address after you have installed the Access Gateway Service, use this option to update the Access Gateway Service to display the new IP address as a configuration option. For more information about this option, see Section 3.8.5, Adding a New IP Address to the Access Gateway.

    Configuration: Click this option to export the configuration of this Access Gateway or to import the configuration of a saved configuration file. See Section 3.4.2, Exporting and Importing an Access Gateway Configuration.

  3. Click Close.

3.4.1 Changing the Name of an Access Gateway and Modifying Other Server Details

The default name of an Access Gateway is its IP address. You can change this to a more descriptive name as well as modifying other details that can help you identify one Access Gateway from another.

  1. In the Administration Console, click Devices > Access Gateways > [Name of Access Gateway] > Edit.

    Editing Access Gateway details

  2. Modify the values in the following fields:

    Name: Specify the Administration Console display name for the Access Gateway. This is a required field. The default name is the IP address of the Access Gateway. If you modify the name, the name must use alphanumeric characters and can include spaces, hyphens, and underscores.

    Management IP Address: Specify the IP address used to manage the Access Gateway. Select an IP address from the list.

    Port: Specify the port to use for communication with the Administration Console.

    Location: Specify the location of the Access Gateway server. This is optional, but useful if your network has multiple Access Gateway servers.

    Description: Describe the purpose of this Access Gateway. This is optional, but useful if your network has multiple Access Gateways.

  3. Click OK twice, then click Close.

    When you click OK, any changes are immediately applied to the Access Gateway.

3.4.2 Exporting and Importing an Access Gateway Configuration

You can export an existing Access Gateway configuration and its dependent policies, and then import this configuration to a new server. This feature is especially useful for deployments that set up configurations in a staging environment, test and validate the configuration, then want to deploy the configuration on new hardware that exists in the production environment.

IMPORTANT:The export feature is not a backup tool. The export feature is designed to handle configuration information applicable to all members of a cluster, and network IP addresses and DNS names are filtered out during the import. (The server-specific information that is filtered out is the information you set specifically for each member in a cluster.) If you want a copy of all configuration information, including server-specific information, you need to perform a backup. See Backing Up and Restoring in the NetIQ Access Manager Appliance 3.2 SP3 Administration Console Guide

The export feature is not an upgrade tool. You cannot export a configuration from one version of Access Manager and import it into a newer version of Access Manager.

If your Access Gateway is not a member of a cluster and you have configured it to use multiple IP addresses, be aware that the export feature filters out multiple IP addresses and uses only eth0. You need to use the backup utility to save this type of information. If you need to reinstall the machine, leave the Access Gateway configuration in the Administration Console and reinstall the Access Gateway. If you use the same IP address for the Access Gateway, it imports into the Administration Console and inherits the configuration.

When exporting the file, you can select to password-protect the file, which encrypts the file. If you are using the exported file to move an Access Gateway from a staging area to a production area and you need to change the names of the proxy services and DNS names from a staging name to a to a production area and you need to change the names of the proxy services and DNS names from a staging name to a production name, do not select to encrypt the file. You need a simple text file so you can search and replace these names. If you select not to encrypt the file, remember that the file contains sensitive information and protect it accordingly production name, do not select to encrypt the file. You need a simple text file so you can search and replace these names. If you select not to encrypt the file, remember that the file contains sensitive information and protect it accordingly.

Exporting the Configuration

  1. In the Administration Console, click Devices > Access Gateway > [Name of Access Gateway].

  2. Click Configuration > Export.

  3. (Conditional) If you want to encrypt the file, fill in the following fields:

    Password protect: Select this option to encrypt the file.

    Password: Specify a password to use for encrypting the file. When you import the configuration onto another device, you are prompted for this password.

  4. Click OK, then select to save the configuration to a file.

    The filename is the name of the Access Gateway with an xml extension.

  5. Export the policies used by the Access Gateway. In the Administration Console, click Policies > Policies, then either select Name to include all policies or individually select the policies to export.

    You need to export all Access Gateway policies and any Role policies used by the Access Gateway policies.

  6. Click Export and modify the proposed filename if needed.

  7. Click OK, then select to save the policy configurations to a file.

  8. (Conditional) If you have created multiple policy containers, select the next policy container in the list, and repeat Step 5 through Step 7.

    The policies for each container must be saved to a separate export file.