junos-ops 0.5__tar.gz

junos_ops-0.5/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

junos_ops-0.5/PKG-INFO

@@ -0,0 +1,344 @@
+Metadata-Version: 2.4
+Name: junos-ops
+Version: 0.5
+Summary: Automated JUNOS package management tool for Juniper Networks devices
+Author: AIKAWA Shigechika
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/shigechika/junos-ops
+Project-URL: Repository, https://github.com/shigechika/junos-ops
+Project-URL: Issues, https://github.com/shigechika/junos-ops/issues
+Keywords: juniper,junos,netconf,pyez,network,automation
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: junos-eznc
+Requires-Dist: looseversion
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Dynamic: license-file
+
+# junos-ops
+
+[日本語版 / Japanese](README.ja.md)
+
+A tool for automatic detection of Juniper device models and automated JUNOS package updates.
+
+## Features
+
+- Automatic device model detection and package mapping
+- Safe package copy via SCP with checksum verification
+- Pre-install package validation
+- Rollback support (model-specific handling for MX/EX/SRX)
+- Scheduled reboot
+- Parallel RSI (request support information) / SCF (show configuration | display set) collection
+- Dry-run mode (`--dry-run`) for pre-flight verification
+- Parallel execution via ThreadPoolExecutor
+- Configuration push with commit confirmed safety (parallel execution supported)
+- INI-based host and package management
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Configuration File (config.ini)](#configuration-file-configini)
+- [Usage](#usage)
+- [Workflow](#workflow)
+- [Examples](#examples)
+- [Supported Models](#supported-models)
+- [License](#license)
+
+## Installation
+
+```bash
+pip install git+https://github.com/shigechika/junos-ops.git
+```
+
+To upgrade to the latest version:
+
+```bash
+pip install git+https://github.com/shigechika/junos-ops.git --upgrade
+```
+
+### Development Setup
+
+```bash
+git clone https://github.com/shigechika/junos-ops.git
+cd junos-ops
+python3 -m venv .venv
+. .venv/bin/activate
+pip install -e ".[test]"
+```
+
+### Dependencies
+
+- [junos-eznc (PyEZ)](https://www.juniper.net/documentation/product/us/en/junos-pyez) — Juniper NETCONF automation library
+- [looseversion](https://pypi.org/project/looseversion/) — Version comparison
+
+### Installing pip3 (if not available)
+
+<details>
+<summary>OS-specific instructions</summary>
+
+- **Ubuntu/Debian**
+  ```bash
+  sudo apt install python3-pip
+  ```
+
+- **CentOS/RedHat**
+  ```bash
+  sudo dnf install python3-pip
+  ```
+
+- **macOS**
+  ```bash
+  brew install python3
+  ```
+
+</details>
+
+## Configuration File (config.ini)
+
+An INI-format configuration file that defines connection settings and model-to-package mappings.
+
+The configuration file is searched in the following order (`-c` / `--config` can override):
+
+1. `./config.ini` in the current directory
+2. `~/.config/junos-ops/config.ini` (XDG_CONFIG_HOME)
+
+### Logging Configuration (logging.ini)
+
+An optional `logging.ini` file can be used to customize log output (e.g., suppress verbose paramiko/ncclient messages). The file is searched in the same order as `config.ini`:
+
+1. `./logging.ini` in the current directory
+2. `~/.config/junos-ops/logging.ini` (XDG_CONFIG_HOME)
+
+If neither is found, the default logging configuration (INFO level to stdout) is used.
+
+### DEFAULT Section
+
+Defines global connection settings and model-to-package mappings shared by all hosts.
+
+```ini
+[DEFAULT]
+id = exadmin          # SSH username
+pw = password         # SSH password
+sshkey = id_ed25519   # SSH private key file
+port = 830            # NETCONF port
+hashalgo = md5        # Checksum algorithm
+rpath = /var/tmp      # Remote path
+# huge_tree = true    # Allow large XML responses
+# RSI_DIR = ./rsi/    # Output directory for RSI/SCF files
+# DISPLAY_STYLE = display set   # SCF output style (default: display set)
+# DISPLAY_STYLE =               # Empty for stanza format (show configuration only)
+
+# model.file = package filename
+# model.hash = checksum value
+EX2300-24T.file = junos-arm-32-18.4R3-S10.tgz
+EX2300-24T.hash = e233b31a0b9233bc4c56e89954839a8a
+```
+
+The model name must match the `model` field automatically retrieved from the device.
+
+### Host Sections
+
+Each section name becomes the hostname. DEFAULT values can be overridden per host.
+
+```ini
+[rt1.example.jp]             # Section name is used as the connection hostname
+[rt2.example.jp]
+host = 192.0.2.1             # Override connection target with IP address
+[sw1.example.jp]
+id = sw1                     # Override SSH username
+sshkey = sw1_rsa             # Override SSH key
+[sw2.example.jp]
+port = 10830                 # Override port
+[sw3.example.jp]
+EX4300-32F.file = jinstall-ex-4300-20.4R3.8-signed.tgz   # Different version for this host
+EX4300-32F.hash = 353a0dbd8ff6a088a593ec246f8de4f4
+```
+
+## Usage
+
+```
+junos-ops <subcommand> [options] [hostname ...]
+```
+
+### Subcommands
+
+| Subcommand | Description |
+|------------|-------------|
+| `upgrade` | Copy and install package |
+| `copy` | Copy package from local to remote |
+| `install` | Install a previously copied package |
+| `rollback` | Rollback to the previous version |
+| `version` | Show running/planning/pending versions and reboot schedule |
+| `reboot --at YYMMDDHHMM` | Schedule a reboot at the specified time |
+| `ls [-l]` | List files on the remote path |
+| `config -f FILE [--confirm N]` | Push a set command file to devices |
+| `rsi` | Collect RSI/SCF in parallel |
+| (none) | Show device facts |
+
+### Common Options
+
+| Option | Description |
+|--------|-------------|
+| `hostname` | Target hostname(s) (defaults to all hosts in config file) |
+| `-c`, `--config CONFIG` | Config file path (default: `config.ini` or `~/.config/junos-ops/config.ini`) |
+| `-n`, `--dry-run` | Test run (connect and display messages only, no execution) |
+| `-d`, `--debug` | Debug output |
+| `--force` | Force execution regardless of conditions |
+| `--workers N` | Parallel workers (default: 1 for upgrade, 20 for rsi) |
+| `--version` | Show program version |
+
+## Workflow
+
+### JUNOS Upgrade Workflow
+
+```
+1. Pre-flight check with dry-run
+   junos-ops upgrade -n hostname
+
+2. Copy and install with upgrade
+   junos-ops upgrade hostname
+
+3. Verify version
+   junos-ops version hostname
+
+4. Schedule reboot
+   junos-ops reboot --at 2506130500 hostname
+```
+
+Use `rollback` to revert to the previous version if problems occur.
+
+### Config Push Workflow
+
+```
+1. Preview changes with dry-run
+   junos-ops config -f commands.set -n hostname
+
+2. Apply changes
+   junos-ops config -f commands.set hostname
+```
+
+## Examples
+
+### upgrade (package update)
+
+```
+% junos-ops upgrade rt1.example.jp
+# rt1.example.jp
+remote: jinstall-ppc-18.4R3-S10-signed.tgz is not found.
+copy: system storage cleanup successful
+rt1.example.jp: cleaning filesystem ...
+rt1.example.jp: b'jinstall-ppc-18.4R3-S10-signed.tgz': 380102074 / 380102074 (100%)
+rt1.example.jp: checksum check passed.
+install: clear reboot schedule successful
+install: rescue config save successful
+rt1.example.jp: software validate package-result: 0
+```
+
+### version (version check)
+
+```
+% junos-ops version rt1.example.jp
+# rt1.example.jp
+  - hostname: rt1
+  - model: MX5-T
+  - running version: 18.4R3-S7.2
+  - planning version: 18.4R3-S10
+    - running='18.4R3-S7.2' < planning='18.4R3-S10'
+  - pending version: 18.4R3-S10
+    - running='18.4R3-S7.2' < pending='18.4R3-S10' : Please plan to reboot.
+  - reboot requested by exadmin at Sat Dec  4 05:00:00 2021
+```
+
+### rsi (parallel RSI/SCF collection)
+
+```
+% junos-ops rsi --workers 5 rt1.example.jp rt2.example.jp
+# rt1.example.jp
+  rt1.example.jp.SCF done
+  rt1.example.jp.RSI done
+# rt2.example.jp
+  rt2.example.jp.SCF done
+  rt2.example.jp.RSI done
+```
+
+### reboot (scheduled reboot)
+
+```
+% junos-ops reboot --at 2506130500 rt1.example.jp
+# rt1.example.jp
+	Shutdown at Fri Jun 13 05:00:00 2025. [pid 97978]
+```
+
+### config (push set command file)
+
+Push a set-format command file to multiple devices. Uses a safe commit flow: commit check, commit confirmed, then confirm.
+
+```
+% cat add-user.set
+set system login user viewer class read-only
+set system login user viewer authentication ssh-ed25519 "ssh-ed25519 AAAA..."
+
+% junos-ops config -f add-user.set -n rt1.example.jp rt2.example.jp
+# rt1.example.jp
+[edit system login]
++    user viewer {
++        class read-only;
++        authentication {
++            ssh-ed25519 "ssh-ed25519 AAAA...";
++        }
++    }
+	dry-run: rollback (no commit)
+# rt2.example.jp
+	...
+
+% junos-ops config -f add-user.set rt1.example.jp rt2.example.jp
+# rt1.example.jp
+	...
+	commit check passed
+	commit confirmed 1 applied
+	commit confirmed, changes are now permanent
+# rt2.example.jp
+	...
+```
+
+Use `--confirm N` to change the commit confirmed timeout (default: 1 minute).
+
+### No subcommand (show device facts)
+
+```
+% junos-ops gw1.example.jp
+# gw1.example.jp
+{'2RE': True,
+ 'hostname': 'gw1',
+ 'model': 'MX240',
+ 'version': '18.4R3-S7.2',
+ ...}
+```
+
+## Supported Models
+
+Any Juniper model can be supported by defining the model name and package file in the configuration file. Models included in the example configuration:
+
+| Series | Example Models |
+|--------|---------------|
+| EX | EX2300-24T, EX3400-24T, EX4300-32F |
+| MX | MX5-T, MX240 |
+| QFX | QFX5110-48S-4C |
+| SRX | SRX300, SRX345, SRX1500, SRX4600 |
+
+## License
+
+[Apache License 2.0](LICENSE)
+
+Copyright 2022-2025 AIKAWA Shigechika