このコールで使用する JSON オブジェクトの例を次に示します。

{
  "diskFileName": "string",
  "encryptionKey": "*********",
  "doNotEncrypt": false,
  "configExportType": "FULL_EXPORT",
  "deployedObjectsOnly": true,
  "entityIds": [
    "string"
  ],
  "jobName": "string",
  "type": "scheduleconfigexport"
}

その属性は次のとおりです。

• diskFileName：（任意）。エクスポート zip ファイルの名前。名前を指定しない場合は、システムによって名前が生成されます。名前を指定した場合でも、一意性を確保するために名前に文字が付加される場合があります。名前の最大長は 60 文字です。

• encryptionKey：（任意）。zip ファイルの暗号化キー。ファイルを暗号化しない場合は、このフィールドを省略して、代わりに "doNotEncrypt": true を指定します。キーを指定する場合は、キーをワークステーションにダウンロードした後に、キーを使用して zip ファイルを開く必要があります。エクスポートされた構成ファイルでは、秘密鍵、パスワード、およびその他の機密データがクリアテキストで公開されることに注意してください（他の方法ではインポートできないため）。そのため、場合によっては暗号化キーを適用して機密データを保護する必要があります。システムでは AES 256 暗号化が使用されます。

• doNotEncrypt：（任意）。エクスポートファイルを暗号化するか（false）または暗号化しないか（true）。デフォルトは false です。つまり、空でない encryptionKey 属性を指定する必要があります。true を指定した場合、encryptionKey 属性は無視されます。

• configExportType：次のいずれかの enum 値。

  • FULL_EXPORT：エクスポートファイルに構成全体を含めます。これがデフォルトです。

  • PARTIAL_EXPORT：entityIds リストで識別されるオブジェクトとその子孫オブジェクトのみを含めます。エクスポート不可能なオブジェクトは、ID を指定しても含まれません。ユーザー定義オブジェクトはすべてエクスポート可能です。

  • PENDING_CHANGE_EXPORT：まだ展開されていない（つまり、保留中の変更を含む）オブジェクトのみを含めます。

• deployedObjectsOnly：（任意）。オブジェクトが展開されている場合にのみ、それらのオブジェクトをエクスポートファイルに含めるかどうか。つまり、保留中の変更は含めません。これらのジョブには未展開のオブジェクトしか含まれないため、PENDING_CHANGE_EXPORT ジョブではこの属性は無視されます。デフォルトは false です。これは、すべての保留中の変更がエクスポートに含まれることを意味します。保留中の変更を除外するには、true を指定します。

• entityIds：[ブラケット] で囲まれた、一連の開始ポイントオブジェクトの ID をカンマで区切ったリスト。このリストは PARTIAL_EXPORT ジョブでは必須です。このリスト内の各項目には、UUID 値か、または "id=uuid-value"、"type=object-type"、"name=object-name" などのパターンと一致する属性と値のペアのいずれかを指定できます。たとえば、"type=networkobject" などを指定できます。

  type は、networkobject などのリーフエンティティ、または一連のリーフタイプのエイリアスのいずれかになります。通常の type エイリアスの例としては、network（NetworkObject と NetworkObjectGroup）、port（すべての TCP/UDP/ICMP ポート、プロトコル、およびグループタイプ）、url（URL オブジェクトおよびグループ）、ikepolicy（IKE V1/V2 ポリシー）、ikeproposal（Ike V1/V2 プロポーザル）、identitysource（すべてのアイデンティティソース）、certificate（すべての証明書タイプ）、object（Device Manager の [オブジェクト（Objects）] ページにリストされるすべてのオブジェクト/グループタイプ）、interface（すべてのネットワーク インターフェイス）、s2svpn（すべてのサイト間 VPN 関連タイプ）、ravpn（すべての RA VPN 関連タイプ）、vpn（s2svpn と ravpn の両方）などがあります。

  これらのオブジェクトとそれらから送出される参照子孫はすべて、PARTIAL_EXPORT の出力ファイルに含まれます。エクスポート不可能なオブジェクトはすべて、ID を指定した場合でも、出力から除外されます。適切なリソースタイプに対して GET メソッドを使用し、ターゲットオブジェクトの UUID、タイプ、または名前を取得します。

  たとえば、すべてのネットワークオブジェクトと、myaccessrule という名前のアクセスルール、および、UUID で識別される 2 つのオブジェクトをエクスポートする場合、次のように指定できます。

  
  "entityIds": [
     "type=networkobject", 
     "id=bab3e3cd-8c70-11e9-930a-1f12ee87d473", 
     "name=myaccessrule", 
     "acc2e3cd-8c70-11e9-930a-1f12ee87b286"
     ]",

• jobName：（任意）。エクスポートジョブの名前。ジョブの名前を指定すると、ジョブのステータスを取得するときにジョブを見つけやすくなります。

• type：ジョブのタイプ。常に scheduleconfigexport です。

