Returns information about the conferencing policies that have been configured for use in your organization. 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
Get-CsConferencingPolicy [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>] |
Get-CsConferencingPolicy [-Filter <String>] [-LocalStore <SwitchParameter>] |
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Optional |
Xds Identity |
Unique identifier for the conferencing policy to be retrieved. Conferencing policies can be configured at the global, site, or per-user scopes. To retrieve the global policy use this syntax: -Identity global. To retrieve a site policy use syntax similar to this: -Identity site:Redmond. To retrieve a per-user policy use syntax similar to this: -Identity SalesConferencingPolicy. If this parameter is not included, Get-CsConferencingPolicy will return a collection of all the conferencing policies configured for use in your organization. Note that wildcards are not allowed when specifying an Identity. Use the -Filter parameter if you want to use wildcards when specifying a conferencing policy. |
Filter |
Optional |
String |
Enables you to use wildcard characters when specifying the conferencing policy (or, in this case, policies) to be returned. For example, this syntax returns all the policies configured at the site scope: -Filter site:*. That syntax works because all the policies configured at the site scope must have an Identity that begins with the string value "site:". (Note that you can only filter on the Identity.) To return a collection of all the policies configured at the per-user scope use this syntax: -Filter tag:*. Note that even though you don’t specify tag: when retrieving an individual per-user policy, the prefix tag: is stored in the background as part of all per-user policy identities and can be used to filter on those policies. |
LocalStore |
Optional |
Switch Parameter |
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.
The Get-CsConferencingPolicy cmdlet provides a way for you to return information about all the conferencing policies that have been configured for use in your organization.
Return Types
Get-CsConferencingPolicy returns instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.Meeting.MeetingPolicy object.
Examples
-------------------------- Example 1 --------------------------
Copy Code | |
---|---|
Get-CsConferencingPolicy |
The preceding example illustrates the simplest possible use of Get-CsConferencingPolicy. Calling the cmdlet without specifying any additional parameters returns a collection of all the conferencing policies configured for use in your organization.
-------------------------- Example 2 --------------------------
Copy Code | |
---|---|
Get-CsConferencingPolicy -Identity Global |
In Example 2 the -Identity parameter is used to limit the retrieved information to conferencing policies that have an identity equal to Global. Because policy Identities must be unique this command returns a single policy: the Global conferencing policy.
-------------------------- Example 3 --------------------------
Copy Code | |
---|---|
Get-CsConferencingPolicy -Filter tag:* |
The above example uses the -Filter parameter to return a collection of all the conferencing policies that have been configured at the per-user scope. (A policy configured at the per-user scope can be directly assigned to users or groups.) The wildcard value "tag:*" tells Windows PowerShell to limit the returned data to conferencing policies that have an identity beginning with the string value "tag:". Keep in mind that even though you don’t need the tag: prefix when retrieving an individual policy, but it can be used to filter on all per-user policies.
-------------------------- Example 4 --------------------------
Copy Code | |
---|---|
Get-CsConferencingPolicy | Where-Object {$_.MaxMeetingSize -gt 100} |
Example 4 returns a collection of all the conferencing policies where the MaxMeetingSize property is greater than 100. The command starts out by using the Get-CsConferencingPolicy cmdlet 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 applies a filter that limits the returned data to policies where the MaxMeetingSize property is greater than (-gt) 100.
-------------------------- Example 5 --------------------------
Copy Code | |
---|---|
Get-CsConferencingPolicy | Where-Object {$_.AllowExternalUsersToSaveContent -eq $True -and $_.AllowExternalUserControl -eq $True} |
The preceding command returns all the conferencing policies that meet two criteria: the AllowExternalUsersToSaveContent property is equal to (-eq) to True ($True) and the AllowExternalUserControl property is also equal to True. To do this, the command calls Get-CsConferencingPolicy without any additional parameters; this returns a collection of all the conferencing policies configured for use in the organization. That collection is then piped to Where-Object, which picks out only those policies where both AllowExternalUsersToSaveContent and AllowExternalUserControl are True. (The -and operator tells Where-Object that an object must meet all the specified criteria in order to be returned.)
-------------------------- Example 6 --------------------------
Copy Code | |
---|---|
Get-CsConferencingPolicy | Where-Object {$_.AllowExternalUsersToSaveContent -eq $True -or $_.AllowExternalUserControl -eq $True} |
Example 6 is a variation of the command shown in Example 5. In this case, the command returns any policy that meets at least one (but not necessarily both) of the specified criteria: either the AllowExternalUsersToSaveContent property is equal to (-eq) to True ($True) and/or the AllowExternalUserControl property is equal to True. To do this, the command calls Get-CsConferencingPolicy without any additional parameters; this returns a collection of all the conferencing policies configured for use in the organization. That collection is then piped to Where-Object, which picks out only those policies where either AllowExternalUsersToSaveContent and/or AllowExternalUserControl are equal to True. (The -or operator tells Where-Object that an object must meet just one of the specified criteria in order to be returned.)