Manage agent installation packages

Learn how to create and download installation packages for Snow Inventory Agents for Windows, macOS, Linux, and Unix with Package Builder.

Depending on your Snow Atlas subscription, you will find Package Builder either directly in the Snow Atlas menu or in the Applications menu.

Create installation packages

Before you start creating your package, you should prepare the agent configuration file and any custom files and scripts that you want to upload to the package. You can download configuration file templates from github.com/SnowSoftwareGlobal/agent-configuration-templates-public. For information on custom files and scripts, see Additional files and scripts.

1. In Package Builder, select Create installation package.

2. In the Package details section, enter a name for the installation package.

   The name is used to help you distinguish it from other installation packages. It will not affect the name of any files included in the installation package.

3. In the Product section, select the agent and version for which you want to create an installation package.

   Depending on the selected agent, you may additionally have to select applicable architectures and package types. An installation package will be created for each combination of selected architecture and package type.

4. Optional: In the Scanning modules section, select any additional scanning modules that you want to include in the installation package to give the agent additional capabilities. Available scanning modules depend on the agent selected in the previous step. For some scanning modules, you can select to upload your own file or script instead of including the default one. See Scanning modules for descriptions of all available capabilities and which files and scripts are available for which platforms.

   1. Turn on the toggle for a scanning module section and then select Customize.

   2. Select the scanning modules that you want to include.

   3. Optional (if available): To include your own custom file or script instead of the default one, select Include custom for the applicable file or script and upload your file or script.

      For more information, see Additional files and scripts.

   4. Select Save.

5. In the Files section, do the following:

   1. Upload the configuration file that you have prepared for this installation package.

   2. Optional: Turn on the Upload additional files toggle, and then upload one or more additional files or scripts to give the agent additional capabilities.

      Note that some specific file names are reserved for files and scripts maintained by Snow. You cannot upload files with those names via this field. For more information, see Additional files and scripts.

6. Select Create.

The package is added to the list of packages. The Package status column enables you to keep track of the status of the package, for example, Building or Available for download. For a complete list of package statuses, see Package status.

You can preview the contents of your uploaded files before downloading the package, see Preview or download uploaded files.

For instructions on how to download your created package, see Download installation packages.

Authenticate to build installation packages

If you upload files of another format than XML to a package, additional authentication is required before the package can be built. The status of the package will be set to Pending authorization, and a warning message will appear at the top of the page, prompting you to authenticate yourself before the package can be built. If you have created several packages with the status Pending authorization, they will all be included in the same authentication process.

note

As some file types may run a higher risk of containing malicious content, this is an added security measure to ensure that you are aware of, and take responsibility for, the contents of the files.

To authenticate yourself so that the packages can be built:

1. In the warning message, select Authenticate and build.

2. On the Confirm access page, select Continue.

   An email with a verification code will be sent to you.

3. On the Confirm access page, enter the verification code sent to you, and then select Sign in.

The build process for the packages will now continue.

Preview or download uploaded files

To verify that your installation package contains the correct agent configuration file, as well as other files you may have uploaded to the package, you can preview the contents before downloading the package.

1. In the list of packages, and in the Package name column, select the name of the package.

2. In the Preview of included files view, select a file name from the list of files to view the contents, or download the file via the download icon.

   The configuration file is always displayed by default.

   Files with content other than plain text cannot be previewed but only downloaded.

3. When you have finished your preview, do one of the following:

   • Download the package directly from the preview view: Select Action, and then select Download package.

   • Delete the package directly from the preview view: Select Action, select Delete package, and then confirm the action.

   • Close the view and return to the list of packages.

Download installation packages

You can download packages with the status Available for download.

1. In the list of packages, select the checkboxes for the packages you want to download.

2. Select Actions, and then select Download package.

Delete installation packages

1. In the list of packages, select the checkboxes for the packages you want to delete.

2. Select Actions, and then select Delete package.