vSphere Client Remote Plug-in Extensions Reference

Plugin manifest schema used for validation of all vSphere Client plugins.

Example object

{
  "manifestVersion": "1.0.0",
  "requirements": {
    "plugin.api.version": "1.0.0"
  },
  "configuration": {
    "nameKey": "My Plugin",
    "icon": {
      "name": "main"
    }
  },
  "global": {
    "view": {
      "navigationId": "myGlobalViewId",
      "uri": "myplugin/globalView.html",
      "navigationVisible": false
    }
  },
  "objects": {
    "Datacenter": {
      "summary": {
        "view": {
          "uri": "myplugin/summary.html",
          "icon": {
            "name": "main"
          },
          "size": {
            "widthSpan": 1,
            "heightSpan": 2
          }
        }
      },
      "monitor": {
        "views": [
          {
            "navigationId": "myview1",
            "labelKey": "category.view1",
            "uri": "myplugin/view1.html"
          }
        ]
      },
      "configure": {
        "views": [
          {
            "navigationId": "myview1",
            "labelKey": "category.view1",
            "uri": "myplugin/view1.html"
          }
        ]
      },
      "menu": {
        "actions": [
          {
            "labelKey": "action1",
            "icon": {
              "name": "action-1"
            },
            "trigger": {
              "type": "modal",
              "uri": "myplugin/modal-action.html",
              "size": {
                "height": 250,
                "width": 600
              }
            }
          }
        ]
      }
    }
  },
  "definitions": {
    "iconSpriteSheet": {
      "uri": "myplugin/images/icon-sprite.png",
      "definitions": {
        "main": {
          "x": 0,
          "y": 0
        }
      }
    },
    "i18n": {
      "locales": [
        "en-US",
        "de-DE",
        "fr-FR"
      ],
      "definitions": {
        "category.view1": {
          "en-US": "Monitor View 2",
          "de-DE": "Monitoransicht 2",
          "fr-FR": "Vue Surveiller 2"
        }
      }
    }
  }
}

Extensibility References

Name /type

Description /example

Constraints

manifestVersion
string

Manifest format version: used for versioning of the plugin manifest schema against which the plugin's manifest is validated.

valid values: "1.0.0"

requirements
object

Requirements specification for the plugin.

Name /type	Description /example	Constraints
plugin.api.version string	The version of the set of APIs used to build the plugin.	valid values: `"1.0.0"`

configuration
object

Plugin configuration properties

Name /type

Description /example

Constraints

nameKey
string

Plugin display name used for all plugin categorization items on the UI: e.g. Navigator entry point, Object menu, Monitor category, Configure category, etc.

min length: 1

icon
object

Reference to plugin icon used for all plugin categorization items on the UI which support icons: e.g. Navigator entry point, Object menu, etc.

Name /type	Description /example	Constraints
name string	Name of the plugin icon itself or item within the sprite sheet.	min length: 1

global
object

Global scope of items that are not specific to a particular inventory object.

Name /type

Description /example

Constraints

view
object

Global view containing any general-purpose plugin solution UI: e.g. dashboards, custom objects, workflows, etc. Only a single global view is supported - multiple global UIs should be aggregated within this view making use of direct internal navigation between the pages.

Name /type	Description /example	Constraints
navigationId string	ID of the global view used for navigation. This is optional and used only when the plugin wants to navigate to this global view from another part of its UI. The ID should be unique for the plugin manifest in which case uniqueness across the whole vSphere Client is ensured.	pattern: ^[a-zA-Z0-9_.-]+$
uri string	Location of the global view UI content.	min length: 1
navigationVisible boolean	Whether to display the Navigator or not. Hiding the Navigator is commonly used to implement custom plugin navigation.	default value: true valid values: (true,false)

objects
object

Object scope of items specific to a particular inventory object.

Name /type

Description /example

Constraints

<ObjectType>

One of: "Datacenter", "VirtualMachine", "HostSystem", "ResourcePool", "VirtualApp", "ClusterComputeResource", "ComputeResource", "DistributedVirtualPortgroup", "Datastore", "StoragePod", "HostProfile", "Network", "OpaqueNetwork", "DistributedVirtualSwitch", "Folder:RootFolder", "Folder:DatacenterFolder", "Folder:HostFolder", "Folder:VirtualMachineFolder", "Folder:NetworkFolder", "Folder:DatastoreFolder"

object

The vSphere inventory object type category containing all plugin extensions on this object type.

Name /type

Description /example

Constraints