たとえば、curl コマンドは次のようになります。

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ 
   "configExportType": "FULL_EXPORT", \ 
   "type": "scheduleconfigexport" \ 
 }' 'https://10.89.5.38/api/fdm/[最新（latest）]/action/configexport'

取得する応答コードは 200 である必要があります。最低限の JSON オブジェクトをポストした場合の正常な応答本文は次のようになります。暗号化キーを指定した場合、暗号化キーは応答でマスクされます。

{
  "version": null,
  "scheduleType": "IMMEDIATE",
  "user": "admin",
  "forceOperation": false,
  "jobHistoryUuid": "c7a8ba61-629a-11e9-8b8d-0fcc3c9d6d0b",
  "ipAddress": "10.24.5.177",
  "diskFileName": "export-config-1",
  "encryptionKey": null,
  "doNotEncrypt": true
  "configExportType": "FULL_EXPORT",
  "deployedObjectsOnly": false,
  "entityIds": null,
  "jobName": "Config Export",
  "id": "c79be920-629a-11e9-8b8d-85231be77de0",
  "type": "scheduleconfigexport",
  "links": {
    "self": "https://10.89.5.38/api/fdm/[最新（latest）]
/action/configexport/c79be920-629a-11e9-8b8d-85231be77de0"
  }
}

構成ファイルのリストには、エクスポートファイルと、インポート用にアップロードしたファイルが含まれます。

curl コマンドは次のようになります。

curl -X GET --header 'Accept: application/json' 
'https://10.89.5.38/api/fdm/[最新（latest）]/action/configfiles'

応答には項目のリストが表示され、これらはそれぞれが構成ファイルです。たとえば、次のリストは 2 つのファイルを示しています。すべてのファイルの id が default であることに注意してください。ID を無視し、代わりに diskFileName を使用します。

{
  "items": [
    {
      "diskFileName": "export-config-2.zip",
      "dateModified": "2019-04-19 13:32:28Z",
      "sizeBytes": 10182,
      "id": "default",
      "type": "configimportexportfileinfo",
      "links": {
        "self": "https://10.89.5.38/api/fdm/[最新（latest）]/action/configfiles/default"
      }
    },
    {
      "diskFileName": "export-config-1.zip",
      "dateModified": "2019-04-19 13:14:56Z",
      "sizeBytes": 10083,
      "id": "default",
      "type": "configimportexportfileinfo",
      "links": {
        "self": "https://10.89.5.38/api/fdm/[最新（latest）]/action/configfiles/default"
      }
    }
  ],

curl コマンドは次のようになります。

curl -X GET --header 'Accept: application/octet-stream' 
'https://10.89.5.38/api/fdm/[最新（latest）]/action/downloadconfigfile/export-config-2.zip'

ファイルは、デフォルトのダウンロードフォルダにダウンロードされます。API エクスプローラから GET メソッドを発行していて、ダウンロード場所を指定するよう求めるようにブラウザが設定されている場合は、ファイルを保存するよう求められます。

正常にダウンロードされると、戻りコードが 200 となり、応答本文はなくなります。

このコールで使用する JSON オブジェクトの例を次に示します。

{
  "diskFileName": "string",
  "encryptionKey": "*********",
  "preserveConfigFile": true,
  "autoDeploy": true,
  "allowPendingChange": true,
  "excludeEntities": [
     "string" 
     ]",
  "inputEntities": [
    {
      "action": "CREATE",
      "oldName": "string",
      "parentId": "string",
      "parentName": "string",
      "index": 0,
      "data": {
        "version": "string",
        "id": "string",
        "type": "identity"
      },
      "id": "string",
      "type": "IdEntityWrapper"
    }
  ],
  "jobName": "string",
  "type": "scheduleconfigimport"
}

その属性は次のとおりです。

• diskFileName：インポートする構成の zip または txt ファイルの名前。

• encryptionKey：zip ファイルの暗号化に使用するキー（存在する場合）。構成ファイルが暗号化されていない場合は、キーを指定しないでください。

• preserveConfigFile：（任意）。インポートジョブが正常に完了した後に、脅威に対する防御 ディスクにインポートされた構成ファイルのコピーを保持するかどうか。ファイルを保持する場合は true を指定し、ファイルを 脅威に対する防御 ディスクから削除する場合は false を指定します。デフォルトは False です。

• autoDeploy：（任意）。インポートが成功した場合に展開ジョブを自動的に開始するかどうか。インポートされたオブジェクトは保留中の変更であり、変更を正常に展開するまではアクティブになりません。展開ジョブを自動的に開始するには、true を指定します。false を指定した場合は、手動で変更を展開する必要があります。デフォルトは False です。

• allowPendingChange：（任意）。既存の保留中の変更がある場合にインポートジョブの開始を許可するかどうかを指定します。この属性を true に設定し、autoDeploy を true に設定した場合、自動展開ジョブには、既存とインポート済みの両方の変更がすべて含まれます。この属性を false に設定すると、保留中の変更がある場合にインポートジョブは実行されません。デフォルトは False です。

• excludeEntities：（任意）。インポートしないオブジェクトを識別する文字列に一致するオブジェクトのリスト。インポートする必要がない項目がインポートファイルに含まれている場合（つまり、アップロードしたファイルからそれらのオブジェクトを削除しない場合）にのみ、この属性を指定する必要があります。このリスト内の各項目は、"id=uuid-value"、"type=object-type"、"name=object-name" などのパターンを持ちます。これらのパターンのいずれかに一致する入力オブジェクトが、インポートから除外されます。

  type は、networkobject などのリーフエンティティ、または一連のリーフタイプのエイリアスのいずれかになります。通常の type エイリアスの例としては、network（NetworkObject と NetworkObjectGroup）、port（すべての TCP/UDP/ICMP ポート、プロトコル、およびグループタイプ）、url（URL オブジェクトおよびグループ）、ikepolicy（IKE V1/V2 ポリシー）、ikeproposal（Ike V1/V2 プロポーザル）、identitysource（すべてのアイデンティティソース）、certificate（すべての証明書タイプ）、object（Device Manager の [オブジェクト（Objects）] ページにリストされるすべてのオブジェクト/グループタイプ）、interface（すべてのネットワーク インターフェイス）、s2svpn（すべてのサイト間 VPN 関連タイプ）、ravpn（すべての RA VPN 関連タイプ）、vpn（s2svpn と ravpn の両方）などがあります。

  たとえば、すべてのネットワークオブジェクト、および、名前 myobj と UUID で識別される他の 2 つのオブジェクトをインポートから除外するには、次のように指定します。

  
  "excludeEntities": [
     "type=networkobject", 
     "name=myobj", 
     "id=acc2e3cd-8c70-11e9-930a-1f12ee87b286"
     ]",

• inputEntities：インポートするオブジェクトの数が少ない場合は、それらを構成ファイルで定義するのではなく inputEntities オブジェクトリストで定義できます。この属性を使用する場合は、diskFileName 属性を含めることはできません。または、この属性を null に設定する必要があります。

• jobName：（任意）。エクスポートジョブの名前。ジョブの名前を指定すると、ジョブのステータスを取得するときにジョブを見つけやすくなります。

• type：ジョブのタイプ。常に scheduleconfigimport です。

たとえば、curl コマンドは次のようになります。

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ 
   "diskFileName": "import-2.txt", \ 
   "preserveConfigFile": true, \ 
   "autoDeploy": true, \ 
   "allowPendingChange": true, \ 
   "type": "scheduleconfigimport" \ 
 }' 'https://10.89.5.38/api/fdm/[最新（latest）]/action/configimport'

