PowerShell モジュールのコマンドレットとコマンド

PowerShell モジュール

Windows PowerShell® は、特にシステム管理用に設計されたタスク ベースのコマンド ライン シェルおよびスクリプト言語です。 .NET Framework 上に構築された Windows PowerShell は、IT プロフェッショナルやパワー ユーザーが Windows 上で実行される Windows オペレーティング システムとアプリケーションの管理を制御および自動化するのに役立ちます。 DRDA サービスは、一般的な HIS 2013 PowerShell モジュール、Microsoft.HostIntegration.PowerShell の一部として PowerShell コマンドを提供します。これには、MsDrdaService.exe.config の要素と属性を追加、取得、削除、設定するためのコマンドレット コマンド、リスナーを開始/停止するコマンドが含まれます。

PowerShell コマンドレット

PowerShell コマンドレットは、Windows PowerShell 環境で使用される軽量のコマンドです。 Windows PowerShell ランタイムは、コマンド ラインで提供されるオートメーション スクリプトのコンテキスト内でこれらのコマンドレットを呼び出します。 Windows PowerShell ランタイムは、Windows PowerShell API を使用してプログラムによって呼び出します。

ユーザーまたはコマンドレットを実行しているアプリケーションで使用できるパラメーターを定義するパブリック プロパティ。 コマンドレットには、必須パラメーター、名前付きパラメーター、位置指定パラメーター、およびスイッチ パラメーターを指定できます。 switch パラメーターは、コマンドの実行時に指定される場合と指定できない場合があるパラメーターです。 パラメーターが指定されている場合、Windows PowerShell ランタイムはその値を true として解決します。 パラメーターが指定されていない場合 (通常は既定値)、パラメーター値は false として解決されます。 共通パラメーターはすべてのコマンドレットに追加され、コマンドレットが実行されるたびにアクセスできます。

DRDA サービス PowerShell モジュールコマンドレット コマンド

DRDA サービス構成は、MsDrdaService.exe.config アプリケーション構成 (アプリ構成) ファイルと、関連する XML ファイル (エラー メッセージ マッピングとデータ型マッピング) に格納されます。 実行時に、DRDA サービスは MsDrdaService.exe.config ファイルの変更を監視します。 検出されると、DRDA サービスは、新しいバインドされた接続を処理するときに、変更された構成情報を読み取って利用します。 DRDA サービスには、アプリケーション構成ファイルを検証するための %SNAROOT%\System\Schemas\HostIntegrationDrdaServiceConfiguration.xsd ファイルが含まれています。

IT プロフェッショナルは、DRDA サービス PowerShell モジュール Microsoft.HostIntegration.PowerShell を使用して DRDA サービス構成をカスタマイズできます。 コマンドレットは、構成コレクションと操作コレクションにグループ化されます。

前提条件ソフトウェア

DRDA サービス PowerShell モジュールには、機能の前提条件として次のソフトウェア製品が必要です。

PowerShell を起動する

次のいずれかのコマンドを実行して、管理者アクセス許可で PowerShell を起動します。

  • スタート画面で Windows PowerShell アプリ タイルを右クリックし、アプリ バーの [管理者として実行] をクリックします。

  • サーバー マネージャーまたはタスク バーのデスクトップで、Windows PowerShell ショートカットを右クリックし、[管理者として実行] をクリックします。

  • デスクトップで、右上隅にカーソルを移動し、[検索] をクリックし、「PowerShell」と入力し、Windows PowerShell アプリ タイルを右クリックして、アプリ バーで [管理者として実行] をクリックします。

  • Windows PowerShell コマンド プロンプトで、次のように入力します。

    Start-Process PowerShell -Verb RunAs
    

PowerShell ISE を起動する

次のいずれかのコマンドを実行して、管理者アクセス許可で PowerShell ISE (統合スクリプト環境) を起動します。

  • スタート画面で「ISE」と入力し、Windows PowerShell ISE タイルを右クリックし、アプリ バーで [管理者として実行] をクリックします。

  • タスク バーで、 Windows PowerShell を右クリックし、[ ISE を管理者として実行] をクリックします。

  • [サーバー マネージャー ツール ] メニューの [Windows PowerShell ISE] を選択します。

  • Windows PowerShell コマンド プロンプトで、次のように入力します。

    Start-Process PowerShell_ISE -Verb RunAs
    

モジュール パスの設定

DRDA サービス PowerShell モジュールは、モジュール パスに含まれている必要があります。 スタンドアロン MsDrdaService.MSIを使用して DRDA サービスをインストールする場合は、PowerShell または PowerShell ISE を使用してモジュール パスを手動で設定する必要があります。

  1. Windows PowerShell または PowerShell ISE コマンド プロンプトで、次のコマンドを入力し、[Enter] をクリックします。

    Import-Module "C:\Program Files\Microsoft Host Integration Server 2013\system\Microsoft.HostIntegration.PowerShell"
    
  2. 次の Get-Module コマンドを入力し、 Enter キーを押します。

    Get-Module Microsoft.HostIntegration.PowerShell
    
  3. 次の情報を確認します。

    ModuleType Version    Name                                ExportedCommands
    ---------- -------    ----                                ----------------
    Binary     9.0.1000.0 Microsoft.HostIntegration.PowerS... {Add-HisDrdaApplicationEncoding, Remove-HisDrdaApplicationEncoding, Get-HisDrdaApplicationEncoding, Add-HisDrdaCollationName...}
    

モジュール コマンドを取得する

  1. Windows PowerShell または PowerShell ISE コマンド プロンプトで、次のコマンドを入力し、[Enter] をクリックします。

    Get-Command -Module Microsoft.HostIntegration.PowerShell
    
  2. 次の情報を確認します。

DRDA サービス コマンド

次の Microsoft.HostIntegration.PowerShell コマンドレット コマンドは、DRDA サービスで使用します。

コマンドタイプ 名前 ModuleName
コマンドレット Add-HisCustomCodePage Microsoft.HostIntegration.PowerShell
コマンドレット Add-HisCustomConversion Microsoft.HostIntegration.PowerShell
コマンドレット Add-HisDrdaApplicationEncoding Microsoft.HostIntegration.PowerShell
コマンドレット Add-HisDrdaCollationName Microsoft.HostIntegration.PowerShell
コマンドレット Add-HisDrdaDatabaseAlias Microsoft.HostIntegration.PowerShell
コマンドレット Add-HisDrdaDatetimeFormat Microsoft.HostIntegration.PowerShell
コマンドレット Add-HisDrdaPackageBindListener Microsoft.HostIntegration.PowerShell
コマンドレット Get-HisCustomCodePage Microsoft.HostIntegration.PowerShell
コマンドレット Get-HisCustomConversion Microsoft.HostIntegration.PowerShell
コマンドレット Get-HisDrdaApplicationEncoding Microsoft.HostIntegration.PowerShell
コマンドレット Get-HisDrdaCollationName Microsoft.HostIntegration.PowerShell
コマンドレット Get-HisDrdaDatabaseAlias Microsoft.HostIntegration.PowerShell
コマンドレット Get-HisDrdaDatetimeFormat Microsoft.HostIntegration.PowerShell
コマンドレット Get-HisDrdaPackageBindListener Microsoft.HostIntegration.PowerShell
コマンドレット Get-HisDrdaPackageBindProcessing Microsoft.HostIntegration.PowerShell
コマンドレット Get-HisDrdaPackageProcedureCache Microsoft.HostIntegration.PowerShell
コマンドレット Get-HisDrdaService Microsoft.HostIntegration.PowerShell
コマンドレット Get-HisDrdaSqlServerConnection Microsoft.HostIntegration.PowerShell
コマンドレット Get-HisDrdaSqlTransform Microsoft.HostIntegration.PowerShell
コマンドレット Get-HisDrdaTraceListener Microsoft.HostIntegration.PowerShell
コマンドレット Remove-HisCustomCodePage Microsoft.HostIntegration.PowerShell
コマンドレット Remove-HisCustomConversion Microsoft.HostIntegration.PowerShell
コマンドレット Remove-HisDrdaApplicationEncoding Microsoft.HostIntegration.PowerShell
コマンドレット Remove-HisDrdaCollationName Microsoft.HostIntegration.PowerShell
コマンドレット Remove-HisDrdaDatabaseAlias Microsoft.HostIntegration.PowerShell
コマンドレット Remove-HisDrdaDatetimeFormat Microsoft.HostIntegration.PowerShell
コマンドレット Remove-HisDrdaPackageBindListener Microsoft.HostIntegration.PowerShell
コマンドレット Set-HisDrdaConsoleTraceListener Microsoft.HostIntegration.PowerShell
コマンドレット Set-HisDrdaEtwTraceListener Microsoft.HostIntegration.PowerShell
コマンドレット Set-HisDrdaEventLogTraceListener Microsoft.HostIntegration.PowerShell
コマンドレット Set-HisDrdaPackageBindProcessing Microsoft.HostIntegration.PowerShell
コマンドレット Set-HisDrdaPackageProcedureCache Microsoft.HostIntegration.PowerShell
コマンドレット Set-HisDrdaService Microsoft.HostIntegration.PowerShell
コマンドレット Set-HisDrdaSqlServerConnection Microsoft.HostIntegration.PowerShell
コマンドレット Set-HisDrdaSqlTransform Microsoft.HostIntegration.PowerShell
コマンドレット Set-HisDrdaTextTraceListener Microsoft.HostIntegration.PowerShell
コマンドレット Start-HisDrdaTraceListener Microsoft.HostIntegration.PowerShell
コマンドレット Stop-HisDrdaTraceListener Microsoft.HostIntegration.PowerShell

