Admin Guide

From FireScope Documentation Site
Jump to: navigation, search

Contents

Admin Guide

The SPM Administration Guide provides valuable information on tasks performed by your SPM Administrator.

System Requirements

The following outlines the minimum requirements required for implementation of FireScope.  Please note that FireScope only supports environments whose dependencies are within the current support by the original equipment manufacturer.  For example, FireScope virtual machines will not be supported on VMware versions that have reached the end of general support by VMware.


Edge Device System Requirements

Edge devices can be physical or virtual appliances. They are deployed on-premise to perform discovery of IT assets, data collection and accurately forwarding all of this data to the FireScope cloud. * 8 vCPUs

  • 12 GB of RAM
  • 100GB for Primary DiskNote: The storage requirement for the Edge device is large, to ensure sufficient storage space for caching in case of loss of connectivity with the FireScope cloud. The number of Configuration Items it collects from frequency of polling, and scope of data collection methodologies impact its performance. 


Additional Components Required for an On-Premises Implementation

In addition to the overall environment requirements, ensure that you meet the requirements for each individual component. Requirements for each component—EWC, EAC, ESC are outlined in the following sections.  Please note that if you are implementing FireScope using the Software-as-a-Service(SaaS) model, the following components will not be required.

Elastic Web Component (EWC)

Of the three cloud components of FireScope , the EWC has the lowest requirements as this component is dedicated to delivering the FireScope user experience and nothing else. Because of this role, the primary consideration in sizing is the number of concurrent users. Factors such as the size of the environment and activity will not significantly impact the EWC. As a result, in many environments, only a few EWC instances may be required.

Each UI server needs:* 4 vCPUs

  • 4 GB of RAM
  • 40GB for Primary Disk


Elastic Application Component (EAC)

The EAC is responsible for receiving data from the Edge device(s), normalizing the data, and analyzing status of Event Definitions, Aggregate Event Definitions, and Policies. Therefore, CPU becomes a critical requirement for this component.* 6 vCPUs

  • 12 GB of RAM
  • 60GB for Primary Disk


Elastic Storage Component (ESC)

Storage and memory are key for the ESC, as this is where all Attribute data is stored and queried. As much of the data set as possible is stored in memory for best query performance, therefore the amount of memory provided for this type of instance has implications on performance of the entire solution. Data retention settings are also key considerations for this instance type.* 4 vCPU

  • 24 GB of RAM
  • 60GB for Primary Disk
  • 500GB for Secondary Disk


Note: For each ESC, provision a secondary VMDK with minimum storage of 500 GB. Also, anti affinity rules must be in place to ensure no 2 ESC nodes are ever on the same host or datastore.

Port Communication Requirements

All communication between the Edge device and the FireScope cloud is initiated by the Edge device for security purposes. The following ports will need to be open for successful communication between FireScope and each Edge device.

Internal

The following table specifies the internal ports you must keep open for the listed servers.


Servers Open Ports
Elastic Storage Component(ESC) <----------> Elastic Web Component (EWC) 22, 27020, 30000, 40000
Elastic Web Component (EWC) <–-------> Elastic Application Component( EAC) 22, 25, 80, 443, 8080http: 28050, 28051 https: 28060, 28061
Elastic Application Component( EAC)<–-------> Elastic Web Component (EWC) 15672, 5671, 5672
Elastic Application Component( EAC)<----------> Elastic Storage Component(ESC) 22. 30000, 40000
Edge <----------> Elastic Application Component( EAC) http: 18050, 18051 https: 18060, 18061, 5671, 5672
Analytic Client Machine 40000


External

The following table specifies the external ports you must keep open for the listed servers.


Servers Open Ports
Elastic Web Component (EWC) 80, 443
EMI 8004
Edge <----------> Elastic Application Component( EAC) http: 18050, 18051 https: 18060, 18061, 5671, 5672
Analytic Client Machine 40000
All Servers ←-------→ controller.firescope.com 80, 443
Web Services 38050, 38051, 38060, 38061
Edge ----> RabbitMQ 5672 , 5671
sFlow Collector ------> Edge 6343(UDP)
NetFlow Collector ----> Edge 2100 (UDP)
AWS VPC Flow Logs ------> Edge 2200

 Note:* If you want to use 38060 for SSL you need to disable peer authentication.

  • Edge to RabbitMQ---The edge has to reach web2 via ssl port 5671 or non ssl port 5672. 
  • The address each Edge should use to reach the RabbitMQ is to be filled out in the Global Network Traffic Settings form on the Edge Devices page inside your account.Enter the address in Application Messaging IP/DNS field.  Global Edge Settings.png-798x536.png


Web Browser Requirements

FireScope supports the following Web browsers:


Internet Explorer 8 and aboveNote: Compatibility mode not supported. HTML5 is not natively supported in versions older than 9.
FireFox 6 and above
Safari 3.2 and above
Chrome 6.0 and above

 

Additionally, the following requirements apply to all browsers:* JavaScript is enabled

  • Minimum resolution: 1024 x 768


On-Premise Implementations Minimum Requirements

If you are opting for a private instance of FireScope , there are additional requirements needed for the FireScope Cloud itself.  All of the previous minimum requirements are still required.

Ensure that you meet the following environment requirements to deploy FireScope successfully.


ESX Servers 3 (5 preferred)
Minimum Instances 3 x EWC2 x EAC2 x ESC1 x Edge Device
VM Environment ESX servers with proper configuration, running versions currently under active support by VMware(Key settings are correct Time Source and Hostname)Standard VMware images, with VMDK support
Supported Storage FC SAN (preferred)Fast iSCSIDirect Attached SAS*NAS is not supported.
Network Fast Ethernet, fully switchedDistributed vSwitches for ESX

 

All primary components (EWC, EAC, and ESC) communicate over TCP/IP Protocol within the Cloud Environment. Each layer must have the appropriate access to the other layers in order for the application to perform optimally. As the Cloud Environment is typically housed in the same location, no special firewall rules or protocols should be required.


Pre-Deployment

