Set-CsConferenceDisclaimer
Topic Last Modified: 2012-03-25
Modifies the property values of the conference disclaimer used in your organization. The conference disclaimer is a message displayed to users who join a conference by using a hyperlink (for example, by pasting a link to the conference into a browser such as Windows Internet Explorer).
Syntax
Set-CsConferenceDisclaimer [-Identity <XdsIdentity>] [-Body <String>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Header <String>] [-WhatIf [<SwitchParameter>]]
Set-CsConferenceDisclaimer [-Body <String>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Header <String>] [-Instance <PSObject>] [-WhatIf [<SwitchParameter>]]
Detailed Description
When configuring conferencing settings, administrators can include a legal disclaimer to display to participants when they join conferences hosted by Microsoft Lync Server 2010. This disclaimer is typically used to explain legal and intellectual property laws regarding the conference. Users cannot join the conference without agreeing to the stipulations set forth in the disclaimer. Note, however, that this disclaimer is only shown to users who join a conference by using a hyperlink.
Lync Server 2010 allows for a single, global instance of the conference disclaimer. The Set-CsConferenceDisclaimer cmdlet enables you to modify the conference disclaimer used in your organization.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsConferenceDisclaimer cmdlet locally: 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 "Set-CsConferenceDisclaimer"}
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Optional |
Xds Identity |
Unique Identity of the conference disclaimer. Because you can only have a single, global instance of the conference disclaimer, you do not need to specify an Identity when calling Set-CsConferenceDisclaimer. However, you can use the following syntax to reference the global disclaimer: -Identity global. |
Instance |
Optional |
ConferenceDisclaimer object |
Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. |
Body |
Optional |
String |
Contents of the conference disclaimer. |
Header |
Optional |
String |
Title given the conference disclaimer. |
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might occur when running the command. |
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Optional |
Switch Parameter |
Prompts you for confirmation before executing the command. |
Input Types
Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConferenceDisclaimer object. Set-CsConferenceDisclaimer accepts pipelined input of conference disclaimer objects.
Return Types
Set-CsConferenceDisclaimer does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConferenceDisclaimer object.
Example
-------------------------- Example 1 ------------------------
Set-CsConferenceDisclaimer -Header "Litwareinc.com Online Conference" -Body "Important note: Conferencing proceedings are recorded and archived."
The command shown in Example 1 modifies both the Header and Body properties for your organization’s conference disclaimer. Because you can have only one such disclaimer, you do not need to specify the Identity when running the Set-CsConferenceDisclaimer cmdlet.