--- GW IMAGE NOT DISPLAYED --- Configuring Profiles

Copyright 2006 GroundWork Open Source, Inc. (“GroundWork”).
All rights reserved. Use is subject to GroundWork commercial license.

Contents

Configuring Profiles


--- GW IMAGE NOT DISPLAYED --- How Do I Define a Host Profile?


The use of Profiles provides a way to save Host specific settings and Services so you can apply them to more that one Host. For example, what if you have 20 or say 200 more Hosts just like the one Host on the same network segment, you can utilize Host Profiles to apply these specific settings to all Hosts. Once the Host Profile is define you may want to change one of the parameters which then would be applied to all of the specified Hosts.

Step 1 – New Host Profile

  1. Select Profiles from the Configuration menu options.
  2. Select Host Profiles.
  3. Select New.
  4. In the New Host Profile screen, enter the properties (see Table 5.4.1a. below).
  5. Select Add to go to the Host Profile screen.

    Figure 5.4.1a. New Host Profile

    --- GW IMAGE NOT DISPLAYED ---

    Table 5.4.1a. New Host Profile

    Name [Required] Name of the Host Profile (e.g. linus_base).
    Description [Optional] Store comments or instructions here.
    Host Template [Required] Select the Host Template most suitable for this Host Profile (e.g. generic-host).

Step 2 – Host Profile – Host Detail

Now you can configure just about everything that the Nagios® engine can know about the Host with this form. The good part is that you can change this data at any time, and the Hosts that use this Profile will be updated with the new settings. This is similar to using templates in Nagios®, but the difference is that Nagios® templates do not support adding Services. In fact, all we really need to do here is to add a Service Profile to this Host Profile to move on.

