Plugin manifest schema used for validation of all vSphere Client plugins.
No Additional PropertiesPlugin configuration properties
Reference to plugin icon used for all plugin categorization items on the UI which support icons: e.g. Navigator entry point, Object menu, etc.
No Additional PropertiesName of the plugin icon itself or item within the sprite sheet.
Must be at least 1 characters long
Plugin display name used for all plugin categorization items on the UI: e.g. Navigator entry point, Object menu, Monitor category, Configure category, etc.
Must be at least 1 characters long
Additional Properties of any type are allowed.
Type: objectDefinitions of plugin resources.
No Additional PropertiesDefinition 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.
No Additional PropertiesLocalization strings for predefined items, e.g. categories and menus. Each item should contain a single translation for each supported language.
Each additional property must conform to the following schema
Type: objectLocalized string item which should contain a definition for each of the locales defined in the locales list.
No Additional PropertiesMust be at least 1 characters long
Must be at least 1 characters long
Must be at least 1 characters long
Must be at least 1 characters long
Must be at least 1 characters long
Must be at least 1 characters long
Must be at least 1 characters long
Must be at least 1 characters long
Must be at least 1 characters long
All properties whose name matches the following regular expression must respect the following conditions
Property name regular expression:^[a-z]{2}-[A-Z]{2}$ Must be at least 1 characters long
Locales supported by the plugin. Those should match the actual localization items.
Must contain a minimum of 1 items
All items must be unique
No Additional ItemsLocales supported by the plugin. All localized strings should contain a definition for each of the locales defined in the current list. The current version of the vSphere Client supports: English US, German, Spanish, French, Japanese, Korean, Chinese Simplified, Chinese Traditional and Italian. English US is used by default if the plugin does not support the current vSphere Client locale.
^[a-z]{2}-[A-Z]{2}$ Definition of a composite sprite sheet containing one or more icons. Supports the definition of theme specific sprite sheets through the 'themeOverrides' property.
No Additional PropertiesDefines individual icons within the base theme sprite sheet.
Each additional property must conform to the following schema
Type: objectSpecifies the offset coordinates of an icon within the larger sprite-sheet.
No Additional PropertiesHorizontal icon offset in pixels within the sprite sheet starting from the left. Can be between 0 and the width of the sprite sheet (exclusive), e.g. 0, 32, 64, etc.
Value must be greater or equal to 0
Vertical icon offset within the sprite sheet starting from the top. Can be between 0 and the height of the sprite sheet (exclusive), e.g. 0, 32, 64, etc.
Value must be greater or equal to 0
Defines theme-specific sprite sheets.
No Additional PropertiesDefinition of a theme-specific sprite sheet containing one or more icons. The sprite sheet might contain only part of the icons present in the base sprite sheet, in this case missing icons will be taken from the base sprite sheet.
No Additional PropertiesDefines individual icons within the theme-specific sprite sheet.
Each additional property must conform to the following schema
Type: objectSpecifies the offset coordinates of an icon within the larger sprite-sheet.
Same definition as definitions_iconSpriteSheet_definitions_additionalPropertiesLocation of the sprite sheet.
Must be at least 1 characters long
Location of the sprite sheet.
Must be at least 1 characters long
Global scope of items that are not specific to a particular inventory object.
No Additional PropertiesGlobal 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.
No Additional PropertiesWhether this view is a public one i.e. exposed as a navigation target to other plugins. This property is valid only if this view has a 'navigationId'.
Path to the global view UI content relative to the folder of the plugin manifest.
Must be at least 1 characters long
Manifest format version: used for versioning of the plugin manifest schema against which the plugin's manifest is validated.
Scope used to define UI elements bound to a specific vSphere inventory object type.
No Additional PropertiesThe vSphere inventory object type category containing all plugin extensions on this object type.
No Additional PropertiesA single category with one or more Configure views on the current object. By default, the Configure category item is labeled with the display name of the plugin.
No Additional PropertiesDefinitions of category details.
Specify the plugin server URI which is expected to return which of the specified extensions will be visible in the UI.
Must be at least 1 characters long
Specify the plugin server URI which is expected to return which of the specified extensions will be visible on the UI.
Must be at least 1 characters long
Specifies the type of the server to receive the request. By default, this is the plugin manifest server.
The ordered list of views within the table of contents category.
All items must be unique
No Additional ItemsSpecify whether the view will be visible/hidden dynamically based on a remote call to the given plugin server path.
Whether this view is a public one i.e. exposed as a navigation target to other plugins. This property is valid only if this view has a 'navigationId'.
Label of the view displayed in the table of contents.
Must be at least 1 characters long
Location of the view UI content.
Must be at least 1 characters long
A single category with one or more Monitor views on the current object. By default, the Monitor category item is labeled with the display name of the plugin.
Same definition as configureA single card on the inventory object's summary screen. 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.
No Additional PropertiesSpecify whether the card will be visible/hidden dynamically based on a remote call to the given plugin server path.
The icon of the card. The default plugin icon will be used if no icon is provided.
Same definition as iconThe id of the card. Required when the card is specified as 'dynamic'.
Same definition as navigationIdDeprecated. This option was applicable to portlets and is not available for cards.
Value must be greater or equal to 1 and lesser or equal to 2
Deprecated. This option was applicable to portlets and is not available for cards.
Deprecated. This option was applicable to portlets and is not available for cards.
Value must be greater or equal to 1 and lesser or equal to 1
Size of the card's width. Default is 'medium'. Possible values are 'small', 'medium' and 'large'.
The title of the card. The default plugin name will be used if no title is provided.
Must be at least 1 characters long
Location of the section UI content.
Must be at least 1 characters long
Cards on the inventory object's summary screen. At most 5 cards can be defined. 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.
Must contain a minimum of 1 items
Must contain a maximum of 5 items
The vSphere inventory object type category containing all plugin extensions on this object type.
Same definition as ClusterComputeResourceThe vSphere inventory object type category containing all plugin extensions on this object type.
Same definition as ClusterComputeResourceThe vSphere inventory object type category containing all plugin extensions on this object type.
Same definition as ClusterComputeResourceThe vSphere inventory object type category containing all plugin extensions on this object type.
Same definition as ClusterComputeResourceThe vSphere inventory object type category containing all plugin extensions on this object type.
Same definition as ClusterComputeResourceThe vSphere inventory object type category containing all plugin extensions on this object type.
Same definition as ClusterComputeResourceThe vSphere inventory object type category containing all plugin extensions on this object type.
Same definition as ClusterComputeResourceThe vSphere inventory object type category containing all plugin extensions on this object type.
Same definition as ClusterComputeResourceThe vSphere inventory object type category containing all plugin extensions on this object type.
Same definition as ClusterComputeResourceThe vSphere inventory object type category containing all plugin extensions on this object type.
Same definition as ClusterComputeResourceThe vSphere inventory object type category containing all plugin extensions on this object type.
Same definition as ClusterComputeResourceThe vSphere inventory object type category containing all plugin extensions on this object type.
Same definition as ClusterComputeResourceThe vSphere inventory object type category containing all plugin extensions on this object type.
Same definition as ClusterComputeResourceThe vSphere inventory object type category containing all plugin extensions on this object type.
Same definition as ClusterComputeResourceThe vSphere inventory object type category containing all plugin extensions on this object type.
Same definition as ClusterComputeResourceThe vSphere inventory object type category containing all plugin extensions on this object type.
Same definition as ClusterComputeResourceThe vSphere inventory object type category containing all plugin extensions on this object type.
Same definition as ClusterComputeResourceThe vSphere inventory object type category containing all plugin extensions on this object type.
Same definition as ClusterComputeResourceThe vSphere inventory object type category containing all plugin extensions on this object type.
No Additional PropertiesA single category with one or more Configure views on the current object. By default, the Configure category item is labeled with the display name of the plugin.
Same definition as configureA single category with one or more Monitor views on the current object. By default, the Monitor category item is labeled with the display name of the plugin.
Same definition as monitorA single category with one or more Snapshots views on the current object. By default, the Snapshots category item is labeled with the display name of the plugin.
Same definition as configureDefine plugin menus rendered as children of the respective vSphere Client-defined sub-menus in the menu of VirtualMachine objects, e.g. VirtualMachine menu -> Snapshots sub-menu -> Plugin sub-menu.
No Additional PropertiesDefines a plugin menu rendered as a child of the vSphere Client-defined Snapshots sub-menu in the menu of VirtualMachine objects, e.g. VirtualMachine menu -> Snapshots sub-menu -> Plugin sub-menu. The plugin menu should contain at least one action and is labeled with the display name of the plugin.
Same definition as menuThe vSphere inventory object type category containing all plugin extensions on this object type.
Same definition as ClusterComputeResourceRequirements specification for the plugin.
No Additional PropertiesCapability flag for actions on multiple targets feature. This feature allows execution of actions on multiple selections.
Capability flag for accessibility title in an action modal dialog feature.
Capability flag for closable action modal dialog feature.
Capability flag for adding action separators.
Collection of browser specific options available to plugins.
No Additional ItemsAPI to open a confirmation modal dialog.
JS APIs for date and time formatting: 'htmlClientSdk.app.formatDateTime()' and 'htmlClientSdk.event.onDateTimeFormatChanged()'.
The version of the date and time formatting capability.
JS APIs for date and time formatting: 'htmlClientSdk.app.formatDateTime()' and 'htmlClientSdk.event.onDateTimeFormatChanged()'.
Capability flag for theme overrides support in icon sprite sheet.
Capability flag to enable the usage of multiple summary cards.
API to open a modal dialog.
Capability flag for the Per WCP Cluster Extensibility feature. The feature allows plugins, registered with the WCP Service, to extend specific WCP clusters only, not the root VC Folder like the regular plugins do.
Support for making API calls to any /api/ui endpoint in a linked vCenter environment.
The version of the set of APIs used to build the plugin.
JS API for retrieving the plugin backend servers: 'htmlClientSdk.getPluginBackendInfo'.
Capability flag for plugin dynamic extensions. It allows plugins to specify an endpoint which will be called by the vSphere Client and is expected to return which dynamic plugin extensions should be visible or hidden based on plugin backend checks (e.g. property values, privilege checks, etc.).
JS API for retrieving the proxied plugin server origin: 'htmlClientSdk.getProxiedPluginServerOrigin'.
Defines the supported vCenter Server environments.
Indicates the valid version or interval of versions.
Must match regular expression:^\s*(([\(\[]\s*(\d+(\.\d+){0,3})?\s*,\s*(\d+(\.\d+){0,3})?\s*[\)\]])|\d+(\.\d+){0,3})\s*$ Capability flag for extending top level Snapshots tab of VirtualMachine objects.