Lync Server 2013 cmdlets by category

Credential

Optional

Enables you to run the Get-CsAdUser 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 user objects.

Identity

Required

Indicates the Identity of the user account to be disabled. User Identities can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 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 display name (for example, Ken Myer). You can also reference a user account by using the Active Directory distinguished name.

Identity

Required

Indicates the Identity of the user account to be enabled for Lync Server. User Identities can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 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 display name (for example, Ken Myer). You can also reference a user account by using the user’s Active Directory distinguished name.

Identity

Optional

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 user principal name (UPN); 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 display name (for example, Ken Myer). You can also reference a user account by using the user’s Active Directory distinguished name.

Identity

Required

Indicates the Identity of the user account to be moved. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 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 display name (for example, Ken Myer). User Identities can also be referenced by using the user’s Active Directory distinguished name.

Identity

Required

UserIdParameter

Indicates the Identity of the user account to be modified. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 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 display name (for example, Ken Myer). User Identities can also be referenced by using the user’s Active Directory distinguished name.

Filter

Optional

Enables you to use wildcard characters in order to return a collection (or collections) of client version configuration settings. To return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity (the only property you can filter for) use this syntax: -Filter *EMEA*.

Filter

Optional

Enables you to use wildcards when specifying the policy (or policies) to be retrieved. For example, this syntax returns all the policies that have been configured at the site scope: -Filter "site:*". This syntax returns all the policies that have been configured at the per-user scope: -Filter "tag:*".

You cannot use both the Filter and the Identity parameters in the same command.

Filter

Optional

Enables you to use wildcard characters when specifying the client version policy rules to be returned. For example, to return all the rules configured for the Redmond site, use this syntax: -Filter "site:Redmond/*".

You cannot use both the Filter and the Identity parameters in the same command.

Filter

Optional

Enables you to use wildcards when specifying the file transfer filter configurations to be returned. For example, to return all the file transfer filter configurations at the site scope, use this syntax: -Filter "site:*". By design, file transfer filter configurations that have an Identity (the only property you can filter for) that begins with the string value "site:" were configured at the site scope.

Filter

Optional

Enables you to use wildcards when specifying the policy (or policies) to be returned. For example, this syntax returns all the presence policies configured at the site scope: -Filter "site:*".

The Filter and Identity parameters cannot be used in the same command.

Filter

Optional

Enables you to use wildcards to return one or more collections of privacy configuration settings. For example, to return all the settings configured at the site scope, you can use this syntax: -Filter "site:*". To return all the settings configured at the service scope, use this syntax: -Filter "service:*".

Identity

Required

Indicates the Identity of the user account to be assigned the presence policy. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 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 display name (for example, Ken Myer). User Identities can also be specified by using the user’s Active Directory distinguished name.

In addition, 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 display name that ends with the string value "Smith".

Confirm

Optional

Prompts you for confirmation before executing the command.

Force

Optional

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

Instance

Optional

Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.

GroupEmailAddress

Required

System.String

Email address of the targeted distribution group. For example: -GroupEmailAddress "FinanceGroup@litwareinc.com".

TargetUri

Required

System.String

Uniform Resource Identifier (URI) of the Group Expansion Web service. For example: -TargetUri "https://atl-cs-001.litwareinc.com/groupexpansion".

Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command.

ReceiverCredential

Required

PSCredential

User credential object for the first of the two user accounts to be tested. The value passed to ReceiverCredential should be an object reference obtained by using the Get-Credential cmdlet. For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y:

$y = Get-Credential "litwareinc\pilar"

You need to supply the user password when running this command.

The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool.

TargetFqdn

Required

String

Fully qualified domain name (FQDN) of the pool to be tested.

ReceiverCredential

Required

PSCredential

User credential object for the first of the two user accounts to be tested. The value passed to ReceiverCredential should be an object reference obtained by using the Get-Credential cmdlet. For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y:

$y = Get-Credential "litwareinc\pilar"

