Deployment Guides

Using the Remote Deployment Tool

Recommended for: Enterprise Deployment. Using the deployment tool you can remotely deploy the SAManage agent on all computers in your network.

Instructions:

Download the SAManage deployment tool setup file and save it on your local computer.
Launch the deployment tool setup wizard.
Click Next >>, I Agree, Next >>, and Install to install the deployment tool on your local computer.
When the setup wizard completes, click Finish to start the deployment tool.
Select the Local Deployment option to deploy the agent on your local computer (for testing purposes), or Remote Deployment to deploy the agent remotely on selected or all computers in your network.

Local Deployment will install the agent manually on your local computer. Click Next > and I Agree to accept the license agreement, enter your SAManage Account Name and click Next > and Install. When the Installation completes, your local computer inventory will appear in your online account.

Remote Deployment will take you to select hosts in your network by specifying an IP range (From - To), or click on "Selected hosts" and + to select hosts from your network. You can select hosts from multiple domains or workgroups and add them to the list, or import a list of hosts from a CSV file. Click Next >> when you are done selecting your hosts.

Enter your SAManage account name as selected during your signup. If you are not sure what's your account name, click here to locate it. Click Next >> when you are done.

Enter your Domain Administrator credentials (Domain\Account or Account@Domain) to use during the remote deployment. The Deployment Tool does not store your credentials or sends it to SAManage. Click Next >> when you are done entering your credentials.

Click Start! to start the remote deployment. You can adjust the speed of deployment by shifting the "Bandwidth usage" scale to simultaneously deploy the agents on your hosts. At the end of deployment, you can save the log file for future reference.

Need help with your SAManage activation? we offer a complimentary phone training to help you get started. Please contact us at support@samanage.com to schedule a 30-minutes deployment call. During the call we'll walk you through the activation process, conduct a test agent install and discuss the best approach to install the agent across your computers.

Network Requirements for using the Remote Deployment Tool:

The Windows Network is running and Printer and File Sharing are activated.
Check your firewall settings and verify that its not blocking any incoming traffic on ports 135 & 445.
The user's domain credential are entered correctly and are legitimate in the domain.

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 Domain Logon Script

Recommended for: Enterprise deployment (Windows). Use a Domain Logon Script to 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 SAManage agent setup file and save it on your local computer.
Copy the agent setup file 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 deployed on the computer? ==============================
if exist "C:\Program Files\SAManage\*.EXE" goto END
REM === Deploying agent in silent mode =======================================
\\SERVER\FOLDER\SAMagentInstaller.exe /TAG:ACCOUNTNAME /force /s /nosplash /debug
REM === Script done ======================================================
:END
exit

Modify the above highlighted values:

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 Option

Recommended for: Enterprise deployment (Windows). Use Active Directory Group Policy Option (GPO) to deploy the SAManage agent automatically 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 SAManage agent setup file and save it on your local computer.
Copy the agent setup file 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 deployed on the computer? ==============================
if exist "C:\Program Files\SAManage\*.EXE" goto END
REM === Deploying agent in silent mode =======================================
\\SERVER\FOLDER\SAMagentInstaller.exe /TAG:ACCOUNTNAME /force /s /nosplash /debug
REM === End of script =====================================================
:END
exit

Modify the above highlighted values:

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:

Microsoft KB on GPO in Windows 2000 http://support.microsoft.com/kb/314934/
Microsoft KB on GPO in Windows 2003 http://support.microsoft.com/kb/816102

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.

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 IT management system and we need your help to complete this manual procedure:

- Download the software by clicking on this link http://www.samanage.com/app/SAMagentInstaller.exe
- 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---->>>

Deploying on Unix / Linux

Supported platforms:

Linux: any distribution on x86, x86_64/AMD64 and PowerPC.
Solaris: tested on Solaris 8, 9 and 10 (x86 and Sparc)
BSD: Sparc and PC
AIX: tested on Solaris 8, 9 and 10 (x86 and Sparc)
OSX (Currently testing on 10.3.9-10.5.3)

Download the Unix unified agent setup file

Requirements:

Perl 5.8.
- Perl module Digest::MD5
- Perl module XML::Simple
- Perl module Net::IP
- LWP
dmidecode on Linux and *BSD (i386, amd64, ia64) dmidecode is required to read the BIOS stats.
lspci on Linux and *BSD (pciutils package) is required to list PCI devices.
Mac::SysProfile on MacOSX to collect the device information's.
sneep on Solaris/sparc, you must install sneep and record the Serial Number with it :

Installing

Once the archive is unpacked, use these commands:

perl Makefile.PL
make
make install

You can also run the agent from the tarball directory. The agent needs some directories to store internal settings.

mkdir -p /etc/ocsinventory-agent
mkdir -p /var/lib/ocsinventory-agent
mkdir -p /var/log/ocsinventory-agent
mkdir -p /var/run

You can choose other directories by changing the default settings directly in the ocsinventory-agent file.

Running

Launch the agent with root privilege. It's also possible to run directly from the tarball directory.

sudo ./ocsinventory-agent --server inventory.samanage.com --tag=ACCOUNTNAME --force --debug

Replace ACCOUNTNAME with your SAManage Account Name. The account name 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.

Deploying on Mac OSX

Supported Platforms:

MacOSX 10.3 and above.

Install Instructions:

Download the SAManage Macintosh Agent package
Double click to mount and open the volume if it's not mounted automatically (volume name is "samanage-agent")
Double click on samanage-agent icon to launch the installer
* Click Continue
Default location of the installation is your system disk, no need to change it
* Click Install
Enter the logged-in user's password:
* Please enter the password and click OK.
Enter your SAManage account name.
* Enter the account name and click OK.
* Note: this is NOT your login/email address. Your account name is the name you selected when you signed up for SAManage. Click here to learn how to find your account name.
Installation will complete and run an inventory scan for the first time. This stage may take several minutes to complete.
* Upon completion the installer returns with "Install Succeeded" message
* Click Close
* You can unmount the samanage-agent volume by clicking "Eject" or dragging its icon to the trash

Note: To schedule periodical refresh of your Mac inventory, add the agent command line to your startup script or cronjob. The agent command line looks like:

sudo php /usr/local/sbin/ocs_mac_agent.php

Removal Instructions:

To remove the MacOS agent please follow these steps:

1. remove folder "/Library/StartupItems/OCSInventory" and its content
2. remove the following files from "/usr/local/sbin":
* ocs_mac_agent.php
* samanage-agent-setup
* samanage-save-config
3. remove folder "/etc/ocsinventory-client"

Uninstalling the agents

Instructions:

Run the agent uninstaller (uninst.exe) available in the SAManage folder (the default folder is \program files\SAManage) for each computer.
The uninstaller can be used with the /s parameter for unattended removal.
Use one of the recommended deployment procedures (domain logon, active directory) to automate the agent removal process by replacing the agent setup with the uninst.exe command. Here is an example batch file:

@echo off
REM === agent deployed on this computer? ==============================
if not exist "C:\Program Files\SAManage\*.EXE" goto END
REM === running the uninstaller to remove the agent in silent mode ============
C:\Program Files\SAManage\uninst.exe /s
REM === Script done ================================================
:END
exit