Skip to content

Commit 96d720a

Browse files
committed
updating readme
1 parent d7ea6c2 commit 96d720a

1 file changed

Lines changed: 60 additions & 0 deletions

File tree

README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,66 @@ ncs-netsim, It's a powerful tool to build a simulated network environment for Ne
4141

4242
netsim-wrapper, An open space to automate the ncs-netsim.
4343

44+
You can build your netsim network using JSON/YAML templates as follows
45+
46+
**creating device using YAML file**
47+
```
48+
nso-packages-path: ./nso-run/package
49+
download-neds: false
50+
neds:
51+
- https://earth.tail-f.com:8443/ncs-pkgs/cisco-ios/5.7.1/ncs-5.7.1-cisco-ios-6.79.signed.bin
52+
compile-neds: false
53+
packages-reload: false
54+
start-devices: true
55+
add-to-nso: true
56+
add-authgroup-to-nso: false
57+
authgroup:
58+
type: local
59+
path: ./custom_authgroup.xml
60+
device-mode:
61+
name-based:
62+
cisco-ios-cli-6.79:
63+
- device-ios0
64+
- device-ios1
65+
load-day0-config: false
66+
config-path: ../day0/
67+
config-files:
68+
- device_ios0_interface.cfg
69+
- device_ios1_interface.cfg
70+
```
71+
72+
**creating network using JSON format**
73+
```
74+
{
75+
"nso-packages-path": "./nso-run/packages",
76+
"download-neds": true,
77+
"neds": [
78+
"https://earth.tail-f.com:8443/ncs-pkgs/cisco-ios/5.7.1/ncs-5.7.1-cisco-ios-6.79.signed.bin"
79+
],
80+
"compile-neds": true,
81+
"packages-reload": true,
82+
"start-devices": true,
83+
"add-to-nso": true,
84+
"add-authgroup-to-nso": true,
85+
"authgroup": {
86+
"type": "system"
87+
},
88+
"device-mode": {
89+
"prefix-based": {
90+
"cisco-ios-cli-6.79": {
91+
"count": 2,
92+
"prefix": "network-ios"
93+
}
94+
}
95+
},
96+
"load-day0-config": true,
97+
"config-path": "./day0/",
98+
"config-files": [
99+
"network_ios0_interface.cfg",
100+
"network_ios1_interface.cfg"
101+
]
102+
}
103+
```
44104
## Pre-requisites
45105

46106
- ncs-netsim command must be reconginsed by the terminal.

0 commit comments

Comments
 (0)