You need to supply the user password when running this command.

The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool.

ReceiverCredential

Required

PSCredential

User credential object for the first of the two user accounts to be tested. The value passed to ReceiverCredential should be an object reference obtained by using the Get-Credential cmdlet. For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y:

$y = Get-Credential "litwareinc\pilar"

You need to supply the user password when running this command.

The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool.

TargetFqdn

Required

String

Fully qualified domain name (FQDN) of the pool to be tested.

PublisherCredential

Required

PSCredential

User credential object for the first of the two user accounts to be tested. The value passed to PublisherCredential should be an object reference obtained by using the Get-Credential cmdlet. For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x:

$x = Get-Credential "litwareinc\kenmyer"

Filter

Optional

Enables you to use wildcards to specify the Identity of the conference directory (or directories) to be retrieved. Because directory Identities are numeric, this parameter might be of minimal value. However, this syntax will return all the conference directories that have an Identity that begins with the number 3: -Filter "3*".

EmptyRegion

Required

Returns information about the dial plans that are associated with a region that is not associated with at least one dial-in conferencing access number. For example, suppose the Bellevue dial plan is associated with the Bellevue region, but no access numbers have been configured for the Bellevue region. The Bellevue region would thus be considered an empty region.

This parameter cannot be used in conjunction with any other parameter.

DomainController

Optional

Enables you to connect to the specified domain controller in order to retrieve contact information. To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-mcs-001) or its fully qualified domain name (for example, atl-mcs-001.litwareinc.com).

Filter

Optional

Provides a way for you to use wildcard characters when specifying dial-in conferencing configuration settings. For example, to return a collection of all the configuration settings that have been applied at the site scope use this syntax: -Filter "site:*". To return all the settings that have the term "EMEA" in their Identity use this syntax: -Filter "*EMEA*". Note that the Filter parameter acts only on the Identity of the settings; you cannot filter on other dial-in conferencing configuration properties.

HomePool

Required

Fully qualified domain name (FQDN) of the Registrar pool where the new conference directory will be hosted. For example: -Identity atl-cs-001.litwareinc.com.

Confirm

Optional

Prompts you for confirmation before executing the command.

WhatIf

Optional

Describes what would happen if you executed the command without actually executing the command.

DisplayNumber

Required

LineURI

Required

The actual dial-in conferencing phone number. The LineURI must be specified using the following syntax: the tel: prefix followed by a plus sign (+) followed by the country/region calling code, area code, and phone number. For example: tel:+18005551234. Note that spaces, hyphens, parentheses and other characters are not allowed.

LineURIs must be unique throughout Active Directory.

PrimaryLanguage

Required

Primary language used for making dial-in conferencing announcements. The language must be configured using one of the available dial-in conferencing language codes; for example, en-US for U.S. English; fr-FR for French; etc. To return a list of the available language codes, type the following command at the Windows PowerShell prompt:

Identity

Required

XdsIdentity

Indicates the Identity of the dial-in conferencing configuration settings to be created. Because these settings can only be created at the site scope, use syntax similar to this, with the prefix "site:" followed by the name of the site: -Identity site:Redmond.

Note that there can only be one set of dial-in conferencing configuration settings per site. The sample command will fail if a collection of settings with the Identity site:Redmond already exists.

EnableNameRecording

Optional

Boolean

Determines whether or not users are asked to record their name before entering the conference. Set to True ($True) to require name recording; set to False ($False) to bypass name recording. The default value is True.

Confirm

Optional

Prompts you for confirmation before executing the command.

EntryExitAnnouncementsEnabledByDefault

Optional

If set to True announcements will be played each time a participant enters or exits a conference. If set to False (the default value), entry and exit announcements will not be played.

Identity

Required

SIP address of the contact object that represents the dial-in conferencing number. When specifying the Identity you must include the "sip:" prefix; for example: -Identity " sip:RedmondDialIn@litwareinc.com".

Priority

Required

