How to install optional Fire Scope Agents on most commonly deployed server platforms.

Overview

Fire Scope SPM includes optional Agents that can be installed on most commonly deployed server platforms. These Agents enable Fire Scope to better access OS-specific performance metrics and log files. Fire Scope officially supports Agents on manufacturer supported versions of enterprise level operating systems patched to the currently supported service pack/patch level. If an Operating System is unsupported by our C++ Agent, then our Java based Flex Agent could be used for compatibility.

Agent Operation

At the time of installation, the installer creates the necessary user, group and other folders needed for the Agent to run. The Agent comprises of two processes:# firescope_agentd – The firescope_agentd listens on the configured port which is usually 8042. The firescope_agentd has following functions,

• It periodically(every 30 seconds) sends the agent_info to Edge device. Agent info is an xml content as shown below.

 <?xml version="1.0" encoding="UTF-8"?>
<agent_info>
   <ip>10.0.23.221</ip>
   <port>8042</port>
   <mgmt_port>8044</mgmt_port>
   <os>windows</os>
   <arch>64</arch>
   <version>4.0.49</version>
   <build>41179</build>
   <ping_period>30000</ping_period>
   <last_upgrade_time />
   <last_upgrade_status />
</agent_info>

• When the Discovery job is run by SPM, the Edge device requests the agent_capabilities from the Agent. Agent capabilities is an xml content that includes the details about storage, cpus, interfaces, and system.

 <?xml version="1.0" encoding="UTF-8"?>
<discovery>
   <hosts>
      <host address="constant">
         <capabilities>
            <cpus>
               <cpu>
                  <name>Cpu 1</name>
                  <description>0</description>
                  <index>0</index>
                  <load-oid>cpu_utilization(0)</load-oid>
               </cpu>
               <cpu>
                  <name>Cpu 2</name>
                  <description>1</description>
                  <index>1</index>
                  <load-oid>cpu_utilization(1)</load-oid>
               </cpu>
               <cpu>
                  <name>Cpu 3</name>
                  <description>2</description>
                  <index>2</index>
                  <load-oid>cpu_utilization(2)</load-oid>
               </cpu>
               <cpu>
                  <name>Cpu 4</name>
                  <description>3</description>
                  <index>3</index>
                  <load-oid>cpu_utilization(3)</load-oid>
               </cpu>
            </cpus>
            <interfaces>
               <interface>
                  <name>Local Area Connection</name>
                  <description>Local Area Connection</description>
                  <admin-status>UP</admin-status>
                  <operational-status>UP</operational-status>
                  <interface-type>ethernet-csmacd</interface-type>
                  <inbound-errors-oid>network_interface_incoming(Local Area Connection,errors)</inbound-errors-oid>
                  <outbound-errors-oid>network_interface_outgoing(Local Area Connection,errors)</outbound-errors-oid>
                  <inbound-traffic-oid>network_interface_incoming(Local Area Connection,bytes)</inbound-traffic-oid>
                  <outbound-traffic-oid>network_interface_outgoing(Local Area Connection,bytes)</outbound-traffic-oid>
                  <admin-status-oid />
                  <operational-status-oid />
               </interface>
               <interface>
                  <name>Loopback Pseudo-Interface 1</name>
                  <description>Loopback Pseudo-Interface 1</description>
                  <admin-status>UP</admin-status>
                  <operational-status>UP</operational-status>
                  <interface-type>softwareLoopback</interface-type>
                  <inbound-errors-oid>network_interface_incoming(Loopback Pseudo-Interface 1,errors)</inbound-errors-oid>
                  <outbound-errors-oid>network_interface_outgoing(Loopback Pseudo-Interface 1,errors)</outbound-errors-oid>
                  <inbound-traffic-oid>network_interface_incoming(Loopback Pseudo-Interface 1,bytes)</inbound-traffic-oid>
                  <outbound-traffic-oid>network_interface_outgoing(Loopback Pseudo-Interface 1,bytes)</outbound-traffic-oid>
                  <admin-status-oid />
                  <operational-status-oid />
               </interface>
            </interfaces>
            <memories>
               <memory>
                  <name>Memory 1</name>
                  <description>Memory 1</description>
                  <storage-type>RAM</storage-type>
                  <total-space-oid>memory_size(total)</total-space-oid>
                  <free-space-oid>memory_size(free)</free-space-oid>
               </memory>
            </memories>
            <storages>
               <storage>
                  <name>C:\</name>
                  <description>C:\</description>
                  <mount>C:\</mount>
                  <storage-type>FIXED_DISK</storage-type>
                  <total-space-oid>filesystem_size(C:\,total)</total-space-oid>
                  <used-space-oid>filesystem_size(C:\,used)</used-space-oid>
                  <pused-space-oid>filesystem_size(C:\,pused)</pused-space-oid>
               </storage>
               <storage>
                  <name>E:</name>
                  <description>\vboxsrv\SpinningDrive</description>
                  <mount>E:</mount>
                  <storage-type>NETWORK_DISK</storage-type>
                  <total-space-oid>filesystem_size(\vboxsrv\SpinningDrive,total)</total-space-oid>
                  <used-space-oid>filesystem_size(\vboxsrv\SpinningDrive,used)</used-space-oid>
                  <pused-space-oid>filesystem_size(\vboxsrv\SpinningDrive,pused)</pused-space-oid>
               </storage>
               <storage>
                  <name>Z:</name>
                  <description>\fsfile\storage</description>
                  <mount>Z:</mount>
                  <storage-type>NETWORK_DISK</storage-type>
                  <total-space-oid>filesystem_size(\fsfile\storage,total)</total-space-oid>
                  <used-space-oid>filesystem_size(\fsfile\storage,used)</used-space-oid>
                  <pused-space-oid>filesystem_size(\fsfile\storage,pused)</pused-space-oid>
               </storage>
            </storages>
            <system-description>
               <description>Windows 8  (x64 version)</description>
               <up-time>1074</up-time>
               <contact />
               <name>Bryancan-PC</name>
               <location />
               <organization />
               <description-oid>host_information</description-oid>
               <up-time-oid>host_uptime</up-time-oid>
               <contact-oid />
               <name-oid>host_name</name-oid>
               <location-oid />
            </system-description>
         </capabilities>
      </host>
   </hosts>
