Get-ProvMetadataConfiguration
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>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Provides the ability to get metadata settings for a specific hypervisor.
Examples
EXAMPLE 1
Get all configuration settings
Get-ProvMetadataConfiguration
PluginType ConfigurationName ConfigurationValue CitrixDefined
---------- ----------------- ------------------ -------------
AzureRM Extension AADLoginForWindows True
AzureRM Extension CustomScriptExtension False
EXAMPLE 2
Get configuration settings for AzureRM plugin
Get-ProvMetadataConfiguration -PluginType "AzureRm"
PluginType ConfigurationName ConfigurationValue CitrixDefined
---------- ----------------- ------------------ -------------
AzureRM Extension AADLoginForWindows True
AzureRM Extension CustomScriptExtension False
EXAMPLE 3
Get supported VM extensions for AzureRM plugin
Get-ProvMetadataConfiguration -PluginType "AzureRm" -ConfigurationName "Extension"
PluginType ConfigurationName ConfigurationValue CitrixDefined
---------- ----------------- ------------------ -------------
AzureRM Extension AADLoginForWindows True
AzureRM Extension CustomScriptExtension False
Parameters
-PluginType
The name of the hypervisor plug-in factory. Currently, AzureRmFactory is the only supported plug-in factory.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ConfigurationName
The configuration name. Currently, Extension is the only supported configuration.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CitrixDefined
Indicates whether it is defined by Citrix
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaxRecordCount
Specifies the maximum number of records to return.
| Type: | Int32 |
| Position: | Named |
| Default value: | 250 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Skip
Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.
| Type: | Int32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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.
| Type: | String |
| Position: | Named |
| Default value: | The default sort order is by name or unique identifier. |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Filter
Gets records that match a PowerShell-style filter expression. See about_Prov_Filtering for details.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FilterScope
Gets only results allowed by the specified scope id.
| 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
Citrix.MachineCreation.Sdk.ProvMetadataConfiguration
The object has the following properties:
PluginType \<string\>
The name of Plugin
ConfigurationName \<string\>
The name of configuration
ConfigurationValue \<string\>
The value of configuration
CitrixDefined \<bool\>
Indicates if the configuration is defined by Citrix.
Notes
In the case of failure, the following errors can result.
Error Codes
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).