Enables you to change the order in which dial-in conferencing numbers are presented to users in meeting invitations or when they access the Dial-In Conferencing Settings webpage. Lower numbers are given a higher priority; to have a number appear at the beginning of the list set the priority to 0. Note that if you change the priority of a given number you must also use the ReorderedRegion parameter to indicate the region where the modified priority should take effect.

TargetFqdn

Required

Fully qualified domain name (FQDN) of the pool to be tested.

Authentication

Optional

Type of authentication used in the test. Allowed values are:

* TrustedServer

* Negotiate

* ClientCertificate

* LiveID

Identity

Required

Indicates the Identity of the user account to be configured as a meeting room. Identities are typically specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 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 display name (for example, Ken Myer).

You can also reference a user account by using the user’s Active Directory distinguished name.

You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. For example, the Identity "* Smith" returns all the user who have a display name that ends with the string value " Smith".

DomainController

Optional

Enables you to connect to the specified domain controller in order to disable a meeting room. To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com).

Identity

Required

Indicates the Identity of the user account to be configured as a meeting room. Identities are typically specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\room14); and, 4) the user's Active Directory display name (for example, Room 14).

You can also reference a user account by using the user’s Active Directory distinguished name.

You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. For example, the Identity "* Smith" returns all the user who have a display name that ends with the string value " Smith".

DomainController

Optional

Enables you to connect to the specified domain controller in order to enable a meeting room. To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com).

Filter

Optional

Enables you to use wildcard characters when specifying the conferencing policy (or policies) to be returned. For example, this syntax returns all the policies configured at the site scope: -Filter "site:*". To return a collection of all the policies configured at the per-user scope, use this syntax: -Filter "tag:*".

Credential

Optional

Enables you to run the Get-CsMeetingRoom 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 by using the Get-Credential cmdlet. For details, see the Get-Credential cmdlet help topic.

Filter

Optional

Enables you to limit the returned data by filtering on Lync Server-specific attributes. For example, you can limit returned data to meeting rooms that have been assigned a specific voice policy, or rooms that have not been assigned a specific voice policy.

The Filter parameter uses much the same Windows PowerShell filtering syntax that is used by the Where-Object cmdlet. For example, a filter that returns only rooms that have been assigned the voice policy RedmondVoicePolicy would look like this:

{VoicePolicy -eq "RedmondVoicePolicy"}

ReceiverCredential

Required

PSCredential

User credential object for the first of the two user accounts to be tested. The value passed to ReceiverCredential should be an object reference obtained by using the Get-Credential cmdlet. For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y:

$y = Get-Credential "litwareinc\pilar"

You need to supply the user password when running this command.

The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool.

TargetFqdn

Required

String

Fully qualified domain name (FQDN) of the pool to be tested.

Force

Optional

SwitchParameter

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

OutVerboseVariable

Optional

String

When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax:

-OutVerboseVariable TestOutput

Do not prepend a $ character when specifying the variable name.

RegistrarPort

Optional

Int32

SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061.

TestJoinLauncher

Optional

SwitchParameter

When present, tests the ability of the Join Launcher to participate in an AV conference. The Join Launcher is used to help users of mobile devices (and, as a result, users of the Mobility Service) take part in conferences.

CentralManagementStoreStatus

Optional

Returns additional information about the current status of the Central Management store, including a list of active replicas and deleted replicas, as well as the location of the Active Master and the File Transfer Agent services.

Filter

Optional

Enables you to use wildcards when specifying the collection (or collections) of User Replicator configuration settings to be returned. For example, this command returns all the settings configured at the service scope: -Filter "service:*".

GlobalCatalog

Optional

Fully qualified domain name of a global catalog server in your domain. This parameter is not required if you are running the Test-CsReplica cmdlet on a computer with an account in your domain.

Report

Optional

Enables you to specify a file path for the log file created when the cmdlet runs. For example:

-Report "C:\Logs\ReplicaTest.html"

Filter

Optional