表 1. DRDA サービス PowerShell コマンドの一覧。

DRDA サービス接続とパッケージ バインド処理

DRDA サービス接続とパッケージ バインドは、(1) DRDA クライアントから DRDA へのサービス接続、(2) DRDA サービス間接続、(3) DRDA サービス間サービス接続、および (4) DRDA サービス パッケージ バインド処理 (SQL 構文変換を含む) で構成されます。

Set-HisDrdaService

この Set-HisDrdaService コマンドレットは、インバインド DRDA クライアント接続用に DRDA サービスを構成します。

構文

Set-HisDrdaService [-PartnerServers<string>] [-Port<uint32>] [-IsPrimary] [-UseSsl] [-PingInterval<uint32>>] [-EnablePerformanceCounters] [-AllowClientIpAddresses<string] [-SslCertificatePath<string>] [<CommonParameters>]

パラメーター

AllowClientIpAddresses パラメーターは、既知の DRDA AR クライアント コンピューターの一覧から、バインドされた TCP/IP ネットワーク接続を受け入れるように DRDA サービスを制限します。 この 省略可能な パラメーターは、 文字列 値を受け入れます。 既定値は 空の文字列です。これにより、DRDA サービスはすべてのインバインド クライアント接続要求に応答できます。 このリストは、TCP/IP アドレスまたは別名セミコロンで区切られた形式で構成されます。 TCP/IP アドレスは、IPv4 形式または IPv6 形式で定義できます。 たとえば、123.34.45.57 などです。123.34.45.58 は、IPv4 ネットワーク アドレス形式で有効なクライアント リストを定義します。

EnablePeformanceCounters パラメーターは、パフォーマンス カウンターに情報を収集するように DRDA サービスに指示します。 この 省略可能な パラメーターは、 ブール 値を受け取ります。 既定値は false です。

IsPrimary パラメーターは、サーバーのグループ内でプライマリ ロールで動作するかどうかを DRDA サービスに指示します。 この 省略可能な パラメーターは、 ブール 値を受け取ります。 既定値は true です。 プライマリ サーバーは、EXCSAT (Exchange Server Attributes)、ACCSEC (Access Security)、ACCRDB (Access Relational Database) を処理することで、すべての DRDA AR クライアント要求に応答します。これには、ACCRDBRM (ACCRDB 応答メッセージ) で SRVLST (サーバー リスト) が返されます。 サーバー一覧には、DRDA サービス コンピューターが接続する DRDA AR クライアントに通知するために、プライマリ (最も重み付けされた値) とセカンダリ サーバー (最も重み付けされた値が最も低い) の重み付け優先度リストが含まれています

PartnerServers パラメーターは、セカンダリ サーバー コンピューターの一覧を定義します。 この 省略可能な パラメーターは、isPrimary=false の場合に必要であり、 文字列 値を受け入れます。 既定値は 空の文字列です。 このリストは、TCP/IP ポート番号で区切られた TCP/IP アドレスまたは別名コロンで構成されます。 TCP/IP アドレスは、IPv4 形式または IPv6 形式で定義できます。 リストには、セミコロンで区切られた複数のパートナー サーバー コンピューターを含めることができます。 たとえば、123.34.45.57:446 です。123.34.45.58:446 は、IPv4 ネットワーク アドレス形式で有効なパートナー サーバー リストを定義します。

PingInterval パラメーターは、EXCSAT (Exchange Server 属性) フローを実行し、EXCSATRD (EXCSAT 応答データ) を確認することによって、パートナー サーバー コンピューターの正常性を監視する頻度を DRDA サービスに指示します。 この 省略可能な パラメーターは 整数値 を受け取ります。 既定値は 1,0000 ミリ秒 (10 秒) です。

Port パラメーターは、DRDA サービスがインバインド DRDA アプリケーションリクエスター クライアント接続要求をリッスンする必要がある TCP/IP ポート番号を定義します。 この 省略可能な パラメーターは 整数値 を受け取ります。 既定値は 446 です

SslCertificatePath パラメーターは、SSL または TLS 証明書の共通名 (CN) を指定します。 この 省略可能な パラメーターは、useSSL=true の場合に必要であり、 文字列 値を受け入れます。 既定値は 空の文字列です。

UseSSL パラメーターは、バインドされた TCP/IP ネットワーク接続に応答するときに、Secure Sockets Layer (SSL) バージョン 3.0 とトランスポート層セキュリティ (TLS) バージョン 1.0 を使用するように DRDA サービスに指示します。 この 省略可能な パラメーターは、 ブール 値を受け取ります。 既定値は false です。

次のコマンド例では、既定値を設定します。

Set-HisDrdaService -IsPrimary -PingInterval 10000 -Port 446

Get-HisDrdaService

この Get-HisDrdaService コマンドレットは、インバインド DRDA クライアント接続の DRDA サービス構成設定を取得します。

構文

Get-HisDrdaService [<CommonParameters>]

パラメーター

なし。

出力

この Get-HisDrdaService コマンドレットは、AllowClientIpAddresses (string) プロパティを持つオブジェクトを返します。IsPrimary (Boolean);PartnerServers (string);EnablePerformanceCounters (Boolean);PingInterval (整数);ポート (整数);SslCertificatePath (string);と UseSsl (ブール値)。

次のコマンド例では、既定値を取得します。

Get-HisDrdaService
AllowClientIpAddresses    :
IsPrimary                 : True
PartnerServers            :
EnablePerformanceCounters : false
PingInterval              : 10000
Port                      : 446
SslCertificatePath        :
UseSsl                    : false

Set-DrdaSqlServerConnection

この Set-DrdaSqlServerConnection コマンドレットは、アウトバウンド SQL Server 接続用に DRDA サービスを構成します。

構文

Set-DrdaSqlServerConnection [-MappedAuthenticationDomain<string>] [-AuthenticationLookupTimeoutDuration<string>] [-AuthenticationLookupRetryCount<uint32>] [-SecurityTokenTimeoutDuration<string>] [-RollbackTransactionOnError] [-ClientApplicationName<ClientApplicationName>] [-DefaultCollationName<string>] [-ConnectionString <string>] [-StoredProcedureCallTimeout<uint32>] [-HostInitiatedAffiliateApplication<string>] [-WindowsInitiatedAffiliateApplication<string>] [-EnableArithAbort] [<CommonParameters>]

パラメーター

AuthenticationLookupRetryCount パラメーターは、障害が発生するまでのセキュリティ認証参照要求を試行する回数を DRDA サービスに指示します。 この 省略可能な パラメーターは 整数値 を受け取ります。 既定値は 3 回の再試行です

AuthenticationLookupTimeoutDuration パラメーターは、障害が発生するまでのセキュリティ認証参照要求を待機する期間を DRDA サービスに指示します。 この 省略可能な パラメーターは、XML 期間の値を表す 文字列 値を受け取ります。 既定値は PT30S です (期間は 30 秒です)。 期間の値は、PnYnMnDTnHnMnS という形式で指定されます。 値の詳細と説明については、「データ統合 (デプロイ)、DRDA サービス、SQL Server 接続の構成」を参照してください。

ClientApplicationName パラメーターは、SQL クライアント アプリケーション名の接続プロパティを設定する方法を DRDA サービスに指示します。 この 省略可能な パラメーターは、列挙された文字列値を受け取ります。 既定値は です。 externalName を指定して、DRDA AR クライアント プログラムのジョブ、タスク、またはプロセスの名前を表す DRDA 外部名 (EXTNAM) のバイト 1 から 8 を使用するように DRDA サービスに指示します。 transactionIdentifier を指定して、CICS for z/OS で実行するときに DRDA AR クライアント プログラムのトランザクション識別子の名前を表す EXTNAM のバイト 5 から 8 を使用するように DRDA サービスに指示します。

ConnectionString パラメーターは、MICROSOFT ADO.NET Framework Data Provider for SQL Server 接続オブジェクトを定義する際に DRDA サービスが使用する引数の名前と値のペアの一覧を定義します。 この 必須 パラメーターは 、文字列 値を受け取ります。 既定値は Data Source=; です。Integrated Security=True;MultipleActiveResultSets=True。 詳細については、「データ統合 (デプロイ)、DRDA サービス、SQL Server 接続の構成」を参照してください。

DEFAULTCollationName パラメーターは、ORDER BY 句を使用して DB2 SELECT ステートメントを ORDER BY 句を使用して SQL Server SELECT ステートメントに変換するときに、SQL Server COLLATE (collation_name) 句を追加するように DRDA サービスに指示します。 この 省略可能な パラメーターは、 文字列 値を受け入れます。 既定値は SQL_Latin1_General_CP1_CI_AS です。 値の詳細と説明については、「データ統合 (デプロイ)、DRDA サービス、照合順序マッピングの構成」を参照してください。

EnableArithAbort パラメーターは、接続時に SET ARITHABORT ステートメントを発行するように DRDA サービスに指示し、クエリの実行中にオーバーフローまたは 0 除算エラーが発生したときに SQL Server にクエリを終了するよう要求します。 この 省略可能な パラメーターは、 ブール 値を受け取ります。 既定値は false です。

