Get-CsUser
Tópico modificado em: 2012-03-23
Retorna informações sobre todos os usuários em sua organização que foram habilitados para o Microsoft Lync Server 2010 ou para uma versão anterior do software (como Microsoft Office Communications Server 2007 R2).
Sintaxe
Get-CsUser [-Identity <UserIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-LdapFilter <String>] [-OnLyncServer <SwitchParameter>] [-OnOfficeCommunicationServer <SwitchParameter>] [-OU <OUIdParameter>] [-ResultSize <Unlimited>] [-UnAssignedUser <SwitchParameter>]
Descrição Detalhada
Usados em conjunto, os cmdlets Get-CsAdUser e Get-CsUser permitem que você retorne informações detalhadas sobre todas as suas contas de usuário do Active Directory. Get-CsAdUser retorna informações sobre todas as suas contas de usuário, incluindo os usuários que foram habilitados para o Lync Server 2010 ou o Office Communications Server e os usuários que não foram habilitados para o Lync Server ou o Office Communications Server. Isso o difere do Get-CsUser, que retorna informações somente sobre os usuários cujas contas foram habilitadas para o Lync Server ou o Office Communications Server.
Embora exista alguma sobreposição entre os dois, Get-CsUser e Get-CsAdUser diferem no tipo de informação que retornam. Em geral, o Get-CsUser retorna valores para atributos do Active Directory especificamente relacionados ao Lync Server. Por exemplo, Get-CsUser retorna informações como as diretivas do Lync Server que foram atribuídas a um usuário, a linha URI atribuída a esse usuário e se o usuário está habilitado ou não para o Enterprise Voice. Esses atributos não serão parte de uma conta de usuário a menos que esse usuário tenha sido habilitado para o Lync Server.
O Get-CsAdUser, por sua vez, retorna valores de atributos genéricos do Active Directory: atributos que são parte da conta de usuário do Active Directory e estão presentes independentemente de um usuário ter sido habilitado para o Lync Server ou não. Por exemplo, Get-CsAdUser retorna informações como o departamento e a organização para os quais o usuário trabalha, bem como seu cargo, número do telefone e endereço do escritório.
Para ver uma lista completa dos valores de atributos retornados pelo Get-CsUser, digite este comando no prompt de comando do Windows PowerShell:
Get-CsUser | Get-Member
Get-CsUser oferece várias maneiras de se filtrar a coleção de usuários retornados quando o cmdlet é executado. Por exemplo, se não desejar que todas as contas de usuário do Lync Server sejam retornadas, você poderá aplicar os parâmetros opcionais Filter ou LDAPFilter. (Estes parâmetros são mutuamente exclusivos: se você usar o Filter em um comando, não pode usar o LDAPFilter no mesmo comando e vice-versa). O parâmetro Filter permite fazer com que os dados retornados sejam limitados aos usuários que atendam aos critérios do Lync Server especificados; por exemplo, você pode retornar somente os usuários com contas no pool de Registrador especificado, ou somente os usuários que foram habilitados para o Enterprise Voice. O parâmetro LDAPFilter permite limitar os dados retornados a usuários que atendam a outros critérios baseados no Active Directory; por exemplo, usuários que trabalhem em um estado ou província específico, usuários que tenham ou não um pager, ou usuários com um determinado cargo.
Quem pode executar este cmdlet: Por padrão, membros dos seguintes grupos estão autorizados a executar o cmdlet Get-CsUser localmente: RTCUniversalUserAdmins, RTCUniversalServerAdmins, RTCUniversalReadOnlyAdmins. 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 "Get-CsUser\b"}
Parâmetros
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
Identity |
Opcional |
UserIDParameter |
Indica a identidade da conta de usuário a ser recuperada. As identidades de usuários podem ser especificadas usando um de quatro formatos: 1) O endereço SIP do usuário; 2) o nome UPN do usuário; 3) o nome de domínio do usuário e nome de logon, na forma domínio\logon (por exemplo, litwareinc\kenmyer); e, 4) o nome de exibição do Active Directory do usuário (por exemplo, Ken Myer). Também é possível fazer referência a uma conta de usuário com o nome diferenciado do Active Directory. Você pode usar o caractere curinga asterisco (*) ao usar o nome para exibição como identidade do usuário. Por exemplo, a identidade "* Smith" retornaria todos os usuários com nome para exibição que termine com " Smith". |
Credential |
Opcional |
Objeto PSCredential |
Permite a você executar o cmdlet Get-CsUser usando credenciais alternativas. Isso pode ser necessário se a conta que você usou para fazer logon no Windows não tiver os privilégios necessários para se trabalhar com objetos de usuário. Para usar o parâmetro Credential, primeiro crie um objeto PSCredential usando o cmdlet Get-Credential. Para obter detalhes, consulte o tópico de Ajuda do cmdlet Get-Credential. |
DomainController |
Opcional |
Cadeia de caracteres |
Permite que você se conecte a um controlador de domínio especificado para recuperar informações de usuário. Para conectar-se a um controlador de domínio em particular, inclua o parâmetro DomainController seguido do FQDN (nome de domínio totalmente qualificado) (por exemplo, atl-cs-001.litwareinc.com). |
Filter |
Opcional |
Cadeia de caracteres |
Permite que você limite os dados retornados, filtrando por atributos específicos do Lync Server. Por exemplo, você pode limitar os dados retornados aos usuários que receberam a atribuição de uma diretiva de voz específica, ou usuários que não receberam a atribuição de uma diretiva de voz específica. O parâmetro Filter usa a mesma sintaxe de filtro do Windows PowerShell usada pelo cmdlet Where-Object. Por exemplo, um filtro para retornar somente os usuários que foram habilitados para o Enterprise Voice teria a seguinte sintaxe, onde EnterpriseVoiceEnabled representa o atributo do Active Directory, -eq representa o operador de comparação (igual a) e $True (uma variável interna do Windows PowerShell) representa o valor do filtro: {EnterpriseVoiceEnabled -eq $True} |
LDAPFilter |
Opcional |
Cadeia de caracteres |
Permite limitar os dados retornados filtrando atributos genéricos do Active Directory (ou seja, atributos que não são específicos do Lync Server). Por exemplo, você pode limitar os dados retornados aos usuários que trabalham em um departamento específico ou aos usuários que têm um gerente ou cargo específico. O parâmetro LDAPFilter usa o idioma de consulta LDAP ao criar filtros. Por exemplo, um filtro para retornar somente os usuários que trabalham na cidade de Redmond seria assim: "l=Redmond", onde "l" (L minúsculo) representa o atributo do Active Directory (localidade); "=" representa o operador de comparação (igual a); e "Redmond" representa o valor do filtro. |
OnOfficeCommunicationServer |
Opcional |
Parâmetro de opção |
Retorna uma coleção de usuários hospedados em uma versão anterior do Lync Server (por exemplo, Office Communications Server 2007 R2). Usuários com contas na versão corrente do software não serão retornados quando você usar esse parâmetro. |
OnLyncServer |
Opcional |
Parâmetro de opção |
Retorna uma coleção de usuários hospedados no Lync Server 2010. Usuários com contas em versões anteriores do software não serão retornados quando você usar esse parâmetro. |
OU |
Opcional |
Nome diferenciado |
Permite retornar informações sobre contas de usuário de uma unidade organizacional (OU) ou contêiner específicos. O parâmetro OU retorna dados da OU especificada e de qualquer de suas OUs filhas. Por exemplo, se a OU Finance tiver duas OUs filhas, AccountsPayable e AccountsReceivable, os dados retornados incluirão usuários de cada uma dessas três OUs. Ao especificar uma OU, use o DN (nome diferenciado) do contêiner em questão; por exemplo: -OU "OU=Finance,dc=litwareinc,dc=com". Para retornar contas de usuário do contêiner User, use esta sintaxe: -OU "cn=Users,dc=litwareinc,dc=com". |
ResultSize |
Opcional |
Inteiro |
Permite limitar o número de registros retornados pelo cmdlet. Por exemplo, para retornar sete usuários (independentemente do número de usuários existentes em sua floresta), inclua o parâmetro ResultSize e defina seu valor como 7. Observe que não há como garantir quais serão os sete usuários retornados. O tamanho do resultado pode ser definido com qualquer número inteiro entre 0 e 2147483647, inclusive. Se for definido com 0, o comando será executado mas nenhum dado será retornado. Se você definir o ResultSize com 7, mas tiver apenas três usuários em sua floresta, o comando retornará esses três usuários e, em seguida, será concluído sem erros. |
UnassignedUser |
Opcional |
Parâmetro de opção |
Permite retornar uma coleção de todos os usuários que tenham sido habilitados para o Lync Server mas que não estejam atribuídos a um pool de Registrador no momento. Os usuários não terão permissão para fazer logon no Lync Server a menos que sejam atribuídos a um pool de Registrador. |
Tipos de Entrada
Cadeia de caracteres. Get-CsUser aceita um valor de cadeia de caracteres em pipeline representando o parâmetro Identity de uma conta de usuário que tenha sido habilitada para o Lync Server 2010.
Tipos de Retorno
Get-CsUser retorna instâncias do objeto Microsoft.Rtc.Management.ADConnect.Schema.ADUser.
Exemplo
-------------------------- Exemplo 1 --------------------------
Get-CsUser
No exemplo anterior, Get-CsUser é chamado sem qualquer parâmetro para retornar uma coleção de todos os usuários de domínio que foram habilitados para o Lync Server ou o Office Communications Server.
-------------------------- Exemplo 2 --------------------------
Get-CsUser | Format-Table -Property DisplayName, SipAddress, EnterpriseVoiceEnabled -AutoSize
No Exemplo 2, Get-CsUser retorna uma coleção de todos os usuários do domínio que tenham sido habilitados para o Lync Server ou o Office Communications Server. Por padrão, Get-CsUser retorna um número muito grande de propriedades e valores de propriedade, muitos dos quais não terão muita utilidade em determinadas situações. Portanto, neste exemplo, os dados recuperados são canalizados para o cmdlet Format-Table. Format-Table então usa o parâmetro Property para selecionar as propriedades DisplayName, SipAddress e EnterpriseVoiceEnabled e exibir essas propriedades e seus valores em uma tabela.
-------------------------- Exemplo 3 --------------------------
Get-CsUser -Identity "Pilar Ackerman"
No Exemplo 3, o parâmetro Identity é usado para limitar os dados retornados à conta do usuário com parâmetro Identity (neste caso, o nome para exibição) igual a Pilar Ackerman.
-------------------------- Exemplo 4 --------------------------
Get-CsUser -Identity "Pilar*"
No Exemplo 4, o caractere curinga (*) é usado para especificar a identidade do usuário. Isso faz com que Get-CsUser retorne todos os usuários que tenham a propriedade Identity começando com a cadeia de caracteres "Pilar".
-------------------------- Exemplo 5 --------------------------
Get-CsUser -Filter {VoicePolicy -eq $Null}
O comando mostrado no Exemplo 5 retorna uma coleção de usuários que não receberam a atribuição de uma diretiva de voz por usuário. Para fazer isso, o comando usa o parâmetro Filter seguido do filtro VoicePolicy -eq "$Null. Ao construir filtros para usar com o Get-CsUser, é preciso especificar o nome da propriedade (VoicePolicy), seguido do operador de comparação (neste caso, "eq", que significa "igual a"). Imediatamente após o operador de comparação deve estar o valor que está sendo testado. Neste exemplo esse valor é $Null, uma variável do Windows PowerShell que representa um valor nulo.
Para retornar uma coleção de usuários que não tenham uma diretiva de voz atribuída a eles, use este comando:
Get-CsUser -Filter {VoicePolicy -ne $Null}
-------------------------- Exemplo 6 --------------------------
Get-CsUser -LDAPFilter "Department=Finance"
O comando anterior usar o parâmetro LDAPFilter para limitar o número de dados retornados aos usuários que trabalham no departamento financeiro. Isso é feito usando o valor de filtro LDAP "Department=Finance".
-------------------------- Exemplo 7 --------------------------
Get-CsUser -LDAPFilter "&(Department=Finance)(Title=Manager)"
O Exemplo 7 demonstra o uso de uma consulta do tipo AND em conjunto com o parâmetro LDAPFilter. Essa consulta (que usa o caractere "&" para indicar uma consulta do tipo AND) especifica duas condições: "Department=Finance" e "Title=Manager". Para que uma conta de usuário seja retornada por esta consulta, ambas as condições precisam ser verdadeiras: o usuário tem que trabalhar no departamento financeiro (Finance) e ser um gerente (Manager).
-------------------------- Exemplo 8 --------------------------
Get-CsUser -LdapFilter "|(Title=Supervisor)(Title=Manager)"
No comando mostrado no exemplo 8, uma consulta do tipo OR (indicado pelo símbolo "|") é usada em conjunto com o parâmetro LDAPFilter. Na consulta AND mostrada no exemplo 7, ambas as condições tinham que ser verdadeiras para que uma conta de usuários fosse retornada. Em uma consulta OR, basta que uma das condições seja verdadeira para que a conta seja retornada. Neste caso, uma conta de usuário será retornada se o usuário for um supervisor ou se for um gerente,
-------------------------- Exemplo 9 --------------------------
Get-CsUser -OU "ou=Finance,ou=North America,dc=litwareinc,dc=com"
O Exemplo 9 retorna informações de contas de usuário para todos os usuários com contas na unidade organizacional (OU) Finance.
-------------------------- Exemplo 10 --------------------------
Get-CsUser -UnassignedUser
O comando anterior retorna uma coleção de todos os usuários que foram habilitados para o Lync Server ou o Office Communications Server mas que não estão atribuídos a um pool de Registrador no momento.