Releases: timeforplanb123/nornir_cli
Releases · timeforplanb123/nornir_cli
v1.3.0
What's Changed
updates
by @timeforplanb123 in #8:- now the nornir_cli commands (
init
,filter
, Nornir plugin commands) accept any arguments as json strings. Combined withjq
,jc
utilities, this feature can be very useful in scripts and automation pipelines - some Nornir plugins accept any arguments only as
**kwargs
. Now such arguments can be passed as json strings
- now the nornir_cli commands (
update_error_messages
by @timeforplanb123 in #9:- added new syntax to
init
,filter
and Nornir plugin error messages
- added new syntax to
update_docs
by @timeforplanb123 in #10:- examples and a description of the new json string feature have been added to the documentation
add_nornir_routeros_plugin
by @timeforplanb123 in #11:- starting from new
nornir_cli
version1.3.0
, you can pass any additional arguments as a json string to Nornir plugin commands. This feature allows you to run any Nornir plugin command without an unique set of parameters. So, now thenornir-routeros
plugin can be run like this -$ nornir_cli nornir-routeros init -c "/home/user/config.yaml" routeros_command '{"path":"/", "command":"ping", "address": "1.1.1.1", "count":4}'
- starting from new
v1.2.0
What's Changed
updates
by @timeforplanb123 in #7:click 8.1.7
nornir 3.4.1
nornir-netmiko 1.0.0
nornir-scrapli 2023.07.30
scrapli 2023.07.30
scrapli-netconf 2023.07.30
scrapli-community 2023.07.30
nornir-napalm 0.4.0
nornir-pyez 0.2.8
nornir-f5 0.6.1
nornir-http 0.1.3
nornir-netconf 2.0.0
- remove
nornir-routeros
plugin.nornir_cli
is not compatible withnornir-routeros
since0.3.0
version.nornir-routeros
has been removed fromnornir_cli 1.2.0
v1.1.1
- Update
netmiko
to latest4.1.2
- Fix
mkdocs.yml
:- fix
pymdownx.tabbed
extension - change
Home
tonornir_cli
innav
- fix
v1.1.0
- Update dependencies to latest versions, add new dev-dependencies:
- see
pyproject.toml
- see
- Add new custom
Nornir
runbook examples. This is an easy way to add yourNornir
runbooks to thenornir_cli
interface - Fix
short_help
and--help
command options parsers - Import reorder with
flake8-import-order
- Update docs:
- fix color palette toggle configuration (
mkdocs.yml
) - update docs according to the new dependencies versions
- fix color palette toggle configuration (
- Bump version to
1.1.0
v1.0.0
- updated python packages:
Click
to8.0.1
Nornir
to3.1.1
Nornir plugins
to latests versions
- updated
Runbook collections
:- updated
custom
decorator. Nowctx
object has become smarter. Now it isdataclass
object that supports the creation of any attributes, their modification and passing between you custom Nornir runbooks:ctx.nornir
- default object with Nornir object. It can be Nornir object onlyctx.result
- default object with Result object. Use it with newprint_result
,write_result
,write_results
commands
- updated
- updated
show_inventory
command:- fixed bug with incorrect defaults inventory output with
--count
option - added
all
parameter for--inventory
option - fixed confirmation for
hosts
/groups
list andhosts
/groups
/defaults
/all
inventory:- confirmation messages contain the requested parameters
- confirmation messages are not displayed if the number of items is 0 or 1
- fixed bug with incorrect defaults inventory output with
- added new
print_result
,write_result
,write_results
,write_file
commands:- work with built-in Nornir plugins and custom commands (Runbook collections)
- you can customize output and write it to file/files
- commands includes many useful options:
--attributes
(Result class attributes you want to print or write)--count
(limit results)--no_errors
(don't write errors to file/files)--diff_to_file
or--print_diff
(write diff to file or output diff)- etc.
- added new
change_credentials
command:- command changes credentials for
defaults
,hosts
/host
list,groups
/groups
list at any time - you can use environment variables
- command changes credentials for
- added new Nornir plugins:
nornir_routeros
nornir_paramiko
nornir_http
nornir_pyxl
nornir_netconf
- applied default value for click.confirm. To press enter is enough
- updated functions in
nornir_cli.common_plugins
:_json_loads
. Added parameter type check_doc_generator
. Added new rule for docstringscustom
. Now it returns newdataclass
objectmultiple_progress_bar
is now available fromnornir_cli.common.plugins
_info
isprint_stat
now
- updated documentation
v0.3.0
Add Nornir plugins and update netmiko to 3.4.0:
- add nornir-f5 and nornir-pyez Nornir plugins
- update dependencies (netmiko to 3.4.0 and click to 7.1.2 from ^7.1.2)
- fix default_value in click command options
- fix regex in _doc_generator
- fix the code responsible for collecting statistic
- fix documentation
v0.2.0
- Add Runbook collections functionality. This is very similar to Ansible Roles. More detailed - https://timeforplanb123.github.io/nornir_cli/workflow/#runbook-collections
- Add statistic function (see _info). Use this function in custom nornir runbooks
- Add
nornir_jinja2
plugin - Change the documentation and fix errors
v0.1.0
Initial release!