HostInitiatedAffiliateApplication パラメーターは、SQL クライアントが Windows 認証を使用する場合に、DRDA サービスが Microsoft Enterprise Single Sign-On で使用する関連アプリケーション名を定義して、バインドされた DRDA AR クライアント資格情報を Windows Active Directory ドメイン ユーザーにマップします。 この 省略可能な パラメーターは、 文字列 値を受け入れます。 既定値は 空の文字列で、ホストによって開始される ESSO を使用しないように DRDA サービスに指示します。 ホストによって開始される ESSO を使用する場合は、SQL Server 接続文字列で Integrated Security=true を指定する必要があります。

MappedAuthenticationDomain パラメーターは、統合セキュリティ サポート プロバイダー インターフェイス (SSPI) を使用して Windows 認証用に構成された SQL Server に接続するときに、Microsoft Windows Active Directory ドメインがバインドされた DRDA クライアント資格情報 (ユーザー名とパスワード) をマップするように DRDA サービスに指示しますが、Microsoft Enterprise シングル サインオンを使用する場合は指定しません。 この 省略可能な パラメーターは、 文字列 値を受け入れます。 既定値は 空の文字列です。

RollbackTransactionOnError パラメーターは、負の SQL Server データベース エラーの後に ROLLBACK を実行するように DRDA サービスに指示します。 この 省略可能な パラメーターは、 ブール 値を受け取ります。 既定値は true です。

SecurityTokenTimeout パラメーターは、一定期間セキュリティ トークンを保持するように DRDA サービスに指示し、その後、新しい Windows クライアント識別子 (CID) を取得します。 この 省略可能な パラメーターは、 期間 の値を受け入れます。 既定値は PT8H です (期間は 8 時間です)。 期間の値は、PnYnMnDTnHnMnS という形式で指定されます。 値の詳細と説明については、「データ統合 (デプロイ)、DRDA サービス、SQL Server 接続の構成」を参照してください。

WindowsInitiatedAffiliateApplication パラメーターは、SQL クライアントが SQL Server 認証を使用する場合に、DRDA サービスが Microsoft Enterprise Single Sign-On で Windows Active Directory ドメイン ユーザーをアウトバインド SQL クライアント資格情報にマップするために使用する関連アプリケーション名を定義します。 この 省略可能な パラメーターは、 文字列 値を受け入れます。 既定値は 空の文字列で、Windows によって開始される ESSO を使用しないように DRDA サービスに指示します。 Windows によって開始される ESSO を使用する場合は、SQL Server 接続文字列で Integrated Security=false を指定する必要があります。

StoredProcedureCallTimeout パラメーターは、試行を終了してエラーを生成する前に、SQL Server が CALL ステートメントを処理してストアド プロシージャを実行するのを待機する時間 (秒単位) を DRDA サービスに指示します。 この 省略可能な パラメーターは 整数値 を受け取ります。 有効な値は 0 以上で、2147483647以下です。 値 0 は制限がないことを示します (コマンドを実行しようとすると無期限に待機します)。 既定値は 30 秒です。

次のコマンド例では、既定値を設定します。

注意事項

この例またはガイダンスでは、接続文字列やユーザー名とパスワードなどの機密情報を参照します。 これらの値をコードにハードコーディングしないでください。また、使用可能な最も安全な認証を使用して機密データを保護してください。 詳しくは、次のドキュメントをご覧ください。

Set-HisDrdaSqlServerConnection -AuthenticationLookupRetryCount 3 -AuthenticationLookupTimeoutDuration PT30S -ClientApplicationName empty -ConnectionString "Data Source=localhost; Integrated Security=True; MultipleActiveResultSets=True" -DefaultCollationName SQL_Latin1_General_CP1_CI_AS -RollbackTransactionOnError -SecurityTokenTimeoutDuration PT8H -StoredProcedureCallTimeout 30

Get-DrdaSqlServerConnection

この Get-DrdaSqlServerConnection コマンドレットは、アウトバウンド SQL Server 接続の DRDA サービス構成設定を取得します。

構文

Get-DrdaSqlServerConnection [<CommonParameters>]

パラメーター

なし。

出力

この Get-DrdaSqlServerConnection コマンドレットは、ArithAbort (Boolean) プロパティを持つオブジェクトを返します。AuthenticationLookupTimeout (string);AuthenticationLookupRetryCount (整数);ClientApplicationName (string);ConnectionString (string);DefaultCollationName (string);HostInitiatedAffiliateApplication (string);MappedAuthenticationDomain (string);RollbackTransactionOnError (Boolean);SecurityTokenTimeoutSeconds (string);StoredProcedureCallTimeoutSeconds (integer);および WindowsInitiatedAffiliateApplication (string)。

次のコマンド例では、既定値を取得します。

Get-HisDrdaSqlServerConnection
ArithAbort                           :
AuthenticationLookupTimeout          : PT30S
AuthenticationLookupRetryCount       : 3
ClientApplicationName                :
ConnectionString                     : Data Source=localhost;Integrated Security=True;MultipleActiveResultSets=True
DefaultCollationName                 : SQL_Latin1_General_CP1_CI_AS
HostInitiatedAffiliateApplication    :
MappedAuthenticationDomain           :
RollbackTransactionOnError           : true
SecurityTokenTimeoutSeconds          : PT8H
StoredProcedureCallTimeoutSeconds    : 30
WindowsInitiatedAffiliateApplication :

Set-DrdaPackageBindProcessing

この Set-DrdaPackageBindProcessing コマンドレットは、DRDA 静的 SQL パッケージを SQL Server ストアド プロシージャに処理するように DRDA サービスを構成します。

構文

Set-DrdaPackageBindProcessing [-CreatePackageProcedureWithCustomSqlScripts ] [-PackageProcedureSchemaList <string>] [-CreatePackageProcedure] [-CreatePackageXml] [-PackageXmlFormat <PackageXmlFormatPackageXmlFormat Set-DrdaPackageBindProcessing >] [-PackageXmlLocation <string>] [-StoredProcedureNameSeparator <string>] [-CreatePackageProcedureWithExtendedProperties ] [<CommonParameters>]

パラメーター

CreatePackageProcedure パラメーターは、単一の BGNBND フローを SQL Server ストアド プロシージャに処理し、DRDA BNDSQLSTT フローによって定義された元のステートメントを対応する SQL Server 構文に変換するように DRDA サービスに指示します。 この 省略可能な パラメーターは、 ブール 値を受け取ります。 既定値は true です。

CreatePackageProcedureWithCustomSqlScripts パラメーターは、外部カスタム パッケージ バインド リスナー コンポーネントを介して DRDA BGNBND と BNDSQLSTT を処理するように DRDA サービスに指示します。 この 省略可能な パラメーターは、 ブール 値を受け取ります。 既定値は false です。

CreatePackageProcedureWithExtendedProperties パラメーターは、BGNBND パッケージバインド オプションを SQL Server ストアド プロシージャの拡張プロパティとして保持するように DRDA サービスに指示します。 この 省略可能な パラメーターは、 ブール 値を受け取ります。 既定値は false です。

CreatePackageXml パラメーターは、DRDA BNDSQLSTT フローによって定義された元のバインド オプションとステートメントを保持して、単一の BGNBND フローを静的 SQL for DB2 パッケージ XML ファイルに処理するように DRDA サービスに指示します。 この 省略可能な パラメーターは、 ブール 値を受け取ります。 既定値は false です。

PackageProcedureSchemaList は、DRDA サービスに対して、代替スキーマでターゲット SQL Server ストアド プロシージャを検索するように指示します。 この 省略可能な パラメーターは、 文字列 値を受け入れます。 既定値は 空の文字列です。 文字列は、コンマ区切りの SQL Server スキーマ名で構成されます。 packageProcedureSchemaList パラメーターは、IBM DB2 for z/OS CURRENT PACKAGESET 特殊レジスターおよび SET CURRENT PACKAGESET ステートメントに似ています。

PackageXmlFormat パラメーターは、DB2 XML 用の静的 SQL ファイルを v90 または v85 形式で書き込むよう DRDA サービスに指示します。 この 省略可能な パラメーターは、v85 または v90 のいずれかの列挙 文字列 値を受け取ります。 既定値は v90 です

PackageXmlLocation パラメーターは、DB2 パッケージ XML ファイルの静的 SQL を書き込む場所を DRDA サービスに指示します。 この 省略可能な パラメーターは、 文字列 値を受け入れます。 既定値は c:\temp です

StoredProcedureNameSeparator パラメーターは、DRDA パッケージ名を SQL Server ストアド プロシージャ名にマッピングするときに使用する区切り文字を DRDA サービスに指示します。 この 省略可能な パラメーターは、 文字列 値を受け入れます。 既定値は 1 つの アンダースコア 文字 (_) です。

次のコマンド例では、既定値を設定します。

Set-HisDrdaPackageBindProcessing -CreatePackageProcedure -PackageXmlFormat v90 -PackageXmlLocation c:\temp -StoredProcedureNameSeparator _

Get-HisDrdaPackageBindProcessing

この Get-HisDrdaPackageBindProcessing コマンドレットは、DRDA 静的 SQL パッケージを SQL Server ストアド プロシージャに処理するための DRDA サービス構成設定を取得します。

構文

Get-HisDrdaPackageBindProcessing [<CommonParameters>]

パラメーター

なし。

出力

