Get-CsTrunkConfiguration
Topic Last Modified: 2012-08-13
Retrieves one or more trunk configurations, which describe the settings for a trunking peer entity such as a public switched telephone network (PSTN) gateway, IP-private branch exchange (PBX), or Session Border Controller (SBC) at the service provider. This cmdlet was introduced in Lync Server 2010.
Get-CsTrunkConfiguration [-Identity <XdsIdentity>] <COMMON PARAMETERS>
Get-CsTrunkConfiguration [-Filter <String>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-LocalStore <SwitchParameter>]
This example retrieves all trunk configurations for the Lync Server deployment.
Get-CsTrunkConfiguration
This example retrieves the trunk configuration with the Identity site:Redmond. Because identities are unique, this command will return at most one object.
Get-CsTrunkConfiguration -Identity site:Redmond
Example 3 retrieves all trunk configurations defined at the site level. The Get-CsTrunkConfiguration cmdlet uses the Filter parameter to retrieve all trunk configurations with an Identity beginning with site:, meaning all trunk configurations defined at the site level.
Get-CsTrunkConfiguration -Filter site:*
Use this cmdlet to retrieve one or more trunking configurations applicable to PSTN gateway entities. Each configuration contains specific settings for a trunking peer entity such as a PSTN gateway, IP-PBX, or SBC at the service provider. These settings configure such things as whether media bypass is enabled on this trunk, whether real-time transport control protocol (RTCP) packets are sent under certain conditions, and whether to require secure real-time protocol (SRTP) encryption.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsTrunkConfiguration cmdlet locally: RTCUniversalUserAdmins, RTCUniversalServerAdmins. 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-CsTrunkConfiguration"}
| Parameter | Required | Type | Description |
|---|---|---|---|
| Filter | Optional | System.String | This parameter accepts a wildcard string and returns all trunk configurations with identities matching that string. For example, a Filter value of site:* will return all trunk configurations defined at the site level. |
| Identity | Optional | Microsoft.Rtc.Management.Xds.XdsIdentity | The unique identifier of the trunk configuration you want to retrieve. Trunk configurations can be defined at the Global scope, the Site scope, or at the Service scope for a PSTN Gateway service. For example, site:Redmond (for site) or PstnGateway:Redmond.litwareinc.com (for service). |
| LocalStore | Optional | System.Management.Automation.SwitchParameter | Retrieves the trunk configuration from the local replica of the Central Management store, rather than the Central Management store itself. |
None.
This cmdlet returns an object of type Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration.
