SUSE Manager Management Pack for Microsoft System Center Operations Manager

User Manual
SUSE Manager Management Pack for Microsoft System Center Operations Manager

SUSE Manager Management Pack for Microsoft System Center extends the functionality of System Center Operations Manager (SCOM) and utilizes the power of SUSE Manager for managing a Linux environment, allowing Windows administrators to view Linux server health information, and perform Linux patching via the SCOM console, saving time and money.

The document at hand explains how to use SUSE Manager Management Pack for Microsoft System Center Operations Manager.

1.0 Introduction

Management Packs typically contain monitoring settings for applications and services. After a management pack is imported into Microsoft System Center Operations Manager 2007, Operations Manager 2012/R2 management group, and Microsoft System Center Operations Manager 2016, Operations Manager immediately begins monitoring objects based on default configurations and thresholds that are set by the Management Pack.

Microsoft System Center Operations Manager provides a general foundation for monitoring and managing systems and software. This foundation knows nothing about how to do these things for specific components, however.

Providing this specialized knowledge is the responsibility of management packs. SUSE Manager Management Pack for Microsoft System Center extends the functionality of Microsoft System Center Operations Manager and utilizes the power of SUSE Manager for managing a Linux environment, allowing Windows administrators to view Linux server health information, and perform Linux patching via the Microsoft System Center Operations Manager console, saving time and money.

The Management Pack was developed to interact with SUSE Manager using SUSE Manager’s open application programming interface. Windows administrators import the Management Pack into Microsoft System Center Operations Manager and deploy a SUSE Manager Server with the SUSE Manager Lifecycle management module on each Linux server to be managed by Microsoft System Center Operations Manager. Information about patch status and health of the managed Linux servers is passed through to Microsoft System Center Operations Manager, where it may be viewed and acted upon by the administrator.

1.1 Key Features

From a single console via tight integration between SUSE Manager and Microsoft System Center Operations Manager, system administrators are able to:

  • Quickly check all Linux servers for health and update status.

  • View a list of all Linux servers entitled to a selected list of critical and optional updates and patches.

  • Schedule a maintenance window to run updates on a specific Linux server or a group of Linux servers.

1.2 Key Benefits

The key benefits of using SUSE Manager Management Pack for Microsoft System Center Operations Manager are as outlined below:

  • Reduce cost: leverage your investment in existing infrastructure including software, hardware, and expertise.

  • Save time: Linux patch management can be done from the same Microsoft System Center Operations Manager console rather than splitting time between silos.

  • Minimize risk: improved efficiency in the patching and updating process translates to lower risk of failure via a missed or incorrectly applied patch.

2.0 Patch Management

In this module, all kinds of patch-related events can be managed. It enables administrators to schedule a patch for a particular system, view the number of relevant patches, upgradable packages, removable packages, and installable packages available to the system, etc. Using this module administrators can view scheduled events and their status. It also provides system health information such as critical, warning, and healthy. It provides information about the systems, patches, and channels to which a system is subscribed.

  • For Microsoft System Center Operations Manager 2007 R2, Patch Management can be accessed through the following path:

    Open Microsoft System Center Operations Manager 2007 R2 Operations Console, click Monitoring, click UNIX/Linux Servers, click Linux, click Patch Management.

    Figure 1 Patch Management System Center Operations Manager 2007 R2

  • For Microsoft System Center Operations Manager 2012 R2 and Microsoft System Center Operations Manager 2016, Patch Management can be accessed through the following path:

    Open Microsoft System Center Operations Manager 2012 R2 / 2016 Operations Console, click Monitoring, click UNIX/Linux Servers, click Linux, click Patch Management.

    Figure 2 Patch Management System Center Operations Manager 2012 R2

  • Patch Management contains three different types of views:

    1. Systems:

      This view displays the list of managed Linux systems which are attached to both Microsoft System Center Operations Manager and SUSE Manager. The main panel of the Systems tab provides a list of systems subscribed to Microsoft System Center Operations Manager and SUSE Manager. Beneath that there are subtabs which show relevant patches, removable packages, upgradable packages, installable packages, etc., which are related to a system. Administrators need to select systems to perform actions on them. This allows to install relevant patches and packages, remove packages, upgrade packages, deploy configuration files, issue remote commands, auto install, view system properties, view system events, base and configuration channels.

      Figure 3 Patch Management System View

    2. Patches:

      This view displays patches relevant to the type of Linux version for at least one of your managed systems that have not been applied yet. Administrators can track the availability and application of patches to their managed systems. SUSE distinguishes between three types of patches: security updates, bug fix updates, and enhancement updates. Each patch is comprised of a summary of the problem and solution, including the RPM packages fixing the problem.

      Figure 4 Patch Management Patches View

    3. Schedule:

      This view enables administrators to track the actions carried out on systems. An action is a scheduled task to be performed on one or more client systems. For example, an action can be scheduled to apply all patches to a system .

      Figure 5 Patch Management Schedule View

  • The status of the system changes to

    • Critical: when relevant patches of the type security advisory exist.

    • Warning: when relevant patches of the type bug fix advisory exist.

    • Healthy: when no relevant patches exist.

  • SUSE Manager monitoring is done using probe actions every four minutes. The system view has to be refreshed manually.

2.1 Systems Tab

You can access the Systems tab through the following path:

Open the Microsoft System Center Operations Manager Operations console, click Patch Management, click the Systems tab (default).

  • The main grid consists of the following items:

    • SystemId: ID of the system

    • SystemName: name of the system

    • Status: provides status of the system such as critical or warning

    • AvailablePatches: patches available to the system

    • AvailablePackages: packages available to the system

  • A Detailed View is displayed under this tab. When a system ID is selected, relevant data will be populated in the following grids:

    • Relevant Patches: patches which are relevant to the system

    • Removable Packages: packages which can be removed from the system

    • Upgradable Packages: packages which can be upgraded

    • Installable Packages: packages which can be installed on the system

    • Channels: channels to which the system is subscribed

    • Events: events recently occurred on the system

    • System Properties: properties of the system