この Get-HisDrdaPackageBindProcessing コマンドレットは、CreatePackageProcedure (Boolean) プロパティを持つオブジェクトを返します。CreatePackageXml (Boolean);PackageXmlFormat (string);PackageXmlLocation (string);StoredProcedureNameSeparator (string);CreatePackageProcedureWithExtendedProperties (Boolean);CreatePackageProcedureWithCustomSqlScripts (Boolean);および PackageProcedureSchemaList (string)。

次のコマンド例では、既定値を取得します。

Get-HisDrdaPackageBindProcessing
CreatePackageProcedure                       : true
CreatePackageXml                             : false
PackageXmlFormat                             : v90
PackageXmlLocation                           : c:\temp
StoredProcedureNameSeparator                 : _
CreatePackageProcedureWithExtendedProperties : false
CreatePackageProcedureWithCustomSqlScripts   : false
PackageProcedureSchemaList                   :

Set-HisDrdaPackageProcedureCache

この Set-HisDrdaPackageProcedureCache コマンドレットは、ステートメントの種類、カーソルの種類、パラメーター データ型、およびその他の属性を検証する SQL Server ストアド プロシージャのメタデータをキャッシュするように DRDA サービスを構成します。

構文

Set-HisDrdaPackageProcedureCache -FlushTimeSpan < string> [<CommonParameters>]

パラメーター

FlushTimeSpan パラメーターは、指定された時間間隔後にパッケージ プロシージャ キャッシュをフラッシュするように DRDA サービスに指示します。 この 省略可能な パラメーターは、XML 期間の値を表す 文字列 値を受け取ります。 既定値は P1D です (期間は 1 日です)。 期間の値は、PnYnMnDTnHnMnS という形式で指定されます。 値の詳細と説明については、「データ統合 (デプロイ)、DRDA サービス、パッケージ バインド処理の構成」を参照してください。

次のコマンド例では、既定値を設定します。

Set-HisDrdaPackageProcedureCache -FlushTimeSpan P1D

Get-HisDrdaPackageProcedureCache

この Get-HisDrdaPackageProcedureCache コマンドレットは、ステートメントの種類、カーソルの種類、パラメーター のデータ型、およびその他の属性を検証する SQL Server ストアド プロシージャのメタデータをキャッシュするための DRDA サービス構成設定を取得します。

構文

Get-HisDrdaPackageProcedureCache [<CommonParameters>]

パラメーター

なし。

出力

この Get-HisDrdaPackageProcedureCache コマンドレットは、プロパティ FlushTimeSpan (string) を持つオブジェクトを返します。

次のコマンド例では、既定値を取得します。

Get-HisDrdaPackageProcedureCache
FlushTimeSpan
-------------
P1D

Set-HisDrdaSqlTransform

この Set-DrdaSqlTransform コマンドレットは、内部または外部の CLR ベースの SQL 変換を使用して DB2 関数の構文を SQL Server T-SQL 関数構文に変換するように DRDA サービスを構成します。

構文

Set-DrdaSqlTransform [-EnableUnicodeOutput] [-Type<SqlTransforms>] [<CommonParameters>]

パラメーター

EnableUnicodeOutput パラメーターは、CLR ベースの SQL トランスフォーマーからの出力を Unicode または ANSI でエンコードするように DRDA サービスに指示します。 この 省略可能な パラメーターは、 ブール 値を受け取ります。 既定値は false で、 ANSI CHAR 文字列と VARCHAR 文字列を出力するように DRDA サービスに指示します。

Type パラメーターは、内部サービスまたは外部 CLR ベースの SQL 変換を利用するように DRDA サービスに指示します。 この省略可能なパラメーターは、Service または ClrType 値を受け取ります。 既定値は Service です

次のコマンド例では、既定値を設定します。

Set-HisDrdaSqlTransform -Type Service

Get-HisDrdaSqlTransform

この Get-HisDrdaSqlTransform コマンドレットは、内部または外部の CLR ベースの SQL 変換を使用して DB2 関数の構文を SQL Server T-SQL 関数構文に変換するための DRDA サービス構成設定を取得します。

構文

Get-HisDrdaSqlTransforms [<CommonParameters>]

パラメーター

なし。

出力

この Get-HisDrdaSqlTransforms コマンドレットは、Type (SqlTransforms) プロパティを持つオブジェクトを返します。と EnableUnicodeOutput (Boolean)。

次のコマンド例では、既定値を取得します。

Get-HisDrdaSqlTransform
Type
----
Service

EnableUnicodeOutput
-------------------
False

データベース エイリアス マッピング

IBM DB2 および Microsoft SQL Server データベースでは、テーブルの完全修飾 3 部構成のオブジェクト識別子を定義する次の表に示すように、オブジェクトの名前付けに異なる用語を使用します。 DRDA サービスは、DB2 カタログ名とスキーマ名を SQL Server カタログ名とスキーマ名にマップできます。 詳細については、「データベース エイリアス マッピングの構成」を参照してください。

Add-HisDrdaDatabaseAlias

この Add-HisDrdaDatabaseAlias コマンドレットは、バインドされたカタログ名とスキーマ名を送信カタログ名とスキーマ名にマッピングするように DRDA サービスを構成します。これは、SQL Server ストアド プロシージャにマップされた DB2 コマンドに対して静的 SQL パッケージを実行するときに使用します。

構文

Add-HisDrdaDatabaseAlias -SourceLocation<string> -SourceCollection<string> -TargetDatabase<string> -TargetSchema<string> [<CommonParameters>]

パラメーター

SourceLocation パラメーターは、バインドされていない SQL Server データベース名へのマッピング時に DRDA サービスが使用する必要があるインバインド DRDA RDBNAM (リレーショナル データベース名) を定義します。 この 省略可能な パラメーターは、 文字列 値を受け入れます。 既定値は 空の文字列で、任意の値を表します。

SourceCollection パラメーターは、バインドされていない SQL Server スキーマ名にマッピングするときに DRDA サービスが使用する必要があるインバインド DRDA COLID (コレクション識別子) を定義します。 この 省略可能な パラメーターは、 文字列 値を受け入れます。 既定値は 空の文字列で、任意の値を表します。

TargetDatabase パラメーターは、インバインド DRDA RDBNAM 値からのマッピング時に DRDA サービスが使用する必要がある、アウトバウンド SQL Server データベース名を定義します。 この 省略可能な パラメーターは、 文字列 値を受け入れます。 既定値は 空の文字列で、任意の値を表します。

TargetSchema パラメーターは、インバインド DRDA COLID 値からのマッピング時に DRDA サービスが使用する必要がある、アウトバウンド SQL Server スキーマ名を定義します。 この 省略可能な パラメーターは、 文字列 値を受け入れます。 既定値は 空の文字列で、任意の値を表します。

次のコマンド例では、サンプル値を追加します。

Add-HisDrdaDatabaseAlias -SourceCollection DSN8HC91 -SourceLocation CONTOSO -TargetDatabase ContosoRetailDW -TargetSchema DSN8910

Get-HisDrdaDatabaseAlias

この Get-HisDrdaDatabaseAlias コマンドレットは、バインドされたカタログ名とスキーマ名を送信カタログ名とスキーマ名にマッピングするための DRDA サービス構成設定を取得します。これは、SQL Server ストアド プロシージャにマップされた DB2 コマンドに対して静的 SQL パッケージを実行するときに使用します。

構文

Get-HisDrdaDatabaseAlias [<CommonParameters>]

パラメーター

なし。

出力

この Get-HisDrdaDatabaseAlias コマンドレットは、SourceLocation (string) プロパティのコレクションを持つオブジェクトを返します。SourceCollection (string);TargetDatabase (string);および TargetSchema (string)。

次のコマンド例では、サンプル値を取得します。

Get-HisDrdaDatabaseAlias
SourceLocation
--------------
CONTOSO

SourceCollection
----------------
DSN8HC91

TargetDatabase
--------------
ContosoRetailDW

TargetSchema
------------
DSN8910

DRDA サービスの日時変換

DRDA サービスは、特定の日付時刻および文字データ型に対して動的および静的 SQL ステートメントを処理するときに、ソースおよびターゲット形式の文字列リテラル日時値を書式設定します。

Add-DrdaDatetimeFormat

この Add-DrdaDatetimeFormat コマンドレットは、DB2 および SQL Server DATE (10)、VARCHAR (10) データ型内の文字列リテラル日付値を処理し、DB2 日付形式から SQL Server 日付形式に変換し、SQL Server 日付形式から DB2 日付形式に変換するように DRDA サービスを構成します。 dateMasks には、日付マッピングを定義する 1 つ以上の dateMask 要素が含まれています。 dateMask 要素には、方向を示す db2ToSql または sqlToDb2 と、マッピングを指定する sourceFormat と targetFormat が含まれています。 値の詳細と説明については、「データ統合 (デプロイ)、DRDA サービス、日付時刻変換の構成」を参照してください。

構文

Add-DrdaDatetimeFormat -Conversion < Conversion> -DateFormat <DateFormats> [<CommonParameters>]

Add-DrdaDatetimeFormat -Conversion < Conversion> -TimeFormat <TimeFormats> [<CommonParameters>]

Add-DrdaDatetimeFormat -Conversion < Conversion> -DateTimeFormat <DateTimeFormats> [<CommonParameters>]

パラメーター

