CIDP Python SDK

0.0.14 verified Sat May 09 auth: no python

A Python SDK for interacting with the Cisco Identity Services Engine (ISE) External RESTful Services (ERS) API. Version 0.0.14 supports Python >=3.6. Provides simplified access to ISE resources such as users, endpoints, and network devices. Release cadence is low / ad-hoc.

pip install cidp

Common errors

error ModuleNotFoundError: No module named 'cidp' ↓

cause The package is not installed or not in the current environment.

fix

Run pip install cidp to install the SDK.

error requests.exceptions.SSLError: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed ↓

cause ISE uses a self-signed certificate and verify is not set to False.

fix

Set verify=False when creating CiscoISE instance: CiscoISE(..., verify=False).

Warnings

gotcha SSL verification defaults to True, but ISE often uses self-signed certificates. You must set verify=False or provide a CA bundle to avoid errors. ↓

fix Pass verify=False when creating CiscoISE instance or set verify='/path/to/ca-bundle.crt'.

gotcha The SDK uses ERS API which must be enabled on ISE. Without it, all API calls will fail with 401 or 404. ↓

fix Enable ERS on ISE under Administration > System > Settings > ERS Settings.

deprecated The method 'get_endpoint' (singular) is deprecated in favor of 'get_endpoints' (plural). The old method may be removed in future releases. ↓

fix Use ise.get_endpoints() instead of ise.get_endpoint().

Imports

CiscoISE

wrong

from cidp.CiscoISE import CiscoISE

correct

from cidp import CiscoISE

CiscoISE is a top-level class, not a module

Quickstart

Initialize CiscoISE with server, credentials, and optional SSL verification. Note: verify=False is commonly used in lab environments.

from cidp import CiscoISE

ise = CiscoISE(
    server=os.environ.get('ISE_SERVER', ''),
    username=os.environ.get('ISE_USERNAME', ''),
    password=os.environ.get('ISE_PASSWORD', ''),
    verify=False
)
print(ise.get_endpoints())