IBM Support

Bigfix Server Plugin Service installation and setup

Technote (troubleshooting)


Problem(Abstract)

The Bigfix Server Plugin Service facilitates communication and automation of the Bigfix Server and Web Reports components with server side utilities.

Resolving the problem

Setting up the Bigfix Server Plugin Service

Depending on the requirements of the server-side utilities, the Bigfix Server plugin service will need access to the following components:

  • Bigfix database (through ODBC)
  • Bigfix Web Reports (through the SOAP API)
  • REST API (applicable only to Bigfix 9.0 and later)
Follow the instructions below to set up the Bigfix Server Plugin Service and provide the necessary database, web reports, and REST API access. To configure the Bigfix Server Plugin Service after installation, use the available content in the BES Support site:
  • For Bigfix 8.2 and earlier, use the BES Server Plugin Service Configuration Wizard
  • For Bigfix 9.0 and later, use the following tasks:
    • Task 1294: Configure REST API credentials for BES Server Plugin Service
    • Task 1295: Configure SOAP API credentials for BES Server Plugin Service

Install the Bigfix Server Plugin Service
1. Use Task 708: "Install BES Server Plugin Service" in the Bigfix Support site will be applicable to any BES Server without the plugin service already installed.

Setup Bigfix Server Plugin Service to access Web Reports SOAP API
1. Create a Bigfix Web Reports user account

The plugin server requires a Web Reports username and password in order to communicate with Web Reports. You can create a new user for this purpose, or use an existing user.

Note: The user should have "normal" account privileges, and should not be restricted by the console operator or by the saved web reports filter.

2. Add Web Reports user information to the Bigfix Server

To store the Web Reports Server URL, user name, and password on the Bigfix server, use the following:

For Bigfix 8.2 and earlier, use the BES Server Plugin Service Configuration Wizard. You need to enable the appropriate analysis and run a fixlet on the server to generate encryption keys, if required.

For Bigfix 9.0 and later, use Task 1295: Configure SOAP API credentials for BES Server Plugin Service.

The data is stored at the following locations:

On Windows Server:

32-bit

[HKEY_LOCAL_MACHINE\SOFTWARE\BigFix\Enterprise Server\BESReports]
SOAPUsername (String)
Set with the name of your Web Reports user as its value.

[HKEY_LOCAL_MACHINE\SOFTWARE\BigFis\Enterprise Server\BESReports]
SOAPPassword (String)
Set with the encrypted Web Reports password as its value.

[HKEY_LOCAL_MACHINE\SOFTWARE\BigFix\Enterprise Server\BESReports]
WRHTTP (String)
Set with the name of your Web Reports Server URL:
For example: http://bigfix.company.com/webreports

[HKEY_LOCAL_MACHINE\SOFTWARE\BigFix\Enterprise Server\BESReports]
SOAPPasswordIsEncrypted (String)
A flag showing encryption method used for Web Reports password:
0: no encryption is used, the password is stored in plain text
1: the password is encrypted by BES Server Plugin Service Configuration Wizard (Bigfix 8.2 and earlier)
2: the password is encrypted by Task 1295 (Bigfix 9.0 and later)

64-bit


[HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\BigFix\Enterprise Server\BESReports]
SOAPUsername (String)
Set with the name of your Web Reports user as its value.

[HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\BigFix\Enterprise Server\BESReports]
SOAPPassword (String)
Set with the users password as its value.

[HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\BigFix\Enterprise Server\BESReports]
WRHTTP (String)
Set with the name of your Web Reports Server url:
For example: http://bigfix.company.com/webreports

[HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\BigFix\Enterprise Server\BESReports]
SOAPPasswordIsEncrypted (String)
A flag showing encryption method used for Web Reports password:
0: no encryption is used, the password is stored in plain text
1: the password is encrypted by BES Server Plugin Service Configuration Wizard (Bigfix 8.2 and earlier)
2: the password is encrypted by Task 1295 (Bigfix 9.0 and later)

On Linux Server (Bigfix 9.0 and later):

The credentials are stored in the file /var/opt/BESServer/Applications/SOAPCredentials

The contents of the file include:
SOAPUsername=<username>
SOAPPassword=<password>
WRHTTP=<Webreports URL>


Set up Bigfix Server Plugin Service to access REST API

REST API uses the platform operator account to access content in Bigfix server. The credentials of a master operator account are required to allow server utilities to access REST API.

Use Task 1294: Configure REST API credentials for BES Server Plugin Service to configure access through REST API (supported in Bigfix 9.0 and above)

The data is stored at the following locations:

On Windows Server:

32-bit

[HKEY_LOCAL_MACHINE\Software\Bigfix\Enterprise Server\MFSConfig]
RESTUsername (String)
Set with the master operator user name as its value.

