Test-ProvInventoryItem
Introduced in: Citrix Virtual Apps and Desktop 7 2206
Check if an inventory item can be used as an input for machine profile.
Syntax
Test-ProvInventoryItem
-HostingUnitName <String>
-InventoryPath <String>
[<CitrixCommonParameters>]
[<CommonParameters>]
Test-ProvInventoryItem
-HostingUnitUid <Guid>
-InventoryPath <String>
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Provides the ability to validate if an inventory item can be used as an input for the MachineProfile parameter while creating or updating a provisioning scheme.
Examples
EXAMPLE 1
Validates if the Azure template spec inventory item located at XDHyp:\HostingUnits\AzureRes\machineprofile.folder\rg.resourcegroup\machineprofile.templatespec\1.0.templatespecversion can be used as input for MachineProfile to either New-ProvScheme or Set-ProvScheme. Since the cmdlet returns no response, the template is a valid MachineProfile.
Test-ProvInventoryItem -HostingUnitName AzureRes -InventoryPath machineprofile.folder\rg.resourcegroup\machineprofile.templatespec\1.0.templatespecversion
EXAMPLE 2
Validates if version 1.0 of the Azure template spec machineprofile found under the hosting unit with identifier 8101028f-2570-4e17-9129-8e0cfc1e2558 can be used as input for MachineProfile to either New-ProvScheme or Set-ProvScheme. The cmdlet returns some validation errors that must be fixed before the template can be used.
Test-ProvInventoryItem -HostingUnitUid 8101028f-2570-4e17-9129-8e0cfc1e2558 -InventoryPath machineprofile.folder\rg.resourcegroup\machineprofile.templatespec\1.0.templatespecversion
ErrorMessage
---------------
Error: Provided disk encryption set ID in MachineProfile (input from the Azure template spec) does not exist
Error: Invalid storage account type in MachineProfile (input from the Azure template spec)
Parameters
-HostingUnitName
The name of the hosting unit used for the provisioning scheme.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HostingUnitUid
The identifier for the hosting unit used for the provisioning scheme.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InventoryPath
The partial inventory path to be validated as a machine profile. It should only contain the relative path from the hosting unit given in either the HostingUnitName or HostingUnitUid parameters. See the examples for how specify this partial path.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
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
None
You can't pipe objects to this cmdlet.
Outputs
Citrix.MachineCreation.Sdk.InventoryItemValidationResult
This object provides a validation error message from the inventory item and contains the following information:
ErrorMessage \<string\>
String describing a validation error from the inventory item.
Notes
In the case of failure, the following errors can result.
Error Codes
CommunicationError
An error occurred while communicating with the service.
PermissionDenied
The user does not have administrative rights to perform this operation.
ConfigurationLoggingError
The operation could not be performed because of a configuration logging error
ExceptionThrown
An unexpected error occurred. For more details, see the Windows event logs on the controller being used or Citrix Virtual Apps and Desktops logs.