スクリプトメタデータ

Security Controls でスクリプトを使用するには、スクリプトを一意に識別し、機能と入力パラメータを記述するメタデータを含める必要があります。このセクションでは、メタデータを作成する方法について説明します。

入力パラメータが1つで、簡単な1行のスクリプトから始めます。

Get-Service $serviceName -ComputerName "$ST_ComputerName"

Security Controls で必要なメタデータとスクリプトは次のとおりです。一部の情報は任意です。各要素は後で詳細に説明します。

<name>GetServices</name>

<author>My Company</author>

<modifiesTarget>false</modifiesTarget>

</options>

<purpose>ターゲットコンピュータでサービスを取得する</purpose>

<inputs>サービス名のワイルドカード</inputs>

<outputs>インストールされているサービスのリスト</outputs>

</description>

<name>serviceName</name>

<description> クエリのワイルドカードサービス </description>

</parameter>

</parameters>

</stScript>

Get-Service $serviceName -ComputerName "$ST_ComputerName"

メタデータブロック

メタデータは、スクリプトコメント内の XML フラグメントです。

スクリプトのコメントは、<#” and “#> で囲みます。本書では、これらの区切り文字をそれぞれ1行にし、列1から始めます。

XML 文書のルート要素は「stScript」です。スクリプトの一意の識別子である属性が1つあります。これはグローバル一意識別子 (GUID) です。 GUID は「xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx」という形式の32文字の16進数で指定されます。多くの標準ツールで GUID を生成できます。

先頭の要素と末尾の要素はそれぞれ1行にして、列1から開始する必要があります。このため、Security Controls で使用されるすべてのスクリプトの先頭は次の2行でなければなりません (各スクリプトで別の GUID に置換)。

最後は次の2行になります。

</stScript>

他の要素は次の順番で表示されます。

name

この必須の要素は、Security Controls 内に表示されるスクリプトの名前を指定します。名前は1～100文字でなければなりません。名前には、スペースと特殊文字を使用できます。

例:

<name>GetServices</name>

version

この必須の要素は、スクリプトのバージョンを指定します。このバージョンは、ピリオドで区切られた4桁の数字として指定されます。スクリプトを修正するときには、新しいバージョンが、使用していた前のバージョンよりも大きい数字でなければなりません。

例:

author

この必須の要素は、スクリプトの作成者を示します。一般的に、作成者の名前または会社名が使用されます。このフィールドは1～256文字で、空白にすることはできません。

例:

<author>My Company</author>

scriptType

この任意の要素は、スクリプト実行の種類を指定します。属性「type」は必須です。これには次のいずれかを含める必要があります。

type=“any” は、1つ以上のターゲットコンピュータに対してスクリプトが実行され、PowerShell remoting が必要ないことを示します。これは最も一般的なスクリプトタイプであり、scriptType 要素が指定されていない場合の既定値です。
type=”consoleOnly” は、スクリプトがターゲットコンピュータのセットに対して実行されないことを示します。この種類のスクリプトは、コンピュータグループまたは選択したコンピュータに対して実行できません。このようなスクリプトは、Security Controls メニューで [ツール] > [コンソール ITScripts の実行] を選択したときにのみ、使用可能なスクリプトに表示されます。
type=”remote” は、1つ以上のターゲットコンピュータに対してスクリプトが実行され、ターゲットコンピュータで PowerShell remoting が使用可能で構成されている必要があることを示します。
type=”esxServer” はスクリプトが ESXi Server または vCenter Server に対して実行されることを示します。このタイプのスクリプトは、ESXi Server を含むコンピュータグループに対してだけ実行されます。コンピュータグループのその他のコンピュータが含まれる場合、このスクリプトが実行されるときに無視されます。

例:

minEngineVersion

この任意の要素は、このスクリプトを実行するために必要な最低 ITScripts エンジンバージョンを指定します。指定しない場合、スクリプトは任意のバージョンの ITScripts エンジンで実行するように作成されます。

例:

modifiedTarget

この任意の要素は、スクリプトがターゲットコンピュータを修正するかどうかを示します。指定しない場合は、既定値の「false」となります。これは、スクリプトは情報を収集するだけで、ターゲットコンピュータを修正しないことを示します。これは文書専用です。値は、スクリプトがターゲットコンピュータを修正しないことを保証しません。

例:

<modifiesTarget>false</modifiesTarget>

options

この任意の要素と4つの下位要素は、標準出力ファイルを生成するように ITScripts エンジンに指示します。既定では、次の標準出力ファイルがエンジンによって生成されます。

runoutput.txt: 実行出力が生成された場合は、実行全体で1つのファイル
runerror.txt: エラーが検出された場合は、全体の実行で1つのファイル
machineoutput.txt: コンピュータ出力が生成される場合は、各ターゲットコンピュータに1つのファイル
machineerror.txt: エラーが検出された場合は、各ターゲットコンピュータで1つのファイル

メタデータで次の項目を指定する場合は、runoutput.txt ファイルも runerror.txt ファイルも生成されません。

メタデータで次の項目を指定する場合は、machineoutput.txt ファイルも machineerror.txt ファイルも生成されません。

すべてのコンピュータの machineoutput.txt ファイルを runoutput.txt ファイルに連結し、すべての machineerror.txt ファイルを runerror.txt に連結する場合は、次のオプションを指定します。

個別のコンピュータ出力ファイルとエラーファイルを結合する場合は、次の項目を指定することで、個別のファイルを削除できます。

例:

</options>

concurrency

この任意の要素は、複数のターゲットコンピュータに対してスクリプトが実行されるときに使用する、既定の最大同時レベルを指定します。 Security Controls でこれを無効にするには、ITScripts テンプレートを作成し、別の同時値を指定します。指定しない場合、既定の最大同時接続数が32に設定されます。

例:

description

「description」要素と4つの下位要素はすべて必須です。入力した情報は、Security Controls に表示されます。

purpose

必須の「purpose」要素は、説明要素の子です。 1～1024文字でなければなりません。スクリプトの使用目的を簡潔かつ正確に示してください。

inputs

必須の「inputs」要素は、説明要素の子です。 1～1024文字でなければなりません。スクリプトで必要な入力パラメータを正確に記述してください。入力パラメータがない場合は、「None」を指定します。

outputs

必須の「outputs」要素は、説明要素の子です。 1～1024文字でなければなりません。スクリプトで生成された出力を正確に記述してください。

例: