Skip to content
This repository was archived by the owner on Nov 15, 2024. It is now read-only.

Commit 34cd684

Browse files
jtdubjtdub
authored
Merge pull request #17 from netdevops/user
move netnir setup user to netnir user
2 parents b2b6243 + 285afd9 commit 34cd684

15 files changed

Lines changed: 401 additions & 395 deletions

File tree

‎docs/_mkdocs/quickstart/commands.rst‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
.. _commands:
2+
3+
custom netnir commands
4+
======================
5+
6+
Creating custom netnir commands is simple. The first thing that you do is create an installable python package with a class
7+
that follows the following format:
8+
9+
.. code:: python
10+
11+
class Plugin:
12+
def __init__(self, args):
13+
self.args = args
14+
15+
@staticmethod
16+
def parser(parser):
17+
parser.add_argument('--some-arg')
18+
19+
def run(self):
20+
return self.args.some-arg
21+
22+
An example of this is:
23+
24+
.. code:: bash
25+
26+
$ cat setup.py
27+
#!/usr/bin/env python3
28+
29+
import setuptools
30+
31+
setuptools.setup(
32+
name="example netnir plugin",
33+
packages=['netnir_plugin']
34+
)
35+
36+
$ cat netnir_plugin/__init__.py
37+
from netnir.helpers.common.args import filter_host
38+
39+
class ExamplePlugin:
40+
41+
def __init__(self, args):
42+
self.args = args
43+
44+
@staticmethod
45+
def parser(parser):
46+
parser.add_argument("--print", help="print something to the screen")
47+
filter_host(parser)
48+
49+
def run(self):
50+
if self.args.host:
51+
return self.args.host
52+
elif self.args.print:
53+
return self.args.print
54+
else:
55+
return "nothing to print"
56+
57+
$ python
58+
Python 3.8.1 (v3.8.1:1b293b6006, Dec 18 2019, 14:08:53)
59+
[Clang 6.0 (clang-600.0.57)] on darwin
60+
Type "help", "copyright", "credits" or "license" for more information.
61+
>>> import netnir_plugin
62+
63+
Once that is done, you can modify the *netnir.yaml* to add the plugin in the *plugins* section.
64+
65+
.. code:: bash
66+
67+
$ cat netnir.yaml
68+
</omitted>
69+
plugins:
70+
</omitted>
71+
example:
72+
class: netnir_plugin.ExamplePlugin
73+
description: example netnir plugin
74+
75+
Then execute netnir.
76+
77+
.. code:: bash
78+
79+
$ netnir -h
80+
usage: netnir [-h] [--version] {cp,fetch,inventory,setup,ssh,example} ...
81+
82+
optional arguments:
83+
-h, --help show this help message and exit
84+
--version display version
85+
86+
netnir commands:
87+
{cp,fetch,inventory,setup,ssh,example}
88+
cp config plan commands
89+
fetch fetch commands
90+
inventory inventory search command
91+
setup netnir setup commands
92+
ssh command and config execution over SSH
93+
example example netnir plugin
94+
95+
$ netnir example -h
96+
usage: netnir example [-h] [--print PRINT] [--host HOST]
97+
98+
example netnir plugin
99+
100+
optional arguments:
101+
-h, --help show this help message and exit
102+
--print PRINT print something to the screen
103+
--host HOST specify a specific host
104+
105+
$ netnir example --host router.dc1
106+
'router.dc1'
107+
$ netnir example --print 'some message'
108+
'some message'