Figure 6 Patch Management Systems Tab Details

Applying Relevant Patches

The Relevant Patches page displays a customized list of patches applicable to a selected system. The list provides a summary of each patch, including its type, severity (for security updates), advisory number, synopsis, systems affected, and date updated.

You can access the Relevant Patches tab through the following path:

Open the Microsoft System Center Operations Manager Operations console, click Patch Management, go to the Systems tab (default), and click on Relevant Patches (which is located under the Systems panel).

  • The grid consists of the following columns:

    • ID: ID of the patch

    • Advisory: the SUSE security team codifies advisories in the following way: SUSE- RU-2011:0030

    • Synopsis: provides a synopsis of the patch

    • Type: provides the type of advisory which may be bug fix advisory, product advisory, or product enhancement advisory

    • UpdateDate: provides the updated date of the patch.

  • Select the patches you want to apply and click the Apply Selected Patches button to apply the selected patches to the particular system.

  • After clicking the button Schedule Your Action, a dialog box will pop up with two options to confirm the date and time of the patch that needs to be applied:

    • Schedule action as soon as possible

    • Schedule action for no sooner than

    For the Schedule action for no sooner than option, the selected time and date should be greater than the current time. Otherwise you will see the message please select date greater than current date on the screen. Upon confirmation, the selected patch will be scheduled for an update to the system. If you select the Cancel button, the pop-up window will close.

    Figure 7 Applying Relevant Patches Schedule

    The scheduled action can be found in the Schedule tab.

  • Details related to Relevant Patches will be displayed in the following grids:

    • Patch Details: details of the selected patch

    • CVEs: the name assigned to the security advisory by the Common Vulnerabilities and Exposures (CVE) project at http://cve.mitre.org (for example: CVE-2006-4535)

    • Related Packages: packages that are related to the selected patch

    • Affected Systems: systems that are affected by the selected patch

      • A patch can be applied to a particular affected system by clicking Apply Patch under that grid

      • When the Apply Patch button is clicked, a pop-up window will open with two options to confirm the date and time of the patch that needs to be applied:

        • Schedule actions as soon as possible

        • Schedule action for no sooner than

        Upon confirmation, the selected patch will be scheduled for an update to the system. If Cancel is selected, the pop-up window will close.

Figure 8 Relevant Patches Tab

Removable Packages Applicable to a System

The Removable Packages page lists installed packages and enables administrators to remove them. You can view and sort packages by name, architecture, and the date they were installed on the system. You can search for the desired packages by typing their name in the Filter by Package Name text box, or by clicking the letter or number corresponding to the first character of the package name. Click on a package name to view its package details in the lower panel. To delete packages from a system, select and click the Remove Packages button in the bottom left-hand corner of the panel. Click confirm to remove the packages.

Access the Removable Packages tab through the following path:

Open the Microsoft System Center Operations Manager Operations console, click on Patch Management, go to the Systems tab (default), and click Removable Packages.

  • The grid consists of the following columns:

    • Name: provides the name of the package

    • Version: provides the version of the package

    • Epoch: provides the timestamp for the package

    • Architecture: names the supported architecture

    • Release: provides the release version

    • InstallTime: provides the time of installation

  • Select the packages you want to remove and click the Remove Selected Packages button which is used to remove selected packages from the selected system.

  • After clicking the button Schedule your Action, a dialog box pops up with two options to confirm the date and time of the package for removal:

    • Schedule actions as soon as possible

    • Schedule action for no sooner than

    For the Schedule action for no sooner than, the selected time and date should be greater than the current time. Otherwise you will see the message please select date greater than current date on the screen. Upon confirmation, the particular package will be scheduled for removal from the selected system. If you select the Cancel button, the pop-up window will close.

    Figure 9 Removing Packages Schedule

    The scheduled action can be found in the Schedule tab.

  • Details related to the Removable Packages tab will be displayed in the following grids:

    • Package Details: details of the selected package

    • Dependencies: other dependencies of the selected package

    • Change Log: log changes of the selected package

    • File List: list of files associated with the selected package

Figure 10 Removable Packages Tab

Upgradable Packages Applicable to a System

The Upgradable Packages tab displays a list of packages with newer versions available in the subscribed channels. Click on the latest package name to view the package details in the lower panel. To upgrade packages immediately, select the respective packages and click Upgrade Packages.

Access the Upgradable Packages tab through the following path:

Open the Microsoft System Center Operations Manager Operations console, click on Patch Management, go to the Systems tab (default) and click on Upgradable Packages.

  • The grid consists of the following columns:

    • Name: provides the name of the package

    • Architecture: provides the architecture it supports

    • FromVersion: names the present version of the package in the system

    • FromRelease: names the present release version of the package in the system

    • FromEpoch: provides the time stamp

    • ToVersion: names the upgradable package version

    • ToRelease: names the present release of the package which the system needs to be upgraded to

    • ToEpoch: provides the time stamp

    • PackageId: provides the package ID

  • Select the packages you want to upgrade and click the Upgrade Selected Packages button which is used to upgrade the selected packages for the selected system.

  • After clicking the button Schedule Your Action, a dialog box pops up with two options to confirm the date and time of the package that needs to be upgraded.

    • Schedule actions as soon as possible

    • Schedule action for no sooner than

    For the Schedule action for no sooner than option, the selected time and date should be greater than the current time. Otherwise you will see the message please select date greater than current date on the screen. Upon confirmation, the particular package will be scheduled for an upgrade to the selected system.

    Figure 11 Upgrading Packages Schedule

  • Details related to the Upgradable Packages tab will be displayed in the following grids:

    • Package Details: provides details of the selected package

    • Dependencies: provides other dependencies of the selected package

    • Change Log: provides log changes of the selected package

    • File List: provides the list of files associated with the selected package

