Introduction to the Skylar Compliance SyncPack

Download this manual as a PDF file

This section describes how you can use the "Skylar Compliance" SyncPack to automatically add Skylar One devices to Skylar Compliance (formerly Restorepoint) when those devices are discovered in Skylar One and then sync data for those devices. This SyncPack also collects backup log data from Skylar Compliance.

The "Skylar Compliance" SyncPack uses the "Skylar Compliance" PowerPack.

What Can I Do with this SyncPack?

The "Skylar Compliance" SyncPack contains Skylar Automation (formerly PowerFlow) applications that can automatically add, or "onboard", Skylar One devices to Skylar Compliance when those devices are discovered in Skylar One. You can also use this SyncPack to collect backup log data from Skylar Compliance.

This SyncPack lets you configure the following integrations between Skylar Compliance and Skylar One:

  • Onboard and Sync Devices. The "Skylar Compliance: Sync Devices" application syncs existing Skylar One devices with Skylar Compliance devices. The application also adds new Skylar One devices and their associated elements to Skylar Compliance, including the domain and credential. The application gets details about how the device will be configured in Skylar Compliance, including the assigned agent and device type, from a mapping in the aligned configuration object.
  • Get Logs from Skylar Compliance. The "Skylar Compliance: Get the list of Logs from Skylar Compliance" application queries the Skylar Compliance API to collect backup success and failure logs from Skylar Compliance. These logs are also synced to Skylar One. You can use Skylar Automation to compare the logs to make sure the backups ran successfully in Skylar Compliance.
  • Update credentials from Skylar One. The "Skylar Compliance: Get list of credentials from Skylar One" application queries Skylar One for existing credentials and matches them against credentials in Skylar Compliance. If there is a change to the credential in Skylar One and the credential exists in Skylar Compliance, the credential is updated with the new information.
  • Sync Compliance Logs to Skylar One as Events. The "Skylar Compliance: Gather Compliance Logs from Skylar Compliance" application checks for compliance logs from Skylar Compliance and syncs them to Skylar One to create events for the compliance alerts in Skylar One.
  • Verify correct configuration of Skylar One and Skylar Compliance systems. The "Skylar Compliance: Pre Check Application" application allows you to verify that both the Skylar One and Skylar Compliance systems are correctly configured for device synchronization. It assesses the current onboarding capacity of the Skylar Compliance system, providing visibility into how many additional devices can be registered. Additionally, it performs a comprehensive permissions check on the Skylar One system, identifying any denied permissions that must be enabled to ensure smooth operation of the Skylar Compliance SyncPack.
  • Create or update custom links. The "Skylar Compliance: Create or Update Custom Links" application allows you to create and update custom links within the Skylar One platform. It enables the addition of direct navigation links to Skylar Compliance-onboarded devices from Skylar One device pages, streamlining access and improving operational efficiency. By integrating these links, users can quickly transition from Skylar One to the corresponding Skylar Compliance device, enhancing workflow and reducing navigation time.

For more information about configuring these integrations, see Configuring Applications for the Skylar ComplianceSyncPack.

Contents of the SyncPack

This section lists the contents of the "Skylar Compliance" SyncPack.

Skylar Automation Applications

