Legal Disclaimer: The resource assets in this website may include abbreviated and/or legacy terminology for HPE Aruba Networking products. See www.arubanetworks.com for current and complete HPE Aruba Networking product lines and names.

Extensions Management

You can create and manage multiple ClearPass Extensions. ClearPass Extensions are self-contained micro-services that can run on top of the ClearPass platform and provide access to some features that are not yet part of the current ClearPass version. ClearPass Extensions are easy to install from the ClearPass Extensions Store. In a cluster Group of independent servers connected through a dedicated network that act as a single system, allowing high availability and load balancing. Resources in a cluster are dynamically assigned., ClearPass Extensions can be installed on a subscriber Server in a cluster that “subscribes” to the publisher to receive updated database information. As redundant servers, subscribers improve performance through load balancing, and provide failover and high availability. Sometimes referred to as a node. independently of the publisher Required server in a cluster. Each cluster can have only one publisher; it is the first server installed on the cluster. The publisher provides database services to the subscribers in the cluster..

To view Page in the application that displays data but does not contain interactive fields the user can modify. Usually a table listing things like accounts or other sets of data and providing links to related actions or forms. and work with the list of ClearPass Extensions and to install and configure new ClearPass Extensions, go to Guest > Administration > Extensions. The Manage Extensions list view opens. All ClearPass Extensions that have been installed are included in the list. Information shown for each ClearPass Extension Self-contained microservice that can run on top of the ClearPass platform and provide access to some features that are not yet part of the current ClearPass version -- for example, custom features developed for a ClearPass customer or by a partner or customer. includes its name, version, state, hostname, and IP address.

The states that may be shown for an Extension in the list are as follows:

Running — The ClearPass Extension is currently running.

Stopped — The ClearPass Extension has been administratively stopped and is not running. This is the normal stopped state and indicates the ClearPass administrator manually stopped the Extension, either by using the Stop option for the Extension or by the equivalent API Application Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software. call.

Exited — The ClearPass Extension is not running and stopped running due to a non-administrative stop. The exit code can be viewed in the Extension Details window. A stopped Extension will be in the exited state if it stopped for any reason other than the administrator stopping it — for example, if the system abruptly stopped working due to an out-of-memory error.

Restarting — The ClearPass Extension is currently restarting. When the ClearPass Extension last exited and the exit code that it exited with can be viewed in the Extension Details window.

Figure 1 The Manage Extensions List View

You can click a ClearPass Extension’s row in the list for additional options:

Options in the Manage Extensions List View
Field	Description
Name	The name of the ClearPass Extension.
Version	The version number of the ClearPass Extension.
State	The ClearPass Extension’s current state, either Running or Not Running.
Hostname	The hostname for the ClearPass Extension.
IP Address	The IPv4 address used for the ClearPass Extension. This address will be within the network range 172.17.0.1/16.
Filter	Lets you filter for a ClearPass Extension by name, version, state, hostname, or IP address.
Show Details	Displays details for the ClearPass Extension such as its state, instance ID, store ID, and any content items.
About	Opens user documentation for the extension in a new browser tab.
Start	Starts a stopped ClearPass Extension.
Stop	Stops a running ClearPass Extension.
Restart	Stops and restarts a running ClearPass Extension.
Delete	Deletes the ClearPass Extension. You will be asked to confirm the deletion.
Reinstall	Opens the Extension Reinstall form Interactive page in the application where users can provide or modify data., which lets you delete and then reinstall the ClearPass Extension. You may also modify the IP address. When it is reinstalled, it retains its previous configuration and includes any current Extension Store updates for the Extension. After it is reinstalled, the Extension’s details show the time it was installed.
Check for Upgrades	To check for upgrades for a ClearPass Extension, click this link in the upper right corner. ClearPass checks for the latest available upgrades and the list is refreshed with the information. If an upgrade is available for an extension, a blue "Up" arrow is shown next to the extension's version number and the options for the extension include the Upgrade option.
Upgrade	The form expands to include the Extension Upgrade form with information about the new version and the option to install the upgrade. See Upgrading Extensions.
Show Logs	Displays log messages for ClearPass Extensions' actions and various Extension-related actions. You can use the drop-down list below the log to change how often to automatically reload the latest log output for the extension you are viewing. This setting can be different for each extension, and is not saved when you move away from the extension. Options include: Auto-refresh off — (Default) If selected, click the Show Logs link each time you want to see the latest log updates. Auto-refresh 3s — Displays updates every three seconds. Auto-refresh 5s — Displays updates every five seconds. Auto-refresh 10s — Displays updates every ten seconds. Auto-refresh 30s — Displays updates every thirty seconds.
Configuration	The form expands to include the Extension Configuration form with the ClearPass Extension’s current configuration parameters, if any. If you modify the default configuration, you must then select the Restart extension after updating configuration check box in order to have the changes take effect, and then click Save Changes. A progress bar is displayed while the ClearPass Extension is being restarted. (Optional) You may also specify whether the extension should be restarted after the ClearPass server restarts by adding the "restartPolicy" parameter with one of the following values: "restartPolicy": "no" — The extension will not be automatically restarted after the server is restarted. "restartPolicy": "always" — The extension will always be restarted after the server is restarted. "restartPolicy": "unless-stopped" — The extension will be restarted unless it was stopped prior to the server restart, in which case it will maintain that state. "restartPolicy": "on-failure:N" — If the extension fails to restart, the value for "N" specifies the number of times the extension should try to restart. If you do not provide a value for "N", the default value will be "0". The "restartPolicy" parameter is not present by default in extension configurations. When it is not present, if the system is restarted a default policy is applied to the extension to maintain the state it was in before the restart. If the "restartPolicy" parameter is added to the configuration but later removed, the extension will then revert to the default restart policy.
Note	The form expands to show the Extension Note form. Administrators can use this form to add any useful information they might want to save about the extension. The first part of the note text will be displayed underneath the name of the extension in the Manage Extensions list, and can be clicked to display the entire note.
Install extension	To install a ClearPass Extension, click this link in the list or in the upper right corner. The initial setup page of the Install Extension form opens. See Installing Extensions.
Refresh	Clears any filter selections and refreshes the full list of installed ClearPass Extensions.