Modifier

Test-CsExStorageConnectivity

  • Reference
Module:
SkypeForBusiness
Applies to:
Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Verifies that the Skype for Business Server Storage Service is working on a Front End Server. This is done by creating a test email message in the specified Exchange mailbox and then optionally deleting that message at the end of the text. Test-CsExStorageConnectivity also verifies that Exchange archiving is working as expected. This cmdlet was introduced in Lync Server 2013.

Syntax

Test-CsExStorageConnectivity
    [-SipUri] <String>
    [-Binding <String>]
    [-DeleteItem]
    [-Folder <ExchFolder>]
    [-Force]
    [-HostNameStorageService <String>]
    [-UseCache]
    [<CommonParameters>]

Description

The Test-CsExStorageConnectivity cmdlet is used to verify that server-to-server authentication is working between Skype for Business Server and Exchange. To verify server-to-server authentication, the cmdlet logs on to Exchange writes an item to the Conversation History folder in the specified mailbox, and then deletes that item.

The Test-CsExStorageConnectivity cmdlet can also be used to verify that connections can be made to the archiving store on Exchange.

If you receive an "Access Denied" error message when running this cmdlet that typically means that you are not a member of the local group RTC Local User Administrators. You can either be added to that group or to the Active Directory group RTCUniversalUserAdmins (which is a member of the RTC Local User Administrators) in order to get the required permissions to run the Test-CsExStorageConnectivity cmdlet.

Skype for Business Server Control Panel: The functions carried out by the Test-CsExStorageConnectivity cmdlet are not available in the Skype for Business Server Control Panel.

Examples

-------------------------- Example 1 --------------------------

Test-CsExStorageConnectivity -SipUri "sip:kenmyer@litwareinc.com" -Binding "NetNamedPipe"

The command shown in Example 1 tests to see if the Skype for Business Server Storage Service can connect to the Exchange mailbox for the user sip:kenmyer@litwareinc.com. In this example, NetNamedPipe is used as the WCF binding.

-------------------------- Example 2 --------------------------

Test-CsExStorageConnectivity -SipUri "sip:kenmyer@litwareinc.com" -Binding "NetNamedPipe" -Folder Dumpster

Example 2 verifies that the Skype for Business Server Storage Service can connect to the archiving store on Exchange. (Note that this command will fail if the specified user has not been enabled for Exchange archiving.) In this example, a connection is made to the Dumpster folder: the Recoverable Items purge folder, a folder that stores deleted items and is not visible to end users.

Parameters

-Binding

Windows Communication Foundation (WCF) binding. A WCF binding determines the transport, encoding, and protocol details required for clients and services to communicate with each other. valid values are:

NetNamedPipe

NetTCP

Type:String
Aliases:b
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-DeleteItem

When present, the test item will be deleted from the Exchange mailbox at the end of the text.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-Folder

Specifies the Exchange archiving folder that the cmdlet should connect to. Allowed values are:

ConversationHistory

Inbox

Dumpster

Type:ExchFolder
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-Force

Suppresses the display of any non-fatal error message that might arise when running the command.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-HostNameStorageService

Fully qualified domain name (FQDN) of the server where the Skype for Business Server Storage Service is running. This parameter is required if the Binding is set to NetTCP.

Type:String
Aliases:h
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-SipUri

SIP address of the Exchange mailbox where the test item should be created.

Type:String
Aliases:s
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-UseCache

When presents, instructs the cmdlet to used cached auto discovery results when attempting to connect to Exchange.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Inputs

None. The Test-CsExStorageConnectivity cmdlet does not accept pipelined input.

Outputs

The Test-CsExStorageConnectivity cmdlet returns instances of the Microsoft.Rtc.Management.ResourceData object.