Cisco Modeling Labs (CML)

Detailed API reference for the wingpy.cisco.cml.CiscoModelingLabs class, which provides methods to interact with Cisco Modeling Labs (CML) using REST API. Look for inline examples and code snippets to help you understand how to use each method, and get information about parameters, return values and exceptions.

wingpy.cisco.cml.CiscoModelingLabs

CiscoModelingLabs(
    *,
    base_url: str | None = None,
    username: str | None = None,
    password: str | None = None,
    verify: SSLContext | bool = True,
    timeout: int = 10,
    retries: int = 3
)

Bases: RestApiBaseClass

Interact with the Cisco Modeling Labs API.

Parameters:

Name	Type	Description	Default
base_url	str | None	Base URL of the API including https://. Must end with /api/v0. Overrides the environment variable WINGPY_CML_BASE_URL.	None
username	str | None	Username for API authentication. Overrides the environment variable WINGPY_CML_USERNAME.	None
password	str | None	Password for API authentication. Overrides the environment variable WINGPY_CML_PASSWORD.	None
verify	bool | SSLContext	Boolean values will enable or disable the default SSL verification. Use an ssl.SSLContext to specify custom Certificate Authority.	True
timeout	int	Number of seconds to wait for HTTP responses before raising httpx.TimeoutException exception.	10
retries	int	Number of failed HTTP attempts allowed before raising httpx.HTTPStatusError exception.	3

Examples:

from wingpy import CiscoModelingLabs
cml = CiscoModelingLabs(
    base_url="https://cml.example.com/api/v0",
    username="example_username",
    password="example_password",
)
cml.get("/")

Raises:

Type	Description
ValueError	When base_url, username or password is missing
ValueError	When base_url does not end with /api/v0

Source code in src/wingpy/cisco/cml.py

def __init__(
    self,
    *,
    base_url: str | None = None,
    username: str | None = None,
    password: str | None = None,
    verify: SSLContext | bool = True,
    timeout: int = 10,
    retries: int = 3,
):
    # Allow parameters to be passed directly or fallback to environment variables
    self.cml_url = base_url or os.getenv("WINGPY_CML_BASE_URL")
    """
    The base URL for the Cisco Modeling Labs API.

    If not provided, it will be read from the environment variable `WINGPY_CML_BASE_URL`.
    """

    self.username = username or os.getenv("WINGPY_CML_USERNAME")
    """
    The username for authentication.
    If not provided, it will be read from the environment variable `WINGPY_CML_USERNAME`.
    """

    self.password = password or os.getenv("WINGPY_CML_PASSWORD")
    """
    The password for authentication.
    If not provided, it will be read from the environment variable `WINGPY_CML_PASSWORD`.
    """

    self.token = None
    """
    The authentication token for the Cisco Modeling Labs API.
    """

    if not self.username or not self.password:
        raise ValueError(
            "Username and password must be provided either as argument or environment variable"
        )

    if not self.cml_url:
        raise ValueError(
            "Cisco Modeling Labs base_url must be provided either as argument or environment variable"
        )
    elif not self.cml_url.endswith("/api/v0"):
        raise ValueError("Cisco Modeling Labs base_url must end with /api/v0")

    self.version: Version = Version("0.0")
    """
    The version of the Cisco Modeling Labs API.
    """

    super().__init__(
        base_url=self.cml_url,
        auth_refresh_percentage=0.9,
        verify=verify,
        headers={
            "Content-Type": "application/json",
            "Accept": "application/json",
        },
        timeout=timeout,
        retries=retries,
    )

get

get(
    path: str,
    *,
    params: dict | None = None,
    path_params: dict | None = None,
    headers: dict | None = None,
    timeout: int | None = None
) -> httpx.Response

Send an HTTP GET request to the specified path.

Parameters:

Name	Type	Description	Default
path	str	The API endpoint path to send the request to.	required
params	dict | None	URL query parameters to include in the request. will be added as ?key=value pairs in the URL.	None
path_params	dict | None	Replace placeholders like {lab_id} in the URL path with actual values. Will be combined with self.path_params before sending request.	None
headers	dict | None	HTTP headers to be sent with the request. Will be combined with self.headers before sending request.	None
timeout	int | None	Override the standard timeout timer self.timeout for a single request.	None

Returns:

Type	Description
Response	The httpx.Response object from the request.

Source code in src/wingpy/cisco/cml.py

def get(
    self,
    path: str,
    *,
    params: dict | None = None,
    path_params: dict | None = None,
    headers: dict | None = None,
    timeout: int | None = None,
) -> httpx.Response:
    """
    Send an HTTP `GET` request to the specified path.

    Parameters
    ----------
    path : str
        The API endpoint path to send the request to.

    params : dict | None, default=None
        URL query parameters to include in the request. will be added as `?key=value` pairs in the URL.

    path_params : dict | None, default=None
        Replace placeholders like `{lab_id}` in the URL path with actual values.

        Will be combined with [self.path_params](https://wingpy.automation.wingmen.dk/api/cml/#wingpy.cisco.cml.CiscoModelingLabs.path_params) before sending request.

    headers : dict | None, default=None
        HTTP headers to be sent with the request.

        Will be combined with [self.headers](https://wingpy.automation.wingmen.dk/api/cml/#wingpy.cisco.cml.CiscoModelingLabs.headers) before sending request.

    timeout : int | None, default=None
        Override the standard timeout timer [self.timeout](https://wingpy.automation.wingmen.dk/api/cml/#wingpy.cisco.cml.CiscoModelingLabs.timeout) for a single request.

    Returns
    -------
    httpx.Response
        The [`httpx.Response`](https://www.python-httpx.org/api/#response) object from the request.
    """

    response = self.request(
        "GET",
        path,
        data=None,
        params=params,
        path_params=path_params,
        headers=headers,
        timeout=timeout,
        is_auth_endpoint=False,
        auth=None,
    )
    return response

get_all

get_all(
    path: str,
    *,
    params: dict | None = None,
    path_params: dict | None = None,
    headers: dict | None = None,
    timeout: int | None = None
) -> list

Retrieves all data items from a GET endpoint.

Parameters:

Name	Type	Description	Default
path	str	The API endpoint path to send the request to.	required
params	dict | None	URL query parameters to include in the request. will be added as ?key=value pairs in the URL.	None
path_params	dict | None	Replace placeholders like {objectId} in the URL path with actual values. Will be combined with self.path_params before sending request.	None
headers	dict | None	HTTP headers to be sent with the request. Will be combined with self.headers before sending request.	None
timeout	int | None	Override the standard timeout timer self.timeout for a single request.	None

Returns:

Type	Description
list[dict]	A list of returned dictionaries from the GET endpoint. Similar to the root list in the Cisco Modeling Labs API JSON responses.

Source code in src/wingpy/cisco/cml.py

def get_all(
    self,
    path: str,
    *,
    params: dict | None = None,
    path_params: dict | None = None,
    headers: dict | None = None,
    timeout: int | None = None,
) -> list:
    """
    Retrieves all data items from a `GET` endpoint.

    Parameters
    ----------
    path : str
        The API endpoint path to send the request to.

    params : dict | None, default=None
        URL query parameters to include in the request. will be added as `?key=value` pairs in the URL.

    path_params : dict | None, default=None
        Replace placeholders like `{objectId}` in the URL path with actual values.

        Will be combined with [self.path_params](https://wingpy.automation.wingmen.dk/api/cml/#wingpy.cisco.cml.CiscoModelingLabs.path_params) before sending request.

    headers : dict | None, default=None
        HTTP headers to be sent with the request.

        Will be combined with [self.headers](https://wingpy.automation.wingmen.dk/api/cml/#wingpy.cisco.cml.CiscoModelingLabs.headers) before sending request.

    timeout : int | None, default=None
        Override the standard timeout timer [self.timeout](https://wingpy.automation.wingmen.dk/api/cml/#wingpy.cisco.cml.CiscoModelingLabs.timeout) for a single request.

    Returns
    -------
    list[dict]
        A list of returned dictionaries from the GET endpoint.

        Similar to the root list in the Cisco Modeling Labs API JSON responses.
    """

    response = self.get(
        path,
        params=params,
        path_params=path_params,
        headers=headers,
        timeout=timeout,
    )

    response_list = response.json()

    if not isinstance(response_list, list):
        raise UnsupportedMethodError(
            "The get_all method is only supported for endpoints returning a list"
        )

    return response_list

