Skip to main content

An attempt at a simplified API collection for Cisco Collab products

Project description

CollabConnector

Cisco Collab Connector Library

This library is made to try and be a single source for all Cisco Collab APIs (which can be lots). The goal is to unify requests and responses across different REST and SOAP APIs availble to make connecting to and scripting Collab tasks easier. Hopefully. Maybe.

Install:

pip3 install CollabConnector

Usage:

>>> from CollabConnector import CUCM
>>> from CollabConnector import CUCX
>>> from CollabConnector import UCCX
>>> from CollabConnector.Webex import Webex

>>> cucm = CUCM.Connect("10.10.10.10", "admin", "P@ssw0rd")
>>> cucm.query("select count(*) from enduser")
[{'count': '5'}]
>>> cucm.get.Phone(name="SEP3C08F67A9618")
[{'name': 'SEP3C08F67A9618', 'description': 'Auto 1000', 'product': 'Cisco 7841', 'mod... }]
>>> cucm.uds.get("version")
{'@uri': 'https://10.10.10.10:8443/cucm-uds/version', '@version': '12.5.1', 'version': '12.5.1', 'capabil... }]
>>> cucm.ast.cluster
{'cluster_name': 'StandAloneCluster', 'nodes': ['cucm-01.lab-01.mycollablab.org', 'cucm-02.lab-01.mycollablab.org'], 'service...}]
>>> cucm.serviceability.status("Cisco Tftp")
{'cucm-01.lab-01.mycollablab.org': {'Cisco Tftp': {'ServiceName': 'Cisco Tftp', 'ServiceStatus': 'Started', 'ReasonCode': -1, 'Rea...}]
>>> cucm.registration_status("SEP3C08F67A9618")
{'SEP3C08F67A9618': {'name': 'SEP3C08F67A9618', 'node': ..., 'firmware': 'sip78xx.12-7-1-0001-393', 'IPAddress': ..., 'dirn': '1000', 'status': 'Registered'}}

>>> unity = CUCX.Connect("10.10.10.20", "admin", "P@ssw0rd")
>>> unity.get("users")
[{'URI': '/vmrest/users/a151...123', 'ObjectId': 'a151...123', 'Alias': 'undeliverablemess... }]
>>> unity.get("/vmrest/users", DtmfAccessId="10*", sort="DtmfAccessId")
[{'URI': ..., 'ObjectId': ..., 'FirstName': '', 'LastName': '', 'Alias': '1000', 'DisplayName': '1000', 'EmailAddress': '', ... }]

>>> ccx = UCCX.Connect("10.10.10.40", "admin", "P@ssw0rd")
>>> ccx.get("application")
[{'@type': 'applicationXMLList', 'application': []}]

>>> wbx = Webex.Connect(token)
>>> wbx.get("/v1/people/me")
{'id': 'Y2l...mYTg', 'emails': ['jsn....com'], 'phoneNumbers': [{'type': 'work', 'value': '2001'}, ...}]

Notes: The AXL SOAP API was generated based on the version 14 WSDL files and may not be complete or function depending on version. A version specific SOAP client is built at CollabConnector.CUCM.axl and can be leveraged as a backup as needed, however no post call treatment is made so soap responses will need to be sterilized etc if used.

>>> from CollabConnector import CUCM

>>> cucm = CUCM.Connect("10.10.10.10", "admin", "P@ssw0rd")
>>> cucm.axl.getPhone(name="SEPAAAABBBBCCCC")
[{'name': 'SEP3C08F67A9618', 'description': 'Auto 1000', 'product': 'Cisco 7841', 'mod... }]

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

collabconnector-0.1.1730147757.tar.gz (3.0 MB view details)

Uploaded Source

Built Distribution

CollabConnector-0.1.1730147757-py3-none-any.whl (3.1 MB view details)

Uploaded Python 3

File details

Details for the file collabconnector-0.1.1730147757.tar.gz.

File metadata

File hashes

Hashes for collabconnector-0.1.1730147757.tar.gz
Algorithm Hash digest
SHA256 c30adc410b7fe3bc3c4173e7491a3295737398d03c0fffa2a06ff9ffa81c98c3
MD5 9940f7eaeb7d0355e68764d902c81676
BLAKE2b-256 ec41b942755578d5109b33ce2ba15e2cbd26461f96fc61c3918f9e5a70f06a15

See more details on using hashes here.

File details

Details for the file CollabConnector-0.1.1730147757-py3-none-any.whl.

File metadata

File hashes

Hashes for CollabConnector-0.1.1730147757-py3-none-any.whl
Algorithm Hash digest
SHA256 87658d5d3000df6c4e3e11cf99d009d3b69698878b46e76695a87f8f9f01e1bb
MD5 6266145daafb39ce4ebd5092a0362b4b
BLAKE2b-256 f5c93b3b5aad973bc9fa79b2a19e8905cedbd7394fa0b5a52c52a472298c6cb7

See more details on using hashes here.

Supported by

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