Python で Cisco CML 上にサンプルラボを作成する

Cisco CML には Tools Menu の中に Sample Labs という機能があります。 予め所定のディレクトリにワークスペースの構成ファイル (YAML) を配置しておくことで Sample Labs の一覧画面に表示され、それを Import するだけですぐにワークスペースを用意出来ます。 また、CML 自体に「サンプルラボをロードする」という API は実装されています。

CML の操作を自動化するには cmlutils や virl2-client を利用することが出来ます。 ですが、Sample Labs の機能は cmlutils や virl2-client には実装されていないようです。 その為、今回は直接、Python から Sample Labs 機能を利用する REST API を呼び出すサンプルスクリプトをメモしておきます。

検証環境

対象	バージョン
Cisco CML	2.8.1 +build.14
Python	3.13.3

サンプルスクリプト

41 行目で SampleLab1 を指定しています。 これは Sample Labs へ SampleLab1.yaml のようにアップロードされたワークスペースを作成します。 42 行目では作成されたワークスペースの ID を表示しています。

#!/usr/bin/env python

import json

import requests
import urllib3

urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)

address = "10.0.0.1"
username = "admin"
password = "password"

base_url = f"https://{address}/api/v0"


def get_token() -> str:
    headers = {"Content-Type": "application/json", "accept": "application/json"}
    payload = {"username": username, "password": password}
    response = requests.post(
        f"{base_url}/authenticate",
        headers=headers,
        data=json.dumps(payload),
        verify=False,
    ).json()
    return response


def create_sample_lab(token: str, lab_name: str) -> str:
    headers = {"accept": "application/json", "Authorization": "Bearer " + token}
    response = requests.put(
        f"{base_url}/sample/labs/{lab_name}",
        headers=headers,
        verify=False,
    ).json()
    return response


if __name__ == "__main__":
    token = get_token()
    lab_id = create_sample_lab(token, "SampleLab1")
    print(lab_id)