Integrations

Manage the U-Series Appliance API key

The U-Series Appliance API manages the communication between U-Series Appliances when high availability is used in your environment. The API key enables U-Series Appliances to communicate with each other.

The API key is automatically generated and is available to copy from the Appliance API Keys page.

ℹ️

Note

For security reasons, we recommend that you regenerate the key regularly. Remote appliances using the previous registration code to communicate with this appliance are denied access until the new registration code is copied to that appliance and registered again.

To view this appliance's key details:

1. From the left sidebar, under Integrations, click Appliance API Keys.
2. From This Appliance tab, you can view the API key details for this appliance in the This Appliance Key Details section.
3. To view the registration code:
   • Select the IP address the remote appliance uses to communicate with this appliance from the Select IP Address to Use in Configuration list.
   • The registration code displays in the Registration Code box. Click the Copy button next to the box to copy the code.
4. To create a new API key:
   • Under Regeneration And Settings, click Regenerate Registration Code.
   • Follow step 3 to view and copy the new registration code.

Register a remote appliance

Communication between appliances requires both appliances to be registered with each other.

To register a remote appliance:

1. Open the U-Series Appliance console on the remote appliance first.
2. From the left sidebar, under Integrations, click Appliance API Keys.
3. Click the Register Remote Appliance tab.
4. Add the registration code from the appliance that you want to link to this appliance into the Registration Code from Remote Appliance box.
5. Optionally, enter a short Description for the appliance being registered.
6. Click Register Remote Appliance.
7. Click the This Appliance tab.
8. Select an IP from the Select IP Address to Use in Configuration dropdown.
9. Click the Copy button to the right of the Registration Code box.
10. Go back to the first appliance's console, and go to the Appliance API Keys page again.
11. Click the Register Remote Appliance tab.
12. Paste the registration code from the remote appliance.
13. Optionally, enter a short Description for the appliance being registered.
14. Click Register Remote Appliance.

The registered remote appliance now appears in the Registered Remote Appliance grid at the bottom of the page. To refresh that list at any time, click the Refresh button at the top right of the table.

To view more of the table, to the right of the Appliance API Keys section, click the down arrow to collapse that section.

Set the background network check interval

In the Registered Remote Appliance grid, you might see the word Communicating under the Outgoing Status and Incoming Status headings. You can adjust how often the connected appliances check with each other to make sure they are still connected, as follows:

1. On the This Appliance tab, under the Regeneration And Settings section, enter the number of minutes for the Background Network Check Interval.
2. Click Save Settings.

Set up health event forwarding

You can send alerts from the U-Series Appliance to your BeyondInsight management console for further analysis.

Health events are about the hardware or software services that are generated by your appliance. If you require these events to be integrated with third-party monitoring products, you can forward these events to BeyondInsight.

BeyondInsight has a wide variety of third-party connectors that allow you to integrate your monitoring needs (for example, SNMP, SIEM tools, Microsoft Operations Manager, etc.).

ℹ️

Note

In addition to choosing an option on this page, there must be a Syslog Event Forwarder connector configured from the BeyondInsight Management console so that BeyondInsight can import health events.

To set up health event forwarding:

1. From the left sidebar, under Integrations, click Health Event Forwarding.
2. Select an option:
   • None: No events are forwarded.
   • Local: Forward events to the local BeyondInsight installation.
   • Remote: Forward events to a remote BeyondInsight server, specified by IP Address or DNS Name.
3. If using the Remote option, two additional fields appear. You must export a certificate from the remote server and import the certificate to the local U-Series Appliance.
4. If the remote server is another U-Series Appliance, log in to that U-Series Appliance's website.
   • From the left sidebar, under Security and Compliance, click Certificate Management.
   • Under Export Certificate, enter a password and confirm it, and then click Export and Download Certificate.
   • Import the certificate on the local U-Series Appliance, as follows:
     • From the left sidebar, under Security and Compliance, click Certificate Management.
     • Upload the certificate by dragging the file into the drag and drop box, and entering the password created in the previous step.
   • Return to the Health Event Forwarding page. Under the Remote option, enter a Server Address, and select a Certificate from the list.
5. If the remote server is a software install of BeyondInsight, use the BeyondInsight Configuration Tool to create and export the certificate.
6. Click Save Health Event Forwarding Settings.

You must also create a connector from the BeyondInsight management console, as follows:

1. Log in to BeyondInsight.
2. Navigate to Configuration > General > Connectors.
3. Click Create New Connector +.
4. Enter a Connector Name.
5. Select Syslog Event Forwarder from the Connector Type dropdown.
6. Click Create Connector.
7. Enter the details for the U-Series Appliance, including IP address, protocol, and facility.
8. Expand the Event Filters section.
9. Toggle the General Appliance Health filter to enable it.
10. By default, all severity levels are included. You may select an alternate level if needed.
11. Click Create Connector.

ℹ️

Note

For more information on importing a certificate to the U-Series Appliance, please see Upload SSL Certificate.

Export log files

Log file exporting facilitates making appliance log files available to third-party tools for analysis. The U-Series Appliance can be configured to generate a set of log files and save them to an external location, on a specified schedule.

By default, the Export Log File to Remote Location option is on. When it is turned off, none of the setup options are visible.

ℹ️

Note

The file cannot be saved on the U-Series Appliance.

To set up log file export and authentication:

1. From the left sidebar, under Integrations, click Log File Export.
2. Toggle the Export Log File to Remote Location switch to enable it.
3. Enter a Log File Export Location.
4. If the log file export location requires authentication, check the box.
   • Enter the Log File Export Location Username.
   • (Optional). Enter a Log File Export Location Password.
   • (Optional). Enter the Domain.
   • To verify the authentication, click Test Credentials.
5. Expand the Log Export Options section.
   • Click All Available Logs to export everything.
   • Click Select Logs to Export to export individually checked logs.
6. Expand the Log File Export Schedule section.
   • If using the default Recurring option:
     • Enter the Start Date and Start Time, and then select the Frequency from the dropdown list.
     • If required, toggle the Specify end date option to set an end date and time.
     • Select additional options based on the frequency of the export.
   • Select Immediate for an immediate export. Click the Export Log Files Now button.
   • Select One Time for a single export. Set the Start Date and Start Time.
   • Click Save Log File Export Settings.

ℹ️

Note

At any time after the settings are initially configured, you can click Export Log Files Now to save the log file to the share.