Get-CsHybridPSTNAppliance
Use the Get-CsHybridPSTNAppliance cmdlet to retrieve information about your Skype for Business Cloud Connector Edition appliances.
Note: This cmdlet will be deprecated from Teams PowerShell Module.
Syntax
Default (Default)
Get-CsHybridPSTNAppliance
[-Name <String>]
[-LocalStore]
[[-Identity] <XdsGlobalRelativeIdentity>]
[-Tenant <Guid>]
[-Filter <String>]
[-SiteName <String>]
[<CommonParameters>]
Description
Skype for Business Cloud Connector Edition appliances are registered, retrieved, modified, and unregistered by the CsHybridPSTNAppliance cmdlet group (Register, Get, Set, and Unregister). The Skype for Business Cloud Connector Edition appliances can be reviewed in your hybrid configuration by using the Get-CsTenantHybridConfiguration cmdlet. However, you can't create or modify Skype for Business Cloud Connector Edition appliances through the CsTenantHybridConfiguration cmdlets. You must use the CsHybridPSTNAppliance cmdlets to manage Skype for Business Cloud Connector Edition appliances.
To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has been assigned, run the following command:
Get-CsAdminRole | Where-Object {$_.Cmdlets -Match "<CmdletName>"}
Examples
Example 1
Get-CsHybridPSTNAppliance
The command shown in Example 1 returns information for all the Skype for Business Cloud Connector Edition appliances.
Example 2
Get-CsHybridPSTNAppliance -SiteName "SeattlePSTN"
The command shown in Example 2 returns information for all the Skype for Business Cloud Connector Edition appliances in the given site.
Example 3
Get-CsHybridPSTNAppliance -Name "CCE1"
The command shown in Example 3 returns information for the Skype for Business Cloud Connector Edition appliance with the given name.
Example 4
Get-CsHybridPSTNAppliance -SiteName "SeattlePSTN" -Name "CCE1"
The command shown in Example 4 returns information for the Skype for Business Cloud Connector Edition appliance in the given site with the given name.
Parameters
-Filter
Applicable: Skype for Business Online
This parameter accepts a wildcard string and returns all hybrid PSTN appliances with identities matching that string. For example, a Filter value of "CCE*" will return all appliances which start with the string "CCE".
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: Skype for Business Online
Specifies the identity of the Skype for Business Cloud Connector Edition appliance.
Parameter properties
| Type: | XdsGlobalRelativeIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-LocalStore
Applicable: Skype for Business Online
This parameter is reserved for internal Microsoft use
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Applicable: Skype for Business Online
Name of Skype for Business Cloud Connector Edition appliance.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SiteName
Applicable: Skype for Business Online
Name of Skype for Business Cloud Connector Edition site that the appliance belongs to.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Tenant
Applicable: Skype for Business Online
Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example:
-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"
You can return your tenant ID by running this command:
Get-CsTenant | Select-Object DisplayName, TenantID
If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment.
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.