The following items must be addressed before FireScope SPM can be initialized.# NTP must be configured in the Firescope Console of each VM.  Record the IP address or DNS name for an authoritative NTP time source here: _______________

  1. The following VMware OVAs from Firescope are delivered prior to onsite visit:
    1. SAPP
    2. SEDGE
    3. SMONGO
    4. SWEB
  2. Access to vCenter with correct permissions to deploy, edit, and start/stop VMs.
  3. Access to the OVAs location (e.g., shared drive, datastore).
  4. IPs pre-allocated for each VM.
    1. Complete the SPM Core Setup Table.
  5. Access to a primary and secondary DNS server with the ability to do forward and reverse DNS lookup of IP addresses.
  6. DNS A records and reverse lookup entries for all SPM servers.
  7. Load balancer configuration pre-allocated and configured.
    1. See the Load Balancer Configuration Example.
  8. Pre-allocated storage space for each Mongo database.
    1. Separate VMDK in the datastore (minimum size recommendation 200GB)
    2. Network Attached Storage
      • Firescope will assist with this.
    3.  Other
      • Firescope will assist with this.


 Firewall settings. For more information, see the Deployment Guide.

SPM Core Setup Table

Hostname Function IP Datastore Name ESX Host Target (Initial) vCPU Memory
sapp1 App Server 1.1.1.1        
sapp2 App Server 2.2.2.2        
smongo1 Mongo Server 3.3.3.3        
smongo2 Mongo Server 4.4.4.4        
smongo3 Mongo Server 5.5.5.5        
smongo4 Mongo Server 6.6.6.6        
sweb1 UI Server 7.7.7.7        
sweb2 UI Server 8.8.8.8        
sweb3 UI Server 9.9.9.9        
sedge1 Edge Server 10.10.10.10        

 

Load Balancer Configuration Example

You may use load balancers for the EXC and EAC VMs. The following table is a load balancer configuration example.


DNS Name Purpose IP Ports Health Check Load Balance Metric Pool Members
uibalance FireScope UI 11.11.11.11 ALL /blank.php (80) Fewest Connections sweb1, sweb2, sweb3
appbalance FireScope App 12.12.12.12 ALL  :18050/edge_services/attribute_results Fewest Connections sapp1, sapp2

 Note: Load Balancer Health Check URLs

http://<app-server-ip>:28050/ui_services/ci

http://<app-server-ip>:18050/edge_services/attribute_results

http://<app-server-ip>:38050/web_services/ci

http://<app-server-ip>/ui_services/ci

http://<app-server-ip>:18050/edge_services/attribute_results

http://<app-server-ip>:38050/web_services/ci

Deployment Guide

For a successful deployment of FireScope we recommend the following:# Install the Elastic Web Component (EWC), Elastic Application Component (EAC), and Elastic Storage Component (ESC) components in the same location.

  1. If you choose to set the static IP for a server (instead of using a dynamic IP),
    1.    Provide the IP details
    2.    Allow the scripts to run
    3.    Wait until you are returned to the main console screen before proceeding
  2. When you set the date and time for your server, sync the server with a network time protocol (NTP) server.
  3. When you complete the final step in an AMI Configuration Wizard, do not close the AMI before it automatically directs you to the associated server's AMI.
  4. During the Edge device setup, select HTTP as the communication protocol. If you select HTTPS you will reduce your bandwidth capabilities between the Edge device and the other servers.
  5. Start the servers in the following order:
    1.    MongoDB servers
    2.    Application server
    3.    UI servers 1 and 2
    4.    UI server 3  
    5.    Get IP address


Upgrading

When upgrading your FireScope environment, complete each one in the following order one VM at a time:#    All MongoDB VMs.

  1.    All Application VMs.
  2.    All UI VMs.
  3.    All Edge Devices.


MongoDB Servers

Follow these steps for the two MongoDB VM servers:# Start the two MongoDB servers.

  1. Access each server's console and either:
    1.    Find the dynamic IP, or
    2.    Set the static IP
  2. Note both servers' IP addresses for future reference.


For more information, see the MongoDB online documentation.  

Application Server

Follow these steps to get the IP address for the application server:# Access the server's console and either find the dynamic IP or set the static IP.

  1. Note the IP address for future reference.


UI Servers 1 and 2

Follow these steps for two of the three UI VM servers:# Start two of the UI servers.

  1. Access each server's console and either:
    1.    Find dynamic IP, or
    2.    Set the satatic IP
  2. Note both servers' IP addresses for future reference.  


UI Servers 3

After you start the first two UI VM servers, you will start the third UI VM server and configure it to function as the main UI server. To start and configure the third UI VM server, follow these steps.

Get the IP Address

To get the IP address for the third UI server, follow these steps:
  1. Access the server's console and either find the dynamic IP or set the static IP.
  2. Note the IP address.


Edge Device

The Edge Device resides at each business location, performs Discovery and data collection, and pushes the resulting data up to the central FireScope SPM cloud. All Edge Device configuration is performed through the central FireScope SPM interface, enabling new business locations to be easily integrated into Dashboards by starting up a new Edge Device and pushing down configuration. Edge devices can be physical or virtual appliances, depending on the size of the environment they reside in and volume of data collected.

Communication with the central cloud can be over standard HTTP or HTTPS, is configurable per edge device, and leverages message queuing to ensure accurate delivery of data. Additionally, if an edge device loses connectivity to its cloud, data will be locally cached until connectivity is restored, at which time a secondary history queue is used to push cached attribute data without disrupting real-time data.

Pastedimage1460646935293v1.png-320x240.png

Deploy Edge Device

  1. Download SEDGE.ova by clicking on the following link https://firescope.box.com/s/imglqzfflzuy4uzl352nozlhbx0x139e
  2. Once the file is downloaded successfully, connect to ESX Server via vSphere client.

6082.VM Console-1.png-500x500.png

  1. Log into the Vmware. Deploy OVF template page will be displayed.

2016-09-23 1153.png-320x500.png

  1. Click on File > Deploy OVF Template. Deploy OVF Template wizard will be displayed.

1234.VM Console-3.png-320x240.png

  1. Click on Browse and  select the SEDGE.ova that was downloaded (Step 1) and click Next.