</discovery>
 

• When the Edge device sends a query to collect the value of an attribute, the Agent processes the request and sends the response back to the Edge device.

Agent Installation

From time to time, Fire Scope will release new agents to be used with your SPM deployment. If you do not see the agent for your operating system listed on in your administration page, either create a helpdesk ticket or contact support@matrix42.com. Fire Scope officially supports agents on manufacturer supported versions of most enterprise level operating systems patched to the currently supported service pack/patch level.

As specified in the System Requirements, the ports 8042 and 8043 are utilized by the Agent and Edge device for communication. Also port 8044 is used by the Agent Manager. Make sure that any local port filtering does not block traffic on these ports.* Agent listens on port 8042 for messages from the Edge device.

• Edge device listens on port 8043 for messages from the Agent.
• Agent Manager listens on port 8044 for messages from the Edge device.

Notes: * To install any agent, you need root-level access to the system you will install on.

• For all Unix systems except Redhat 5 use the Dynamic Installer.
  • What is a Dynamic Installer and why is it used? With Dynamic Installer the agent binary is dynamically linked. Since the dependent libraries are not bundled inside the agent binary, Agent uses the libraries from the operating system. This is because REdhat 6 and above were not compatible with how this Operating System wanted to be.
• For all other Unix platforms including Red Hat 5, use the Static Installer.
  • What is a Static Installer and why is it used?
    With Static Installer the agent binary is statically linked. The dependent libraries are bundled(linked/packaged) inside the agent binary itself.

***The latest installation packages for Agents are available here:

>>>>Agent Downloads<<<<

sh Fire Scope Agent_Installer_Solaris-4.0.57_42376.sh -A <firescope-edge-device-ip>

sh Fire Scope Agent_Installer_Solaris-4.0.57_42376.sh -A <firescope-edge-device-ip> -b /export/home/fsbuild/instalationstuff/

Agent Upgrade

To update an Agent with the latest upgrade: Download latest upgrade file by clicking on the appropriate Download Link from the table below.

1. After you download the file you have to upload the Agent file into CMI account. This will make the file available to Accounts in Firescope SPM for upgrade.
   To upload an Agent upgrade file into CMI Account:
   1. Log in to Fire Scope SPM CMI account.
   2. Click on Administration > Device Management > Agent Upgrades. The Agent Upgrades page will be displayed.
      
2. Click on the Upload button( upper right corner). The Agent Upgrade page will be displayed.
   
3. Click on Browse in Upload an Agent Upgrade file.
4. Select the upgrade file you want to upload.
5. Click on the Save button.
6. Log out of CMI account.

To Upload Agent Upgrade in Firescope SPM Account# Log in to the desired Fire Scope SPM Account with Administration privileges.

1. Click Administration > Utilities > Agent Upgrades. The Agent Upgrades page will be displayed.
   
2. Click on the Manage Agents on Edge Devices button(Upper right hand corner). Upload Agent Upgrade page will be displayed.
   
3. Select the Edge Device from the drop down list.
4. Select Agent files from the Available list, click on Add button. File is added to the Active list box.
5. Click on the Save button. 
   To apply an updated Agent file to a single CI/server or multiple CIs/servers:
   1. Click Administration > Utilities > Agent Management. The Agents Administration page will be displayed.
      
6. In the Remote Agents section in Agent IP / DNS column, click on the check box next to the Agent you want to update. For multiple updates select as many Agent as you want to upgrade.
7. Under Available Versions select the version from the drop down list.
8. Click on the Deploy updates for selected button, Deploy Schedule page is displayed.
   
9. Under Deploy section, complete the following fields
   1. Deploy Reason: Briefly explain the reason for the update.
   2. Schedule Deployment: Select to deploy now or choose a future date/time.
10. Click Deploy update.
11. The ACTIVE JOB QUEUE section on the Agents Management page shows the status of any pending updates.
    

Agent Management

The Agent Management page centralizes updates and configuration of data collection in Fire Scope Agents, which simplifies the management of large deployments. From this page, you can:* Configure one or more Agents at once

• Update one or more Agents immediately or at a future day/time

See Agents for a list of supported Agents.

To access the Agent Management page:# Log in to Firescope SPM as an Administrator.

1. Click Administration > Utilities > Agent Management. The Agent Management page will be displayed.
   

Section Descriptions The default Agent Management page is divided into three sections that provide an overview of the current status of active Agents.

Additional options that are available via the drop-down in the top right corner are: