< Back
Get-SpbmCompatibleStorage
Post
NAME Get-SpbmCompatibleStorage
SYNOPSIS
This cmdlet performs placement compatibility checking based on a storage requirement policy.
SYNTAX
Get-SpbmCompatibleStorage [-CandidateStorage <StorageResource[]>] [-Server <VIServer[]>] -StoragePolicy
<SpbmStoragePolicy> [<CommonParameters>]
DESCRIPTION
This cmdlet performs placement compatibility checking based on a storage requirement policy. If the compatibility
checking for a hub does not produce any errors, the hub is considered as a viable candidate for virtual machine
file storage.
When the CandidateStorage parameter is specified, each object in the output is equal to some of the objects in the
input (the -eq operation returns true).
PARAMETERS
-CandidateStorage <StorageResource[]>
Specifies a list of datastores and storage pods that are candidates for storage resources. If you do not
specify this parameter, the server uses all of the datastores and storage pods for placement compatibility
checking.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-StoragePolicy <SpbmStoragePolicy>
Specifies a storage requirement policy.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
List of storage resources (datastores and storage pods) matching the policy
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/inde ... -pane.html
-------------------------- Example 1 --------------------------
Get-SpbmCompatibileStorage -StoragePolicy $policy
Returns all datastores and datastore clusters that are in compliance with storage policy.
-------------------------- Example 2 --------------------------
Get-SpbmCompatibileStorage -StoragePolicy $policy -CandidateStorage $ListOfDatastoreOrDatastoreCluster
Returns all datastores and datastore clusters from the $ListOfDatastoreOrDatastoreCluster list that are in
compliance with the $policy storage policy.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... orage.html
SYNOPSIS
This cmdlet performs placement compatibility checking based on a storage requirement policy.
SYNTAX
Get-SpbmCompatibleStorage [-CandidateStorage <StorageResource[]>] [-Server <VIServer[]>] -StoragePolicy
<SpbmStoragePolicy> [<CommonParameters>]
DESCRIPTION
This cmdlet performs placement compatibility checking based on a storage requirement policy. If the compatibility
checking for a hub does not produce any errors, the hub is considered as a viable candidate for virtual machine
file storage.
When the CandidateStorage parameter is specified, each object in the output is equal to some of the objects in the
input (the -eq operation returns true).
PARAMETERS
-CandidateStorage <StorageResource[]>
Specifies a list of datastores and storage pods that are candidates for storage resources. If you do not
specify this parameter, the server uses all of the datastores and storage pods for placement compatibility
checking.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-StoragePolicy <SpbmStoragePolicy>
Specifies a storage requirement policy.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
List of storage resources (datastores and storage pods) matching the policy
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/inde ... -pane.html
-------------------------- Example 1 --------------------------
Get-SpbmCompatibileStorage -StoragePolicy $policy
Returns all datastores and datastore clusters that are in compliance with storage policy.
-------------------------- Example 2 --------------------------
Get-SpbmCompatibileStorage -StoragePolicy $policy -CandidateStorage $ListOfDatastoreOrDatastoreCluster
Returns all datastores and datastore clusters from the $ListOfDatastoreOrDatastoreCluster list that are in
compliance with the $policy storage policy.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... orage.html