Cisco DNA Controller SD-Access Bulk Operations

Author: Jason Barbee - CCIE #18039

Contributions by: Jeremy Sanders

Latest Version tested: DNA 1.1.2

Features

Imports CSV to DNA Switch ports
Exports DNA Switch ports to CSV
Converts IOS to CSV format for import
Merges 24 to 48 port switch port in the CSV for combining (2) 24 port switches to a 48.
Exports Virtual Networks and Address pools.
Renames FastEthernet0/XX to GigabitEthernetX/0/XX based on the stack parameter passed.
Locates a MAC address or any partial mac system wide in DNA.
Prints Inventory and Provisioning Status of the system

Setup Python for DNAC-Bulk Tools

Install Python 3 and Libraries

pip3 install requests pyaml

Modify your config.yml file

global:
  hostname: 'fqdn_of_DNAC'
  username: 'admin'
  password: 'password'
  defaultVoiceVN: '10_0_1_0-Phone_VN' (your default phone VN)
  VoiceVlans: ['101','102'] (this helps the script know what voice vlans are - must manually update till I use the spreadsheet field.)

If you are using Netcopa for conversions, install Python 2.7 and it's requirements.txt file. on mac that is like this

cd netcopa
pip2 install -r requirements.txt

Mapping Vlans to DNA Address Pools via Vlans.csv

This is a format that worked for us, it stores some relevant data as we migrate.

Note about Netcopa conversions

You do NOT have to use my NetCopa conversion process, you can just build a plain CSV in any way you wish and run the import. The process helps us convert large batches of IOS config files.

Import a DNA switch via CSV

Have a CSV file ready through conversion(below) or manual building that looks like this

Switch Name,Interface,Address Pool(VN),Voice Pool(VN),Authentication
CLOSETSWITCH_1.domain.loc,GigabitEthernet1/0/1,10_0_0_0-Corp_VN,10_0_1_0-Phone_VN,No Authentication

python3 dnac-bulk.py --action import --input closet1.csv --switchname switch1.domain.loc

Export a DNA Switch Network CSV

It will generate a compatible format above for re-importing. Good for backups.

python3 dnac-bulk.py --action export --output export.csv --switchname switch.domain.com

Clear Configs

Wipe switch so that it can be re-provisioned from CLI.

python3 dnac-bulk.py --action clear --switchname switch.domain.com

Locate MAC address

python3 dnac-bulk.py --action findhost --mac 08:cc:a7:85:cb:5f

-------
Searching for Phone MAC Addresses ending with 08:cc:a7:85:cb:5f
Host IP:  10.2.2.2
Host MAC: 08:cc:a7:85:cb:5f
Switch Device IP: 10.1.1.1
Switch Name: switch.domain.loc
Switch Interface: GigabitEthernet1/0/48

Search All IP Phones in DNA by partial MAC

This step uses a DNA API Request to pull all endpoints DNA has categorized as IP_PHONE, and basically greps them for a match.

python3 dnac-bulk.py --action findphone --mac cb5f

-------
Searching for Phone MAC Addresses ending with  cb5f
Host IP:  10.2.2.2
Host MAC: 08:cc:a7:85:cb:5f
Switch Device IP: 10.1.1.1
Switch Name: switch.domain.loc
Switch Interface: GigabitEthernet1/0/48

Print Inventory Status from DNA

python3 dnac-bulk.py --action inventory

Hostname                       Platform                 Uptime           Version          CollectionStatus       IP Address       Reachability     Status
A-DNA-SWITCH                    C9500-40X          95 days, 3:01:50.69    16.6.3               Managed            10.1.1.1        Reachable        "SUCCESS"

Conversion Step 1 - Prepare IOS Files

Credit to netcopa project. This step will convert text IOS files into a YAML structure that this script will them process.

Download Netcopa, and copy my file closet_ios.yml into the netcopa/host_vars folder.
Obtain your Cisco IOS config file.
Scrub it of all lines except interfaces and an "end" statement". Remove all show commands, etc.
Remove any extra commands like spanning tree, port security, cdp, whatever under the interfaces. Netcopa does not process unexpected input well. .
Place cleaned switch config in netcopa/configs.
Name it something like 211.cfg
Duplicate closet_ios.xml file to match the name like 211.yml in the netcopa/host_vars folder. This fille basically tells Netcopa to use the IOS parser, and gives it a blank structure to fill in.

closet_ios.yml contents

os: cisco_ios
vars:

Conversion Step 2 - Running netcopa to parse to YML

python2.7 runparse.py

This will process all the configs and fill in the vars: field in the .xml file with structured YAML. Scroll up to see if it was successful. The logs are a little hard to read. I have several times had to skip problem parsing areas like this. If you have scrubbed your config down to interfaces, this won't be an issue.

python2.7 runparse.py --skip logging

Conversion Process - Troubleshooting NETCOPA

Read the output carefully.

Look on your screen for buffer like this

'######## ACTUAL'
[['interface FastEthernet0'],
 ['interface GigabitEthernet0/1',
  ' switchport access vlan 10',
  ' switchport mode access',
  ' switchport voice vlan 20'],

and 
'######## JINJA RESULT'
[['interface FastEthernet0'],
 ['interface GigabitEthernet0/1',
  ' switchport access vlan 10',
  ' switchport mode access',
  ' switchport voice vlan 20'],

Capture the output, and DIFF/Compare them if you need to.

Conversion - Step 3 - Import YML Configurations to DNAC import CSV.

The script will stop when it finds a port hard coded to an access voice vlan. DNA will not let you assign a voice address pool into a data address (access vlan) They in a list in the config.yml file.

Running the Conversion

This will conver the YAML to a CSV intermediary format for my script to later import.

python3 dnac-bulk.py --action convert --stack 1 --input netcopa/host_vars/211.yml --output 211.csv

Run the Conversion process for Stack 2, etc. It will append to the csv file.

python3 dnac-bulk --stack 2 --input 212.yml --output 21.csv

If you need to convert a 24 to 48 port switch use --to48 it will transpse interfaces by 24, useful on the second switch in a merged stack of 48 ports.

python3 dnac-bulk --stack 2 --input 212.yml --output 21.csv  --to48

Caveats

VN/Pool export shows up on screen, it does not write to CSV well yet. Partially implemented.
I never had to bulk 802.1x yet, we are using no authentication, so the netcopa does not reflect if the port used 802.1x or not. The import process example is for no authentication, but you can change that to any of the expected values in DNA.
This uses undocumented API calls to DNA, and may be volatile. I am documeting what I use it on. I had to reverse engineer the calls using Firefox Inspector on the DNA Web Interface.
I plan to support this through a rollout of a few hundred switches probably till late 2018, we'll see where things are at that point.
Open a github issue if you have one, or submit a pull request and I'll review it. We have 300 switches or so left to go, so if you think it's useful, I might add it.
Long term, once Cisco publishes a real DNA API, this tool may become obsolete.

Likely roadmap

Use filename as the import switchname instead of parameter.
Remove switch name from CSV / clean up CSV formatting.
Remove the voice vlan markings in config file and use CSV to understand voice vlans

License

MIT License.

Want Professional DNA / SD-Access Assistance?

TekLinks is a Cisco Gold Partner that offers professional services to support your DNA SD-Access design and installation.

Visit www.teklinks.com and contact us to talk more.

Other Credits

I reference the Netcopa Project in my process, but no code is copied or modified from that project. https://github.com/cidrblock/netcopa

htothek/dnac-bulk