Skip to main content

Python API Client for CCC

Project description

ccc_client

This package provides a simple, modular SDK for the CCC REST API.

Features

  • Automatically handles authentication and renewal
  • Graceful error management
  • Logically organized modules
  • Easily maintained

Installation

Install using pip:

pip install cccAPI 

Install from source:

git clone https://github.hpe.com/hpe/cccAPI.git
cd cccAPI
pip install -e .

Quick Start

Initialize the Client

import json
from cccAPI import cccAPIClient
client = cccAPIClient("https://localhost:8000/cmu/v1", "root", "your-password")

Example Usage

Get Nodes

nodes = client.nodes.show_nodes()
print(json.dumps(nodes, indent=4))

Get specific Node

#Specific node named BartC01n1-091
node = client.nodes.show_node("BartC01n1-091")
print(json.dumps(node, indent=4))

Get specific Node/fields

  • Allowed fields are:
query_params = {"fields": "name,id,uuid,network.name,network.ipAddress,network.macAddress"}
specific_nodes=client.nodes.show_nodes(query_params)
print(json.dumps(specific_nodes, indent=4))

API Modules

Module Description
nodes Query history, top clients/domains, DNS stats
image_groups Enable/disable blocking
network_groups Create, update, and delete groups
custom_groups Allow/block domains (exact & regex)
resource_features Manage client-specific rules
image_capture_deployment Manage blocklists (Adlists)
power_operation Modify CCC configuration
application Get CCC core process (FTL) info
architecture Manage DHCP leases
management_cards View network devices, interfaces, routes
tasks Flush logs, restart services

License

This project is license under the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cccapi-0.0.1.tar.gz (2.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cccapi-0.0.1-py3-none-any.whl (2.2 kB view details)

Uploaded Python 3

File details

Details for the file cccapi-0.0.1.tar.gz.

File metadata

  • Download URL: cccapi-0.0.1.tar.gz
  • Upload date:
  • Size: 2.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for cccapi-0.0.1.tar.gz
Algorithm Hash digest
SHA256 88086e2c03803ef398bf7a016ae9facc7dbbd9b491231f1683278cce0f6ddd22
MD5 a7381c13b9d578d03efc80018e6fd2cc
BLAKE2b-256 b2181c1af1f1a0a42b3f2f299c22cd39d5ff52f1a071bdd62bdc94a5382e5e44

See more details on using hashes here.

File details

Details for the file cccapi-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: cccapi-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 2.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for cccapi-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f2827c23207b46060ddaf4e66b50ee1ccc06e6506a929c7f33512fceb5670743
MD5 e5336692fd5c98dd9f34247d83e71be7
BLAKE2b-256 9def65b40c2b669b366268710c08c437cbcfbb45c4e38676573391bf3161353b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page