Citrix Virtual Apps and Desktops SDK

Get-ProvSchemeResourceInStorage

March 11, 2024

Contributed by:

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

Syntax

Get-ProvSchemeResourceInStorage [-ProvisioningSchemeName] <String> [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Get-ProvSchemeResourceInStorage -ProvisioningSchemeUid <Guid> [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

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

Parameters

Name	Description	Required?	Pipeline Input	Default Value
ProvisioningSchemeName	The name of the provisioning scheme.	true	true (ByPropertyName)
ProvisioningSchemeUid	The unique identifier of the provisioning scheme.	true	false
BearerToken	Specifies the bearer token assigned to the calling user	false	false
AdminClientIP	Specifies the Client IP of the calling user	false	false
TraceParent	Specifies the trace parent assigned for internal diagnostic tracing use	false	false
TraceState	Specifies the trace state assigned for internal diagnostic tracing user	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	false	false
AdminAddress	The address of a Citrix Virtual Apps and Desktops controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address.	false	false	Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Citrix.Machinecreation.Sdk.Provisioningscheme

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

Return Values

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: o The provisioned scheme name o The provisioned scheme id o The hosting unit name o The hosting unit id o Array of provisioned resource in OS storage

Examples

Example 1

C:\PS> 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-->

Description

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

Example 2

C:\PS> 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-->

Description

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”.

Example 3

C:\PS> $result = Get-ProvSchemeResourceInStorage -ProvisioningSchemeUid '9c08beec-154e-4a00-ad56-f97adb69aad4'

                C:\PS> $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-->

Description

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

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Get-ProvSchemeResourceInStorage

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Get-ProvSchemeResourceInStorage

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.Machinecreation.Sdk.Provisioningscheme

Return Values

Citrix.Machinecreation.Sdk.Provschemeresourceinstorage

Notes

Examples

Example 1

Description

Example 2

Description

Example 3

Description

In this article