Set-CsAddressBookConfiguration
Tópico modificado em: 2012-03-25
Modifica uma coleção existente de definições de configuração do Catálogo de endereços.
Sintaxe
Set-CsAddressBookConfiguration [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-EnableFileGeneration <$true | $false>] [-Force <SwitchParameter>] [-IgnoreGenericRules <$true | $false>] [-KeepDuration <UInt32>] [-MaxDeltaFileSizePercentage <UInt32>] [-RunTimeOfDay <DateTime>] [-SynchronizePollingInterval <TimeSpan>] [-UseNormalizationRules <$true | $false>] [-WhatIf [<SwitchParameter>]]
Set-CsAddressBookConfiguration [-Confirm [<SwitchParameter>]] [-EnableFileGeneration <$true | $false>] [-Force <SwitchParameter>] [-IgnoreGenericRules <$true | $false>] [-Instance <PSObject>] [-KeepDuration <UInt32>] [-MaxDeltaFileSizePercentage <UInt32>] [-RunTimeOfDay <DateTime>] [-SynchronizePollingInterval <TimeSpan>] [-UseNormalizationRules <$true | $false>] [-WhatIf [<SwitchParameter>]]
Descrição Detalhada
Os servidores do Catálogo de endereços são intermediários entre o AD DS e o Microsoft Lync Server 2010. O servidor de Catálogos de endereços garante que as informações de usuários armazenadas no Lync Server 2010 estejam sincronizadas com as informações de usuários armazenadas no AD DS. Isso é feito sincronizando-se periodicamente os arquivos do Catálogo de endereços com as informações armazenadas no Banco de dados de usuários.
Além disso, os servidores do Catálogo de endereços periodicamente geram arquivos de índice que são baixados para computadores executando o Lync 2010. Quando um usuário procura contatos, ele pesquisa por esses arquivos de índice ou pesquisa nos arquivos de índice do Catálogo de endereços armazenados no Repositório de Gerenciamento Central.
Os servidores do Catálogo de endereços são governados usando-se as definições de configuração do Catálogo de endereços; essas definições determinam ações como a frequência com que os arquivos do Catálogo de endereços são sincronizados com o banco de dados de usuários e a frequência com que são gerados os arquivos de índice do Catálogo de endereços. Ao se instalar o Lync Server, cria-se um conjunto de definições globais de catálogos de endereços. Também é possível criar definições de configuração personalizadas, que podem ser aplicadas a sites específicos. Essas definições, se existirem, se aplicarão a quaisquer servidores de catálogos de endereços que estiverem em vigor no site e sempre têm precedência sobre as definições globais.
O cmdlet Set-CsAddressBookConfiguration permite modificar qualquer coleção de definições de configuração do Catálogo de endereços em uso pela organização.
Quem pode executar esse cmdlet: Por padrão, membros dos seguintes grupos são autorizados a executar o cmdlet Set-CsAddressBookConfiguration localmente: RTCUniversalServerAdmins. Para retornar uma lista de todas as funções do controle de acesso baseado em função (RBAC) que receberam a atribuição desse cmdlet (incluindo qualquer função RBAC personalizada criada por você), execute o seguinte comando do prompt Windows PowerShell:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsAddressBookConfiguration"}
Parâmetros
Parâmetro | Obrigatório | Digite | Descrição |
---|---|---|---|
Identity |
Opcional |
XdsIdentity |
Identificador exclusivo atribuído à coleção de definições de Catálogo de endereços. Para fazer referência às definições globais, use esta sintaxe: -Identity global. Para fazer referência a uma coleção configurada no escopo do site, use uma sintaxe semelhante a esta: -Identity site:Redmond. Não é possível utilizar caracteres curinga ao se especificar uma identidade. Se esse parâmetro for omitido, Set-CsAddressBookConfiguration modificará as definições globais. |
Instance |
Obrigatório |
objeto AddressBookSettings |
Permite passar uma referência a um objeto para o cmdlet, em vez de definir valores de parâmetros individuais. |
EnableFileGeneration |
Opcional |
Parâmetro de opção |
Quando definido como True (o valor padrão), o servidor do Catálogo de Endereços gerará arquivos de índice do Catálogos de Endereços que podem ser baixados pelos clientes. Quando definido como False, esses arquivos de índice não são gerados. Isso significa que os aplicativos cliente terão de usar o Serviço de Consulta à Web do Catálogo de Endereços ao buscar contatos. |
IgnoreGenericRules |
Opcional |
Booleano |
Indica se o servidor do Catálogo de endereços vai ignorar ou não as regras de normalização genérica usadas ao se analisar números telefônicos. As regras genéricas são criadas no Lync Server 2010. Essas regras não podem ser alteradas. No entanto, definindo-se o valor dessa propriedade como True, é possível instruir os servidores do Catálogo de endereços a ignorar essas regras e a usar as regras personalizadas que você tiver criado. O valor padrão é False. |
KeepDuration |
Opcional |
TimeSpan |
Especifica o período de tempo (em dias) durante o qual os servidores do Catálogo de Endereços manterão os arquivos de alteração. Os arquivos de alteração mais antigos que o valor da propriedade KeepDuration serão excluídos. KeepDuration pode ser definido como qualquer número inteiro entre 1 e 90, inclusive. O valor padrão é 30 dias. |
MaxDeltaFileSizePercentage |
Opcional |
Inteiro |
As alterações feitas ao Active Directory (como habilitar um novo usuário para o Lync Server), são normalmente registradas pelo servidor do Catálogo de Endereços em um "arquivo delta", um arquivo que consiste apenas nas informações atualizadas. O Lync 2010 pode então baixar os arquivos delta, em vez de um arquivo completo do Catálogo de Endereços. A propriedade MaxDeltaFileSizePercentage determina o tamanho máximo que os arquivos delta podem atingir antes de serem incorporados ao arquivo completo do Catálogo de Endereços. Por padrão, os arquivos delta podem ter 20% do tamanho do arquivo completo do Catálogo de Endereços, antes que um novo arquivo do Catálogo de Endereços seja gerado. Nesse momento, os clientes do Lync baixarão o arquivo completo, em vez do arquivo delta. MaxDeltaFileSizePercentage deve ser inserido como um valor percentual entre 1 e 100. |
RunTimeOfDay |
Opcional |
DataHora |
Indica a hora do dia em que os servidores geram arquivos do Catálogo de Endereços. A propriedade RunTimeOfDay tem como base um relógio de 24 horas (horas:minutos:segundos), onde 00:00:00 representa meia-noite e 23:59:00 representa 11:59 PM. O valor padrão é 01:30:00 (1:30: AM). |
SynchronizePollingInterval |
Opcional |
TimeSpan |
Indica a frequência com que os servidores do Catálogo de endereços sincronizam as suas informações com as informações armazenadas no Banco de dados de usuários. SynchronizePollingInterval pode ser definido com qualquer valor entre 5 segundos (00:00:05) e 3 horas (03:00:00). O valor padrão é 5 minutos (00:05:00). |
UseNormalizationRules |
Opcional |
Booleano |
Indica se os servidores do Catálogo de Endereços devem usar as regras de normalização do telefone ao recuperar números de telefone. Se o valor for definido como False, os números de telefone serão recuperados como estão e o aplicativo cliente será responsável pela aplicação das regras de normalização ao exibir esses números. O valor padrão é True. |
Force |
Opcional |
Parâmetro de opção |
Suprime a exibição de qualquer mensagem de erro não-fatal que possa ocorrer 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.AddressBook.AddressBookSettings. Set-CsAddressBookConfiguration aceita a entrada canalizada de objetos de configuração do Catálogo de endereços.
Tipos de Retorno
Set-CsAddressBookConfiguration não retorna um valor ou objeto. Em vez disso, o cmdlet configura instâncias do objeto Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings.
Exemplo
-------------------------- Exemplo 1 --------------------------
Set-CsAddressBookConfiguration -identity site:Redmond -RunTimeOfDay 23:00
Esse exemplo define a propriedade RunTimeOfDay (que determina a hora do dia em que se realiza a sincronização do Catálogo de endereços) como sendo 23:00 (11:00 PM, em um relógio de 24 horas). O parâmetro Identity é usado para limitar a alteração às definições de configuração do Catálogo de endereços cuja identidade for site:Redmond.
-------------------------- Exemplo 2 --------------------------
Get-CsAddressBookConfiguration -Filter site:* | Set-CsAddressBookConfiguration -RunTimeOfDay 23:00
No Exemplo 2, define-se como sendo 11:00 PM (23:00) a propriedade RunTimeOfDay de todas as coleções de definições do Catálogo de Endereços configuradas no escopo do site. Para realizar isso, o comando primeiramente usa Get-CsAddressBookConfiguration e o parâmetro Filtro, para retornar uma coleção de todas as definições específicas ao site; o valor de filtro "site:*" limita os dados retornados a coleções configuradas no escopo do site. Essas informações serão então canalizadas para Set-CsAddressBookConfiguration, que modificará o valor da propriedade RunTimeOfDay de cada item na coleção.
-------------------------- Exemplo 3 --------------------------
Get-CsAddressBookConfiguration | Where-Object {$_.KeepDuration -lt 30} | Set-CsAddressBookConfiguration -KeepDuration 30
O comando precedente modifica a propriedade KeepDuration para qualquer coleção de definições do Catálogo de Endereços em que KeepDuration for menor que 30 dias. Para realizar essa tarefa, utiliza-se Get-CsAddressBookConfiguration, sem nenhum parâmetro adicional, para retornar uma coleção de todas as definições do Catálogo de Endereços configuradas para uso na organização. Essa coleção será então canalizada para o cmdlet Where-Object, que selecionará apenas as definições cuja propriedade KeepDuration for menor do que 30 dias. Essa coleção filtrada é então canalizada para Set-CsAddressBookConfiguration, que modifica para 30 dias o valor da propriedade KeepDuration de cada item na coleção.
Consulte Também
Outros Recursos
Get-CsAddressBookConfiguration
New-CsAddressBookConfiguration
Remove-CsAddressBookConfiguration