Skip to content

Commit 7fed9a0

Browse files
committed
(FM-7602) Update Readme and Reference docs
1 parent b36aab0 commit 7fed9a0

File tree

2 files changed

+20
-40
lines changed

2 files changed

+20
-40
lines changed

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
The PANOS module configures Palo Alto firewalls running PANOS 7.1.0 or PANOS 8.1.0.
2121

22-
When committing changes to resources, include `panos_commit` in your manifest, or execute the `commit` task. You must do this before they can be made available to the running configuration.
22+
When committing changes to resources, include `panos_commit` in your manifest, or execute the `commit` task. You must do this before they can be made available to the running configuration.
2323

2424
The module provides a Puppet task to manually `commit`, `store_config` to a file, and `set_config` from a file.
2525

@@ -70,13 +70,27 @@ __Note:__ v0.1.0 requires `host` instead of `address`
7070

7171
__Note:__ v0.1.0 requires `user` instead of `username`
7272

73-
To obtain an API key for the device, it is possible to use the `panos::apikey` task. The required creditials file should be in the format of (a) above. After which you can discard it. Before running this task, install the module on your machine, along with [Puppet Bolt](https://puppet.com/docs/bolt/0.x/bolt_installing.html). When complete, execute the following command:
73+
To obtain an API key for the device, it is possible to use the `panos::apikey` task. Before running this task, install the module on your machine, along with [Puppet Bolt](https://puppet.com/docs/bolt/latest/bolt_installing.html). When complete, execute the following command:
7474

7575
```
76-
bolt task run panos::apikey --nodes localhost --transport local --modulepath <module_installation_dir> --params @credentials.json
76+
bolt task run panos::apikey --nodes pan --modulepath <module_installation_dir> --inventoryfile <inventory_yaml_path>
7777
```
7878

79-
The `--modulepath` param can be retrieved by typing `puppet config print modulepath`. The credentials file needs to be valid JSON containing host, username and password for the Palo Alto firewall.
79+
The following [inventory file](https://puppet.com/docs/bolt/latest/inventory_file.html) can be used to connect to your firewall.
80+
```yaml
81+
# inventory.yaml
82+
nodes:
83+
- name: firewall.example.com
84+
alias: pan
85+
config:
86+
transport: remote
87+
remote:
88+
remote-transport: panos
89+
user: admin
90+
password: admin
91+
```
92+
93+
The `--modulepath` param can be retrieved by typing `puppet config print modulepath`.
8094

8195
Test your setup and get the certificate signed:
8296

REFERENCE.md

Lines changed: 2 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929

3030
**Tasks**
3131

32-
* [`apikey`](#apikey): Retrieve a PAN-OS apikey using PAN-OS host, username and password.
32+
* [`apikey`](#apikey): Retrieve a PAN-OS apikey
3333
* [`commit`](#commit): Commit a candidate configuration to a firewall.
3434
* [`set_config`](#set_config): upload and/or apply a configuration to a firewall.
3535
* [`store_config`](#store_config): Retrieve the configuration running on the firewall.
@@ -1711,44 +1711,16 @@ The display-name of the zone.
17111711

17121712
### apikey
17131713

1714-
Retrieve a PAN-OS apikey using PAN-OS host, username and password.
1714+
Retrieve a PAN-OS apikey
17151715

17161716
**Supports noop?** false
17171717

1718-
#### Parameters
1719-
1720-
##### `host`
1721-
1722-
Data type: `String`
1723-
1724-
The host to connect to
1725-
1726-
##### `user`
1727-
1728-
Data type: `String`
1729-
1730-
The user name
1731-
1732-
##### `password`
1733-
1734-
Data type: `String`
1735-
1736-
The password
1737-
17381718
### commit
17391719

17401720
Commit a candidate configuration to a firewall.
17411721

17421722
**Supports noop?** false
17431723

1744-
#### Parameters
1745-
1746-
##### `credentials_file`
1747-
1748-
Data type: `String`
1749-
1750-
The filename of the credentials file (as referenced in device.conf)
1751-
17521724
### set_config
17531725

17541726
upload and/or apply a configuration to a firewall.
@@ -1757,12 +1729,6 @@ upload and/or apply a configuration to a firewall.
17571729

17581730
#### Parameters
17591731

1760-
##### `credentials_file`
1761-
1762-
Data type: `String`
1763-
1764-
The filename of the credentials file (as referenced in device.conf)
1765-
17661732
##### `config_file`
17671733

17681734
Data type: `String`

0 commit comments

Comments
 (0)