API リファレンスガイド
この Kaspersky Security Center OpenAPI リファレンスガイドは、次のタスクを支援する目的で作成されています：
- 自動化とカスタマイズ。管理コンソールを使用して、手動で扱う必要がないタスクを自動化できます。管理コンソールでサポートされていないシナリオの実装も可能です。たとえば、管理者として Kaspersky Security Center OpenAPI を使用し、管理グループ構造の作成を支援するスクリプトを作成、実行することで、その構造の最新の状態を維持できます。
- カスタム開発。たとえば、クライアント用に操作を制限した代替の MMC ベースの管理コンソールを開発できます。
OpenAPI リファレンスガイドでは、画面右側の検索フィールドを使用して必要な情報を検索できます。
スクリプトのサンプル
OpenAPI リファレンスガイドには、次の表に示す Python スクリプトのサンプルが含まれています。これらのサンプルは、OpenAPI メソッドを呼び出して、ネットワークを保護するための様々なタスクを自動的に実行する方法を示しています。たとえば、 「プライマリ」と「セカンダリ」の階層の作成、 Kaspersky Security Centerでのタスクの実行、ディストリビューションポイントの割り当てなどの方法です。サンプルをそのまま実行することも、サンプルを基に独自のスクリプトを作成することもできます。
OpenAPI メソッドを呼び出してスクリプトを実行するには：
- KlAkOAPI.tar.gz アーカイブをダウンロードします。このアーカイブには、KlAkOAPI パッケージとサンプルが含まれています（アーカイブまたは OpenAPI リファレンスガイドからコピーできます）。KlAkOAPI.tar.gz アーカイブは、Kaspersky Security Center のインストールフォルダーにもあります。
- 管理サーバーがインストールされているデバイス上の KlAkOAPI.tar.gz アーカイブから KlAkOAPI パッケージをインストールします。
OpenAPI メソッドを呼び出し、サンプルや独自のスクリプトを実行するのは、管理サーバーと KlAkOAPI パッケージがインストールされているデバイスでのみ実行できます。
ユーザーシナリオと Kaspersky Security Center OpenAPI メソッドのサンプルの一致
サンプル
サンプルの目的
シナリオ
KlAkParamsデータ構造を使用してデータを抽出、処理できます。サンプルには、このデータ構造の使用方法を示しています。サンプル出力は、様々な方法で表示される場合があります。データを取得して HTTP メソッドを送信したり、自分のコードで使用したりできます。
管理サーバーをセカンダリ管理サーバーとして追加し、プライマリとセカンダリの階層を確立できます。または、セカンダリ管理サーバーを階層から切断することもできます。
Active Directory 単位をポーリングして、検出されたデバイスグループの階層を形成できます。
以前にポーリングされた Active Directory 単位に基づいて、管理対象デバイスグループの階層を形成できます。最後のポーリング後に新しいデバイスが Active Directory に表示された場合、それらは保存されたポーリング結果に含まれていないため、グループに追加されません。
接続ゲートウェイを使用して、必要なデバイスでネットワークエージェントに接続できます。次に、ネットワークリストを含むファイルをデバイスにダウンロードします。
プライマリ管理サーバーに接続し、そこから必要なライセンスをダウンロードして、このライセンスを階層内のすべてのセカンダリ管理サーバーに送信できます。
様々なレポートを作成できます。たとえば、このサンプルを使用して、有効なユーザー権限のレポートを生成できます。このレポートでは、ユーザーのグループと役割に応じて、ユーザーが持つ権限について説明します。
レポートは、HTML、PDF、Excel 形式でダウンロードできます。
接続ゲートウェイを使用して、必要なデバイスでネットワークエージェントに接続できます。次に必要なタスクを実行します。
使用する Active Directory 単位に基づいて IP サブネットを作成できます。
サンプルは、指定された IP 範囲のポーリングを開始し、検出されたサブネットを削除して、新しいサブネットとの競合を回避します。したがって、サブネットの保存が重要なネットワークでは、このサンプルを実行しないでください。
ポーリング後、サンプルは Active Directory を参照し、その中のすべてのデバイスを調査して、IP サブネットを作成します。これを実行するために、サンプルはすべてのデバイスのマスクと IP アドレスを使用します。
管理対象デバイスをディストリビューションポイント（以前はアップデートエージェントと呼ばれていました）として割り当てることができます。
管理グループに対して、様々な処理を実行できます。サンプルでは、次の実行方法を例示しています：
- ［管理対象デバイス］ルートグループの識別子の取得
- グループ階層の移動
- グループの完全な拡張階層を、名前とネスト構造とともに取得
参照可能な情報は次の通りです：
- タスクの進捗履歴
- 現在のタスクステータス
- 様々なステータスのタスクの数
タスクの実行も可能です。既定では、サンプルは統計の出力後にタスクを実行します。
タスクを作成できます。サンプルにある次のタスクパラメータを指定します：
- 種別
- 実行方法
- 名前
- タスクが使用されるデバイスグループ
既定では、サンプルは「メッセージを表示する」種別のタスクを作成します。このタスクは、管理サーバーのすべての管理対象デバイスに対して実行できます。必要に応じて、タスクパラメータを独自に指定できます。
管理サーバーが管理するデバイスにインストールされたカスペルスキー製品の、現在のライセンスがすべてリストされた一覧を取得できます。リストには、全ライセンスの詳細データ（名前、種別、有効期限日など）が含まれています。
さらなる作業のためにアカウントを作成できます。
必要なパラメータとともに、アプリケーションカテゴリを作成できます。
SrvView クラスを使用して、管理サーバーからの詳細な情報をリクエストできます。たとえば、このサンプルを使用してユーザーのリストを取得できます。
OpenAPI 経由で Kaspersky Security Center と連携するアプリケーション
一部のアプリケーションは、OpenAPI 経由で Kaspersky Security Center と連携します。Kaspersky Anti Targeted Attack Platform または Kaspersky Security for Virtualization などがこのようなアプリケーションに含まれます。また、OpenAPI に基づいて開発されたカスタムクライアントアプリケーションであることもあります。
OpenAPI 経由で Kaspersky Security Center と連携するアプリケーションは管理サービスに接続します。管理サーバーへの接続用に IP アドレスの許可リストを設定している場合は、Kaspersky Security Center の OpenAPI を使用するアプリケーションをインストールしているデバイスの IP アドレスを追加してください。使用しているアプリケーションが OpenAPI によって動作しているかどうかについては、そのアプリケーションのヘルプを参照してください。