guides:user:getting_started
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
guides:user:getting_started [2021/01/14 11:04] – jkuiterman | guides:user:getting_started [2024/07/03 12:31] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | {{indexmenu_n> | ||
+ | ====== Getting started ====== | ||
+ | |||
+ | **Great**, you've downloaded the NetYCE VM and welcome to our automation framework. | ||
+ | |||
+ | //(It is assumed you've installed the VM and are able to access it using the browser. If not the case, please check out the [[maintenance: | ||
+ | |||
+ | This guide will explain how to start with NetYCE. First we will make sure you can change the necessary settings to communicate to your nodes, adding those after which we will dive into jobs and templates. | ||
+ | |||
+ | The modeling around this has already been done. This is in the '' | ||
+ | |||
+ | |||
+ | ===== Spreadsheet ===== | ||
+ | In order to manipulate the database of NetYCE easily, a spreadsheet can be used instead of writing API calls yourself. This provides an easy/lazy way to call the API, called the CSV API. A spreadsheet has been created as a template. The next chapters will use the contents of this spreadsheet. | ||
+ | |||
+ | Download: {{ : | ||
+ | |||
+ | Download: {{ : | ||
+ | |||
+ | __Color coding__ \\ | ||
+ | <color # | ||
+ | <color # | ||
+ | |||
+ | ===== CSV API ===== | ||
+ | |||
+ | The CSV API can be found at '' | ||
+ | |||
+ | The downloaded spreadsheet already has the correct syntax which can be copied into the text area. There is no need to provide commas or delimiters yourself, this is automatically understood by the tool. | ||
+ | |||
+ | Each line will be an action. You may provide as many lines as desired. | ||
+ | |||
+ | Copy the desired lines into the text form and press next. An overview is given for the lines found and will show which variable has been assigned which value. Press next to continue and adding the information. | ||
+ | |||
+ | {{ guides: | ||
+ | |||
+ | But first, let's fill the sheet with information. | ||
+ | |||
+ | ===== Changing credentials ===== | ||
+ | Let us set the username, password and an enable password before we add nodes. These credentials will be used to communicate with the devices. | ||
+ | |||
+ | The credentials are stored in the '' | ||
+ | |||
+ | This spreadsheet can be used to modify the information, | ||
+ | |||
+ | To do so, open '' | ||
+ | |||
+ | {{guides: | ||
+ | |||
+ | ==== Adding nodes ==== | ||
+ | Adding nodes to the NetYCE database is just as easy. Make sure all green columns are filled with your variables and the lines into the CSV API. | ||
+ | |||
+ | __Nodename__ \\ | ||
+ | This will be the hostname of the node. | ||
+ | |||
+ | __Vendor_type__ \\ | ||
+ | This will be the vendor of the node, specifically mentioning the family if needed. A few example, which are also shown as comments in the spreadsheet: | ||
+ | |||
+ | * Cisco_IOS | ||
+ | * Cisco_XE | ||
+ | * Cisco_XR | ||
+ | * HP_C7 | ||
+ | * Huawei_S | ||
+ | * Junos | ||
+ | |||
+ | If you are missing a specific vendor, please let us know and we'll make sure you are able to continue to test/use our product. | ||
+ | |||
+ | __mgmtip__ \\ | ||
+ | Provide the IP that you wish to assign to the node. | ||
+ | |||
+ | ===== Deleting nodes ===== | ||
+ | Deleting any node can be done using the GUI as well as the API. To use it from the GUI, go to '' | ||
+ | |||
+ | **NOTE** Deleting the node only, will not delete the linked '' | ||
+ | {{guides: | ||
+ | |||
+ | Using the API is as easy as pasting the line from the spreadsheet using the desired hostname. | ||
+ | |||
+ | ===== Jobs ===== | ||
+ | Jobs are short for '' | ||
+ | |||
+ | Here you can type the hostname directly to add it to the list, or use the clientcode to drill down. Make sure that at least one node is added to the list and go to the next page. | ||
+ | |||
+ | {{guides: | ||
+ | |||
+ | Here you'll see the following: | ||
+ | * a list of nodes, which also shows the Vendor and family | ||
+ | * a list of saved jobs | ||
+ | * a commands section | ||
+ | * a scenario section | ||
+ | * the scheduler section | ||
+ | |||
+ | To push a //simple// configuration change, you just have to do the following: | ||
+ | - Select the desired node | ||
+ | - fill the desired command(s) in the commands section | ||
+ | - Schedule the task using a date and time or select now | ||
+ | - press schedule | ||
+ | |||
+ | {{guides: | ||
+ | |||
+ | There is no need to worry about if you need to enter the enable or configuration mode or such. This is done for you within our vendor module(s). Of course, the username/ | ||
+ | |||
+ | ===== Templates ===== | ||
+ | Templates can be used in several ways. A few examples: | ||
+ | * To build a tree of templates to generate the complete configuration | ||
+ | * As part of jobs to be vendor agnostic, simplicity and re-usability | ||
+ | * To parse information that is read from the device using show commands or reading the complete configuration, | ||
+ | |||
+ | ==== A vendor agnostic example explained ==== | ||
+ | Per vendor/ | ||
+ | |||
+ | This way you have the capability to send out the same job to multiple nodes of different vendors/ | ||
+ | |||
+ | An NTP sub template is provided as an example for Cisco_IOS | ||
+ | |||
+ | {{guides: | ||
+ | |||
+ | {{guides: | ||
+ | |||
+ | ==== Template examples ==== | ||
+ | For several vendors the ' | ||
+ | |||
+ | ==== Template in jobs ==== | ||
+ | Templates can be called from within jobs or other templates and it looks like this: \\ | ||
+ | '' | ||
+ | where NTP is the template name. | ||
+ | |||
+ | |||
+ | An example has been added to the stored jobs, called ' | ||
+ | |||
+ | {{guides: |