Enables you to use wildcards when specifying the Identity of the pool (or pools) to be returned. For example, this syntax returns all the pools that have an Identity that ends with the string value ".fabrikam.com": -Filter "*.fabrikam.com".

Note that you cannot use both the Filter and the Identity parameters in the same command.

Filter

Optional

Enables you to use wildcards when specifying the Identity of the site (or sites) to be returned. For example, this syntax returns all the pools that have an Identity that include the string value "Dublin": -Filter "*Dublin*".

Note that you cannot use both Filter and Identity in the same command.

ByteInput

Required

System.Byte[]

Reads topology information from a byte array stored in a variable. This byte array is created by using the ByteInput parameter when calling the Export-CsConfiguration cmdlet.

You cannot use both the ByteInput parameter and the FileName parameter in the same command.

Document

Required

Enables you to publish an XML element rather than an XML file. This XML element must be configured as a System.XML.Linq.XElement object.

FinalizeUninstall

Required

Used only when uninstall Lync Server.After the Central Management Server has been removed, use Publish-CsTopology and the FinalizeUninstall parameter to publish an empty topology. Among other things, this removes all the Active Directory entries for the Central Management Server.

Filter

Optional

Enables you to use wildcard values when referencing a collection of backup service configuration settings. Because you can only have a single, global instance of these settings there is no reason to use the Filter parameter. However, if you prefer you can use the following syntax to reference the global settings:

-Filter "g*"

The preceding syntax returns all the conference backup service configuration settings that have an Identity that begins with the letter "g".

PoolFqdn

Required

Fully qualified domain name of the pool whose backup service status is being checked. For example:

-PoolFqdn "atl-cs-001.litwareinc.com"

Force

Optional

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

PoolFqdn

Required

Fully qualified domain name of the pool being checked. You must supply the FQDN of a pool when calling this cmdlet; for example:

-PoolFqdn "atl-cs-001.litwareinc.com”

Tenant

Required

PARAMVALUE: Guid

Confirm

Optional

Prompts you for confirmation before executing the command.

Type

Optional

Specifies the service type to be returned. Allowed values are:

* All (returns information for all services)

* MCUFactory (returns information for the MCU factory service)

* ConferenceDirectory (returns information for the Conference Directory service)

LYSS (returns information for the Lync Server Storage service)

You can only specify a single type per command.

PoolFqdn

Required

Fully qualified domain name of the pool being backed up. For example:

-SourcePoolFqdn "atl-cs-001.litwareinc.com"

Confirm

Optional

Prompts you for confirmation before executing the command.

Force

Optional

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

Filter

Optional

Enables you to use wildcard characters in order to return a collection (or multiple collections) of Address Book settings. For example, to return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity, use this syntax: -Filter *EMEA*.

Identity

Required

Unique identifier to be assigned to the new collection of Address Book settings. Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond".

EnableFileGeneration

Optional

When set to True (the default value) the Address Book server generates Address Book index files that can be downloaded by clients. When set to False, these index files are not generated. That means that client applications will have to use the Address Book Web Query service when searching for contacts.

Confirm

Optional

Prompts you for confirmation before executing the command.

EnableSearchByDialPad

Optional

When set to True, enables mobile users to use their telephone keypads to search for contacts.

Identity

Optional

Unique identifier assigned to the collection of Address Book settings. To refer to the global settings, use this syntax: -Identity global. To refer to a collection configured at the site scope, use syntax similar to this: -Identity site:Redmond. You cannot use wildcard characters when specifying an Identity.

If this parameter is omitted, then the Set-CsAddressBookConfiguration cmdlet will modify the global settings.

TargetFqdn

Required

String

Fully qualified domain name (FQDN) of the Registrar pool where the Address Book Download Web service is to be tested. For example: -TargetFqdn "atl-cs-001.litwareinc.com".

You cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command.

GlobalSettingsDomainController

Optional

Fully qualified domain name (FQDN) of a domain controller where global settings are stored. If global settings are stored in the Active Directory System container, then this parameter must point to the root domain controller. If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted.

