• Artigo

New-CsArchivingConfiguration

 

Tópico modificado em: 2012-03-23

Cria um novo conjunto de configurações de arquivamento do sistema de mensagens instantâneas (IM, instant messaging). Essas configurações podem ser usadas para habilitar ou desabilitar a gravação automática de sessões IM; essas configurações também permitem bloquear todas as mensagens instantâneas que não puderem ser arquivadas.

Sintaxe

New-CsArchivingConfiguration -Identity <XdsIdentity> [-ArchiveDuplicateMessages <$true | $false>] [-BlockOnArchiveFailure <$true | $false>] [-CachePurgingInterval <UInt32>] [-Confirm [<SwitchParameter>]] [-EnableArchiving <None | ImOnly | ImAndWebConf>] [-EnablePurging <$true | $false>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-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 IM realizadas pelos usuários. Para outras organizações, é obrigatório manter essas transcrições; por exemplo, muitas organizações do mundo financeiro são obrigadas por lei a manter cópias de todas as comunicações eletrônicas.

O Microsoft Lync Server 2010 oferece flexibilidade no arquivamento de sessões de conferência IM e da Web. Se tiver implantado o Servidor de Arquivamento, você poderá usar os vários cmdlets CsArchivingConfiguration para habilitar e desabilitar o arquivamento da sessão IM e gerenciar o banco de dados de arquivamento. Também é possível suspender o IM em caso de falha do arquivamento, o que ajuda a garantir que você mantenha um registro de todas as suas comunicações eletrônicas.

Quando você instala o Lync Server 2010, uma coleção das configurações de arquivamento globais será criada; por padrão, essas configurações serão aplicadas a toda a organização. Também é possível usar o cmdlet New-CsArchivingConfiguration para criar definições de configuração personalizadas site a site.

Quem pode executar este cmdlet: Por padrão, membros dos seguintes grupos estão autorizados a executar o cmdlet New-CsArchivingConfiguration localmente: RTCUniversalServerAdmins. Para retornar uma lista de todas as funções do RBAC (controle de acesso baseado na função) atribuídas a este cmdlet (incluindo eventuais funções personalizadas do RBAC que você mesmo tenha criado), execute o comando a seguir no prompt do Windows PowerShell:

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

Parâmetros

Parâmetro Obrigatório Tipo Descrição

Identity

Obrigatório

Xds Identity

Identificador exclusivo a ser atribuído à nova coleção das definições de configuração do arquivamento. Como só é possível criar novas coleções no escopo do site, a Identity sempre terá o prefixo "site:" seguido do nome do site; por exemplo, "site:Redmond".

ArchiveDuplicateMessages

Opcional

Booleano

Especifica como mensagens instantâneas em vários pools devem ser arquivadas. Por exemplo, Ken Myer (com uma conta no Pool 1) envia uma mensagem instantânea para Pilar Ackerman (que tem uma conta no Pool 2). Pilar, por sua vez, envia uma resposta para a mensagem instantânea de Ken. Se ArchiveDuplicateMessages estiver definido como False, a transcrição da sessão (com base em um algoritmo interno) será registrada no Pool 1 ou no Pool 2, mas não em ambos. Se ArchiveDuplicateMessages estiver definido como True (o valor padrão), a transcrição será registrada em ambos os pools.

BlockOnArchiveFailure

Opcional

Booleano

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

CachePurgingInterval

Opcional

Inteiro

Indica com que frequência (em horas) são limpas, do sistema, as transcrições em que nenhum dos participantes estava habilitado para arquivamento. Por design, todas as sessões IM em grupo e sessões de conferência são gravadas quando ocorrem. No intervalo especificado, o sistema determinará se algum dos participantes dessas sessões estava habilitado para arquivamento. Se o sistema encontrar uma sessão na qual nenhum dos participantes estava habilitado para arquivamento, a transcrição será excluída do banco de dados.

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

EnableArchiving

Opcional

Cadeia de caracteres

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

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

ImOnly. As sessões IM são arquivadas no banco de dados.

ImAndWebConf. As sessões de conferência IM e da Web são arquivadas no banco de dados.

EnablePurging

Opcional

Booleano

Se True, as mensagens instantâneas arquivadas serão removidas periodicamente do banco de dados, desde que essas mensagens instantâneas: 1) sejam anteriores ao valor especificado na propriedade KeepArchivingDataForDays ou 2) tenham sido exportadas e marcadas para exclusão.

