smc-python: A Python repository from BinhLPhan

smc-python

Python based library to provide basic functions to interact with the Stonesoft Management Center API.

Currently it provides basic functionality to manipulate object data stored on the SMC. It is working towards having a command line front end to ease interaction from automated tools such as Chef/Puppet or do automated deployments into virtual and cloud environments.

Getting Started

Installing package

use pip

pip git+https://github.com/gabstopper/smc-python.git

download the latest tarball: smc-python, unzip and run

python setup.py install

Testing

Included is a test.py script that has several examples for manipulating data using the SMC api.

Basics

Before any commands are run, you must obtain a login session. Once commands are complete, call smc.logout() to remove the active session.

import smc

smc.login('http://1.1.1.1:8082', 'EiGpKD4QxlLJ25dbBEp20001')
....do stuff....
smc.logout()

Once a valid session is obtained, it will be re-used for each operation performed.

Creating/removing a host record

smc.create.host('ami', '1.1.1.2')
smc.remove.element('ami')		#remove host named 'ami'
smc.remove.element('agroup')	#remove group
smc.remove.element('myfw')		#remove firewall instance

Create group and add members

smc.create.group('group_with_no_members')
smc.create.host('ami', '1.1.1.1')
smc.create.host('ami2', '2.2.2.2', comment='this is my comment')	#with optional comment
smc.create.group('anewgroup', ['ami','ami2']) #group with member list

Create networks and router objects

smc.create.network('hostbitsnotinnetwork', '1.2.3.0/255.255.252.0')
smc.create.network('goodnetwork', '1.2.0.0/255.255.252.0')
smc.create.network('networkwithcidr', '1.3.0.0/24', 'created by api tool')
smc.create.router('myrouter', '7.7.7.7')

Create / remove a single_fw instance

smc.create.single_fw('myfw', '172.18.1.5', '172.18.1.0/24', dns='5.5.5.5', fw_license=True)
smc.remove.element('myfw')					#without filter
smc.remove.element('myfw', 'single_fw') 	#with filter

Example of using a search filter

smc.get.element('myobject')  		#Search for element named 'myobject', match on 'name' field (looks at all object types)
smc.get.element('myobject', 'host')	#Search for host element named 'myobject'; match on 'name' field
smc.get.element('myobject', 'host', False)	#Search for host element/s with 'myobject' somewhere in the object definition

BinhLPhan/smc-python