Skip to main content

Interacting with Cisco FTD devices via the FDM REST API in Python

Project description

Firepyer

Firepyer provides a way of interacting with Cisco Firepower devices via their REST APIs in Python. Currently FTD devices using FDM (not FMC) are supported. The intended usage is to replace some of the tedious clicking tasks from the GUI, perform actions on a large number of devices or execute bulk imports of objects, rules etc.

The following versions have been used in development (others should work but YMMV):

  • Python 3.9 (3.6+ should be fine)
  • FTD 6.6.1-91

Please see the brief instructions below on installing and using Firepyer and visit the documentation for a more comprehensive guide and examples.

Installation

The latest release is available to download from PyPI, simply using pip install firepyer.

Alternatively, as this project is still in early development, the best place to get the most recent features is directly from the source GitHub repo.

Usage

All functionailty for interacting with an FTD device is contained within the Fdm class and it’s methods. Authentication is taken care of transparently when calling a method, so this doesn’t need to be done explicilty.

Import the Fdm class and instantiate an object, passing in your FTD hostname/IP, username and password:

>>> from firepyer import Fdm
>>> fdm = Fdm(host='192.168.45.45', username='admin', password='Admin123')

Then call any of the available methods to run against your FTD:

>>> fdm.get_hostname()
     'firepyer2120'

>>> fdm.get_net_objects('any-ipv4')
     {'description': None,
      'dnsResolution': None,
      'id': '00f7b297-4d44-11eb-9e04-13721b05d633',
      'isSystemDefined': True,
      'links': {'self': 'https://192.168.45.45/api/fdm/latest/object/networks/00f7b297-4d44-11eb-9e04-13721b05d633'},
      'name': 'any-ipv4',
      'subType': 'NETWORK',
      'type': 'networkobject',
      'value': '0.0.0.0/0',
      'version': 'kxd2dzxm2gtwn'}

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

firepyer-0.0.2.tar.gz (13.5 kB view details)

Uploaded Source

Built Distribution

firepyer-0.0.2-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

Details for the file firepyer-0.0.2.tar.gz.

File metadata

  • Download URL: firepyer-0.0.2.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for firepyer-0.0.2.tar.gz
Algorithm Hash digest
SHA256 8353749b51102702a7c83085319886857f0b8dffb634eae5c8aa6a0a28585b57
MD5 d69e23b4e42c43b2cda25fdfb61d6f19
BLAKE2b-256 0622d20975816745f5120c620615ae9313ed38081d6c449991e3bcc74323706e

See more details on using hashes here.

File details

Details for the file firepyer-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: firepyer-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 16.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for firepyer-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cf61cd98c89c272a4474a6e9a6599c1616f19fa418fa10dc7fc006c7b5b1e00d
MD5 8f607841812cf25cdc135bd8eb6cac46
BLAKE2b-256 c1b9ad15505a9b4ff8c72e54184d7bdea09969fff766936840facf513a375cb6

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