Get-SpbmEntityConfiguration Command | Vmware PowerCLI Reference

Get-SpbmEntityConfiguration

This cmdlet retrieves SPBM-related configuration data of Virtual Machine, Hard Disk, and Datastore 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. Associated default storage policy for datastores.

Syntax

Get-SpbmEntityConfiguration
[-CheckComplianceNow ]
[-Datastore < Datastore[] > ]
[-HardDisk < HardDisk[] > ]
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[-VM < VIObject[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional CheckComplianceNow SwitchParameter named
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.
optional Datastore Datastore[] named
  • wildcards
Specifies the datastores for which you want to retrieve default storage policy data.
optional HardDisk HardDisk[] named
Specifies virtual disks for which you want to check compliance.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
  • wildcards
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.
optional VM VIObject[] named
  • pipeline
  • wildcards
Specifies the virtual machines, hard disks, and datastores for which you want to retrieve SPBM-related configuration data.
Get-SpbmEntityConfiguration
[-CheckComplianceNow ]
[-HardDisksOnly ]
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[-StoragePolicy < SpbmStoragePolicy[] > ]
[-VMsOnly ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional CheckComplianceNow SwitchParameter named
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.
optional HardDisksOnly SwitchParameter named
If the value is $true, retrieves the configuration data only for hard disks.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
  • wildcards
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.
optional StoragePolicy SpbmStoragePolicy[] named
  • pipeline
  • wildcards
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.
optional VMsOnly SwitchParameter named
If the value is $true, retrieves the configuration data only for virtual machines.

Output

VMware.VimAutomation.Storage.Types.V1.Spbm.SpbmEntityConfiguration

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) -Datastore $datastore1

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

Example 6

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

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

Related Commands

SpbmEntityConfiguration

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

This cmdlet sets SPBM-related configuration data for VirtualMachine, HardDisk, and Datastore objects.