Metadata-Version: 1.1
Name: fp-NGFW-SMC-python
Version: 0.7.0b16
Summary: Python based API to Forcepoint NGFW Management Center
Home-page: http://github.com/Forcepoint/smc-python
Author: Forcepoint
Author-email: PSIRT@forcepoint.com
License: Apache 2.0
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
        
        Python 3.5, 3.6
        
        Requests >= 2.12.0
        
        Security Management Center version 6.0, 6.1, 6.1.1, 6.1.2, 6.2, 6.2.1, 6.3.x, 6.4.x, 6.5.x, 6.6.x
        
        Getting Started
        ---------------
        
        Installing package
        
        From Pypi:
        
        ``pip install fp-NGFW-SMC-python``
        
        Or after cloning from GitHub:
        
        ``python setup.py install``
        
        Testing
        -------
        
        Included are a variety of test example scripts that leverage the API to
        do various tasks in /examples
        
        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.
        
        .. code:: python
        
            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:
        
        .. code:: python
        
            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 <https://badge.fury.io/py/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.
        
        .. |Python version| image:: https://img.shields.io/badge/python-2.7%20%7C%203.5%20%7C%203.6-blue
            :target: https://pypi.python.org/pypi/fp-NGFW-SMC-python/
        
        
        Release History
        ===============
        
        0.7.0
        -----
        
        - Support SMC 6.6
        - Add validate flag to all rule creation parameters and update parameters. Validate=False will circumvent validating
          the inspection policy during rule creation, making add operations faster when bulk loading rules
        - SwitchPhysicalInterface implemented
        - VPNProfile implemented
        - VPN Mobile Gateways for Policy VPN
        - Set default retries parameter on ActiveDirectoryServer to 3 retries
        - Configurable gateway profile for ExternalGateway
        - Geolocation objects (SMC 6.6)
        - Update of docs for smc-python-monitoring
        - SNMPAgent modified to accommodate SMC >= 6.5.1 requiring snmp_user_name field during creation
        - Support ClientProtectionCA for compatibility with all >= 6.5.x versions
         
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
