ファイル・ベースのアクセス方式

ファイル・ベース・アクセス方式は、ファイル・サーバーからデバイス情報を取得します。 通常、お客様がデバイス情報をファイル・サーバーにダウンロードしてから、 Netcool Configuration Manager が ftp/scp サーバーからデバイス情報をインポートします。 ファイルは、UOW を処理しているワーカー・サーバーにダウンロードされます。 ワーカー・サーバーは、デバイス情報を含むファイル・サーバーに直接接続します。 情報が取得されると、他のデバイスと同様に処理されます。

単一サーバーを使用した NCM ファイル・ベース・ドライバーのセットアップ

概要

別個のサーバーからファイル・ベースのドライバー・アクセス方式を使用してデバイスをインポートすることも、同じワーカー・サーバーからファイル (デバイス) をインポートすることもできます。 2 サーバー・アプローチは、ネットワーク・ポリシーによって Netcool Configuration Manager ワーカー・サーバーとネットワーク EMS またはノードの間の直接対話が防止される実稼働環境で一般的に使用されます。 通常、このファイル・サーバーは DMZ 内にあり、実動デバイスはサーバー上の 1 つの NIC に到達できますが、 Netcool Configuration Manager は別の NIC に到達できます。 その他の状況では、ファイルを同じワーカー・サーバー上に配置することができ、 Netcool Configuration Manager はファイルをあるディレクトリーから別のディレクトリーに転送します。

単一サーバー実装

Netcool Configuration Manager UI からレルムを作成する必要があります。そのレルム内で、認証リソース、ファイル転送リソース、および作成してインポートするネットワーク・リソースを作成する必要があります。 インポートを実行するワーカー・サーバー上に、インポートされるファイル (ソース・ファイル) を保管するための別個のディレクトリーを作成する必要があります。 これらのソース・ファイルは、サーバー上でファイル転送リソースに指定された宛先ディレクトリーに転送されます。

詳細なセットアップ・プロセス

1. ワーカー・サーバー上に /home/icosftp/singleという名前のファイル・ディレクトリーを作成します。 このディレクトリーは、ファイルのソース・ディレクトリーを指定します。 icosftp ユーザーに適切な読み取り許可が設定されていることを確認して、すべてのデバイス構成ファイルをこのディレクトリーに配置します。
2. 以下のパラメーターを使用してファイル転送リソースを作成します (この FTP リソースはファイルの宛先ディレクトリーを指定します)。

   氏名

   ftpInfo

   ホスト

   ローカル・ホスト

   ユーザー名

   IcosFTP

   パスワード

   icosftp ユーザーのパスワード

   パス

   /home/icosftp

   パッシブ・モード

   チェックされた

3. デフォルトの FTP ユーザーの認証リソースを作成します (まだ存在しない場合)。 以下の設定例では、デフォルトの icosftp ユーザーを使用しています。

   ユーザー名

   IcosFTP

   パスワード

   icosftp ユーザーのパスワード

   パスワードの有効化

   強制ブランク

   再試行カウント

   0 (ゼロ)

   再試行遅延

   0 (ゼロ)

   無視

   いいえ

4. 名前、ベンダー、タイプ、モデル、および OS を指定してネットワーク・リソースを作成します。
5. ネットワークリソースのリソースアクセスを編集するか（ ネットワークリソースを右クリックし、 リソースアクセスを選択）、リソースアクセスを作成します（ ファイル > 新規 > リソースアクセスをクリック）。
   注:

   新規リソース・アクセスを作成する場合

   ファイル・スクリプトをリソース・アクセスに追加します。

   ステップ 3から、ファイル・ベース・アクセス方式のトピックで説明されているステップに従ってください。

   ネットワーク・リソースでリソース・アクセスを編集する場合

   ファイル・スクリプトを変更します。

   ステップ 10から、ファイル・ベース・アクセス方式のトピックで説明されているステップに従ってください。

6. 以下の例に示すように、リソース・アクセス文書 (RAD) 内のファイル・スクリプトを編集して、ファイルのソース・ディレクトリーを指定します。

   config.running.01.getFtpFileName=ls -t $ftpPath$/single/*$addressName$* | cut -d"/" -f5,first
   config.running.02.getSCP=$ftp_username$:$ftp_password$@$ftp_hostname$:$ftpPath$/single/$ftp_filename$
   config.running.end=$

   注： ディレクトリ名 single をパスに導入し、ディレクトリの深さを 5 （以前は4）に変更したことに注目。
7. ネットワーク・デバイスをインポートします。

指定された構成ファイルへの変更の書き込み

NSM REST API (GUI は除く) を使用して、ファイル・ベースのアクセス権限を持つデバイスの名前付きファイルおよびディレクトリーに対して、フル・デバイス構成またはフル・デバイス・サービス構成を書き込みまたは削除することができます。 サービスとは、デバイスの全構成のサブセットです。 いずれか一方のデバイスに対して、デバイス構成またはデバイス・サービス構成のいずれかを作成および削除できます。両方を作成および削除することはできません。

-
_
.
/ (for path separator only)

指定された構成ファイルに変更を書き込むには、以下のステップを実行します。

1. 上記の説明に従って、ファイル・ベースのアクセスをセットアップします。
2. デフォルトの FTP ユーザーの認証リソースを作成します (まだ存在しない場合)。 以下の設定例では、デフォルトの icosftp ユーザーを使用しています。

   ユーザー名

   IcosFTP

   パスワード

   icosftp ユーザーのパスワード

   パスワードの有効化

   強制ブランク

   再試行カウント

   0 (ゼロ)

   再試行遅延

   0 (ゼロ)

   無視

   いいえ

3. FTP リソースを作成して、ファイルの宛先ディレクトリーを指定します。
   1. 新規エントリーを追加し、以下のパラメーターを設定します。
      • 名前: ftpInfo
      • Host: localhost
      • ユーザー名: icosftp
      • パスワード: icosftp ユーザーのパスワード
      • パス: /home/icosftp
      • パッシブ・モード: チェック・マークなし
   2. 別のエントリーを追加し、以下のパラメーターを設定します。
      • 名前: altftpInfo
      • ホスト: リモート・ホストのアドレス
      • ユーザー名: icosftp
      • パスワード: icosftp ユーザーのパスワード
      • パス: /home/icosftp
      • パッシブ・モード: チェック・マークなし
4. カスタム・ファイル名に使用するカスタム UOW ラベルを作成します。
   1. システムマネージャからツール > システムプロパティを選択します。
   2. 「カスタム UOW ラベル 1」プロパティーを Config_Dir_Name に設定します。
   3. カスタム UOW ラベル 1 の状態を値「オプション」に設定します。

5. ステップ 5(デバイス構成の更新の場合) またはステップ 6 (サービス構成の更新の場合) のいずれかを実行します。

   1. 新しい構成ファイルを生成するスクリプトを作成します。 このスクリプトは、ステップ 5.bに示すように、リソース・アクセス・デバイス・スクリプトから実行されます。 スクリプトは、以下の結果を達成する必要があります。

      • 最初の作成後にデバイスに初期構成を指定する場合、スクリプトは、スクリプトに渡されるディレクトリーとファイル名を使用して新規構成ファイルを作成し (ファイルがまだ存在しない場合)、そのファイルにデータを追加する必要があります。
      • 構成ファイルがデバイス用に既に存在する場合は、構成ファイルを作成したり、構成ファイルにデータを追加したりしないでください。
      • データを返しません。 返されたデータが構成に追加されます。
      • chmod 777 コマンドを使用して、デバイスの初期構成ファイルの許可を変更します。 このスクリプトは通常、 icosuserとして実行されますが、FTP は通常、 icosftp ユーザーとして実行されます。

   2. ファイル・ベースのデバイス・アクセス用に以前に作成したリソース・アクセス権限を編集し、 「ファイル」 アクセス・タイプを選択して、以下の変更を行います。

      1. 「トランスポート」 タブの 「ストリーミング: 書き込み」 のチェック・マークを外します。
      2. 「構成」 タブの 「変更時に更新」 にチェック・マークを付けます。
      3. デバイス・スクリプトを編集して、以下の変更を行います。
         1. # Device script properties セクションで、 putConfigFileServer を putConfigFileServer=configured_for_remote_scpに変更します。

         2. 新規デバイス・スクリプトの removeConfigDir セクションを追加します。

            # New section in device script, removes all config files and directories for a device, both locally and remotely.
            removeConfigDir.01.getDeviceFileDirContent=ls $ftpPath$/$addressName$/ | cut -d"/" -f5,all
            removeConfigDir.02.removeRemoteContent=$ftp_altusername$:$ftp_altpassword$@$ftp_althostname$:$ftp_altpath$/$device_file_dir_content$
            removeConfigDir.03.exec=rm -rf $ftpPath$/$addressName$\r

         3. 新規デバイス・スクリプトの removeConfigFile セクションを追加します。

            # New 'removeConfigFile' section.
            # Removes a config file for a device, both locally and remotely, this will be triggered as a result of a 'delete service' being performed.
            # 'Update on Change' should be set in the Resource access, so that changes here will be reflected in the configuration.
            removeConfigFile.01.removeRemoteContent=$ftp_altusername$:$ftp_altpassword$@$ftp_althostname$:$ftp_altpath$/$config_dir$/$ftp_filename$
            removeConfigFile.02.exec=rm -rf $ftpPath$/$addressName$/$config_dir$/$ftp_filename$\r
            removeConfigFile.03.exec=rm -rf $ftpPath$/$addressName$/$addressName$.cfg\r

         4. デバイス・スクリプトの config.running セクションで、ファイル・ベースの例の config.running.01 および config.running.02 を以下の行に置き換えます。

            config.running.01.exec=mkdir -p $ftpPath$/$addressName$\r
            config.running.02.exec=$ftpPath$/telus_script_for_initial_config.sh -d $ftpPath$/$addressName$ -f $addressName$.cfg\r
            config.running.03.setFileName=$addressName$.cfg
            config.running.04.setSubDirForFtpPath=$addressName$
            config.running.05.readSCPFile=$ftpPath$/$subDirForFtpPath$/$ftpFileName$

            注: config.running.02.exec で始まる行はオプションです。 これは、デバイスの作成後の最初のインポート時に有効になる初期デフォルト構成をセットアップする方法の例として提供されています。 スクリプト名 script_for_initial_config.sh を、このステップで作成したスクリプトに置き換えます。 スクリプトの場所、および前のコード内の引数名 -d と -f は変更できます。
      4. ホスト上に cp -i 別名がセットアップされている場合は、 unalias cp -iを使用して別名を定義解除します。そうしないと、 cp -f は次のステップで動作しません。

      5. デバイス・スクリプトの ftp セクションで、例の ftp セクション全体を以下の行に置き換えます。

         ftp.01.exec=mkdir -p $ftpPath$/$addressName$/$config_dir$/\r
         ftp.02.exec=mv -f $ftpPath$/$ftp_filename$ $ftpPath$/$addressName$/$config_dir$/\r
         ftp.03.exec=cp -f $ftpPath$/$addressName$/$config_dir$/$ftp_filename$ $ftpPath$/$addressName$/$addressName$.cfg\r
         ftp.04.setSubDirForFtpPath=$addressName$/$config_dir$
         ftp.05.scpFile=$ftp_altusername$:$ftp_altpassword$@$ftp_althostname$:$ftp_altpath$/$config_dir$/r

6. サービス構成の更新の場合はステップ 6、デバイス構成の更新の場合はステップ 5 のいずれかを実行します。

   1. 新しい構成ファイルを生成するスクリプトを作成します。 このスクリプトは、リソース・アクセス・デバイス・スクリプトから実行されます。 スクリプトは、以下の結果を達成する必要があります。

      • 最初の作成後にデバイスに初期構成を指定する場合、スクリプトは、スクリプトに渡されるディレクトリーとファイル名を使用して新規構成ファイルを作成し (ファイルがまだ存在しない場合)、そのファイルにデータを追加する必要があります。
      • ディレクトリー $ftpPath$/$addressName$ にあるすべてのサービス構成ファイルを、インポート用の単一のデバイス構成ファイル $addressName$.cfgに集約します。
      • 個々のサービス構成ファイルをデバイス構成ファイルに集約するための特定の順序付け要件またはフォーマット要件を処理します。
      • データを返しません。 返されたデータが構成に追加されます。
      • chmod 777 コマンドを使用して、デバイスの初期構成ファイルの許可を変更します。 このスクリプトは通常、 icosuserとして実行されますが、FTP は通常、 icosftp ユーザーとして実行されます。

   2. ファイル・ベースのデバイス・アクセス用に以前に作成したリソース・アクセス権限を編集し、 「ファイル」 アクセス・タイプを選択して、以下の変更を行います。

      1. 「トランスポート」 タブの 「ストリーミング: 書き込み」 のチェック・マークを外します。
      2. 「構成」 タブの 「変更時に更新」 にチェック・マークを付けます。
      3. デバイス・スクリプトを編集して、以下の変更を行います。
         1. # Device script properties セクションで、 putConfigFileServer を putConfigFileServer=configured_for_remote_scpに変更します。

         2. 新規デバイス・スクリプトの removeConfigDir セクションを追加します。

            # New section in device script, removes all config files and directories for a device, both locally and remotely.
            removeConfigDir.01.getDeviceFileDirContent=ls $ftpPath$/$addressName$/ | cut -d"/" -f5,all
            removeConfigDir.02.removeRemoteContent=$ftp_altusername$:$ftp_altpassword$@$ftp_althostname$:$ftp_altpath$/$device_file_dir_content$
            removeConfigDir.03.exec=rm -rf $ftpPath$/$addressName$\r

         3. 新規デバイス・スクリプトの removeConfigFile セクションを追加します。

            # New 'removeConfigFile' section.
            # Removes a config file for a device, both locally and remotely, this will be triggered as a result of a 'delete service' being performed.
            # 'Update on Change' should be set in the Resource access, so that changes here will be reflected in the configuration.
            removeConfigFile.01.removeRemoteContent=$ftp_altusername$:$ftp_altpassword$@$ftp_althostname$:$ftp_altpath$/$config_dir$/$ftp_filename$
            removeConfigFile.02.exec=rm -rf $ftpPath$/$addressName$/$config_dir$/$ftp_filename$\r
            removeConfigFile.03.exec=rm -rf $ftpPath$/$addressName$/$addressName$.cfg\r

         4. デバイス・スクリプトの config.running セクションで、ファイル・ベースの例の config.running.01 および config.running.02 を以下の行に置き換えます。

            config.running.01.exec=mkdir -p $ftpPath$/$addressName$\r
            config.running.02.exec=$ftpPath$/telus_script_for_initial_config.sh -d $ftpPath$/$addressName$ -f $addressName$.cfg\r
            config.running.03.setFileName=$addressName$.cfg
            config.running.04.setSubDirForFtpPath=$addressName$
            config.running.05.readSCPFile=$ftpPath$/$subDirForFtpPath$/$ftpFileName$

            注: config.running.02.exec で始まる行はオプションです。 これは、デバイスの作成後の最初のインポート時に有効になる初期デフォルト構成をセットアップする方法の例として提供されています。 スクリプト名 script_for_initial_config.sh を、このステップで作成したスクリプトに置き換えます。 スクリプトの場所、および前のコード内の引数名 -d と -f は変更できます。
      4. ホスト上に cp -i 別名がセットアップされている場合は、 unalias cp -iを使用して別名を定義解除します。そうしないと、 cp -f は次のステップで動作しません。

      5. デバイス・スクリプトの ftp セクションで、例の ftp セクション全体を以下の行に置き換えます。

         ftp.01.exec=mkdir -p $ftpPath$/$addressName$/$config_dir$/\r
         ftp.02.exec=mv -f $ftpPath$/$ftp_filename$ $ftpPath$/$addressName$/$config_dir$/\r
         ftp.03.exec=cp -f $ftpPath$/$addressName$/$config_dir$/$ftp_filename$ $ftpPath$/$addressName$/$addressName$.cfg\r
         ftp.04.setSubDirForFtpPath=$addressName$/$config_dir$
         ftp.05.scpFile=$ftp_altusername$:$ftp_altpassword$@$ftp_althostname$:$ftp_altpath$/$config_dir$/r

7. サービス・テンプレートを編集して、 CUSTOM_UOW_LABEL_1という名前の新しいパラメーター uowParameter を組み込みます。 このパラメーターを追加すると、REST 呼び出しで構成ファイル名を渡すことができます。 以下のサービス・テンプレートの例は、新規パラメーターが追加された snmp contact および snmp location エレメントを構成に追加するコマンド・セットを示しています。

   <serviceTemplate name="SNMP_test" description="NSM Service Template to add and delete SNMP info">
   	<clientParameters>
   		<clientParameter>
   			<name>LOCATION</name>
   		</clientParameter>
   		<clientParameter>
   			<name>CONTACT</name>
   		</clientParameter>
   	</clientParameters>
       <uowParameters>
           <uowParameter>
               <name>CUSTOM_UOW_LABEL_1</name>
               <description>The configuration file name</description>
           </uowParameter>
       </uowParameters>
   	<implementations>
   		<implementation>
   			<rules>
   				<rule type="DeviceType">
   					<ruleProperty name="Vendor" value="mediatrix"/>
   					<ruleProperty name="Type" value=".*"/>
   					<ruleProperty name="Model" value=".*"/>
   					<ruleProperty name="OS" value=".*"/>
   				</rule>
   			</rules>
   			<serviceOperations>
   				<serviceOperation type="CREATE">
   					<operations>
   						<operation name="ITNCM/mediatrix/SNMP-add" type="COMMANDSET">
   							<parameters>
   								<parameter name="LOCATION"/>
   								<parameter name="CONTACT"/>
   							</parameters>
   						</operation>
   					</operations>
   				</serviceOperation>
   				<serviceOperation type="DELETE">
   					<operations>
   						<operation name="ITNCM/mediatrix/SNMP-delete" type="COMMANDSET">
   							<parameters>
   								<parameter name="LOCATION"/>
   								<parameter name="CONTACT"/>
   							</parameters>
   						</operation>
   					</operations>
   				</serviceOperation>
   			</serviceOperations>
   		</implementation>
   	</implementations>
   </serviceTemplate>
   

   以下のサービス・テンプレートの例では、デバイスが削除され、新しいパラメーターが追加されています。

   <?xml version="1.0" encoding="UTF-8"?>
   <serviceTemplate name="remove_device" description="To remove devices">
       <uowParameters>
           <uowParameter>
               <name>CUSTOM_UOW_LABEL_1</name>
               <description>The configuration file name</description>
           </uowParameter>
       </uowParameters>
   	<implementations>
   		<implementation>
   			<rules>
   				<rule type="DeviceType">
   					<ruleProperty name="Vendor" value="Mediatrix"/>
   					<ruleProperty name="Type" value=".*"/>
   					<ruleProperty name="Model" value=".*"/>
   					<ruleProperty name="OS" value=".*"/>
   				</rule>
   			</rules>
   			<serviceOperations>
   				<serviceOperation type="CREATE">
   					<operations>
   						<operation name="REMOVE" type="REMOVE">
   						</operation>
   					</operations>
   				</serviceOperation>
   				<serviceOperation type="DELETE">
   					<operations>
   						<operation name="REMOVE" type="REMOVE">
   						</operation>
   					</operations>
   				</serviceOperation>
   			</serviceOperations>
   		</implementation>
   	</implementations>
   </serviceTemplate>
   

8. GUI を使用して構成の更新を実行依頼する場合は、 「作業の説明 (Describe Work)」 画面の 「Config_Dir_Name」 フィールドに構成ファイルのカスタム名を入力します。

9. 以下の NSM サービス POST 本文の例では、構成ファイル名を MAC999999/SN77777_1.xmlとして定義しています。

   XML の例:

   <serviceTemplate id="101">
   	<deviceID>402</deviceID>
     <uowParameters>
       <uowParameter>
         <name>CUSTOM_UOW_LABEL_1</name>
         <value>mediatrix_device.cfg</value>
       </uowParameter>
     </uowParameters>
   	<clientParameters>
   		<clientParameter>
   			<name>LOCATION</name>
   			<value>The Shire</value>
   		</clientParameter>
   		<clientParameter>
   			<name>CONTACT</name>
   			<value>Bilbo Baggins</value>
   		</clientParameter>
   	</clientParameters>
   </serviceTemplate>

   JSON の例:

   {
          "serviceTemplateId" : "101",
          "deviceID": "402",
          "clientParameters": [
         {
            "name": "LOCATION",
            "value": "The Shire"
         },
         {
            "name": "CONTACT",
            "value": "Bilbo Baggins"
         }
      ],
      "uowParameters": [
        {
            "name": "CUSTOM_UOW_LABEL_1",
            "value": "MAC999999/SN77777_1.xml"
         }
      ]   
   }

10. 以下のデバイスを削除するための NSM サービス POST 本体の例には、デバイスに関連付けられた構成ファイルの削除をトリガーする delete_device_file_based_configs 値が含まれています。

    XML の例:

     <serviceTemplate id="105">
    	<deviceID>3207</deviceID>
      <uowParameters>
        <uowParameter>
          <name>CUSTOM_UOW_LABEL_1</name>
          <value>delete_device_file_based_configs</value>
        </uowParameter>
      </uowParameters>
    </serviceTemplate>
    

    JSON の例

    {
           "id" : "105",
           "deviceID": "3207",
       "uowParameters": [
         {
             "name": "CUSTOM_UOW_LABEL_1",
             "value": "delete_device_file_based_configs"
          }
       ]   
    }