Get-CsAdUser
Tópico modificado em: 2012-03-23
Retorna informações sobre todas as contas de usuário no Serviços de Domínio Active Directory (AD DS). Isso inclui contas de usuário que foram habilitadas para o Microsoft Lync Server 2010, bem como contas que não foram habilitadas para o Lync Server 2010.
Sintaxe
Get-CsAdUser [-Identity <UserIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-LDAPFilter <String>] [-OU <OUIdParameter>] [-ResultSize <Unlimited>]
Descrição Detalhada
Get-CsAdUser retorna informações sobre todas as contas de usuário no Active Directory, inclusive as contas de usuário que tiverem sido habilitadas e contas de usuário que não tiverem sido habilitadas para o Lync Server. Este cmdlet se diferencia de Get-CsUser, que retorna informações somente dos usuários cujas contas tiverem sido habilitadas para o Lync Server ou uma versão anterior do software (como o Microsoft Office Communications Server 2007 R2).
Embora haja alguma sobreposição entre os cmdlets, Get-CsAdUser e Get-CsUser também se diferenciam pelo 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 pode informar quais políticas do Lync Server foram atribuídas a um usuário, o Identificador de recurso uniforme (URI) de linha atribuído a esse usuário, além de indicar se o usuário foi habilitado ou não para o Enterprise Voice. Esses atributos não farão parte de uma conta de usuário, a menos que esse usuário tenha sido habilitado para o Lync Server.
Por outro lado, o cmdlet Get-CsAdUser retorna valores genéricos de atributos do Active Directory, ou seja, ele retorna informações sobre atributos que fizerem parte da conta do usuário básica do Active Directory e estiverem presentes, independentemente de o usuário ter sido habilitado ou não para o Lync Server. Por exemplo, Get-CsAdUser retorna informações tais como o departamento e a organização onde o usuário trabalha, juntamente com o cargo, número de telefone e endereço do escritório. Para ver uma lista completa dos valores de atributos retornados por Get-CsAdUser, digite este comando no prompt do Windows PowerShell:
Get-CsAdUser | Get-Member
Quando se executa Get-CsAdUser, ele fornece diversos modos de filtrar a coleção de usuários retornados. Por exemplo: caso não se queira retornar todas as contas de usuários do Active Directory, aplique os parâmetros opcionais Filter ou LdapFilter. Estes parâmetros são mutuamente exclusivos: Caso o parâmetro Filter seja usado em um comando, não será possível usar o parâmetro LdapFilter nesse mesmo comando, e vice-versa. O parâmetro Filter permite limitar os dados retornados aos usuários que satisfizerem os critérios especificados em atributos específicos do Lync Server. Por exemplo: o parâmetro Filter pode ser usado para retornar uma coleção de usuarios que tiverem sido habilitados ou não para o Lync Server. O parâmetro LdapFilter permite limitar os dados retornados de usuários que satisfizerem outros critérios, com base em atributos genéricos do Active Directory. Por exemplo: usuários que trabalharem em um estado ou província específica, os usuários que tiverem ou não um pager, ou os usuários com um determinado cargo.
Uma característica importante a ser observada sobre o cmdlet Get-CsAdUser é esta: embora o atributo Enabled, que determina se um usuário foi habilitado para o Lync Server, seja um valor Booliano, essa propriedade tem três valores válidos:
True. O usuário foi habilitado para o Lync Server
False. O usuário teve sua conta do Lync Server desabilitada temporariamente. Isso é geralmente feito usando o cmdlet Set-CsUser e configurando o parâmetro Enabled como $False.
Null. O usuário não foi habilitado para o Lync Server
Isso significa que, se você desejar retornar uma lista de usuários que não estão habilitados para Lync Server, deverá usar um comando que retorna todos os usuários onde o atributo Enabled é nulo:
Get-CsAdUser –Filter {Enabled –eq $Null}
Por contraste, o seguinte comando retorna somente os usuários que têm contas do Lync Server que foram desabilitadas temporariamente:
Get-CsAdUser –Filter {Enabled –eq $False}
Os usuários que não foram habilitados para o Lync Server não serão retornados quando você executar o comando anterior.
Quem pode executar esse cmdlet: Por padrão, membros dos seguintes grupos estão autorizados a executar o cmdlet Get-CsAdUser localmente: RTCUniversalUserAdmins, RTCUniversalServerAdmins e RTCUniversalReadOnlyAdmins. Para retornar uma lista de todas as funções de controle de acesso baseado em função (RBAC) às quais este cmdlet tiver sido atribuído (inclusive qualquer função RBAC personalizada que tiver sido criada por você), execute o seguinte comando no prompt do Windows PowerShell:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsAdUser"}
Parâmetros
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
Identity |
Opcional |
Parâmetro UserID |
Indica a Identidade da conta de usuário a ser recuperada. A identidade de usuário pode ser especificada usando-se um dos quatro formatos a seguir: 1) O endereço SIP do usuário, 2) o UPN (nome principal de usuário), 3) o nome de domínio e nome de logon do usuário, na forma domínio\logon (por exemplo: litwareinc\kenmyer) e 4) o nome de exibição do usuário no Active Directory (por exemplo: Ken Myer). Também é possível fazer referência a uma conta de usuário usando o nome diferenciado do usuário no Active Directory. É possível utilizar o caractere curinga asterisco (*) ao se utilizar o Nome de Exibição como Identidade de usuário. Por exemplo, a identidade "* Smith" retornará todos os usuários com nome de exibição que terminarem com o valor da cadeia de caracteres " Smith". |
Credential |
Opcional |
Objeto PSCredential |
Permite executar o cmdlet Get-CsAdUser com credenciais alternativas. Isto poderia ser necessário se a conta que se usou para fazer o logon no Windows não tivesse os privilégios necessários para trabalhar com objetos de usuário. Para usar o parâmetro de Credential, crie primeiramente um objeto PSCredential, usando o cmdlet Get-Credential. Para detalhes, consulte o tópico de Ajuda Get-Credential. |
DomainController |
Opcional |
Cadeia de caracteres |
Permite se conectar a um controlador de domínio especificado, para recuperar as informações de usuário. Para se conectar a um determinado controlador de domínio, inclua o parâmetro DomainController, seguido do nome de domínio totalmente qualificado (FQDN) (atl-cs-001.litwareinc.com, por exemplo). |
Filter |
Opcional |
Cadeia de caracteres |
Permite limitar os dados retornados, filtrando atributos específicos a Lync Server. O parâmetro Filtro usa o mesmo filtro de sintaxe Windows PowerShell usado pelo cmdlet Where-Object. Por exemplo: um filtro que só retorna usuários que tiverem sido habilitados para o Lync Server teria a seguinte aparência: {Enabled -ne $True}, onde Enabled representa o atributo do Active Directory, -ne, o operador de comparação (diferente de) e $True (uma variável interna do Windows PowerShell), o valor True. |
LdapFilter |
Opcional |
Cadeia de caracteres |
Permite limitar os dados retornados, filtrando-se atributos genéricos do Active Directory (ou seja, atributos que não forem específicos a Lync Server). Por exemplo, pode-se limitar os dados retornados aos usuários que trabalharem em um departamento específico ou aos usuários que tiverem um gerente ou cargo específico. Ao criar filtros, o parâmetro LdapFilter usa a linguagem de consulta LDAP. Por exemplo, um filtro que retorna somente os usuários que trabalharem na cidade de Redmond poderia ter a seguinte aparência: "l=Redmond", onde "l" (uma letra L minúscula) representa o atributo do Active Directory (localidade), "=", o operador de comparação (igual a) e "Redmond", o valor do filtro. |
OU |
Opcional |
Nome distinto |
Permite que usuários sejam retornados de uma unidade organizacional (OU) ou de um contêiner específico do Active Directory. Este parâmetro retorna dados da OU específica e de qualquer uma de suas OUs filhas. Por exemplo: se a OU Financeiro 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, utilize o nome diferenciado (DN) do contêiner. Por exemplo: OU=Finance,dc=litwareinc,dc=com. Para retornar usuários do contêiner Users, utilize a sintaxe: cn=Users,dc=litwareinc,dc=com. |
ResultSize |
Opcional |
Inteiro |
Permite limitar o número de registros retornados por um cmdlet. Por exemplo: para retornar sete usuários (independentemente de quantos usuários existirem na floresta), inclua o parâmetro ResultSize e defina o valor de parâmetro como 7. Observe que não há maneira de garantir quais sete usuários serão retornados. O tamanho do resultado pode ser definido como qualquer número inteiro entre 0 e 2147483647, inclusive. Se o número for definido como 0, o comando será executado, mas nenhum dado será retornado. Se se definir o ResultSize como 7, mas só houver três usuários na floresta, o comando retornará os três usuários e, em seguida, concluirá sem erro. |
Tipos de Entrada
Cadeia de caracteres. Get-CsAdUser aceita um valor canalizado de cadeia de caracteres, que representa a Identidade de uma conta de usuário do Active Directory.
Tipos de Retorno
Get-CsAdUser retorna instâncias do objeto Microsoft.Rtc.Management.ADConnect.Schema.CSADUser.
Exemplo
-------------------------- Exemplo 1 --------------------------
Get-CsAdUser
O comando mostrado no Exemplo 1 retorna uma coleção de todas as contas de usuário no domínio do Active Directory.
-------------------------- Exemplo 2 --------------------------
Get-CsAdUser -Identity "Pilar Ackerman"
No Exemplo 2, Get-CsAdUser retorna as informações da conta de usuário de Pilar Ackerman. Neste exemplo, utiliza-se o nome de exibição do usuário para especificar a sua identidade.
-------------------------- Exemplo 3 --------------------------
Get-CsAdUser -OU "ou=Finance,dc=litwareinc,dc=com"
O Exemplo 3 retorna as informações de conta de usuário de todos os usuários da unidade organizacional Financeiro. Para fazer isto, o nome diferenciado da OU deve ser passado ao parâmetro OU.
-------------------------- Exemplo 4 --------------------------
Get-CsAdUser -Filter {Enabled -ne $True} | Select-Object DisplayName
No comando anterior, serão retornados todos os usuários que não tiverem sido habilitados para o Lync Server 2010 ou o Office Communications Server. Para isso, utiliza-se o parâmetro Filter com Get-CsAdUser, para restringir os dados retornados às contas de usuário cuja propriedade Enabled não for igual a True. Este filtro instrui Get-CsAdUser a retornar somente as contas de usuários que não tiverem sido habilitadas para uso com o Lync Server ou o Office Communications Server. Depois que os dados tiverem sido recuperados, as informações serão canalizadas para o cmdlet Select-Object, que identificará a única propriedade (neste caso, DisplayName) que será de fato exibida na tela.
-------------------------- Exemplo 5 --------------------------
Get-CsAdUser -LdapFilter "Department=Finance"
No Exemplo 5, utiliza-se o parâmetro LdapFilter, para limitar os dados retornados aos usuários que pertencerem ao departamento Financeiro. Isso é feito usando-se o valor "Department=Financeiro" do filtro LDAP.