VM Console-3.png-500x500.png

  1. Specify a Name of the VM (As per company standards)and click Next.
  2. Select DataStore and click Next.
  3. Select Thin provision and click Next.
  4. Check the box Power on Deployment and Click Finish.
  5. After successful deployment, node will be starting. Once the node is started follow below steps for Network and Hostname assignments.
  • Enter 1 for Configure Network Settings.

Console-1.png-500x240.png

  • Select No

Console-2.png-500x240.png

  • Enter Hostname

Console-3.png-500x240.png

  • Enter IP Address

Console-4.png-500x240.png

  • Enter Subnet Mask

Console-5.png-500x500.png

  • Enter Gateway

Console-6.png-500x240.png\

  • Enter PRIMARY DNS Server

Console-7.png-500x240.png

  • Enter SECONDARY DNS Server

Console-8.png-500x240.png

  • Enter NTP Server

Console-9.png-500x240.png


Note: Once you enter all above details, SEDGE Node will be installing required modules / updates and Creates Database and tables etc.

Create Edge-CMI Account

  1. Log into CMI Account.
  2. Click on Administration > Device Management > Edge Device, Manage Edge devices page will be displayed.    5734.CMI Edge Page 1.png-960x478.png
  3. Click on Create. Create Edge Device form will be displayed.  

7823.2 Create Edge.png-949x608.png

  1. Complete the form.
  2. Click on the Save button.   
  3. Click on Download Key button.
  4. Select Save file option.


 Note: Registration key is necessary for Edge Registration.  

Create Edge - Non CMI Account

SAAS customers do not have access to the CMI Account, so to create an Edge device the user has to log in with Account Admin User Access level.

To create an Edge device# Log in to FireScope Cloud Advisor with Firescope or Account Administration privileges.

  1. Click on Configuration > Edge Device, Manage Edge devices page will be displayed.

Edge Devices page 1.png-803x136.png

  1. To create a new Edge Device click on the Create button or to set the network traffic collection rules for all edge devices click on Global Network Traffic Settings (upper right hand corner) button.


Create New Edge Device

  1. Create Edge Device form.

Create Edge Devices.png-798x757.png

  1. Select the Edge Device Status from the drop down list.
  2. In Edge Device Details section, 
    • Enter a name for the new Edge Device
    • Enter Description for the new Edge Device
    • TimeZone - You can click on the Change button to select a different Country and its Timezone from the drop down list.

0513.TimeZone.png-320x240.png

  1. Proxy: Click on the Use Proxy check box if you want to use a proxy for this Edge device. Proxy section will be expanded with the connection information fields. Enter the necessary information to connect to a proxy.

File:Proxy.png-601x312.png"

  1. Select the application server IP from the Application Server Connection Settings drop down list.
  2. Network Traffic Collector - This section sets the rules for Network Traffic Collection. These rules are applied to this particular Edge Device only.Note: If Global Network Traffic Setting is created as well, then these two rules are combined for data collection.

Network Traffic Collector.png-602x357.png

    • Collect Traffic: You can select enable or disable from the drop down list to turn on or turn off data flow.
    • Options: To select the type of data flows select the check boxes in front of the following options,
      • Collect NetFlow:  NetFlow is a network protocol developed by Cisco for collecting IP traffic information and monitoring network traffic. By analyzing flow data, a picture of network traffic flow and volume can be built. Supported versions: V1/V5/V7/V8/V9/V10.
      • Collect SFlow:  sFlow is a general purpose network traffic measurement system technology. sFlow is designed to be embedded in any network device and to provide continuous statistics on any protocol (L2, L3, L4, and up to L7), so that all traffic throughout a network can be accurately characterized and monitored. Supported version: V2/V4/V5.
      • Promiscuous Mode: In a network, promiscuous mode allows a network device to intercept and read each network packet that arrives in its entirety. This mode of operation is sometimes given to a network snoop server that captures and saves all packets for analysis (for example, for monitoring network usage).
        • Promiscuous Mode Network Interface: Specify network interface for capturing promiscuous network traffic.
          • Lowercase, alphanumeric characters only.
          • Leave blank to default to OS selected network interface.
    • Exclusion:Enter a comma-separated list of IPs and/or Ports to be excluded from the Network Traffic Data Collection.
      • IP Exclusion:  The list you enter, uses normal IP range syntax, so it can include hostnames, CIDR netblocks, octet ranges, etc.
      • Port Exclusion List: The list can be individual ports (8024,8025) or a range of port (8024-8034).
    • Inclusion: Enter a comma-separated list of IPs and/or Ports to be included in the Network Traffic Data Collection.
      • IP Inclusion List:  The list you pass uses normal IP range syntax, so it can include hostnames, CIDR netblocks, octet ranges, etc.
      • Port Inclusion List: The list can be individual ports (8024,8025) or a range of port (8024-8034).


 Click on the Save button. The Edge Device page will be displayed.

Pastedimage1510074877139v6.png-320x240.png

Click on the Download Key button. Option to Save or Open the Edge device key is displayed.

Select the Save option.

Note: Registration key is necessary for Edge Registration.  

Register Edge

  1.  Open your browser and type http://<ip or dns of your newly deployed Edge Device>:8004. Login page will be displayed.

Pastedimage1472754938755v1.png-320x240.png

  1. Enter  Username and Password. Click on Login.
  2. FireScope SPM EMI menu page will be displayed.

EMI Edge Registration.png-320x240.png

  1. Click on Administration > Edge Registration. Edge Registration Key page will be displayed.

6545.EdgRegistration Key Validation.png-320x240.png

  1. Drag & Drop EDGE Registration Key or Browse and upload Key. Note: Follow below link to obtain EDGE Registration KeyFor CMI Account:https://community.firescope.com/documentation/w/documentation/713.create-edgeFor Non-CMI Account:https://community.firescope.com/documentation/w/documentation/755.create-edge-non-cmi-account
  2. Click on the Validate Registration Key. Validation page will be displayed.            

6567.Submit.png-461x162.png

  1. Click on Submit the Registration Key. Edge Registration Complete page will be displayed.

5700.Edge Registration Complete.png-554x251.png

  1. Click on Edge Registration Complete.
  2. Refresh the Manage Edge Device page in CMI account. You will see the registered Edge Device IP address.

