Set-WSManInstance
リソースに関連する管理情報を変更します。
構文
Set-WSManInstance
[-ApplicationName <String>]
[-ComputerName <String>]
[-Dialect <Uri>]
[-FilePath <String>]
[-Fragment <String>]
[-OptionSet <Hashtable>]
[-Port <Int32>]
[-ResourceURI] <Uri>
[[-SelectorSet] <Hashtable>]
[-SessionOption <SessionOption>]
[-UseSSL]
[-ValueSet <Hashtable>]
[-Credential <PSCredential>]
[-Authentication <AuthenticationMechanism>]
[-CertificateThumbprint <String>]
[<CommonParameters>]
Set-WSManInstance
[-ConnectionURI <Uri>]
[-Dialect <Uri>]
[-FilePath <String>]
[-Fragment <String>]
[-OptionSet <Hashtable>]
[-ResourceURI] <Uri>
[[-SelectorSet] <Hashtable>]
[-SessionOption <SessionOption>]
[-ValueSet <Hashtable>]
[-Credential <PSCredential>]
[-Authentication <AuthenticationMechanism>]
[-CertificateThumbprint <String>]
[<CommonParameters>]
説明
Set-WSManInstance
コマンドレットは、リソースに関連する管理情報を変更します。
このコマンドレットは、WinRM の接続/トランスポート層を使用して、情報を変更します。
例
例 1: ローカル コンピューターでリスナーを無効にする
Set-WSManInstance -ResourceURI winrm/config/listener -SelectorSet @{address="*";transport="https"} -ValueSet @{Enabled="false"}
cfg : http://schemas.microsoft.com/wbem/wsman/1/config/listener
xsi : http://www.w3.org/2001/XMLSchema-instance
lang : en-US
Address : *
Transport : HTTPS
Port : 443
Hostname :
Enabled : false
URLPrefix : wsman
CertificateThumbprint :
ListeningOn : {127.0.0.1, 172.30.168.171, ::1, 2001:4898:0:fff:0:5efe:172.30.168.171...}
このコマンドは、ローカル コンピューター上の HTTPS リスナーを無効にします。
重要
ValueSet パラメーターは、指定されたプロパティと一致するときに大文字と小文字が区別されます。
たとえば、このコマンドでは、
これは失敗します。 -ValueSet @{enabled="False"}
これにより、次の処理が成功します。 -ValueSet @{Enabled="False"}
例 2: ローカル コンピューターで封筒の最大サイズを設定する
Set-WSManInstance -ResourceURI winrm/config -ValueSet @{MaxEnvelopeSizekb = "200"}
cfg : http://schemas.microsoft.com/wbem/wsman/1/config
lang : en-US
MaxEnvelopeSizekb : 200
MaxTimeoutms : 60000
MaxBatchItems : 32000
MaxProviderRequests : 4294967295
Client : Client
Service : Service
Winrs : Winrs
このコマンドは、ローカル コンピューターの MaxEnvelopeSizekb 値を 200 に設定します。
重要
ValueSet パラメーターは、指定されたプロパティと一致するときに大文字と小文字が区別されます。
たとえば、上記のコマンドを使用するとします。
これは失敗します。 -ValueSet @{MaxEnvelopeSizeKB ="200"}
これにより、次の処理が成功します。 -ValueSet @{MaxEnvelopeSizekb ="200"}
例 3: リモート コンピューターでリスナーを無効にする
Set-WSManInstance -ResourceURI winrm/config/listener -ComputerName SERVER02 -SelectorSet @{address="*";transport="https"} -ValueSet @{Enabled="false"}
cfg : http://schemas.microsoft.com/wbem/wsman/1/config/listener
xsi : http://www.w3.org/2001/XMLSchema-instance
lang : en-US
Address : *
Transport : HTTPS
Port : 443
Hostname :
Enabled : false
URLPrefix : wsman
CertificateThumbprint :
ListeningOn : {127.0.0.1, 172.30.168.172, ::1, 2001:4898:0:fff:0:5efe:172.30.168.172...}
このコマンドは、リモート コンピューター SERVER02上の HTTPS リスナーを無効にします。
重要
ValueSet パラメーターは、指定されたプロパティと一致するときに大文字と小文字が区別されます。
たとえば、上記のコマンドを使用するとします。
これは失敗します。 -ValueSet @{enabled="False"}
これにより、次の処理が成功します。 -ValueSet @{Enabled="False"}
パラメーター
-ApplicationName
接続のアプリケーション名を指定します。 ApplicationName パラメーターの既定値は "WSMAN" です。 リモート エンドポイントの完全な識別子は、次の形式です。
<transport>://<server>:<port>/<ApplicationName>
次に例を示します。
http://server01:8080/WSMAN
セッションをホストするインターネット インフォメーション サービス (IIS) は、このエンドポイントで、指定されたアプリケーションに要求を転送します。 WSMAN
のこの既定の設定は、ほとんどの用途に適しています。 このパラメーターは、Windows PowerShell を実行している 1 台のコンピューターに多数のコンピューターからリモート接続を確立する場合に使用するように設計されています。 この場合、IIS は効率を上げるために Web Services for Management (WS-Management) をホストします。
型: | String |
配置: | Named |
規定値: | Wsman |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Authentication
サーバーで使用される認証メカニズムを指定します。 次のいずれかの値になります。
Basic
:Basic は、ユーザー名とパスワードがクリア テキストでサーバーまたはプロキシに送信されるスキームです。Default
: WS-Management プロトコルによって実装された認証方法を使用します。 これが既定です。Digest
: Digest は、チャレンジにサーバー指定のデータ文字列を使用するチャレンジ応答スキームです。Kerberos
: クライアント コンピューターとサーバーは、Kerberos 証明書を使用して相互に認証します。Negotiate
: Negotiate は、認証に使用するスキームを決定するためにサーバーまたはプロキシとネゴシエートするチャレンジ応答スキームです。 たとえば、このパラメーター値を指定すると、Kerberos プロトコルと NTLM のどちらが使用されるかを特定するネゴシエーションを行うことができます。CredSSP
: 資格情報セキュリティ サポート プロバイダー (CredSSP) 認証を使用します。これにより、ユーザーは資格情報を委任できます。 このオプションは、1 台のリモート コンピューターで実行するが、他のリモート コンピューターからデータを収集するコマンドや、他のリモート コンピューターで追加のコマンドを実行するコマンドを対象としています。
注意事項
CredSSP は、ローカル コンピューターからリモート コンピューターにユーザーの資格情報を委任します。 そのため、リモート操作のセキュリティ リスクが高まります。 リモート コンピューターのセキュリティが低下している場合は、そのリモート コンピューターに渡された資格情報を使用してネットワーク セッションが制御される場合があります。
型: | AuthenticationMechanism |
Aliases: | auth, am |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-CertificateThumbprint
この処理を実行するアクセス許可を持つユーザー アカウントのデジタル公開キー証明書 (X509) を指定します。 証明書の拇印を入力します。
証明書は、クライアント証明書ベースの認証で使用されます。 これらの証明書は、ローカル ユーザー アカウントにしかマップできません。ドメイン アカウントでは機能しません。
証明書の拇印を取得するには、PowerShell Cert:
ドライブの Get-Item
または Get-ChildItem
コマンドを使用します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ComputerName
管理操作を実行するコンピューターを指定します。 値には、完全修飾ドメイン名、NetBIOS 名、または IP アドレスを指定できます。 ローカル コンピューター名、 localhost
、またはドット (.
) を使用して、ローカル コンピューターを指定します。 ローカル コンピューターは、既定値です。
リモート コンピューターがユーザーとは異なるドメインにある場合は、完全修飾ドメイン名を使用する必要があります。 パイプを使用して、このパラメーターの値をコマンドレットに渡すことができます。
型: | String |
Aliases: | cn |
配置: | Named |
規定値: | Localhost |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ConnectionURI
接続エンドポイントを指定します。 この文字列の形式は次のとおりです。
<Transport>://<Server>:<Port>/<ApplicationName>
次の文字列は、このパラメーターの正しい形式の値です。
http://Server01:8080/WSMAN
URI は完全修飾名にする必要があります。
型: | Uri |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Credential
この処理を実行するアクセス許可を持つユーザー アカウントを指定します。 既定値は現在のユーザーです。 User01
、Domain01\User01
、User@Domain.com
などのユーザー名を入力します。 または、Get-Credential
コマンドレットによって返されるオブジェクトなど、PSCredential オブジェクトを入力します。 ユーザー名を入力すると、パスワードの入力を促すメッセージが表示されます。
型: | PSCredential |
Aliases: | cred, c |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Dialect
フィルター述語で使用する言語を指定します。 リモート サービスでサポートされている任意の言語を指定できます。 言語の URI には、次のエイリアスを使用できます。
WQL
:http://schemas.microsoft.com/wbem/wsman/1/WQL
Selector
:http://schemas.microsoft.com/wbem/wsman/1/wsman/SelectorFilter
Association
:http://schemas.dmtf.org/wbem/wsman/1/cimbinding/associationFilter
型: | Uri |
配置: | Named |
規定値: | http://schemas.microsoft.com/wbem/wsman/1/WQL |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-FilePath
管理リソースの更新に使用するファイルのパスを指定します。 管理リソースは、 ResourceURI パラメーターと SelectorSet パラメーターを使用して指定します。 たとえば、次のコマンドでは、 FilePath パラメーターを使用します。
Invoke-WSManAction -Action StopService -ResourceUri wmicimv2/Win32_Service -SelectorSet @{Name="spooler"} -FilePath:c:\input.xml -authentication default
このコマンドは、ファイルからの入力を使用して、スプーラー サービスで StopService メソッドを呼び出します。
ファイル Input.xml
には、次の内容が含まれています。
<p:StopService_INPUT xmlns:p="http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Service" />
型: | String |
Aliases: | Path |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Fragment
指定された操作で更新または取得するインスタンス内のセクションを指定します。 たとえば、スプーラー サービスの状態を取得するには、 -Fragment Status
を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-OptionSet
要求のオプションを変更または調整する一連のスイッチをサービスに渡します。 これらは、サービス固有であるため、コマンド ライン シェルで使用されるスイッチに似ています。 任意の数のオプションを指定できます。
次の例では、a
、b
、およびc
パラメーターの値1
、2
、および3
を渡す構文を示します。
-OptionSet @{a=1;b=2;c=3}
型: | Hashtable |
Aliases: | os |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Port
クライアントが WinRM サービスに接続するときに使用するポートを指定します。 トランスポートが HTTP の場合、既定のポートは 80 です。 トランスポートが HTTPS の場合、既定のポートは 443 です。
トランスポートとして HTTPS を使用する場合、 ComputerName パラメーターの値は、サーバーの証明書の共通名 (CN) と一致する必要があります。 ただし、 SkipCNCheck パラメーターが SessionOption パラメーターの一部として指定されている場合、サーバーの証明書の共通名はサーバーのホスト名と一致する必要はありません。 SkipCNCheck パラメーターは、信頼できるマシンにのみ使用する必要があります。
型: | Int32 |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ResourceURI
リソース クラスまたはインスタンスの Uniform Resource Identifier (URI) を含めます。 URI は、ディスクやプロセスなど、コンピューター上の特定の種類のリソースを特定するために使用されます。
URI は、プレフィックスとリソースのパスで構成されます。 次に例を示します。
http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_LogicalDisk
http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_NumericSensor
型: | Uri |
Aliases: | ruri |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-SelectorSet
特定の管理リソース インスタンスの選択に使用する値のペアのセットを指定します。 SelectorSet パラメーターは、リソースの複数のインスタンスが存在する場合に使用されます。 SelectorSet パラメーターの値はハッシュ テーブルである必要があります。 次の例では、このパラメーターの値を入力する方法を示します。
-SelectorSet @{Name="WinRM";ID="yyy"}
型: | Hashtable |
配置: | 1 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-SessionOption
WS-Management セッションの一連の拡張オプションを定義します。 New-WSManSessionOption
コマンドレットを使用して作成する SessionOption オブジェクトを入力します。 使用可能なオプションの詳細については、「 New-WSManSessionOptionを参照してください。
型: | SessionOption |
Aliases: | so |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-UseSSL
Secure Sockets Layer (SSL) プロトコルを使用してリモート コンピューターとの接続を確立するように指定します。 既定では、SSL は使用されません。
WS-Management は、ネットワークを介して転送されるすべての Windows PowerShell コンテンツを暗号化します。 UseSSL パラメーターを使用すると、HTTP ではなく HTTPS の追加保護を指定できます。 接続に使用するポートで SSL を使用できない場合に、このパラメーターを指定すると、コマンドは失敗します。
型: | SwitchParameter |
Aliases: | ssl |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ValueSet
管理リソースの変更に役立つハッシュ テーブルを指定します。 管理リソースは、 ResourceURI パラメーターと SelectorSet パラメーターを使用して指定します。 ValueSet パラメーターの値はハッシュ テーブルである必要があります。
型: | Hashtable |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
入力
None
このコマンドレットにオブジェクトをパイプすることはできません。
出力
このコマンドレットは、更新された WSMan インスタンスを XmlElement オブジェクトとして返します。
関連リンク
PowerShell