post

post(
    path: str,
    *,
    data: str | dict | list | None,
    path_params: dict | None = None,
    headers: dict | None = None,
    timeout: int | None = None
) -> httpx.Response

Send an HTTP POST request to the specified path.

Parameters:

Name	Type	Description	Default
path	str	The API endpoint path to send the request to.	required
data	str | dict | list | None	Request payload as JSON string or Python list/dict object.	required
path_params	dict | None	Replace placeholders like {lab_id} in the URL path with actual values. Will be combined with self.path_params before sending request.	None
headers	dict | None	HTTP headers to be sent with the request. Will be combined with self.headers before sending request.	None
timeout	int | None	Override the standard timeout timer self.timeout for a single request.	None

Returns:

Type	Description
Response	The httpx.Response object from the request.

Source code in src/wingpy/cisco/cml.py

def post(
    self,
    path: str,
    *,
    data: str | dict | list | None,
    path_params: dict | None = None,
    headers: dict | None = None,
    timeout: int | None = None,
) -> httpx.Response:
    """
    Send an HTTP `POST` request to the specified path.

    Parameters
    ----------
    path : str
        The API endpoint path to send the request to.

    data : str | dict | list | None
        Request payload as JSON string or Python list/dict object.

    path_params : dict | None, default=None
        Replace placeholders like `{lab_id}` in the URL path with actual values.

        Will be combined with [self.path_params](https://wingpy.automation.wingmen.dk/api/cml/#wingpy.cml.CiscoModelingLabs.path_params) before sending request.

    headers : dict | None, default=None
        HTTP headers to be sent with the request.

        Will be combined with [self.headers](https://wingpy.automation.wingmen.dk/api/cml/#wingpy.cml.CiscoModelingLabs.headers) before sending request.

    timeout : int | None, default=None
        Override the standard timeout timer [self.timeout](https://wingpy.automation.wingmen.dk/api/cml/#wingpy.cml.CiscoModelingLabs.timeout) for a single request.

    Returns
    -------
    httpx.Response
        The [`httpx.Response`](https://www.python-httpx.org/api/#response) object from the request.
    """

    response = self.request(
        "POST",
        path,
        data=data,
        params=None,
        path_params=path_params,
        headers=headers,
        timeout=timeout,
        is_auth_endpoint=False,
        auth=None,
    )

    return response

put

put(
    path: str,
    *,
    data: str | dict | list | None = None,
    path_params: dict | None = None,
    headers: dict | None = None,
    timeout: int | None = None
) -> httpx.Response

Send an HTTP PUT request to the specified path.

Parameters:

Name	Type	Description	Default
path	str	The API endpoint path to send the request to.	required
data	str | dict | list | None	Request payload as JSON string or Python list/dict object.	None
path_params	dict | None	Replace placeholders like {lab_id} in the URL path with actual values. Will be combined with self.path_params before sending request.	None
headers	dict | None	HTTP headers to be sent with the request. Will be combined with self.headers before sending request.	None
timeout	int | None	Override the standard timeout timer self.timeout for a single request.	None

Returns:

Type	Description
Response	The httpx.Response object from the request.

Source code in src/wingpy/cisco/cml.py

