Set-CsClientVersionPolicyRule
Tópico modificado em: 2012-03-26
Modifica uma ou mais regras de diretiva da versão do cliente atualmente configuradas para uso na sua organização.
Sintaxe
Set-CsClientVersionPolicyRule [-Identity <XdsIdentity>] [-Action <Allow | AllowAndUpgrade | AllowWithUrl | Block | BlockAndUpgrade | BlockWithUrl>] [-ActionUrl <String>] [-BuildNumber <Nullable>] [-CompareOp <EQL | NEQ | GTR | GEQ | LSS | LEQ>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Enabled <$true | $false>] [-Force <SwitchParameter>] [-MajorVersion <UInt16>] [-MinorVersion <Nullable>] [-Priority <Int32>] [-QfeNumber <Nullable>] [-UserAgent <String>] [-UserAgentFullName <String>] [-WhatIf [<SwitchParameter>]]
Set-CsClientVersionPolicyRule [-Action <Allow | AllowAndUpgrade | AllowWithUrl | Block | BlockAndUpgrade | BlockWithUrl>] [-ActionUrl <String>] [-BuildNumber <Nullable>] [-CompareOp <EQL | NEQ | GTR | GEQ | LSS | LEQ>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Enabled <$true | $false>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-MajorVersion <UInt16>] [-MinorVersion <Nullable>] [-Priority <Int32>] [-QfeNumber <Nullable>] [-UserAgent <String>] [-UserAgentFullName <String>] [-WhatIf [<SwitchParameter>]]
Descrição Detalhada
Regras da versão do cliente são usadas para determinar quais aplicativos cliente podem fazer logon no Microsoft Lync Server 2010. Quando um usuário tenta fazer logon no Lync Server 2010, seu aplicativo cliente envia um cabeçalho SIP ao servidor; este cabeçalho inclui informações detalhadas sobre o próprio aplicativo, incluindo a versão principal do software, versão secundária e número da versão. A informação da versão é então verificada contra a coleção de regras da versão do cliente para ver se alguma regra se aplica a este aplicativo em particular. Por exemplo, suponha que um usuário tente fazer logon usando o Microsoft Office Communicator 2007 R2. Para que o usuário possa fazer logon no Lync Server 2010, o sistema verificará se há uma regra de versão do cliente que se aplique ao Office Communicator 2007 R2. Se essa regra existir, o Lync Server 2010 realiza a ação especificada por ela. Esta medida precisa ser uma das seguintes:
Allow. Este usuário vai ser autorizado a conectar.
AllowAndUpgrade. O usuário vai ser autorizado a fazer logon, e sua cópia do Communicator 2007 R2 será atualizada automaticamente para a versão mais atual do Lync. As atualizações são realizadas usando-se o Microsoft Update ou o Windows Server Update Services, dependendo da configuração do sistema.
AllowWithUrl. O usuário vai ser autorizado a fazer logon, e uma mensagem será exibida direcionando o usuário a uma URL na qual a versão mais recente do Lync poderá ser baixada e instalada. A URL precisa apontar para um site que você mesmo tenha criado; esse site não é criado automaticamente durante a instalação do Lync Server.
Block. O usuário não vai ser autorizado a fazer logon.
BlockAndUpgrade. O usuário não vai ser autorizado a fazer logon, mas sua cópia do Communicator 2007 R2 será atualizada automaticamente para a versão mais recente do Lync. O usuário pode, então, tentar fazer logon usando um novo aplicativo cliente. As atualizações são realizadas usando-se o Microsoft Update ou o Windows Server Update Services, dependendo da configuração do sistema.
BlockWithUrl. O usuário não vai ser autorizado a fazer logon, mas uma mensagem será exibida direcionando-o a uma URL onde a versão mais recente do Lync poderá ser baixada e instalada. A URL precisa apontar para um site que você mesmo tenha criado; esse site não é criado automaticamente durante a instalação do Lync Server.
As regras de versão do cliente são coletadas nas diretivas de versão do cliente, e podem ser configuradas no escopo global, de site, de serviço (serviço Registrador) ou por usuário. O cmdlet Set-CsClientVersionPolicyRule oferece uma maneira de modificar as propriedades de uma regra de versão do cliente existente.
É importante observar que as diretivas de versão de cliente não se aplicam a usuários federados; os usuários federados estão presos às diretivas de versão de cliente usadas em suas próprias organizações. Por exemplo, suponha que um usuário federado utilize o cliente A, que é permitido pela organização federada. Desde que a organização federada permita o uso do cliente A, o usuário poderá se comunicar com sua organização usando esse cliente. Isso também vale mesmo que sua diretiva de versão de cliente bloqueie o uso do cliente A. As diretivas de versão de cliente aplicadas em sua organização não substituem as diretivas de versão de cliente usadas em uma organização federada.
Quem pode executar este cmdlet: Por padrão, membros dos seguintes grupos estão autorizados a executar o cmdlet Set-CsClientVersionPolicyRule 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 "Set-CsClientVersionPolicyRule"}
Parâmetros
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
Identity |
Obrigatório |
Xds Identity |
Identificador único para a diretiva da versão do cliente a ser modificada. A Identity da versão do cliente consiste do escopo em que a regra foi configurada mais um identificador global único (GUID). Isto significa que a regra vai ter uma Identity semelhante a esta: site:Redmond/1987d3c2-4544-489d-bbe3-59f79f530a83. |
Instance |
Opcional |
Objeto de Regra |
Permite passar uma referência a um objeto para o cmdlet, em vez de definir valores de parâmetros individuais. |
Action |
Opcional |
Modificador de Lista PS |
Ação a ser tomada sempre que a regra é disparada (isto é, sempre que alguém tentar fazer logon usando o software especificado). Valores válidos são: Allow. Este usuário vai ser autorizado a conectar. AllowWithUrl. O usuário vai ser autorizado a fazer logon, e uma mensagem será exibida direcionando-o a uma URL na qual a versão mais recente do Lync pode ser baixada e instalada. AllowAndUpgrade. O usuário vai ser autorizado a fazer logon, e sua cópia do Communicator será atualizada automaticamente para a versão mais recente do Lync. Block. O usuário não vai ser autorizado a fazer logon. BlockWithUrl. O usuário não vai ser autorizado a fazer logon, mas uma mensagem será exibida direcionando-o a uma URL onde a versão mais recente do Lync poderá ser baixada e instalada. BlockAndUpgrade. O usuário não vai ser autorizado a fazer logon, mas sua cópia do Communicator será atualizada automaticamente para a versão mais recente do Lync. O usuário pode, então, tentar fazer logon usando um novo aplicativo cliente. |
ActionUrl |
Opcional |
Cadeia de caracteres |
URL na qual os usuários podem baixar a versão mais recente do Lync. Esta propriedade é necessária se a propriedade Action estiver definida como BlockWithUrl ou AllowWithUrl. |
BuildNumber |
Opcional |
Inteiro |
Número da versão do software. Por exemplo, se sua cópia do Communicator for a versão 2.0.6362.111, então o BuildNumber é 6362. Os números de versão representam versões internas do software durante o processo de desenvolvimento, e ajudam a garantir que você esteja usando a versão de lançamento final, em vez de uma versão de pré-lançamento. |
CompareOp |
Opcional |
Modificador de Lista PS |
Operador de comparação usado para determinar se o software do cliente tentando conectar foi lançado antes, depois ou na mesma hora que a versão especificada na regra. Valores válidos são: EQL (igual a) NEQ (diferente de) GTR (maior do que) GEQ (maior ou igual a) LSS (menor do que) LEQ (menor ou igual a) |
Description |
Opcional |
Cadeia de caracteres |
Habilita administradores a fornecer informações adicionais sobre uma regra de versão do cliente. Por exemplo, a Description deve incluir informações sobre quem contatar se você achar que a regra deve ser modificada. |
Enabled |
Opcional |
Booleano |
Indica se a regra de versão do cliente deve ser usada. Se a propriedade Enabled for definida como False, então a regra vai ser ignorada sempre que um usuário tentar fazer logon com o software especificado. O valor padrão é True. |
MajorVersion |
Opcional |
Inteiro |
Versão principal do software. Por exemplo, se sua cópia do Communicator for a versão 2.0.6362.111, então MajorVersion será 2. Versões principais equivalem a versões primárias do software. |
MinorVersion |
Opcional |
Inteiro |
Versão secundária do software. Por exemplo, se sua cópia do Communicator for a versão 2.0.6362.111, então MinorVersion será 0. Versões secundárias equivalem a versões intermediárias do software. |
Priority |
Opcional |
Inteiro |
Prioridade relativa da regra. Regras são processadas em ordem de prioridade, com a regra de prioridade 0 sendo processada primeiro, a regra de prioridade 1 sendo processada em segundo lugar, e assim por diante. Se você atribuir uma prioridade já em uso, a nova regra vai usar esta prioridade e outras regras vão ser renumeradas de acordo. |
QfeNumber |
Opcional |
Inteiro |
Número de quick fix engineering do software. Por exemplo, se sua cópia do Communicator for a versão 2.0.6362.111, então o QfeNumber será 111. Números QFE representam atualizações planejadas para um aplicativo que são disponibilizadas após o lançamento oficial do software. |
UserAgent |
Opcional |
Cadeia de caracteres |
Designador usado para identificar o cliente do software. Por exemplo, OC é a designação de agente do usuário do Communicator. O cmdlet Get-CsClientVersionConfiguration oferece nomes amigáveis correspondentes para cada designação de agente de usuário. |
UserAgentFullName |
Opcional |
String |
Enables administrators to provide a friendly name for the user agent. For example, instead of relying on the user agent UCCP to identify the agent administrators might spell the name out in full: Microsoft Unified Communications Client. |
Force |
Opcional |
Parâmetro de opção |
Suprime a exibição de mensagens de erro não fatais que possam ocorrer na 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.Policy.ClientVersion.Rule. Set-CsClientVersionPolicyRule aceita instâncias em pipeline do objeto de regra de versão de cliente.
Tipos de Retorno
Nenhuma. Em vez disso, Set-CsClientVersionPolicyRule modifica instâncias do objeto Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.Rule.
Exemplo
-------------------------- Exemplo 1 ------------------------
Set-CsClientVersionPolicyRule -Identity site:Redmond/74ba9211-8610-42f9-91ba-846cdee98820 -Enabled $False
O comando mostrado no Exemplo 1 desabilita a regra de diretiva da versão do cliente que tem Identity site:Redmond/74ba9211-8610-42f9-91ba-846cdee98820. Para desabilitar a regra, o comando inclui o parâmetro Enabled e o valor de parâmetro $False.
-------------------------- Exemplo 2 ------------------------
Get-CsClientVersionPolicyRule -Filter "site:Redmond*" | Set-CsClientVersionPolicyRule -Description "Client policy rules for Redmond"
Exemplo 2 adiciona uma descrição genérica a todas as regras de diretiva de versão do cliente atribuídas ao site Redmond. Para fazer isso, o comando primeiro chama Get-CsClientVersionPolicyRule junto com o parâmetro Filter; o valor de filtro "site:Redmond*" limita os dados retornados às regras de diretiva atribuídas ao site Redmond. Esta coleção é então encaminhada ao cmdlet Set-CsClientVersionPolicyRule, que atribui a Description "Regras de diretiva de cliente para Redmond" para cada item nesta coleção.
-------------------------- Exemplo 3 ------------------------
Get-CsClientVersionPolicyRule | Where-Object {$_.UserAgent -eq "UCCP"} | Set-CsClientVersionPolicyRule -Action "Block"
O comando anterior bloqueia o uso de clientes UCCP (plataforma de cliente de comunicações unificadas) para qualquer regra de diretiva de versão de cliente que faça referência à UCCP como o agente do usuário. Para fazer isto, o comando primeiro chama Get-CsClientVersionPolicyRule para recuperar uma coleção de todas as regras de diretiva de cliente atualmente em uso. Essa coleção é então encaminhada para o cmdlet Where-Object, que seleciona somente as regras nas quais a propriedade UserAgent seja igual a (-eq) UCCP. Em seguida, esta coleção filtrada é encaminhada para o cmdlet Set-CsClientVersionPolicyRule, que pega cada item na coleção e define a propriedade Action como Block.
Consulte Também
Outros Recursos
Get-CsClientVersionPolicyRule
New-CsClientVersionPolicyRule
Set-CsClientVersionPolicyRule