-
标题
How to export and import an Alarm Template -
说明
In Foglight 6.1 and higher, Administrator users have the ability to export an Alarm Template from one Foglight Management Server (FMS) and import the alarm template into a different FMS. This capability is present in the base Foglight Management Server, Foglight for Databases, and Foglight Evolve.
It is not possible to import and export the Factory Template via REST API.
-
解决办法
Configure an Auth Token for a Foglight user
1. Navigate to Administration | Users & Security
2. Enter the foglight user name in the User Look Up field and click the Look up button
3. Click the Set Auth Token button
4. Click the Set button in the popup that appears
5. Copy the Auth Token displayed in the middle of the popup and click the Close button
Accessing the Swagger console and applying the Auth-token
1. As the Foglight Administrator account, open a browser window to http://hostname:port/api/openapi/swagger-ui (where the hostname and port is the connection string to the FMS, use the http or https protocol as appropriate for the connection), for example: http://localhost:8080/api/openapi/swagger-ui
2. In the page that appears, click the Authorize button, a popup will appear.
3. If the popup has the word Authorized written beneath the bearerAuth text, click the Logout button.
4. A popup with an empty value field should appear. Paste the Auth-token into the ApiKeyAuth (apiKey) Value field and click the Authorize button.
5. The popup should display with the message "Authorized" and both a Logout and Close button. Click the Close button.
Identifying an Alarm Template to export
1. Find the GET /alarm-templates pulldown option and click the pulldown icon to expand the area
2. Click the Try if out button
3. Click the Execute button
4. A server response should be generated. The results are displayed with a response code indicating if the task is successful. The Responses area below provides a list of the possible responses and meanings.
- A 200 response code indicates that the task was successful. Copy the ID from the response body in the field id. The name of the template is in the "name" field below the id.
- A 401 error code indicates that the task failed because the Auth-token has expired or is involved. If this occurs, repeat the steps above in Configure an Auth Token for a Foglight user and Accessing the Swagger console and applying the Auth-token.
Exporting an Alarm Template
1. Find the GET /alarm-templates/{alarmTemplateID}/export pulldown option and click the pulldown icon to expand the area
2. Click the Try if out button
3. Paste the alarm template's ID copied from the Identifying an Alarm Template to export steps (above) into the alarmTemplateId field.
4. Click the Execute button
5. A server response should be generated. The results are displayed with a response code indicating if the task is successful. The Responses area below provides a list of the possible responses and meanings.
- A 200 response code indicates that the task was successful. Click the copy icon in the bottom right corner of the panel. The content can be pasted into text file for later use or transfer to a different server.
- A 401 error code indicates that the task failed because the Auth-token has expired or is involved. If this occurs, repeat the steps above in Configure an Auth Token for a Foglight user and Accessing the Swagger console and applying the Auth-token.
Importing an Alarm Template
1. On the destination FMS, find the GET /alarm-templates/import pulldown option and click the pulldown icon to expand the area.
2. Click the Try it Out button
3. Clear out any current text in the request body and replace it with the copied text
4. Click the Execute button
It will take a few moments for the imported file to be loaded.
5. A server response should be generated below the Curl response box (this may be far down the page).
The results are displayed with a response code indicating if the task is successful. The Responses area below provides a list of the possible responses and meanings.- A 200 response code indicates that the task was successful and the template has been imported. If the template has been imported into a FMS that already had a template with same ID, this template will be updated to use the imported template.
- A 401 error code indicates that the task failed because the Auth-token has expired or is involved. If this occurs, repeat the steps above in Configure an Auth Token for a Foglight user and Accessing the Swagger console and applying the Auth-token.
6. In Foglight, navigate to Alarm Management | Alarm Templates. The imported template should be visible in the Alarm Templates list.
- A 200 response code indicates that the task was successful. Copy the ID from the response body in the field id. The name of the template is in the "name" field below the id.