Configuring the administration endpoint

You can configure the administration (admin) endpoint either by using the Amlen WebUI or by using the REST Administration API.

The admin endpoint allows you to administer and monitor Eclipse Amlen. You can use configuration policies to define which users can perform which administrative and monitoring operations. When you configure the admin endpoint, you can specify the following components:
  • IP Address

    The IPv4 or IPv6 address that the admin endpoint listens on.

    The default value is All.

  • Port

    The port number that the admin endpoint listens on.

    This value must be in the range 2-65535.

    The default value is 9089.

  • Security Profile

    The security profile that the admin endpoint uses.

    Ensure that the security profile already exists.

  • Configuration Policies

    The configuration policies that are applied to the admin endpoint.

    The admin endpoint can have a maximum of 100 configuration policies.

You can also change the admin superuser ID and password.

Configuration policies

Configuration policies define the administrative and monitoring tasks that can be performed by a user, or by a group of users.

When you create a configuration policy, you must specify the following components:
  • Name

    Specifies the name that identifies the configuration policy.

    The name must not have leading or trailing spaces and cannot contain control characters, commas, double quotation marks, backslashes, or equal signs. The first character must not be a number or any of the following special characters: ! # $ % & ' ( ) * + - . / : ; < > ? @

  • Authority
    Specifies the level of authority that is granted to the user, or users, authorized by the configuration policy to perform administrative or monitoring tasks. You must specify at least one of the following levels of authority:
    • Configure

      Grants authority to modify the server configuration.

    • View

      Grants authority to view the server configuration.

    • Monitor

      Grants authority to view monitoring data.

    • Manage

      Grants authority to issue service requests, such as restarting the server

You must also specify at least one of the following filters:
  • User ID

    Specifies the user ID that is granted the administrative and monitoring authorities that are specified in the configuration policy.

    You can use an asterisk (*) at the end of the value to match 0 or more characters.

  • Group ID

    Specifies the group of users that is granted the administrative and monitoring authorities that are specified in the configuration policy.

    You can use an asterisk (*) at the end of the value to match 0 or more characters.

  • Client IP address

    Specifies the client IP addresses that are granted the administrative and monitoring authorities that are specified in the configuration policy.

    The IP address can contain an asterisk (*), or a comma-separated list of IPv4 or IPv6 addresses or ranges. For example, 192.0.2.32, 192.0.0.0, 192.0.2.0-192.0.2.100. The range must be specified from low to high.

    IPv6 addresses must be enclosed in brackets [ ].

  • Certificate Common Name

    Specifies the client certificate common name that must be used for a client to be allowed to use the authorities that are specified in the configuration policy.

    You can use an asterisk (*) at the end of the value to match 0 or more characters.

For more information about configuring the admin endpoint by using the Amlen WebUI, see Configuring the admin endpoint by using the Amlen WebUI.

For more information about configuring the admin endpoint by using the REST Administration API, see Configuring the admin endpoint by using REST Administration APIs.