Skip to main content

PyPI Supported python versions

Caveats

As napalm-ros uses API, several caveats exist.

  • API is not versioned so things may break when routeros is upgraded.
  • RouterOS has no native, non-reboot commit/rollback and safe mode is not exposed via the API. Rollback is emulated with a device-side scheduler that restores a backup, so a rollback (or an expired commit-confirm) reverts by rebooting. See Configuration management.

Configuration management

Configuration management is supported on RouterOS 7.x and is implemented entirely over the binary API (via librouteros), so it needs no SSH access.

  • get_config / compare_config read the running configuration with /export.
  • load_merge_candidate stages a .rsc script that is applied with /import. load_replace_candidate stages a full configuration.
  • commit_config applies the candidate. Before a plain commit a backup is taken so rollback can restore it (by rebooting). commit_config(revert_in=<seconds>) arms a device-side scheduler that restores that backup unless confirm_commit is called in time (has_pending_commit reports whether one is armed). Because the timer lives on the device it survives a lost session or a lock-out.
  • A replace (load_replace_candidate + commit_config) uses /system reset-configuration run-after-reset, which wipes the configuration and reboots into the candidate. It is destructive, has no automatic rollback, and the candidate must be a complete, self-consistent configuration that restores management connectivity. Commit-confirm (revert_in) is not available with a replace.

RouterOS configuration is imperative (an /export is a list of add/set actions, not declarative state) and ordering matters in some paths (e.g. /ip firewall filter) but not others (e.g. /ip address). compare_config is therefore a textual diff for review, not an executable patch.

Implemented getters

  • get_arp_table
  • get_interfaces_counters
  • get_environment
  • get_facts
  • get_interfaces
  • get_interfaces_ip
  • get_ntp_servers
  • get_snmp_information
  • get_users
  • get_ipv6_neighbors_table
  • is_alive
  • ping
  • get_lldp_neighbors
  • get_lldp_neighbors_detail
  • get_network_instances
  • get_mac_address_table
  • get_bgp_neighbors
  • get_bgp_neighbors_detail
  • get_config
  • get_vlans

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

napalm_ros-1.3.1.tar.gz (11.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

napalm_ros-1.3.1-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

Details for the file napalm_ros-1.3.1.tar.gz.

File metadata

  • Download URL: napalm_ros-1.3.1.tar.gz
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.3 CPython/3.12.3 Linux/6.17.0-1022-azure

File hashes

Hashes for napalm_ros-1.3.1.tar.gz
Algorithm Hash digest
SHA256 4bb403ab8b76b4851e8e91fa02cb00be11aa9d3d90b92b1991ff6555743dca2c
MD5 84272f9957820867c5f1ae33c3b4fbc1
BLAKE2b-256 2ece050cdf693de1fd471cd8f6196349cd61b162b5116a15a917822afed6cad5

See more details on using hashes here.

File details

Details for the file napalm_ros-1.3.1-py3-none-any.whl.

File metadata

  • Download URL: napalm_ros-1.3.1-py3-none-any.whl
  • Upload date:
  • Size: 12.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.3 CPython/3.12.3 Linux/6.17.0-1022-azure

File hashes

Hashes for napalm_ros-1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f2f0a549fe620b5da8e3b9cba2f960e883d1bf7547053d4ff55f676632c5fdc7
MD5 3b64d75cf0e46a5f8d10ecd6c75d7b4b
BLAKE2b-256 890f5111275c023c5083a65ac2783a6ad42f3bdbdaddd9f4165363c61afa87cb

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.3.1 This release

2 files

1.2.6

2 files

1.2.5

2 files

1.2.4

2 files

1.2.3

2 files

1.2.2

1 file

1.2.1

1 file

1.2.0

1 file

1.1.0

1 file

1.0.1

1 file

1.0.0

1 file

0.8.0

1 file

0.7.0

1 file

0.6.2

1 file

0.6.1

1 file

0.6.0

1 file

0.5.1

1 file

0.5.0

1 file

0.4.2

1 file

0.4.1

1 file

0.4.0

1 file

0.3.5

1 file

0.3.4

1 file

0.3.3

1 file

0.3.2

1 file

0.3.1

1 file

0.3.0

1 file

0.2.2

1 file

0.2.1

1 file

0.2.0

1 file

0.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page