Skip to main content

Python based API to Forcepoint NGFW Management Center

Project description

Python version

smc-python

Python based library to provide the ability to interact with the Forcepoint NGFW Management Center API. Provides automation capabilities for any environment that interact with the SMC remotely.

Some of the functionality you get with the SMC Python API:

  • Create any engine types; single firewall, cluster firewalls, ips engines, layer 2 firewalls, master engine and virtual engines.

  • Engine operations such as enabling/disabling AV, GTI, default NAT, Contact Addresses, etc

  • Interface configurations

  • Routing configurations (OSPF, BGP, Static, Antispoofing)

  • Engine level commands such as rebooting, going offline, policy push, enable/disable SSH, etc.

  • Create and modify all network element objects such as Host, Network, Address Ranges, Domain Names, etc.

  • Policy control (create rules, delete rules) for layer 3 firewall policies

  • VPN Policy control and creation

  • Management / Log Server settings configuration

  • Admin User creation and modification

  • System level controls; update system packages, update engines, global blacklisting, etc

  • Tasks

  • Search operations for any object type by name, href and by filter

  • Collections interface to view all objects by type

Requirements

Python >= 2.7 or >= 3.5

Requests >= 2.31.0 websocket-client >= 1.5.0

Security Management Center version >= 6.0

Getting Started

Installing package

From git:

pip install git+https://github.com/Forcepoint/fp-NGFW-SMC-python.git

Or after cloning:

python setup.py install

Testing

Included are a variety of test example scripts that leverage the API to do various tasks in smc/examples directory

Basics

Before any commands are run, you must obtain a login session. Once commands are complete, call session.logout() to remove the active session. To obtain the api_key, log in to the Forcepoint NGFW Management Center and create an API client with the proper privileges.

from smc import session

session.login(url='http://1.1.1.1:8082', api_key='xxxxxxxxxxxxx')
....do stuff....
session.logout()

Or log in to a specific Admin Domain and use a specific version of the API:

session.login(url='http://1.1.1.1:8082', api_key='xxxxxxxxxxxxx',
              domain=mydomain, api_version=6.2)
....do stuff....
session.logout()

Once a valid session is obtained, it will be re-used for each operation for the duration of the sessions validity, or until the program is exited.

Extensions

Extensions are available to smc-python that provide additional functionality besides what is provided in the base library. Extensions are kept separate as they may require additional package requirements and simplify packaging.

Available extensions:

  • smc-python-monitoring: Monitoring for SMC connections, blacklists, users, VPNs, alerts, etc. In addition this package provides the ability to ‘subscribe’ to administrative event modifications.

Extensions are found in the base smc-python repository as namespace packages and each is housed in it’s own sub-directory of this base package.

Pull Requests

Pull requests are accepted and welcome but they could not be merged as are. Indeed, we are using internal repository in order to validate and integrate these changes. But they could be released later on following our road map.

Commit Message Guidelines

We follow a consistent commit message format to maintain a clear and organized version history. This helps in understanding the purpose of each commit and tracking changes effectively.

Each and every commit message to the repository must follow this format.

<jira_key>: <title>
<body>
  • Jira Key: Jira Ticket ID or Key that begins with “SMC-“.

  • Title: Usually the title of the Jira ticket, or a concise version of the same.

  • Body: Additional details about the commit. Use this section to provide more context and information if necessary.

Example:

SMC-51100: CI Validation
- Check that commit starts with "SMC-"
- Update Jira tickets automatically

Documentation

View Documentation on Read The Docs

Release History

Release notes on GitHub

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

fp-NGFW-SMC-python-1.0.26.tar.gz (433.5 kB view details)

Uploaded Source

Built Distribution

fp_NGFW_SMC_python-1.0.26-py2.py3-none-any.whl (585.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file fp-NGFW-SMC-python-1.0.26.tar.gz.

File metadata

  • Download URL: fp-NGFW-SMC-python-1.0.26.tar.gz
  • Upload date:
  • Size: 433.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.10

File hashes

Hashes for fp-NGFW-SMC-python-1.0.26.tar.gz
Algorithm Hash digest
SHA256 52dacf2034d5d8930d45a6de84a225d5bf472f0e19549a2efa99bfcabd9d06b7
MD5 222ae2d795c877aa0980deccd6b07d56
BLAKE2b-256 8fd5678645c32bf0fb2d2c83089be86290cdb76ac18025f44af6d87a02442a05

See more details on using hashes here.

File details

Details for the file fp_NGFW_SMC_python-1.0.26-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for fp_NGFW_SMC_python-1.0.26-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 909899e621d85ffd3af0f76cc79ae92d90ae007ff3555500c69e2a3a63ac75c2
MD5 f6a5807249a719db3b19ae065e6e7954
BLAKE2b-256 cf080dc614b3d947ccd8a75416f575e52ca69e7f69621ecf1ef178bd0b61de2f

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