An API Client to use FMC RESTful API.
Project description
FMCAPIClient
An API Client for the Cisco Firepower Management Center to be able to easily use the API in a more standard way.
How to install
$ pip install FMCAPIClient
Usage
The argument 'method' must be specify every time.
Note: The class will validate the token, and refresh the token when needed as this validation method is called in between each method call.
NOTE:
Default arguments and attributes
import FMCAPIClient
client = FMCAPIClient.Client(verify=False, warnings=False, api_version='v1')
client.get(url=None, method='', data=None, auth = None)
# client.headers
# client.base_url
# client.token
# client.auth
# client.token_expire
# client.token_refresh
# client.token_refresh_count
# client.domain_uuid
# client.server
Authentication
import FMCAPIClient
client = FMCAPIClient.Client()
client.connect(url='https://FMC-server.local', username='admin', password='Admin123')
client.disconnect()
Refresh Token
import FMCAPIClient
client = FMCAPIClient.Client()
client.connect(url='https://FMC-server.local', username='admin', password='Admin123')
client.refresh_token_func()
client.disconnect()
The first query
import FMCAPIClient
import json
client = FMCAPIClient.Client()
client.connect(url='https://FMC-server.local', username='admin', password='Admin123')
response = client.get(method='/devicegroups/devicegrouprecords')
print(json.dumps(response.json(), indent=4))
client.disconnect()
Getting detailed information
import FMCAPIClient
import json
client = FMCAPIClient.Client()
client.connect(url='https://FMC-server.local', username='admin', password='Admin123')
response = client.get(method=f'/devicegroups/devicegrouprecords', expanded=True)
print(json.dumps(response.json(), indent=4))
client.disconnect()
Filtering
import FMCAPIClient
import json
client = FMCAPIClient.Client()
client.connect(url='https://FMC-server.local', username='admin', password='Admin123')
group_id = '81fe2042-9ad2-11ea-be78-cde812596ba2'
response = client.get(method=f'/devicegroups/devicegrouprecords/{group_id}')
print(json.dumps(response.json(), indent=4))
client.disconnect()
Paging
import FMCAPIClient
import json
client = FMCAPIClient.Client()
client.connect(url='https://FMC-server.local', username='admin', password='Admin123')
response = client.get(method=f'/devicegroups/devicegrouprecords', offset=0, limit=1)
print(json.dumps(response.json(), indent=4))
client.disconnect()
Creating
import FMCAPIClient
import json
client = FMCAPIClient.Client()
client.connect(url='https://FMC-server.local', username='admin', password='Admin123')
response = client.post(method='/devicegroups/devicegrouprecords', data={'name': 'test_group',
'type': 'DeviceGroup'})
print(json.dumps(response.json(), indent=4))
client.disconnect()
Updating
import FMCAPIClient
import json
client = FMCAPIClient.Client()
client.connect(url='https://FMC-server.local', username='admin', password='Admin123')
group_id = '1234567890abc'
response = client.put(method=f'/devicegroups/devicegrouprecords/{group_id}', data={'id': group_id,
'name': 'test_group_updated',
'type': 'DeviceGroup'})
print(json.dumps(response.json(), indent=4))
client.disconnect()
Deleting
import FMCAPIClient
import json
client = FMCAPIClient.Client()
client.connect(url='https://FMC-server.local', username='admin', password='Admin123')
group_id = '1234567890abc'
response = client.delete(method=f'/devicegroups/devicegrouprecords/{group_id}')
print(json.dumps(response.json(), indent=4))
client.disconnect()
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
FMCAPIClient-0.0.1.tar.gz
(6.0 kB
view hashes)
Built Distribution
Close
Hashes for FMCAPIClient-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7355e303c0b293e8f8416997905b3571239174dc952f2439b49d099269607b9e |
|
MD5 | 8a020b6e8612048175d03a0bfe775775 |
|
BLAKE2b-256 | c31ad9ddfd643ed0b84119af3b84c2617ae7c59f5f2d98a2f442f69f0c10f05b |