PowerCLI Reference

Get-SpbmCapability

Synopsis

This cmdlet retrieves capability schema.

Syntax

Get-SpbmCapability [[-Name] <String[]>] [-Category <String[]>] [-Server <VIServer[]>] [-SpbmLineOfServiceType <SpbmLineOfServiceType[]>] [<CommonParameters>]

Related Commands

Online Version

Detailed Description

This cmdlet retrieves capability schema sorted by alphabetical order of the Name field. Each capability schema object has a unique identifier and contains the namespace to which the capability schema object belongs. Each registered namespace must be unique. You can relate a capability schema object with a unique vendor and resource type by using the namespace. After any VAIOFilter CRUD operation, there is an expected delay of approximately 30 seconds before the changes are reflected in the Get-SpbmCapability cmdlet.

To discover a namespace, run "Get-SpbmCapability | select Namespace -unique".

Parameters

Name	Type	Description	Required?	Pipeline Input
Name	String[]	Optional filter, based on full name of the capability schema object you want to retrieve. The full name must be in the format <namespace>.<CapabilityId> for the capability that contains only one property or <namespace>.<CapabilityId>.<PropertyId> for the capability that contains more than one property.	false	False
Category	String[]	Specifies the capability subcategory of the capability schema object you want to retrieve.	false	False
Server	VIServer[]	Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.	false	True (ByValue)
SpbmLineOfServiceType	SpbmLineOfServiceType[]	Specifies the line of service types for the SPBM capabilities.	false	False

Return Type

List of SpbmCapability objects

Notes

Works only with vCenter Server 5.5 or later. For more information, see the VMware Storage Policy API Reference: https://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vspsdk.apiref.doc/right-pane.html

Examples

-------------------------- Example 1 --------------------------

Get-SpbmCapability -Name "VSAN.stripeWidth"

Returns all SPBM capability schemas named "VSAN.stripeWidth". The name is unique for the capability schemas.

-------------------------- Example 2 --------------------------

Get-SpbmCapability -Name VSAN*

Returns all SPBM capability schemas whose name starts with VSAN.

-------------------------- Example 3 --------------------------

Get-SpbmCapability -Name "VSAN*" -Category "Performance"

Returns all SPBM capability schemas whose name starts with "VSAN" and are of category "Performance".

-------------------------- Example 4 --------------------------

Get-SpbmCapability -Name IOFILTERS*

Retrieves all capabilities from the VAIOFilter namespace.