Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2303 2212 2209 2206 2203 2112 2109 2103 1912

Get-ProvMetadataConfiguration

August 3, 2023
Contributed by: 
C

Get VM metadata configuration settings for a plugin.

Syntax


Get-ProvMetadataConfiguration [-PluginType <String>] [-ConfigurationName <String>] [-CitrixDefined <Boolean>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Provides the ability to get metadata settings for a specific hypervisor.

Parameters

Name Description Required? Pipeline Input Default Value
PluginType The plugin. AzureRM is the only plugin supported initially. false false  
ConfigurationName The configuration name. Extension is the only configuration supported initially. false false  
CitrixDefined Indicates whether it is defined by Citrix false false  
ReturnTotalRecordCount When specified, the cmdlet outputs an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Prov_Filtering for details. false false False
MaxRecordCount Specifies the maximum number of records to return. false false 250
Skip Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount. false false 0
SortBy Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present. false false The default sort order is by name or unique identifier.
Filter Gets records that match a PowerShell-style filter expression. See about_Prov_Filtering for details. false false  
FilterScope Gets only results allowed by the specified scope id. 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

Citrix.Machinecreation.Sdk.Provmetadataconfiguration

The object has the following properties:

  • PluginType &lt;string&gt; The name of Plugin

  • ConfigurationName &lt;string&gt; The name of configuration

  • ConfigurationValue &lt;string&gt; The value of configuration

  • CitrixDefined &lt;bool&gt; Indicates if the configuration is defined by Citrix.

Notes

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

  • 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>Get-ProvMetadataConfiguration

          PluginType ConfigurationName ConfigurationValue    CitrixDefined

          ---------- ----------------- ------------------    -------------

          AzureRM    Extension         AADLoginForWindows             True

          AzureRM    Extension         CustomScriptExtension         False

<!--NeedCopy-->

Description

Get all configuration settings

Example 2 


C:\PS>Get-ProvMetadataConfiguration -PluginType "AzureRm"

          PluginType ConfigurationName ConfigurationValue    CitrixDefined

          ---------- ----------------- ------------------    -------------

          AzureRM    Extension         AADLoginForWindows             True

          AzureRM    Extension         CustomScriptExtension         False

<!--NeedCopy-->

Description

Get configuration settings for AzureRM plugin

Example 3 


C:\PS>Get-ProvMetadataConfiguration -PluginType "AzureRm" -ConfigurationName "Extension"

          PluginType ConfigurationName ConfigurationValue    CitrixDefined

          ---------- ----------------- ------------------    -------------

          AzureRM    Extension         AADLoginForWindows             True

          AzureRM    Extension         CustomScriptExtension         False

<!--NeedCopy-->

Description

Get supported VM extensions for AzureRM plugin

Get-ProvMetadataConfiguration
August 3, 2023
Contributed by: 
C
August 3, 2023
Contributed by: 
C

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.