Compartilhar via


Set-CsVoiceRoute

 

Tópico modificado em: 2012-03-25

Modifica uma rota de voz. As rotas de voz contêm instruções que informam ao Microsoft Lync Server 2010 como rotear chamadas de usuários do Enterprise Voice para números de telefone na PSTN (rede telefônica pública comutada) ou em uma PBX (Central Privada de Comutação).

Sintaxe

Set-CsVoiceRoute [-Identity <XdsGlobalRelativeIdentity>] [-AlternateCallerId <String>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Force <SwitchParameter>] [-NumberPattern <String>] [-Priority <Int32>] [-PstnGatewayList <PSListModifier>] [-PstnUsages <PSListModifier>] [-SuppressCallerId <Nullable>] [-WhatIf [<SwitchParameter>]]

Set-CsVoiceRoute [-AlternateCallerId <String>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-NumberPattern <String>] [-Priority <Int32>] [-PstnGatewayList <PSListModifier>] [-PstnUsages <PSListModifier>] [-SuppressCallerId <Nullable>] [-WhatIf [<SwitchParameter>]]

Descrição Detalhada

Use este cmdlet para modificar uma rota de voz existente. As rotas de voz são associadas a políticas de voz por meio de usos da PSTN. Uma rota de voz inclui uma expressão regular que identifica quais números de telefone serão roteados por uma determinada rota de voz: os números de telefone que combinam com a expressão regular serão roteados por esta rota.

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

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

Parâmetros

Parâmetro Obrigatório Digite Descrição

Identity

Opcional

XdsIdentity

A identidade exclusiva da rota de voz (se o nome da rota contiver um espaço, como Test Route, você deverá colocar a cadeia de caracteres completa entre parênteses).

Instance

Opcional

Rota

Permite passar uma referência a um objeto para o cmdlet, em vez de definir valores de parâmetros individuais. Este objeto deve ser do tipo Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route e pode ser recuperado chamando-se Get-CsVoiceRoute.

AlternateCallerId

Opcional

Cadeia de caracteres

Se o parâmetro SuppressCallerId for definido como Verdadeiro, o valor do parâmetro AlternateCallerId será exibido aos destinatários, e não ao número real do chamador. Este número deve ser um número válido e pode ser usado para representar uma divisão dentro de uma organização, como Suporte ou Recursos Humanos

Se o parâmetro SuppressCallerId for definido como Falso, o parâmetro AlternateCallerId será ignorado.

Os valores devem combinar com a expressão regular (\+)?[1-9]\d*(;ext=[1-9]\d*)?. Em outras palavras, o valor pode iniciar com um sinal de mais (+), mas não é necessário; deve consistir em qualquer número de dígitos; e pode ser seguido por uma extensão que inicia com ;ext= seguida por qualquer número de dígitos. (observe que se você incluir uma extensão, a cadeia de caracteres deverá ser colocada entre aspas duplas).

Description

Opcional

Cadeia de caracteres

Uma descrição para que serve esta rota de telefone.

NumberPattern

Opcional

Cadeia de caracteres

Uma expressão regular que especifica os números de telefone aos quais se aplica esta rota. Os números que combinam com este modelo serão roteados segundo o restante das configurações de roteamento. Por exemplo: o modelo de número padrão [0-9] {10} especifica um número de 10 dígitos que contém qualquer dígito de 0 a 9.

Priority

Opcional

Int32

Um número pode ser resolvido para diversas rotas de voz. A prioridade determina a ordem na qual serão aplicadas as rotas, se houver mais de uma rota possível.

PstnGatewayList

Opcional

PSListModifier

Um Servidor de Mediação pode ser associado com diversos gateways. Este parâmetro contém uma lista de gateways associados a essa rota de voz. Cada membro desta lista deve ser a Identidade do serviço do gateway PSTN ou Servidor de Mediação. O valor poderá fazer referência a um Servidor de Mediação apenas se a Servidor de Mediação estiver configurado para Microsoft Office Communications Server 2007 ou Microsoft Office Communications Server 2007 R2. No caso do Lync Server 2010, deve se utilizar um gateway PSTN. A Identidade do serviço é uma cadeia de caracteres no formato ServiceRole:FQDN, onde ServiceRole é o nome da função de serviço (PSTNGateway) e FQDN é o nome de domínio totalmente qualificado do pool ou o endereço IP do servidor. Por exemplo: PSTNGateway:redmondpool.litwareinc.com. As identidades de serviço podem ser recuperadas chamando-se o comando Get-CsService | Select-Object Identity.

Se você realizar alterações em uma rota de voz e deixar a lista PstnGatewayList vazia, ou se a alteração feita remover todos os itens na lista, você receberá uma mensagem de aviso informando que os usuários não poderão realizar chamadas PSTN.

PstnUsages

Opcional