PoolFqdn

Required

Fully qualified domain name of the pool whose database mirroring state is being checked. For example:

-PoolFqdn "atl-cs-001.litwareinc.com"

LocalStore

Optional

Retrieves the backup mirror state from the local replica of the Central Management store rather than from the Central Management store itself.

Identity

Optional

Unique identifier of the user database whose online status is to be returned. For example: -Identity "UserDatabase:atl-sql-001.litwareinc.com".

You cannot use both Identity and RegistrarPool in the same command, nor can you use wildcards with either parameter. If both parameters are omitted the Get-CsUserDatabaseState cmdlet returns information about all the user databases currently in use.

DatabaseType

Required

Type of database being failed over. Valid values are:

* ActiveMonitoring

* Application

* Archiving

* CentralMgmt

* Cls

* Edge

* Lyss

* Monitoring

* PersistentChat

* PersistentChatCompliance

* Provision

* Registrar

* SigninTelemetry

* User

PoolFqdn

Required

Fully qualified domain name of the pool containing the database to be failed over.

ExcludeDatabaseList

Optional

List of databases that should not be failed over. For example:

-ExcludeDatabaseList "LcsCDR"

To prevent multiple databases from being failed over, separate the database names using commas:

-ExcludeDatabaseList "LcsCDR", "LcsLog"

BackupSqlServerFqdn

Optional

Fully qualified domain name of the computer hosting the SQL Server backup database. This parameter is required if you are running the Invoke-CsManagementServerFailover cmdlet in disaster recovery mode.

BackupMirrorSqlInstanceName

Optional

SQL Server instance for the mirror database.

BackupSqlInstanceName

Optional

SQL Server instance for the backup database.

ConfigurationFileName

Optional

Full path to the Lync Server configuration backup file created by running the Export-CsConfiguration cmdlet. This parameter should only be used in a disaster recovery scenario.

Force

Optional

Forces the Central Management Server move even if the existing store is offline; this parameter is required in a disaster recovery scenario. Note that there is the potential for some data loss any time you force the movement of the Central Management Server.

The Force parameter can also be used if your previous attempts at calling the Move-CsManagementServer cmdlet have failed.

CentralManagementDatabase

Required

Tests the configuration of the Central Management database. This parameter cannot be used in conjunction with the ConfiguredDatabases parameter or the DatabaseType parameter.

Force

Optional

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

Filter

Optional

Enables you to use wildcards in order to return one or more collections of Registrar configuration settings. For example, to return all the settings configured at the site scope, use this syntax: -Filter "site:*". To return all the settings configured at the service scope, use this syntax: -Filter "service:*".

PoolFqdn

Required

Fully qualified domain name of the Registrar pool being reset. For example:

-PoolFqdn "atl-cs-001.litwareinc.com"

Force

Optional

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

ArchivingDatabase

Optional

Service Identity of the database used by the Archiving service.

BackupRegistrar

Optional

Service location of the Registrar to be used if this Registrar is not available. For example: -BackupRegistrar "Registrar:dublin-cs-001.litwareinc.com".

EdgeServer

Optional

Service location of the Edge Server to be associated with the Registrar. For example: -EdgeServer "EdgeServer:atl-edge-001.litwareinc.com".

TargetFqdn

Required

String

Fully qualified domain name (FQDN) of the pool to be tested.

ApplicationDatabase

Optional

Returns information about the Application databases used in your organization. Application databases are used by the Application service.

ArchivingDatabase

Optional

Returns information about the Archiving databases used in your organization. Archiving databases store transcripts of instant messaging sessions.

BackupServer

Optional

Returns information about the backup servers used in your organization.

CentralManagementDatabase

Optional

Returns information about the Central Management store used in your organization. The Central Management store maintains configuration information for Lync Server.

Director

Optional

Returns information about the Directors used in your organization. Directors are empowered to handle user requests and user authentication, but do not house user accounts. Directors are typically used to handle requests from external users.