Se 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 2.562) em que as mensagens instantâneas arquivadas são mantidas no banco de dados antes de serem excluídas automaticamente. O valor padrão é 14.

Essa propriedade só entrará em vigor se EnablePurging tiver sido definida como True.

PurgeExportedArchivesOnly

Opcional

Booleano

Se True, o sistema só limpará mensagens instantâneas exportadas (e, assim, marcadas para exclusão). As mensagens instantâneas não exportadas continuarão no banco de dados, mesmo que sejam anteriores ao valor especificado pela propriedade KeepArchivingDataForDays.

PurgeHourOfDay

Opcional

Inteiro

Indica a hora do dia quando os registros expirados são excluídos do banco de dados de arquivamento. A hora do dia é especificada usando-se um relógio de 24 horas, com 0 representando meia-noite (12:00 AM) e 23 representando 11:00 PM. Observe só ser possível especificar a hora do dia. Isso significa que você pode agendar a limpeza para ocorrer às 04h00, mas não pode agendá-la para ocorrer, por exemplo, 04h30 ou 04h15. O valor padrão é 2 (02:00 AM).

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

Force

Opcional

SwitchParameter

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

InMemory

Opcional

SwitchParameter

Cria uma referência de objeto, sem na verdade executar o objeto como uma alteração permanente. Se a saída deste cmdlet for atribuída, chamando-o com este parâmetro a uma variável, você poderá realizar alterações às propriedades da referência do objeto e executar estas alterações, chamando-se o cmdlet coincidente Set- deste cmdlet.

WhatIf

Opcional

SwitchParameter

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

Confirm

Opcional

SwitchParameter

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

Tipos de Entrada

Nenhuma. New-CsArchivingConfiguration não aceita entrada em pipeline.

Tipos de Retorno

New-CsArchivingConfiguration cria novas instâncias do objeto Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings.

Exemplo

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

New-CsArchivingConfiguration -Identity site:Redmond -EnableArchiving "ImOnly"

O comando mostrado no Exemplo 1 cria uma nova coleção de definições de configuração de arquivamento e aplica essas configurações ao site de Redmond. Adicionando o parâmetro EnableArchiving e configurando o valor do parâmetro como "ImOnly", o comando também habilita o arquivamento da sessão IM (mas não o arquivamento de conferência da Web) para o site Redmond.

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

$x = New-CsArchivingConfiguration -Identity site:Redmond -InMemory
$x.EnableArchiving = "ImOnly"
Set-CsArchivingConfiguration -Instance $x

O exemplo anterior demonstra o uso do parâmetro InMemory para criar uma coleção de definições de configuração de arquivamento que existe inicialmente apenas na memória. Para isso, o exemplo cria uma nova coleção de configurações (com a Identity site:Redmond) e armazena essa coleção em uma variável chamada $x. Observe que, depois do primeiro comando ser executado, a coleção só existirá na memória; se executar o comando Get-CsArchivingConfiguration, você não verá uma entrada para site:Redmond.

No segundo comando, a propriedade EnableArchiving dessa coleção virtual de configurações é definida como "ImOnly", o que habilita o arquivamento da sessão IM. Por fim, o último comando usa Set-CsArchivingConfiguration para transformar as configurações de arquivamento virtual em uma coleção de configurações reais aplicada ao site de Redmond. Se você não chamar Set-CsArchivingConfiguration, essas configurações continuarão apenas na memória e desaparecerão assim que sua sessão do Windows PowerShell for encerrada ou a variável $x for excluída.