SnipeAgent - A Windows agent for Snipe-IT
Installation
- Download and install the latest .msi installer from the releases tab.
- By default, the program will be installed in Program Files (x86)/Snipe-IT/SnipeAgent. Edit the SnipeAgent.exe.config file to include your API key and BaseURI from the default values to the ones given by your Snipe-IT instance.
- Set the Company and Location parameters in SnipeAgent.exe.config, then run the .exe.
Features
- The agent creates an asset and fills out the fields:
- Asset name (currently machine hostname, unless agent is run in interactive mode)
- Asset id (Asset tag prefix + serial number)
- Location (from a config file or the Organizational Unit)
- Warranty (from config file)
- Status label (from config file)
- Mac address
- Make, model of the machine (as reported to Windows)
- Ensures that the assets created is unique
- New locations, makes, models are created as needed
Getting started
You will need a working Snipe-IT database with API access and an API key.
We recommend creating a separate user for the agent with minimal (read + add) permissions.
You can run it via a GPO or Scheduled task (recommended way is to run the agent once on boot with a delay of 1+ minute). Note: Currently investigating running as service using http://nssm.cc/description.
Developer Guide
If you want to not only use SnipeAgent.exe, but edit the sources and build the project, here are some steps for getting started. SnipeAgent has a dependency on our specific fork of SnipeSharp, so you will need to build it as well.
- Create a development folder. Inside this folder, clone the following repos:
- Open the SnipeSharp project .sln, and build the solution.
- Open the SnipeAgent project. Check the 'references' under the SnipeAgent project, and see if SnipeSharp has been added automatically. Make sure that the path of the SnipeSharp reference points to the repository you just built. If a reference does not exist, you may need to add it manually.
- Build the SnipeSharp project. It should build correctly - if there are any errors at this stage please file a bug report.
- You can now proceed to edit the config file so that your API key and BaseURI correspond to your Snipe-IT instance. Once the config file is set, the program can be run.
Bug Reports & Feature Requests
We welcome community participation in this project. Please submit an issue or pull request to participate in the development.
License
This project is licensed under the Apache 2.0 License
Planned features
- Install as Windows Service
- Collect API Key and other information during setup, allow parameter passthrough during install to .msi for distribution through SCCM and other software management tools
Acknowledgments