変換パラメーターは、DB2 から SQL への方向または SQL から DB2 への方向を定義します。 この 必須 パラメーターは、 列挙された Conversion 値を受け取ります。 Db2toSql を指定して、バインドされた DateTime 形式を変換するために読み取るよう DRDA サービスに指示します。 バインド外の DateTime 形式を変換するように書き込むよう DRDA サービスに指示する SqlToDb2 を指定します。

DateFormat パラメーターは、書式の種類を定義します。 この必須パラメーターは、列挙 された DateFormat 値を受け取ります。

TimeFormat パラメーターは、書式の種類を定義します。 この必須パラメーターは、列挙された TimeFormat 値を受け取ります。

DateTimeFormat パラメーターは、書式の種類を定義します。 この必須パラメーターは、列挙 された DateTimeFormat 値を 受け取ります。

値の詳細と説明については、「データ統合 (デプロイ)、DRDA サービス、日付時刻変換の構成」を参照してください。

次のコマンド例では、サンプルの Date 値を設定します。

Add-HisDrdaDatetimeFormat -Conversion Db2ToSql -DateFormat Usa

次のコマンド例では、時間値のサンプルを設定します。

Add-HisDrdaDatetimeFormat -Conversion Db2ToSql -TimeFormat HmsPeriod

次のコマンド例では、サンプルの Date 値を設定します。

Add-HisDrdaDatetimeFormat -Conversion Db2ToSql -DateTimeFormat IsoTimestampFormat

Get-HisDrdaDatetimeFormat

この Get-HisDrdaDatetimeFormat コマンドレットは、DB2 および SQL Server DATE、CHAR (10)、VARCHAR (10) データ型内の文字列リテラル日付値を処理し、DB2 日付形式から SQL Server 日付形式に変換し、SQL Server 日付形式から DB2 日付形式に変換するための DRDA サービス構成設定を取得します。

構文

Get-HisDrdaDatetimeFormat -DateTime<DateTime> [<CommonParameters>]

パラメーター

DateTime パラメーターは、構成済みの形式変換を返すように DRDA サービスに指示します。 この 必須 パラメーターは、 列挙された DateTime 値を 受け取ります。 既定値はありません。 Date を指定して、構成された日付形式変換を返すように DRDA サービスに指示します。 構成された時刻形式変換を返すように DRDA サービスに指示する 時間 を指定します。 DateTime を指定して、構成された DateTime 形式変換を返すように DRDA サービスに指示します。

出力

この Get-HisDrdaDatetimeFormat コマンドレットは、Db2ToSql (string) プロパティのコレクションを持つオブジェクトを返します。と SqlToDb2 (文字列)。

次のコマンド例では、既定の日付値を取得します。

Get-HisDrdaDatetimeFormat -DateTime Date
Db2ToSql
--------
Iso

SqlToDb2
--------
Iso

次のコマンド例では、既定の時刻値を取得します。

Get-HisDrdaDatetimeFormat -DateTime Date
Db2ToSql
--------
HmsColong
HmsPeriod

SqlToDb2
--------
HmsColon

次のコマンド例では、既定の DateTime 値を取得します。

Get-HisDrdaDatetimeFormat -DateTime Date
Db2ToSql
--------
Db2TimestampFormat

SqlToDb2
--------
Db2TimestampFormat

Remove-HisDrdaDatetimeFormat

この Remove-HisDrdaDatetimeFormat コマンドレットは、DB2 および SQL Server DATE、CHAR (10)、VARCHAR (10) データ型内の文字列リテラル日付値を処理するための 1 つ以上の DRDA サービス構成設定を削除して、DB2 日付形式から SQL Server 日付形式に変換し、SQL Server 日付形式から DB2 日付形式に変換します。

構文

Remove-HisDrdaDatetimeFormat -DateTime<DateTime> -Conversion<Conversion> -Format<string> [<CommonParameters>]

パラメーター

DateTime パラメーターは、構成済みの形式変換を削除するように DRDA サービスに指示します。 この 必須 パラメーターは、 列挙された DateTime 値を 受け取ります。 既定値はありません。 Date を指定して、構成された日付形式変換を削除するように DRDA サービスに指示します。 構成された時刻形式変換を削除するように DRDA サービスに指示する 時間 を指定します。 DateTime を指定して、構成された DateTime 形式変換を削除するように DRDA サービスに指示します。

変換パラメーターは、DB2 から SQL への方向または SQL から DB2 への方向を定義します。 この 必須 パラメーターは、 列挙された Conversion 値を受け取ります。 Db2toSql を指定して、バインドされた DateTime 形式を変換するために読み取るよう DRDA サービスに指示します。 バインド外の DateTime 形式を変換するように書き込むよう DRDA サービスに指示する SqlToDb2 を指定します。

Format パラメーターは、書式の種類を定義します。 この必須パラメーターは、列挙 された DateFormatTimeFormat、または DateTimeFormat 値を 受け取ります。

次のコマンド例では、サンプルの Date 値を削除します。

Remove-HisDrdaDatetimeFormat -Conversion Db2ToSql -DateTime Date -Format Usa

次のコマンド例では、時間値のサンプルを設定します。

Remove-HisDrdaDatetimeFormat -Conversion Db2ToSql -DateTime Time -Format HmsPeriod

次のコマンド例では、サンプルの Date 値を設定します。

Remove-HisDrdaDatetimeFormat -Conversion Db2ToSql -DateTime DateTime -Format IsoTimestampFormat

DRDA サービス エンコード

DRDA サービスは、コード ページをマップし、基になる HIS Encoder コンポーネントと Windows 各国語サポート (NLS) システム コンポーネントを使用したカスタム コード ページ変換をサポートします。 Microsoft Windows Update を使用すると、Windows NLS コード ページ変換ライブラリを含む追加の Windows 言語パックをインストールできます。 必要に応じて、HIS エンコーダーは、MsDrdaService.exe.config ファイルの codePages 部分内で定義された codePage 要素に基づいて、カスタム NLS コード ページを読み込むことができます。 HIS エンコーダーは、標準 NLS 内のコード ポイントと、MsDrdaService.exe.config ファイルの codePages 部分内で定義された ebcdicToUnicodeConversion 要素に基づいてカスタム NLS コード ページをマップできます。 値の詳細と説明については、「サービス エンコードの構成」を参照してください。

Add-HisCustomCodePage

この Add-HisCustomCodePage コマンドレットは、カスタム Windows 各国語サポート (NLS) システム コード ページ変換ファイルを読み込むよう HIS Encoder コンポーネントに指示するように DRDA サービスを構成します。

構文

Add-HisCustomCodePage -CodePage<uint32> -Name<string> -NlsCodePage<uint32> [-Description<string>] [<CommonParameters>]

パラメーター

CodePage パラメーターは、番号付きのカスタム NLS コード ページ ファイルを読み込むよう HIS エンコーダーに指示します。 この 必須 パラメーターは 整数を受け入れます。 既定値は0です。

Name パラメーターは、定義されたカスタム NLS コード ページ番号に基づいて HIS エンコーダーが読み込む必要があるカスタム NLS コード ページに名前を付けます。 この 必須 パラメーターは 文字列を受け入れます。 既定値は 空の文字列です。

NlsCodePage パラメーターは、HIS エンコーダーがカスタム コード ページ番号に置き換える必要がある標準の NLS コード ページ番号を定義します。 この 必須 パラメーターは 整数を受け入れます。 既定値は0です。

Description パラメーターは、定義されたカスタム NLS コード ページ番号に基づいて HIS エンコーダーが読み込む必要があるカスタム NLS コード ページを記述します。 この 省略可能な パラメーターは 文字列を受け入れます。 既定値は 空の文字列です。

次のコマンド例では、サンプル値を設定します。

Add-HisCustomCodePage -CodePage 21140 -Name Custom21140 -NlsCodePage 1140 -Description "Custom codepage based on 1140"

Get-HisCustomCodePage

この Get-HisCustomCodePage コマンドレットは、カスタム Windows 各国語サポート (NLS) システム コード ページ変換ファイルを読み込むよう HIS Encoder コンポーネントに指示するための DRDA サービス構成設定を取得します。

構文

Get-HisCustomCodePage [-CodePage<uint32>] [-Name<string>] [-NlsCodePage<uint32>] [<CommonParameters>]

パラメーター

CodePage パラメーターは、この番号付きカスタム NLS コード ページ ファイルを使用して構成設定を取得するように DRDA サービスに指示します。 この 省略可能な パラメーターは 整数を受け入れます。 既定値は0です。

Name パラメーターは、このカスタム NLS コード ページ名を使用して構成設定を取得するように DRDA サービスに指示します。 この 省略可能な パラメーターは 文字列を受け入れます。 既定値は 空の文字列です。

NlsCodePage パラメーターは、このカスタム コード ページ番号を使用して構成設定を取得するように DRDA サービスに指示します。 この 省略可能な パラメーターは 整数を受け入れます。 既定値は0です。

出力

この Get-HisCustomCodePage コマンドレットは、Name (string) プロパティを持つオブジェクトを返します。CodePage (整数);NlsCodePage (整数);と説明 (文字列)。

次のコマンド例では、サンプル値を取得します。

Get-HisCustomCodePage -CodePage 21140 -Name Custom21140 -NlsCodePage 1140
Name
----
Custom21140

CodePage
--------
21140

Description
-----------
Custom code based on 1140

NlsCodePage
1140

Remove-HisCustomCodePage