Figure 12 Upgradable Packages Tab

Installable Packages Applicable to a System

The Installable Packages tab displays a list of packages which are installable and available in the subscribed channels. Click on the latest package name to view its package details page. To install packages immediately, select them and click Install Packages.

Access the Installable Packages tab through the following path:

Open the Microsoft System Center Operations Manager Operations console, click on Patch Management, go to the Systems tab (default) and click on Installable Packages.

  • The grid consists of the following items:

    • Name: provides the name of the installable package

    • Architecture: provides the architecture it supports

    • Version: provides the version of the installable package

    • Release: provides the release version of the package

    • Epoch: provides the timestamp

    • PackageId: provides the package ID

  • Select the packages you want to install and click the Install Selected Packages button which is used to install the selected packages for the particular system.

  • After clicking the button, a dialog box pops up with two options to confirm the date and time of the package that needs to be installed:

    • Schedule action as soon as possible

    • Schedule action for no sooner than

    For the Schedule action for no sooner than option, the selected time and date should be greater than the current time. Otherwise you will see the message please select date greater than current date on the screen. Upon confirmation, the particular package will be scheduled for installation to the selected system.

    Figure 13 Upgrading Packages Schedule

    The scheduled action can be found in the Schedule tab.

  • Details related to the Installable Packages tab will be displayed in the following grids:

    • Package Details: details of the selected package

    • Dependencies: other dependencies of the selected package

    • Change Log: changes to a selected package

    • File List: list of files associated with the selected package

Figure 14 Installable Packages Tab

Channels

The Channels tab provides a well-defined method to determine which packages should be available to a system for installation or upgrade based upon their operating systems, installed packages, and functionality. Click a channel name to view its channel details page. The list of channels to which the selected system is subscribed is displayed in this tab.

Access the Channels tab through the following path:

Open the Microsoft System Center Operations Manager Operations console, click on Patch Management, go to the Systems tab (default) and click on Channels.

  • The grid consists of the following columns:

    • Name: provides the name of the channel

    • ChannelLabel: provides the label of the channel

  • Details related to the Channels tab will be displayed in the following grids:

    • Channel Properties: properties of the selected channel

    • Channel Patches: patches that are published to the selected channel

    • Channel Packages: packages that are subscribed to the selected channel

    • Subscribed Systems: systems that are subscribed to the selected channel

Figure 15 Channels Tab

Events

The Events tab displays past, current, and scheduled actions on a system.

Access the Events tab through the following path:

Open the Microsoft System Center Operations Manager Operations console, click on Patch Management, go to the Systems tab (default) and click on Events.

  • Details related to the Channels tab will be displayed in the following grids:

    • Pending Events: lists events that are scheduled but have not started

      A prerequisite action must complete successfully before the given action is attempted. Actions can be chained so that action A requires action B which requires action C. If any action in the chain fails, the remaining actions also fail.

    • History: provides the history of events that have occurred on a system

Figure 16 Events Tab

System Properties

The System Properties tab provides the properties of the selected system such as system ID, description, base entitlement, add-on entitlement, auto update, and so on.

Access the System Properties tab through the following path:

Open the Microsoft System Center Operations Manager Operations console, click on Patch Management, go to the Systems tab (default) and click on System Properties.

Figure 17 System Properties Tab

Auto Installation

Overview

SUSE Manager uses cobbler to set up PXE and auto installation methods for provisioning. However, if you manually administer cobbler from the command line, SUSE Manager knows what has and has not been configured via the SUSE Manager Web interface, and the Web interface will show the changes. But it will also show that they are not managed by SUSE Manager and will not allow you to edit or change the settings. Therefore, it is recommended to set up your environment through the Web interface.

To set up SUSE Manager for the auto installation or provisioning, you need to perform the following steps (which will be outlined in detail in the following sections):

  1. Configure your DHCP server for PXE booting (the example given is for a Windows Server based DHCP server).

  2. Perform various cobbler setup actions from the command line.

  3. Make the installation files of your Linux distribution available somewhere on the SUSE Manager server’s file system.

  4. Perform the remaining auto installation setup items via the SUSE Manager Web interface.

DHCP Server Setup

These are the steps you need to perform to set up the DHCP server:

  1. Open the Server Manager on the DHCP Server

    1. Select DHCP Server

    2. Select 'server_name'

    3. Select IPv4

    4. Select Scope

    5. Select Scope Options

    6. Right-click in the Options page and select Configure options...

  2. Check option 066 and set it to the IP address of the TFTP server (the SUSE Manager server in this case)

  3. Check option 067 and set it to pxelinux.o

Cobbler Setup

Run the command cobbler check from the command line and take care of any potential configuration items returned by this command. Here are the items in the list that you will need to set up:

  • Pull in various PXE loaders via

    • cobbler get-loaders

  • Change the default password used by the sample templates for newly installed machines (default_password_crypted in /etc/cobbler/settings) by executing the following steps:

    • Execute the command

      openssl passwd -1 -salt 'r4nd0WPA$$wordpassphrase' 'PA$$word'

      to get the hashed value for the password given. It will look similar to the following:

      $1$r4nd0WPA$ARWps.KUMHpz/DcckxJmj0

    • Add the generated string from the command above to the cobbler settings file:

      /etc/cobbler/settings

    • You can edit the file using the command:

      vim /etc/cobbler/settings

  • TFTP server. SUSE Manager has atftpd installed by default (use the default, apparently it comes with KIWI build system integration).

    • Enable the TFTP daemon to start by default via

      • chkconfig atftpd on

  • Enable rsync

    • Change the disable line to no instead of yes in /etc/xinetd.d/rsync using the command

      vim /etc/xinetd.d/rsync

  • Restart and synchronize cobbler using the following commands:

    • /etc/init.d/cobblerd restart

    • cobbler sync

Prepare the System for Serving Distribution Trees

