Export (0) Print
Expand All
Expand Minimize

Set-CsConferencingPolicy

 

Topic Last Modified: 2012-10-18

Modifies an existing conferencing policy. Conferencing policies determine the features and capabilities that can be used in a conference; this includes everything from whether or not the conference can include IP audio and video to the maximum number of people who can attend a meeting.

Set-CsConferencingPolicy [-Identity <XdsIdentity>] [-AllowAnnotations <$true | $false>] [-AllowAnonymousParticipantsInMeetings <$true | $false>] [-AllowAnonymousUsersToDialOut <$true | $false>] [-AllowConferenceRecording <$true | $false>] [-AllowExternalUserControl <$true | $false>] [-AllowExternalUsersToRecordMeeting <$true | $false>] [-AllowExternalUsersToSaveContent <$true | $false>] [-AllowIPAudio <$true | $false>] [-AllowIPVideo <$true | $false>] [-AllowParticipantControl <$true | $false>] [-AllowPolls <$true | $false>] [-AllowUserToScheduleMeetingsWithAppSharing <$true | $false>] [-AppSharingBitRateKb <Int64>] [-AudioBitRateKb <UInt32>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-EnableAppDesktopSharing <None | SingleApplication | Desktop>] [-EnableDataCollaboration <$true | $false>] [-EnableDialInConferencing <$true | $false>] [-EnableFileTransfer <$true | $false>] [-EnableP2PFileTransfer <$true | $false>] [-EnableP2PRecording <$true | $false>] [-EnableP2PVideo <$true | $false>] [-FileTransferBitRateKb <Int64>] [-Force <SwitchParameter>] [-MaxMeetingSize <UInt32>] [-MaxVideoConferenceResolution <CIF | VGA>] [-VideoBitRateKb <Int64>] [-WhatIf [<SwitchParameter>]]
Set-CsConferencingPolicy [-AllowAnnotations <$true | $false>] [-AllowAnonymousParticipantsInMeetings <$true | $false>] [-AllowAnonymousUsersToDialOut <$true | $false>] [-AllowConferenceRecording <$true | $false>] [-AllowExternalUserControl <$true | $false>] [-AllowExternalUsersToRecordMeeting <$true | $false>] [-AllowExternalUsersToSaveContent <$true | $false>] [-AllowIPAudio <$true | $false>] [-AllowIPVideo <$true | $false>] [-AllowParticipantControl <$true | $false>] [-AllowPolls <$true | $false>] [-AllowUserToScheduleMeetingsWithAppSharing <$true | $false>] [-AppSharingBitRateKb <Int64>] [-AudioBitRateKb <UInt32>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-EnableAppDesktopSharing <None | SingleApplication | Desktop>] [-EnableDataCollaboration <$true | $false>] [-EnableDialInConferencing <$true | $false>] [-EnableFileTransfer <$true | $false>] [-EnableP2PFileTransfer <$true | $false>] [-EnableP2PRecording <$true | $false>] [-EnableP2PVideo <$true | $false>] [-FileTransferBitRateKb <Int64>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-MaxMeetingSize <UInt32>] [-MaxVideoConferenceResolution <CIF | VGA>] [-VideoBitRateKb <Int64>] [-WhatIf [<SwitchParameter>]]

Conferencing is an important part of Microsoft Lync Server 2010: conferencing enables groups of users to come together online to view slides and video, share applications, exchange files, and otherwise communicate and collaborate.

It’s important for administrators to maintain control over conferences and conference settings. In some cases, there might be security concerns: by default, anyone, including unauthenticated users, can participate in meetings and save any of the slides or handouts distributed during those meetings. In other cases, there might be bandwidth concerns: having a multitude of simultaneous meetings, each involving hundreds of participants and each featuring video feeds and file sharing, has the potential to cause problems with your network. In addition, there might be occasional legal concerns. For example, by default meeting participants are allowed to make annotations on shared content; however, these annotations are not saved when the meeting is archived. If your organization is required to keep a record of all electronic communication, you might want to disable annotations.

Of course, needing to manage conferencing settings is one thing; actually managing these settings is another. In Lync Server 2010 conferences are managed by using conferencing policies. (In previous versions of the software, these were known as meeting policies.) As noted, conferencing policies determine the features and capabilities that can be used in a conference, including everything from whether or not the conference can include IP audio and video to the maximum number of people who can attend a meeting. Conferencing policies can be configured at the global scope; at the site scope; or at the per-user scope. This provides administrators with enormous flexibility when it comes to deciding which capabilities will be made available to which users.

Policy property values can be configured at the time a policy is created. In addition to that, you can, at any time, use the Set-CsConferencingPolicy cmdlet to modify the property values of an existing policy.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsConferencingPolicy 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-CsConferencingPolicy"}

 

Parameter Required Type Description

Identity

Optional

Xds Identity

Unique identifier for the conferencing policy to be modified. Conferencing policies can be configured at the global, site, or per-user scopes. To modify the global policy, use this syntax: -Identity global. To modify a site policy, use syntax similar to this: -Identity site:Redmond. To modify a per-user policy, use syntax similar to this: -Identity SalesConferencingPolicy.