‎docs/_mkdocs/quickstart/configure.rst‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
.. _configure:
2+
3+
configuring netnir
4+
==================
5+
6+
Initialize netnir to create the basic configuration and directory structure. For the purpose of the demonstration,
7+
I'll utilize an always on device from `Cisco's DevNet Sandbox <https://devnetsandbox.cisco.com/RM/Topology>`_.
8+
9+
.. code:: bash
10+
11+
$ netnir
12+
WARNING:root:netnir config doesn't exist. creating defaults.
13+
WARNING:root:creating directory ./host_vars
14+
WARNING:root:creating directory ./group_vars
15+
WARNING:root:creating directory ./templates
16+
WARNING:root:creating directory ./output
17+
WARNING:root:creating directory ./conf/hier
18+
WARNING:root:creating netnir.yaml config
19+
WARNING:root:creating ./conf/nornir.yaml config
20+
WARNING:root:loading config_file config
21+
netnir username: admin
22+
netnir network authentication password:
23+
netnir network authentication confirm passowrd:
24+
error: too few commands
25+
usage: netnir [-h] [--version] {cp,fetch,inventory,netconf,user,ssh} ...
26+
27+
optional arguments:
28+
-h, --help show this help message and exit
29+
--version display version
30+
31+
netnir commands:
32+
{cp,fetch,inventory,netconf,user,ssh}
33+
cp config plan commands
34+
fetch fetch commands
35+
inventory inventory search command
36+
netconf commands and config execution over NETCONF
37+
user netnir user commands
38+
ssh command and config execution over SSH
39+
40+
Once the configuration and directory structure is initialized. You can modify the configuration and add hosts to suit your environment.
41+
In the **netnir.yaml** file, you'll want to change the **domain:** flag from *example.net* to a domain that is appropriate to your
42+
environment. Since this example uses Cisco's DevNet Sandbox, I'll set it to *cisco.com*. I'll leave the remainder of the
43+
config default.
44+
45+
.. code:: bash
46+
47+
$ cat netnir.yaml
48+
directories:
49+
groupvars: ./group_vars
50+
hier: ./conf/hier
51+
hostvars: ./host_vars
52+
output: ./output
53+
templates: ./templates
54+
domain: cisco.com
55+
nornir:
56+
config: ./conf/nornir.yaml
57+
plugins:
58+
cp:
59+
class: netnir.core.tasks.config_plan.ConfigPlan
60+
description: config plan commands
61+
fetch:
62+
class: netnir.core.tasks.fetch.Fetch
63+
description: fetch commands
64+
inventory:
65+
class: netnir.core.tasks.inventory.Inventory
66+
description: inventory search command
67+
setup:
68+
class: netnir.core.tasks.setup.Setup
69+
description: netnir setup commands
70+
ssh:
71+
class: netnir.core.tasks.ssh.Ssh
72+
description: command and config execution over SSH
73+
74+
Next we'll add a host in the **host_vars** folder.
75+
76+
.. code:: bash
77+
78+
$ ls host_vars/
79+
sbx-iosxr-mgmt
80+
$ cat host_vars/sbx-iosxr-mgmt
81+
os: iosxr
82+
port: 8181
83+
provider: cisco
84+
85+
The *os* and *provider* key / value pairs are the only required values for a given host. By default the port will be set to *22*,
86+
unless it's specifically set in the host variables.
87+
88+
You can check that netnir sees the device in inventory by executing the inventory command.
89+
90+
.. code:: bash
91+
92+
$ netnir inventory
93+
netnir username: admin
94+
{'groups': {}, 'hosts': {'sbx-iosxr-mgmt': Host: sbx-iosxr-mgmt}}
95+
96+
The first time that you run netnir, it will ask you for a username and password, which it will securely store in a keyring locally on
97+
your computer. The username will be stored in a file at ~/.netniruser, which netnir will read to fetch the password from the keyring.
98+
You can also use the environment variables *NETNIR_USER* for netnir to fetch the username from.
99+
100+
Example:
101+
102+
.. code:: bash
103+
104+
$ export NETNIR_USER=admin

