Extend collection with expansion packages (advanced)

Updated

Follow

[ Applies to ] StorageGuard 9.2 and later  /  All supported storage, backup, SAN and cloud systems  /  Windows and Linux deployments

StorageGuard collects a built-in set of configuration data from each platform. A data collection package adds more: the output of a command or REST call, a file's content or metadata, registry entries, or the result of a script. The extra data is collected with every scan, shown on the asset, and available to your custom checks.

Note: This is an advanced feature. Commands and scripts run on your systems with the scan account, so use read-only operations and test them on one system first.

How a package works

A package is a container for one platform type. You set its scope, the systems it runs on, and add resources, the items to collect. Each resource type is available on some platforms only:

Resource type Platforms Collects
REST call Systems scanned through an API, including storage, backup, SAN and cloud The response of one or more read-only REST calls.
Command Systems scanned through a CLI, and hosts The output of a command. The command must exist at the given path.
Shell Script Unix and Linux The output of a script run on the host.
File Content Unix, Linux and Windows The text content of a file.
File Meta Data Unix, Linux and Windows Privileges, ownership, create and modify dates, checksum and size.
Directory Structure Unix, Linux and Windows A directory's folders, signatures, sizes and permissions, optionally recursive.
Registry Entry Windows Values of registry entries matching a pattern.
WMI Query Windows The result of a WMI query.
VB Script, PowerShell Windows The output of a script run on the host.
PowerCLI script VMware ESXi The output of a script run on the ESXi host.

For most types you can also enable an AWK preprocessor that parses the output before StorageGuard stores it.

Create a package

  1. Go to Settings > Scan > Custom Data Collection.
  2. Click +.
  3. Enter the Package name and Author.
  4. Select the package type: Storage System, SAN switch, Backup System, Unix and Linux, Windows, VMware, Management Software or Hyper-Converged Infrastructure.
  5. Under Supported Platforms, select the platforms the package can run on.
  6. Enter a Description and click Save.

Choose which systems it runs on

  1. Right-click the package and select Assign scanned item.
  2. Select the systems using the filters for the package type, then save.
Package type Filter by
Storage systems Sites, storage arrays, storage clusters, CI groups
Backup systems Sites, backup servers, backup clusters, CI groups
SAN switches Sites, SAN switches, CI groups
Hosts Sites, business entities, clusters, hosts, CI groups
VMware (ESXi) Sites, clusters, hosts, dynamic host groups, dynamic CI groups

For hosts, filters add up rather than narrow down. Selecting the site Boston and the business entity ERP includes every Boston host and every ERP host.

Tip: Scope by CI group where you can. Membership is evaluated at run time, so new systems that match the group are picked up automatically. See CI groups.

Add what to collect

  1. Right-click the package and select Manage data collection resource.
  2. Click + and select the resource type.
  3. Enter the details for the type, such as the command and its arguments, the file path, or the REST call.
  4. To parse the output, select Enable Preprocessor (AWK script) and enter the script.
  5. Click Save.

Run it and view the data

  • The package runs as part of every full scan of the systems in its scope.
  • To run it without a full scan, right-click the asset in Assets > Inventory and select Custom collection.
  • To see what was collected, right-click the asset and select View custom Collection.

Manage packages

Action What it does
Edit / Clone / Delete Package Change, copy or remove a package.
Import / Export Package Move packages between StorageGuard servers or share them.
Backup Packages / Restore Packages from Backup Keep a copy of your packages and restore it.

[ Next step ]

Build a custom check on the data you collected.

[ Still need help? ]

Our support team can help with connecting systems and scan setup. Submit a request

Comments

0 comments

Please sign in to leave a comment.