Note that wildcards are not allowed when specifying an Identity. If you do not specify an Identity Set-CsConferencingPolicy will automatically modify the global conferencing policy.

Instance

Optional

Meeting Policy object

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

AllowAnnotations

Optional

Boolean

Indicates whether or not participants are allowed to make on-screen annotations on any content shared during the meeting; in addition, this setting determines whether or not whiteboarding is allowed in the conference. The default value is True.

Note that annotations are not archived along with other meeting content.

This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will include annotations. However, the user can participate in other conferences where annotations are allowed.

AllowAnonymousParticipantsInMeetings

Optional

Boolean

Indicates whether anonymous users are allowed to participate in the meeting. If set to False then only authenticated users (that is, users logged on to your Active Directory Domain Services (AD DS) or the Active Directory of a federated partner) are allowed to attend the meeting. The default value is True.

This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow anonymous participants. However, the user can take part in other conferences where anonymous participants are allowed.

AllowAnonymousUsersToDialOut

Optional

Boolean

Indicates whether or not anonymous users (for example, unauthenticated users) are allowed to join a conference using dial-out phoning. With dial-out phoning the conferencing server will telephone the user; when the user answers the phone, he or she will be joined to the conference.

Note that dial-in conferencing is allowed even when this setting is False.

This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow anonymous participants to join the conference by dialing out; however, the user can take part in other conferences where anonymous users can join by dialing out.

The default value is False ($False).

AllowConferenceRecording

Optional

Boolean

Indicates whether users are allowed to record the meeting. The default value is False.

This setting applies to all users taking part in the conference.

AllowExternalUserControl

Optional

Boolean

Indicates whether external users (either anonymous users or federated) are allowed to take control of shared applications or desktops. The default value is False.

This setting is enforced at the per-user level, and for both conferences and peer-to-peer communication sessions. That means that some users in a session might be allowed to give up control of a shared application or desktop to an external user while other users might not be allowed to give up control.

AllowExternalUsersToRecordMeeting

Optional

Boolean

Indicates whether external users (either anonymous users or federated users) are allowed to record the meeting. The default value is False.

This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow external users to record conferences. However, the user can take part in other conferences where external users are allowed to record.

Note that this setting takes effect only if the AllowConferenceRecording property is set to True.

AllowExternalUsersToSaveContent

Optional

Boolean

Indicates whether external users (that is, users not currently logged-on to your network) are allowed to save handouts, slides, and other meeting content. The default value is True.

This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow external users to save content. However, the user can take part in other conferences where external users are allowed to save content.

AllowIPAudio

Optional

Boolean

Indicates whether or not computer audio is allowed in the meeting. The default value is True.

This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow IP audio. However, the user can take part in other conferences where IP audio is allowed.

AllowIPVideo

Optional

Boolean

Indicates whether or not computer video is allowed in the meeting. The default value is True.

This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow IP video. However, the user can take part in other conferences where IP video is allowed.

AllowParticipantControl

Optional

Boolean

Indicates whether or not meeting participants are allowed to take control of applications or desktops shared during the meeting. The default value is True.

This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow participant control. However, the user can take part in other conferences where participant control is allowed.

AllowPolls

Optional

Boolean

Indicates whether or not users are allowed to conduct online polls during a meeting. The default value is True.

This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow polls. However, the user can take part in other conferences where polls are allowed.

AllowUserToScheduleMeetingsWithAppSharing

Optional

Boolean

Indicates whether or not users are allowed to organize meetings that include application sharing. The default value is True.

This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow application sharing. However, the user can take part in other conferences where application sharing is allowed.

AppSharingBitRateKB

Optional

Integer

Bit rate (in kilobytes) used for application sharing. The default value is 50000.

AudioBitRateKB

Optional

Integer

Bit rate (in kilobits) used for audio transmissions. The audio bit rate can be any whole number between 20 and 200, inclusive; the default value is 200.

This setting is enforced at the per-user level, and for both conferences and peer-to-peer communication sessions.

Description

Optional

String

Enables administrators to provide additional text about the conferencing policy. For example, the Description might indicate the users the policy should be assigned to.

EnableAppDesktopSharing

Optional

PSListModifier

Indicates whether participants are allowed to share applications (or their desktop) during the course of a meeting. Allowed values include:

Desktop. Users are allowed to share their entire desktop.

SingleApplication. Users are allowed to share a single application.

None. Users are not allowed to share applications or their desktop.

This setting is enforced at the per-user level. That means that some users in a conference might be allowed to share their desktop or applications while other users in the same conference might not be allowed to do so.

The default value is Desktop.

EnableDataCollaboration

Optional

Boolean

Indicates whether users can organize meetings that include data collaboration activities such as whiteboarding and annotations.

This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow data collaboration. However, the user can take part in other conferences where data collaboration is allowed.

EnableDialInConferencing

Optional

Boolean

Indicates whether users are able to join the meeting by dialing in with a public switched telephone network (PSTN) telephone. The default value is True.