Before you can use the integrations between Skylar Compliance and Skylar One, you will need to configure the following applications in the "Skylar Compliance" SyncPack:

  • Skylar Compliance: Get list of credentials from Skylar One. This application queries Skylar One for existing credentials and matches them against credentials in Skylar Compliance. If there is a change to the credential in Skylar One and the credential exists in Skylar Compliance, the credential is updated with the new information. For more information, see Configuring the Skylar Compliance: Get list of credentials from Skylar One application.
  • Skylar Compliance: Get the List of Logs from Skylar Compliance. This application queries the Skylar Compliance API to collect backup success and failure logs from Skylar Compliance. You can use Skylar Automation to compare the logs to make sure the backups ran successfully in Skylar Compliance. For more information, see Configuring the Skylar Compliance: Get the List of Logs from Skylar Compliance Application.
  • Skylar Compliance: Sync Devices. This application discovers newly registered Skylar One devices and then triggers the "Skylar Compliance: Onboard Device" application on the discovered device. The "Skylar Compliance: Onboard Device" application adds new devices and the associated elements to Skylar Compliance, and also creates Skylar Compliance custom attributes for the new devices in Skylar One. For more information, see Configuring the Skylar Compliance: Sync Devices Application.
  • Skylar Compliance: Get a list of devices not present in Skylar One. This application retrieves a list of devices that are not present in Skylar One but are present in Skylar Compliance.
  • Skylar Compliance: Gather Compliance Logs from Skylar Compliance. This application checks for compliance logs from Skylar Compliance and syncs them to Skylar One to create events for the compliance alerts in Skylar One. For more information, see Configuring the Skylar Compliance: Gather Compliance Logs from Skylar Compliance Application.
  • Skylar Compliance: Pre Check Application. This application verifies that both the Skylar One and Skylar Compliance systems are correctly configured for device synchronization. It assesses the current onboarding capacity of the Skylar Compliance system, providing visibility into how many additional devices can be registered. Additionally, it performs a comprehensive permissions check on the Skylar One system, identifying any denied permissions that must be enabled to ensure smooth operation of the Skylar Compliance SyncPack. For more information, see Configuring the Skylar Compliance: Pre Check Application.
  • Skylar Compliance: Create or Update Custom Links. This application allows you to create and update custom links within the Skylar One platform. It enables the addition of direct navigation links to Skylar Compliance-onboarded devices from Skylar One device pages, streamlining access and improving operational efficiency. By integrating these links, you can quickly transition from Skylar One to the corresponding Skylar Compliance device, enhancing workflow and reducing navigation time. For more information, see Configuring the Skylar Compliance: Create or Update Custom Links.

Skylar Automation Applications (Internal)

The following applications are "internal" applications that should not be run directly, but are automatically run by applications from the previous list. To view these internal Skylar Automation applications, click the Filter icon () on the Applications page and select Show Hidden Applications. Internal applications are hidden by default.

  • Skylar Compliance: Onboard Device. This application adds new devices and the associated elements to Skylar Compliance, including the domain and credential. This application also creates Skylar Compliance custom attributes for the new devices in Skylar One. The application gets details about how the device will be configured in Skylar Compliance, including the assigned agent and device type, from a mapping in the aligned configuration object. This application is triggered by the "Skylar Compliance: Sync Devices" application.
  • Skylar Compliance: Update Event info in Skylar One. This application populates Skylar One events with log and backup information that is collected from Skylar Compliance. This application is triggered by the "Skylar Compliance: Get the List of Logs from Skylar Compliance" and the "Skylar Compliance: Gather Compliance Logs from Skylar Compliance" applications.

Configuration Object

  • Skylar Compliance Base Config. This configuration object can be used as a template after the SyncPack is installed on the Skylar Automation system. The configuration object includes the following:
  • Details for connecting to the Skylar One API, including the URL, username, and password.
  • Details for connecting to the Skylar Compliance API, including the URL, username, and password.
  • Details for connecting to the Skylar One database, including the URL, username, and password.
  • A mapping between Skylar One Device Class globally unique identifiers (GUIDs) and Skylar Compliance device types.
  • A default value for Skylar Compliance device types.
  • Mapping between Skylar One collector appliance IDs and Skylar Compliance agents.
  • A default backup schedule for all new devices added to Skylar Compliance.
  • An option to add a custom link configuration to Skylar One, a user access URL, a timestamp, and the option to allow device change detection.

Steps

The following steps are included in this SyncPack:

  • Check Skylar One User Access

  • Checking Skylar Compliance API Access and Device Availability

  • Create and Update Skylar Compliance Credential

  • Skylar Compliance: Create Device

  • Create Skylar Compliance Domain

  • Determine the change in Skylar Compliance Logs

  • Skylar Compliance: Enrich Devices with Credentials data

  • Fetch Device Limit from Skylar Compliance

  • Fetch Skylar One Credential Data

  • Filter devices from Skylar One

  • Filter basic/snippet and ssh Skylar One credentials list

  • Select devices from Skylar One

  • Get backup data from Skylar Compliance

  • Get list of Basic/Snippet credentials from Skylar One

  • Get collector group details for list of Skylar One devices

  • Get device class details for list of Skylar One devices

  • Get Device Details from Skylar One

  • Get device id from Skylar One

  • Get device list from Skylar Compliance

  • Get devices from Skylar One

  • Retrieve Skylar Compliance Group Devices

  • Get list of Skylar Compliance credentials

  • Get Plugin Info

  • Get Skylar Compliance Compliance Logs

  • Get Logs from the Skylar Compliance and save in SA cache

  • Get license details from Skylar Compliance

  • Get list of SSH credentials from Skylar One

  • Create or Update Custom Links

  • Insert data in Skylar One database

  • Optional QueryGQL Call Skylar Compliance

  • Select Custom Link

  • Select device id from Skylar One

  • Update Device Event Info

  • Add Skylar Compliance ID custom attribute to Skylar One device

  • Create custom attribute