7367.6 Refresh Edge.png-803x143.png          

Update Edge Device -CMI Account

  1. Login into CMI Account
  2. Click on Administrator > Device Management > Edge Devices. Manage Edge Devices page will be displayed.                                                                                                                                                                                                                   Upgrade Edge.png-941x494.png
  3. Select the Edge Device Account (Click in the check box).
  4. Click on Update Edge Devices.      

Update Edge Device - Non-CMI Account

  1. Login into Firescope SPM with Administrator privileges.
  2. Click on Administrator > Utilities > Edge Devices. Manage Edge Devices page will be displayed.

0871.Download Key Page.png-955x203.png

  1. Select the Edge Device Account (Click in the check box).
  2. Click on Update Edge Devices.      

Global Network Traffic Settings -Non-CMI Account

You can set the network traffic collection rules for all edge devices here. # Log in to FireScope SPM with Firescope or Account Administration privileges.

  1. Click on Configuration > Edge Device, Manage Edge devices page will be displayed.

Global Network Setting.png-803x136.png

  1. To create a new Edge Device click on the Create button or to set the network traffic collection rules for all edge devices click on Global Network Traffic Settings (upper right hand corner) button.


Set Global Network Traffic Settings

  1. Global Network Traffic Settings form.

Global Network Setting Creat.png-801x588.png

  1. Traffic Sampling Frequency: Select the sampling frequency time from the drop down, this defines the amount of time in which network packets for the same (source_ip, target_ip, port) are aggregated into the same flow. Setting a larger sampling frequency is advantageous in that less flows are created in the system and increases processing time. Note: Flows will take a longer amount of time to be available for processing.
  2. Application Messaging IP/DNS: RabbitMQ messaging for intra-application communication requires access from your edge devices to your cloud FireScope web server (typically the 2nd configured webserver). If your webserver location is different than the default setup (a different DNS or virtual IP), you can enter it here.
  3. Global IP Exclusion List: Specifies a comma-separated list of IPs to be excluded. The list you pass in uses normal IP range syntax, so it can include hostnames, CIDR netblocks, octet ranges, etc.
  4. Global Port Exclusion: Specifies a comma-separated list of ports you want to exclude. The list can be individual ports (8024,8025) or a range of port (8024-8034)
  5. Global IP Inclusion List: Specifies a comma-separated list of IPs to be the ONLY ones included in network traffic data collection. The list you pass enter uses normal IP range syntax, so it can include hostnames, CIDR netblocks, octet ranges, etc.
  6. Global Port Inclusion List: Specifies a comma-separated list of ports to be the ONLY ones included in network traffic data collection. The list can be individual ports (8024,8025) or a range of port (8024-8034).

Service Rule Settings - Non CMI Account

Here you can schedule Data Analysis, assign discovered CIs to Edge Devices based upon IP ranges and if there are CIs which do not match the IP filters and ranges you can assign them to a default Edge device.

Note: Saving the Service Rules Settings page will restart the job.

To accomplish the above,# Log in to FireScope SPM with Firescope or Account Administration privileges.

  1. Click on Administration > Application Settings > Service Rules Settings, Edge Assignment Rules page will be displayed.

Pastedimage1509562946112v1.png-798x576.png

  1. Status: You can enable or disable the Edge assignment Rule by selecting Active or Disable from the drop down list.
  2. Dependency Analysis Schedule:  Select the interval of frequency from the drop down list. to determine often you want the job to run.
    • Last Check: Displays the date and time the job starts processing
    • Finished: Displays the date and time the job was completed .
    • Results: This displays the status (success/fail) and number of Service Groups processed
  3. Edge Device Assignments for Network Traffic: Network Traffic which is selected by Business Service Rules will be assigned to the selected Edge Devices based on matching IP ranges. You can also select the default Edge Device assignment for all other CIs not matching the specified IP ranges.  
    • Click on Add Rule button to add IP addresses or IP range. IP Range section will be displayed

Edge Assignment for Network Traffic.png-489x115.png

    • IP range: Enter Network IP address(s) you want to assign to a particular Edge Device. You can enter a single IP, multiple IP's or a Range of addresses.Examples:Multiple IP's:192.168.0.1,192.168.0.2,192.168.0.3IP Ranges:192.168.0.1-254 (means 192.168.0.1 to 192.168.0.254)192.168.0-14.1-254 (means 192.168.0.1 to 192.168.14.254)192.0-1.1-4.1-254 (means 192.0.1.1 to 192.1.4.254)191-192.0-1.1-.1-254 (means 191.0.1.1 to 192.1.4.254)Also supports CIDR notation (192.168.0.0/24)See http://www.subnet-calculator.com/cidr.php
    • Edge Device: Select an Edge Device from the drop down list, to which the network traffic will be assigned to. Note: You can add multiple rules by clicking on the Add Rule button or remove a rule by clicking on the Remove button.
    • Select an Edge device from the drop down list  to which all the other CIs that do not match the IP filter and ranges will be assigned to.
  1. Cloud Migration: Risk Analysis Thresholds: Here you can enter the score that will determine the color which is related to the risk level of the Service Group. This makes it easy to analyze the risk of each Service Group at a glance. The color is based on minimum score threshold entered. For e.g if you enter 45 Medium risk then all the Service Groups with a score of 45 and above will display a yellow color on the risk card, and if you enter 85 as Low risk then 85 and above will display a green color. So the score from 1 to 45 will be medium risk, 45 to 85 will be low risk and 85 to 100 will be no risk.Note:  Enter numbers from 1 - 99 in Low risk and Medium risk boxes. High Risk and No Risk(Max Score) score are hard coded.

Cloud Migration Risk Analysis Thresholds1.png-429x234.png

  1. Click on the Save button.
  2. To see the results of the Cloud Migration: Risk Analysis Thresholds settings click on Analysis  > Cloud Migration > Risk Analysis. In the example below you can see that
    • 0 to 20 is Red
    • 21 to 25 is yellow
    • 26 to 100 is Green

Cloud Migration.png-801x304.png

Accounts