summary
object

Name /type

Description /example

Constraints

view
object

A single summary section view on the current object. Should contain only summarized plugin data for the current object usually represented as name-value pairs. Can contain action buttons or links to Monitor/Configure views with more detailed data.

Name /type

Description /example

Constraints

uri
string

Location of the section UI content.

min length: 1

icon
object

Reference to plugin vendor icon.

Name /type	Description /example	Constraints
name string	Name of the plugin icon itself or item within the sprite sheet.	min length: 1

size
object

Name /type	Description /example	Constraints
type	Sizing type of the summary view.	valid values: `"span"`
widthSpan integer	Width factor of the section related to the default width. Currently the summary section width is dynamic, so this has no effect for now.	min value:1 max value:1
heightSpan integer	Height factor of the section related to the default height.	min value:1 max value:2

monitor
object

A single category with one or more Monitor views on the current object. The Monitor category item is labeled with the display name of the plugin.

Name /type

Description /example

Constraints

views
array

Array of views within the current category.

Name /type

Description /example

Constraints

[*]
object

Name /type	Description /example	Constraints
navigationId string	ID of the view used only for navigation. It should be unique within the scope of the plugin.	pattern: ^[a-zA-Z0-9_.-]+$
labelKey string	Label of the view displayed in tables of contents.	min length: 1
uri string	Location of the view UI content.	min length: 1

unique items

configure
object

A single category with one or more Configure views on the current object. The Configure category item is labeled with the display name of the plugin.

Name /type

Description /example

Constraints

views
array

Array of views within the current category.

Name /type

Description /example

Constraints

[*]
object

Name /type	Description /example	Constraints
navigationId string	ID of the view used only for navigation. It should be unique within the scope of the plugin.	pattern: ^[a-zA-Z0-9_.-]+$
labelKey string	Label of the view displayed in tables of contents.	min length: 1
uri string	Location of the view UI content.	min length: 1

unique items

menu
object

A single menu with one or more actions on the current object. The menu is labeled with the display name of the plugin.

Name /type

Description /example

Constraints

actions
array

Set of actions to display in the menu.

Name /type

Description /example

Constraints

[*]
object

Name /type

Description /example

Constraints

labelKey
string

Label of the action displayed in menus.

min length: 1

icon
object

Reference to the menuitem icon of the action.

Name /type	Description /example	Constraints
name string	Name of the plugin icon itself or item within the sprite sheet.	min length: 1

trigger

Defines what should happen as a result of executing the action.

See the Action Triggers section below.

unique items

min length: 1

min length: 1

definitions
object

Definitions of plugin resources.

Name /type

Description /example

Constraints

iconSpriteSheet
object

Definition of a sprite sheet with one or more icons.

Name /type

Description /example

Constraints

uri
string

Location of the icon or sprite sheet.

min length: 1

definitions

Offset of the icon within the sprite sheet.

Name /type	Description /example	Constraints
x integer	Horizontal icon index within the sprite sheet starting from the left.	min value: 0
y integer	Vertical icon index within the sprite sheet starting from the top.	min value: 0

min length: 1

i18n
object

Definition of localization strings for predefined items that vSphere Client displays for the plugin, e.g. categories and menus. Plugin views have the responsibility for localization of the actual view content.

Name /type

Description /example

Constraints

locales
array

Locales supported by the plugin. Those should match the actual localization items.

Name /type	Description /example	Constraints
*[]**	Locales supported by the plugin. All localized strings should contain a definition for each of the locales defined in the current list. Possible locales are English US, German, Spanish, French, Japanese, Korean, Chinese Simplified and Chinese Traditional.	valid values: `"en-US"`, `"de-DE"`, `"es-ES"`, `"fr-FR"`, `"ja-JP"`, `"ko-KR"`, `"zh-CN"`, `"zh-TW"`

min length: 1
max length: 8
unique items

definitions

Localization strings for predefined items, e.g. categories and menus. Each item should contain a single translation for each supported language.

min length: 1

min length: 1

Action triggers

trigger

Defines what should happen as a result of executing the action.

One of the following:

"modal"

Name /type

Description /example

Constraints

type

Indicates that a modal dialog should be opened as a result of executing the action.

valid values: "modal"

uri
string

Location of the action modal dialog UI content.

min length: 1

titleKey
string

Title of the action modal dialog.

min length: 1

size
object

Name /type	Description /example	Constraints
width integer	The action modal dialog width in pixels.
height integer	The action modal dialog height in pixels.