On SUSE Manager server, make sure /etc/hosts references the external IP address for the host name, not a loopback address (for example 127.0.0.1). If this isn't done, SUSE Manager creates references to 127.0.0.1 when setting up the PXE configuration. This obviously wouldn't work if a client tried to access the Kickstart/AutoYaST files on localhost.

Before making the distribution tree, check whether the system is subscribed to any tools channel. If it is not subscribed, issue the following command mgr-ncc-sync -l in the SUSE Manager server system and check the available channels.

Follow the instructions presented on the screen and add the tools channel database to your SUSE Manager server using the command mgr-ncc-sync -c plus the tools channel name.

Subscribe the system for which you want to perform automated installation to the tools channel. During automated installation the system needs some tools like Spacewalk-Koan, which are provided by the tools channel.

Making SUSE Linux Enterprise Server Installation Files Available on the File System

Before making the distribution files, enable the Provisioning entitlement on the system using the SUSE Manager Web UI. Select the system you want to enable for Provisioning entitlement and go to Details. Select Properties, check the Provisioning add-on entitlement and click the Update Properties button. There are two options for making the SUSE Linux Enterprise Server installation files available on the SUSE Manager server. Either copy the files from the ISO image or a CD to a location on the file system or just mount the SUSE Linux Enterprise Server installation ISO to a location on the file system.

  • Option 1:

    Copy the contents of the installation CD or DVD (the operating system which needs to be installed) to any location in SUSE Manager. If you have an .iso file then mount that image using the command mount –o loop followed by the source path (path of .iso file) and the destination path (mounting point). Before that you need to create a mount point using the command mkdir /mnt/ followed by the name of your mounting point.

    • Put the the files into /storage/dist/ followed by the distribution name using the command cp –R /mnt/ followed by the mounting point name and the destination path (your location of Distro). Do not put them in /srv/www/cobbler as the files will be erased on a cobbler synchronization initiated from the SUSE Manager Web interface (which synchronizes the settings from the SUSE Manager database onto the cobbler setup on the file system, erasing any manual changes in the process).

  • Option 2: Mount ISO image

    • Copy a SUSE Linux Enterprise Server installation ISO into /storage/iso/

    • Create a mount point

    • Mount the ISO by default in /etc/fstab

      • /storage/iso/SLES-11-SP1-DVD-x86_64-GM-DVD1.iso /mnt/sles11-sp1-x86_64-iso udf,iso9660 user,loop,ro 0 0

      • /storage/iso/rhel-server-6.1-x86_64-dvd.iso /mnt/rhel61-x86_64-iso udf,iso9660 user,loop,ro 0 0

      • Run mount -a after the change to fstab to activate the change

Creating Distributions Using the SUSE Manager Web UI

Auto installation distributions need to be created before creating an auto installation profile. Remember that SUSE Manager automatically copies kernel and initrd images in place from the installation tree (ISO image tree). It also makes the installation tree available via HTTP, which means the installation files can be placed anywhere on the server.

  • Create the auto installation distribution. Go to the Web interface, then to Systems, choose Autoinstallation, and then Distributions.

    • For the tree path, provide the local directory on the server where the ISO installation files are located (for example /storage/dist/rhel61-x86_64). Do not worry about setting up Apache to serve the installation trees. SUSE Manager will take care of making the local directory available via HTTP.

    • Leave the kernel options blank. SUSE Manager will automatically populate this for SUSE Linux Enterprise Server systems. For Red Hat Enterprise Linux systems, SUSE Manager will not automatically populate it (but the information does not seem to be important anyhow).

  • Create the automatic installation profile.

NOTE: Cobbler Equivalent

In the SUSE Manager Web interface, there is a mapping to the cobbler command line equivalent:

  • If you go to the Web interface, choose Systems, then Auto Installation, and then Distributions, you get the equivalent to Cobbler Distro .

    This essentially copies the kernel and initrd images from the installation tree to /srv/tftpboot/images. Keep in mind that this step does not yet create a PXE entry. That happens only when a cobbler profile is created.

  • If you go to the Web interface, choose Systems, then Auto Installation and then Profiles, you get the equivalent to Cobbler Profile .

    This step creates entries in the PXE boot menu. Multiple profiles can use the same underlying distro (kernel and initrd).

Auto Installation Using Kickstart Profiles

IMPORTANT:Refer to Overview before proceeding. If you encounter issues in setting up the system for auto installation, refer to Section 3.0, Troubleshooting Tips.

The Provisioning service is designed to allow you to deploy and manage your network of SUSE Linux Enterprise systems and Red Hat Enterprise Linux systems.

Like the SUSE Manager subscription service, which allows you to manage your network of SUSE Linux Enterprise systems, Red Hat Enterprise Linux systems, users, and system groups, provisioning is also based on an organization which contains a network of SUSE Linux Enterprise systems, Red Hat Enterprise Linux systems, users, and system groups.

It takes this concept a step further by enabling you with provisioning entitlements to autoinstall using Kickstart profiles. Kickstart profiles are the recipes that allow the installer to install the system with all of the configurations that the user wants. They reside in a predefined path in the SUSE Manager system. At the time of autoinstallation, the client system accesses that file and installs the system according to that configuration.

The Provisioning tab and its subtabs allow you to schedule and monitor Kickstart installations. The subtabs are further divided into a Schedule and a Status subtab.

Scheduling Auto Installation

The tab Schedule allows you to schedule an auto installation for a system using a Kickstart profile. Choose from the list of available profiles, select a time for the autoinstallation to begin, and click the Schedule Autoinstall and Finish buttons to schedule the autoinstallation.

Figure 18 Scheduling Auto-Installation Using Patch Management

  • The grid consists of the following columns:

    • KickstartProfileLabel: provides the label of the Kickstart profile

    • KickstartTreeLabel: provides the label of the Kickstart distribution tree

    • KickstartProfileName: provides the name of the Kickstart profile

    • IsAdvancedMode: states true or false according to whether the profile is using advanced options or not

    • IsOrgDefault: states true or false

    • IsActive: states true or false according to whether the profile whether it is active or not

