Extension format for vSphere Client plugins

Type: object

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

 No Additional Properties

root manifestVersion
Type: enum (of string)

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

Must be one of:

  • "1.0.0"
  • "1.0.1"
  • "1.1.0"
  • "1.2.0"

root requirements
Type: object

Requirements specification for the plugin.

 No Additional Properties

root requirements plugin.api.version
Type: enum (of string)

The version of the set of APIs used to build the plugin.

Must be one of:

  • "1.0.0"
  • "1.0.1"
  • "1.1.0"
  • "1.2.0"

root requirements vcenter.server
Type: object

Defines the supported vCenter Server environments.

root requirements vcenter.server version
Type: string

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*$

root requirements vcenter.server environments
Type: array of enum (of string)

Each item of this array must be:

root requirements vcenter.server environments items
Type: enum (of string)

Must be one of:

  • "onprem"
  • "cloud"
  • "gateway"

root requirements vsphere.client
Type: object

Defines the supported vSphere Client environments.

Same definition as vcenter.server

root requirements confirmation.modal.api
Type: enum (of string)

API to open a confirmation modal dialog.

Must be one of:

  • "1.0.0"

root requirements client.view.navigation
Type: object

Enabling navigation to a client view via htmlClientSdk.app.navigateToClientView API. Valid target view ids are: ["administration.ceip", "cluster.configure.settings.drs", "cluster.configure.settings.ha", "cluster.configure.settings.quickstart", "folder.configure.keyProviders", "host.configure.networking.physicalAdapters", "host.summary", "namespace.storage.persistentVolumeClaims", "network.summary", "profilesAndPolicies.vmStoragePolicies", "vm.monitor.performance.overviewcies", "vm.summary"].

root requirements client.view.navigation version
Type: enum (of string)

The version of the client view navigation capability.

Must be one of:

  • "1.0.0"
  • "2.0.0"

root requirements dateTime.format.api

root requirements dateTime.format.api oneOf item 0
Type: object

JS APIs for date and time formatting: 'htmlClientSdk.app.formatDateTime()' and 'htmlClientSdk.event.onDateTimeFormatChanged()'.

root requirements dateTime.format.api oneOf item 0 version
Type: enum (of string)

The version of the date and time formatting capability.

Must be one of:

  • "1.0.0"
root requirements dateTime.format.api oneOf item 1
Type: enum (of string)

JS APIs for date and time formatting: 'htmlClientSdk.app.formatDateTime()' and 'htmlClientSdk.event.onDateTimeFormatChanged()'.

Must be one of:

  • "1.0.0"

root requirements browser.options
Type: array of enum (of string)

Collection of browser specific options available to plugins.

Each item of this array must be:

root requirements browser.options items
Type: enum (of string)

Must be one of:

  • "allow.popups"
  • "allow.popups.to.escape.sandbox"
  • "allow.downloads"

root requirements proxied.plugin.server.origin.api
Type: enum (of string)

JS API for retrieving the proxied plugin server origin: 'htmlClientSdk.getProxiedPluginServerOrigin'.

Must be one of:

  • "1.0.0"

root requirements icon.sprite.sheet.theming
Type: enum (of string)

Capability flag for theme overrides support in icon sprite sheet.

Must be one of:

  • "1.0.0"

root requirements plugin.backend.info.api
Type: enum (of string)

JS API for retrieving the plugin backend servers: 'htmlClientSdk.getPluginBackendInfo'.

Must be one of:

  • "1.0.0"

root requirements action.modal.closable
Type: boolean

Capability flag for closable action modal dialog feature.

root requirements action.modal.accessibility.title
Type: boolean

Capability flag for accessibility title in an action modal dialog feature.

root requirements action.accepts.multiple.targets
Type: boolean

Capability flag for actions on multiple targets feature. This feature allows execution of actions on multiple selections.

root requirements plugin.dynamic.extensions
Type: enum (of string)

Capability flag for plugin dynamic extensions. It enables plugins to specify an endpoint which will be called by the vSphere Client and is expected to return which dynamic plugin extensions should be shown or hidden based on plugin backend checks (e.g. property values, privilege checks, etc.).

Must be one of:

  • "1.0.0"

root configuration
Type: object

Plugin configuration properties

root configuration nameKey
Type: 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.

Must be at least 1 characters long

root configuration icon
Type: 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.

 No Additional Properties

root configuration icon name
Type: string

Name of the plugin icon itself or item within the sprite sheet.

Must be at least 1 characters long

Additional Properties of any type are allowed.

root configuration additionalProperties
Type: object

root global
Type: object

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

 No Additional Properties

root global view
Type: 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.

 No Additional Properties

root global view navigationId
Type: 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 via the JavaScript API app.navigateTo(configObj). The ID should be unique for the plugin manifest in which case uniqueness across the whole vSphere Client is ensured.

Must match regular expression: ^[a-zA-Z0-9_.-]+$

root global view isPublic
Type: boolean Default: false

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'.