この Remove-HisCustomCodePage コマンドレットは、カスタム Windows 各国語サポート (NLS) システム コード ページ変換ファイルを読み込むよう HIS Encoder コンポーネントに指示するための DRDA サービス構成設定を削除します。

構文

Remove-HisCustomCodePage [-Name] <string> [<CommonParameters>]

パラメーター

Name パラメーターは、カスタム NLS コード ページ名を使用して構成設定を削除するように DRDA サービスに指示します。 この 必須 パラメーターは 文字列を受け入れます。 既定値は 空の文字列です。

次のコマンド例は、サンプル値を削除します。

Remove-HisCustomCodePage -Name Custom21140

Add-HisCustomConversion

この Add-HisCustomConversion コマンドレットは、標準 NLS およびカスタム NLS コード ページ内のコード ポイント マッピングをオーバーライドするように DRDA サービスを構成します。

構文

Add-HisCustomConversion -CodePage<uint32> [-EbcdicToUnicode<string[]>] [-UnicodeToEbcdic<string[]>] [<CommonParameters>]

Add-HisCustomConversion -Name<string> [-EbcdicToUnicode<string[]>] [-UnicodeToEbcdic<string[]>] [<CommonParameters>]

パラメーター

CodePage パラメーターは、この番号付き NLS コード ページ ファイルを使用して構成設定を追加するように DRDA サービスに指示します。 この 必須 パラメーターは 整数を受け入れます。 既定値は0です。

Name パラメーターは、このカスタム NLS コード ページ名ファイルを使用して構成設定を追加するように DRDA サービスに指示します。 この 必須 パラメーターは 文字列を受け入れます。 既定値は 空の文字列です。

EbcdicToUnicode パラメーターは、指定された EBCDIC コード ポイントから変換するように HIS エンコーダーに指示します。 この省略可能なパラメーターは、 文字列 値を "To=From" の形式で受け取ります。"To" は EBCDIC 16 進コード ポイント値、"From" は Unicode 16 進コード ポイント値です。 既定値は 空の文字列です。

UnicodeToEbcdic パラメーターは、指定された Unicode コード ポイントから変換するように HIS エンコーダーに指示します。 この省略 可能なパラメーター は文字列値を受け取ります。"To= From" の形式で、"To" は Unicode の 16 進コード ポイント値、"From" は EBCDIC の 16 進コード ポイント値です。 既定値は 空の文字列です。

Get-HisCustomConversion

この Get-HisCustomConversion コマンドレットは、標準 NLS およびカスタム NLS コード ページ内のコード ポイント マッピングをオーバーライドするための DRDA サービス構成設定を取得します。

構文

Get-HisCustomConversion -Type<ConversionType> {EbcdicToUnicode |UnicodeToEbcdic} -CodePage < uint32> [<CommonParameters>]

Get-HisCustomConversion -Type<ConversionType> {EbcdicToUnicode |UnicodeToEbcdic} -Name < string> [<CommonParameters>]

パラメーター

CodePage パラメーターは、この番号付き NLS コード ページ ファイルを使用して構成設定を取得するように DRDA サービスに指示します。 この 必須 パラメーターは 整数を受け入れます。 既定値は0です。

Name パラメーターは、このカスタム NLS コード ページ名ファイルを使用して構成設定を取得するように DRDA サービスに指示します。 この 必須 パラメーターは 文字列を受け入れます。 既定値は 空の文字列です。

Type パラメーターは、この番号付き NLS コード ページ ファイルまたはカスタム NLS コード ページ名ファイルを使用して構成設定を取得するように DRDA サービスに指示します。 この 必須 パラメーターは、EbcdicToUnicode または UnicodeToEbcdic のいずれかの列挙値を受け取ります。

出力

この Get-HisCustomConversion コマンドレットは、次のプロパティを持つオブジェクトを返します: From (hex);および To (16 進数)。

Remove-HisCustomConversion

この Remove-HisCustomConversion コマンドレットは、標準 NLS およびカスタム NLS コード ページ内のコード ポイント マッピングをオーバーライドするための DRDA サービス構成設定を削除します。

構文

Remove-HisCustomConversion -CodePage<uint32> [-EbcdicToUnicode<string[]>] [-UnicodeToEbcdic<string[]>] [<CommonParameters>]

Remove-HisCustomConversion -Name<string> [-EbcdicToUnicode<string[]>] [-UnicodeToEbcdic<string[]>] [<CommonParameters>]

パラメーター

CodePage パラメーターは、この番号付き NLS コード ページ ファイルを使用して構成設定を取得するように DRDA サービスに指示します。 この 必須 パラメーターは 整数を受け入れます。 既定値は0です。

Name パラメーターは、このカスタム NLS コード ページ名ファイルを使用して構成設定を取得するように DRDA サービスに指示します。 この 必須 パラメーターは 文字列を受け入れます。 既定値は 空の文字列です。

EbcdicToUnicode パラメーターは、指定された EBCDIC コード ポイントから変換するように HIS エンコーダーに指示します。 この省略可能なパラメーターは、 文字列 値を受け入れます。 既定値は 空の文字列です。

UnicodeToEbcdic パラメーターは、指定された Unicode コード ポイントから変換するように HIS エンコーダーに指示します。 この省略可能なパラメーターは、 文字列 値を受け入れます。 既定値は 空の文字列です。

DRDA サービス アプリケーション のエンコード

DRDA サービスは、ベース コード ページを変換し、基になる HIS Encoder コンポーネントと Windows National Language Support (NLS) システム コンポーネントを使用してコード ポイントをマップします。 applicationEncodings 要素には、データベースごとに既定のアプリケーション レベルのエンコード スキームを指定するための applicationEncoding 要素が含まれています。 値の詳細と説明については、「アプリケーション エンコーディングの構成」を参照してください。

Add-HisDrdaApplicationEncoding

この Add-HisDrdaApplicationEncoding コマンドレットは、データベースごとに既定のアプリケーション レベルのエンコード スキーム用に DRDA サービスを構成します。これは、コード ページ内のコード ポイントのマッピングで HIS Encoder コンポーネントと Windows National Language Support (NLS) システム コンポーネントで使用されます。 値の詳細と説明については、「アプリケーション エンコーディングの構成」を参照してください。

構文

Add-HisDrdaApplicationEncoding -Ccsid<uint32> -Database<string> [-Scheme<string>] [<CommonParameters>]

Add-HisDrdaApplicationEncoding -Database<string> -CustomCcsid<uint32> [-Scheme<string>] [<CommonParameters>]

パラメーター

Ccsid パラメーターは、DRDA AR クライアント要求 CCSID ではなく、オーバーライド CCSID (コード化文字セット ID) を使用して出力パラメーターと結果セット値をエンコードするよう DRDA サービスに指示します。 この 必須 パラメーターは 整数を受け入れます。 既定値は 1208 です

CustomCcsid パラメーターは、DRDA AR クライアント要求の CCSID ではなく、オーバーライド・カスタム CCSID (コード化文字セット ID) を使用して出力パラメーターと結果セット値をエンコードするよう DRDA サービスに指示します。 この 必須 パラメーターは 整数を受け入れます。 既定値は -1 です

Database パラメーターは、指定されたターゲット SQL Server データベースに対してのみ、DRDA AR クライアント要求エンコード スキームではなく、オーバーライド エンコード スキームを使用して出力パラメーターと結果セット値をエンコードするように DRDA サービスに指示します。 この 必須 パラメーターは 、文字列 値を受け取ります。 既定値は 空の文字列です。

Scheme パラメーターは、DRDA AR クライアントが要求したエンコード 方式ではなく、オーバーライド エンコード スキームを使用して出力パラメーターと結果セットの値をエンコードするように DRDA サービスに指示します。 この 省略可能な パラメーターは、 文字列 値を受け入れます。 サポートされている値は Ebcdic、Unicode、 Ansi です。 既定値は Unicode です

次のコマンド例では、サンプル値を設定します。

Add-HisDrdaApplicationEncoding -Ccsid 1140 -Database NWIND1 -Scheme Ebcdic

次のコマンド例では、既定値を設定します。

Add-HisDrdaApplicationEncoding -CustomCcsid 1234 -Database NWIND1 -Scheme Ebcdic

Get-HisDrdaApplicationEncoding

この Get-HisDrdaApplicationEncoding コマンドレットは、データベースごとに既定のアプリケーション レベルのエンコード スキームの DRDA サービス構成設定を取得します。これは、コード ページ内のコード ポイントのマッピングで HIS Encoder コンポーネントと Windows National Language Support (NLS) システム コンポーネントで使用されます。

構文

Get-HisDrdaApplicationEncoding [-Ccsid<uint32>] [-Database<string>] [-CustomCcsid<uint32>] [<CommonParameters>]

パラメーター

Ccsid パラメーターは、オーバーライド CCSID (コード化文字セット ID) を使用してアプリケーション・エンコード構成を取得するよう DRDA サービスに指示します。 この 省略可能な パラメーターは 整数を受け入れます。 既定値は 1208 です

CustomCcsid パラメーターは、カスタム CCSID (コード化文字セット ID) を使用してアプリケーション・エンコード構成を取得するように DRDA サービスに指示します。 この 省略可能な パラメーターは 整数を受け入れます。 既定値は -1 です

Database パラメーターは、指定されたターゲット SQL Server データベース名を使用してアプリケーション エンコード構成を取得するように DRDA サービスに指示します。 この 省略可能な パラメーターは、 文字列 値を受け入れます。 既定値は 空の文字列です。

