Skip to content

Commit d87b408

Browse files
DNACENSolutionsDNACENSolutions
committed
Fix PnP stack documentation examples
1 parent 131a870 commit d87b408

3 files changed

Lines changed: 13 additions & 93 deletions

File tree

‎cvp/plug_and_play/README.md‎

Lines changed: 4 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ Each item in the lists above (e.g., inside `claim_switching_devices`) typically
125125
| `image_name` | String | No | The name of the software image to provision. |
126126
| `template_params` | Dictionary | No | Variables required by the Jinja2 template (e.g., VLAN ID, IP). |
127127
| `device_info` | List | Yes | A list of specific devices to apply this configuration to. |
128-
| `license_level` | String | No | License level applied when claiming a Catalyst switch / stack switch (e.g., `network-advantage`). Most commonly used with `pnp_type: Default` or `pnp_type: StackSwitch`. |
128+
| `license_level` | String | No | License level applied when claiming a Catalyst switch / stack switch. Valid values: `Cisco DNA Essentials`, `Cisco DNA Advantage`. Most commonly used with `pnp_type: Default` or `pnp_type: StackSwitch`. |
129129
| `top_of_stack_serial_number` | String | No | Serial number of the switch to designate as top-of-stack (Member 1 / Active) during stack renumbering. Must match a `serial_number` under `device_info`. Applicable only when `pnp_type: StackSwitch`. |
130130
| `cabling_scheme` | Enum | No | Physical cabling topology of the Catalyst stack. Accepted values are `1A` and `1B`. Applicable only when `pnp_type: StackSwitch`. |
131131

