Product Documentation

Citrix.Configuration.Admin.V2

Nov 18, 2015

Overview

Name Description
ConfigConfigurationSnapin The Configuration service PowerShell snap-in provides administrative
Config Filtering Describes the common filtering options for XenDesktop cmdlets.

Cmdlets

Name Description
Add-ConfigRegisteredServiceInstanceMetadata Adds metadata on the given ServiceInstance.
Add-ConfigServiceGroupMetadata Adds metadata on the given ServiceGroup.
Export-ConfigFeatureTable Returns the current feature table.
Get-ConfigDBConnection Gets the database string for the specified data store used by the Configuration Service.
Get-ConfigDBSchema Gets a script that creates the Configuration Service database schema for the specified data store.
Get-ConfigDBVersionChangeScript Gets a script that updates the Configuration Service database schema.
Get-ConfigEnabledFeature Lists features of the site that are enabled.
Get-ConfigInstalledDBVersion Gets a list of all available database schema versions for the Configuration Service.
Get-ConfigLicensingModel Lists the supported licensing models.
Get-ConfigLocalData Gets the service local data.
Get-ConfigProduct Lists the site's supported product names and codes.
Get-ConfigProductEdition Lists the supported product editions.
Get-ConfigProductFeature Lists the supported features.
Get-ConfigProductVersion Lists the supported product versions.
Get-ConfigRegisteredServiceInstance Gets the service instances that are registered in the directory.
Get-ConfigService Gets the service record entries for the Configuration Service.
Get-ConfigServiceAddedCapability Gets any added capabilities for the Configuration Service on the controller.
Get-ConfigServiceGroup Gets the service groups that match the parameters supplied.
Get-ConfigServiceInstance Gets the service instance entries for the Configuration Service.
Get-ConfigServiceStatus Gets the current status of the Configuration Service on the controller.
Get-ConfigSite Gets the site.
Import-ConfigFeatureTable Sets the feature table of the site.
Register-ConfigServiceInstance Allows the registration of a service instance.
Remove-ConfigRegisteredServiceInstanceMetadata Removes metadata from the given ServiceInstance.
Remove-ConfigServiceGroup Removes service groups.
Remove-ConfigServiceGroupMetadata Removes metadata from the given ServiceGroup.
Remove-ConfigServiceMetadata Removes metadata from the given Service.
Remove-ConfigSiteMetadata Removes metadata from the given Site.
Reset-ConfigServiceGroupMembership Reloads the access permissions and configuration service locations for the Configuration Service.
Set-ConfigDBConnection Configures a database connection for the Configuration Service.
Set-ConfigRegisteredServiceInstance Updates a service instance.
Set-ConfigRegisteredServiceInstanceMetadata Adds or updates metadata on the given ServiceInstance.
Set-ConfigServiceGroupMetadata Adds or updates metadata on the given ServiceGroup.
Set-ConfigServiceMetadata Adds or updates metadata on the given Service.
Set-ConfigSite Changes the overall settings of the site.
Set-ConfigSiteMetadata Adds or updates metadata on the Site.
Test-ConfigDBConnection Tests a database connection for the Configuration Service.
Test-ConfigServiceInstanceAvailability Tests whether the supplied service instances are responding to requests.
Unregister-ConfigRegisteredServiceInstance Removes a service instance from the Configuration Service registry.