出力

この Get-HisDrdaApplicationEncoding コマンドレットは、Scheme (string) プロパティを持つオブジェクトを返します。Ccsid (整数);データベース (文字列);および CustomCcsid (整数)。

次のコマンド例では、サンプル値を取得します。

Get-HisDrdaApplicationEncoding
Scheme
------
Ebcdic
Ebcdic

Ccsid
-----
1140

Database
--------
NWIND1
NWIND1

Customccsid
-----------

1234

Remove-HisDrdaApplicationEncoding

この Remove-HisDrdaApplicationEncoding コマンドレットは、データベースごとに既定のアプリケーション レベル エンコード スキームの DRDA サービス構成設定を削除します。これは、コード ページ内のコード ポイントのマッピングで HIS Encoder コンポーネントと Windows National Language Support (NLS) システム コンポーネントで使用されます。

構文

Remove-HisDrdaApplicationEncoding -Ccsid<string[]> [-Database<string>] [<CommonParameters>]

Remove-HisDrdaApplicationEncoding -CustomCcsid<string[]> [-Database<string>] [<CommonParameters>]

パラメーター

Ccsid パラメーターは、オーバーライド CCSID (コード化文字セット ID) を使用してアプリケーション・エンコード構成を除去するよう DRDA サービスに指示します。 この 省略可能な パラメーターは 整数を受け入れます。 既定値は 1208 です

CustomCcsid パラメーターは、カスタム CCSID (コード化文字セット ID) を使用してアプリケーション・エンコード構成を除去するように DRDA サービスに指示します。 この 省略可能な パラメーターは 整数を受け入れます。 既定値は -1 です

Database パラメーターは、指定されたターゲット SQL Server データベース名を使用してアプリケーション エンコード構成を削除するように DRDA サービスに指示します。 この 省略可能な パラメーターは、 文字列 値を受け入れます。 既定値は 空の文字列です。

次のコマンド例は、サンプル値を削除します。

Remove-HisDrdaApplicationEncoding -Ccsid 1140

次のコマンド例は、サンプル値を削除します。

Remove-HisDrdaApplicationEncoding -CustomCcsid 1234

DRDA サービスの照合順序マッピング

DRDA サービスは照合順序構文をマップして、クエリ結果のクロスプラットフォーム互換性を提供します。 値の詳細と説明については、「データ統合 (デプロイ)、DRDA サービス、照合順序マッピングの構成」を参照してください。

Add-HisDrdaCollationName

この Add-HisDrdaCollationName コマンドレットは、SELECT ステートメントを DB2 ORDER BY COLLATION_KEY (照合順序名) 構文から SQL Server T-SQL ORDER BY COLLATE (collation_name) 構文に変換し、DB2 照合順序名の値から SQL Server collation_name値にマッピングするように DRDA サービスを構成して、互換性のあるクエリ結果を提供します。 値の詳細と説明については、「データ統合 (デプロイ)、DRDA サービス、照合順序マッピングの構成」を参照してください。

構文

Add-HisDrdaCollationName -To < string> -From <string> [<CommonParameters>]

パラメーター

To パラメーターは、SQL Server SELECT ORDER BY COLLATE 句内の指定されたcollation_name文字列に変換するように DRDA サービス SQL Transformer に指示します。 この 必須 パラメーターは 、文字列 値を受け取ります。 既定値はありません。

From パラメーターは、DB2 SELECT ORDER BY COLLATION_KEY 句内の指定された照合順序名文字列から変換するように DRDA サービス SQL Transformer に指示します。 この 必須 パラメーターは 、文字列 値を受け取ります。 既定値はありません。

次のコマンド例では、サンプル値を設定します。

Add-HisDrdaCollationName -From UCA400R1_LEN_AN -To SQL_EBCDIC037_CP1_CS_AS

Get-HisDrdaCollationName

この Get-HisDrdaCollationName コマンドレットは、SELECT ステートメントを DB2 ORDER BY COLLATION_KEY (照合順序名) 構文から SQL Server T-SQL ORDER BY COLLATE (collation_name) 構文に変換するための DRDA サービス構成設定を取得します。この構文は、DB2 照合順序名の値から SQL Server collation_name 値にマッピングされ、より互換性のあるクエリ結果を提供します。

構文

Get-HisDrdaCollationName [-To<string>] [-From<string>] [<CommonParameters>]

パラメーター

To パラメーターは、指定されたcollation_name文字列を使用して、DRDA サービスの照合順序名の構成を取得するように指示します。 この 必須 パラメーターは 、文字列 値を受け取ります。 既定値はありません。

From パラメーターは、DB2 SELECT ORDER BY COLLATION_KEY 句内の指定された照合順序名文字列を使用して、DRDA サービスに照合順序名の構成を取得するように指示します。 この 必須 パラメーターは 、文字列 値を受け取ります。 既定値はありません。

出力

この Get-HisDrdaCollationName コマンドレットは、プロパティを持つオブジェクトを返します: To (string);and From (string)。

次のコマンド例では、既定値を設定します。

Get-HisDrdaCollationName
To
--
SQL_EBCDIC037_CP1_CS_AS

From
----
UCA400R1_LEN_AN

Remove-HisDrdaCollationName

この Remove-HisDrdaCollationName コマンドレットは、既定の ORDER BY 照合順序名に基づいて、DRDA サービスの構成設定を削除して、ORDER BY 句に COLLATE 句を追加します。

構文

Remove-HisDrdaCollationName -RemoveAll<bool> [-To<string>] [-From<string>] [<CommonParameters>]

パラメーター

To パラメーターは、指定したcollation_name文字列を使用して、DRDA サービスの照合順序名の構成を削除するように指示します。 この 必須 パラメーターは 、文字列 値を受け取ります。 既定値はありません。

From パラメーターは、DB2 SELECT ORDER BY COLLATION_KEY 句内の指定された照合順序名文字列を使用して、DRDA サービスに照合順序名の構成を削除するように指示します。 この 必須 パラメーターは 、文字列 値を受け取ります。 既定値はありません。

次のコマンド例は、サンプル値を削除します。

Remove-HisDrdaCollationName -From UCA400R1_LEN_AN

トレース リスナーの構成

DRDA サービスでは、テキスト トレース リスナー、コンソール トレース リスナー、カスタム トレース リスナー、Windows イベント トレース (ETW) トレース リスナーなど、複数の同時トレース リスナーがサポートされています。 値の詳細と説明については、「データ統合 (デプロイ)、DRDA サービス、トレース リスナーの構成」を参照してください。

Set-HisDrdaConsoleTraceListener

Set-HisDrdaConsoleTraceListener コマンドレットは、コマンド コンソール ウィンドウにトレース データを書き込むよう DRDA サービス コンソール トレース リスナーを構成します。

構文

Set-HisDrdaConsoleTraceListener -Level < uint32> [<CommonParameters>]

パラメーター

Level パラメーターは、定義された情報のコレクションをトレースするように DRDA サービスに指示します。トレースの最小レベルから最大レベルまでです。 この 必須 パラメーターは 整数値 を受け取ります。 既定値は0です。

価値 説明
0 トレース メッセージを出力しません。
1 エラー メッセージを出力します。
2 警告メッセージとエラー メッセージを出力します。
3 情報メッセージ、警告メッセージ、およびエラー メッセージを出力します。
4 すべてのメッセージを出力します。

テーブル AUTONUM \\ アラビア語 トレース レベル.*

次のコマンド例では、サンプル値を設定します。

Set-HisDrdaConsoleTraceListener -Level 3

Set-HisDrdaEtwTraceListener

Set-HisDrdaEtwTraceListener コマンドレットは、ETW セッションを通じてトレース データを Windows オペレーティング システムの ETW コントローラーに出力する ETW プロバイダーとして DRDA サービス ETW (Windows イベント トレーシング) を構成します。

構文

Set-HisDrdaEtwTraceListener -Level < uint32> [<CommonParameters>]

パラメーター

Level パラメーターは、定義された情報のコレクションをトレースするように DRDA サービスに指示します。トレースの最小レベルから最大レベルまでです。 この 必須 パラメーターは 整数値 を受け取ります。 既定値は0です。

価値 説明
0 トレース メッセージを出力しません。
1 エラー メッセージを出力します。
2 警告メッセージとエラー メッセージを出力します。
3 情報メッセージ、警告メッセージ、およびエラー メッセージを出力します。
4 すべてのメッセージを出力します。

テーブル AUTONUM \\ アラビア語 トレース レベル.*

次のコマンド例では、サンプル値を設定します。

Set-HisDrdaEtwTraceListener -Level 3

Set-HisDrdaEventLogTraceListener

Set-HisDrdaEventLogTraceListener コマンドレットは、DRDA サービス イベント ログ リスナーが Windows イベント ログにログ データを出力するように構成します。

構文

Set-HisDrdaEventLogTraceListener -InitializeData < string> [<CommonParameters>]

パラメーター

InitializeData パラメーターは、定義済みの情報のコレクションをログに記録するように DRDA サービスに指示します。 この 必須 パラメーターは 、文字列 値を受け取ります。 既定値は、すべてのイベント ログ レベルを含む "Error,Warning,Information" です。

