Cisco Jabber Bulk Provisioning using POSTMAN and AXL API

[Music] hello everyone and welcome to Cisco collaboration learning group and also on the Cisco collaboration Learning Series YouTube channel my name is Amit Singh and I would like to thank every one of you who have joined the group to learn to know something new about Cisco collaboration technology so today we are gonna discuss about something very interesting which many of you maybe think is useful in your day to day operations especially during this pandemic situation where the customer needs to have a lot of phones a lot of devices created for work from home you know so yeah sure today we are gonna discuss about it bulk line and CSF ties device creation using the postman API so we are gonna create line in bulk we are gonna create CSF device in bulk and then we are gonna associate them with the end users and then see how it works so if you haven't seen how do we create a line or CSF please visit my last video or please watch my last videos wherein you will be able to watch all the stuffs how do we create lines and CSF using the postman API and how do we send the soap requests and receive a response and then this would then be a real helpful video for you guys when you come back and watch this video so let's get Evan edified let's get started [Music] [Music] you all right so let's start and let's see how can we create the CSF devices in bulk and how can we create you know the phones in bulk or the lines in bulk right so first things first so first we'll be creating a line and then we'll be creating the devices so we'll create lines in bulk and then we'll create the CSF devices in bulk I'm using soap you I - you know generate or or just copy the soap request and then I will remove all the unwanted lines that we don't need while adding a line and then we'll be creating a bulk request let's see how it happens so what I have done basically is just copied all this text for the add line from the soap UI and then pasted it into the notepad here and then I have just removed all the lines that I don't need while I create a pattern you know for example yeah you don't need a our settings and lot of other settings so I just removed all of them and then I have made some short soap requests and I have then created election in postman where I said okay I need to add a line and I need to add the line in bulk so it's just a name add line bulk I've created one I just did a copy I did a duplicate you know like this and then just renamed this request so okay and then in this ad line bulk what I did was I added the authorization header I said it's basic authorization API user and you know this API user if not please watch my first second third videos you will get to know how do we create this API user and why is it used basically it's used to authenticate the soap requests that we send across to Cisco Unified Communications Manager and here we add the headers that are needed while sending the slope request because slope requests one of the important parts is the slope headers you know and then here you specify what you want to do you say see you see M : DB and then the version of the soap request or this you see M you say 12.5 because I'm using COC M 12.5 so it's important and then I say what is the API that I am using it's add line request okay and my content type is application slash JavaScript now this body part is very important because last time if you see the body is different than the body here what do you mean by this is we will define something called as a variable okay so we here create something called as an environment variable in the way that you define the environment variable is within this double curly braces so opening curly braces and then the variable that you have to define environment variable that you have to define and then closed environment sorry in the curly braces this is how you define the variable inside a postman all right now this variable you have to define somewhere else right so that position is nothing but here you go to manage environments and then you can define it as a global variable or a local variable I'm using it as a global variables you know and then here basically you will say what what are the variables that you would like to define so in my case it's like I think I will use the variable bien to define a directory number and then I will use a variable D and D ESC to define the DN description you know and then [Music] I this is this is we can leave for now because this is for the next request and then we will have this alert one variable and then I have created a variable called as alert - all right so I've just created four variables so remember for now that we have created four variables here so we just have to type in TN and that's it that's how you define an environment variable and then you can type in anything it's not compulsory so you can even type in directory number or whatever you know so but for now I'm just saying it has at the end so it's just whatever you want to define it as you know so I will be using this for variables and then I will say save close and then these variables will be used here so for example if you have to define a pattern I'm using a variable DN inside the opening curly braces and closed curly braces so too that's important not one two curly braces here and then for description I am saying it's DN d ESC and then the usage is device it's same for all the all the lines so I am not changing that I'm using the same route partition for all my directory numbers so this is the provisioning partition that we created in our last videos I am using the same provisioning partition that we created using the API so you can have a look at my previous videos and then you will get to know how do you create a addition using postman API and then as the d-ends will have a different alerting names when defining this as different variables so for alerting name I said alert one and for ascii alerting name i said alert to again within the same curly braces and open early and closed curly braces okay and this is this is also optional but I say I thought that's important because you use allow control of devices from CTI I have set it to true and that's it once you have defined the error e once you have defined here the soap request now you have to provide the values of these variables you know how you could do it basically what you want to what you have to do is so this is this the this is how you create one excel sheet so that you could import those details inside the postman application you know for all those variable so let's say I want to have for the first row you have to define the variables first column VN is the first variable that we created and then I think the second was yeah the description the NDEs is the second variable that we define in postman and then the third variable that we defined was alert one and the fourth variable that we defined was alert too so let's now define the values for these D ends and then I say okay my first director number is five thousand one five thousand to five thousand three five thousand four five thousand five right and then I give a description or whatever you want to I will say user 1 user to user three to the four those are five you know and then I will copy the same description to the alerting names ASCII alerting name and the alerting names so this how you define or put the data and then you should save it as dot CSV file and after saving this as a dot CSV file it should be a comma separated file you know or sometimes what happens is you don't have a comma in between and you have some issues so make sure that you have for example saved it as a dot CSV file so for example I have saved it here as a dot CSV file okay so now once the file is created or the information is entered here let's import this file using the postman Runner you know so you just have to select the collection I'll just select this folder inside the collection one that's my collection and then I will click on run collections or runner and then I will say I need to have collection one line add bulk so I will remove add line because I am using add line in bulk request and then here I will say data select File and then I will say add line bulk and then it will automatically show you that it's a text slash CSV file and then the good part is that you can see how your data looks like if it's parsed correctly or not and then you can you know make a change in the CSV file if needed let's preview it and then here you see that's it's very beautifully parsed the way we want it so these are the variables that we define in the CSV file and these are the values of those variables and using these variables we will create five lines ingest by seconds now let's see how it happens okay I hope everything's fine and then you see iterations would automatically zero now it is automatically set to five because there were five rows inside the CSV file and then it selected this CSV file and then we'll just say now a run collection and then let's see what the output you okay it's all it gives you an error because I have already created this lines before just for testing and I've deleted that and now let's try once again you all right now you see we have a 200 ok back from CCM that means the line has been created okay sounds good and then let's see what we see in the Cisco Unified Communications Manager let's login to the Cisco Unified Communications Manager here and now here you see that let's say find all the directory numbers that begins with story that begins with 500 and bingo you have five lines created all right let's see if they have the correct information we'll just check one and then hopefully the rest should be fine as well so they have the right partition right description alerting name you know and then probably yeah this is what this is what we have just added you know and here I think that's for no not really okay all right good so we have created the lines let's move ahead and let's see how can we create the CSF device so far CSF you just have to go to soap UI and then go to look for add phone requests here's your add phone requests just copy everything here and you could remove lot of optional things here for example this is optional you could remove that these are of optional things remove it it's as well you need whatever you want to keep it keep it provide the information builder request and then send it across be a postman so for example I have built a request here and in this request I have last time not used couple of things so this time I'm using a couple of more things I have cleaned up the request that I copied from soap UI and then you know added some more inputs like for example if I have to associate the end user with the line you know and the busy trigger for example the maximum number of calls and busy triggers so I have put in some more information to make it a little bit more looking like you know it's for production or something not only for lab we can use it for production so the request is already built let's have a look here and then yeah same way I have created a request or an ad phone bulk request here so with a lot of variables because for example if I have to add five devices what I did was for example for name of the device I said I will use the variable def name you know and for example device description I use deaf discs as devices you can use your variables it doesn't matter X Y whatever but make it meaningful so that you guys can understand what variable it's all about you know and then I use the same CSS that we created last time postman CSS because it's the same location for example and same location wants to have five users created and then device pool I kept it default and then line label we have created a variable line variable and then line display again with the curly braces this is how you define the variable in postman you know open curly brace is two times and then closed curly brace is two times and then you need the N or directory number that's the pattern and then I'm using the same partition because usually in a company not all the directory numbers will have different partitions you know so the phones will have same partition so that they could call each other and then I have a variable for display ASCII value or the display name of the phone and then I said max number of calls to visit figure 1 and then I said the end user I haven't shown this but I have created also the end user via bulk maybe if you want I can put the soap request so that you guys could use it you know and yeah by the way I will put this soap requests or this collections in the github soon and I will let you know the links in my descriptions if you want you can come back and have a look and then here in the in the soap request I said okay allow CGI control or allow control of device from CTI as I did to true and then I have the owner user name that's important for licensing I said the variable will be own user and then the same way you go here manage environments Global's and then here you will say okay I just created already so I'm just using it again to show you guys you know so I had to practice before I could provided to you guys you know so device description we need it device name we need it we don't need alert to we don't need these variables because this was for creation of rdn so we are using deaf named deaf description line label line display the n4 pattern or the directory number and then line ask display for ASCII value and then the end user and own user so these are the variables that in environment variables or the global variables that we are going to use in our slope request for a bulk phone creation right okay so just let's just save it close it and then we are growing we are gonna create the same file like we created or the directory numbers so here we are gonna say I think we don't need all this information so we would have to see this what are the variables we are using but in def named def disk so def aim deaf description and then line label line display line label line display and then we have some more variables here so bien and then line ask display so DM climb ask display and then you have I guess end-user and own user right so end-user and own user variables so let's define those as well so end-user on user now let's just describe the device name so I will say CSF user 1 CSF user [Music] - CSF user 3 TS f user or ESF user wife so this is how the CSF device name and then description I will say okay CSF or jabber user 1 [Music] and then jabber user to I guess there was something intelligence happening around see here two three four five you know and then here you'll say user one user two three four five and then line display the same way you can just copy them here and then the DN would be five thousand one five thousand to five thousand three five thousand four five thousand five and then you could just copy the names again or your user if you want to or you could put in something different if you want and then end user is the user ID so I have created the user IDs like user one user two three four five Wow that's intelligence in the Excel all right then you can use the same and user IDs and then put it inside the own user variable and then just save either save it as a CSV file and then we will import this CSV file once you save the CSV file and open it again it should exactly look like this with the comma separated values you know if there is an issue the postman could not parse it and then it would create problems while you send the requests all right once this is done let's go to postman and let's add the phone in bulk so here we have the body of the request you know and here we have the authorization I said API user and the password is the same header that we are using and in the body inside the raw I just pasted the top request with the variables and then I will say run collections and then I will select what collections so I will say I think better own and then I will say not ad phone but ad phone in bulk is what I have created and then I will say import the pile or select File and then I will say add device CSF bulk and then here you see the data file type is text CSV and then iterations are five through web and it automatically understands that there are five bones that needs to be created and then you could preview your request and then you see here the values alright so it seems clear to me and there is no issues and once you have created it you could just say run and it's just you see here running five iterations and then voila we get 200 okay for each request and there was no problem in creating a request or sorry in sending a request and then creating the object inside the Cisco Unified Communications Manager database now let's see if we were successful in creating these five phones in just few seconds you just go to phone and then we go to find the device name where device name begins with CSF user will say so that we just see five phones that we are created and voila here you see we have yes F user two three one four and five let's see inside this user if the line was associated and if the ASCII names and the end user associations were right all right this floor up type is correct that we have used Cisco Unified Communications framework and the is the device name CSF user one is the description that we gave and this is the CSS that we assigned to the device Postman CSS and then we said owner user ID has to be user 1 and then it has taken cool seems interesting you know I excited when I'm talking and I'm at something saving efforts when doing the bulk creation you know at least I could suggest this to my other colleagues in level 1 and level 2 teams so that they could make use of this now so here you see the DN 5001 was associated with this phone this line was associated with the provisioning partition PT partition and the description is the alerting name that's correct and here you see that it's associated with the CSF user 1 and even we saw we said that allow control of device from CDI and there is a checkbox but that works that really works and that's really worth so you could also change these values for example a sign voicemail profile or whatever you want to even call forward settings and everything so it's really really handy and then here we said ok that should be the display name and then that should be the line text label user 1 Wow wonderful and then we said maximum number of calls to visit trigger 1 it has taken those values as well and then here we said ok associate it with this user 1 dot user so I mean user 1 and it has associated this with the user as well I think that was quick enough in if you practice and make a template you know and you could autumn eyes these stuffs it could really make your life easier and then you could are not spend I think just for creating at least you will need 5 minutes for creating one phone and and if there are five phones that you need to create you know it still if you do a copy and paste still you need to change lot of things description device name and let's say directory numbers and display names and all those stuffs so rather than doing those stuffs I think work smart you know make use of some automation steps stuffs that cisco has provided indirectly or directly and make life easier alright just let me know guys how was it I hope this would be useful at least introduce situation where customer has a lot of requirements coming in so that would be helpful to him as well and I guess you could make life easier work faster smarter and improve your knowledge about the technology on Cisco collaboration all right I thank you guys and we see us again in the next video where I'll be talking about you know I will be talking about how do you manually create the Cisco postman API requests and then we take it from there all right I thank you guys once again and see you next time until then thank you bye bye have a nice day

Channel: TrainCollab

Views: 1,467

Keywords: Jabber, Cisco UnifiedClientservicesFramework, CSF, AXL, API, SOAP, Development, Basics, Learn, POSTMAN, SOAPUI, Bulk Add Cisco Jabber, Bulk Provisioning, Learning, DevNet, IPPhone, Collaboration, Unified Communication, Automation, AI, Smart Work

Id: XRVzZZdgzvA

Length: 31min 12sec (1872 seconds)

Published: Sat Apr 11 2020