In FireScope SPM, Accounts represent divisions of your business. Depending on your company's size and structure, an Account can be a region, location, department, or branch, for example, or any category that makes sense in your environment. As a hosted service, FireScope SPM can host multiple accounts in the same cloud instance and provide true multi-tenancy in a secured and scalable environment. Each account can be a separate customer.

FireScope SPM CMI interface will provide summarized reports and views focusing on individual accounts or view the operational health of the SPM cloud infrastructure.

CMI

The FireScope SPM Cloud Management Interface (CMI) is a tool for creating and managing accounts in SPM.


Create Account

  1. Log in to a UI server using the following credentials:
    •    Account name: CMI
    •    User: Contact support
    •    Password: Contact support
  2. Manage Account page will be displayed. (You can also go to Manage Account page by clicking on Administration > User Management > Accounts.)

4643.1 CMI Manage Acct Page.png-943x112.png

  1. Click on Create button on the upper right hand corner. Create Account page will be displayed.
  2. Complete the following required fields. For more information refer to the Section Description Table.
    •    Account Name
    •    Account Description

2 CMI Create Acct Form.png-945x843.png

  1. Click Save. Manage Account page will be displayed.

Add License CMI Create User.png-942x127.png

  1. Click Add License to upload your license file from the License Expiration column. Edit Account page will be displayed.

Edit Account CMI.png-799x1332.png

  1. Click Browse in the Account License Key section and select your license key.
  2. Click Save.


Section Description


Section Description
Account Name This will be used during login, and will be converted to a single word with no spaces. (e.g. a domain name)
Account Description This can be anything you want to describe the account, domain, or other grouping that this Account represents.
Account Status An Account set to 'Suspended' will prevent users of the Account from logging in to the system.
Account License Key Upload the license key purchased from FireScope Support to set the permissions for this account.
Account Locale  
Account Permissions Optionally allow users of the 'Account Admin' User Access Level to control certain aspects of their own account, that would otherwise be the responsibility of the CMI.


Manage Edge Devices Allow users of the 'Account Admin' User Access Level the ability to create and register Edge Devices for their account.
Application Server Cloud Component Groups Select the Application Server Cloud Component Groups this account will have access to for configuring Edge Devices.
Web Server Cloud Component Groups Select the Web Server Cloud Component Groups this account will have access to for user access to SPM.
Public Dashboard Access Enabling will allow any user to see all resources presented on Public Dashboard pages.For example, a user with access type Dashboard Only, who has been given access to only one Service Group with a few Cis, will now be able to see all Service Groups, CIs, Policies, etc ie all resources presented on Public Dashboard pages.
Browser connection Check to force all users in this account to use HTTPS (Hypertext Transfer Protocol Secure), a secure protocol that provides authenticated and encrypted communication


Create a User

To create a user, follow these steps:
# Log into the CMI.
    •    Account Name: CMI
    •    Name: Contact support
    •    Password: Contact support.
  1. Manage Account page will be displayed
4863.1 CMI Manage Acct Page.png-834x99.png
  1. Click on Administration > User Management > Users. Users page will be displayed.

7610.3 CMI Create User Page.png-833x164.png

  1. Click Create. Create User page will be displayed.

7522.4 CMI Create User Form.png-879x385.png

  1. Complete the following required fields, for more information refer to the Section Description Table below.
    •    Alias
    •    Name
    •    Surname
    •    Password
    •    Confirm password
    •    User Access Level
    •    Contact Media
  2. Click Save.

Agents

FireScope SPM includes optional Agents that can be installed on most commonly deployed server platforms. These Agents enable FireScope to better access OS-specific performance metrics and log files. FireScope 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,

 <?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>
 <?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.
  1. firescope_agent_managerd - The firescope_agent_managerd listens on the configured port which is usually 8044. The firescope_agent_managerd has three main roles.
    • Ensure that the firescope_agentd process is always running. If it is not running then the firescope_agent_managerd attempts to start it every 30 seconds.
    • Update the Agent when a new update becomes available.
    • Change the Agent configuration properties.


Supported Operating Systems

Operating System Versions
Microsoft Windows Windows 2003 Server and above, 32- and 64-bit
Red Hat Enterprise Linux 4 and above, 32- and 64-bit
SUSE Linux Enterprise 10 and above, 32- and 64-bit
Solaris 9 and 10, Sparc and x86
AIX All versions officially supported by IBM

Agent Installation

From time to time, FireScope 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@firescope.com.  FireScope 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.


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


The latest installation packages for Agents are available below.

 


OS Package Version Link
Linux Static Installer 4.0.51_41539 Download
  Dynamic Installer 4.0.51_41539 Download
Windows Installer for 64bit 4.0.49_41179 Download
  Installer for 32bit 4.0.49_41179 Download
Solaris Installer for Sparc 4.0.40_39977 Download
  Installer for x86 4.0.2_25576 Download
HP UX Installer 3.5.0_12463 Download
AIX Installer 4.0.50_41188 Download

Platform-Specific Agent Installation Guides

 

FireScope Agent for Unix(Linux, AIX, Solaris)

FireScope Agent for Windows 

 

System Resources:

Depending on the load on an agent; the system resources used by an Agent varies.* On a typical Windows as well as Unix system, the agent uses under 10MB and the agent manager uses about 1MB of memory.

Screenshot 1.png-440x337.png

Screenshot 2.png-454x190.png

Unix (Linux, AIX, Solaris)

Selecting the Installer

All Linux and UNIX platforms must use the Dynamic Agent Installers except for RedHat-5 (32/64bit) and below which will use the Static Agent Installers.


Instructions to Install

By default, the Linux and Unix Agents will be installed under /opt/firescope.

sh FireScopeAgent_Installer_Solaris-4.0.57_42376.sh -A <firescope-edge-device-ip>

If you want to install the Agent in a different directory add -b option, followed by the directory you want it to be install in. For Example:

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

The installation shell script can be modified to suit your OS needs.

For the purposes of this document, you can replace opt with the target directory of your choice. However, everything under the firescope/ directory must remain as documented.

