Set-CsWebServiceConfiguration
トピックの最終更新日: 2012-04-23
Web サービス構成設定の既存のコレクションを変更します。UNRESOLVED_TOKEN_VAL(ps-intro-in-LS2010)
構文
Set-CsWebServiceConfiguration [-Identity <XdsIdentity>] <COMMON PARAMETERS>
Set-CsWebServiceConfiguration [-Instance <PSObject>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-AllowAnonymousAccessToLWAConference <$true | $false>] [-AllowExternalAuthentication <$true | $false>] [-AutoLaunchLyncWebAccess <$true | $false>] [-CASigningKeyLength <UInt64>] [-Confirm [<SwitchParameter>]] [-CrossDomainAuthorizationList <PSListModifier>] [-DefaultValidityPeriodHours <UInt64>] [-EnableCertChainDownload <$true | $false>] [-EnableGroupExpansion <$true | $false>] [-EnableStatisticsInResponse <$true | $false>] [-Force <SwitchParameter>] [-InferCertChainFromSSL <$true | $false>] [-MACResolverUrl <String>] [-MaxCSRKeySize <UInt64>] [-MaxGroupSizeToExpand <UInt32>] [-MaxValidityPeriodHours <UInt64>] [-MinCSRKeySize <UInt64>] [-MinValidityPeriodHours <UInt64>] [-SecondaryLocationSourceUrl <String>] [-ShowAlternateJoinOptionsExpanded <$true | $false>] [-ShowDownloadCommunicatorAttendeeLink <$true | $false>] [-ShowJoinUsingLegacyClientLink <$true | $false>] [-TrustedCACerts <PSListModifier>] [-UseCertificateAuth <$true | $false>] [-UseDomainAuthInLWA <$true | $false>] [-UsePinAuth <$true | $false>] [-UseWindowsAuth <None | Negotiate | NTLM>] [-UseWsFedPassiveAuth <$true | $false>] [-WhatIf [<SwitchParameter>]] [-WsFedPassiveMetadataUri <String>]
例
例 1
例 1 では、Redmond サイト (-Identity site:Redmond) に適用されている Web サービス 構成設定のグループ拡張を有効にしています。これを行うため、EnableGroupExpansion プロパティを組み込み、パラメーターの値を True に設定しています。
Set-CsWebServiceConfiguration -Identity site:Redmond -EnableGroupExpansion $True
例 2
例 2 では、サイト スコープで適用されるすべての Web サービス 構成設定の最大有効期間を、16 時間に変更しています。このタスクを実行するため、Get-CsWebServiceConfiguration コマンドレットを Filter パラメーターと共に呼び出します。フィルター値 "site:*" により、戻されるデータを文字列 "site:" で始まる ID を持つ設定に制限します。次に、このコレクションを Set-CsWebServiceConfiguration コマンドレットにパイプ処理し、コレクション内の各項目を取得し、MaxValidityPeriodHours プロパティを 16 に変更します。
Get-CsWebServiceConfiguration -Filter "site:*" | Set-CsWebServiceConfiguration -MaxValidityPeriodHours 16
例 3
例 3 では、グループ拡張を許可する Web サービス構成設定のコレクションごとに、グループ拡張サイズを 400 に設定しています。これを実行するため、パラメーターを指定せずに Get-CsWebServiceConfiguration コマンドレットを呼び出します。これにより、組織で使用しているすべての Web サービス構成設定のコレクションが戻されます。次に、このコレクションは Where-Object コマンドレットにパイプ処理されて、EnableGroupExpansion プロパティが True と等しい設定のみが選択されます。さらに、このフィルター処理されたコレクションは Set-CsWebServiceConfiguration コマンドレットにパイプ処理されて、コレクション内の各項目が取得され、MaxGroupSizeToExpand プロパティの値が 400 に設定されます。
Get-CsWebServiceConfiguration | Where-Object {$_.EnableGroupExpansion -eq $True} | Set-CsWebServiceConfiguration -MaxGroupSizeToExpand 400
例 4
例 4 のコマンドは、Lync 以外のクライアント アプリケーションを使用して会議に参加する参加者に対して、まず Lync 15 Web App をダウンロードするサイトに移動するためのリンクを表示するように、グローバル Web サービス設定を構成する方法を示しています。これは、ShowDownloadCommunicatorAttendeeLink プロパティを指定し、パラメーター値を $True に設定することによって行われます。
Set-CsWebServiceConfiguration -Identity global -ShowDownloadCommunicatorAttendeeLink $True
例 5
例 5 のコマンドでは、Web サービス構成設定の既存のコレクションにドメイン https://fabrikam.com を追加します。この処理を実行するには、この例の最初のコマンドで New-CsWebOrigin コマンドレットを使用して fabrikam.com のドメイン オブジェクトを作成します。このドメイン オブジェクトは変数 $x に格納されます。
この例の 2 つ目のコマンドでは Set-CsWebServiceConfiguration コマンドレットを使用して Redmond サイトに適用される Web サービス構成設定に https://fabrikam.com を追加します。構文 @{Add=$x} により、クロスドメインのスクリプト作成の権限があるドメインのコレクション内に既にあるすべてのドメインにこのドメインが追加されます。既存のコレクションを https://fabrikam.com に置き換えるには、構文 @{Replace=$x} を使用します。
$x = New-CsWebOrigin -Url "https://fabrikam.com"
Set-CsWebServiceConfiguration -Identity "site:Redmond" - CrossDomainAuthorizationList @{Add=$x}
例 6
例 6 では、クロスドメインのスクリプト作成の権限があるドメインのコレクションに示されていた最初のドメインが Redmond サイトの Web サービス構成設定から削除されます。これを実行するために、この例の最初のコマンドでは Get-CsWebServiceConfiguration コマンドレットを使用して Redmond サイトの現在の設定を取得しています。これらの値は変数 $x に格納されます。
2 つ目のコマンドでは、RemoveAt メソッドを使用して、CrossDomainAuthorizationList プロパティから最初のドメインを削除します。ドメインは、このプロパティ内に配列として格納されており、最初のドメインはインデックス番号が 0、2 番目のドメインはインデックス番号が 1、という具合になっています。2 番目のドメイン (インデックス番号 1) を CrossDomainAuthorizationList プロパティから削除するには、次の構文を使用します。
$x.CrossDomainAuthorizationList.RemoveAt(1)
2 つ目のコマンドは、Redmond サイトそのものではなく、変数 $x に格納されている Redmond サイトのコピーからこのドメインを削除します。実際に Redmond サイトからドメインを削除するために、この例の 3 つ目のコマンドでは Set-CsWebServiceConfiguration コマンドレットと Instance パラメーターを使用して、Redmond サイトの設定を $x に格納されている設定で上書きしています。
$x = Get-CsWebServiceConfiguration -Identity "site:Redmond"
$x.CrossDomainAuthorizationList.RemoveAt(0)
Set-CsWebServiceConfguration -Instance $x
例 7
例 7 のコマンドでは、クロスドメインのスクリプト作成の権限があるドメインすべてを削除することで、Redmond サイトの Web サービス構成設定を変更しています。そのために、CrossDomainAuthorizationList プロパティが null 値 ($Null) に設定されています。
Set-CsWebServiceConfiguration -Identity "site:Redmond" - CrossDomainAuthorizationList $Null
解説
多くの Lync Server コンポーネントは Web ベースです。これらのコンポーネントでは、Web サービス または Web ページを使用してタスクを実行します。たとえば、新しい連絡先をアドレス帳で検索したり、グループ拡張を使用して配布グループの個々のメンバーを表示したりする場合、ユーザーは Web サービスを使用します。同様に、ダイヤルイン会議から Lync Server コントロール パネル にわたる各種コンポーネントは、Web ページを Lync Server とユーザー間のインターフェイスとして使用します。
CsWebServiceConfiguration コマンドレットを使用することにより、管理者は組織全体にわたって Web サービス 構成設定を管理できるようになります。これには、グループ拡張、証明書の設定、および許可された認証方法の管理が含まれます。グローバル スコープ、サイト スコープ、およびサービス スコープで異なる設定を構成できるため (ただし、Web Services サービスの場合のみ)、さまざまなユーザーや場所に合わせて Web サービス の機能をカスタマイズできます。CsWebServiceConfiguration コマンドレット群を使用することにより、管理者は組織全体にわたって Web サービス 構成設定を管理できるようになります。これには、グループ拡張、証明書の設定、および許可された認証方法の管理が含まれます。グローバル、サイト、およびサービスの各スコープで異なる設定を構成できるため (Web Services サービスのみ)、さまざまなユーザーと場所に合わせて Web サービス の機能をカスタマイズできます。
カスタム設定 (たとえば、証明書のカスタムの有効期間など) は、新しい Web サービス 構成設定のコレクションを作成するときに指定できます。または、Set-CsWebServiceConfiguration コマンドレットを使用して、既存のコレクションのプロパティの値を変更できます。
このコマンドレットを実行できるユーザー: 既定では、次のグループのメンバーが Set-CsWebServiceConfiguration コマンドレットをローカルで実行することを承認されています。RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsWebServiceConfiguration"}
パラメーター
パラメーター | 必須かどうか | 型 | 説明 |
---|---|---|---|
AllowAnonymousAccessToLWAConference |
省略可能 |
System.Boolean |
True に設定した場合、匿名ユーザーは Lync Web App 会議への出席を許可されます。 |
AllowExternalAuthentication |
省略可能 |
System.Boolean |
True (既定値) に設定されている場合、OAuth 認証を使用して外部ユーザーを認証できます。 |
AutoLaunchLyncWebAccess |
省略可能 |
System.Boolean |
このパラメーターは、社内バージョンの Lync Server 15 で使用する目的で廃止されました。 True に設定した場合、オンライン会議に参加するための既定の Web ポップアップとして Lync Web App が自動的に使用されます。ただし、Lync 15 Web App を使用するための前提条件 (Silverlight がインストールされている、Internet Explorer がポップアップ ウィンドウをブロックしていないなど) が満たされていることが前提です。 既定値は True です。 |
CASigningKeyLength |
省略可能 |
System.UInt64 |
CA 署名キー (認証機関 (CA) がデジタル証明書に署名するために使用する秘密キー) のサイズを設定します。この署名キーの長さは、2048 ~ 16384 バイトの整数値で設定できます。既定値は 2048 です。 |
Confirm |
省略可能 |
System.Management.Automation.SwitchParameter |
コマンドの実行前に確認メッセージを表示します。 |
CrossDomainAuthorizationList |
省略可能 |
System.Management.Automation.PSListModifier |
クロスドメインのスクリプト作成リクエストを Lync Server 15 の展開に送信する Web アプリケーションをホストすることを許可されているドメインのコレクション。 リストに追加するドメインは、New-CsWebOrigin コマンドレットを使用して作成したうえで Web サービス構成設定の新しいコレクションに追加する必要があります。また、ドメイン名の先頭には http: または https: プレフィックスを付ける必要もあります。詳細については、このヘルプ トピックの例 5、6、および 7 を参照してください。 このパラメーターは、Lync Server 15 の 2013 年 2 月のリリースで導入されました。 |
DefaultValidityPeriodHours |
省略可能 |
System.UInt64 |
認証証明書を使用する場合、クライアントは証明書が有効である期間 (時間単位) を要求することができます。DefaultValidityPeriodHours は、クライアントがカスタム有効期間を要求しない場合に証明書が有効なまま維持される時間量を表します。 DefaultValidityPeriodHours は、8 ~ 8760 時間 (365 日) の任意の整数値に設定できます。既定値は 4320 (180 日) です。 |
EnableCertChainDownload |
省略可能 |
System.Boolean |
True に設定した場合、認証証明書を提示されたサーバーは、その証明書の証明書チェーンをダウンロードします。証明書チェーンは、個々の証明書を発行元の CA までさかのぼります。証明書の CA が信頼されない限り、証明書は認証用として許可されません。 |
EnableGroupExpansion |
省略可能 |
System.Boolean |
True に設定した場合、Lync でグループ拡張が有効になります。グループ拡張を使用すると、ユーザーは配布グループを連絡先として構成し、そのグループを "拡張" できるようになります。グループを拡張すると、ユーザーはグループの個別メンバーとその現在のプレゼンス情報を表示できます。 |
EnableStatisticsInResponse |
省略可能 |
System.Boolean |
PARAMVALUE: $true | $false |
Force |
省略可能 |
System.Management.Automation.SwitchParameter |
コマンドレットを実行するときに発生する可能性のある、すべての確認メッセージまたは致命的ではないエラー メッセージが表示されないようにします。 |
Identity |
省略可能 |
Microsoft.Rtc.Management.Xds.XdsIdentity |
変更する Web サービス 構成設定の一意の識別子です。サイト スコープで構成された設定を変更するには、次のような構文を使用します。-Identity "site:Redmond"。サービス スコープで構成された設定を変更するには、次のような構文を使用します。-Identity "service:WebServer:atl-cs-001.litwareinc.com"。 グローバル スコープで構成された設定を変更するには、次の構文を使用できます。-identity global。 Identity パラメーターが使用されていない場合は、Set-CsWebServiceConfiguration コマンドレットによって、グローバル コレクションが自動的に変更されます。 |
InferCertChainFromSSL |
省略可能 |
System.Boolean |
True に設定した場合、サーバーは SSL (Secure Sockets Layer) に含まれた証明書情報を使用して、発行元の CA を判別します。証明書の CA が信頼されない限り、証明書は認証用として許可されません。 |
Instance |
省略可能 |
WebServiceSettings オブジェクト |
個々のパラメーター値を設定するのではなく、オブジェクトへの参照をコマンドレットに渡せるようにします。 |
MACResolverUrl |
省略可能 |
System.String |
メディア アクセス制御 (MAC) 解決を実行できる Web サービスの URL です。MAC 解決では、接続されたクライアントの MAC アドレスを取得して、そのクライアントが接続されているネットワーク スイッチの筐体とポート ID を戻します。MAC 解決は、高度 9-1-1 サービスで使用されます。 |
MaxCSRKeySize |
省略可能 |
System.UInt64 |
証明書の署名要求 (CSR) キーの最大サイズを設定します (CSR は、デジタル証明書を申請するために申請者が CA に送信するメッセージです)。CSR キーの最大サイズは、1024 ~ 16384 バイトの任意の整数値に設定できます。既定値は 16384 です。 |
MaxGroupSizeToExpand |
省略可能 |
System.UInt32 |
グループの拡張時に表示される最大人数を表します。たとえば、MaxGroupSizeToExpand を 75 に設定した場合は、グループを拡張すると、グループの最初の 75 人のメンバーだけが常に表示されます。 MaxGroupSizeToExpand は、1 ~ 1000 の任意の整数値に設定できます。既定値は 100 です。 |
MaxValidityPeriodHours |
省略可能 |
System.UInt64 |
認証証明書を使用する場合、クライアントは証明書が有効である期間 (時間単位) を要求することができます。MaxValidityPeriodHours は、クライアントが要求できる時間の最大値を表します。 MaxValidityPeriodHours は、8 ~ 8760 時間 (365 日) の任意の整数値に設定できます。既定値は 8760 です。 |
MinCSRKeySize |
省略可能 |
System.UInt64 |
証明書の署名要求 (CSR) キーの最小サイズを設定します 最小サイズは、1024 ~ 16384 の任意の整数値に設定できます。既定値は 16384 です。 |
MinValidityPeriodHours |
省略可能 |
System.UInt64 |
認証証明書を使用する場合、クライアントは証明書が有効である期間 (時間単位) を要求することができます。MinValidityPeriodHours は、クライアントが要求できる最小時間量を表します。 MinValidityPeriodHours は、8 ~ 4320 時間 (180 日) の任意の整数値に設定できます。既定値は 8 です。 |
SecondaryLocationSourceUrl |
省略可能 |
System.String |
場所の要求を処理できる Web サービスの URL。このサービスは、場所の要求をローカルで解決できない場合にのみ使用されます。 |
ShowAlternateJoinOptionsExpanded |
省略可能 |
System.Boolean |
このパラメーターは、社内バージョンの Lync Server 15 で使用する目的で廃止されました。 True に設定されている場合、オンライン会議に参加するための別のオプション (Office Communicator 2007 R2 など) が自動的に展開され、ユーザーに表示されます。False (既定値) に設定されている場合、これらのオプションは使用できますが、ユーザーが自分でオプションの一覧を表示する必要があります。 |
ShowDownloadCommunicatorAttendeeLink |
省略可能 |
System.Boolean |
このパラメーターは、社内バージョンの Lync Server 15 で使用する目的で廃止されました。 True (既定値) に設定した場合、Lync 以外のクライアント アプリケーションを使用してオンライン会議に参加するユーザーに、Lync 15 Web App のダウンロードを示すリンクが表示されます。 |
ShowJoinUsingLegacyClientLink |
省略可能 |
System.Boolean |
このパラメーターは、社内バージョンの Lync Server 15 で使用する目的で廃止されました。 True に設定した場合、Lync 以外のクライアント アプリケーションを使用してオンライン会議に参加するユーザーには、そのユーザーの現在のクライアント アプリケーションを使用して会議に参加するオプションが提供されます。既定値は False です。 |
TrustedCACerts |
省略可能 |
System.Management.Automation.PSListModifier |
Web サーバーによって信頼されている証明書チェーンを表す証明書のコレクション。コレクションに追加する新しい証明書は、New-CsWebTrustedCACertificate コマンドレットを使用して作成する必要があります。 InferCertChainFromSSL プロパティが True に設定されている場合、このコレクションは使用されません。 |
UseCertificateAuth |
省略可能 |
System.Boolean |
True (既定値) に設定した場合、クライアントは証明書を使用して認証されます。この値を False に設定すると、証明書認証が無効になります。 |
UseDomainAuthInLWA |
省略可能 |
System.Boolean |
PARAMVALUE: $true | $false |
UsePinAuth |
省略可能 |
System.Boolean |
True (既定値) に設定すると、暗証番号 (PIN) を使用してクライアントを認証することが可能になります。この値を False に設定すると、PIN 認証が無効になります。 |
UseWindowsAuth |
省略可能 |
Microsoft.Rtc.Management.WritableConfig.Settings.Web.UseWindowsAuth |
Windows 認証を使用して、つまり、Windows にログオンしたときと同じ資格情報を使用して、ユーザーを認証する方法 (および認証するかどうか) を決定します。有効な値は次のとおりです。 Negotiate - クライアントとサーバーが連動して、適切な認証プロトコル (Kerberos または NTLM) を判別します。 NTLM - Windows 認証は許可されますが、NTLM プロトコルを使用する場合に限られます。 None - Windows 認証は許可されません。 |
UseWsFedPassiveAuth |
省略可能 |
System.Boolean |
True に設定した場合、パッシブ認証 (URL リダイレクトまたはスマート リンクを使用したユーザーの認証) を使用できます。既定値は False ($False) です。 |
WhatIf |
省略可能 |
System.Management.Automation.SwitchParameter |
実際にコマンドを実行せずに、コマンドの実行結果がわかります。 |
WsFedPassiveMetadataUri |
省略可能 |
System.String |
WS-Federation Web リクエスター プロトコルによって使用される URI。 |
入力の種類
Microsoft.Rtc.Management.WritableConfig.Settings.Web.WebServiceSettings オブジェクト。Set-CsWebServiceConfiguration コマンドレットは、パイプライン処理された Web サービス 設定オブジェクトのインスタンスを受け入れます。
戻り値の種類
Set-CsWebServiceConfiguration コマンドレットは、値またはオブジェクトを戻しません。代わりに、このコマンドレットは、Microsoft.Rtc.Management.WritableConfig.Settings.Web.WebServiceSettings オブジェクトのインスタンスを構成します。