Citrix Virtual Apps and Desktops SDK

Add-ProvMetadataConfiguration

August 3, 2023

Contributed by:

Add VM metadata configuration settings for a plugin.

Syntax

Add-ProvMetadataConfiguration [-PluginType] <String> [-ConfigurationName] <String> [-ConfigurationValue] <String> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Provides the ability to configure metadata setting for a hypervisor. Customer can run the command to manage the allowed Azure VM extension list. When an extension is added, it will be installed for catalog machines if the extension is also defined in MachineProfile VM/Template. Extensions that are not in the allowed list will be automatically ignored during catalog creation.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
PluginType	The plugin. AzureRM is the only plugin supported initially.	true	false
ConfigurationName	The configuration name. Extension is the only configuration supported initially.	true	false
ConfigurationValue	The setting for metadata configuration, for example Azure extension type.	true	false
LoggingId	Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.	false	false
BearerToken	Specifies the bearer token assigned to 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

Return Values

Notes

In the case of failure, the following errors can result.

ConfigurationValueAlreadyExists The configuration has already been added to the database.
ConfigurationNotValid The plugin type or configuration name is not valid.
AzureRM is the only plugin and Extension is the only configuration supported initially.
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 DatabaseError An error occurred in the service while attempting a database operation.
DatabaseNotConfigured The operation could not be completed because the database for the service is not configured.
ServiceStatusInvalidDb An error occurred in the service while attempting a database operation - communication with the database failed for for various reasons.
CommunicationError An error occurred while communicating with the service.
ExceptionThrown An unexpected error occurred.

For more details, check the Windows event logs on your self-hosted delivery controller or contact Citrix support if using Citrix DaaS (Citrix-hosted delivery controller).

Examples

Example 1

C:\PS>Add-ProvMetadataConfiguration -PluginType "AzureRm" -ConfigurationName "Extension" -ConfigurationValue "AADLoginForWindows"

<!--NeedCopy-->

Description

Add Azure VM extension AADLoginForWindows

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

Add-ProvMetadataConfiguration

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Add-ProvMetadataConfiguration

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Notes

Examples

Example 1

Description

In this article