To install the Agent:# Extract the tar file. e.g. tar xvf FireScopeAgent_DynamicInstaller_Linux-4.0.61_42952.tar

  1. Invoke the installation script.Example:e.g. sh FireScopeAgent_DynamicInstaller_Linux-4.0.61_42952.sh -A <firescope-edge-device-ip>This will place the Agent and all necessary files in /opt/firescope and place the appropriate init scripts where necessary. The installation will also create the firescop user account. Once the installation has completed, you can tail the log file (tail -f /opt/firescope/agent/logs/firescope_agentd.log) to verify that it's running.
  2. After the agent is installed, it takes a few minutes for the SPM to start the collection of data.


Starting and Stopping the services

Use the following commands as needed:* Linux


Uninstalling the FireScope Agent


FireScope Agent Important Files

Configuration file/opt/firescope/agent/conf/firescope_agentd_posix.xml

Log file/opt/firescope/agent/logs/firescope_agentd.log

PID file/opt/firescope/agent/logs/firescope_agentd.pid

Store and forward cache directory/opt/firescope/agent/cache

Windows

The following information provides instructions for installing the FireScope Agent on any 32- or 64-bit version of Windows 2000 Server or Windows 2003 Server.

 Desktop operating systems are not supported.

Note:* Ports 8042 and 8043 are utilized by the FireScope Agent and Server for communication. Make sure that any local port filtering does not block traffic on ports 8042 and 8043 to ensure maximum effectiveness from your FireScope SPM solution.


To install the Agent for Windows:# Follow the instructions for Installing an Agent for SPM.

  1. Double-click the FireScope Agent for Windows executable.
  2. Click Next. The FireScope End User License Agreement (EULA) is displayed. Read the EULA carefully.
  3. Click I Agree to continue the installation.
  4. Accept the default selection to install the FireScope Agent component.
  5. Click Next.
  6. Enter the name of the FireScope server that will manage this server. You can enter the IP address or the Fully Qualified Domain Name (FQDN). The Hostname should contain the host name of this server and does not need the FQDN.
  7. Click Enable Remote Commands if you want to allow FireScope to perform automated tasks on this server (e.g., restart services on failure or execute scripts based on specific events that you specify within FireScope).
  8. Click Next.
  9. Select the destination folder where you want to install the FireScope Agent. The default destination folder is C:\Program Files\FireScope Agent.
  10. Click Next. The FireScope Windows Agent creates a service called FireScope Agent, which automatically starts after installation and on system boot, using Local System for login credentials. You can modify these settings in the Services administrative tool.
  11. Click Close.
  12. Add this host on the FireScope appliance you specified during this installation.


Silent Installation

In 2008 r2, DEP and UAC are major limiting factors, so run a cmd window as administrator, then use the following command:* Least required for install:msiexec /i FireScope_Agent_Windows_Server-xxbit_x.x.x.xx-xxxx.msi /qn SERVER=xxx.xxx.xxx.xxx


Note: SERVER is the actual IP address of the Edge device


Property Description Value
SERVER FireScope Appliance  
LISTENIP Agent Listen IP  
CINAME Configuration Item Name  
JAVAHOME Path to Java.exe  
PORT FireScope Agent Port 8042
SPORT Agent Server Port 8043
MPORT Agent Manager Port 8044
RMTCMD Remote Commands TRUE
REALTIME Store and Forward TRUE
STORETIME Cached Time 300
STORECOUNT Cached Count 100
JPORT JMX Port 8046
ENABLEJMX JMXDelegate TRUE
WPORT WMI Port 8047
ENABLEWMI WMIDelegate TRUE


Silent Uninstall

In 2008 r2, DEP and UAC are major limiting factors, so run a cmd window as administrator, then use the following command:* Least required for uninstall:msiexec /x FireScope_Agent_Windows_Server-xxbit_x.x.x.xx-xxxx.msi /qn


For more information on msiexec, refer to this link

https://technet.microsoft.com/en-us/library/bb490936.aspx

Agent Configuration

Note: To Configure any agent, you need root-level access to the system you will be performing the installation on.# Log in to FireScope SPM as an Administrator.

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

2543.Image1.png-874x415.png

  1. In the Agent IP / DNS column, click the Agent you want to configure. There is a pause while FireScope SPM establishes a remote connection to the Agent and the Agent Attributes are updated. A summary of the Agent's configuration will be displayed on the Agent Management window.

1565.Image2.png-920x577.png


Configuring or Updating Multiple Agents

To simplify configuration of multiple Agents, or to ensure that multiple Agents have a consistent configuration, FireScope SPM includes a bulk editor for agents.

To configure multiple agents:# On the Agents Management page, check the box next to each Agent you want to configure.

  1. Click Edit properties for selected button. There is a pause while FireScope SPM DDM establishes a remote connection to the Agent and the Agent Attributes are updated. Note: The Agents Management page is divided vertically and displays the properties for the selected Agents.
  2. Use the Properties to save section to specify a global value to apply to all selected Agents.
  3. The Agents to update side displays the current configuration for each selected Agent, displayed three at a time with paging controls at the top.Note: You can update the Agents individually in this section.1588.Iamge3.png-806x1517.png                               
  4. Perform one or more of the following tasks:
    • To remove a property from all Agents, in the Properties to Save column, clear the box next to the property you want to remove.
    • To add a custom property to all Agents, click Add custom property button (at the bottom).
    • To edit a property for all Agents, in the Properties to save section, edit the appropriate field in the Value column.
    • To edit a property for one Agent, in the Agents to update section, edit the appropriate field in the column for that Agent.
  5.  In Change Properties Reason, type the explanation for your changes.
  6. Click on the Save Properties button. The configuration updates are pushed to all of the selected Agents.

Agent Upgrade

To update an Agent with the latest upgrade:# Download latest upgrade file by clicking on the appropriate Download  Link from the table Latest Upgrade File 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 FireScope SPM CMI account.
    2. Click on Administration > Device Management > Agent Upgrades. The Agent Upgrades page will be displayed.

Pastedimage1490364598290v2.png-741x271.png

    1. Click on the Upload button( upper right corner). The Agent Upgrade page will be displayed.

Pastedimage1490364629888v3.png-725x200.png

    1. Click on Browse in Upload an Agent Upgrade file.
    2. Select the upgrade file you want to upload.
    3. Click on the Save button.
    4. Log out of CMI account.


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

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

