Skip to content

Management Pack Detail JSON

P2P-Nathan edited this page Oct 26, 2017 · 3 revisions

Managing the GitHub Management Pack Detail Entry

Pairing with the Management Pack Index this JSON file (details.json) provides the details for a Community Based Management Pack. The below steps provide documentation on using the file to describe a Management Pack

Overview

After the UI in the SCOM console has pulled the Management Pack Index the second step proceeds to retrieve the detail file via HTTP GET. This file is used for the following functions.

  • Provided additional detail for the UI
  • Indicates where there end user can obtain the pack
  • Tracks the version of the pack so that we provide update notifications

Location

Using the Management Pack Index as the reference, the UI will search for this file at ManagementPackSystemName/details.json .

Index JSON structure

{ 
    "ManagementPackSystemName":"Community.ManagementPackCatalog",
    "ManagementPackDisplayName":"Community Management Pack Catalog",
    "URL":"http://www.SquaredUp.com/ManagementPacks",
    "Version":"1.2.4.3",
    "Author":"Squared Up Ltd.",
    "IsFree":"true",
    "Description":"The Management Pack Community Catalog core UI and management pack"
    "Tags":
        [
            "PowerShell",
            "Templates",
            "Authoring"
        ]
}

Property Descriptions

ManagementPackSystemName

The exact System Name of the management pack. This will be used to identify which packs are already installed as well as where updates may be available.

ManagementPackDisplayName

The Display Name of the Management Pack to show in the catalog.

URL

Where can the latest version of the pack be obtained from?

Version

What is the currently released version of the Management Pack? This value will be evaluated against the currently installed packs to see if updates are available.

Author

Indicates who wrote the management pack.

IsFree

Indicates if this management pack is free to use. If not provided the value defaults to false.

Description

A short description of what the pack provides. Providing a description can assist with packs where the display name may not identify the features of the MP.

Tags

Tag strings are indexed and visible for searching.