New-CsPresenceProvider
Authorizes a new presence provider for use in the organization. Presence providers represent the PresenceProviders property of a collection of user services configuration settings. This cmdlet was introduced in Lync Server 2013.
Syntax
ParentAndRelativeKey
New-CsPresenceProvider
-Fqdn <String>
-Parent <String>
[-Confirm]
[-Force]
[-InMemory]
[-WhatIf]
[<CommonParameters>]
Identity
New-CsPresenceProvider
[-Identity] <XdsIdentity>
[-Confirm]
[-Force]
[-InMemory]
[-WhatIf]
[<CommonParameters>]
Description
The CsPresenceProvider cmdlets are used to manage the PresenceProviders property found in the User Services configuration settings. Among other things, these settings are used to maintain presence information, including a collection of authorized presence providers. That collection is stored in the PresenceProviders property. You can use the New-CsPresenceProvider cmdlet to add an authorized presence provider to a collection of User Services configuration settings.
Skype for Business Server Control Panel: The functions carried out by the New-CsPresenceProvider cmdlet are not available in the Skype for Business Server Control Panel.
Examples
Example 1
New-CsPresenceProvider -Parent "global" -Fqdn "fabrikam.com"
The command shown in Example 1 creates a new presence provider (with the fully qualified domain name "fabrikam.com") that will be added to the global collection of user services configuration settings.
Example 2
Get-CsUserServicesConfiguration | ForEach-Object {New-CsPresenceProvider -Parent $_.Identity -Fqdn "fabrikam.com"}
Example 2 adds a presence provider with the Fqdn "fabrikam.com" to all the user services configuration collections in the organization. To do this, the command first uses the Get-CsUserServicesConfiguration cmdlet to return a collection of all the user services settings. Those settings are then piped to the ForEach-Object, which takes each item in the collection and a creates a new presence provider for that collection, using "fabrikam.com" as the presence provider Fqdn and the Identity of the user services collection as the presence provider Parent.
Parameters
-Confirm
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Prompts you for confirmation before executing the command.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Suppresses the display of any non-fatal error message that might occur when running the command.
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 |
-Fqdn
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Fully qualified domain name for the presence provider. For example:
-Fqdn "fabrikam.com"
If you use the Fqdn parameter you must also use the Parent parameter. However, the Fqdn parameter cannot be used in the same command as the Identity parameter.
Note that FQDNs must be unique at a given scope.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ParentAndRelativeKey
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Unique identifier for the new presence provider. The Identity of a presence provider is composed of two parts: the scope (Parent) where the rule has been applied (for example, service:UserServer:atl-cs-001.litwareinc.com) and the provider's fully qualified domain name. To create a new provider at the global scope use syntax similar to this:
-Identity "global/fabrikam.com"
To create a provider at the site scope, use syntax like this:
-Identity "site:Redmond/fabrikam.com"
To create a provider at the service scope (for the UserServer service only), use syntax similar to this:
-Parent "UserServer:atl-cs-001.litwareinc.com"
You cannot use the Identity parameter in the same command as the Fqdn or the Parent parameter.
Parameter properties
| Type: | XdsIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Identity
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InMemory
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet.
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 |
-Parent
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Scope where the new presence provider will be created. To create a new presence provider at the global scope, use syntax similar to this:
-Parent "global"
To create a new provider at the site scope use syntax like this:
-Parent "site:Redmond"
To create a provider at the service scope (for the UserServer service only), use syntax similar to this:
-Parent "UserServer:atl-cs-001.litwareinc.com"
If you use the Parent parameter you must also include the Fqdn parameter. However, the Parent parameter cannot be used in conjunction with the Identity parameter.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ParentAndRelativeKey
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Describes what would happen if you executed the command without actually executing the command.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
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.
Inputs
None
The New-CsPresenceProvider cmdlet does not accept pipelined input.
Outputs
Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PresenceProvider
The New-CsPresenceProvider cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PresenceProvider#Decorated object.