FileStore

Optional

Returns information about the File Stores used in your organization. The File Store is used to maintain Lync Server files, such as audio files used by the Announcement service.

Identity

Optional

Unique identifier of the specific service or server role to be returned. For example: -Identity "Registrar:atl-cs-001.litwareinc.com".

MediaProcessor

Optional

Returns information about the media processor service used in your organization.

MonitoringDatabase

Optional

Returns information about the monitoring databases used in your organization. Monitoring databases store Enterprise Voice phone usage and call quality information.

PersistentChatComplianceDatabase

Optional

Returns information about the databases used for maintaining Persistent Chat compliance information.

PersistentChatServer

Optional

Returns information about the Persistent Chat servers used in your organization.

PstnGateway

Optional

Returns information about the public switched telephone network (PSTN) gateways used in your organization. PSTN gateways translate signals from Enterprise Voice devices to signals that can be understood by PSTN devices, and vice-versa.

TrustedApplicationPool

Optional

Returns information about the trusted application pools used in your organization. Trusted applications pools host computers that run trusted applications.

UserServer

Optional

Returns information about the User Services service used in your organization. The User Services service provides such things as user replication, in-band provisioning, presence publication and notification, and contact card exchange.

WacServer

Optional

Returns information about the Office Web Apps servers used with Microsoft Lync Server. Office Web Apps server was previously known as "WacServer".

ComputerName

Optional

Name of the remote computer hosting the service to be started; if this parameter is not included, then the Start-CsWindowsService cmdlet will start the specified service (or services) on the local computer. The remote computer should be referenced using its FQDN; for example, atl-cs-001.litwareinc.com.

Force

Optional

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

Credential

Optional

Enables you to run the 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 by using the Get-Credential cmdlet. For details, see the Get-Credential cmdlet help topic.

Filter

Optional

Enables you to use wildcard characters when specifying the settings collection (or collections) to be returned. For example, this syntax returns all the settings configured at the site scope: -Filter "site:*".

Note that you cannot use both the Filter and the Identity parameters in the same command.

Filter

Optional

Enables you to use wildcard characters when specifying the health monitoring configuration settings to be retrieved. For example, this syntax returns all the settings configured for the litwareinc.com domain: -Filter "*.litwareinc.com".

Identity

Required

SIP address of the audio test service contact to be modified.

DisplayName

Optional

Active Directory display name of the contact object.

Confirm

Optional

Prompts you for confirmation before executing the command.

FirstTestUserSipUri

Optional

SIP address of the first test user to be configured for use by this collection of health monitoring settings. Note that the SIP address must include the sip: prefix. For example: -FirstTestUserSipUri "sip:kenmyer@litwareinc.com".

Identity

Optional

Fully qualified domain name (FQDN) of the pool where the health monitoring configuration settings to be modified have been assigned. For example: -Identity atl-cs-001.litwareinc.com.

Filter

Optional

There can only be one instance of this object, so this parameter does nothing.

LocalStore

Optional

Retrieves the voice configuration from the local replica of the Central Management store, rather than the Central Management store itself.

Filter

Optional

This parameter provides a way to do a wildcard search of the defined voice test configurations. (For details, see the examples in this topic.)

LocalStore

Optional

Retrieves the voice test configuration from the local replica of the Central Management store, rather than the Central Management store itself.

Identity

Required

A string uniquely identifying this test scenario.

This string can be up to 32 characters in length and may contain any alphanumeric characters plus the backslash (\), period (.) or underscore (_).

The value of this parameter does not include scope because this object can be created only at the global scope. Therefore only a unique name is required.

Confirm

Optional

Prompts you for confirmation before executing the command.

Identity

Required

The scope of the voice configuration to remove. This value must be Global.

Force

Optional

Suppresses any confirmation prompts that would otherwise be displayed before making changes.

DialedNumber

Required

PhoneNumber