This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow dial-in conferencing. However, the user can take part in other conferences where dial-in conferencing is allowed.

EnableFileTransfer

Optional

Boolean

Indicates whether file transfers to all the meeting participants are allowed during the meeting. The default value is True.

This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow file transfers. However, the user can take part in other conferences where file transfers are allowed.

EnableP2PFileTransfer

Optional

Boolean

Indicates whether peer-to-peer file transfers (that is, file transfers that do not involve all participants) are allowed during the meeting. The default value is True ($True).

This setting is enforced at the per-user level. That means that one user in a peer-to-peer communication session might be allowed to transfer files while the other user is not.

EnableP2PRecording

Optional

Boolean

If True, users will be able to record peer-to-peer conferencing sessions. The default value is False.

This setting is enforced at the per-user level. That means that one user in a peer-to-peer communication session might be allowed to record the session while the other user is not.

EnableP2PVideo

Optional

Boolean

If True, users will be able to take part in peer-to-peer video conferencing sessions. The default value is False.

This setting is enforced at the per-user level. That means that one user in a peer-to-peer communication session might be allowed to use video while the other user is not.

FileTransferBitRateKB

Optional

Integer

Bit rate (in kilobytes) used for file transfers. The default value is 50000.

MaxMeetingSize

Optional

Integer

Indicates the maximum number of people who are allowed to attend a meeting. After the maximum number of participants has been reached anyone else who tries to join the meeting will be turned away with the notice that the meeting is full. The number of participants specified in this value can be any 32-bit whole number (any value between 1 and 4,294,967,295), but the recommended size is between 2 and 250, inclusive; the default value is 250.

noteNote:
250 is the maximum for shared pool deployments, based on Microsoft testing. For information about supporting meeting with more than 250 participants, see "Microsoft Lync Server 2010 Support for Large Meetings" at http://go.microsoft.com/fwlink/p/?LinkId=242073.

This setting applies to the user who organizes the conference: no conference created by a user affected by this policy will allow more than the specified number of participants. However, the user can take part in other conferences where additional participants are allowed.

MaxVideoConferenceResolution

Optional

PSListModifier

Indicates the maximum resolution for meeting video. Allowed values are:

CIF. Common Intermediate Format (CIF) has a resolution of 352 pixels by 288 pixels.

VGA. VGA has a resolution of 640 pixels by 480 pixels.

The default value is VGA.

VideoBitRateKB

Optional

Integer

Bit rate (in kilobits) used for video transmissions. The default value is 50000.

This setting is enforced at the per-user level, and for both conferences and peer-to-peer communication sessions.

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.

Microsoft.Rtc.Management.WritableConfig.Policy.Meeting.MeetingPolicy object. Set-CsConferencingPolicy accepts pipelined instances of the meeting policy object.

Set-CsConferencingPolicy does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Meeting.MeetingPolicy object.

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

Set-CSConferencingPolicy -Identity SalesConferencingPolicy -AllowConferenceRecording $False

The preceding command modifies a property value of the conferencing policy SalesConferencingPolicy; in particular, the command sets the value of the AllowConferenceRecording property to False. To do this, Set-CsConferencingPolicy is called along with the Identity parameter and the AllowConferenceRecording parameter.

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

Get-CSConferencingPolicy | Set-CSConferencingPolicy -AllowAnonymousParticipantsInMeetings $False -EnableDialInConferencing $False

In Example 2, the same two property values -- AllowAnonymousParticipantsInMeetings and EnableDialInConferencing -- are modified for all the conferencing policies configured for use in the organization. To do this, the command first uses Get-CsConferencingPolicy to return a collection of all the available conferencing policies. That collection is then piped to Set-CsConferencingPolicy, which sets the value of both the AllowAnonymousParticipantsInMeetings and EnableDialInConferencing properties to False for each policy in the collection.

-------------------------- Example 3 --------------------------

Get-CSConferencingPolicy -Filter "site:*" | Set-CSConferencingPolicy  -MaxVideoConferenceResolution CIF

The command shown in Example 3 modifies the MaxVideoConferenceResolution property for all the conferencing policies that have been configured at the site scope. To accomplish this task the command first calls Get-CsConferencingPolicy and the Filter parameter; the filter value "site:*" restricts the returned data to policies configured at the site scope. This filtered collection is then piped to Set-CsConferencingPolicy, which sets the MaxVideoConferenceResolution property for each policy in the collection to "CIF".

-------------------------- Example 4 --------------------------

Get-CSConferencingPolicy | Where-Object {$_.MaxMeetingSize -gt 100} | Set-CSConferencingPolicy -MaxMeetingSize 100 

Example 4 retrieves all the policies where the maximum meeting size is greater than (-gt) 100 and then changes the value of the associated property (MaxMeetingSize) to 100. To do this the command first calls Get-CsConferencingPolicy to return a collection of all the conferencing policies configured for use in the organization. That collection is then piped to the Where-Object cmdlet, which picks out only those policies that have a MaxMeetingSize greater than 100. The filtered collection is then piped to Set-CsConferencingPolicy, which takes each policy in the collection and sets the MaxMeetingSize property to 100.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft