Link Search Menu Expand Document

Community

The Community section allows Addigy partners to contribute to one another. When submitting a Custom Fact or Custom Script to the Community, the fact will be reviewed by the Addigy Community team before being published to the community. If you have questions about the Addigy Community or submitting your fact, please get in touch with us at community@addigy.com.

  1. Device Facts
  2. Scripts
  3. Community Submission Guidelines
  4. Reporting Community Device Facts

Device Facts

Device Facts are queries that you can run against your devices to retrieve and store just about any kind of data. The facts here have been contributed by the Addigy community and can be copied to your catalog.

Community Facts can be reviewed by:

  • Highest Rated
  • Most Copied
  • Newest
  • Most Voted
  • Searched

Once a Community Fact is copied to your catalog it will not be linked to any other fact and needs to be added to a Policy to collect data.

Scripts

Device Scripts are commands that you can run against your devices to execute or perform a task. These scripts were submitted to the community by other admins. You can copy them to your scripts collection and run them against one or more devices in your devices list.

Community Scripts can be reviewed by:

  • Highest Rated
  • Most Copied
  • Newest
  • Most Voted
  • Searched

Once a Community Script is copied to your catalog it will not be linked to any other script and needs to be executed or associated to a maintenance or alert to perform an action.

Community Submission Guidelines

Here are the guidelines used to approve or reject all Custom Fact submissions:

  • The Name and Description should demonstrate the value the fact may bring to other members of the community.
  • The description must accurately describe what results should be expected from the fact and how those results were collected.
  • The fact should be read-only. The script should not save files to the machine, edit settings, or interfere with running processes. Exceptions can be made for logging but should be clearly stated in the description.
  • The fact cannot use a modified hashbang. For Bash-based facts, the script should use #!/bin/bash. For Python-based facts, the script should use #!/usr/bin/python.
  • The fact should run without error on all Addigy-supported major versions of the OSes Supported (see Addigy System Requirements).
  • The description must include “Known Limitations”, a list of requirements and dependencies to function properly. If there are no known limitations on the supported OSes, that must still be indicated. Ie., “Known Limitations: no known limitations.”

Examples of known limitations:

  • The fact requires specific software installed on devices.
  • The fact requires certain utilities or features not present on specific versions of an OS.
  • The fact requires a specific account or connection to be configured or logged-in.
  • The script should run without error on all major versions of the OSes Supported. Please see our Best Practices and Examples of Custom Facts to better understand avoiding errors.
  • The fact must not upload or escrow data to other sites, locations, or servers outside of Addigy.
  • The fact must not rely on settings or infrastructure unique to your organization.

Reporting Community Device Facts

If you find a Community Device Fact that does not meet these guidelines, please let us know by using the Report button. The Addigy Community team will review your report and, if necessary, will remove the item from the community and contact the author.


Copyright © 2022 Addigy.