def put(
    self,
    path: str,
    *,
    data: str | dict | list | None = None,
    path_params: dict | None = None,
    headers: dict | None = None,
    timeout: int | None = None,
) -> httpx.Response:
    """
    Send an HTTP `PUT` request to the specified path.

    Parameters
    ----------
    path : str
        The API endpoint path to send the request to.

    data : str | dict | list | None, default=None
        Request payload as JSON string or Python list/dict object.

    path_params : dict | None, default=None
        Replace placeholders like `{lab_id}` in the URL path with actual values.

        Will be combined with [self.path_params](https://wingpy.automation.wingmen.dk/api/cml/#wingpy.cisco.cml.CiscoModelingLabs.path_params) before sending request.

    headers : dict | None, default=None
        HTTP headers to be sent with the request.

        Will be combined with [self.headers](https://wingpy.automation.wingmen.dk/api/cml/#wingpy.cisco.cml.CiscoModelingLabs.headers) before sending request.

    timeout : int | None, default=None
        Override the standard timeout timer [self.timeout](https://wingpy.automation.wingmen.dk/api/cml/#wingpy.cisco.cml.CiscoModelingLabs.timeout) for a single request.

    Returns
    -------
    httpx.Response
        The [`httpx.Response`](https://www.python-httpx.org/api/#response) object from the request.
    """

    response = self.request(
        "PUT",
        path,
        data=data,
        params=None,
        path_params=path_params,
        headers=headers,
        timeout=timeout,
        is_auth_endpoint=False,
        auth=None,
    )

    return response

patch

patch(
    path: str,
    *,
    data: str | dict | list | None,
    path_params: dict | None = None,
    headers: dict | None = None,
    timeout: int | None = None
) -> httpx.Response

Send an HTTP PATCH request to the specified path.

Parameters:

Name	Type	Description	Default
path	str	The API endpoint path to send the request to.	required
data	str | dict | list	Request payload as JSON string or Python list/dict object.	required
path_params	dict | None	Replace placeholders like {lab_id} in the URL path with actual values. Will be combined with self.path_params before sending request.	None
headers	dict | None	HTTP headers to be sent with the request. Will be combined with self.headers before sending request.	None
timeout	int | None	Override the standard timeout timer self.timeout for a single request.	None

Returns:

Type	Description
Response	The httpx.Response object from the request.

Source code in src/wingpy/cisco/cml.py

def patch(
    self,
    path: str,
    *,
    data: str | dict | list | None,
    path_params: dict | None = None,
    headers: dict | None = None,
    timeout: int | None = None,
) -> httpx.Response:
    """
    Send an HTTP `PATCH` request to the specified path.

    Parameters
    ----------
    path : str
        The API endpoint path to send the request to.

    data : str | dict | list
        Request payload as JSON string or Python list/dict object.

    path_params : dict | None, default=None
        Replace placeholders like `{lab_id}` in the URL path with actual values.

        Will be combined with [self.path_params](https://wingpy.automation.wingmen.dk/api/cml/#wingpy.cisco.cml.CiscoModelingLabs.path_params) before sending request.

    headers : dict | None, default=None
        HTTP headers to be sent with the request.

        Will be combined with [self.headers](https://wingpy.automation.wingmen.dk/api/cml/#wingpy.cisco.cml.CiscoModelingLabs.headers) before sending request.

    timeout : int | None, default=None
        Override the standard timeout timer [self.timeout](https://wingpy.automation.wingmen.dk/api/cml/#wingpy.cisco.cml.CiscoModelingLabs.timeout) for a single request.

    Returns
    -------
    httpx.Response
        The [`httpx.Response`](https://www.python-httpx.org/api/#response) object from the request.
    """

    response = self.request(
        "PATCH",
        path,
        data=data,
        params=None,
        path_params=path_params,
        headers=headers,
        timeout=timeout,
        is_auth_endpoint=False,
        auth=None,
    )

    return response

delete

delete(
    path: str,
    *,
    path_params: dict | None = None,
    headers: dict | None = None,
    timeout: int | None = None
) -> httpx.Response

Send an HTTP DELETE request to the specified path.