取得する応答コードは 200 である必要があります。最低限の JSON オブジェクトをポストした場合の正常な応答本文は次のようになります。暗号化キーを指定した場合、暗号化キーは応答でマスクされます。

{
  "version": null,
  "scheduleType": "IMMEDIATE",
  "user": "admin",
  "forceOperation": false,
  "jobHistoryUuid": "7e360139-6725-11e9-abb5-078014531401",
  "ipAddress": "10.24.127.37",
  "diskFileName": "import-2.txt",
  "encryptionKey": null,
  "preserveConfigFile": true,
  "autoDeploy": true,
  "allowPendingChange": true,
  "jobName": "Config Import",
  "id": "7e2b52d8-6725-11e9-abb5-5dec35337506",
  "type": "scheduleconfigimport",
  "links": {
    "self": "https://10.89.5.38/api/fdm/[最新（latest）]
/action/configimport/7e2b52d8-6725-11e9-abb5-5dec35337506"
  }
}

または、GET /jobs/configimportstatus/{objId} を使用して、1 つのインポートジョブのステータスを取得することもできます。objId については、応答本文の jobHistoryUuid 値を POST /action/configimport コールで使用します。

curl コマンドは次のようになります。

curl -X GET --header 'Accept: application/json' 
'https://10.89.5.38/api/fdm/[最新（latest）]/jobs/configimportstatus'

インポートに成功すると、応答本文は次のようになります。インポートに失敗した場合は、必要に応じてファイルを編集して形式や内容のエラーを修正してからやり直す必要があります。

{
      "version": "pcgccfnk4hmiz",
      "jobName": "Config Import",
      "jobDescription": null,
      "user": "admin",
      "startDateTime": "2019-04-25 06:43:54Z",
      "endDateTime": "2019-04-25 06:44:01Z",
      "status": "SUCCESS",
      "statusMessage": "The configuration was imported successfully",
      "scheduleUuid": "7e2b52d8-6725-11e9-abb5-5dec35337506",
      "diskFileName": "import-2.txt",
      "messages": [],
      "preserveConfigFile": true,
      "autoDeploy": true,
      "allowPendingChange": true,
      "id": "7e360139-6725-11e9-abb5-078014531401",
      "type": "configimportjobstatus",
      "links": {
        "self": "https://10.89.5.38/api/fdm/[最新（latest）]
/jobs/configimportstatus/7e360139-6725-11e9-abb5-078014531401"
  }
}