‎docs/_mkdocs/quickstart/execute.rst‎

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
.. _execute:
2+
3+
executing netnir commands
4+
=========================
5+
6+
Using the built in netnir plugins is easy. For example, if you want to fetch the production config from a device, use the *fetch config* command.
7+
8+
.. code:: bash
9+
10+
$ netnir fetch config
11+
netmiko_send_command************************************************************
12+
* sbx-iosxr-mgmt ** changed : False ********************************************
13+
vvvv netmiko_send_command ** changed : False vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv INFO
14+
15+
Wed Jul 29 23:31:56.177 UTC
16+
Building configuration...
17+
!! IOS XR Configuration version = 6.5.3
18+
!! Last configuration change at Wed Jul 29 23:29:39 2020 by admin
19+
!
20+
hostname iosxr1
21+
domain name abc.inc
22+
username admin
23+
group root-lr
24+
group cisco-support
25+
secret 5 $1$oN8e$ft916PCBogrqPKt59kepW0
26+
!
27+
tpa
28+
vrf default
29+
address-family ipv4
30+
default-route mgmt
31+
!
32+
!
33+
!
34+
line console
35+
exec-timeout 0 0
36+
absolute-timeout 0
37+
session-timeout 0
38+
!
39+
line default
40+
exec-timeout 0 0
41+
absolute-timeout 0
42+
session-timeout 0
43+
transport input ssh
44+
!
45+
call-home
46+
service active
47+
contact smart-licensing
48+
profile CiscoTAC-1
49+
active
50+
destination transport-method http
51+
!
52+
!
53+
interface Loopback100
54+
description ***MERGE LOOPBACK 100****
55+
ipv4 address 1.1.1.100 255.255.255.255
56+
!
57+
interface Loopback200
58+
description ***MERGE LOOPBACK 200****
59+
ipv4 address 1.1.1.200 255.255.255.255
60+
!
61+
interface MgmtEth0/RP0/CPU0/0
62+
ipv4 address 10.10.20.175 255.255.255.0
63+
!
64+
interface GigabitEthernet0/0/0/1
65+
shutdown
66+
!
67+
interface GigabitEthernet0/0/0/2
68+
shutdown
69+
!
70+
interface GigabitEthernet0/0/0/3
71+
shutdown
72+
!
73+
interface GigabitEthernet0/0/0/4
74+
shutdown
75+
!
76+
interface GigabitEthernet0/0/0/5
77+
shutdown
78+
!
79+
interface GigabitEthernet0/0/0/6
80+
shutdown
81+
!
82+
router static
83+
address-family ipv4 unicast
84+
0.0.0.0/0 10.10.20.254
85+
!
86+
!
87+
mpls ldp
88+
address-family ipv4
89+
!
90+
interface GigabitEthernet0/0/0/0
91+
address-family ipv4
92+
!
93+
!
94+
!
95+
xml agent tty
96+
iteration off
97+
!
98+
netconf agent tty
99+
!
100+
netconf-yang agent
101+
ssh
102+
!
103+
ssh server v2
104+
ssh server vrf default
105+
ssh server netconf vrf default
106+
end
107+
108+
^^^^ END netmiko_send_command ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
109+
110+
If you want to interact or make changes with a device via SSH, use the *ssh* command.
111+
112+
.. code:: bash
113+
114+
$ netnir ssh -c 'show platform' -c 'show route'
115+
netmiko_send_command************************************************************
116+
* sbx-iosxr-mgmt ** changed : False ********************************************
117+
vvvv netmiko_send_command ** changed : False vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv INFO
118+
119+
Wed Jul 29 23:39:09.731 UTC
120+
Node Type State Config state
121+
--------------------------------------------------------------------------------
122+
0/0/CPU0 R-IOSXRV9000-LC-C IOS XR RUN NSHUT
123+
0/RP0/CPU0 R-IOSXRV9000-RP-C(Active) IOS XR RUN NSHUT
124+
^^^^ END netmiko_send_command ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
125+
netmiko_send_command************************************************************
126+
* sbx-iosxr-mgmt ** changed : False ********************************************
127+
vvvv netmiko_send_command ** changed : False vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv INFO
128+
CPU0:iosxr1#
129+
130+
RP/0/RP0/CPU0:iosxr1#show route
131+
132+
Wed Jul 29 23:39:10.855 UTC
133+
134+
^^^^ END netmiko_send_command ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
135+
[{'sbx-iosxr-mgmt': MultiResult: [Result: "netmiko_send_command"]},
136+
{'sbx-iosxr-mgmt': MultiResult: [Result: "netmiko_send_command"]}]
137+
138+
$ netnir ssh -c 'route-policy NETNIR-TEST' -c 'end' --config
139+
{'sbx-iosxr-mgmt': MultiResult: [Result: "netmiko_send_config"]}
140+
$ netnir ssh -c 'show rpl route-policy NETNIR-TEST'
141+
netmiko_send_command************************************************************
142+
* sbx-iosxr-mgmt ** changed : False ********************************************
143+
vvvv netmiko_send_command ** changed : False vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv INFO
144+
145+
Wed Jul 29 23:43:37.092 UTC
146+
route-policy NETNIR-TEST
147+
end-set
148+
149+
^^^^ END netmiko_send_command ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
150+
[{'sbx-iosxr-mgmt': MultiResult: [Result: "netmiko_send_command"]}]

‎docs/_mkdocs/quickstart/install.rst‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
.. _install:
2+
3+
installing netnir
4+
==================
5+
6+
There are two ways to install netnir.
7+
8+
*installing the python package via pip:*
9+
10+
.. code:: bash
11+
12+
$ pip install netnir
13+
14+
*installing the package from github:*
15+
16+
.. code:: bash
17+
18+
$ git clone git@github.com:netdevops/netnir.git
19+
$ cd netnir; ./setup.py install

0 commit comments

Comments
 (0)