Citrix Daas SDK

Add-ProvMetadataConfiguration

November 28, 2023

Contributed by:

C C

Add VM metadata configuration settings for a plugin.

Syntax

Add-ProvMetadataConfiguration
   [-PluginType] <String>
   [-ConfigurationName] <String>
   [-ConfigurationValue] <String>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

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.

Examples

EXAMPLE 1

Add Azure VM extension AADLoginForWindows

Add-ProvMetadataConfiguration -PluginType "AzureRmFactory" -ConfigurationName "Extension" -ConfigurationValue "AADLoginForWindows"
<!--NeedCopy-->

Parameters

-PluginType

The name of the hypervisor plug-in factory. Currently, AzureRmFactory is the only supported plug-in factory.

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ConfigurationName

The configuration name. Currently, Extension is the only supported configuration.

Type:	String
Position:	3
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ConfigurationValue

The setting for metadata configuration, for example Azure extension type.

Type:	String
Position:	4
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	Guid
Position:	Named
Default value:	None
Required:	False
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

None

By default, this cmdlet returns no output.

Notes

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

Error Codes

ConfigurationValueAlreadyExists

The configuration has already been added to the database.

ConfigurationNotValid

The plugin type or configuration name is not valid. AzureRmFactory is the only plugin type, and Extension is the only configuration supported.

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

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

November 28, 2023

Contributed by:

C C

November 28, 2023

Contributed by:

C C

Add-ProvMetadataConfiguration

Syntax

Description

Examples

EXAMPLE 1

Parameters

-PluginType

-ConfigurationName

-ConfigurationValue

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

None

Notes

Related Links

In this article