Pastedimage1490364681622v4.png-749x175.png

  1. Click on the Manage Agents on Edge Devices button(Upper right hand corner). Upload Agent Upgrade page will be displayed.

Pastedimage1490364731635v5.png-738x432.png

  1. Select the Edge Device from the drop down list.
  2. Select Agent files from the Available list, click on Add button. File is added to the Active list box.
  3. 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.  

0385.Agent Management Page.png-705x260.png

    1. 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.
    2. Under Available Versions select the version from the drop down list.
    3. Click on the Deploy updates for selected button, Deploy Schedule page is displayed.   

5584.Deploy Schedule Page.png-703x257.png

    1. 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.
    2. Click Deploy update.
    3. The ACTIVE JOB QUEUE section on the Agents Management page shows the status of any pending updates.

5582.Deploy Schedule.png-701x92.png


Latest Upgrade File


OS Package Version Link
Linux (RedHat_and_CentOS_64) Static Upgrade 4.0.51_41539 Download
Linux (RedHat_and_CentOS_32) Static Upgrade 4.0.51_41539 Download
Linux (SUSE_64) Static Upgrade 4.0.51_41539 Download
Linux (SUSE_32) Static Upgrade 4.0.51_41539 Download
Linux (RedHat_and_CentOS_64) Dynamic Upgrade 4.0.51_41539 Download
Linux (RedHat_and_CentOS_32) Dynamic Upgrade 4.0.51_41539 Download
Linux (SUSE_64) Dynamic Upgrade 4.0.51_41539 Download
Linux (SUSE_32) Dynamic Upgrade 4.0.51_41539 Download
Windows 64 Upgrade 4.0.49_41179 Download
Windows 32 Upgrade 4.0.49_41179 Download
AIX Upgrade 4.0.50_41188 Download
Solaris 10 Sparc Upgrade 4.0.40_39977 Download
Solaris 9 Sparc Upgrade 4.0.40_39977 Download

Agent Management

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


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.   

Agent Managemnet 2.png-800x336.png


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


Section Description
Active Job Queue Pending actions to be performed on Agents or Agent Groups.
Remote Agents Agents that are currently capable of remote administration.
Legacy Agents Legacy agents are those that are known yet have limited information. Those agents, not found in the Remote Agents list, have deployed version and/or build attributes found in one of the Configuration Items. Links found under the Associated CIs column allow access to the corresponding CIs.

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


Option Description
Overview Default view of the Agent Management page, see the previous section descriptions.
Job Queue Displays pending jobs and job that completed in the last twenty-four hours for Agents or Agent Groups.
Agents Displays only the remote Agents and legacy Agents.
Agent Groups Allows creating Agent Groups to facilitate Agent management functions.

Create Agent Group

You can organize Agents logically into groups to simplify management. These groups can be used to ensure a consistent configuration and versions across Agents. A common example is to create a group for each platform, such as all Windows Agents.# Log in to FireScope SPM with Administration privileges.

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

4532.Image1.png-917x500.png                                                                          

  1. Select Agent Groups from the drop-down in the top right corner. The Agent Management page displays existing Agent Groups.

Agent Group Page.png-918x132.png

  1. Click on the Create Agent Group button. The Agent Management page displays Agent Group fields.   

8255.Image2.png-925x409.png                                                                                         

  1. Complete the form.
  2. Click on the Save button.

Agent Resource Usage

On one of the Windows systems following resource usage was noticed:

CPU Usage

2474.agent cpu.jpg-806x225.jpg

 Memory Usage

 8168.agent memory.jpg-802x238.jpg

 Network Usage

0247.agent network.jpg-805x181.jpg

Backup and Restore

Account Backup

This feature is used to create/schedule a backup of all or a single account, so that if anything happens you may restore your settings from a previous date.There are two types of backup restore, full account backup and config backup. Full account backup which includes configuration, history and events, were as config backup does not include history and events.