[HKEY_LOCAL_MACHINE\Software\Bigfix\Enterprise Server\MFSConfig]
RESTPassword (String)
Set with the encrypted master operator password as its value.

[HKEY_LOCAL_MACHINE\Software\Bigfix\Enterprise Server\MFSConfig]
RESTURL (String)
Set with the name of your REST API URL:
For example: https://bigfix.company.com:52311/api

[HKEY_LOCAL_MACHINE\Software\Bigfix\Enterprise Server\MFSConfig]
RESTPasswordEncryption (String)
Similar to SOAPPasswordIsEncrypted. It is always set to 2 by Task 1294.

64-bit

[HKEY_LOCAL_MACHINE\Software\ Wow6432Node\Bigfix\Enterprise Server\MFSConfig]
RESTUsername (String)
Set with the master operator user name as its value.

[HKEY_LOCAL_MACHINE\Software\ Wow6432Node\Bigfix\Enterprise Server\MFSConfig]
RESTPassword (String)
Set with the encrypted master operator password as its value.

[HKEY_LOCAL_MACHINE\Software\ Wow6432Node\Bigfix\Enterprise Server\MFSConfig]
RESTURL (String)
Set with the name of your REST API URL:
For example: https://bigfix.company.com:52311/api

[HKEY_LOCAL_MACHINE\Software\ Wow6432Node\Bigfix\Enterprise Server\MFSConfig]
RESTPasswordEncryption (String)
Similar to SOAPPasswordIsEncrypted. It is always set to 2 by Task 1294.

On Linux Server (Bigfix 9.0 and later):

The credentials are stored in the file /var/opt/BESServer/Applications/MasterOperatorCredentials

Contents of the file:
RESTUsername=<username>
RESTPassword=<password>
RESTURL=<REST API URL>

Set up the Bigfix Server Plugin Service to access the Bigfix database

1. If the database is on the same computer as the Bigfix Server Plugin Service, then you will NOT need to make any changes because local services running as SYSTEM on the same computer as SQL Server will automatically have access to the database. This is the most common Bigfix configuration.

2. If the database is on a different computer as the Bigfix Server Plugin Service AND you used the "NT Authentication" option when you initially installed the Bigfix Server, then you will need to go to your Windows Services dialog (Administrative Tool > Services) and change the login user of the Bigfix Server Plugin Service to be a Windows user that has access to the remote database (you can use the same user that the Bigfix FillDB and Bigfix GatherDB services user). (This is the most common configuration for remote databases if they are members of an Active Directory domain.)

3. If the database is on a different computer as the Bigfix Server Plugin Service AND you used the "SQL Server Authentication" option when you initially installed the Bigfix Server, then you will NOT need to make any changes because the Bigfix Server Plugin Service will use the username/password that were created by the Bigfix Server installer at "HKLM\Software\Bigfix\Enterprise Server\Database". (This configuration is less common for remote databases.)

Once this is set, Bigfix applications can be installed on the server and registered with the service.

Logs for Troubleshooting

The log for the "Store Power Data Utility" is located in \Bigfix Enterprise\BES Server\Applications\BESAggregator. The log for the "BES Server Plugin Service" (MFS.exe) is located in \Bigfix Enterprise\BES Server\Applications\Logs Sample successful entries for both logs are below:

BESAggregatePowerData.log
[Thu Oct 14 08:04:17 2010] [INFO] Running BESAggregatePowerData.exe version 0.7.35
[Thu Oct 14 08:04:17 2010] [INFO] Connecting to webreports at http://mycompany/webreports
[Thu Oct 14 08:04:17 2010] [INFO] Connecting to database on bes_bfenterprise.
[Thu Oct 14 08:04:17 2010] [INFO] No aggregation policies were found.
[Thu Oct 14 08:04:17 2010] [INFO] Creating group for all computers
[Thu Oct 14 08:04:17 2010] [INFO] Found 1 groupings for manual grouping policy "All Computers"
[Thu Oct 14 08:04:17 2010] [INFO] Generating power data for group "All Computers"
[Thu Oct 14 08:04:18 2010] [INFO] Adding today's data to power history...
[Thu Oct 14 08:04:20 2010] [INFO] Utility Successfully Completed!

MFS.log
[Thu, 14 Oct 2010 08:04:16 -0700] Task 'BESAggregatePowerData' run by command: "C:\Program Files (x86)\Bigfix Enterprise\BES Server\Applications\BESAggregator\BESAggregatePowerData.exe" -url http:// mycompany /webreports -u myUser -p ***** -odbc bes_bfenterprise -dbuser -dbpass

Historical Number

1643

Document information

More support for: IBM BigFix family

Software version: 7.2, 8.0, 8.1

Operating system(s): Platform Independent

Reference #: 1506199

Modified date: 22 May 2016


Translate this page: