Compartilhar via

  • Artigo

Set-CsArchivingConfiguration

 

Tópico modificado em: 2012-03-27

Modifica uma coleção existente de definições de arquivamento de mensagens instantâneas (IM).

Sintaxe

Set-CsArchivingConfiguration [-Identity <XdsIdentity>] [-ArchiveDuplicateMessages <$true | $false>] [-BlockOnArchiveFailure <$true | $false>] [-CachePurgingInterval <UInt32>] [-Confirm [<SwitchParameter>]] [-EnableArchiving <None | ImOnly | ImAndWebConf>] [-EnablePurging <$true | $false>] [-Force <SwitchParameter>] [-KeepArchivingDataForDays <UInt32>] [-PurgeExportedArchivesOnly <$true | $false>] [-PurgeHourOfDay <UInt32>] [-WhatIf [<SwitchParameter>]]

Set-CsArchivingConfiguration [-ArchiveDuplicateMessages <$true | $false>] [-BlockOnArchiveFailure <$true | $false>] [-CachePurgingInterval <UInt32>] [-Confirm [<SwitchParameter>]] [-EnableArchiving <None | ImOnly | ImAndWebConf>] [-EnablePurging <$true | $false>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-KeepArchivingDataForDays <UInt32>] [-PurgeExportedArchivesOnly <$true | $false>] [-PurgeHourOfDay <UInt32>] [-WhatIf [<SwitchParameter>]]

Descrição Detalhada

Muitas organizações consideram útil manter uma transcrição de todas as sessões de mensagens instantâneas e conferências de que os usuários participam. Para outras organizações, é obrigatório manter essas transcrições. Por exemplo: a lei exige que muitas organizações no mundo financeiro mantenham cópias de todas as suas comunicações eletrônicas.

Para arquivar as mensagens instantâneas, será necessário definir pelo menos um Servidor de Arquivamento. Depois que o Servidor de Arquivamento estiver definido, será necessário realizar duas etapas adicionais. Primeiramente, será necessário habilitar o arquivamento no escopo global (para obter mais detalhes, consulte o tópico Set-CsArchivingConfiguration). Como opção, também é possível configurar as definições de arquivamento personalizado em diferentes sites.

Segundo, será necessário usar políticas de arquivamento para indicar quais usuários terão suas sessões de IM arquivadas. As sessões de IMs não serão arquivadas, a menos que exista uma política em vigor que exija que as sessões de IMs sejam arquivadas.

Ao se instalar o Lync Server 2010, será criada uma coleção de definições de configuração de arquivamento global. Por padrão, essas definições se aplicarão a toda a organização. Como alternativa, é possível usar o cmdlet New-CsArchivingConfiguration para criar definições de configuração personalizada com base nos sites específicos. De qualquer forma, é possível utilizar o cmdlet Set-CsArchivingConfiguration para modificar os valores de propriedade de uma coleção ou definições de configuração de arquivamento existentes.

Quem pode executar esse cmdlet: Por padrão, membros dos seguintes grupos são autorizados a executar o cmdlet Set-CsArchivingConfiguration localmente: RTCUniversalServerAdmins. Para retornar uma lista de todas as funções de controle de acesso baseado em função (RBAC) às quais este cmdlet tiver sido atribuído (inclusive qualquer função RBAC personalizada que tiver sido criada por você), execute o seguinte comando no prompt do Windows PowerShell:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsArchivingConfiguration"}

Parâmetros

Parâmetro Obrigatório Digite Descrição

Identity

Opcional

Identidade de Xds

Representa o identificador exclusivo da coleção de definições de configuração de arquivamento a ser modificada. Para modificar as definições globais, deixe esse parâmetro em branco ou use a seguinte sintaxe: -Identity global. Para modificar as definições no escopo de site, utilize o prefixo "site:", seguido do nome do site. Por exemplo: -Identity "site:Redmond".

Instance

Opcional

Objeto ArchivingSettings

Permite passar uma referência a um objeto para o cmdlet, em vez de definir valores de parâmetros individuais.

ArchiveDuplicateMessages

Opcional

Booleano

Especifica como se devem arquivar as mensagens instantâneas "entre pools". Considere um exemplo simples: Ken Myer (com uma conta no Pool 1) envia uma mensagem instantânea para Pilar Ackerman (que possui uma conta no Pool 2). Pilar, por sua vez, envia uma resposta à mensagem instantânea de Ken. Se ArchiveDuplicateMessages for definido como False, então (com base em um algoritmo incorporado) a transcrição da sessão será registrada no Pool 1 ou no Pool 2, mas não em ambos. Se ArchiveDuplicateMessages for definido como True (o valor padrão), a transcrição será registrada nos dois pools.

BlockOnArchiveFailure

Opcional

Booleano

Se estiver definido como True, o serviço de IM será suspenso sempre que as mensagens instantâneas não puderem ser arquivadas. Se estiver definido como False (o valor padrão), o serviço de IM continuará, mesmo se as mensagens instantâneas não puderem ser arquivadas.

CachePurgingInterval

Opcional

Inteiro

Indica a frequência (em horas) com que o sistema será limpo das transcrições nas quais nenhum dos participantes tiver sido habilitado para arquivamento. Por padrão, todas as sessões de IM em grupo e sessões de conferência são registradas à medida que ocorrerem. No intervalo especificado, o sistema determinará se qualquer um dos participantes nessas sessões tiver sido habilitado para arquivamento. Se o sistema encontrar uma sessão em que nenhum dos participantes tiver sido habilitado para arquivamento, essa transcrição será excluída do banco de dados.