価値 説明
エラー この値は、エラー レベルのデータのみをログに記録するように DRDA サービスに指示します。
Warnung この値は、警告レベルのデータのみをログに記録するように DRDA サービスに指示します。
情報 この値は、情報レベルのデータのみをログに記録するように DRDA サービスに指示します

テーブル AUTONUM \\ アラビア語 イベント ログ レベル。*

次のコマンド例では、サンプル値を設定します。

Set-HisDrdaEventLogTraceListener -InitializeData Warning

Set-HisDrdaTextTraceListener

Set-HisDrdaTextTraceListener コマンドレットは、トレース データをテキスト形式でディスク ファイルに書き込むよう DRDA サービス テキスト トレース リスナーを構成します。

構文

Set-HisDrdaTextTraceListener -Level < uint32> [-InitializeData <string>] [-AutoFlush <bool>] [-MaxTraceEntryCount <uint32>] [-MaxTraceFileCount <uint32>] [<CommonParameters>]

パラメーター

Level パラメーターは、定義された情報のコレクションをトレースするように DRDA サービスに指示します。トレースの最小レベルから最大レベルまでです。 この 必須 パラメーターは 整数値 を受け取ります。 既定値は0です。

価値 説明
0 トレース メッセージを出力しません。
1 エラー メッセージを出力します。
2 警告メッセージとエラー メッセージを出力します。
3 情報メッセージ、警告メッセージ、およびエラー メッセージを出力します。
4 すべてのメッセージを出力します。

テーブル x。 トレース レベル。

AutoFlush パラメーターは、トレース リスナーにデータを自動的にフラッシュするように DRDA サービスに指示します。 この 必須 パラメーターは 、ブール 値を受け取ります。 既定値は false です。

DRDA サービスはトレース データをトレース リスナーに自動的にフラッシュできます。これにより、トレース データが確実にキャプチャされますが、ディスク I/O が増加し、システム全体のパフォーマンスが低下します。 パフォーマンスを向上させるには、AutoFlush=$False を設定して、自動トレース フラッシュを無効にします。

MaxTraceEntryCount パラメーターは、最大エントリ数までトレースし、トレースを停止するように DRDA サービスに指示します。 この 必須 パラメーターは 整数を受け入れます。 既定値は 1000000 です

MaxTraceFileCount パラメーターは、テキスト リスナー トレース出力に個々のトレース ファイルの最大数を書き込み、既存のトレース ファイルを上書きするように DRDA サービスに指示します。 この 必須 パラメーターは 整数を受け入れます。 既定値は 10 です。

次のコマンド例では、サンプル値を設定します。

Set-HisDrdaTextTraceListener -Level 3 -AutoFlush $True -InitializeData MsDrdaService.DSTF -MaxTraceEntryCount 1000000 -MaxTraceFileCount 10

Start-HisDrdaTraceListener

この Start-HisDrdaTraceListener コマンドレットは、指定した種類のトレース リスナーを開始するように DRDA サービスに指示します。

構文

Start-HisDrdaTraceListener [-Listener] <TraceListenerType> [<CommonParameters>]

パラメーター

Listener パラメーターは、指定されたトレース リスナーの種類を開始するように DRDA サービスに指示します。 この 必須 パラメーターは、 ConsoleTextEtw、または EventLog のリスナー値を受け取ります。 既定値はありません。

次のコマンド例では、サンプル値を設定します。

Start-HisDrdaTraceListener -Listener Console

次のコマンド例では、サンプル値を設定します。

Start-HisDrdaTraceListener -Listener Text

次のコマンド例では、サンプル値を設定します。

Start-HisDrdaTraceListener -Listener Etw

次のコマンド例では、サンプル値を設定します。

Start-HisDrdaTraceListener -Listener EventLog

Get-HisDrdaTraceListener

この Get-DrdaTextTraceListener コマンドレットは、テキスト 形式でディスク ファイルにトレース データを書き込むためのテキスト トレース リスナーの DRDA サービス構成設定を取得します。

構文

Get-HisDrdaTraceListener [-Listener] <TraceListenerType> [<CommonParameters>]

パラメーター

Listener パラメーターは、指定されたトレース リスナーの種類の構成を取得するように DRDA サービスに指示します。 この 必須 パラメーターは、 ConsoleTextEtw、または EventLog のリスナー値を受け取ります。 既定値はありません。

出力

この Get-HisDrdaTraceListener コマンドレットは、プロパティのコレクションを返します。

次のコマンド例では、サンプル値を取得します。

Get-HisDrdaTraceListener -Listener Console
Status
------
Enabled

Level
-----
3

次のコマンド例では、サンプル値を取得します。

Get-HisDrdaTraceListener -Listener Text
InitializeData  : MsDrdaService.DSTF
AutoFlush       : True
MaxTraceEntries : 1000000
MaxTraceFiles   : 10
Status          : Enabled
Level           : 3

次のコマンド例では、サンプル値を取得します。

Get-HisDrdaTraceListener -Listener Etw
Status
------
Enabled

Level
-----
3

次のコマンド例では、サンプル値を取得します。

Get-HisDrdaTraceListener -Listener Console
InitializeData
--------------
Warning

Status
------
Enabled

Stop-HisDrdaTraceListener

この Stop-HisDrdaTraceListener コマンドレットは、指定した種類のトレース リスナーを停止するように DRDA サービスに指示します。

構文

Stop-HisDrdaTraceListener [-Listener] <TraceListenerType> [<CommonParameters>]

パラメーター

Listener パラメーターは、指定されたトレース リスナーの種類の構成を取得するように DRDA サービスに指示します。 この 必須 パラメーターは、 ConsoleTextEtw、または EventLog のリスナー値を受け取ります。 既定値はありません。

次のコマンド例では、サンプル値を設定します。

Get-HisDrdaTraceListener -Listener Console

次のコマンド例では、サンプル値を設定します。

Get-HisDrdaTraceListener -Listener Text

次のコマンド例では、サンプル値を設定します。

Get-HisDrdaTraceListener -Listener Etw

次のコマンド例では、サンプル値を設定します。

Get-HisDrdaTraceListener -Listener EventLog

DRDA サービス パッケージ バインド リスナー

DRDA サービスは、.NET Framework カスタム リスナーの形式でカスタム パッケージ バインダーをサポートします。

Add-HisDrdaPackageBindListener

この Add-HisDrdaPackageBindListener コマンドレットは、バインド SQL ステートメント出力を含むバインド パッケージをオプションのカスタム バインド リスナーに送信するための DRDA サービス構成を追加します。

構文

Add-HisDrdaPackageBindListener -TypeName<string> [-ThrowWhenNoCallback ] [<CommonParameters>]

パラメーター

TypeName パラメーターは、DRDA サービスのカスタム バインド リスナーの型を定義します。 この 必須 パラメーターは 文字列を受け入れます。 既定値はありません。 カスタム パッケージ バインド リスナー サンプルの Type 値は、"CustomListeners.MyPackageBindListener、CustomListeners、Version=1.0.0.0、Culture=neutral、PublicKeyToken=34013cf74da51d17、processorArchitecture=MSIL" です。

ThrowWhenNoCallback パラメーターは、カスタム バインド リスナー コンポーネントがコールバック インターフェイスに関する情報を返さない場合に、BGNBNDRM (Begin Bind Reply Message) を DRDA AR クライアントに返すように DRDA サービスに指示します。 この 省略可能な パラメーターは、 ブール 値を受け取ります。 既定値は true です。

次のコマンド例では、サンプル値を追加します。

Add-HisDrdaPackageBindListener -TypeName CustomListeners.MyPackageBindListener -ThrowWhenNoCallback

Get-HisDrdaPackageBindListener

この Get-HisDrdaPackageBindListener コマンドレットは、バインド SQL ステートメント出力を含むバインド パッケージをオプションのカスタム バインド リスナーに送信するための DRDA サービス構成設定を取得します。

構文

Get-HisDrdaPackageBindListener [-Type<string>] [<CommonParameters>]

パラメーター

Type パラメーターは、DRDA サービスのカスタム バインド リスナーの型を定義します。 この 必須 パラメーターは 文字列を受け入れます。 既定値はありません。 カスタム パッケージ バインド リスナー サンプルの Type 値は、"CustomListeners.MyPackageBindListener、CustomListeners、Version=1.0.0.0、Culture=neutral、PublicKeyToken=34013cf74da51d17、processorArchitecture=MSIL" です。

次のコマンド例では、サンプル値を取得します。

Get-HisDrdaPackageBindListener
PackageBindListener:
type=CustomListeners.MyPackageBindListener
errorWhenNoCallback=True

Remove-HisDrdaPackageBindListener

この Remove-HisDrdaPackageBindListener コマンドレットは、カスタム トレース リスナーを追加するための DRDA サービス構成設定を削除します。

構文

Remove-HisDrdaPackageBindListener -TypeName<string> [<CommonParameters>]

パラメーター

Type パラメーターは、DRDA サービスのカスタム バインド リスナーの型を定義します。 この 必須 パラメーターは 文字列を受け入れます。 既定値はありません。 カスタム パッケージ バインド リスナー サンプルの Type 値は、"CustomListeners.MyPackageBindListener、CustomListeners、Version=1.0.0.0、Culture=neutral、PublicKeyToken=34013cf74da51d17、processorArchitecture=MSIL" です。

次のコマンド例は、サンプル値を削除します。

Remove-HisDrdaPackageBindListener -TypeName CustomListeners.MyPackageBindListener