root global view uri
Type: string

Path to the global view UI content relative to the folder of the plugin manifest.

Must be at least 1 characters long

root global view navigationVisible
Type: boolean Default: true

Whether to display the Object Navigator or not. Hiding the Object Navigator is commonly used to implement custom plugin navigation.

root objects
Type: object

Scope used to define UI elements bound to a specific vSphere inventory object type.

 No Additional Properties

root objects ClusterComputeResource
Type: object

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

 No Additional Properties

root objects ClusterComputeResource summary
Type: object
No Additional Properties

root objects ClusterComputeResource summary view
Type: object

A single section view 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 Properties

root objects ClusterComputeResource summary view uri
Type: string

Location of the section UI content.

Must be at least 1 characters long

root objects ClusterComputeResource summary view icon
Type: object

Reference to plugin vendor icon.

Same definition as icon

root objects ClusterComputeResource summary view size
Type: object
No Additional Properties

root objects ClusterComputeResource summary view size type
Type: enum (of string)

Sizing type of the summary view indicating how much of the default section size should be consumed vertically and horizontally. Allowed spans are 1-by-1 and 1-by-2.

Must be one of:

  • "span"

root objects ClusterComputeResource summary view size widthSpan
Type: 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.

Value must be greater or equal to 1 and lesser or equal to 1

root objects ClusterComputeResource summary view size heightSpan
Type: integer

Height factor of the section related to the default height.

Value must be greater or equal to 1 and lesser or equal to 2

root objects ClusterComputeResource monitor
Type: 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.

 No Additional Properties

root objects ClusterComputeResource monitor views
Type: array

The ordered list of views within the table of contents category.

All items must be unique

Each item of this array must be:

root objects ClusterComputeResource monitor views view
Type: object
No Additional Properties

root objects ClusterComputeResource monitor views items navigationId
Type: string

ID of the view used only for navigation. It should be unique within the scope of the plugin. Required when the view is specified as 'dynamic'.

Must match regular expression: ^[a-zA-Z0-9_.-]+$

root objects ClusterComputeResource monitor views items isPublic
Type: boolean Default: false

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'.

root objects ClusterComputeResource monitor views items labelKey
Type: string

Label of the view displayed in the table of contents.

Must be at least 1 characters long

root objects ClusterComputeResource monitor views items uri
Type: string

Location of the view UI content.

Must be at least 1 characters long

root objects ClusterComputeResource monitor views items dynamic
Type: boolean

Specify whether the view will be shown/hidden dynamically based on a remote call to the given dynamicUri on the plugin server.

root objects ClusterComputeResource monitor dynamicUri
Type: string

Specify the plugin server URI which is expected to return which of the specified views will be shown on the UI.

root objects ClusterComputeResource configure
Type: 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.

Same definition as monitor

root objects ClusterComputeResource menu
Type: object

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

 No Additional Properties

root objects ClusterComputeResource menu actions
Type: array

Set of actions to display in the menu.

All items must be unique

Each item of this array must be:

root objects ClusterComputeResource menu actions action
Type: object
No Additional Properties

root objects ClusterComputeResource menu actions items id
Type: string

The id of the action. Required when the action is specified as 'dynamic'.

Must match regular expression: ^[a-zA-Z0-9_.-]+$

root objects ClusterComputeResource menu actions items labelKey
Type: string

Label of the action displayed in menus.

Must be at least 1 characters long

root objects ClusterComputeResource menu actions items icon
Type: object

Reference to the icon of the menu item.

Same definition as icon

root objects ClusterComputeResource menu actions items acceptsMultipleTargets
Type: boolean Default: false

Specify whether the action can work on multiple selected objects.

root objects ClusterComputeResource menu actions items trigger

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

root objects ClusterComputeResource menu actions items trigger oneOf item 0
Type: object
No Additional Properties

root objects ClusterComputeResource menu actions items trigger oneOf item 0 type
Type: enum (of string)

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

Must be one of:

  • "modal"

root objects ClusterComputeResource menu actions items trigger oneOf item 0 uri
Type: string

Location of the modal dialog UI content.

Must be at least 1 characters long

root objects ClusterComputeResource menu actions items trigger oneOf item 0 titleKey
Type: string

Title of the action modal dialog.

Must be at least 1 characters long

root objects ClusterComputeResource menu actions items trigger oneOf item 0 accessibilityTitleKey
Type: string

Accessibility title of the action modal dialog.

Must be at least 1 characters long

root objects ClusterComputeResource menu actions items trigger oneOf item 0 size
Type: object
No Additional Properties

root objects ClusterComputeResource menu actions items trigger oneOf item 0 size width
Type: integer

The action modal dialog width in pixels.

root objects ClusterComputeResource menu actions items trigger oneOf item 0 size height
Type: integer

The action modal dialog height in pixels.

root objects ClusterComputeResource menu actions items trigger oneOf item 0 closable
Type: boolean Default: true

Specify whether the modal dialog should have a close button.