Figure 19 Kickstart Profiles for Provisioning in Patch Management

The tab Status tracks the progress of previously scheduled auto installations, stating whether they are completed or failed and giving additional information.

  • The grid consists of the following columns:

    • Id: provides the ID of the event

    • Name: provides the name of the event

    • ActionType: provides the type of action the event is going to perform

    • Version: provides the version number

    • SchedulerUser: provides the scheduler user information

    • CreatedDate: provides the date of creation

    • EarliestAction: provides the earliest expected time of picking up the action

    • ModifiedDate: provides the modified date when it exceeds the EarliestAction time

    • PickupDate: provides the actual pickup date

    • Result: provides the result after completion of the event

    • FailedCount: provides the count of failed systems

    • SuccessCount: provides the count of successfully completed systems

Figure 20 Provisioning Status Information in Patch Management

Configuration Management

Enabling Remote Command Execution

To enable remote command execution (configuration feature) in the client system, the following steps must be performed:

  1. First make sure the client system is up to date and has all relevant patches and packages installed. Check the Relevant patches tab and the Upgradable packages tab under the Systems tab. If there are still some items in the list then apply those patches and packages.

  2. In the client system, check whether the Rhncfg packages are installed. In the terminal window, type the command rpm –qa|grep rhncfg.

  3. If the packages are already installed then the system should display the following packages with their version number:

    rhncfg-management

    rhncfg-actions

    rhncfg

    rhncfg-client

  4. In the SUSE Manager Web UI select the Configuration tab. In the Configuration section, there is a table named Configuration Actions. From that table select Enable Configuration Management On Systems. From the list of systems, select the system on which you want to install the packages and click the Enable SUSE Manager Configuration button.

    Figure 21 Enabling SUSE Manager Configuration Feature in SUSE Manager Web UI

  5. If the step described above does not work, you need to install the missing packages by moving to the Installable packages tab (go to System and choose Installable packages). Refer to Section 3.0, Troubleshooting Tips if you are facing any problems.

  6. After installing these packages, run the command rpm –qa|grep rhncfg and make sure you get the installed packages list as shown in step 3.

  7. Next log in to the SUSE Manager server system as root and add the following file to the local SUSE Manager configuration directory: allowed-actions/script/run.

    1. Create the necessary directory on the target system:

      mkdir -p /etc/sysconfig/rhn/allowed-actions/script

    2. Create an empty run file in that directory which acts as a flag to SUSE Manager signaling permission to allow remote commands:

      touch /etc/sysconfig/rhn/allowed-actions/script/run

  8. Run the following commands from the terminal of the target system:

    1. First run rhn_check.

    2. After that run one of the following:

      for Red Hat Enterprise Linux systems

      rhn-actions-control --enable-all

      and for SUSE Linux Enterprise Server systems

      rhn-actions-control --enable-all

      or

      Mgr-actions-control --enable-all

    3. Make sure you get the following result when you issue the command rhn-actions-control --report:

      sles11sp2x64-om2012-sm17:/ # rhn-actions-control --report
      deploy is enabled
      diff is enabled
      upload is enabled
      mtime_upload is enabled
      run is enabled
      sles11sp2x64-om2012-sm17:/ #
    4. Run the command cd /etc/sysconfig/rhn/allowed-actions/configfiles.

      In the above-mentioned directory you should now see a file named all.

    5. Check if you have properly executed the above commands by entering the command rhncfg-client listin the terminal window.

      It should display the list of configuration channels with the configuration files to which that target system is subscribed, similar to the below:

      sles11sp2x64-om2012-sm17:/ # rhncfg-client list
      DoFoS       Config Channel   File
      F   testsandboxchannel     /etc/ldapnew.conf
      sles11sp2x64-om2012-sm17:/ #
                                      

      After installing these packages and creating the necessary folders try issuing a remote command providing the necessary inputs and scripts in the text boxes provided in the Remote Command tab. Refer to Section 3.0, Troubleshooting Tips if you are facing any problems.

  9. For creating the configuration channels and adding configuration files in the SUSE Manager Web UI, please refer to the SUSE Manager Installation and Troubleshooting Guide at https://www.suse.com/documentation/suse-manager-3/singlehtml/suse_manager21/book_susemanager_install/book_susemanager_install.html.

Deploying Configuration Files Using Configuration Channels

To enable Configuration File deployment in the client system follow the steps provided in Configuration Management. For more information on troubleshooting refer to Section 3.0, Troubleshooting Tips.

In Configuration Channels, you can check configuration channels and files, centrally or limited to a single system. Centrally-managed files are available to multiple systems; changes to a single file affect all these systems. Each system with a lifecycle entitlement has also a local configuration channel, sometimes referred to as an override channel, and a sandbox channel. Deploy the configuration files to a system using configuration channels related to that system. To manage a system's configuration with SUSE Manager, it must have the appropriate tools and the config-enable file installed.

When a system is selected in the Systems tab, you can see the channels to which the system is subscribed and the related details of each channel in a separate panel.

  • The configuration channel grid shows the following details:

    • Channel Name: provides the name of the channel

    • Channel Label: provides the label information of the channel

    • Total files: provides the total number of files available on the configuration channel

    • Rank: provides the rank of the channel when a system is subscribed to more than one channel

    Figure 22 Configuration Channels - Deploying Configuration Files

  • Each channel has associated information which is shown in four separate tabs as follows:

    • Channel Properties: provides the properties of the channel, such as Description, OrgId, Number of systems subscribed, etc.

    • Centrally-Managed Files: provides the details of the centrally-managed files

    • Local Sandbox Files: provides the details of the local configuration files which override the centrally-managed files

    • Subscribed Systems: provides details of the systems which are subscribed to that channel

Rebooting and Running Remote Command

