Set-CsNetworkBandwidthPolicyProfile
Tópico modificado em: 2012-03-26
Modifica um perfil existente de política de largura de banda de rede.
Sintaxe
Set-CsNetworkBandwidthPolicyProfile [-Identity <XdsGlobalRelativeIdentity>] [-AudioBWLimit <String>] [-AudioBWSessionLimit <String>] [-BWPolicy <PSListModifier>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Force <SwitchParameter>] [-VideoBWLimit <String>] [-VideoBWSessionLimit <String>] [-WhatIf [<SwitchParameter>]]
Set-CsNetworkBandwidthPolicyProfile [-AudioBWLimit <String>] [-AudioBWSessionLimit <String>] [-BWPolicy <PSListModifier>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-VideoBWLimit <String>] [-VideoBWSessionLimit <String>] [-WhatIf [<SwitchParameter>]]
Descrição Detalhada
Como parte do controle de admissão de chamadas (CAC), utiliza-se uma política de largura de banda para definir as limitações de largura de banda de determinadas modalidades. (no Microsoft Lync Server 2010, as limitações de largura de banda podem ser atribuídas apenas às modalidades de áudio e vídeo). Esse cmdlet modifica um perfil de contêiner dessas políticas.
IMPORTANTE: Se um perfil contiver múltiplas políticas (por exemplo, uma política de áudio e uma de vídeo), a modificação do perfil mediante o uso das propriedades AudioBWLimit, AudioBWSessionLimit, VideoBWLimit ou VideoBWSessionLimit removerá todas as políticas existentes no perfil e as substituirá pelos novos valores. Se o perfil continha uma política para limitar o vídeo e somente o parâmetro AudioBWLimit for definido, a política de vídeo será removida e será criada uma política de áudio.
Quem pode executar esse cmdlet: Por padrão, membros dos seguintes grupos são autorizados a executar o cmdlet Set-CsNetworkBandwidthPolicyProfile 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-CsNetworkBandwidthPolicyProfile"}
Parâmetros
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
Identity |
Opcional |
XdsGlobalRelativeIdentity |
Um valor de cadeia de caracteres que identifica exclusivamente o perfil de política de largura de banda a ser modificado. Ele é idêntico à propriedade BWPolicyProfileID do perfil e pode ser alterado mudando-se o valor desta propriedade. Isto é equivalente a uma operação de "cortar e colar": todas as propriedades do perfil permanecerão inalteradas. Somente o seu nome mudará. Contudo, este valor não poderá ser mudado se o perfil estiver atribuído a um site de rede. |
Instance |
Opcional |
BWPolicyProfileType |
Uma referência a um objeto de perfil de política de largura de banda (um objeto do tipo Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType), que contém as definições que se quer utilizar para modificar o perfil. Este objeto pode ser recuperado chamando-se o cmdlet Get-CsNetworkBandwidthPolicyProfile. |
AudioBWLimit |
Opcional |
Cadeia de caracteres |
A largura máxima de banda a se alocar para todas as conexões de áudio. Se uma única sessão de áudio exceder o limite de largura de banda de áudio, essa sessão não será iniciada. Expresso em kbps. Por exemplo, o valor 1000 significa 1000 kbps. Se for fornecido um valor para este parâmetro, não será possível fornecer um valor para o parâmetro BWPolicy. Padrão: Se você fornecer um valor para o parâmetro AudioBWSessionLimit, mas não para AudioBWLimit, este será definido como 0. |
AudioBWSessionLimit |
Opcional |
Cadeia de caracteres |
A largura máxima de banda a se alocar por sessão de áudio. Expresso em kbps. O valor deve ser 40 ou superior. Se você fornecer um valor para esse parâmetro, não será possível fornecer um valor para o parâmetro BWPolicy. Padrão: Se você fornecer um valor para o parâmetro AudioBWLimit, mas não para AudioBWSessionLimit, este será definido como 175. |
BWPolicy |
Opcional |
PSListModifier |
Uma lista de objetos contendo perfis de política de largura de banda. Cada objeto na lista consiste em uma modalidade de largura de banda (áudio ou vídeo), uma limitação de largura de banda e uma limitação de sessão de largura de banda. Se for fornecido um valor para esse parâmetro, não será possível fornecer um valor para os parâmetros AudioBWLimit, AudioBWSessionLimit, VideoBWLimit ou VideoBWSessionLimit. Os objetos na lista devem ser do tipo Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyType. Os objetos deste tipo podem ser criados chamando-se o cmdlet New-CsNetworkBWPolicy e a política resultante poderá, então, ser adicionada ao perfil, passando-a como o valor deste parâmetro. |
Description |
Opcional |
Cadeia de caracteres |
Uma descrição do perfil de política de largura de banda. Por exemplo, é possível usar esse parâmetro para esclarecer o uso esperado do perfil. |
VideoBWLimit |
Opcional |
Cadeia de caracteres |
A largura máxima de banda a se alocar para todas as conexões de vídeo. Se uma única sessão de vídeo exceder o limite de largura de banda de vídeo, essa sessão não será iniciada. Expresso em kbps. Por exemplo, o valor 1000 significa 1000 kbps. Se você fornecer um valor para esse parâmetro, não será possível fornecer um valor para o parâmetro BWPolicy. Padrão: Se você fornecer um valor para o parâmetro VideoBWSessionLimit, mas não para VideoBWLimit, este será definido como 0. |
VideoBWSessionLimit |
Opcional |
Cadeia de caracteres |
A largura máxima de banda a se alocar por sessão de vídeo. Expresso em kbps. O valor deve ser 100 ou superior. Se for fornecido um valor para este parâmetro, não será possível fornecer um valor para o parâmetro BWPolicy. Padrão: Se você fornecer um valor para o parâmetro VideoBWLimit, mas não para VideoBWSessionLimit, este será definido como 700. |
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. |
Confirm |
Opcional |
SwitchParameter |
Solicita confirmação antes da execução do comando. |
Tipos de Entrada
Objeto Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType. Aceita entrada canalizada dos objetos do perfil da política de largura de banda de rede.
Tipos de Retorno
Este cmdlet não retorna um valor. Ele modifica um objeto do tipo Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType.
Exemplo
-------------------------- Exemplo 1 --------------------------
Set-CsNetworkBandwidthPolicyProfile -Identity LowBWProfile -Description "Policy for links of less than 10MB"
Este exemplo modifica a descrição do perfil da política de largura de banda cuja identidade for LowBWProfile. Ele faz isso chamando Set-CsNetworkBandwidthPolicyProfile com dois parâmetros: Identity, especificando o nome do perfil a modificar; e Description, especificando a nova descrição do perfil.
-------------------------- Exemplo 2 --------------------------
Set-CsNetworkBandwidthPolicyProfile -Identity LowBWLimit -VideoBWLimit 2500 -VideoBWSessionLimit 300
O Exemplo 2 modifica o limite total e o limite de sessão de transmissões de vídeo do perfil da política de largura de banda cuja identidade for LowBWLimit. Após se especificar a identidade do perfil a ser modificado, utiliza-se o parâmetro VideoBWLimit, para definir como 2500 o limite geral de vídeo. Em seguida, utiliza-se o parâmetro VideoBWSessionLimit para definir como 300 o limite de sessão individual. Este comando adicionará um perfil de vídeo ou atualizará um perfil de vídeo existente do perfil da política de largura de banda LowBWLimit. Quaisquer perfis de áudio existentes não serão afetados.
-------------------------- Exemplo 3 --------------------------
$bp = New-CsNetworkBWPolicy -BWLimit 5000 -BWSessionLimit 200 -BWPolicyModality video
Set-CsNetworkBandwidthPolicyProfile -Identity LowBWLimit -BWPolicy $bp
Neste exemplo, uma nova política de largura de banda será criada e atribuída ao perfil da política de largura de banda cuja identidade for LowBWLimit. A primeira linha do exemplo é uma chamada ao cmdlet New-CsNetworkBWPolicy. Este cmdlet cria um novo perfil, neste caso um perfil de vídeo (-BWPolicyModality video) com um limite de 5000 kbps (-BWLimit 5000) e um limite de sessão de 200 kbps (-BWSessionLimit 200). Este novo objeto de perfil será armazenado na variável $bp. A próxima linha deste exemplo chamará Set-CsNetworkBandwidthPolicyProfile, para modificar o perfil LowBWLimit (-Identity LowBWLimit). O parâmetro BWPolicy é utilizado com o valor $bp. Isto substitui quaisquer políticas existentes neste perfil pela política recém-criada, que foi armazenada na variável $bp.
-------------------------- Exemplo 4 --------------------------
$a = Get-CsNetworkBandwidthPolicyProfile -Identity LowBWProfile
$ap = New-CsNetworkBWPolicy -BWLimit 2000 -BWSessionLimit 300 -BWPolicyModality audio
$a.BWPolicy.Add($ap)
Set-CsNetworkBandwidthPolicyProfile -Instance $a
O exemplo 4 adiciona uma nova política de largura de banda ao conjunto de políticas existentes no perfil LowBWProfile. Na linha 1, chama-se Get-CsNetworkBandwidthPolicyProfile, para recuperar o perfil cuja identidade for LowBWProfile. Armazena-se este perfil na variável $a. Na próxima linha, chama-se New-CsNetworkBWPolicy, para criar uma nova política de largura de banda. Esta é uma política de áudio (-BWPolicyModality audio), com um limite de 2000 kbps (-BWLimit 2000) e um limite de sessão de 300 kbps (-BWSessionLimit 300). Esta nova política será armazenada na variável $ap.
Na linha 3, adiciona-se a nova política de áudio (armazenada em $ap) ao perfil recuperado na linha 1 (e armazenado na variável $a). Isto é feito chamando-se o método Add da propriedade BWPolicy do perfil e passando o valor de $ap. Isto pode ser lido como "Adicionar a nova política, armazenada em $ap, a BWPolicy do perfil LowBWProfile (armazenado em $a)".
Finalmente, chama-se Set-CsNetworkBandwidthPolicyProfile, para atualizar o perfil LowBWProfile. Utiliza-se o parâmetro Instance, passando-lhe o valor de $a, que contém o perfil modificado.
-------------------------- Exemplo 5 --------------------------
$ap = New-CsNetworkBWPolicy -BWLimit 2000 -BWSessionLimit 300 -BWPolicyModality audio
Set-CsNetworkBandwidthPolicyProfile -Identity LowBWProfile -BWPolicy @{add=$ap}
O Exemplo 5 é idêntico em funcionalidade ao Exemplo 4: ele adiciona uma nova política de áudio a uma lista de política existentes do perfil LowBWProfile. Este método requer menos linhas, mas pode não ser tão claro. Foi incluído aqui simplesmente para demonstrar que existem modos diferentes de se fazer a mesma coisa.
Na linha 1, cria-se uma nova política de largura de banda de áudio, definindo-se um limite de largura de banda (2000), um limite de sessão (300) e armazenando-se o novo objeto na variável $ap. A seguir, chama-se Set-CsNetworkBandwidthPolicyProfile, para modificar o perfil cuja identidade for LowBWProfile. Utiliza-se o parâmetro BWPolicy para modificar a lista de políticas do perfil. Observe o valor passado para este parâmetro: @{add=$ap}. Isto é simplesmente um modo de adicionar algo a uma lista no Windows PowerShell. Inicia-se com o caractere @, seguido de um conjunto de chaves {}. Dentro dessas chaves, especifica-se a ação a ser realizada na lista. Neste caso, adicionar algo à lista. (pode-se também remover ou substituir algo.) Coloca-se um sinal de igual após a ação (add), seguido do objeto que se quer adicionar à lista. Neste caso, a nova política armazenada na variável $ap.
Consulte Também
Outros Recursos
New-CsNetworkBandwidthPolicyProfile
Remove-CsNetworkBandwidthPolicyProfile
Get-CsNetworkBandwidthPolicyProfile
New-CsNetworkBWPolicy