Citrix Virtual Apps and Desktops SDK

Get-ProvSchemeResourceInStorage

Gets the summary of the base disk and machine count in each OS storage for the provisioning scheme.

Syntax

Get-ProvSchemeResourceInStorage
   [-ProvisioningSchemeName] <String>
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Get-ProvSchemeResourceInStorage
   -ProvisioningSchemeUid <Guid>
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Lets you retrieve the resource summary in each OS storage of the provisioning scheme, such as base disks and the machine count.

Examples

EXAMPLE 1

Returns the provisioning scheme name, hosting unit name, hosting unit id, and provisioning resource in storage object of the associated provisioning scheme id.

Get-ProvSchemeResourceInStorage -ProvisioningSchemeUid '9c08beec-154e-4a00-ad56-f97adb69aad4'

  ProvisioningSchemeName       : Vmware-MC
  ProvisioningSchemeUid        : 9c08beec-154e-4a00-ad56-f97adb69aad4
  HostingUnitName              : Vmware-hostingUnit
  HostingUnitUid               : 56b22b5e-b54d-49bc-a6f7-5dd336f6f70b
  ProvResourceInStorage        : {datastore-11, datastore-12}
<!--NeedCopy-->

EXAMPLE 2

Returns the provisioning scheme name, hosting unit name, hosting unit id, and provisioning resource in storage object of all the provisioning schemes with hosting unit as “Vmware-hostingUnit”.

Get-ProvScheme |Where-Object {$_.HostingUnitName -eq "Vmware-hostingUnit"} | Get-ProvSchemeResourceInStorage

  ProvisioningSchemeName       : Vmware-MC
  ProvisioningSchemeUid        : 9c08beec-154e-4a00-ad56-f97adb69aad4
  HostingUnitName              : Vmware-hostingUnit
  HostingUnitUid               : 56b22b5e-b54d-49bc-a6f7-5dd336f6f70b
  ProvResourceInStorage        : {datastore-11, datastore-12}

  ProvisioningSchemeName       : Vmware-MC2
  ProvisioningSchemeUid        : e9aa1cf8-b2a8-4c3c-a309-1d53f7882e76
  HostingUnitName              : Vmware-hostingUnit
  HostingUnitUid               : 56b22b5e-b54d-49bc-a6f7-5dd336f6f70b
  ProvResourceInStorage        : {datastore-11, datastore-12}
<!--NeedCopy-->

EXAMPLE 3

Returns the ID, name, and resource of the provisioned scheme object of the provisioning scheme id “9c08beec-154e-4a00-ad56-f97adb69aad4”.

$result = Get-ProvSchemeResourceInStorage -ProvisioningSchemeUid '9c08beec-154e-4a00-ad56-f97adb69aad4'
$result.ProvResourceInStorage | Format-List -Property *

OSStorageId         : datastore-11
OSStoragePath       : /Datacenter1.datacenter/Cluster1.cluster/datastore1.storage
OSStorageSuperseded : False
BaseDiskId          : {Version=2,LsiLogicScsi,1000,group-v4,[Datastore1]
Vmware-MC-baseDisk-datastore-11/Vmware-MC-baseDisk-datastore-11.vmdk,resgroup-93,Vmfs}
MachineCount        : 2

OSStorageId         : datastore-12
OSStoragePath       : /Datacenter1.datacenter/Cluster1.cluster/datastore2.storage
OSStorageSuperseded : False
BaseDiskId          : {}
MachineCount        : 0
<!--NeedCopy-->

Parameters

-ProvisioningSchemeName

The name of the provisioning scheme.

Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-ProvisioningSchemeUid

The unique identifier of the provisioning scheme.

Type: Guid
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: True

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Citrix.MachineCreation.Sdk.ProvisioningScheme

You can pipe an object containing a parameter called ‘ProvisioningSchemeName’ to Get-ProvSchemeResourceInStorage.

Outputs

Citrix.MachineCreation.Sdk.ProvSchemeResourceInStorage

The object provides the resource details of the provisioning scheme and contains the following information:

ProvisioningSchemeName <string>

The name of the provisioning scheme.

ProvisioningSchemeUid <Guid>

The unique identifier for the provisioning scheme.

HostingUnitName <string>

The name of the hosting unit being used by the provisioning scheme.

HostingUnitUid <Guid>

The unique identifier of the hosting unit being used by the provisioning scheme.

ProvisionedResourceInStorage <Citrix.MachineCreation.Sdk.ProvisionedResourceInStorage[]>

A list of objects containing the OS storage id, path, base disk Id, and the number of machines located in the storage.

Notes

The Get-ProvSchemeResourceInStorage cmdlet returns an object containing the following five sub-objects:

  • The provisioned scheme name
  • The provisioned scheme id
  • The hosting unit name
  • The hosting unit id
  • Array of provisioned resource in OS storage
Get-ProvSchemeResourceInStorage