Parameters:

Name	Type	Description	Default
path	str	The API endpoint path to send the request to.	required
path_params	dict | None	Replace placeholders like {lab_id} in the URL path with actual values. Will be combined with self.path_params before sending request.	None
headers	dict | None	HTTP headers to be sent with the request. Will be combined with self.headers before sending request.	None
timeout	int | None	Override the standard timeout timer self.timeout for a single request.	None

Returns:

Type	Description
Response	The httpx.Response object from the request.

Source code in src/wingpy/cisco/cml.py

def delete(
    self,
    path: str,
    *,
    path_params: dict | None = None,
    headers: dict | None = None,
    timeout: int | None = None,
) -> httpx.Response:
    """
    Send an HTTP `DELETE` request to the specified path.

    Parameters
    ----------
    path : str
        The API endpoint path to send the request to.

    path_params : dict | None, default=None
        Replace placeholders like `{lab_id}` in the URL path with actual values.

        Will be combined with [self.path_params](https://wingpy.automation.wingmen.dk/api/cml/#wingpy.cisco.cml.CiscoModelingLabs.path_params) before sending request.

    headers : dict | None, default=None
        HTTP headers to be sent with the request.

        Will be combined with [self.headers](https://wingpy.automation.wingmen.dk/api/cml/#wingpy.cisco.cml.CiscoModelingLabs.headers) before sending request.

    timeout : int | None, default=None
        Override the standard timeout timer [self.timeout](https://wingpy.automation.wingmen.dk/api/cml/#wingpy.cisco.cml.CiscoModelingLabs.timeout) for a single request.

    Returns
    -------
    httpx.Response
        The [`httpx.Response`](https://www.python-httpx.org/api/#response) object from the request.
    """

    response = self.request(
        "DELETE",
        path,
        data=None,
        params=None,
        path_params=path_params,
        headers=headers,
        timeout=timeout,
        is_auth_endpoint=False,
        auth=None,
    )

    return response

authenticate

authenticate() -> None

Executes the API-specific authentication process and records timestamps for session tracking.

Notes

Authentication will automatically be carried out just-in-time.

Only call this method directly if you need to authenticate proactively, outside of normal request flow.

Source code in src/wingpy/base.py

def authenticate(self) -> None:
    """
    Executes the API-specific authentication process and records timestamps
    for session tracking.

    Notes
    ----
    Authentication will automatically be carried out just-in-time.

    Only call this method directly if you need to authenticate proactively,
    outside of normal request flow.
    """

    # Authenticate
    logger.debug("Authenticating and recording token lifetime")
    auth_response = self._authenticate()

    # Record the time of authentication
    self.auth_timestamp = arrow.utcnow()

    self._after_auth(auth_response=auth_response)

tasks

tasks: TaskRunner = TaskRunner(max_workers=max_workers)

Manages concurrent requests to the API server.

The number of concurrent requests is limited by the MAX_CONNECTIONS property:

• 1 connection is reserved for the main thread used for authentication and synchronous requests.
• The remaining connections are used for concurrent requests.

See Also

wingpy.scheduling.TaskRunner Schedule and run asynchronous tasks in parallel.

is_authenticated

is_authenticated

Check if the client is authenticated.

timeout

timeout: int = timeout

The timeout in seconds for each request to the API server.

MAX_CONNECTIONS

MAX_CONNECTIONS = 10

The maximum number of concurrent connections opened to the Cisco Modeling Labs.

1 connection will be used for general synchronous requests.

6 connections will be used for parallel asynchronous requests.

RETRY_RESPONSES

RETRY_RESPONSES = []

No explicit retry reponses are defined for Cisco Modeling Labs.

headers

headers: dict = headers or {}

A dictionary of HTTP headers to be sent with each request. These headers will be merged with any headers dict passed to an individual request.

path_params

path_params: dict = {}

A dictionary of path parameters to be used in the API path of each request.

These parameters will be merged with any path_params dict passed to the request.