You can then select the Service Profiles tab, and select a Profile from the list, save the Host Profile, and you are ready to import Hosts.

  1. In the Host Detail tab, enter the properties (see Table 5.4.1b. below).
  2. Select Save to save the new Host Profile. You will be prompted in the next screen that the Profile has been save. Select Close. Delete removes the current Host Profile, Rename is used to change the name of the current Host Profile, Export is used to save the current Host Profile to the directory /tmp/host_profile_<hostprofilename>.xml., and Close is used to exit the current Host Profile screen without saving.
  3. The other listed tabs within the Host Profile screen including Parents, Host Groups, Escalations, Assign Hosts, Assign Host Groups, and Apply are optional. The apply option determines how the Profile is used. You may choose whether or not to manage Parents or Host Groups from a Profile. Also, the apply settings are saved, so how the Profiles are applied remains the same from one session to the next.

    Figure 5.4.1b. Host Detail

    --- GW IMAGE NOT DISPLAYED ---

    Table 5.4.1b. Host Detail

    Name [Required] Name of the new Host Profile.
    Description [Optional] Store comments or instructions here.
    Host Template [Required] Select the Host Template most suitable for this Host. Note inheritance (left check box) on directives below. To override the template value, uncheck the left check box.
    Inherit All Values From Template Checked = sets all directives to inherit values from the selected template. Uncheck left checkbox on directives below to override template values.
    Process Performance Data [Optional] This directive is used to determine whether or not the processing of performance data is enabled for Hosts using this template. Values: unchecked = disable performance data processing, checked = enable performance data processing.
    Retain Status Information [Optional] This directive is used to determine whether or not status-related information about the Host is retained across program restarts. This is only useful if you have enabled state retention using the retain_state_information directive. Value: unchecked = disable status information retention, checked = enable status information retention.
    Flap Detection Enabled [Optional] This directive is used to determine whether or not flap detection is enabled for Hosts using this template. Values: unchecked = Disable Host Flap Detection, checked = enable Host Flap Detection.
    Low Flap Threshold [Optional] This directive is used to specify the low state change threshold used in flap detection for Hosts using this template. If you set this directive to a value of 0, the program-wide value specified by the low_host_flap_threshold directive will be used.
    High Flap Threshold [Optional] This directive is used to specify the high state change threshold used in flap detection for Hosts using this template. If you set this directive to a value of 0, the program-wide value specified by the high_host_flap_threshold directive will be used.
    Retain Nonstatus Information [Optional] This directive is used to determine whether or not non-status information about the Host is retained across program restarts. This is only useful if you have enabled state retention using the retain_state_information directive. Value: unchecked = disable non-status information retention, checked = enable non-status information retention.
    Active Checks Enabled This directive is used to determine whether or not active checks (either regularly scheduled or on-demand) of this Host are enabled. Values: unchecked = Disable Active Host Checks, checked = Enable Active Host Checks.
    Passive Checkes Enabled This directive is used to determine whether or not passive checks are enabled for this Host. Values: uncehcked = Disable Passive Host Checks, checked = Enable Passive Host Checks.
    Obsess Over Host This directive determines whether or not checks for the Host will be obsessed over using the ochp_command (defined in Nagios® main configuration). Checked = enabled
    Check Freshness This directive is used to determine whether or not freshness checks are enabled for Hosts using this template. Checked = enable freshness checks.
    Freshness Threshold This directive is used to specify the freshness threshold (in seconds) for Hosts using this template. If you set this directive to a value of 0, Nagios® will determine a freshness threshold to use automatically.
    Check Command [Optional] This directive is used to specify the short name of the command that should be used to check if the Host is up or down. Typically, this command would try and ping the Host to see if it is ‘alive’. The command must return a status of OK (0) or Nagios® will assume the Host is down. If you leave this argument blank, the Host will not be checked – Nagios® will always assume the Host is up. This is useful if you are monitoring printers or other devices that are frequently turned off. The maximum amount of time that the notification command can run is controlled by the host_check_timeout option.
    Max Check Attempts [Required] This directive is used to define the number of times that Nagios® will retry the Host Check Command if it returns any state other than an OK state. Setting this value to 1 will cause Nagios® to generate an alert without retrying the Host check again. Note: If you do not want to check the status of the Host, you must still set this to a minimum value of 1. To bypass the Host check, just leave the check_command option blank.
    Check Interval [Optional] NOTE: Do NOT enable regularly scheduled checks of a Host unless you absolutely need to! Host checks are already performed on-demand when necessary, so there are few times when regularly scheduled checks would be needed. Regularly scheduled Host checks can negatively impact performance. This directive is used to define the number of “time units” between regularly scheduled checks of the Host. Unless you’ve changed the interval_length directive from the default value of 60, this number will mean minutes.
    Event Handler Enabled [Optional] This directive is used to determine whether or not the event handler for Hosts using this template is enabled. Values: unchecked = Disable Host Event Handler, checked = Enable Host Event Handler.
    Event Handler [Optional] This directive is used to specify the short name of the command that should be run whenever a change in the state of the Host is detected (i.e. whenever it goes down or recovers). The maximum amount of time that the event handler command can run is controlled by the event_handler_timeout option.
    Notifications Enabled [Optional] This directive is used to determine whether or not notifications for Hosts using this template are enabled. Values: unchecked = Disable Host Notifications, checked = Enable Host Notifications.
    Notification Interval [Required] This directive is used to define the number of ‘time units’ to wait before re-notifying a contact that this server is still down or unreachable. Unless you’ve changed the interval_length directive from the default value of 60, this number will mean minutes. If you set this value to 0, Nagios® will not re-notify contacts about problems for Hosts using this template – only one problem notification will be sent out.
    Notification Period [Required] This directive is used to specify the short name of the time period during which notifications of events for Hosts using this template can be sent out to contacts. If a Host goes down, becomes unreachable, or recoveries during a time which is not covered by the time period, no notifications will be sent out.
    Notification Options [Required] This directive is used to determine when notifications for the Host should be sent out. Valid options are a combination of one or more of the following: Down checked = send notifications on a DOWN state, Unreachable checked = send notifications on an UNREACHABLE state, and Recovery checked = send notifications on recoveries (OK state). If you specify n (none) as an option, no Host notifications will be sent out. Example: If you specify Down and Recovery, notifications will only be sent out when the Host goes DOWN and when it recovers from a DOWN state.
    Stalking Options [Optional] This directive determines which Host states ‘stalking’ is enabled for. Valid options are a combination of one or more of the following: Up checked = stalk on UP states, Down checked = stalk on DOWN states, and Unreachable checked = stalk on UNREACHABLE states.
    Contact Groups This is a list of the short names of the contact groups that should be notified whenever there are problems (or recoveries) with this Host.
    Extended Host Info Template [Optional] Defines extended Host information for this Host profile. The template controls the icon and url link as seen in Nagios®.

Configuring Profiles


--- GW IMAGE NOT DISPLAYED --- How Do I Define a Service Profile?

Service Profiles are a collection of multiple Services. For example, you would typically want to check more than just disk space on a Linux Host. Some measure of memory use is also a good idea, and CPU load is also interesting. GroundWork Monitor contains several Commands and Services for checking these and many other parameters on Linux Hosts. These Services are grouped into Service Profiles, which you can use as is or modify to fit your needs. Select Profiles under the Configuration tab, and select Service Profiles to see what you have to choose from. Select ssh_unix to see a Linux Service Profile.

