HelpCache/Microsoft.KeyDistributionService.Cmdlets.dll-help.xml
|
<?xml version = "1.0" encoding = "utf-8" ?>
<helpItems schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Add-KdsRootKey</command:name><maml:description><maml:para>Generates a new root key for the Microsoft Group Key Distribution Service (KdsSvc) within Active Directory (AD).</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Add</command:verb><command:noun>KdsRootKey</command:noun><dev:version /></command:details><maml:description><maml:para>The Add-KdsRootKey cmdlet generates a new root key for the Microsoft Group Key Distribution Service (KdsSvc) within Active Directory (AD). The Microsoft Group KdsSvc generates new group keys from the new root key.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Add-KdsRootKey</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""><maml:name>EffectiveTime</maml:name><maml:description><maml:para>Specifies the date on which the newly generated root key takes effect. If this parameter is not specified, the default date set is 10 days after the current date.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>LocalTestOnly</maml:name><maml:description><maml:para>Indicates that the new root key is generated on the local host only. This parameter is used with the Set-KdsConfiguration cmdlet to test the local server configuration. If this parameter is specified, then the cmdlet returns a value that indicates whether the test passed. If this parameter is not specified, then the cmdlet returns the identifier (ID) of the root key when the operation succeeds. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Add-KdsRootKey</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>LocalTestOnly</maml:name><maml:description><maml:para>Indicates that the new root key is generated on the local host only. This parameter is used with the Set-KdsConfiguration cmdlet to test the local server configuration. If this parameter is specified, then the cmdlet returns a value that indicates whether the test passed. If this parameter is not specified, then the cmdlet returns the identifier (ID) of the root key when the operation succeeds. </maml:para></maml:description></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>EffectiveImmediately</maml:name><maml:description><maml:para>Indicates that the Microsoft Group Key Distribution Service immediately uses the new root key.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>EffectiveImmediately</maml:name><maml:description><maml:para>Indicates that the Microsoft Group Key Distribution Service immediately uses the new root key.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""><maml:name>EffectiveTime</maml:name><maml:description><maml:para>Specifies the date on which the newly generated root key takes effect. If this parameter is not specified, the default date set is 10 days after the current date.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue><dev:type><maml:name>DateTime</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>LocalTestOnly</maml:name><maml:description><maml:para>Indicates that the new root key is generated on the local host only. This parameter is used with the Set-KdsConfiguration cmdlet to test the local server configuration. If this parameter is specified, then the cmdlet returns a value that indicates whether the test passed. If this parameter is not specified, then the cmdlet returns the identifier (ID) of the root key when the operation succeeds. </maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>This cmdlet accepts no input objects.</maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>System.Boolean</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue><command:returnValue><dev:type><maml:name>System.Guid</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Generate a new root key</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Add-KdsRootKey </dev:code><dev:remarks><maml:para>This example generates a new root key for the Microsoft Group KdsSvc within AD.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 2: Generate a new root key for immediate use</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Add-KdsRootKey -EffectiveImmediately </dev:code><dev:remarks><maml:para>This example generates a new root key immediately and adds it to the Microsoft Group KdsSvc.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 3: Generate a new root key which takes effect on a specific date</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Add-KdsRootKey –EffectiveTime "03/06/2013" </dev:code><dev:remarks><maml:para>This example generates a new root key for the Microsoft Group KdsSvc which takes effect on the specified date 03/06/2013 using the mm/dd/yyyy format.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 4: Generate a new root key on the local host only</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Add-KdsRootKey –LocalTestOnly </dev:code><dev:remarks><maml:para>This example generates a new root key on the local host only.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287358</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Clear-KdsCache</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-KdsConfiguration</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-KdsRootKey</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Set-KdsConfiguration</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Test-KdsRootKey</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Clear-KdsCache</command:name><maml:description><maml:para>Clears the group key cache of the local computer.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Clear</command:verb><command:noun>KdsCache</command:noun><dev:version /></command:details><maml:description><maml:para>The Clear-KdsCache cmdlet clears the group key cache of the local computer.</maml:para><maml:para>The local computer can be either a domain controller running the Microsoft Group Key Distribution Service (KdsSvc) or a client of the Microsoft Group KdsSvc.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Clear-KdsCache</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CacheOwnerSid</maml:name><maml:description><maml:para>Specifies the security identifier (SID) for the user account whose cache this cmdlet clears.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CacheOwnerSid</maml:name><maml:description><maml:para>Specifies the security identifier (SID) for the user account whose cache this cmdlet clears.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>This cmdlet accepts no input objects.</maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>This cmdlet produces no output.</maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Clear the group key cache</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Clear-KdsCache </dev:code><dev:remarks><maml:para>This example clears the group key cache of the local computer.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 2: Clear the group key cache of a specific user</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Clear-KdsCache –CacheOwnerSid "s-1-1-0" </dev:code><dev:remarks><maml:para>This example clears the group key cache of the user with SID s-1-1-0.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287359</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Add-KdsRootKey</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-KdsConfiguration</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-KdsRootKey</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Set-KdsConfiguration</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Test-KdsRootKey</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Get-KdsConfiguration</command:name><maml:description><maml:para>Retrieves the current configuration of the Microsoft Group Key Distribution Service (KdsSvc) from Active Directory (AD).</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>KdsConfiguration</command:noun><dev:version /></command:details><maml:description><maml:para>The Get-KdsConfiguration cmdlet retrieves the current configuration of the Microsoft Group Key Distribution Service (KdsSvc) from Active Directory (AD). The KDS configuration defines how keys are generated from the root keys.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-KdsConfiguration</maml:name></command:syntaxItem></command:syntax><command:parameters></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>This cmdlet accepts no input objects.</maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.KeyDistributionService.KdsServerConfiguration</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>A KdsServerConfiguration object contains information such as the key derivation function (KDF) algorithm and secret agreement algorithm used in key generation.</maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Retrieve the current KDS configuration</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Get-KdsConfiguration </dev:code><dev:remarks><maml:para>This example retrieves the current configuration of the Microsoft Group KdsSvc from AD.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287360</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Add-KdsRootKey</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Clear-KdsCache</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-KdsRootKey</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Set-KdsConfiguration</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Test-KdsRootKey</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Get-KdsRootKey</command:name><maml:description><maml:para>Retrieves a list of root key values stored by the Microsoft Group Key Distribution Service (KdsSvc).</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>KdsRootKey</command:noun><dev:version /></command:details><maml:description><maml:para>The Get-KdsRootKey cmdlet retrieves the following information from Active Directory (AD) for each root key: -- The root key identifier -- The root key value -- The Microsoft Group Key Distribution Service (KdsSvc). </maml:para><maml:para>This information is required to generate the group keys distributed by the Microsoft Group KdsSvc.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-KdsRootKey</maml:name></command:syntaxItem></command:syntax><command:parameters></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>This cmdlet accepts no input objects.</maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>System.Collections.Generic.List`1<KdsRootKey^></maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>A list of master root keys stored in AD.</maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Retrieve a list of root key values</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Get-KdsRootKey </dev:code><dev:remarks><maml:para>This example retrieves a list of root key values stored in AD.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287361</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Add-KdsRootKey</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Clear-KdsCache</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-KdsConfiguration</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Set-KdsConfiguration</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Test-KdsRootKey</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Set-KdsConfiguration</command:name><maml:description><maml:para>Sets the configuration of Microsoft Group Key Distribution Service (KdsSvc).</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Set</command:verb><command:noun>KdsConfiguration</command:noun><dev:version /></command:details><maml:description><maml:para>The Set-KdsConfiguration cmdlet sets the configuration of Microsoft Group Key Distribution Service (KdsSvc). This cmdlet sets the following configuration data: -- The key derivation function algorithm and parameters used to generate private group keys -- The secret agreement algorithm and parameters used to generate public group keys. </maml:para><maml:para>This cmdlet also validates input by performing key derivation function tests and secret agreement tests.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Set-KdsConfiguration</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""><maml:name>InputObject</maml:name><maml:description><maml:para>Specifies the server configuration object that contains the configuration information of the Microsoft Group KdsSvc.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">KdsServerConfiguration</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>LocalTestOnly</maml:name><maml:description><maml:para>Indicates that the cmdlet only validates the new group key distribution service configuration on the local computer, and does not store the key in Active Directory (AD). If this parameter is specified, then the cmdlet returns a value that indicates whether the test passed. If this parameter is not specified, then the cmdlet returns the new server configuration object. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Set-KdsConfiguration</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>KdfAlgorithm</maml:name><maml:description><maml:para>Specifies the name of the key derivation function algorithm that the key distribution server uses to generate the keys.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>KdfParameters</maml:name><maml:description><maml:para>Specifies the parameters for the key derivation function used to generate the group private key. If this parameter is not specified or this parameter is set to $null, then no key derivation function parameters are needed.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">Byte[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>LocalTestOnly</maml:name><maml:description><maml:para>Indicates that the cmdlet only validates the new group key distribution service configuration on the local computer, and does not store the key in Active Directory (AD). If this parameter is specified, then the cmdlet returns a value that indicates whether the test passed. If this parameter is not specified, then the cmdlet returns the new server configuration object. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>SecretAgreementAlgorithm</maml:name><maml:description><maml:para>Specifies the name of the secret agreement algorithm used to generate a group public key.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>SecretAgreementParameters</maml:name><maml:description><maml:para>Specifies the parameters for the secret agreement algorithm. If this parameter is not specified or this parameter is set to $null, then no secret agreement algorithm parameters are needed.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">Byte[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>SecretAgreementPrivateKeyLength</maml:name><maml:description><maml:para>Specifies the length of the private key used in the secret agreement algorithm.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>SecretAgreementPublicKeyLength</maml:name><maml:description><maml:para>Specifies the length of the public key used in the secret agreement algorithm.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Set-KdsConfiguration</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>LocalTestOnly</maml:name><maml:description><maml:para>Indicates that the cmdlet only validates the new group key distribution service configuration on the local computer, and does not store the key in Active Directory (AD). If this parameter is specified, then the cmdlet returns a value that indicates whether the test passed. If this parameter is not specified, then the cmdlet returns the new server configuration object. </maml:para></maml:description></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RevertToDefault</maml:name><maml:description><maml:para>Indicates that the customized service configuration is reverted to the default configuration.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""><maml:name>InputObject</maml:name><maml:description><maml:para>Specifies the server configuration object that contains the configuration information of the Microsoft Group KdsSvc.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">KdsServerConfiguration</command:parameterValue><dev:type><maml:name>KdsServerConfiguration</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>KdfAlgorithm</maml:name><maml:description><maml:para>Specifies the name of the key derivation function algorithm that the key distribution server uses to generate the keys.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>KdfParameters</maml:name><maml:description><maml:para>Specifies the parameters for the key derivation function used to generate the group private key. If this parameter is not specified or this parameter is set to $null, then no key derivation function parameters are needed.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">Byte[]</command:parameterValue><dev:type><maml:name>Byte[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>LocalTestOnly</maml:name><maml:description><maml:para>Indicates that the cmdlet only validates the new group key distribution service configuration on the local computer, and does not store the key in Active Directory (AD). If this parameter is specified, then the cmdlet returns a value that indicates whether the test passed. If this parameter is not specified, then the cmdlet returns the new server configuration object. </maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RevertToDefault</maml:name><maml:description><maml:para>Indicates that the customized service configuration is reverted to the default configuration.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>FALSE</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>SecretAgreementAlgorithm</maml:name><maml:description><maml:para>Specifies the name of the secret agreement algorithm used to generate a group public key.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>SecretAgreementParameters</maml:name><maml:description><maml:para>Specifies the parameters for the secret agreement algorithm. If this parameter is not specified or this parameter is set to $null, then no secret agreement algorithm parameters are needed.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">Byte[]</command:parameterValue><dev:type><maml:name>Byte[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>SecretAgreementPrivateKeyLength</maml:name><maml:description><maml:para>Specifies the length of the private key used in the secret agreement algorithm.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>SecretAgreementPublicKeyLength</maml:name><maml:description><maml:para>Specifies the length of the public key used in the secret agreement algorithm.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.KeyDistributionService.KdsServerConfiguration</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>The KdsServerConfiguration object contains configuration information for the Microsoft Group KdsSvc.</maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.KeyDistributionService.KdsServerConfiguration</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue><command:returnValue><dev:type><maml:name>System.Boolean</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Set the configuration of Microsoft Group Key Distribution Service</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> $config = Get-KdsConfiguration PS C:\> Set-KdsConfiguration –InputObject $config </dev:code><dev:remarks><maml:para>This example retrieves a server configuration object in to a variable $config using the Get-KdsConfiguration cmdlet, and passes the contents of the variable to this cmdlet.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 2: Test the configuration on the local server</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Set-KdsConfiguration -LocalTestOnly </dev:code><dev:remarks><maml:para>This example tests the local server configuration.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 3: Set the key derivation function algorithm</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Set-KdsConfiguration –KdfAlgorithm "SHA-1" </dev:code><dev:remarks><maml:para>This example sets the key derivation function (KDF) algorithm name to SHA-1. This algorithm generates a private group key.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 4: Set the secret agreement algorithm</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Set-KdsConfiguration –SecretAgreementAlgorithm "ECDH" </dev:code><dev:remarks><maml:para>This example sets the secret agreement algorithm name to ECDH. This algorithm generates a public group key.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 5: Set the Group Key Distribution Service configuration to the default configuration</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Set-KdsConfiguration -RevertToDefault </dev:code><dev:remarks><maml:para>This example validates that the customized group key distribution service configurations are deleted and the SID key starts to use the default configuration.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287362</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Add-KdsRootKey</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Clear-KdsCache</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-KdsConfiguration</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-KdsRootKey</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Test-KdsRootKey</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Test-KdsRootKey</command:name><maml:description><maml:para>Tests the root key configuration.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Test</command:verb><command:noun>KdsRootKey</command:noun><dev:version /></command:details><maml:description><maml:para>The Test-KdsRootKey cmdlet tests that the root key with the specified key identifier (ID) uses a valid configuration. The test verifies generation of both new group public key and group private key.</maml:para><maml:para>This cmdlet is useful for analyzing failures based on invalid root key configuration failures.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Test-KdsRootKey</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""><maml:name>KeyId</maml:name><maml:description><maml:para>Specifies the ID of the root key to test.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""><maml:name>KeyId</maml:name><maml:description><maml:para>Specifies the ID of the root key to test.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>This cmdlet accepts no input objects.</maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>System.Boolean</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>The Boolean object that indicates that the root key can be used to generate derived keys.</maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Test the root key configuration</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Test-KdsRootKey –KeyId "4A3615F1-5A90-22E4-0B1D-1416F93D4412" </dev:code><dev:remarks><maml:para>This example tests the configuration of the root key specified by key ID.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287363</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Add-KdsRootKey</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Clear-KdsCache</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-KdsConfiguration</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Set-KdsConfiguration</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Add-KdsRootKey</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> </helpItems> |