Manual Agent Installation
Recommended for: Testing on a single / small number of computers.
Instructions:
- Follow these instructions if you wish to test the agent on a limited number of computers. For company wide deployments, the recommended best practice is to use Domain Login Scripts or Active Directory GPO.
- Download the agent setup file and save it to your computer.
- When the download completes, click on the “Run” to launch the agent setup wizard.
- Click on the “I Agree” to accept the license agreement.
- You will see this screen:
- What's my account name? you selected a name for your account when you signed up for SAManage.
Click here to learn how to find your account name.
- Click next, verify the installation folder, and click “install”.
- Installation is now complete. Your inventory will appear in your online account in a couple of minutes.
Using Domain Logon Scripts
Recommended for: Enterprise deployment (Windows).
You can use Domain Logon Scripts to automatically deploy the SAManage agent on all computers that log into the domain. Important: Your local user accounts must have local administrator rights on their computers to use the domain logon script procedure.
Instructions:
- Download the agent setup file and save it to a shared network folder (for example NETLOGON).
- Modify your existing domain logon script, or use the script below. The script runs when a computer logs into the domain, checks if the agent was not previously deployed, and deploys the agent:
@echo off
REM === Agent already installed on the computer? ==============================
if exist "C:\Program Files\SAManage\*.EXE" goto END
REM === Installing agent in silent mode =======================================
\\SERVER\FOLDER\SAMagent_4036.exe /TAG:ACCOUNTNAME /force /s /nosplash /debug
REM === Script done ======================================================
:END
exit
- Modify the relevant values as follows:
- SERVER and FOLDER are your server name and shared folder name (for example \\SERVER\NETLOGON). Verify that the agent setup file is located on the shared folder.
- ACCOUNTNAME is the name you selected for your SAManage account when you signed up to use the service. For instructions how to find your account name, click here.
Agent command line parameters:
- /PNUM:PORT NUMBER - instruct the agent to use a different outbound communication port.
- /S /NOSPLASH - performs silent install and hides the splash screen.
- /NP - No-Proxy - bypass Internet Explorer proxy setting.
- /DEBUG - writes a local log file (hostname.log) in the agent's directory.
- /FORCE - forces the agent to run an inventory update immediately following deployment.
Using Active Directory Group Policy
Recommended for: Enterprise deployment (Windows).
You can use Active Directory GPO to configure the group policy applied to a domain so that the SAManage agent is automatically deployed to all computers that join the domain.
Instructions:
- Open the “Active Directory users and computers tool” (Start | Programs | Administrative tools | Active directory users and computers).
- Right click on your Active Directory Domain (or Organizational Unit) and select “properties”. (STEP 1)
- Click the “Group Policy” tab, create a new policy, or edit an existing policy. (STEP 2, STEP 3)
Click on the image above to enlarge
- Expand "Computer Configuration" and "Windows Settings", select Scripts (Startup / Shutdown). (STEP 4)
- Double click on the Startup option. (STEP 5)
- Click on Show Files in the Startup Properties dialog box. (STEP 6)
- Download the agent setup file and save it to a shared network folder (for example NETLOGON).
- Create a new batch file that will deploy the agent on the computer that joins the domain, if the agent was not previously deployed. Here is an example:
@echo off
REM === Agent already installed on the computer? ==============================
if exist "C:\Program Files\SAManage\*.EXE" goto END
REM === Installing agent in silent mode =======================================
\\SERVER\FOLDER\SAMagent_4036.exe /TAG:ACCOUNTNAME /force /s /nosplash /debug
REM === End of script =====================================================
:END
exit
Modify the relevant values as follows:
- SERVER and FOLDER are your server name and shared folder name (for example \\SERVER\NETLOGON). Verify that the agent setup file is located on the shared folder.
- ACCOUNTNAME is the name you selected for your SAManage account when you signed up to use the service. For instructions how to find your account name, click here.
- Save the batch file on your desktop as deploySAM.bat
- Copy and paste the deploySAM.bat from your desktop to the Script Startup Folder. (STEP 7)
- In the Startup Properties dialog box, click Add. (STEP 8)
- In the Add a Script dialog box, click Browse. (STEP 9)
- Select the deploySAM.bat batch file and click Open. (STEP 10)
- Click OK on the Add a Script dialog box, OK on the Startup Properties dialog box and close all open dialogs and the Active Directory snap-in. When the computer starts, the deploySAM.bat will execute and deploy the agent if it was not previously installed on the local computer.
Click on the image above to enlarge
For additional information:
Agent command line parameters:
- /PNUM:PORT NUMBER - instruct the agent to use a different outbound communication port.
- /S /NOSPLASH - performs silent install and hides the splash screen.
- /NP - No-Proxy - bypass Internet Explorer proxy setting.
- /DEBUG - writes a local log file (hostname.log) in the agent's directory.
- /FORCE - forces the agent to run an inventory update immediately following deployment.
Using Microsoft PsTools / PsExec
Recommended for: Enterprise deployment (Windows)
The Microsoft PsExec tool (part of the PSTOOLS suite from Microsoft) can help automate the agent deployment across all your computers. PsExec is best used together with the domain logon scripts method. Combining the two, all computers that are currently connected to your domain would get the agent installed using PsExec, while the remaining computers would get the agent installed the next time they login to the domain by using the domain logon script.
The process uses the PsExec tool to remotely login to all computers in your domain, and run a batch file from the shared network folder. The batch file installs the agent locally using the silent install option (no user intervention required).
Instructions:
- SERVER and FOLDER are your server name and shared folder name (for example \\SERVER\NETLOGON). Verify that the agent setup file is located on the shared folder.
- ACCOUNTNAME is the name you selected for your SAManage account when you signed up to use the service. For instructions how to find your account name, click here.
- Save the batch file to a shared folder on your network (for example \SERVER\NETLOGON). Lets call the batch deploySAM.bat. Please note that the path used should be defined as a UNC path.
- Open a dos window and launch the PsExec Tool - here are a few usage examples:
* Install on all computers currently logged in your domain:
PsExec \\* -s \\Server\NetLogon\deploySAM.bat
* install on a single computer:
PsExec \\COMPUTER_NAME -s \\Server\NetLogon\deploySAM.bat
* Install on all computers using the domain administrator credentials:
PsExec \\* -s -u Domain\Administrator -p Password \\Server\NetLogon\deploySAM.bat
* Install on specific computers (ALL.TXT is a text file that lists target computer names, one per line), using domain administrator credentials:
PsExec @ALL.TXT -s -u Domain\Administrator -p Password \\Server\NetLogon\deploySAM.bat
When doing mass deployment on multiple computers you can monitor the response file to get a list of computers that were not deployed successfully, and run the PsExec multiple times throughout the business hours to make sure all your computers are getting installed. Supplement this with adding the batch file to your domain logon scripts and you'll ensure that all existing and new computers on your network are getting deployed.
For additional information:
http://technet.microsoft.com/en-us/sysinternals/bb897553.aspx
Credits to: Michael Fafel,
Systems Administrator -
Heywood Hospital
E-Mailing your users
Recommended for: Enterprise deployment (when Domain / Active Directory GPO is not available).
Instructions:
This manual activation procedure is based on sending an email asking your users to manually install the agent. Please note that you need to replace ACCOUNTNAME with the account name you chose when you signed up for SAManage. For instructions how to find your account name, click here.
----COPY & PASTE---->>>
Hi There,
We are rolling out an on-demand IT Asset Management service from SAManage and we need your help to complete this manual procedure:
- Download the software by clicking on this link www.SAManage.com/app/install_agent.html
- Save the software to your local computer.
- When the download completes, launch the software by double clicking on the downloaded file.
- Click Next>
- Click I Agree
- In the "Account Name" field, type ACCOUNTNAME
- Click Next>
- Click Install
- Wait for the installer to finish and click Finish
- You're done - thank you.
----COPY & PASTE---->>>
Using patch/software distribution tools
Recommended for: Enterprise deployment
Instructions:
- Software distribution tools (such as Microsoft SMS) are an effective way to deploy the agent across your computers.
- Create a new advertisement for the agent package, and configure it as an "ongoing advertisement" that checks for the existences of a local agent using the \program files\SAManage folder (see Domain Logon Scripts example).
- Download the setup file and save it to your local disk.
- Here is an example for the SAMagent setup command line:
SAMagent_4036.exe /TAG:ACCOUNTNAME /s /nosplash /debug /force
- Important: Replace ACCOUNTNAME with the name you selected for your account when you signed up for SAManage. For instructions how to find your account name, click here.
- Please verify that you are installing the agent using local administrator credentials.
- You are ready to deploy the agents across your computers.
Agent command line parameters:
- /PNUM:PORT NUMBER - instruct the agent to use a different outbound communication port.
- /S /NOSPLASH - performs silent install and hides the splash screen.
- /NP - No-Proxy - bypass Internet Explorer proxy setting.
- /DEBUG - writes a local log file (hostname.log) in the agent's directory.
- /FORCE - forces the agent to run an inventory update immediately following deployment.
Deploying on Linux
Supported platforms: REDHAT (4 & 5), Fedora
Install Instructions:
Download: Download the agent package here
Requirements:
- dmidecode version 2.2 or higher
- PERL 5.6 or higher
- Perl module XML::Simple version 2.12 or higher
- Perl module Compress::Zlib version 1.33 or higher
- Perl module Net::IP version 1.21 or higher
- Perl module LWP::UserAgent version 5.800 or higher
- Perl module Digest::MD5 version 2.33 or higher
- Perl Module Net::SSLeay version 1.25 or higher
- Make utility
- C/C++ compiler like GNU GCC
To install the agent, you must logon as root and run the installer "sh setup.sh" and follow the instructions.
The Installer does the following:
- Ensure your computer runs every needed components. If there are missing
components, setup is able to install them (EXCEPT if those components also
require others components).
- Build and install ipdiscover binary.
- Build and install Agent's perl module. Agent's perl script
ocsinventory-client.pl goes in /usr/sbin.
- Put a link "ocsinv" into "/bin" to allow you to run agent manually.
- Create "/etc/ocsinventory-client" configuration directory and ask for configuration parameters.
- Create directory "/var/log/ocsinventory-client" to allow agent storing logs
here and add a log rotation directive into /etc/logrotate.d.
- Add a crontab task into "/etc/cron.d" to run agent every day.
By default, the installer runs in user interactive mode, but you can also launch the script
setup.sh in silent mode (without user interaction) if you provide the following command
line parameters:
- Param 1 must be 1 to enable setup of missing dependencies (dmidecode, perl), 0 to disable.
- Param 2 must be SAManage server address (inventory.SAManage.com).
- Param 3 (optional) can be an alternate server port (the default port is 80).
- Param 4 (optional) can be 1 to enable autoupdate, 0 to disable (enabled by
default).
- Param 5 must be your company SAManage account ID between quotes (required). Account ID is the name you selected for your account when you signed up for SAManage. Click here to learn how to find your account name.
Example: sh setup.sh 1 inventory.samanage.com "my-account"
The installer exits with code 0 if no errors were found, returns code 1 if errors were found during dependencies installation, or 2 if errors were found while installing the agent.
Credits: Pascal DANEK
Unix general agent
Supported Platforms:
* FreeBSD 6.1-CURRENT (x86)
* OpenBSD 3.8 (x86)
* NetBSD 2.0.2 (x86)
* Solaris 9 (x86)
Download: Download the agent package here
Requirements:
You should have a copy of the following tools (libraries and header
files) to compile the agent:
* libcurl (http://curl.haxx.se/)
* libxml2 (http://www.xmlsoft.org)
* libz (http://www.zlib.net)
* GCC C compiler (2.96 or above)
Build Instructions:
* verify that "curl-config" and "xml2-config" are available
in your $PATH.
* run the "Configure.sh" shell script; you may optionally
provide the following arguments:
ZLIB_PREFIX=/path/to/zlib/installation
PREFIX=/where/to/install/the/agent
* run "make"
Install Instructions:
* "make install" creates the following files or directories :
$PREFIX $PREFIX/ocs-agent-<platform>
$PREFIX/ocs-agent-<platform>.<revision_number>
Note that $PREFIX/ocs-agent-<platform> is a symbolic link to
$PREFIX/ocs-agent-<platform>.<revision_number>.
* add the following command to your crontab to start the agent every day at 1am:
0 1 * * * $PREFIX/ocs-agent-sparcsolaris8
-s <inventory.samanage.com>[:<port>] >$PREFIX/ocs.log 2>&1
Usage & Parameters Instructions:
ocs-agent-sparcsolaris8: OCS client for Solaris (ocs-agent-solaris/0.3)
Usage: ocs-agent-sparcsolaris8 [-l] [-d] -s <server>:[<port>] [-a]
-l local mode (display XML document)
-d debug mode
-s <server> name of the OCS server (inventory.samanage.com)
-a activate auto-update (default: OFF)
Credits:
bfleisch@users.sourceforge.net
Supported Platforms:
Sun Solaris 8 / 9 / 10 (SPARC)
Download: Download the agent here
Requirements:
You should have a copy of the following tools (libraries and header
files) to compile the agent:
* libcurl (http://curl.haxx.se/)
* libxml2 (http://www.xmlsoft.org)
* libz (http://www.zlib.net)
* GCC C compiler (2.96 or above)
Build Instructions:
* verify that "curl-config" and "xml2-config" are available
in your $PATH.
* run the "Configure.sh" shell script; you may optionally
provide the following arguments:
ZLIB_PREFIX=/path/to/zlib/installation
PREFIX=/where/to/install/the/agent
* run "make"
Install Instructions:
* "make install" creates the following files or directories :
$PREFIX $PREFIX/ocs-agent-<platform>
$PREFIX/ocs-agent-<platform>.<revision_number>
Note that $PREFIX/ocs-agent-<platform> is a symbolic link to
$PREFIX/ocs-agent-<platform>.<revision_number>.
* add the following command to your crontab to start the agent every day at 1am:
0 1 * * * $PREFIX/ocs-agent-sparcsolaris8
-s <inventory.samanage.com>[:<port>] >$PREFIX/ocs.log 2>&1
Usage & Parameters Instructions:
ocs-agent-sparcsolaris8: OCS client for Solaris (ocs-agent-solaris/0.3)
Usage: ocs-agent-sparcsolaris8 [-l] [-d] -s <server>:[<port>] [-a]
-l local mode (display XML document)
-d debug mode
-s <server> name of the OCS server (inventory.samanage.com)
-a activate auto-update (default: OFF)
Credits:
bfleisch@users.sourceforge.net
Supported Pltforms:
AIX 5.1
Download: Download the agent here
Requirements:
You should install the following tools to install and use the agent:
1) perl 5.8 Net::IP requires
2) perl LWP XML::Simple Compress::Zlib Net::IP modules
Install Instructions:
1) Unzip the package to an install directory
2) run the following: /usr/local/bin/perl ocsinventory-installer.pl
Usage & Parameters Instructions:
-local - does not communicate with the inventory server
-debug - debug mode
-xml - local mode (display XML document)
-server - <server> name of the server (default: inventory.samanage.com)
Credits:
Joan.Soler@uv.es
Deploying on Mac OSX
Supported Platforms:
MacOSX 10.3 and above.
Install Instructions:
- Download the Mac agent setup package and save it to your local computer.
- Install the package
- by double clicking the package OR
- via command line: sudo installer -pkg samanage_mac_agent.pkg -target "/"
- After the install, edit the agent configuration file:
- Run the agent:
- Via command line sudo php /usr/local/sbin/ocs_mac_agent.php
- Done.
- Note: The installed updates the startup files and launches the agent every time the machine boots.
What's my account name? your account name is the name you selected when you signed up for SAManage. Click here to learn how to find your account name.
Credits to: Jason rust
Uninstalling the agents
Instructions:
- Run the uninstaller command (uninst.exe) located in the SAManage installation folder (the default folder is \program files\SAManage).
- The uninstaller can be used with the /s parameter for unattended uninstallation.
- Use one of the recommended deployment procedures to uninstall the agents by replacing the agent setup file with the uninst.exe command.
Product Tour