Step 1 – New Service Profile

  1. Select Profiles from the Configuration menu options.
  2. Select Service Profiles.
  3. Select New.
  4. In the New Service Profile screen, enter the properties (see Table 5.4.2a. below).
  5. Select Add, the Service Profile screen will be displayed.

    Figure 5.4.2a. New Service Profile

    --- GW IMAGE NOT DISPLAYED ---

    Table 5.4.2a. New Service Profile

    Name [Required] Name of the New Service Profile.
    Description [Optional] Store comments or instructions here.

Step 2 – Service Profile Properties

  1. In the Service Profile screen, enter the properties (see Table 5.4.2b. below).
  2. Select Save to add and save the new Service. If you do not select Save and go to another tab you will lose your changes. After saving, you will be prompted in the next screen that the Service has been save. Select Close. Other options in addition to saving include Delete which removes the current Service Profile, Rename changes the name of the current Service Profile, Export exports the current Service Profile to /tmp/service_profile_ssh_unix.xml for example, and Close to exit the current Service Profile screen without saving.

    Figure 5.4.2b. Service Profile Properties

    --- GW IMAGE NOT DISPLAYED ---

    Table 5.4.2b. Service Profile Properties

    Name [Required] Name of the New Service Profile.
    Description [Optional] Store comments or instructions here.
    Services [Required] Select Services from the right hand list to be included in this profile. Where Service dependencies have been assigned to Service names, be careful to include the parent Service names as defined in the dependency templates.


OTHER SERVICE PROFILE OPTIONS


Assign Hosts

The Assign Hosts tab within the Service Profiles screen enables you to add or remove Hosts to be managed by this Service Profile. Removing a Host means the Host is no longer managed by this Service Profile. After saving, you will need to use the Apply tab to instantiate changes to the Host. The Host will retain its properties until the Host is assigned and applied to another Profile, or modified individually.

Figure 5.4.2c. Assign Hosts

--- GW IMAGE NOT DISPLAYED ---


Assign Host Groups

The Assign Host Groups tab within the Service Profiles screen enables you to add or remove Host Groups to be managed by this Service Profile. Removing a Host Group means the Host Group is no longer managed by this Service Profile. After saving, you will need to use the Apply tab to instantiate changes to the member Hosts. The member Hosts will retain their properties until the Host Group is assigned and applied to another Service Profile, or the member Hosts are modified individually.

Figure 5.4.2d. Assign Host Groups

--- GW IMAGE NOT DISPLAYED ---


Host Profiles

The Host Profiles tab within the Service Profiles screen enables you to add or remove Host Profiles to which this Service Profile is assigned. Adding or removing a Host Profile here has no effect the Host Profile’s member Hosts until the Apply tab is used on the Host Profile, or the Profile is applied on the individual Hosts.

Figure 5.4.2e. Host Profiles

--- GW IMAGE NOT DISPLAYED ---


Apply

The Apply tab within the Service Profiles screen enables you to select Apply to Host Groups and/or Apply to Hosts to push changes to Hosts, and select from the options what to apply. If you select replace existing Services, all Services are removed from the Host and new ones are added from the Profile. Merge with existing services means any existing Service on the Host remains unchanged.

Figure 5.4.2f. Apply

--- GW IMAGE NOT DISPLAYED ---

Configuring Profiles


--- GW IMAGE NOT DISPLAYED --- How Do I Import Profiles?


The Profile Importer tool is used to re-import, update modifications, or import customized Profiles into the Monarch database. You can also select to remove unwanted Profiles. The Importer will list the available XML Profiles that are in the /usr/local/groundwork/profiles folder. The Importer will import the XML file and automatically search and import its Performance Configuration companion file (if there is one). Any associated Plugins will need to be copied to the GroundWork Server.

Several Profiles are included in the GroundWork Monitor product. Refer to the Bookshelf for a list of distributed Profiles and detailed definitions under GroundWork Reference>Administrator>GroundWork Profiles.

Profile Importer

  1. Select Profiles from the Configuration menu options.
  2. Select Profile Importer.
  3. In the Profile Importer screen the Import Folder listed indicates the location of the profile files. You will see a list of all eligible files in this directory. Click the radio button next to the Profiles you wish to import.
  4. To overwrite existing objects and replace all matching Time Periods, Commands, Templates, Services, and Profiles check the Overwrite Existing Objects option before selecting Import.
  5. Use the Upload option to upload Profiles from your desktop and then use Import. Also, Profile files can be generated from the Export option found on the main Host Profile page or the main Service Profile page.

    Figure 5.4.3a. Profile Importer

    --- GW IMAGE NOT DISPLAYED ---

Leave a Reply

Your email address will not be published. Required fields are marked *

clear formPost comment