IBM BigFix: API Reference Guide

[Pages:98]IBM BigFix

Version 9.2

API Reference Guide

IBM

IBM BigFix

Version 9.2

API Reference Guide

IBM

Note Before using this information and the product it supports, read the information in "Notices" on page 87.

This edition applies to version 9, release 2, modification level 0 of IBM BigFix and to all subsequent releases and modifications until otherwise indicated in new editions. ? Copyright IBM Corporation 2010, 2015. US Government Users Restricted Rights ? Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

Contents

Chapter 1. API Reference Guide . . .. 1

Chapter 2. Server API . . . . . . . .. 3

Installation . . . . . . . . . . . . . .. 3 BES XML documents . . . . . . . . . .. 5 Connecting to the API . . . . . . . . . .. 5 Examples . . . . . . . . . . . . . .. 6

Top-level BES XML elements . . . . . . .. 6 Running an action . . . . . . . . . .. 7 Accessing the API with Perl . . . . . . .. 7 The API Objects . . . . . . . . . . . .. 15 BESAPI.XMLImporter . . . . . . . . .. 15 BESAPI.ActionStopper. . . . . . . . .. 16 BESAPI.RetrievedProperty . . . . . . .. 17 BESAPI.FixletMessage . . . . . . . . .. 19 BESAPI.SiteManager . . . . . . . . .. 22 BESAPI.ActionSiteMasthead . . . . . . .. 23 BESAPI.SigningKeys . . . . . . . . .. 24 BES schemas . . . . . . . . . . . . .. 25 Fixlet or task . . . . . . . . . . . .. 26 Baseline . . . . . . . . . . . . .. 27 Single actions. . . . . . . . . . . .. 28 Multiple action groups . . . . . . . .. 28 Analyses . . . . . . . . . . . . .. 29 Computer groups . . . . . . . . . .. 29 Properties . . . . . . . . . . . . .. 30 Shared BES XML elements . . . . . . . .. 30 FixletAction . . . . . . . . . . . .. 30 ActionScript . . . . . . . . . . . .. 30 ActionSuccessCriteria . . . . . . . . .. 31 ActionSettings . . . . . . . . . . .. 31 ActionSettingsLocks . . . . . . . . .. 34 Search components . . . . . . . . . .. 35 Miscellaneous types . . . . . . . . . .. 35 RelevanceString . . . . . . . . . . .. 35 TimeInterval . . . . . . . . . . . .. 36 NonNegativeTimeInterval . . . . . . .. 36 ActionMessageMaxPostponementInterval . .. 36 ActionMessageTimeoutInterval . . . . . .. 36

Chapter 3. Client API. . . . . . . .. 37

Client API terminology . . . . . . . . .. 38 Potential use cases . . . . . . . . . . .. 38 Deploying an agent. . . . . . . . . . .. 39 Software development kit . . . . . . . .. 40 C++ source code. . . . . . . . . . . .. 40 Configuring the components. . . . . . . .. 41 API specifications . . . . . . . . . . .. 43 BESClientComplianceMod.Session . . . . . .. 43 BESClientComplianceMod.Progress . . . . .. 43 BESClientComplianceMod.Response . . . . .. 44 Examples of Client Documents . . . . . . .. 44 Check service pack . . . . . . . . . . .. 45 Check for a running app . . . . . . . . .. 45 Update patches . . . . . . . . . . . .. 46

? Copyright IBM Corp. 2010, 2015

Check for anti-virus . . . . . . . . . .. 46

Chapter 4. Dashboard API . . . . .. 49

Linking . . . . . . . . . . . . . . .. 49 Relevance in dashboards . . . . . . . . .. 50 Debugging dashboards . . . . . . . . .. 50 Editing dashboards . . . . . . . . . . .. 51

Chapter 5. Database API . . . . . .. 53

BES_FIXLETS. . . . . . . . . . . . .. 53 BES_TASKS . . . . . . . . . . . . .. 54 BES_ANALYSES . . . . . . . . . . . .. 54 BES_BASELINES . . . . . . . . . . .. 54 BES_COMPUTERGROUPS . . . . . . . .. 54 BES_COLUMN_HEADINGS. . . . . . . .. 55 BES_RELEVANT_FIXLETS . . . . . . . .. 55 BES_RELEVANT_TASKS . . . . . . . . .. 55 BES_RELEVANT_BASELINES . . . . . . .. 56 BES_ACTIONS . . . . . . . . . . . .. 56 BES_RELEVANT_FIXLET_HISTORY . . . . .. 57 BES_RELEVANT_TASK_HISTORY. . . . . .. 57 BES_RELEVANT_BASELINE_HISTORY . . . .. 57 BES_FIXLET_PROPERTIES . . . . . . . .. 58 BES_TASK_PROPERTIES . . . . . . . . .. 58 BES_BASELINE_PROPERTIES . . . . . . .. 59 Example report generator. . . . . . . . .. 59

Chapter 6. WebReports API . . . . .. 63

Authoring Web Reports . . . . . . . . .. 63 Converting a dashboard . . . . . . . . .. 64 Propagating Web Reports . . . . . . . . .. 64 Template report . . . . . . . . . . . .. 64 Custom report . . . . . . . . . . . .. 65 External report . . . . . . . . . . . .. 65 Exporting to PDF . . . . . . . . . . .. 66 Setting a title . . . . . . . . . . . . .. 66 Setting OnLoad events. . . . . . . . . .. 66 SOAP API . . . . . . . . . . . . . .. 66

Configuring SOAP . . . . . . . . . .. 67 SOAP URL . . . . . . . . . . . .. 67 SOAP headers . . . . . . . . . . .. 67 SOAP methods . . . . . . . . . . .. 69 SOAP examples . . . . . . . . . . .. 74

Chapter 7. Creating HTML with inspectors . . . . . . . . . . . .. 77

HTML inspectors . . . . . . . . . . .. 77 HTML tag inspectors . . . . . . . . . .. 78 Issues with the "it" statement . . . . . . .. 79 Introducing datastore inspectors . . . . . .. 80 Creating statistical properties . . . . . . .. 80 Linking to other documents . . . . . . . .. 80 The link ID protocol . . . . . . . . . .. 81 A list of link IDs. . . . . . . . . . . .. 82

iii

Refreshing relevance . . . . . . . . . .. 82

Appendix. Support . . . . . . . .. 85

Notices . . . . . . . . . . . . .. 87

Trademarks . . . . . . . . . . . . .. 89

Terms and conditions for product documentation.. 90

iv IBM BigFix: API Reference Guide

Chapter 1. API Reference Guide

IBM BigFix has extensibility built-in to allow you to create content directly from the console in the form of custom Fixlets and tasks. There are times, however, when you need direct programmatic access to the relevance engine at the core of IBM BigFix. IBM BigFix therefore makes available a set of application programming interfaces (APIs).

This guide describes the various APIs, including server, client, dashboard, and Web Reports, that you can use to control all aspects of the IBM BigFix engine from your own scripts.

This guide describes the API available to IBM BigFix Version 9.2.

? Copyright IBM Corp. 2010, 2015

1

2 IBM BigFix: API Reference Guide

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download