@@ -221,17 +221,6 @@ pnp_details:
221221
is_sudi_required: false
222222
is_stack_device: true
223223
224-
# Phase 2: CLAIM the stack device as StackSwitch (stack renumbering)
225-
# Phase 1: ADD the stack device to PnP (Unclaimed)
226-
network_devices:
227-
- device_info:
228-
- serial_number: FJC271925Q1
229-
hostname: NY-EN-9300
230-
state: Unclaimed
231-
pid: C9300-48UXM
232-
is_sudi_required: false
233-
is_stack_device: true
234-
235224
# Phase 2: CLAIM the stack device as StackSwitch (stack renumbering)
236225
claim_switching_devices:
237226
- site_name: Global/USA/New York/NY_BLD1
@@ -242,11 +231,7 @@ pnp_details:
242231
PNP_VLAN_ID: 2005
243232
LOOPBACK_IP: 204.1.2.2
244233
pnp_type: StackSwitch
245-
license_level: network-advantage
246-
top_of_stack_serial_number: FJC271925Q1
247-
cabling_scheme: 1B
248-
pnp_type: StackSwitch
249-
license_level: dna-advantage
234+
license_level: "Cisco DNA Advantage"
250235
top_of_stack_serial_number: FJC271925Q1
251236
cabling_scheme: 1B
252237
device_info:
@@ -257,24 +242,7 @@ pnp_details:
257242
is_stack_device: true
258243
```
259244

260-
> **Stack renumbering:** `top_of_stack_serial_number` and `cabling_scheme` apply only when `pnp_type: StackSwitch`. `license_level` accepts the values reported by the device's `validLicenseLevels` (e.g. `network-advantage`, `advantage`); refer to your Catalyst Center version's API schema for the authoritative list.
261-
262-
#### Switch Stack with SUDI Authorization
263-
264-
When SUDI authorization is required, set `is_sudi_required: true` and list **every
265-
stack member serial number** in `user_sudi_serial_nos` (sent to the API as
266-
`userSudiSerialNos`).
267-
268-
```yaml
269-
---
270-
catalystcenter_version: 2.3.7.9
271-
pnp_details:
272-
claim_switching_devices:
273-
- site_name: Global/USA/New York/NY_BLD1
274-
project_name: Onboarding Configuration
275-
```
276-
277-
> **Stack renumbering:** `top_of_stack_serial_number` and `cabling_scheme` apply only when `pnp_type: StackSwitch`. `license_level` accepts the values reported by the device's `validLicenseLevels` (e.g. `network-advantage`, `advantage`); refer to your Catalyst Center version's API schema for the authoritative list.
245+
> **Stack renumbering:** `top_of_stack_serial_number` and `cabling_scheme` apply only when `pnp_type: StackSwitch`. `license_level` accepts `Cisco DNA Essentials` or `Cisco DNA Advantage`.
278246

279247
#### Switch Stack with SUDI Authorization
280248

@@ -290,7 +258,7 @@ pnp_details:
290258
- site_name: Global/USA/New York/NY_BLD1
291259
project_name: Onboarding Configuration
292260
pnp_type: StackSwitch
293-
license_level: dna-advantage
261+
license_level: "Cisco DNA Advantage"
294262
top_of_stack_serial_number: FJC271925Q1
295263
cabling_scheme: 1B
296264
device_info:
@@ -966,4 +934,3 @@ Use either of these forms:
966934

967935
- Relative to the playbook: `../vars/catalyst_center_pnp_vars.yml`
968936
- Fully resolved from the repo root: `${PWD}/cvp/plug_and_play/vars/catalyst_center_pnp_vars.yml`
969-

‎cvp/plug_and_play/vars/catalyst_center_pnp_vars.yml‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,7 @@ pnp_details:
4141
state: Unclaimed
4242
pid: C9300-48T
4343

44-
# DUPLICATE KEY - REMOVED: claim_switching_devices:
45-
- site_name: Global/USA/New York/NY_BLD1
44+
- site_name: Global/USA/New York/NY_BLD1
4645
project_name: Onboarding Configuration
4746
template_name: PnP-Devices-SW
4847
image_name: cat9k_iosxe.17.12.02.SPA.bin
@@ -57,9 +56,11 @@ pnp_details:
5756
is_sudi_required: true
5857
user_sudi_serial_nos:
5958
- FJC271925Q1
59+
- FJC271925Q2
60+
- FJC271925Q3
6061
is_stack_device: true
6162
pnp_type: StackSwitch
62-
license_level: network-advantage
63+
license_level: "Cisco DNA Advantage"
6364
top_of_stack_serial_number: FJC271925Q1
6465
cabling_scheme: 1B
6566

@@ -125,4 +126,4 @@ pnp_details:
125126
- serial_number: FXS2502Q2HC
126127
hostname: SF-BN-2-ASR.cisco.local
127128
state: Unclaimed
128-
pid: ASR1001-X
129+
pid: ASR1001-X

‎roles/pnp/README.md‎

Lines changed: 4 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Each item in `pnp_config` is passed directly to the `pnp_workflow_manager` modul
3939
- `project_name` / `template_name` / `template_params`: Onboarding template details.
4040
- `image_name` / `golden_image`: Software image to provision.
4141
- `pnp_type`: `Default`, `CatalystWLC`, `AccessPoint`, or `StackSwitch`.
42-
- `license_level`: License level applied when claiming a switch / stack switch (e.g., `network-advantage`).
42+
- `license_level`: License level applied when claiming a switch / stack switch. Valid values: `Cisco DNA Essentials`, `Cisco DNA Advantage`.
4343
- `top_of_stack_serial_number`: Serial number designated as top-of-stack (Member 1 / Active) for stack renumbering. Applicable only when `pnp_type: StackSwitch`.
4444
- `cabling_scheme`: Physical cabling topology of the stack. Accepted values: `1A`, `1B`. Applicable only when `pnp_type: StackSwitch`.
4545
- `device_info[].is_sudi_required`: Enable SUDI authentication. Requires `user_sudi_serial_nos`.
@@ -155,25 +155,6 @@ Stack-specific fields: `is_stack_device` (sent as `stack`),
155155
is_sudi_required: false
156156
is_stack_device: true
157157
158-
# Play 2: CLAIM the stack device as StackSwitch (stack renumbering)
159-
# Play 1: ADD the stack device to PnP (Unclaimed)
160-
- hosts: localhost
161-
roles:
162-
- role: pnp
163-
vars:
164-
catalystcenter_host: "{{ vault_catalystcenter_host }}"
165-
catalystcenter_username: "{{ vault_catalystcenter_username }}"
166-
catalystcenter_password: "{{ vault_catalystcenter_password }}"
167-
pnp_state: "merged"
168-
pnp_config:
169-
- device_info:
170-
- serial_number: FJC271925Q1
171-
hostname: NY-EN-9300
172-
state: Unclaimed
173-
pid: C9300-48UXM
174-
is_sudi_required: false
175-
is_stack_device: true
176-
177158
# Play 2: CLAIM the stack device as StackSwitch (stack renumbering)
178159
- hosts: localhost
179160
roles:
@@ -189,7 +170,7 @@ Stack-specific fields: `is_stack_device` (sent as `stack`),
189170
template_name: PnP-Devices-SW
190171
image_name: cat9k_iosxe.17.12.02.SPA.bin
191172
pnp_type: StackSwitch
192-
license_level: dna-advantage
173+
license_level: "Cisco DNA Advantage"
193174
top_of_stack_serial_number: FJC271925Q1
194175
cabling_scheme: 1B
195176
device_info:
@@ -200,35 +181,7 @@ Stack-specific fields: `is_stack_device` (sent as `stack`),
200181
is_stack_device: true
201182
```
202183

