Returns information about the audio conference providers assigned to a user or group of users.
Syntax
Get-CsUserAcp [-Identity <UserIdParameter>] [-Credential <PSCredential>] [-Filter <String>] [-LdapFilter <String>] [-ResultSize <Unlimited>] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
User Identity |
Indicates the Identity of the user account to be retrieved. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's Universal Principal Name; 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory Domain Services display name (for example, Ken Myer). Note that the SamAccountName cannot be used as an identity because it is not necessarily unique in a forest. You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. For example, the Identity "* Smith" returns all the users with the a display name that ends with the string value " Smith". |
|
Filter |
Optional |
String |
Enables you to limit the returned data by filtering on Communications Server-specific attributes. For example, you can limit returned data to users who have been assigned a specific voice policy, or users who have not been assigned a specific voice policy. The Filter parameter uses the same Windows PowerShell filtering syntax that is used by the Where-Object cmdlet. For example, a filter that returns only users who have been enabled for Enterprise Voice would look like this, with EnterpriseVoiceEnabled representing the Active Directory Domain Services attribute, -eq representing the comparison operator (equal to), and $True (a built-in Windows PowerShell variable) representing the filter value: {EnterpriseVoiceEnabled -eq $True} For details, see the about_communications_server_filters Help topic. |
|
LdapFilter |
Optional |
String |
Enables you to limit the returned data by filtering on generic Active Directory Domain Services attributes (that is, attributes that are not specific to Communications Server). For example, you can limit returned data to users who work in a specific department, or users who have a specified manager or job title. The LDAPFilter parameter uses the LDAP query language when creating filters. For example, a filter that returns only users who work in the city of Redmond would look like this: "l=Redmond", with "l" representing the Active Directory Domain Services attribute (locality); "=" representing the comparison operator (equal to); and "Redmond" representing the filter value. For details, see the about_ldap_filters Help topic. |
|
Credential |
Optional |
PS Credential object |
Enables you to run the Get-CsUserAcp cmdlet under alternate credentials. This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with contact objects. To use the -Credential parameter you must first create a PSCredential object using the Get-Credential cmdlet. For details, see the Get-Credential cmdlet Help topic. |
|
ResultSize |
Optional |
Integer |
Enables you to limit the number of records returned by a command. For example, to return seven users (regardless of how many users are in your forest) include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which 7 users will be returned. If you set the ResultSize to 7 but you have only three users in your forest, the command will return those three users, and then complete without error. The result size can be set to any whole number between 0 and 2147483647, inclusive. If set to 0 the command will run, but no data will be returned. |
Detailed Description
An audio conference provider is a third-party company that provides organizations with conferencing services. Among other things, audio conference providers provide a way for users located off site, and not connected to the corporate network or the Internet, to participate in the audio portion of a conference or online meeting. Audio conference providers often provide high-end services such as live translation, transcription, and live per-conference operator-assistance.
The Get-CsUserAcp cmdlet enables you to return information about the audio conference providers that have been assigned to a user or a group of users. To return ACP information for a single user, simply include the –Identity parameter followed by the Identity of the user whose information is to be returned. To return information for multiple users, you can use either the –LdapFilter or the –Filter parameters. The –LdapFilter parameter enables you to use generic Active Directory attributes such as Department or Title when specifying the user account information; for example, the parameter value "Title=Accountant" restricts the returned information to users who have the job title Accountant. The –Filter parameter enables you to use Communications Server-specific attributes (such as VoicePolicy or EnterpriseVoiceEnabled) to filter the returned data. For example, the filter value {EnterpriseVoiceEnabled –eq $True} limits the user accounts returned by Get-CsUserAcp to users who have been enabled for Enterprise Voice.
Alternatively, you can call Get-CsUserAcp without any parameters in order to return ACP information for all your users. Note that Get-CsUserAcp returns audio conference provider information for all your users, including users who have not been enabled for Communications Server.
Return Types
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Get-CsUserAcp |
|
The command shown in Example 1 returns audio conference provider information for all the users in your organization.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsUserAcp -Identity "Ken Myer" |
|
The preceding command returns ACP information for a single user: the user with the Identity Ken Myer. In this case, the identity is specified by using the user’s Active Directory display name.
-------------------------- Example 3 ------------------------
| Copy Code |
|
|---|---|
Get-CsUserAcp -Filter {AcpInfo -ne $Null}
|
|
Example 3 returns information for all the users who have been assigned at least one audio conference provider. To do this, the –Filter parameter is included along with the filter value {AcpInfo –ne $Null}; this filter value limits the returned data to users who have an AcpInfo property value that is not equal to (-ne) a null value ($Null). To return information about users who have not been assigned an audio conference provider use this filter value: {AcpInfo –eq $Null}.
-------------------------- Example 4 ------------------------
| Copy Code |
|
|---|---|
Get-CsUserAcp | Where-Object {$_.AcpInfo -match "Fabrikam ACP"
|
|
The preceding command returns audio conference provider information for any user who has been assigned the audio conference provider Fabrikam ACP. To carry out this task the command first uses Get-CsUserAcp without any parameters in order to return audio conference provider information for all the users in your organization. This information is then piped to the Where-Object cmdlet, which picks out any user whose AcpInfo property includes (-match) the string value "Fabrikam ACP".
-------------------------- Example 5 ------------------------
| Copy Code |
|
|---|---|
Get-CsUserAcp -Identity "Ken Myer" | Select-Object -ExpandProperty AcpInfo |
|
In Example 5, detailed information is displayed about the audio conference providers assigned to the user Ken Myer. To do this, Get-CsUserAcp is first called to return audio conference provider information for Ken Myer. This data is then piped to the Select-Object cmdlet, which uses the –ExpandProperty parameter to “expand” the value of the AcpInfo property. When a property value is expanded, that simply means that all the information stored in that value is displayed in easy-to-read fashion.