To enable Rebooting and Remote Script Scheduling in the target system follow the steps provided in Configuration Management. For more information on troubleshooting refer to Section 3.0, Troubleshooting Tips.

The subtab Remote Command allows you to execute a remote command on any Linux client system by writing scripts in the Operations Console and executing them on remote client systems via scheduling. Before doing so, you must configure the system to accept remote commands (this is explained later in this section). This subtab also allows you to reboot a system.

The following is an example of how to write a script to create a directory on a remote client by using Remote Command:

#!/bin/sh

mkdir /root/MyDirectory

Check the Run Remote Command option. In the panel, enter the user, group, and timeout details (the definitions of these inputs are explained next). Copy the above script and paste it into the Script text box. Schedule the selected action by clicking on Schedule Remote Command.

The execution of the above script will create a directory named MyDirectory located in the root directory of the client system.

Figure 23 Executing Remote Script Using Patch Management

The option Running Remote Command requires some more information to be submitted for processing the action:

  • Run as user: requires the user name for the system on which you are issuing the remote command for the system entry

  • Run as group: requires the group name to which the user belongs

  • Timeout: requires the time interval for the command for timing out the execution on the client system

  • Script: requires to enter into the text box the script which is going to be executed on the client system

The option Reboot System just requires the selection of the system to reboot and to schedule.

Figure 24 Rebooting System using Patch Management

2.2 Patches

The Patches tab displays a list of all patches that are published to channels that are subscribed to the systems in SUSE Manager.

You can access the Patches tab through the following path:

Open the Microsoft System Center Operations Manager Operations console, click Patch Management, click the Patches tab.

  • The main grid consists of the following columns:

    • ID: provides the ID of the patch

    • Advisory: provides the advisory of the patch

    • Synopsis: provides the synopsis of the patch

    • Type: provides the type of the patch which may be it is Bug fix advisory or Product enhancement or Security advisory

    • UpdateDate: provides the updated date of the patch

  • Under the Patches tab, there is also displayed a Detailed View tab. When a patch is selected the relevant data will be populated in the following grids:

    • Patch Details: details of the selected patch

    • CVEs: CVEs of the selected patch

    • Affected Systems: systems that are affected by that selected patch

    • Related Packages: information about related packages

Figure 25 Patches Overview

Patch Details

The Patch Details tab displays all relevant details of the selected patch.

You can access the Patch Details tab through the following path:

Open the Microsoft System Center Operations Manager Operations console, click Patch Management, click the Patches tab, and go to the Patch Details tab.

Figure 26 Patch Details

Applying Patches to Affected Systems

The Affected Systems tab displays all systems that are affected by the selected patch.

You can access the Affected Systems tab through the following path:

Open the Microsoft System Center Operations Manager Operations console, click Patch Management, click the Patches tab, and go to the Affected Systems tab.

  • The grid consists of the following columns:

    • SystemId: provides the ID of the Linux server

    • System Name: provides the name of the Linux server

    • Status: provides the status, which may be critical, warning, or healthy

    • Available Patches: provides the patches available to a system

    • Available Packages: provides the patches available to a system

  • You can apply a patch to a particular affected system by clicking the Apply Patch button. After clicking that button, a pop-up window opens with two options to confirm the date and time of the patch that needs to applied. The options are:

    • Schedule action as soon as possible

    • Schedule action for no sooner than

    Upon confirmation, the particular patch will be scheduled for the update to the selected system.

Figure 27 Affected Systems Details

CVEs (Common Vulnerabilities and Exposures)

CVEs is a list of information security vulnerabilities and exposures that aims to provide common names for publicly known cyber security issues. The goal of CVEs is to make it easier to share data across separate vulnerability capabilities (tools, repositories, and services) with a common enumeration. You can find more information about the CVE project at http://cve.mitre.org.

The CVEs tab displays the Common Vulnerabilities and Exposures (CVEs) and their related information.

You can access the CVEs tab through the following path:

Open the Microsoft System Center Operations Manager Operations console, click Patch Management, click the Patches tab, and go to the CVEs tab.

Figure 28 CVEs Details

The Related Packages tab displays all information about related packages of the patch currently selected in the Patches tab in a detailed view.

You can access the Related Packages tab through the following path:

Open the Microsoft System Center Operations Manager Operations console, click Patch Management, click the Patches tab, and go to the Related Patches tab.

Figure 29 Related Packages Details

2.3 Schedule

The Schedule tab enables you to track the actions carried out on your systems. An action is a scheduled task to be performed on one or more client systems. For example, an action can be scheduled to apply all patches to a system.

You can access the Schedule tab through the following path:

Open the Microsoft System Center Operations Manager Operations console, click Patch Management, and click the Schedule tab.

  • The Schedule tab consists of the following subtabs:

    • Completed Actions: displays the list of actions successfully carried out

    • Pending Actions: displays actions not yet started or still in progress

    • Failed Actions: displays whether an action cannot be completed and returns an error

    • Archived Actions: displays (completed or failed) selected actions to be stored for review

  • The grid for all subtabs consists of the following columns:

    • ID: provides the ID of the patch or package which is scheduled

    • Name: provides the name of the patch or package which is scheduled

    • Type: provides the type of action, whether it is a package install or a patch update

    • Scheduled By: provides details about who scheduled the event

    • Scheduled Time: provides the scheduled time

    • Completed Systems: provides the list of systems that completed the scheduled events

    • Failed Systems: provides the list of systems that failed the scheduled events

    • In Progress Systems: provides the list of systems whose scheduled events are in progress

  • A Detailed View is also displayed under this tab. When an action is selected the relevant data will be populated in the following grids

    • Completed Systems

    • In Progress Systems

    • Failed Systems

Completed Actions

The Completed Actions tab displays the list of completed actions successfully carried out.

You can access the Completed Actions tab through the following path:

Open the Microsoft System Center Operations Manager Operations console, click Patch Management, click the Schedule tab, and go to the Completed Actions tab.