203-
#### Switch Stack with SUDI Authorization
204-
205-
When SUDI authorization is required, set `is_sudi_required: true` and list **every
206-
stack member serial number** in `user_sudi_serial_nos` (sent to the API as
207-
`userSudiSerialNos`).
208-
209-
```yaml
210-
- hosts: localhost
211-
roles:
212-
- role: pnp
213-
vars:
214-
catalystcenter_host: "{{ vault_catalystcenter_host }}"
215-
catalystcenter_username: "{{ vault_catalystcenter_username }}"
216-
catalystcenter_password: "{{ vault_catalystcenter_password }}"
217-
pnp_state: "merged"
218-
pnp_config:
219-
- site_name: Global/USA/New York/NY_BLD1
220-
project_name: Onboarding Configuration
221-
pnp_type: StackSwitch
222-
license_level: dna-advantage
223-
top_of_stack_serial_number: FJC271925Q1
224-
cabling_scheme: 1B
225-
device_info:
226-
- serial_number: FJC271925Q1
227-
hostname: NY-EN-9300
228-
state: Unclaimed
229-
pid: C9300-48UXM
230-
is_stack_device: true
231-
```
184+
> `license_level` accepts the Catalyst Center values `Cisco DNA Essentials` and `Cisco DNA Advantage`.
232185

233186
#### Switch Stack with SUDI Authorization
234187

@@ -249,7 +202,7 @@ stack member serial number** in `user_sudi_serial_nos` (sent to the API as
249202
- site_name: Global/USA/New York/NY_BLD1
250203
project_name: Onboarding Configuration
251204
pnp_type: StackSwitch
252-
license_level: network-advantage
205+
license_level: "Cisco DNA Advantage"
253206
top_of_stack_serial_number: FJC271925Q1
254207
cabling_scheme: 1B
255208
device_info:
@@ -258,7 +211,6 @@ stack member serial number** in `user_sudi_serial_nos` (sent to the API as
258211
state: Unclaimed
259212
pid: C9300-48UXM
260213
is_stack_device: true
261-
is_stack_device: true
262214
is_sudi_required: true
263215
user_sudi_serial_nos:
264216
- FJC271925Q1

0 commit comments

Comments
 (0)