module.create

説明

object module.create(object/array modules)

このメソッドを使用すると、新しいWebインターフェースモジュールをインストールできます。

このメソッドは、特権管理者ユーザータイプでのみ使用できます。 メソッドを呼び出す権限は、ユーザーロールの設定で取り消すことができます。 詳細については、ユーザーロールを参照してください。
Webインターフェース設定ファイルで$ZBX_FEATURE_FLAGS['modules_config_enabled']がfalseに設定されている場合、ユーザーはこのメソッドを呼び出せません。

モジュールファイルは、モジュールのrelative_pathプロパティに対応する正しいサブディレクトリに手動で展開する必要があります。

パラメータ

(object/array) 作成するモジュール。

このメソッドは、標準モジュールプロパティを持つモジュールを受け入れます。

戻り値

(object) は、moduleids プロパティにインストールされているモジュールの ID を含むオブジェクトを返します。 返される ID の順序は、渡されたモジュールの順序と一致します。

例

モジュールのインストール

モジュールをステータス"有効"でインストールします。

リクエスト :

{
    "jsonrpc": "2.0",
    "method": "module.create",
    "params": {
        "id": "example_module",
        "relative_path": "modules/example_module",
        "status": 1
    },
    "id": 1
}

レスポンス :

{
    "jsonrpc": "2.0",
    "result": {
        "moduleids": [
            "25"
        ]
    },
    "id": 1
}

参照

ソース

CModule::create() in ui/include/classes/api/services/CModule.php.