nmstate
Project description
We are nmstate!
A declarative network manager API for hosts.
What is it?
NMState is a library with an accompanying command line tool that manages host networking settings in a declarative manner. The networking state is described by a pre-defined schema. Reporting of current state and changes to it (desired state) both conform to the schema.
NMState is aimed to satisfy enterprise needs to manage host networking through a northbound declarative API and multi provider support on the southbound. NetworkManager acts as the main (and currently the only) provider supported.
Development Environment
Install:
pip install tox pbr
Run Unit Tests:
tox
Runtime Environment
Install (from sources) system-wide:
sudo pip install --upgrade .
Install just for the local user:
pip install --user --upgrade .
Make sure that ~/.local/bin
is in your PATH when installing as a local user.
The export
command can be used to add it for the current session:
export PATH="${HOME}/.local/bin:${PATH}"
Basic Operations
Show current state:
nmstatectl show
Change to desired state:
nmstatectl set desired-state.json
Edit current state of eth3 in a text editor:
nmstatectl edit --only eth3
nmstatectl
will also read from stdin when no file is specified:
nmstatectl set < desired-state.json
Desired/Current state example:
{
"interfaces": [
{
"description": "Production Network",
"ethernet": {
"auto-negotiation": true,
"duplex": "full",
"speed": 1000
},
"ipv4": {
"address": [
{
"ip": "192.0.2.142",
"prefix-length": 24
}
],
"enabled": true
},
"mtu": 1500,
"name": "eth3",
"state": "up",
"type": "ethernet"
}
]
}
The state is also supported as YAML, to get the current state in YAML format:
nmstatectl show --yaml
The set
command accepts both YAML and JSON.
Supported Interfaces:
- bond
- dummy
- ethernet
- ovs-bridge
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
Built Distribution
Hashes for nmstate-0.0.1.dev187-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8778c929fb83c9331dda268a0f960099e0e71238bff1eab277b69e5c7226a801 |
|
MD5 | db3956cfbe50bb0753c75c355e939353 |
|
BLAKE2b-256 | 52d95818c009d24faf7f58dd46fd8cb8b9dc231325f569ece930b8f218587758 |