MCP Components

The following MCP tools and their filters work in conjunction with the MCP server introduced in version 3.4.0 of Skylar Automation. For more information, see the Configuring the Skylar Automation MCP Server chapter in the Skylar Automation manual.

All MCP tools listed below require a config_name that points to a Skylar Automation configuration object with the following fields:

  • restorepoint_url. The hostname or IP address, or full base URL of the Skylar Compliance instance.

  • restorepoint_api_token. The Skylar Compliance API key. This is used with the custom authorization scheme.

  • list_devices. Returns a paginated list of devices from Skylar Compliance.

    • limit. Integer between 1 and 50. Defines results per page. The default value is 10.

    • offset. Integer. The number of results to skip for pagination. The default value is zero.

  • get_device_by_id. Returns a single device.

    • device_id. Integer. Required. Filters to a specific device.

  • list_device_backups_by_type. Returns the history of backups for a device, split by configuration type. Consecutive identical backups are collapsed.

    • device_id. Integer. Required. Filters to a specific device.

    • limit. Integer. Defines the number of backups to look through. The default value is 100.

  • get_device_backup_by_id. Returns the metadata for a single backup.

    • device_id. Integer. Required. The ID of the device.

    • backup_id. Integer. Required. The ID of the backup.

  • get_device_backup. Returns the actual config lines for a specific backup.

    • device_id. Integer. Required. The ID of the device.

    • backup_id. Integer. Required. The ID of the backup.

    • backup_type. String. Required. The configuration type of the backup.

  • compare_backup. Returns a diff between two backups on two (possibly different) devices.

    • device1_id. The ID of the first device.

    • backup1_id. The ID of the first backup.

    • backup1_type. The configuration type of the first backup.

    • device2_id. The ID of the second device.

    • backup2_id. The ID of the second backup.

    • backup2_type. The configuration type of the second backup.

  • list_agents. Returns a paginated list of agents.

    • limit. Integer between 1 and 50. Defines results per page. The default value is 10.

    • offset. Integer. The number of results to skip for pagination. The default value is zero.

  • list_jobs. Returns a paginated list of currently running jobs.

    • limit. Integer between 1 and 50. Defines results per page. The default value is 10.

    • offset. Integer. The number of results to skip for pagination. The default value is zero.

  • get_job_by_id. Returns a single job.

    • job_id. Integer. Required. The ID of the job.

  • list_historic_jobs. Returns a paginated list of historic (completed) jobs.

    • limit. Integer between 1 and 50. Defines results per page. The default value is 10.

    • offset. Integer. The number of results to skip for pagination. The default value is zero.

  • list_logs. Returns a paginated list of system logs.

    • limit. Integer between 1 and 50. Defines results per page. The default value is 10.

    • offset. Integer. The number of results to skip for pagination. The default value is zero.

  • status. Returns the combined system status (appliance, storage, memory, system, High Availability cluster). No additional parameters.

  • get_device_compliance_results. Returns the results of running compliance rules against a device.

    • device_id. Integer. Required. The ID of the device.

  • list_compliance_policies. Returns a paginated list of compliance policies.

    • limit. Integer between 1 and 50. Defines results per page. The default value is 10.

    • offset. Integer. The number of results to skip for pagination. The default value is zero.

  • get_compliance_policy_by_id. Returns a single compliance policy.

    • policy_id. Integer. Required. The ID of the policy.

  • list_plugins. Returns all plugins without pagination. No additional parameters.

  • list_domains. Returns a paginated list of domains.

    • limit. Integer between 1 and 50. Defines results per page. The default value is 10.

    • offset. Integer. The number of results to skip for pagination. The default value is zero.

Paginated tools are offset-based, rather than using cursors. Pass the next offset value to fetch the next page.