besapi

besapi is a Python library designed to interact with the BigFix REST API.

Latest version: 4.1.2 registry icon
Maintenance score
100
Safety score
100
Popularity score
2
Check your open source dependency risks. Get immediate insight about security, stability and licensing risks.
Security
  Vulnerabilities
Version Suggest Low Medium High Critical
4.1.2 0 0 0 0 0
4.0.2 0 0 0 0 0
4.0.1 0 0 0 0 0
3.9.8 0 0 0 0 0
3.9.7 0 0 0 0 0
3.9.6 0 0 0 0 0
3.9.5 0 0 0 0 0
3.9.4 0 0 0 0 0
3.9.1 0 0 0 0 0
3.8.3 0 0 0 0 0
3.8.2 0 0 0 0 0
3.8.1 0 0 0 0 0
3.7.8 0 0 0 0 0
3.7.7 0 0 0 0 0
3.7.6 0 0 0 0 0
3.7.4 0 0 0 0 0
3.7.2 0 0 0 0 0
3.7.1 0 0 0 0 0
3.5.1 0 0 0 0 0
3.4.2 0 0 0 0 0
3.4.1 0 0 0 0 0
3.3.3 0 0 0 0 0
3.3.2 0 0 0 0 0
3.2.6 0 0 0 0 0
3.2.4 0 0 0 0 0
3.2.2 0 0 0 0 0
3.2.1 0 0 0 0 0
3.1.9 0 0 0 0 0
3.1.8 0 0 0 0 0
3.1.7 0 0 0 0 0
3.1.6 0 0 0 0 0
3.1.5 0 0 0 0 0
3.1.4 0 0 0 0 0
3.1.3 0 0 0 0 0
3.1.1 0 0 0 0 0
3.0.2 0 0 0 0 0
3.0.1 0 0 0 0 0
2.1.1 0 0 0 0 0
2.0.1 0 0 0 0 0
1.1.3 0 0 0 0 0
1.1.2 0 0 0 0 0
1.1.1 0 0 0 0 0
1.0.7 0 0 0 0 0
1.0.6 0 0 0 0 0
1.0.5 0 0 0 0 0
1.0.4 0 0 0 0 0
1.0.3 0 0 0 0 0
1.0.2 0 0 0 0 0
1.0.1 0 0 0 0 0

Stability
Latest release:

4.1.2 - This version is safe to use because it has no known security vulnerabilities at this time. Find out if your coding project uses this component and get notified of any reported security vulnerabilities with Meterian-X Open Source Security Platform

Licensing

Maintain your licence declarations and avoid unwanted licences to protect your IP the way you intended.

MIT   -   MIT License

Not a wildcard

Not proprietary

OSI Compliant



besapi

besapi is a Python library designed to interact with the BigFix REST API.

Installation:

pip install besapi

Usage:

import besapi
b = besapi.besapi.BESConnection('my_username', 'my_password', 'https://rootserver.domain.org:52311')
rr = b.get('sites')

# rr.request contains the original request object
# rr.text contains the raw request.text data returned by the server
# rr.besxml contains the XML string converted from the request.text
# rr.besobj contains the requested lxml.objectify.ObjectifiedElement

>>>print rr
<BESAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="BESAPI.xsd">
<ExternalSite Resource="http://rootserver.domain.org:52311/api/site/external/BES%20Support">
<Name>BES Support</Name>
</ExternalSite>
<!---...--->
<CustomSite Resource="http://rootserver.domain.org:52311/api/site/custom/Org">
<Name>Org</Name>
</CustomSite>
<CustomSite Resource="http://rootserver.domain.org:52311/api/site/custom/Org%2fMac">
<Name>Org/Mac</Name>
</CustomSite>
<CustomSite Resource="http://rootserver.domain.org:52311/api/site/custom/Org%2fWindows">
<Name>Org/Windows</Name>
</CustomSite>
<CustomSite Resource="http://rootserver.domain.org:52311/api/site/custom/ContentDev">
<Name>ContentDev</Name>
</CustomSite>
<OperatorSite Resource="http://rootserver.domain.org:52311/api/site/operator/mah60">
<Name>mah60</Name>
</OperatorSite>
<ActionSite Resource="http://rootserver.domain.org:52311/api/site/master">
<Name>ActionSite</Name>
</ActionSite>
</BESAPI>
>>>rr.besobj.attrib
{'{http://www.w3.org/2001/XMLSchema-instance}noNamespaceSchemaLocation': 'BESAPI.xsd'}

>>>rr.besobj.ActionSite.attrib
{'Resource': 'http://rootserver.domain.org:52311/api/site/master'}

>>>rr.besobj.ActionSite.attrib['Resource']
'http://rootserver.domain.org:52311/api/site/master'

>>>rr.besobj.ActionSite.Name
'ActionSite'

>>>rr.besobj.OperatorSite.Name
'mah60'

>>>for cSite in rr.besobj.CustomSite:
...     print cSite.Name
Org
Org/Mac
Org/Windows
ContentDev
...

>>>rr = b.get('task/operator/mah60/823975')
>>>with open('/Users/Shared/Test.bes", "wb") as file:
...     file.write(rr.text)

>>>b.delete('task/operator/mah60/823975')

>>> file = open('/Users/Shared/Test.bes')
>>> b.post('tasks/operator/mah60', file)
>>> b.put('task/operator/mah60/823975', file)

Command-Line Interface

$ python bescli.py
OR
>>> import bescli
>>> bescli.main()

BigFix> login
User [mah60]: mah60
Root Server (ex. https://server.institution.edu:52311): https://my.company.org:52311
Password:
Login Successful!
BigFix> get help
...
BigFix> get sites
...
BigFix> get sites.OperatorSite.Name
mah60
BigFix> get help/fixlets
GET:
/api/fixlets/{site}
POST:
/api/fixlets/{site}
BigFix> get fixlets/operator/mah60
...

BigFix REST API Documentation

Requirements

  • Python 3.6 or later
    • version 1.1.3 of besapi was the last to have partial python2 support
  • lxml
  • requests
  • cmd2

Examples using BESAPI

Pyinstaller

  • pyinstaller --clean --collect-all besapi --onefile .\src\bescli\bescli.py
  • Note: using UPX to compress the binary only saves 2MB out of 16MB on Windows

Related Items

LICENSE

  • MIT License