cpauto package

Subpackages

• cpauto.core package
  • Submodules
  • cpauto.core.exceptions module
  • cpauto.core.misc module
  • cpauto.core.sessions module
  • Module contents
• cpauto.objects package
  • Submodules
  • cpauto.objects.access module
  • cpauto.objects.application module
  • cpauto.objects.group module
  • cpauto.objects.host module
  • cpauto.objects.network module
  • cpauto.objects.policy module
  • cpauto.objects.service module
  • cpauto.objects.simplegateway module
  • Module contents

Module contents

cpauto is a client library, written in Python, for the web APIs exposed via Check Point R80 management server software. The Check Point R80 management APIs provide automation and integration capabilities that were not available in previous versions of Check Point management server software.

https://sc1.checkpoint.com/documents/R80/APIs/#introduction

usage:

>>> import cpauto
>>> cc = cpauto.CoreClient('admin', 'vpn123', '10.6.9.81')
>>> r = cc.login()
>>> r.status_code
200
>>> r.json()
{u'last-login-was-at': {u'posix': 1478636363481, u'iso-8601': u'2016-11-08T15:19-0500'}, u'uid': ...}
>>> n = cpauto.Network(cc)
>>> r = n.add('net_mgmt', { 'subnet': '10.6.9.0', 'subnet-mask': '255.255.255.0' })
>>> r.status_code
200
>>> r.json()
{u'domain': {u'domain-type': u'domain', u'name': u'SMC User', u'uid': u'41e821a0-3720-11e3-aa6e-0800200c9fde'}, ...}
>>> r = cc.publish()
>>> r.status_code
200
>>> r.json()
{u'task-id': u'01234567-89ab-cdef-8b0a-92e9635a47d3'}
>>> r = cc.logout()
>>> r.status_code
200
>>> r.json()
{u'message': u'OK'}

copyright:

3. 2016 by Dana James Traversie and Check Point Software Technologies, Ltd.

license:

Apache 2.0, see LICENSE for more details.