Figure 30 Completed Actions Details

Failed Actions

The Failed Actions tab displays the list of actions that could not be completed and failed during execution.

You can access the Failed Actions tab through the following path:

Open the Microsoft System Center Operations Manager Operations console, click Patch Management, click the Schedule tab, and go to the Failed Actions tab.

Figure 31 Failed Actions Details

Rescheduling Failed Actions

You can reschedule failed actions. To do so, go to the Failed Actions tab through the following path:

Open the Microsoft System Center Operations Manager Operations console, click Patch Management, click the Schedule tab, and go the Failed Actions tab.

Figure 32 Rescheduling Failed Actions

Here you get an overview of all failed actions.

Select the actions you want to reschedule and click the Reschedule Action button. After successful rescheduling, you can check the rescheduled actions in the Pending Actions tab.

Pending Actions

The Pending Actions tab displays the list of actions not yet started or still in progress.

You can access the Pending Actions tab through the following path:

Open the Microsoft System Center Operations Manager Operations console, click Patch Management, click the Schedule tab, and go to the Pending Actions tab.

Figure 33 Pending Actions Details

Canceling Pending Actions

You can cancel pending actions. To do so, go to the Pending Actions tab through the following path:

Open the Microsoft System Center Operations Manager Operations console, click Patch Management, click the Schedule tab, and go to the Pending Actions tab.

Here you get an overview of all pending actions.

Select the actions you want to cancel and click the Cancel Actions button as shown on the screenshot above to cancel the selected actions. Canceled actions are not listed anywhere.

Completed Systems

The Completed Systems tab displays the list of completed systems for the selected scheduled action in the Completed Actions or Archived Actions tab. Select any completed action from the Completed Actions or Archived Actions tab and view the completed system details in the Completed Systems tab.

You can access the Completed Systems tab through the following path:

Open the Microsoft System Center Operations Manager Operations console, click Patch Management, click the Schedule tab, and go to the Completed Systems tab.

  • The grid consists of the following columns:

    • Server ID: provides the ID of the Linux server

    • Server Name: provides the name of the Linux server

    • Base Channel: the primary channel for the system based upon its operating system

    • Time Stamp: provides the timestamp of when the event completed

    • Message: provides any message displayed to the user

Figure 34 Completed Systems Details

In Progress Systems

The In Progress Systems tab displays the list of in-progress systems, for the selected pending action. Select any pending action from the Pending Actions tab and view the in-progress system details in the In Progress Systems tab.

You can access the In Progress Systems tab through the following path:

Open the Microsoft System Center Operations Manager Operations console, click Patch Management, click the Schedule tab, and go to the In Progress Systems tab.

  • The grid consists of the following columns:

    • Server ID: provides the ID of the Linux server

    • Server Name: provides the name of the Linux server

    • Base Channel: the primary channel for the system based upon its operating system

    • Time Stamp: provides the timestamp of when the event completed

    • Message: provides any message displayed to the user

Figure 35 In Progress Systems Details

Failed Systems

The Failed Systems tab displays the list of failed systems for the selected failed action. Select any failed action from the Failed Actions or Archived Actions tab and view the failed system details in the Failed Systems tab.

You can access the Failed Systems tab through the following path:

Open the Microsoft System Center Operations Manager Operations console, click Patch Management, click the Schedule tab, and go to the Failed Systems tab.

  • The grid consists of the following columns:

    • Server ID: provides the ID of the Linux server

    • Server Name: provides the name of the Linux server

    • Base Channel: the primary channel for the system based upon its operating system

    • Time Stamp: provides the timestamp of when the event completed

    • Message: provides any message displayed to the user

Figure 36 Failed Systems Details

2.4 Common Features

Patch management provides several additional options. Sorting and filtering functions are available for all the grids in all tabs except for the following subtabs:

  • Package Details

  • Patch Details

  • Change Log

  • Channel Properties

  • Kickstart Profile Details

  • System Properties

  • The Sort function is implemented in all the grids of the Patch Management page. All the records in the grid will be sorted according to the filter option that is selected by checking the column name in the filter list and applying the filter.

    Figure 37 Record Sorting and Page Refresh

    You can refresh the entire view or page by clicking the Refresh icon in the top-right corner of each main tab as shown in the above screenshot. All records are reloaded into the grid from the SUSE Manager Server.

  • The Filter function is provided in all grids of the Patch Management page. You can filter the records of each column with a matching filter criterion. By default the first column in the grid is considered for filtering of all the records. By moving the mouse over the filter icon, a context menu appears which allows you to change the column selection for filtering. After selecting the filter column, enter your search text in the filter text box. Click on the Search icon to filter the records in the grid. To remove the filter criteria, clear the filter text box.

    Figure 38 Record Filtering

  • By default all grids are enabled with a page navigation on the Patch Management page. All grids contain 100 records per page by default. At any point in time you can navigate to any of the following pages:

    • next page (>)

    • last page (>>|)

    • previous page (<)

    • first page (|<<)

  • If you select any row or any cell in a grid and right-click on it, a context menu appears which contains the options Copy, Export, Refresh, and Properties.

    Figure 39 Additional Options

    • By using the Copy option you can select a portion of data manually, copy the selected portion of content, and paste it anywhere.

    • By using the Export option you can export the values of the entire grid to an Excel sheet by providing the path.

      IMPORTANT: Prerequisites for Enabling the Export Functionality

      • Microsoft Office 2010 or later must be installed in the Microsoft System Center Operations Management system.

      • Check the path C:\Windows\assembly for the Microsoft.Office.Interop. Excel” assembly with the version 14.0.0.0. By default version “14.0.0.0” will be placed automatically in the folder “C:\Windows\assembly” on installation of Office 2010.

    • By selecting the Refresh option the entire grid view is refresheded. This means it is reloading the entire data grid by collecting the data from the server.

    • By using the Properties option you can check the properties of a particular system, package, patch, profile, or channel, depending on the selection.

