# FireCLI
FireCLI is a command line interface to Firepower Management Center
that can perform a variety of tasks ranging from report generation
to import/export of configuration elements like object overrides and s2svpns
## Requirements
FireCLI requires Python version >= 3.7 and FMC version >= 6.6.0
## Installation
Build and install FireCLI
```shell
tox -e build
pip install dist/firecli-1.1.0.tar.gz
```
Generate documentation
```shell
tox -e docs
```
## Usage
```shell
Usage: firecli.py [OPTIONS] COMMAND [ARGS]...
FireCLI is a command line interface to Firepower Management Center that
automates a variety of tasks
Options:
--version Show the version and exit.
--hostname TEXT Hostname of firepower management center
--domain TEXT Management domain of FMC
--username TEXT Username of fmc api user. It is recommended to create a
dedicated api user
--password TEXT Password of fmc api user
--timeout INTEGER Api request timeout in seconds
--dry-run Display changes without performing an action
--debug Enable debug loglevel
--trace Enable trace loglevel (Debug + FireREST api calls)
--no-proxy Ignore system proxy settings
-h, --help Show this message and exit.
Commands:
accesspolicy Accesspolicy management
cache Local cache management
compliance Security compliance checks
log Application log analysis
object Object management
s2svpn Site2Site vpn management
sync Configuration synchronisation
```
## Documentation
See `docs/` for additional project documentation.
## Author Information
Oliver Kaiser (oliver.kaiser@outlook.com)
Raw data
{
"_id": null,
"home_page": "https://git.ong.at/cisco/firecli.git",
"name": "firecli",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "cisco firepower fmc ftd fpr api rest python api cli",
"author": "Oliver Kaiser",
"author_email": "oliver.kaiser@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/c1/63/94e1af807024fe5d6b317d4bfdcdc30de31b2402b6bdad58b97ab5fdb11f/firecli-1.1.3.tar.gz",
"platform": null,
"description": "# FireCLI\n\nFireCLI is a command line interface to Firepower Management Center\nthat can perform a variety of tasks ranging from report generation\nto import/export of configuration elements like object overrides and s2svpns\n\n## Requirements\n\nFireCLI requires Python version >= 3.7 and FMC version >= 6.6.0\n\n## Installation\n\nBuild and install FireCLI\n\n```shell\ntox -e build\npip install dist/firecli-1.1.0.tar.gz\n```\n\nGenerate documentation\n\n```shell\ntox -e docs\n```\n\n## Usage\n\n```shell\nUsage: firecli.py [OPTIONS] COMMAND [ARGS]...\n\n FireCLI is a command line interface to Firepower Management Center that\n automates a variety of tasks\n\nOptions:\n --version Show the version and exit.\n --hostname TEXT Hostname of firepower management center\n --domain TEXT Management domain of FMC\n --username TEXT Username of fmc api user. It is recommended to create a\n dedicated api user\n\n --password TEXT Password of fmc api user\n --timeout INTEGER Api request timeout in seconds\n --dry-run Display changes without performing an action\n --debug Enable debug loglevel\n --trace Enable trace loglevel (Debug + FireREST api calls)\n --no-proxy Ignore system proxy settings\n -h, --help Show this message and exit.\n\nCommands:\n accesspolicy Accesspolicy management\n cache Local cache management\n compliance Security compliance checks\n log Application log analysis\n object Object management\n s2svpn Site2Site vpn management\n sync Configuration synchronisation\n```\n\n## Documentation\n\nSee `docs/` for additional project documentation.\n\n## Author Information\n\nOliver Kaiser (oliver.kaiser@outlook.com)\n",
"bugtrack_url": null,
"license": "",
"summary": "FireCLI is a command line interface to Firepower Management Center",
"version": "1.1.3",
"split_keywords": [
"cisco",
"firepower",
"fmc",
"ftd",
"fpr",
"api",
"rest",
"python",
"api",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c16394e1af807024fe5d6b317d4bfdcdc30de31b2402b6bdad58b97ab5fdb11f",
"md5": "e1c452a6ad91db3bf609a17b86abad8c",
"sha256": "d28fd5756c2f1daa6c3dc6b79847c02c7c9ad9b815f8f9d7e127eac6ca0f2302"
},
"downloads": -1,
"filename": "firecli-1.1.3.tar.gz",
"has_sig": false,
"md5_digest": "e1c452a6ad91db3bf609a17b86abad8c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 41754,
"upload_time": "2023-04-11T19:12:38",
"upload_time_iso_8601": "2023-04-11T19:12:38.422722Z",
"url": "https://files.pythonhosted.org/packages/c1/63/94e1af807024fe5d6b317d4bfdcdc30de31b2402b6bdad58b97ab5fdb11f/firecli-1.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-11 19:12:38",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "firecli"
}
JSON