The phone number against which you want to test the dial plan specified in the Dialplan parameter.

Full Data Type: Microsoft.Rtc.Management.Voice.PhoneNumber

DialedNumber

Required

The phone number against which you want to test the normalization rule specified in the NormalizationRule parameter.

Full Data Type: Microsoft.Rtc.Management.Voice.PhoneNumber

TargetNumber

Required

PhoneNumber

The phone number against which to run the test. This number should be in E.164 format (such as +14255551212).

Force

Optional

SwitchParameter

Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet.

Route

Required

An object containing a reference to the voice route against which you want to test the number specified in the TargetNumber parameter. You can retrieve a voice route object by calling the Get-CsVoiceRoute cmdlet.

Full Data Type: Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route

DialedNumber

Required

The phone number to test.

Full data type: Microsoft.Rtc.Management.Voice.PhoneNumber

Filter

Optional

Uses wildcard strings to return a collection of normalization rules based on Identity. Note that Filter works only on the scope portion of the Identity, not on the name. For example, the filter value *lob* will return all rules at the global scope (scopes that contain the letters lob), but not a rule with the identity site:Redmond/lobby, where lob is only in the name portion of the identity, not the scope.

Confirm

Optional

Prompts you for confirmation before executing the command.

Force

Optional

Suppresses any confirmation prompts that would otherwise be displayed before making changes.

DialedNumber

Required

The phone number against which you want to test the normalization rule specified in the NormalizationRule parameter.

Full Data Type: Microsoft.Rtc.Management.Voice.PhoneNumber

Filter

Optional

Performs a wildcard search that allows you to narrow down your results to only dial plans with identities that match the given wildcard string.

Filter

Optional

The Filter parameter allows you to retrieve only those PSTN usages with an Identity matching a particular wildcard string. However, the only Identity available to PSTN usages is Global, so this parameter is not useful for this cmdlet.

Filter

Optional

This parameter accepts a wildcard string and returns all voice policies with identities matching that string. For example, a Filter value of site:* will return all voice policies defined at the site level.

LocalStore

Optional

Retrieves the voice policy from the local replica of the Central Management store, rather than the Central Management store itself.

City

Optional

This parameter is not used with this cmdlet.

CountryCode

Optional

This parameter is not used with this cmdlet.

Confirm

Optional

Prompts you for confirmation before executing the command.

Identity

Optional

The scope at which these settings are applied. The Identity for this cmdlet is always Global.

Usage

Optional

Contains a list of allowable usage strings. These entries can be any string value.

AllowCallForwarding

Optional

Boolean

If this parameter is set to True, users assigned to this policy can forward calls. If this parameter is set to False, calls cannot be forwarded.

AllowSimulRing

Optional

Boolean

Simultaneous ring is a feature that allows multiple phones to ring when a single number is dialed. Setting this parameter to True enables simultaneous ring. If this parameter is set to False, simultaneous ring cannot be configured for any user assigned to this policy.

DialedNumber

Required

PhoneNumber

The phone number against which you want to test the dial plan specified in the Dialplan parameter.

Full Data Type: Microsoft.Rtc.Management.Voice.PhoneNumber

Filter

Optional

The Filter parameter allows you to retrieve only those PSTN usages with an Identity matching a particular wildcard string. However, the only Identity available to PSTN usages is Global, so this parameter is not useful for this cmdlet.

Filter

Optional

There can be only one instance of this object, so this parameter does nothing.

Filter

Optional

This parameter filters the results of the Get operation based on the wildcard value passed to this parameter.

Confirm

Optional

Prompts you for confirmation before executing the command.

Identity

Optional

The scope at which these settings are applied. The Identity for this cmdlet is always Global.

Usage

Optional

Contains a list of allowable usage strings. These entries can be any string value.

Route

Required

An object containing a reference to the voice route against which you want to test the number specified in the TargetNumber parameter. You can retrieve a voice route object by calling the Get-CsVoiceRoute cmdlet.

Full Data Type: Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route