3.0 Troubleshooting Tips

3.1 Auto Installation Issues

  • If you are getting any dependency problems, before rescheduling make sure the system is up to date with all relevant patches installed. Otherwise it will cause dependency problems for installing other packages or patches.

  • If you face any errors after scheduling the auto installation, check the message for the cause in the Schedule section.

    In the /var/log/ path check the up2date file for complete information about the issue using the task pick up time and date.

    See the sample screenshot of an up2date file for an issue below.

    Figure 40 Screenshot up2date File

  • Follow the steps given in the description to resolve the issue. Manually download the packages which have dependency problems by selecting the packages from the SUSE Manager UI or from the Internet, if they are not available from SUSE Manager Installable Packages. Try to install those packages manually using zypper install <package name>(for SUSE Linux Enterprise Server) or yum install <package name>(for Red Hat Enterprise Linux) commands.

    IMPORTANT: SUSE Manager Documentation

    Refer to the SUSE Manager documentation Installable packages in the Web interface at https://www.suse.com/documentation/suse-manager-3/book_suma_reference_manual/data/book_suma_reference_manual.html.

  • If you do not find any description regarding that issue, check other log files in the /var/log path and try to find the data relating to that issue using the task pickup date and time value.

  • If you get a message Internal server problems while creating the distribution tree, free up space by deleting unnecessary files and folders from your SUSE Manager server system.

  • If you are getting an initrd not found in the specified path error message while creating Kickstart profiles or AutoYaST profiles, check the distribution tree path you provided and the version of architecture the distribution contains.

  • If your system could not register even after performing an auto installation using an AutoYaST profile, try manually using the following command in the target or client system:

    curl –Sks https://Server_hostname/pub/bootstrap/bootstrap_edited.sh |/bin/bash

    Replace Server_hostname with your SUSE Manager server host name.

3.2 Run Remote Command Issues

  • Refer to the SUSE Manager documentation at https://www.suse.com/documentation/suse-manager-3/for more information on bootstrap and registering a client to a SUSE Manager server.

  • If you are getting errors while installing the rhncfg packages check the message in the Failed systems tab under the Schedule tab.

  • If you are getting any error message regarding the rhn-setup-gnome dependency, check if you have installed a package version newer than the version mentioned in the error message. If the version is older, try installing the newer version. After that try installing the rhncfg packages. If the installed version is already newer than the version mentioned in the error message, or if you still get the same message after installing the newer version, remove the package using the Removable packages tab under the Systems tab in the Operations console.

    Figure 41 Screenshot Error Message

  • If you are getting any error message regarding the rhn_register package dependency, follow the below-mentioned procedure.

  • When a Red Hat Enterprise Linux System is subscribed to SUSE Manager, usually the Spacewalk tools override the rhn_register package. If that is not happening and if you are still able to find rhn_register after being subscribed to SUSE Manager, use the following procedure to ensure the system will not make use of rhn_register.

  • Use the following command to find the rhn_register package in Red Hat Enterprise Linux systems (this is not required for SUSE Linux Enterprise systems):

    locate rhn_register

    You will get the result with the files in the following folders:

    • /usr/bin/

    • /usr/sbin/

    • /usr/share/firstboot/modules/

    Just rename the files using the mv as shown below.

    mv rhn_register rhn_register1

    Use the mv to rename all the files with an rhn_register name such as

    • rhn_register

    • rhn_register.py

    • rhn_register.pyo

    • rhn_register.pyc

4.0 Appendix

The SUSE Manager Management Pack allows scheduling the same package(s) multiple times to a single system. All other scheduled actions will be canceled if the first scheduled action completes successfully.

5.0 GNU Free Documentation License

Copyright (C) 2000, 2001, 2002 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

0. PREAMBLE

The purpose of this License is to make a manual, textbook, or other functional and useful document "free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or non-commercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

This License is a kind of "copyleft", which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.

We have designed this License to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.

1. APPLICABILITY AND DEFINITIONS

This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you". You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.

A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.

A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.

The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.

The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.

A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not "Transparent" is called "Opaque".

Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.

The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, "Title Page" means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.

A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", or "History".) To "Preserve the Title" of such a section when you modify the Document means that it remains a section "Entitled XYZ" according to this definition.

The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.

2. VERBATIM COPYING

You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.

You may also lend copies, under the same conditions stated above, and you may publicly display copies.

3. COPYING IN QUANTITY

If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.

If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.

If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.

It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.

4. MODIFICATIONS

You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:

  1. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.

  2. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.

  3. State on the Title page the name of the publisher of the Modified Version, as the publisher.

  4. Preserve all the copyright notices of the Document.

  5. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.

  6. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.

  7. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice.

  8. Include an unaltered copy of this License.

  9. Preserve the section Entitled "History", Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled "History" in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.

  10. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the "History" section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.

  11. For any section Entitled "Acknowledgements" or "Dedications", Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.

  12. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.

  13. Delete any section Entitled "Endorsements". Such a section may not be included in the Modified Version.

  14. Do not retitle any existing section to be Entitled "Endorsements" or to conflict in title with any Invariant Section.

  15. Preserve any Warranty Disclaimers.

If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles.

You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties--for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.

You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.

The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.

5. COMBINING DOCUMENTS

You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.

The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

In the combination, you must combine any sections Entitled "History" in the various original documents, forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements".

6. COLLECTIONS OF DOCUMENTS

You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.

You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.

7. AGGREGATION WITH INDEPENDENT WORKS

A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.

If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.

8. TRANSLATION

Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.

If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.

9. TERMINATION

You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.

10. FUTURE REVISIONS OF THIS LICENSE

The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.

Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License "or any later version" applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.

ADDENDUM: How to use this License for your documents
Copyright (c) YEAR YOUR NAME.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU
 Free Documentation License".

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the "with...Texts". line with this:

with the Invariant Sections being LIST THEIR TITLES, with the
Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.

If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.

If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.