Skip to content

Commit 77f53bd

Browse files
committed
update various readme docs
1 parent d833a5b commit 77f53bd

File tree

5 files changed

+26
-13
lines changed

5 files changed

+26
-13
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ all:
187187
ndfc:
188188
hosts:
189189
nac-ndfc1:
190-
ansible_host: 10.X.X.X
190+
ansible_host: "{{ lookup('ansible.builtin.env', 'ND_HOST') }}"
191191
```
192192

193193
This structure creates two things in Ansible, a group called `ndfc` and a host called `nac-ndfc1:`. These are tied back to the directory structure of the repository that contains two folders in the top directory:
@@ -209,7 +209,7 @@ The collection is **pre-built** to utilize the `group_vars` and `host_vars` matc
209209

210210
#### Step 1 - Update the Inventory File
211211

212-
In the provided `inventory.yaml` file on the root directory, update the `ansible_host` variable to point to your NDFC controller by replacing `10.X.X.X` with the IP address of the NDFC controller.
212+
In the provided `inventory.yaml` file on the root directory, update the `ansible_host` variable to point to your NDFC controller by replacing `"{{ lookup('ansible.builtin.env', 'ND_HOST') }}"` with the IP address of the NDFC controller or setting the ```ND_HOST``` environment variable as described in Step 3.
213213

214214

215215
#### Step 2 - Configure Ansible Connection File
@@ -246,12 +246,14 @@ The usage of [Ansible vault](https://docs.ansible.com/ansible/latest/vault_guide
246246
The environment variables are set in the shell that is going to execute the playbook. The environment variables are configured via the `export` command in the shell (bash). Using this template set the environment variables to the correct credentials for the NDFC controller and the devices in the inventory on your topology.
247247

248248
```bash
249-
# These are the credentials for
250-
export ansible_user=admin
251-
export ansible_password=Admin_123
249+
# These are the credentials for ND/NDFC
250+
export ND_HOST=10.15.0.11
251+
export ND_DOMAIN=local
252+
export ND_USERNAME=admin
253+
export ND_PASSWORD=Admin_123
252254
# These are the credentials for the devices in the inventory
253-
export ndfc_switch_username=admin
254-
export ndfc_switch_password=Admin_123
255+
export NDFC_SW_USERNAME=admin
256+
export NDFC_SW_PASSWORD=Admin_123
255257
```
256258

257259
The following quickstart repository is available to provide a step by step guide for using this collection

roles/dtc/connectivity_check/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Role Name: cisco.nac_dc_vxlan.dtc.connectivity_check
22
========================================
33

44
This role is used to check the connectivity and authentication to NDFCs.
5-
Additionally, the role is used to obtain the NDFC version information.
5+
Additionally, the role is used to obtain the Nexus Dashboard (ND) and Nexus Dashboard Fabric Controller (NDFC) version information.
66

77
Requirements
88
------------
@@ -33,12 +33,11 @@ The following tags can be used to selectively execute stages within the `cisco.n
3333

3434
`cc` stands for `connectivity_check` role
3535

36-
* cc_connectivity_check
37-
* cc_version
36+
* cc_verify
3837

3938
```bash
4039
# Selectively run stage to add VRFs and Networks and skip all other stages
41-
ansible-playbook -i inventory.yml vxlan.yml --tags cc_connectivity_check
40+
ansible-playbook -i inventory.yml vxlan.yml --tags cc_verify
4241
```
4342

4443
License

roles/dtc/create/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Example Playbook
2828
```
2929
3030
-------
31-
The following tags can be used to selectively execute stages within the `cisco.nac_dc_vxlan.create` role
31+
The following tags can be used to selectively execute stages within the `cisco.nac_dc_vxlan.dtc.create` role
3232

3333
`cr` stands for `create_role`
3434

@@ -37,6 +37,7 @@ The following tags can be used to selectively execute stages within the `cisco.n
3737
* cr_manage_vpc_peers
3838
* cr_manage_interfaces
3939
* cr_manage_vrfs_networks
40+
* cr_manage_policy
4041

4142
```bash
4243
# Selectively run stage to add VRFs and Networks and skip all other stages

roles/dtc/deploy/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,16 @@ Example Playbook
2727
- role: cisco.nac_dc_vxlan.dtc.deploy
2828
```
2929
30+
-------
31+
The following tags can be used to selectively execute stages within the `cisco.nac_dc_vxlan.dtc.deploy` role
32+
33+
* role_deploy
34+
35+
```bash
36+
# Selectively run stage to add VRFs and Networks and skip all other stages
37+
ansible-playbook -i inventory.yml vxlan.yml --tags role_deploy
38+
```
39+
3040
License
3141
-------
3242

roles/dtc/remove/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Example Playbook
2828
```
2929
3030
-------
31-
The following tags can be used to selectively execute stages within the `cisco.nac_dc_vxlan.create` role
31+
The following tags can be used to selectively execute stages within the `cisco.nac_dc_vxlan.dtc.remove` role
3232

3333
`rr` stands for `remove_role`
3434

@@ -38,6 +38,7 @@ The following tags can be used to selectively execute stages within the `cisco.n
3838
* rr_manage_vpc_peers
3939
* rr_manage_links
4040
* rr_manage_switches
41+
* rr_manage_policy
4142

4243
```bash
4344
# Selectively run stage to remove networks and vrfs and skip all other stages

0 commit comments

Comments
 (0)