Uma lista de usos de PSTN (como Local ou Interurbano) que podem ser aplicados a esta rota de voz. O uso de PSTN deve ser um uso existente. (os usos da PSTN podem ser recuperados chamando-se o cmdlet Get-CsPstnUsage.)

Se você realizar alterações em uma rota de voz e deixar a lista PstnUsages vazia, ou se a alteração feita remover todos os usos da PSTN constantes na lista, você receberá uma mensagem de aviso informando que os usuários não poderão realizar chamadas da PSTN.

SuppressCallerId

Opcional

Booleano

Determina se um ID de chamador será revelado em chamadas de saída. Se este parâmetro for definido como True, o ID do chamador será suprimido. No lugar do ID real, o valor do AlternateCallerId será exibido. Quando SuppressCallerId for definido como True, deverá ser fornecido o valor de AlternateCallerId.

Confirm

Opcional

SwitchParameter

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

Force

Opcional

SwitchParameter

Suprime qualquer aviso de confirmação que, de outra maneira, seria exibido antes de se realizar as alterações.

WhatIf

Opcional

SwitchParameter

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

Tipos de Entrada

Objeto Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route. Aceita entrada canalizada de objetos de rota de voz.

Tipos de Retorno

Set-CsVoiceRoute não retorna um valor ou objeto. Em vez disso, o cmdlet configura instâncias do objeto Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route.

Exemplo

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

Set-CsVoiceRoute -Identity Route1 -Description "Test Route"

Este comando define a Descrição da rota de voz Route1 para "Test Route".

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

Set-CsVoiceRoute -Identity Route1 -PstnUsages @{add="Long Distance"}

O comando neste exemplo modifica a rota de voz com a identidade Route1, para adicionar o uso da PSTN Interurbano à lista de usos desta rota de voz. A chamada interurbana deve estar na lista de usos de PSTN globais (que podem ser recuperados chamando-se Get-CsPstnUsage).

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

$x = (Get-CsPstnUsage).Usage
Set-CsVoiceRoute -Identity Route1 -PstnUsages @{replace=$x}

Este exemplo modifica a rota de voz denominada Route1, preenchendo a lista da rota de usos da PSTN com todos os usos existentes na organização. O primeiro comando neste exemplo recupera a lista de usos PSTN globais. Observe que a chamada para Get-CsPstnUsage está entre parênteses; isto significa que primeiramente recuperamos um objeto que contém informações sobre o uso da PSTN. (como há somente um uso de PSTN global, será recuperado somente um objeto.) O comando então recupera a propriedade de Uso deste objeto. Essa propriedade, que contém uma lista de usos da PSTN, é atribuída à variável $x. Na segunda linha deste exemplo, Set-CsVoiceRoute é chamado para modificar a rota de voz cuja identidade for Route1. Observe o valor passado ao parâmetro PstnUsages: @{replace=$x}. Este valor informa que se deve substituir tudo na lista de PstnUsages correspondente a essa rota com o conteúdo de $x, que contém a lista de usos de PSTN recuperada na linha 1.

-------------------------- Exemplo 4 --------------------------

$x = Get-CsVoiceRoute -Identity Route1
$x.Name = "RouteA"
Set-CsVoiceRoute -Instance $x

Este conjunto de comandos modifica a propriedade Nome da rota de voz com a identidade Route1 para RouteA. Alterar a propriedade de Nome modifica automaticamente a propriedade Identidade, neste caso para RouteA.

Na primeira linha, o Get-CsVoiceRoute é chamado para recuperar a rota de voz com a identidade Route1. O objeto retornado será armazenado na variável $x. Em seguida, será atribuído o valor de cadeia de caracteres "RouteA" à propriedade Nome desse objeto. Finalmente, o objeto (contido na variável $ x) é passado para o parâmetro Instance de Set-CsVoiceRoute, para efetuar a mudança.

-------------------------- Exemplo 5 --------------------------

$y = Get-CsVoiceRoute -Identity Route1
$y.PstnGatewayList.Add("PstnGateway:192.168.0.100")
Set-CsVoiceRoute -Instance $y

Esse exemplo modifica a rota de voz denominada Route1 e preenche a lista de gateways PSTN (PstnGatewayList) desta rota com a função de servidor do gateway cuja Identidade for PstnGateway:192.168.0.100. Na primeira linha desse exemplo, chama-se Get-CsVoiceRoute, para recuperar a rota de voz que queremos modificar (Rota 1, nesse caso). Em seguida, chamaremos o método Adicionar na propriedade PstnGatewayList de Route1. Passamos ao método Adicionar a Identidade do serviço que desejamos adicionar. Finalmente, chamamos Set-CsVoiceRoute, passando ao parâmetro Instance a variável $y, que atualizará Route1 (armazenada em $y) com o gateway PSTN recém-adicionado.