API リファレンスガイド

2024年5月20日

ID 211453

この Kaspersky Security Center OpenAPI リファレンスガイドは、次のタスクを支援する目的で作成されています:

  • 自動化とカスタマイズ。手動で扱う必要がないタスクを自動化できます。たとえば、管理者として Kaspersky Security Center OpenAPI を使用し、管理グループ構造の作成を支援するスクリプトを作成、実行することで、その構造の最新の状態を維持できます。
  • カスタム開発。OpenAPI を使用して、クライアントアプリケーションを開発できます。

画面右側の検索フィールドを使用して OpenAPI リファレンスガイドから必要な情報を見つけることができます。

unloc_icon_API_open OPENAPI リファレンスガイド(英語)

スクリプトのサンプル

OpenAPI リファレンスガイドには、次の表に示す Python スクリプトのサンプルが含まれています。これらのサンプルは、OpenAPI メソッドを呼び出して、ネットワークを保護するための様々なタスクを自動的に実行する方法を示しています。たとえば、 「プライマリ」と「セカンダリ」の階層の作成、 Kaspersky Security Center Linux でのタスクの実行、ディストリビューションポイントの割り当てなどの方法です。サンプルをそのまま実行することも、サンプルを基に独自のスクリプトを作成することもできます。

OpenAPI メソッドを呼び出してスクリプトを実行するには:

  1. KlAkOAPI.tar.gz アーカイブをダウンロードします。このアーカイブには、KlAkOAPI パッケージとサンプルが含まれています(アーカイブまたは OpenAPI リファレンスガイドからコピーできます)。KlAkOAPI.tar.gz アーカイブは、Kaspersky Security Center Linux インストールフォルダーにもあります。
  2. 管理サーバーがインストールされているデバイス上の KlAkOAPI.tar.gz アーカイブから KlAkOAPI パッケージをインストールします。

    OpenAPI メソッドを呼び出し、サンプルや独自のスクリプトを実行するのは、管理サーバーと KlAkOAPI パッケージがインストールされているデバイスでのみ実行できます。

    ユーザーシナリオと Kaspersky Security Center OpenAPI メソッドのサンプルの一致

    サンプル

    サンプルの目的

    シナリオ

    KlAkParams のログ記録

    KlAkParams データ構造を使用してデータを抽出、処理できます。サンプルには、このデータ構造の使用方法を示しています。

    サンプル出力は、様々な方法で表示される場合があります。データを取得して HTTP メソッドを送信したり、自分のコードで使用したりできます。

    監視とレポート

    プライマリ / セカンダリ階層の作成と削除(英語)

    管理サーバーをセカンダリ管理サーバーとして追加し、プライマリとセカンダリの階層を確立できます。または、セカンダリ管理サーバーを階層から切断することもできます。

    管理サーバーの階層の作成、セカンダリ管理サーバーの追加管理サーバーの階層の削除

    接続ゲートウェイを使用してネットワークリストファイルを指定したホストにダウンロード

    接続ゲートウェイを使用して、必要なデバイスでネットワークエージェントに接続できます。次に、ネットワークリストを含むファイルをデバイスにダウンロードします。

    ディストリビューションポイントと接続ゲートウェイの調整

    プライマリ管理サーバーリポジトリに保存されたライセンスのセカンダリ管理サーバーへのインストール

    プライマリ管理サーバーに接続し、そこから必要なライセンスをダウンロードして、このライセンスを階層内のすべてのセカンダリ管理サーバーに送信できます。

    カスペルスキー製品のライセンスの更新

    有効なユーザー権限のレポートの作成

    様々なレポートを作成できます。たとえば、このサンプルを使用して、有効なユーザー権限のレポートを生成できます。このレポートでは、ユーザーのグループと役割に応じて、ユーザーが持つ権限について説明します。

    レポートは、HTML、PDF、Excel 形式でダウンロードできます。

    レポートの生成と表示

    デバイスタスクの開始

    接続ゲートウェイを使用して、必要なデバイスでネットワークエージェントに接続できます。次に必要なタスクを実行します。

    タスクの手動での開始

    デバイスのディストリビューションポイントのグループへの登録(英語)

    管理対象デバイスをディストリビューションポイント(以前はアップデートエージェントと呼ばれていました)として割り当てることができます。

    定義データベースとカスペルスキー製品のアップデート

    すべてのグループの列挙(英語)

     

    管理グループに対して、様々な処理を実行できます。サンプルでは、次の実行方法を例示しています:

    • [管理対象デバイス]ルートグループの識別子の取得
    • グループ階層の移動
    • グループの完全な拡張階層を、名前とネスト構造とともに取得

    管理サーバーの設定

    タスクの列挙、タスクの統計のクエリ、タスクの実行(英語)

    参照可能な情報は次の通りです:

    • タスクの進捗履歴
    • 現在のタスクステータス
    • 様々なステータスのタスクの数

    タスクの実行も可能です。既定では、サンプルは統計の出力後にタスクを実行します。

    タスク実行の監視

    タスクの作成と実行(英語)

    タスクを作成できます。サンプルにある次のタスクパラメータを指定します:

    • 種別
    • 実行方法
    • 名前
    • タスクが使用されるデバイスグループ

    既定では、サンプルは「メッセージを表示する」種別のタスクを作成します。このタスクは、管理サーバーのすべての管理対象デバイスに対して実行できます。必要に応じて、タスクパラメータを独自に指定できます。

    タスクの作成

    ライセンスの列挙(英語)

    管理サーバーが管理するデバイスにインストールされたカスペルスキー製品の、現在のライセンスがすべてリストされた一覧を取得できます。リストには、全ライセンスの詳細データ(名前、種別、有効期限日など)が含まれています。

    使用中のライセンスに関する情報の表示

    内部ユーザーの作成および検索(英語)

    さらなる作業のためにアカウントを作成できます。

    管理サーバーを開始するアカウントの選択

    カスタムカテゴリの作成(英語)

    必要なパラメータとともに、アプリケーションカテゴリを作成できます。

    コンテンツが手動で追加されるアプリケーションカテゴリの作成

    SrvView を使用したユーザーの列挙(英語)

    SrvView クラスを使用して、管理サーバーからの詳細な情報をリクエストできます。たとえば、このサンプルを使用してユーザーのリストを取得できます。

    ユーザーアカウントの管理

OpenAPI 経由で Linux Kaspersky Security Center と連携するアプリケーション

一部のアプリケーションは、OpenAPI 経由で Kaspersky Security Center Linux と連携します。Kaspersky Anti Targeted Attack Platform または Kaspersky Security for Virtualization などがこのようなアプリケーションに含まれます。また、OpenAPI に基づいて開発されたカスタムクライアントアプリケーションであることもあります。

OpenAPI 経由で Kaspersky Security Center Linux と連携するアプリケーションは管理サービスに接続します。管理サーバーへの接続用に IP アドレスの許可リストを設定している場合は、Kaspersky Security Center Linux の OpenAPI を使用するアプリケーションをインストールしているデバイスの IP アドレスを追加してください。使用しているアプリケーションが OpenAPI によって動作しているかどうかについては、そのアプリケーションのヘルプを参照してください。

この記事はお役に立ちましたか?
改善できる点がありましたらお聞かせください。
フィードバックをいただき、ありがとうございました。改善に向けて取り組んでまいります。
フィードバックをいただき、ありがとうございました。改善に向けて取り組んでまいります。