```console
-$ pan-os-upgrade --hostname houston.cdot.io --version 10.2.0-h2 --username admin --password paloalto#1
+$ pan-os-upgrade --ip-address 192.168.255.211 --version 10.2.0-h2 --username admin --password paloalto#1
INFO - ✅ Connection to firewall established
-INFO - 📝 007054000242050 houston 192.168.255.211
+INFO - 📝 007054000123456 houston 192.168.255.211
INFO - 📝 Firewall HA mode: disabled
INFO - 📝 Current PAN-OS version: 10.2.0
INFO - 📝 Target PAN-OS version: 10.2.0-h2
@@ -89,7 +90,7 @@ INFO - ✅ Base image for 10.2.0-h2 is already downloaded
INFO - 🚀 Performing test to see if 10.2.0-h2 is already downloaded...
INFO - 🔍 PAN-OS version 10.2.0-h2 is not on the firewall
INFO - 🚀 PAN-OS version 10.2.0-h2 is beginning download
-INFO - Device 007054000242050 downloading version: 10.2.0-h2
+INFO - Device 007054000123456 downloading version: 10.2.0-h2
INFO - ⚙️ Downloading PAN-OS version 10.2.0-h2 - Elapsed time: 4 seconds
INFO - ⚙️ Downloading PAN-OS version 10.2.0-h2 - Elapsed time: 36 seconds
INFO - ⚙️ Downloading PAN-OS version 10.2.0-h2 - Elapsed time: 71 seconds
@@ -108,7 +109,7 @@ INFO - 🚀 Performing backup of houston's configuration to local filesystem...
INFO - 🚀 Not a dry run, continue with upgrade...
INFO - 🚀 Performing upgrade on houston to version 10.2.0-h2...
INFO - 🚀 Attempting upgrade houston to version 10.2.0-h2 (Attempt 1 of 3)...
-INFO - Device 007054000242050 installing version: 10.2.0-h2
+INFO - Device 007054000123456 installing version: 10.2.0-h2
INFO - ✅ houston upgrade completed successfully
INFO - 🚀 Rebooting the firewall...
INFO - 📝 Command succeeded with no output
@@ -122,7 +123,7 @@ INFO - ⚙️ Firewall is rebooting...
INFO - ⚙️ Firewall is rebooting...
INFO - ⚙️ Firewall is responding to requests but hasn't finished its reboot process...
INFO - ⚙️ Firewall is responding to requests but hasn't finished its reboot process...
-INFO - ✅ Firewall upgraded and rebooted in 343 seconds"
+INFO - ✅ Firewall upgraded and rebooted in 343 seconds
```
diff --git a/docs/user-guide/configuration.md b/docs/user-guide/configuration.md
index be3d340..64b9992 100644
--- a/docs/user-guide/configuration.md
+++ b/docs/user-guide/configuration.md
@@ -1,89 +1,51 @@
# Configuration Guide for pan-os-upgrade
-Proper configuration is crucial for the effective use of the `pan-os-upgrade` package. There are two main methods to configure the tool: using a `.env` file or passing command-line arguments. Each method has its strengths and weaknesses, which we'll explore below.
+Proper configuration is vital for the effective use of the `pan-os-upgrade` package. As of the latest update, configuration can be done primarily through command-line arguments.
-## Option 1: Using a `.env` File
+## Executing `pan-os-upgrade`
-A `.env` file is a simple way to store configuration settings in key-value pairs. This method is advantageous for keeping your configuration organized and easily editable in one place.
+### Option 1: Execute Without Command-Line Arguments
-**Creating a `.env` File:**
+You can start the script by simply issuing `pan-os-upgrade` from your current working directory. The interactive shell will prompt you to input the required arguments.
-1. Create a `.env` file in your project's root directory.
-2. Add your firewall's details to the file, as shown below:
-
-```env
-# PAN-OS credentials - use either API key or username/password combination
-PAN_USERNAME=admin
-PAN_PASSWORD=paloalto123
-API_KEY=
-
-# Hostname or IP address of the firewall
-HOSTNAME=firewall1.example.com
-
-# Target PAN-OS version for the upgrade
-TARGET_VERSION=11.0.2-h3
-
-# Logging level (e.g., debug, info, warning, error, critical)
-LOG_LEVEL=debug
-
-# Set to true for a dry run
-DRY_RUN=false
+```bash
+$ pan-os-upgrade
+IP address: 192.168.255.1
+Username: admin
+Password:
+Target PAN-OS version: 11.1.1
+...output...
```
-**Pros:**
-
-- Centralized configuration management.
-- Easy to update or modify settings.
-
-**Cons:**
+### Option 2: Execute Using Command-Line Arguments
-- Risk of committing sensitive information to a version control system if not properly ignored.
-- Less flexibility for dynamic or per-run configurations.
-
-## Option 2: Using Command-Line Arguments
-
-Command-line arguments offer a direct way to pass configuration settings each time you run the script.
-
-**Passing Details via Command-Line:**
-
-- Standard Usage:
+Alternatively, you can pass these details as command-line arguments:
```bash
-pan-os-upgrade --hostname 192.168.1.1 --username admin --password secret --version 10.1.0
+$ pan-os-upgrade --ip-address 192.168.1.1 --username admin --password secret --version 10.1.0
```
-- For a Dry Run:
+For a dry run:
```bash
-pan-os-upgrade --hostname 192.168.1.1 --username admin --password secret --version 10.1.0 --dry-run
+$ pan-os-upgrade --ip-address 192.168.1.1 --username admin --password secret --version 10.1.0 --dry-run
```
-**Pros:**
-
-- Greater control and flexibility for each run.
-- Avoids storing sensitive details in a file.
-
-**Cons:**
-
-- Risk of exposing sensitive information in console history.
-- Less convenient for repeated use with the same settings.
-
## CLI Arguments Description
When using command-line arguments, the following options are available:
-| argument | description | required |
-| ------------- | ------------------------------------------------------------------------- | --------- |
-| `--api-key` | API Key for authentication | required* |
-| `--dry-run` | Dry run of all tests and downloads without performing the actual upgrade. | optional |
-| `--hostname` | Hostname or IP address of the PAN-OS firewall. | optional |
-| `--log-level` | Set the logging output level (e.g., debug, info, warning). | optional |
-| `--password` | Password for authentication. | required* |
-| `--username` | Username for authentication. | required* |
-| `--version` | Target PAN-OS version to upgrade to. | required |
+| Argument | Description | Required |
+| -------------- | -------------------------------------------------------------------- | -------- |
+| `--ip-address` | IP address of the target PAN-OS firewall. | Yes |
+| `--username` | Username for authentication with the firewall. | Yes |
+| `--password` | Password for authentication with the firewall. | Yes |
+| `--version` | Target PAN-OS version to upgrade to. | Yes |
+| `--dry-run` | Perform a dry run of all tests and downloads without actual upgrade. | No |
+| `--log-level` | Set the logging output level (e.g., debug, info, warning). | No |
-
* if using a --api-key for authentication, omit the --username and --password arguments; opposite is also true.
+Note: The use of an API key and `.env` file for configuration is no longer supported.
## Next Steps
-After configuring `pan-os-upgrade`, you're ready to execute the upgrade process. To learn more about the execution steps and options, proceed to the [Execution Guide](execution.md).
+After configuring `pan-os-upgrade`, you're ready to execute the upgrade process. For more details on execution steps and options, proceed to the [Execution Guide](execution.md).
diff --git a/docs/user-guide/execution.md b/docs/user-guide/execution.md
index bbf33c7..13e1a96 100644
--- a/docs/user-guide/execution.md
+++ b/docs/user-guide/execution.md
@@ -1,45 +1,37 @@
# Execution Guide for pan-os-upgrade
-The `pan-os-upgrade` tool automates the entire process of upgrading PAN-OS firewalls. This guide will walk you through the execution steps, detailing how to use the script with different configuration options, and what to expect in terms of output and logging.
+The `pan-os-upgrade` tool automates the entire process of upgrading PAN-OS firewalls. This guide will walk you through the execution steps, detailing how to use the script with the latest configuration options, and what to expect in terms of output and logging.
## Execution Options
-You can execute `pan-os-upgrade` using two primary methods: either by using a `.env` file or command-line arguments. Each method provides flexibility depending on your preference or automation setup.
+You can execute `pan-os-upgrade` using command-line arguments to provide configuration details directly.
-### Using a `.env` File
+### Using Command-Line Arguments
-If you have set up a `.env` file as per the configuration guide, simply execute the script without any additional arguments:
+Execute the script by passing the configuration details as command-line arguments:
```console
-pan-os-upgrade
+$ pan-os-upgrade --ip-address 192.168.1.1 --username admin --password secret --version 10.1.0
```
-This command will automatically pick up the configuration details from your `.env` file.
-
-### Using Command-Line Arguments
+Replace `192.168.1.1`, `admin`, `secret`, and `10.1.0` with your firewall's details and the desired PAN-OS version.
-Alternatively, pass the configuration details directly as command-line arguments:
-
-
+For a dry run:
```console
-pan-os-upgrade --hostname 192.168.1.1 --username admin --password secret --version 10.1.0
+$ pan-os-upgrade --ip-address 192.168.1.1 --username admin --password secret --version 10.1.0 --dry-run
```
-
-
-Here, replace `192.168.1.1`, `admin`, `secret`, and `10.1.0` with your firewall's details and the desired PAN-OS version.
-
## Output
```console
-pan-os-upgrade --hostname 192.168.255.211 --username admin --password secret --version 10.2.0-h2
+pan-os-upgrade --ip-address 192.168.255.211 --username admin --password secret --version 10.2.0-h2
INFO - ✅ Connection to firewall established
INFO - 📝 007054000123456 houston 192.168.255.211
INFO - 📝 Firewall HA mode: disabled
@@ -51,7 +43,7 @@ INFO - ✅ Base image for 10.2.0-h2 is already downloaded
INFO - 🚀 Performing test to see if 10.2.0-h2 is already downloaded...
INFO - 🔍 PAN-OS version 10.2.0-h2 is not on the firewall
INFO - 🚀 PAN-OS version 10.2.0-h2 is beginning download
-INFO - Device 007054000242050 downloading version: 10.2.0-h2
+INFO - Device 007054000123456 downloading version: 10.2.0-h2
INFO - ⚙️ Downloading PAN-OS version 10.2.0-h2 - Elapsed time: 4 seconds
INFO - ⚙️ Downloading PAN-OS version 10.2.0-h2 - Elapsed time: 36 seconds
INFO - ⚙️ Downloading PAN-OS version 10.2.0-h2 - Elapsed time: 71 seconds
@@ -90,6 +82,8 @@ INFO - ✅ Firewall upgraded and rebooted in 542 seconds
+This output will include detailed logs of the process, such as establishing a connection, checking versions, performing upgrades, and rebooting the firewall.
+
## Assurance Functions
The script performs various assurance functions like readiness checks, snapshots, and configuration backups. These are stored in the `assurance/` directory, structured as follows:
