Add-KdsRootKey

Windows Server 2012 R2 and Windows 8.1

Add-KdsRootKey

Generates a new root key for the Microsoft Group Key Distribution Service (KdsSvc) within Active Directory (AD).

Sintaxis

Parameter Set: EffectiveTime
Add-KdsRootKey [[-EffectiveTime] <DateTime> ] [-LocalTestOnly] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: EffectiveImmediately
Add-KdsRootKey -EffectiveImmediately [-LocalTestOnly] [-Confirm] [-WhatIf] [ <CommonParameters>]




Descripción detallada

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.

Parámetros

-EffectiveImmediately

Indicates that the Microsoft Group Key Distribution Service immediately uses the new root key.


Alias

ninguno

¿Requerido?

true

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

false

¿Aceptar caracteres comodín?

false

-EffectiveTime<DateTime>

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.


Alias

ninguno

¿Requerido?

false

¿Posición?

1

Valor predeterminado

ninguno

¿Aceptar canalización?

True (ByValue)

¿Aceptar caracteres comodín?

false

-LocalTestOnly

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.


Alias

ninguno

¿Requerido?

false

¿Posición?

named

Valor predeterminado

ninguno

¿Aceptar canalización?

false

¿Aceptar caracteres comodín?

false

-Confirm

Solicita confirmación antes de ejecutar el cmdlet.


¿Requerido?

false

¿Posición?

named

Valor predeterminado

falso

¿Aceptar canalización?

false

¿Aceptar caracteres comodín?

false

-WhatIf

Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.


¿Requerido?

false

¿Posición?

named

Valor predeterminado

falso

¿Aceptar canalización?

false

¿Aceptar caracteres comodín?

false

<CommonParameters>

Este cmdlet admite los siguientes parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, consulte about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).

Entradas

El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet.

  • None

    This cmdlet accepts no input objects.


Salidas

El tipo de resultado es el tipo de objetos que emite el cmdlet.

  • System.Boolean
  • System.Guid

Ejemplos

Example 1: Generate a new root key

This example generates a new root key for the Microsoft Group KdsSvc within AD.


PS C:\> Add-KdsRootKey

Example 2: Generate a new root key for immediate use

This example generates a new root key immediately and adds it to the Microsoft Group KdsSvc.


PS C:\> Add-KdsRootKey -EffectiveImmediately

Example 3: Generate a new root key which takes effect on a specific date

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.


PS C:\> Add-KdsRootKey –EffectiveTime "03/06/2013"

Example 4: Generate a new root key on the local host only

This example generates a new root key on the local host only.


PS C:\> Add-KdsRootKey –LocalTestOnly

Temas relacionados

Mostrar: