coding 102 updates

Author: brtiller1

labs/coding-102-rest-python-ga/3.md

@@ -6,7 +6,7 @@ These files are located on your workstation in the directory: /DevNetCode/<yo
 * **create-ticket.py** - Example to create a service ticket. Used in Step 2.
 * **get-network-hosts.py** – First application to parse the service ticket response and show list of hosts by doing a pretty print of the JSON data
 * **get-network-devices.py** – Retrieves network device list and parses JSON to display networkDeviceId values
-* **manage-users.py** – Shows how to retrieve, add and delete users
+* **build-topology.py** – Shows how to retrieve devices and interfaces, and to build a spreadsheet-like topology
 
 
 #### get-network-hosts.py

labs/coding-102-rest-python-ga/5.md

@@ -1,10 +1,10 @@
 # Step 5. Manage APIC-EM Users
 
-In this step we're going to continue to use functions to get, create and delete users.
+In this step we're going to get the topology then parse the data to determine how devices link to one another and their status.
 
 
 #### manage-users.py
-This sample code uses the application REST function call to retrieve a list of the APIC-EM users and their roles. Our goal is to find the users and display information about them.  In addition, we'll create a new user and delete it.
+This sample code uses the application REST function call to retrieve a list of devices called nodes and links which are the interfaces that connect them. Our goal is to find the devices and display information about them and how they connect to other devices.
 
 
 ```python
@@ -14,16 +14,12 @@ import requests
 #import json library
 import json
 
-
 # Disable warnings
 requests.packages.urllib3.disable_warnings()
 
-
 controller='sandboxapic.cisco.com'
 
-#creates and returns a service ticket.
 def getTicket():
-	print("\nCreating ticket")
 	# put the ip address or dns of your apic-em controller in this url
 	url = "https://" + controller + "/api/v1/ticket"
 
@@ -36,6 +32,8 @@ def getTicket():
 	#Performs a POST on the specified url to get the service ticket
 	response= requests.post(url,data=json.dumps(payload), headers=header, verify=False)
 
+	print (response)
+
 	#convert response to json format
 	r_json=response.json()
 
@@ -44,120 +42,92 @@ def getTicket():
 
 	return ticket
 
-#Get and display the APIC-EM Users
-def getUsers(ticket):
-	print("\nGetting list of existing users")
-	# URL for user REST API call to get list of APIC-EM users.
-	url = "https://" + controller + "/api/v1/user"
 
-	#Content type as well as the ticket must be included in the header
-	header = {"content-type": "application/json", "X-Auth-Token":ticket}
 
-	# this statement performs a GET on the specified host url
-	response = requests.get(url, headers=header, verify=False)
-
-	# json.dumps serializes the json into a string and allows us to
-	# print the response in a 'pretty' format with indentation etc.
-	print ("Users = ")
-	print (json.dumps(response.json(), indent=4, separators=(',', ': ')))
-
-
-#Adds a APIC-EM User
-def addUser(ticket):
-	print("\nAdding new user")
-	# URL for user REST API call to get list of existing users in the network.
-	url = "https://" + controller + "/api/v1/user"
+def getTopology(ticket):
+	# URL for topology REST API call to get list of existing devices on the network, and build topology
+	url = "https://" + controller + "/api/v1/topology/physical-topology"
 
 	#Content type as well as the ticket must be included in the header
 	header = {"content-type": "application/json", "X-Auth-Token":ticket}
 
-	username="brett"
-	#Data for new user
-	payload={"password":"Brett123!","username":username,"authorization":[{"scope":"ALL","role":"ROLE_OBSERVER"}]}
-
-	# this statement performs a Post on the specified user url
-	response = requests.post(url, data=json.dumps(payload), headers=header, verify=False)
-	print ("Response after post:  " + response.text)
-
-	return (username)
-
-
-#Delete the user that corresponds to the passed in username parameter
-def deleteUser(username, ticket):
-	print("\nRemoving user: " + username)
-	# URL for a specified user REST API call.
-	url = "https://" + controller + "/api/v1/user/" + username
-
-	#Content type as well as the ticket must be included in the header
-	header = {"content-type": "application/json", "X-Auth-Token":ticket}
-
-	# this statement performs a Delete on the specified user url
-	response = requests.delete(url, headers=header, verify=False)
-	print (response.text)
-
-
-#Show the User that corresponds to the passed in username parameter
-def showUser(username, ticket):
-	print("\nDisplaying user: " + username)
-	# URL for user REST API call to get APIC-EM user with corresponding name.
-	url = "https://" + controller + "/api/v1/user/" + username
-
-	#Content type as well as the ticket must be included in the header
-	header = {"content-type": "application/json", "X-Auth-Token":ticket}
-
-	# this statement performs a GET on the specified user url
+	# this statement performs a GET on the specified network device url
 	response = requests.get(url, headers=header, verify=False)
+
 	# json.dumps serializes the json into a string and allows us to
 	# print the response in a 'pretty' format with indentation etc.
-	print ("User found = ")
+	print ("Topology = ")
 	print (json.dumps(response.json(), indent=4, separators=(',', ': ')))
 
+	#convert data to json format.
+	r_json=response.json()
+
+	#Iterate through network device data and list the nodes, their interfaces, status and to what they connect
+	for n in r_json["response"]["nodes"]:
+		if "platformId" in n:
+			print()
+			print()
+			print('{:30}'.format("Node") + '{:25}'.format("Family") + '{:20}'.format("label")+ "Management IP")
+			print('{:30}'.format(n["platformId"]) + '{:25}'.format(n["family"]) + '{:20}'.format(n["label"]) + n["ip"])		
+		found=0    #print header flag
+		printed=0  #formatting flag
+		for i in r_json["response"]["links"]:
+			if "startPortName" in i:
+				#check that the source device id for the interface matches the node id.  Means interface originated from this device.
+				if i["source"] == n["id"]:
+					if found==0:
+						print('{:>20}'.format("Source Interface") + '{:>15}'.format("Status") + '{:>22}'.format("Target Interface") + '{:>18}'.format("Target"))
+						found=1
+						printed=1					
+					for n1 in r_json["response"]["nodes"]:
+						#find name of node to which this one connects
+						if i["target"] == n1["id"]:
+							print("    " + '{:<25}'.format(i["startPortName"]) + '{:<12}'.format(i["linkStatus"]) + '{:<28}'.format(i["endPortName"]) + '{:<15}'.format(n1["platformId"]))							
+							break;
+		found=0		
+		for i in r_json["response"]["links"]:
+			if "startPortName" in i:
+				#Find interfaces that link to this one which means this node is the target.
+				if i["target"] == n["id"]:
+					if found==0:
+						if printed==1:
+							print()
+						print('{:>20}'.format("Source Interface") + '{:>15}'.format("Status") + '{:>22}'.format("Target Interface") + '{:>18}'.format("Source"))
+						found=1					
+					for n1 in r_json["response"]["nodes"]:
+						#find name of node to that connects to this one
+						if i["source"] == n1["id"]:
+							#print('{:<30}'.format(i["endPortName"]) + '{:>10}'.format(i["linkStatus"]) + '{:>26}'.format(n1["platformId"]))
+							print("    " + '{:<25}'.format(i["startPortName"]) + '{:<12}'.format(i["linkStatus"]) + '{:<28}'.format(i["endPortName"]) + '{:<15}'.format(n1["platformId"]))
+							break;
 
 theTicket=getTicket()
-getUsers(theTicket)
-name=addUser(theTicket)
-showUser(name,theTicket)
-getUsers(theTicket)
-deleteUser(name,theTicket)
-getUsers(theTicket)
+getTopology(theTicket)
 ```
 
 Let's look at what the code is doing.  We'll focus on the key code changes.
-* *def addUser(theTicket):*
-    * We define the function named addUser.  This function creates a payload with user information and adds it. The passed in parameter 'theTicket' is used for authorization purposes.
-* *def deleteUser(username,theTicket):*
-    * We define the function named deleteUser which removes a user with the name of the passed in parameter 'username'. The passed in parameter 'theTicket' is used for authorization purposes.
+* *def getTopology(theTicket):*
+    * We define the function named getTopology.  This function reads in the topology data.  It parses the nodes which are devices on the network and displays some information about them.  It also parses the link data which are interfaces that connect the nodes and displays information about how they connect the devices and their status. The passed in parameter 'theTicket' is used for authorization purposes.
 
 To run this code sample:
 1. Go to directory **coding102-REST-python-ga**.  In the terminal type:
     **cd \DevNetCode\&lt;your-name&gt;\coding-skills-sample-code\coding102-REST-python-ga**
 2. Assign the APIC-EM Controller IP address or DNS to the **controller** variable.
-    * Open the file **manage-users.py**.  For example, in Windows type: **notepad manage-users.py**
+    * Open the file **build-topology.py**.  For example, in Windows type: **notepad build-topology.py**
     * *If you are not using your own APIC-EM Controller*, use the [DevNet Sandbox](https://developer.cisco.com/site/devnet/sandbox/) Always-On APIC-EM Lab: [sandboxapic.cisco.com](https://sandboxapic.cisco.com)
         * controller='sandboxapic.cisco.com'
 3. Save the file. If encoding type is an option select **UTF-8**.
 4. Type the python command and then the filename at the command prompt, and press the return key.
-    * *On Windows type*: **py -3 manage-users.py**.  Or type: **python manage-users.py**
-    * *On Mac OS or Linux type*: **python3 manage-users.py**
+    * *On Windows type*: **py -3 build-topology.py**.  Or type: **python build-topology.py**
+    * *On Mac OS or Linux type*: **python3 build-topology.py**
 5. The program should execute or display an error message.
 
     You should see a result like the following.
 
-Create service ticket and list users
-![](/posts/files/coding-102-rest-python-ga/assets/images/manage-users-1.png)
-<br/><br/>
-Add and list user
-![](/posts/files/coding-102-rest-python-ga/assets/images/manage-users-2.png)
-<br/><br/>
-List all users
-![](/posts/files/coding-102-rest-python-ga/assets/images/manage-users-3.png)
-<br/><br/>
-Remove the added user and list remaining users
-![](/posts/files/coding-102-rest-python-ga/assets/images/manage-users-4.png)
-<br/><br/>
+![](/posts/files/coding-102-rest-python-ga/assets/images/build-topology.png)
 
 
 ## Things to Try
-* Comment out the call to deleteUser(name,theTicket) which would then show as *#deleteUser(name,theTicket)*, and run the program twice.  What error occurs when you try to add an already existing user?   
-* Remove the pound sign # from the deleteUser function so reads as *deleteUser(name,theTicket)* then run the program twice.  Is the problem corrected?
-* In the showUser(name,theTicket) function call change the name parameter to string 'joe' so the function call reads as *showUser('joe',theTicket)* .  What happens when the user to be shown is not found?
+* After running the script, review the node data printed. Replace the label attribute that is printed with another attribute such as role or nodeType. 
+* You may have noticed that no host devices are printed.  Review the data and the source code, and determine why this is so along with how you would print this data.
+* Modify the source code so that host devices are printed as well.