[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Modifies an existing conferencing policy. Conferencing policies determine the features and capabilities that can be used in a Web 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.

Syntax

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>]]

Parameters

Parameter Required Type Description

Identity

Optional

XdsIdentity

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 then 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.

AllowIPAudio

Optional

Boolean

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

AllowIPVideo

Optional

Boolean

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

AllowParticpantControl

Optional

Boolean

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

AllowAnnotations

Optional

Boolean

Indicates whether or not participants are allowed to make onscreen annotations on any content shared during the meeting. The default value is True ($True).

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

AllowUserToScheduleMeetingsWithAppSharing

Optional

Boolean

Indicates whether or not users are allowed to schedule meetings that include application sharing. The default value is true ($True).

AllowAnonymousUsersToDialOut

Optional

Boolean

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

The default value is False ($False).

AllowAnonymousParticipantsInMeetings

Optional

Boolean

Indicates whether anonymous users are allowed to participate in the meeting. If set to False ($False) then only authenticated users (that is, users logged on to your Active Directory or the Active Directory of a federated partner) are allowed to attend the meeting. The default value is True ($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 ($True).

AllowExternalUserControl

Optional

Boolean

Indicates whether external users (that is, users not currently logged-on to your network) are allowed to take control of shared applications or desktops. The default value is False ($False).

AllowExternalUsersToRecordMeetings

Optional

Boolean

Indicates whether external users (that is, users not currently logged-on to your network) are allowed to record the meeting. The default value is False ($False).

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

EnableDialInConferencing

Optional

Boolean

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

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.

The default value is Desktop.

AllowConferenceRecording

Optional

Boolean

Indicates whether users are allowed to record the meeting. The default value is True ($True).

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).

EnableDataCollaboration

Optional

Boolean

Indicates whether users are allowed to join the meeting over the Internet, provided they are using a supported Web browser. The default value is True ($True).

MaxVideoConferenceResolution

Optional

PSListModifier

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

CIF. 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.

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 maximum number of participants can be any whole number between 2 and 250, inclusive; the default value is 200.

AudioBitRateKB

Optional

Integer

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

VideoBitRateKB

Optional

Integer

Bit rate (in kilobytes) used for video transmissions. The video bit rate can be any whole number between 0 and 2000, inclusive; the default value is 2000.

AppSharingBitRateKB

Optional

Integer

Bit rate (in kilobytes) used for application sharing. The application sharing bit rate can be any whole number between 0 and 2000, inclusive; the default value is 2000.

FileTransferBitRateKB

Optional

Integer

Bit rate (in kilobytes) used for file transfers. The file transfers bit rate can be any whole number between 0 and 2000, inclusive; the default value is 2000.

Description

Optional

String

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

AllowPolls

Optional

Boolean

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

EnableP2PRecording

Optional

Boolean

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

EnableP2PVideo

Optional

Boolean

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

Force

Optional

Switch Parameter

Suppresses the display of any non-fatal error message that might arise 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

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

Detailed Description

Conferencing is an important part of Microsoft Communications Server 2010: conferencing enables groups of users (as few as 2 people to as many as 1,000 people) to come together online to view slides and video, share applications, exchange files, and otherwise communicate and collaborate.

Needless to say, 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 wreak havoc on 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, wanting to manage conferencing settings is one thing; how you manage these settings is another. In Communications Server 2010 conferences are managed 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 Web 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.

Return Types

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

Examples

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

Copy Code
Set-CSConferencingPolicy -Identity SalesConferencingPolicy -EnableRecording $False

The preceding command modifies a property value of the conferencing policy SalesConferencingPolicy; in particular, the command sets the value of the EnableRecording property to False ($False). To do this, Set-CSConferencingPolicy is called along with the -Identity parameter (to specify the policy to be modified) and the -EnableRecording parameter.

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

Copy Code
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 entire collection is then piped to Set-CSConferencingPolicy, which sets the value of both AllowAnonymousParticipantsInMeetings and EnableDialInConferencing to False ($False) for each policy in the collection.

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

Copy Code
Get-CSConferencingPolicy -Filter "site:*" | Set-CSConferencingPolicy  -MaxVideoP2PResolution CIF

The command shown in Example 3 modifies the MaxVideoP2PResolution 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. (That is, policies that have an Identity that begins with the string value "site:".) This filtered collection is then piped to Set-CSConferencingPolicy, which sets the MaxVideoP2PResolution property for each policy in the collection to "CIF".

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

Copy Code
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. This filtered collection is then piped to Set-CSConferencingPolicy, which takes each policy in the collection and sets its MaxMeetingSize property to 100.