Get-CsApplicationEndpoint
Topic Last Modified: 2012-03-23
Retrieves endpoints for the Application service.
Syntax
Get-CsApplicationEndpoint [-Identity <UserIdParameter>] [-ApplicationId <String>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-OU <OUIdParameter>] [-PoolFqdn <String>] [-ResultSize <Unlimited>]
Detailed Description
This cmdlet retrieves one or more application contacts from Active Directory Domain Services (AD DS). These objects are stored in Active Directory in the Application Contacts container of the RTC service.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsApplicationEndpoint cmdlet locally: RTCUniversalUserAdmins, RTCUniversalServerAdmins, RTCUniversalReadOnlyAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsApplicationEndpoint"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
UserIdParameter |
The Identity, SIP address, or display name of the application endpoint to retrieve. The Identity consists of the distinguished name of the endpoint. This will typically contain a globally unique identifier (GUID) as part of the CN, for example: CN={8811fefe-e0bb-4fab-ae39-7aaeddd423dc},CN=Application Contacts,CN=RTC Service,CN=Services,CN=Configuration,DC=Vdomain,DC=com. |
ApplicationId |
Optional |
String |
The application ID of the application endpoint you want to retrieve. The application ID is the value of the endpoint’s OwnerUrn property. For example, if the OwnerUrn property has a value of urn:application:Caa, the application ID is urn:application:Caa. However, you can enter only the suffix, in this case Caa, to retrieve the endpoint. For example: -ApplicationId Caa |
Credential |
Optional |
PSCredential |
Alternate credentials under which the Get operation will proceed. You can retrieve a PSCredential object by calling the Windows PowerShell cmdlet Get-Credential. |
DomainController |
Optional |
Fqdn |
Allows you to specify a domain controller. If no domain controller is specified, the first available will be used. |
Filter |
Optional |
String |
Enables you to limit the returned data by filtering on specific attributes for Microsoft Lync Server 2010. For example, you can limit returned data to contacts whose display names or SIP addresses match a certain wildcard pattern. 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 contacts that have been enabled for Enterprise Voice would look like this: {EnterpriseVoiceEnabled -eq $True}, with EnterpriseVoiceEnabled representing the Active Directory attribute, -eq representing the comparison operator (equal to), and $True (a built-in Windows PowerShell variable) representing the filter value. |
OU |
Optional |
OUIdParameter |
The organizational unit (OU) in which the endpoint resides. |
PoolFqdn |
Optional |
String |
The fully qualified domain name (FQDN) of the pool on which the application endpoint resides. |
ResultSize |
Optional |
Unlimited |
The maximum number of endpoint records to retrieve. |
Input Types
String. Accepts a pipelined string value representing the Identity of the application endpoint.
Return Types
Retrieves an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact.
Example
-------------------------- Example 1 ------------------------
Get-CsApplicationEndpoint
This example retrieves information about all application endpoints defined within the Lync Server 2010 deployment.
-------------------------- Example 2 ------------------------
Get-CsApplicationEndpoint -Identity "Call Park Service Contact"
Example 2 retrieves information about the application endpoint contact with the display name “Call Park Service Contact”.
-------------------------- Example 3 ------------------------
Get-CsApplicationEndpoint -Filter {DisplayName -like "*endpoint*"}
Example 3 retrieves all application endpoints that have the string “endpoint” anywhere within their display name. To do this, the command uses the Filter parameter. The value of the parameter filters to find endpoint objects that have a display name (DisplayName) that contains (-like) the string endpoint (*endpoint* - the wildcard characters indicate that any characters can come before or after the string endpoint, meaning endpoint can be anywhere within the display name).
-------------------------- Example 4 ------------------------
Get-CsApplicationEndpoint -ApplicationId tapp2 | Select-Object Identity, SipAddress, DisplayName, OwnerUrn
Example 4 will return all application endpoints associated with the application urn:application:tapp2. This is accomplished by passing the ID tapp2 to the ApplicationId parameter. Notice that we didn’t supply a pool FQDN; this means that if an application with the ID tapp2 exists on more than one pool, endpoints for all those applications will be retrieved. The next part of this command pipes the returned object or objects to the Select-Object cmdlet, which displays only the Identity, SipAddress, DisplayName, and OwnerUrn properties of those objects.