## PowerCLI Reference

# Get-SpbmEntityConfiguration

## Synopsis

This cmdlet retrieves SPBM-related configuration data of Virtual Machine, Hard Disk and Cluster objects.

Syntax

Get-SpbmEntityConfiguration [-StoragePolicy <SpbmStoragePolicy[]>] [-VMsOnly] [-HardDisksOnly] [-CheckComplianceNow] [-Server <VIServer[]>] [<CommonParameters>]
Get-SpbmEntityConfiguration [[-VM] <VIObject[]>] [-HardDisk <HardDisk[]>] [-Cluster <Cluster[]>] [-CheckComplianceNow] [-Server <VIServer[]>] [<CommonParameters>]

Related Commands

Online version
Set-SpbmEntityConfiguration

Detailed Description

This cmdlet retrieves SPBM-related configuration data of Virtual Machine, Hard Disk and Cluster objects.
The configuration data includes:
1. Associated storage policy for virtual machines or hard disks.
2. Compliance status for virtual machines or hard disks.
3. SPBM enablement status for cluster.

Parameters

Name | Type | Description | Required? | Pipeline Input | Default Value
--- | --- | --- | --- | --- | ---
VM | VIObject[] | Specifies the virtual machines, hard disks, and clusters, for which you want to retrieve SPBM-related configuration data. | false | true (ByValue)
CheckComplianceNow | SwitchParameter | If the value is $true, checks the compliance status and updates the server cache. If $false, returns the latest available compliance status from the server cache. | false | false
Cluster | Cluster[] | Specifies the clusters, for which you want to check whether SPBM is enabled or disabled on them. | false | false
HardDisk | HardDisk[] | Specifies virtual disks for which you want to check compliance. | false | false
HardDisksOnly | SwitchParameter | If the value is $true, retrieves the configuration data only for hard disks. | 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 | false
StoragePolicy | SpbmStoragePolicy[] | Specifies the storage policies against which the compliance status will be evaluated. A storage policy can be associated with one or multiple StorageObjects (VM Home or Disks). There will be one association object with compliance status for each policy - entity combination. If no storage policy is specified, the cmdlet returns the status for all available storage policies. | false | true (ByValue)
VMsOnly | SwitchParameter | If the value is $true, retrieves the configuration data only for virtual machines. | false | false

Return Type

Zero or more objects derived from SpbmEntityConfiguration

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-SpbmEntityConfiguration -StoragePolicy $policy

Returns the SPBM configuration and compliance status of all Virtual Machine and Hard Disk objects associated with the $policy storage policy.

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

    Get-SpbmEntityConfiguration -StoragePolicy $policy -CheckComplianceNow

Returns the SPBM configuration and compliance status of all Virtual Machine and Hard Disk objects associated with the $policy storage policy and updates the server cache.

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

    Get-SpbmEntityConfiguration -StoragePolicy $policy -HardDisksOnly

Returns the SPBM configuration and compliance status of all Hard Disk objects associated with the $policy storage policy.

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

    Get-SpbmEntityConfiguration -VM $vm1, $vm2 -CheckComplianceNow

Returns the SPBM configuration and compliance status of the $vm1 and $vm2 virtual machines and updates the server cache.

-------------- Example 5 --------------

    Get-SpbmEntityConfiguration -HardDisk (Get-HardDisk -VM $vm1) -Cluster $cluster1

Returns the SPBM configuration and compliance status of all Hard Disk objects of the $vm1 virtual machine and the SPBM configuration status of the $cluster1 cluster.

-------------- Example 6 --------------

    Get-SpbmEntityConfiguration $vm1, $vm2, $hd1, $cluster1

Returns the SPBM configuration and compliance status of the $vm1 and $vm2 virtual machines, the $hd1 hard disk, and the $cluster1 cluster.

Copyright © VMware, Inc. All rights reserved.