To create an Account Backup #  Log into the CMI account.

  1. Account backup is located under Administration > Settings Note: Account Backup page has two view options , List and Calendar. To select view option click on the drop down list box View (Upper right hand corner.
  2. First thing you will need to to do before creating a backup is to configure where to store the backup.
  3. Click on the Config button, in the top right and enter your information. (See example screenshot below).

2016-04-27 11 32 47-FireScope Account Backup.png-595x289.png

  1. Once you have set up the configuration you can create a Scheduled backup,
    1. Click on the Create button. Schedule a Backup window will be displayed.
    2. In this pop-up window you can customize the backup time, frequency, and what account or accounts to backup.

Backup screenshot.png-709x727.png


Note: You can create many variations of backups, for example: * You can have a scheduled backup that runs every day at 6 pm that always keeps three backups or you can have a scheduled backup that runs once a month at 4 am that keeps only one backup.


6. In order to restore your accounts please contact Firescope support.

Import And Export

FireScope leverages an XML format for exporting and importing Configuration Items, Blueprints, Dashboards and Google Maps. To perform any of these functions, you will need to be logged into the solution with Administrator rights.

 Import:

  1. Click Administration > Utilities > Import. Import page will be displayed.

8750.Import Page.png-837x438.png

  1. Select Import Type(upper right hand corner) from the drop down selection.
  2. Depending on the Import Type selected, the form will display contains to choose from.
  3. Complete the form.
  4. Click on the Import button.


Export

  1. Click Adminintration > Utilities > Export. Export page will be displayed.

1616.Export Page.png-849x361.png

  1. Select Export Type(upper right hand corner) from the drop down selection.
  2. Depending on the Export Type selected, the form will display contains to choose from.
  3. Complete the form.
  4. Click on the Export button.

Configuration & Usage Statistics

Configuration with Errors

To allow your SPM application to function fully, make sure your configuration is healthy and not busy with errors. For example, a large number of erroneous Attributes will still task the system to try and retry with connection efforts. 

Attributes

Some possible errors with Attributes:* The device API changes due to a software update and the Attribute data request no longer works

Config Usage.png-950x487.png


Event Definitions / Aggregate Event Definitions / Policies

Some possible errors with Event Definitions:* The evaluation criteria has an error in the syntax

Config Usage ED Error.png-1009x413.png

Timezone

Edge Timezone

 Edge Device Time Zone in SPM

Pastedimage1462803683134v1.png-704x425.png 

Available with SPM Release 1.4-1-1

For Edge Devices, the time zone should be set to the TZDATA Standard for the Country/City where the Edge Device will be located. For example, if the Edge Device is hosted at a data center in Dallas, TX, USA, the time zone for the Edge Device VM would be ‘America/Chicago’ - a TZDATA Standard Country/City pairing that is representative of the Central Time Zone in America, but that also shares the same Daylight Savings operations as the host city. Another example would be an Edge Device hosted in Flagstaff, AZ, USA. The time zone for that Edge Device would be ‘America/Phoenix’, and not ‘America/Denver’. Both of those time zones are in the Mountain Time Zone, but Arizona deals with Daylight Savings differently than Colorado.

The time zone configured in the Edge Device VM should be representative of the physical location of the Edge Device VM itself and, by association, every CI that will be reporting to it. For this reason, the CMI is responsible for knowing what time zone the Edge Device will be placed in, so that it can be provisioned with this information.

Selecting the Time Zone

The CMI can set and update the Edge Device’s time zone from the Edge Device form. The selected time zone must match the time zone set in the Edge Device’s VM configuration.
  To select a new time zone,
# Administration > Edge Device > Create. Create Edge Device page will be displayed.

Create Edge Device.png-479x329.png

  1. Click on the Change button, under Time Zone.

Change Time Zone.png-373x230.png

  1. Select the Country from a drop down list.
  2. Select the Time Zone from drop down list, it will be update with available time zones for the selected country.
  3. Click on the Select button.
  4. Complete rest of the form and click on the Save button.


 Note: When updating an existing Edge Device, it is recommended to re-register the Edge Device to ensure the Edge Device has the most up-to-date information about itself from the CMI. 

Implications of Time Zone selection

The time zone setting on the Edge Device will be referenced by Attributes and scheduled processes that take place on the Edge Device to ensure that they are executed at the appropriate time relative to the Edge Device, and not the rest of the system.

For example, Attribute Flex Periods are created for particular days of the week, and hours in those days. If a Flex Period of Monday through Friday between 08:00-17:00 is given, it will be when the Edge Device’s clock ticks on Monday through Friday between 08:00-17:00. This will display on the web pages as Monday-Friday @ 08:00-17:00.

Account Timezone

Global Support CMI.png-705x425.pngUsing the Time Zone in SPM 
Data collection in SPM relies on all cloud components having consistent time settings to collect all data as GMT. As such, the application allows setting time zones for global account and individual users to be used for conversion when displaying dates and times. However, there are times when a User or Account does not actually operate in the same time zone where the data is collected or for where the main Account is setup. For these instances, the displayed time zone can be changed, shifting the time stamps of the data collection to an equivalent time stamp in the displayed time zone.#
Log into CMI account.
  1. Click on Administration > User Management > Accounts, edit Account page will be displayed.

8284.Edit Account CMI.png-455x391.png

  1. To select a new time zone, click on the Change button in the Account Locale section > Time Zone. Choose Time Zone Window will be displayed.

Change TimeZone.png-320x240.png

  1. Select the Country from a drop down menu.
  2. Select the Time Zone drop down will be update with available time zones for the selected country.
  3. Select the Time Zone
  4. Click on the Select button to save the changes.
  5. To select the Date and Time Format, click on Change > Date/Time Format. Choose the Date/Time Format window will be displayed.[1]

Change Date Time Account.png-320x240.png

  1. Select the Month, Day and Year Order & Formats.
  2. Select the Time Format and time Zone Display Preference
  3. Click on the Select button to save the changes.
  4. Complete rest of the form and click on the Save button.


When editing or creating an Account by a CMI administrator, one of the options to set is the default time zone. The date and time for this account will be displayed in a default format. This will provide a default time zone for new users created within that account. Initially, the display time zone is defaulted to the system configuration’s time zone.

User Time Zone

User Time Zones

The User’s default time zone will default to the time zone selected for the Account. In the case of a CMI user, it will be defaulted to the time zone of the CMI account; in the case of a client account user, it will be the client account’s time zone. In some instances, a user may wish to display their time stamps in a different time zone than that of the account. This can be changed in two places: the User Form (by administrators), and User Profile (by the user).

User Form

Administrators can edit a user’s time zone by selecting the user from the user list, and looking for the User Locale section of the user form. To select a new time zone, # Click on the Change button. Choose the Time Zone window will be displayed.  Pastedimage1487364484008v2.png-320x240.png

  1. Select the Country from a drop down menu. Select the Time Zone drop down will be update with available time zones for the selected country.
  2. Select the Time Zone and click on the Select button to save the changes.
  3. To Select the Date and Time Format click on the Change button under Date/Time Format. Choose the Date/Time Format window will be displayed.

3438.Change Date Time Account.png-413x149.png

  1. Select the Month, Day and Year Order and Formats.
  2. Select the Time Format and Time Zone Preference
  3. Click on Select to save the changes.
  4. Complete rest of the form and click on the Save button.


User Profile

 A user can edit their own time zone choice via the User Profile page, located in the User Icon menu at the top right of all SPM pages.

  Pastedimage1487364484009v3.png-320x240.png

 

Click on Edit User Profile. User Profile: Admin  page will be displayed

User TimeZone.png-735x440.png

 To select a new time zone,
# Click on the Change button under the User Locale section in the User Profile Form. Choose the Time Zone window will be displayed. 

Pastedimage1487364484009v5.png-320x240.png

  1. Select the Country from a drop down menu. Select the Time Zone drop down will be update with available time zones for the selected country.
  2. Select the Time Zone and click on the Select button to save the changes.
  3. To Select the Date and Time Format click on the Change button under Date/Time Format. Choose the Date/Time Format window will be displayed.

3438.Change Date Time Account.png-320x240.png

  1. Select the Month, Day and Year Order and Formats.
  2. Select the Time Format and Time Zone Preference
  3. Click on Select to save the changes.
  4. Complete rest of the form and click on the Save button.
Retrieved from "https://community.firescope.com/index.php?title=Admin_Guide&oldid=565"