A propriedade CachePurgeInterval pode ser definida como qualquer número inteiro entre 4 e 168, inclusive. O valor padrão é 24.

EnableArchiving

Opcional

Cadeia de caracteres

Indica quais termos (se houver) serão salvos no banco de dados de arquivamento. Os valores válidos são:

None. Nenhum item será arquivado no banco de dados. Esse é o valor padrão.

ImOnly. Nenhuma sessão de IM será arquivada no banco de dados.

ImAndWebConf. As sessões de conferência de IM e de webconferência serão arquivadas no banco de dados.

EnablePurging

Opcional

Booleano

Se estiver definido como True, as mensagens instantâneas arquivadas serão removidas periodicamente do banco de dados, contanto que essas mensagens instantâneas: 1) sejam mais antigas do que o valor especificado na propriedade KeepArchivingDataForDays ou 2) tiverem sido exportadas e marcadas para exclusão.

Se estiver definido como False, as mensagens instantâneas não serão excluídas automaticamente do banco de dados.

KeepArchivingDataForDays

Opcional

Inteiro

Número de dias (entre 1 e 2562) durante os quais as mensagens instantâneas arquivadas serão mantidas no banco de dados antes de serem excluídas automaticamente. O valor padrão é 14.

Essa propriedade terá efeito apenas se EnablePurging tiver sido definido como True.

PurgeExportedArchivesOnly

Opcional

Booleano

Se estiver definida como True, o sistema limpará apenas as mensagens instantâneas que tiverem sido exportadas (e, consequentemente, marcadas para exclusão). As mensagens instantâneas que não tiverem sido exportadas permanecerão no banco de dados, mesmo se elas forem mais antigas do que o valor especificado pela propriedade KeepArchivingDataForDays.

PurgeHourOfDay

Opcional

Inteiro

Indica a hora local do dia em que os registros expirados serão excluídos do banco de dados de arquivamento. O horário é especificado utilizando-se um relógio de 24 horas, onde 0 representa a meia-noite (00:00) e 23 representa 23 horas. Observe que é possível especificar apenas a hora do dia. Isso significa que você pode programar a ocorrência da limpeza às 4:00, mas não pode programar para ocorrer, por exemplo às 4:30 ou 4:15. O valor padrão é 2 (2:00).

A limpeza do banco de dados ocorrerá apenas se a propriedade EnablePurging estiver definida como True.

Force

Opcional

Parâmetro de opção

Suprime a exibição de qualquer mensagem de erro não-fatal que possa surgir durante a execução do comando.

WhatIf

Opcional

Parâmetro de opção

Descreve o que aconteceria se o comando fosse executado sem ser executado de fato.

Confirm

Opcional

Parâmetro de opção

Solicita confirmação antes da execução do comando.

Tipos de Entrada

Objeto Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings. Set-CsArchivingConfiguration aceita entradas canalizadas de objetos de configuração de arquivamento.

Tipos de Retorno

Set-CsArchivingConfiguration não retorna um valor ou objeto. Em vez disso, o cmdlet configura instâncias do objeto Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings.

Exemplo

-------------------------- Exemplo 1 --------------------------

Set-CsArchivingConfiguration -Identity site:Redmond -ArchiveDuplicateMessages $False -KeepArchivingDataForDays 30

No exemplo anterior, Set-CsArchivingConfiguration é utilizado para modificar duas propriedades das definições de configuração de arquivamento que possuem a Identidade site:Redmond. Primeiramente, o comando define a propriedade ArchiveDuplicateMessages como False; isso evita que o sevidor arquive a mesma sessão de mensagens instantâneas diversas vezes. O comando também utiliza o parâmetro KeepArchivingDataForDays, para instruir o servidor a manter as mensagens instantâneas por 30 dias.

-------------------------- Exemplo 2 --------------------------

Get-CsArchivingConfiguration -Filter "site:*" | Set-CsArchivingConfiguration -ArchiveDuplicateMessages $False -KeepArchivingDataForDays 30

O Exemplo 2 é uma variação do comando exibido no Exemplo 1: No entanto, nesse caso, os valores das propriedades ArchiveDuplicateMessages e KeepArchivingDataForDays serão modificados em todas as definições de arquivamento que tiverem sido configuradas no escopo do site. Para realizar essa tarefa, o comando utiliza inicialmente Get-CsArchivingConfiguration e o parâmetro Filter, para retornar uma coleção de todas as definições de arquivamento configuradas no escopo de site. O valor de filtro "site:*" garante que apenas as definições cuja identidade for iniciada pelo valor da cadeia de caracteres "site:". serão retornadas. A coleção filtrada será então canalizada para Set-CsArchivingConfiguration, que modificará os dois valores de propriedade de cada item na coleção.

-------------------------- Exemplo 3 --------------------------

Get-CsArchivingConfiguration | Where-Object {$_.EnableArchiving -eq "ImAndWebConf"} | Set-CsArchivingConfiguration -EnableArchiving "ImOnly"

No Exemplo 3, serão modificadas todas as definições de configuração de arquivamento que permitem o arquivamento de sessões de IM e de webconferência. Depois que o comando for concluído, essas definições permitirão apenas o arquivamento de sessões de IM. Para fazer isso, o comando chama primeiramente Get-CsArchivingConfiguration sem quaisquer parâmetros, para retornar uma coleção de todas as definições de configuração de arquivamento em uso na organização. Esta coleção será canalizada para o cmdlet Where-Object, que selecionará apenas as definições cuja propriedade EnableArchiving for igual a (-eq) "ImAndWebConf". A coleção filtrada será então canalizada para Set-CsArchivingConfiguration, que tratará cada item na coleção e alterará o valor de EnableArchiving para "ImOnly".