root objects ClusterComputeResource menu actions items dynamic
Type: boolean

Specify whether the action will be shown/hidden dynamically based on a remote call to the given dynamicUri on the plugin server.

root objects ClusterComputeResource menu dynamicUri
Type: string

Specify the plugin server URI which is expected to return which of the specified actions will be shown on the UI.

root objects Datacenter
Type: object

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

Same definition as ClusterComputeResource

root objects Datastore
Type: object

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

Same definition as ClusterComputeResource

root objects DistributedVirtualPortgroup
Type: object

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

Same definition as ClusterComputeResource

root objects DistributedVirtualSwitch
Type: object

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

Same definition as ClusterComputeResource

root objects Folder:DatacenterFolder
Type: object

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

Same definition as ClusterComputeResource

root objects Folder:DatastoreFolder
Type: object

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

Same definition as ClusterComputeResource

root objects Folder:HostFolder
Type: object

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

Same definition as ClusterComputeResource

root objects Folder:NetworkFolder
Type: object

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

Same definition as ClusterComputeResource

root objects Folder:RootFolder
Type: object

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

Same definition as ClusterComputeResource

root objects Folder:VirtualMachineFolder
Type: object

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

Same definition as ClusterComputeResource

root objects HostSystem
Type: object

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

Same definition as ClusterComputeResource

root objects Network
Type: object

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

Same definition as ClusterComputeResource

root objects OpaqueNetwork
Type: object

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

Same definition as ClusterComputeResource

root objects ResourcePool
Type: object

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

Same definition as ClusterComputeResource

root objects StoragePod
Type: object

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

Same definition as ClusterComputeResource

root objects SupervisorClusterComputeResource
Type: object

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

Same definition as ClusterComputeResource

root objects VirtualApp
Type: object

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

Same definition as ClusterComputeResource

root objects VirtualMachine
Type: object

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

Same definition as ClusterComputeResource

root objects VirtualMachineTemplate
Type: object

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

Same definition as ClusterComputeResource

root definitions
Type: object

Definitions of plugin resources.

 No Additional Properties

root definitions iconSpriteSheet
Type: object

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 Properties

root definitions iconSpriteSheet uri
Type: string

Location of the sprite sheet.

Must be at least 1 characters long

root definitions iconSpriteSheet definitions
Type: object

Defines individual icons within the base theme sprite sheet.

Each additional property must conform to the following schema

root definitions iconSpriteSheet definitions spriteOffset
Type: object

Specifies the offset coordinates of an icon within the larger sprite-sheet.

 No Additional Properties

root definitions iconSpriteSheet definitions additionalProperties x
Type: integer

Horizontal 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

root definitions iconSpriteSheet definitions additionalProperties y
Type: integer

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

root definitions iconSpriteSheet themeOverrides
Type: object

Defines theme-specific sprite sheets.

 No Additional Properties

root definitions iconSpriteSheet themeOverrides dark
Type: object

Definition 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 Properties

root definitions iconSpriteSheet themeOverrides dark uri
Type: string

Location of the sprite sheet.

Must be at least 1 characters long

root definitions iconSpriteSheet themeOverrides dark definitions
Type: object

Defines individual icons within the theme-specific sprite sheet.

Each additional property must conform to the following schema

root definitions iconSpriteSheet themeOverrides dark definitions spriteOffset
Type: object

Specifies the offset coordinates of an icon within the larger sprite-sheet.

Same definition as spriteOffset

root definitions i18n
Type: 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.

 No Additional Properties

root definitions i18n locales
Type: array

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

Must contain a minimum of 1 items

Must contain a maximum of 8 items

All items must be unique

Each item of this array must be:

root definitions i18n locales locales
Type: enum (of string)

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. English US is used by default if the plugin does not support the current vSphere Client locale.

Must be one of:

  • "en-US"
  • "de-DE"
  • "es-ES"
  • "fr-FR"
  • "ja-JP"
  • "ko-KR"
  • "zh-CN"
  • "zh-TW"

root definitions i18n definitions
Type: object

Localization 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

root definitions i18n definitions localizedItem
Type: object

Localized string item which should contain a definition for each of the locales defined in the locales list.

 No Additional Properties

root definitions i18n definitions additionalProperties en-US
Type: string

Must be at least 1 characters long

root definitions i18n definitions additionalProperties de-DE
Type: string

Must be at least 1 characters long

root definitions i18n definitions additionalProperties es-ES
Type: string

Must be at least 1 characters long

root definitions i18n definitions additionalProperties fr-FR
Type: string

Must be at least 1 characters long

root definitions i18n definitions additionalProperties ja-JP
Type: string

Must be at least 1 characters long

root definitions i18n definitions additionalProperties ko-KR
Type: string

Must be at least 1 characters long

root definitions i18n definitions additionalProperties zh-CN
Type: string

Must be at least 1 characters long

root definitions i18n definitions additionalProperties zh-TW
Type: string

Must be at least 1 characters long