OpenNMS 101 - Module 2: Getting Started Video Lecture | A Complete Guide: OpenNMS - IT & Software

hello and welcome to another episode of
open an - 101
my name is Taurus Balog I'm one of the
maintainer of the abundance project and
in this lesson we're going to get
started with using open an MS I'm
assuming by this point you have actually
installed over the MS using one of the
other videos or the documentation and so
you should be looking at a screen that
looks something like this now this is
from Meridian we're actually going to be
playing with horizon through a lot of
this but there's no real material
differences between the two screens now
the open Internet Dewie I like it I mean
I've been using it for over a decade so
I'm pretty comfortable with navigating
through it but it hasn't changed
considerably much in the last 15 years a
part of that reason is the the
commercial side of open and amenity open
minimis group we often have customers
who will pay us to makeover the much
more powerful but we rarely have
customers who will come through and pay
us to make it easy to use in fact a lot
of our bigger customers rely on the rest
interface to do a lot of work and open
an MS and they only come to the GUI when
there is something wrong that may be
diagnosed so what we're going to do here
though is give you a little overview and
since I'm letting you reduce your class
I put up slides but since we're doing
the magic video I'm just going to switch
over here to a to a live instance of
opening a mess now you can see this has
the green color scheme which is our
horizon color scheme and there are a few
slight differences but mainly this is
the page once you log in and again art
our top-secret login is admin admin and
it's on port 80 nine eighty of your open
MS server assuming you can reach it to
the firewall you should be able to get
to port 80 nine eighty and you login
with admin and when you'll see this page
now here on the left side of the screen
are four sections that is kind of like
your to-do list so those are pending
problems or modes with alarms notes with
outages are nodes that have
detected that a particular service on
those nodes is down we have a business
service in an application section these
are things you can create with it open
in a mess so you can instead of looking
at particular devices which is kind of
the focus of the first two you can
actually look at things like business
services and applications that you are
providing on the network
now this middle section here is called
the near of the real real-time console
but more appropriately should be called
the near ton console it gets updated
about every two minutes so if I mouse
over this you can see the little pop-up
says updated Friday January 13th at
11:16 and you can see up here that the
time is 11 17 and so there will be a
little bit of a difference while this
gets updated but basically is this is
based upon outages and it can tell you
you can group things together and you
can see the overall the overall status
of the network and give you kind of a
visual indication we set up these
default categories to begin with but
I've been in places where we've set up
categories based upon vendor we set up
categories based upon location etc and
in a future lesson we'll cover that now
here on the right side of the screen you
have notifications window we will be
talking in a couple of lessons about
notifications and this gives you kind of
a glance there's a quick search for
resource graphs so you can bring up
quickly bring up any of the performance
graphs that we're creating we have this
thing called KSC reports which stands
for key SMT custom reports actually this
is one of the first features ever
contributed by an outside party and the
person worked at Kennedy Space Center so
all the code had KSC this KSC that and I
said hey can I call this thing Kennedy
Space Center reports and they said no so
we came up with the kind of quasi
acronym key SP custom reports and this
allows you to group separate performance
reports on the one page to make it very
easy to to get there and again we'll
have a lesson on that as well and then
there's a little quick search button
now there's lots of little menu items
here you can do searches you can look at
nodes assets you can look at status you
can generate reports we have dashboards
Maps through the through the future
lessons we were able to cover most of
this what I want to focus right now is
on this admin menu as you can see if you
click on admin menu there's this menu
called configure open NMS I'm going to
go ahead and click on it this is only
available to admin level users and as
you can see there's quite a bit of
options here I showed you on on the
installation video one of the things is
this menu item at the very bottom called
data choices this does the this is how
you change whether you opt in or opt out
to our statistics so we've probably seen
that before if you've watched other
videos but this is basic administrative
actions now in the battle days you did
almost all configurations through the
command line you would hand edit XML
files as over the Misses groan you can
do a lot more through the web user
interface and we're going to be spending
a lot of time here but remember this is
only available to to admin level users
now since admin admin is is kind of a
bad thing to have the first thing we do
is go and change the admin password so
that's fairly easy go up under admin hit
change password bring you up to this
user account fell to self-service menu
hit change password again and I'm going
to change the password to something
totally not admin so I had my first
password and then new password new
password confirm and I hit submit and
that will have changed my password so
now no one can login with admin and
let's enter the password now I strongly
recommend that no one log in as the
admin user when we talk about
notifications in a couple of lessons
when we send a notification consent to a
particular user that user has the
ability to acknowledge the notification
their username will be associated with
it now if everyone's using the admin
account and you have a whole bunch of
people acknowledging notifications as
admin well it's hard to audit you don't
really know who did it so I strongly
recommend that you create individual
users and let them log in as themselves
and for those users who need admin
access you can grant it to them so we're
going to do that right now
so if I go to admin in the configuration
menu you'll see configure users groups
and on-call roles it's the second piece
right here I'm going to click on that
then I'm going to click on configure
users and here are my users I only have
the admin user by default we strongly
recommend you don't delete the admin
user it is referenced in another places
I do believe if you really wanted to you
could get rid of admin and it wouldn't
hurt anything it's just I would just
change the password to something that no
one can easily remember don't tell
anybody and have everyone log in as
themselves so I want to click on this
button says add new user and it will
bring up its dialog I'm going to put my
name I like using the same username that
I use blogging to everything else which
APIs qataris and I will put in a
password and I will confirm the password
and I will hit OK now this will bring me
to a different screen and I haven't
created these yet I want to stress I
have to go down to the very bottom here
and click finish
once I've click finish that the user
will be added so don't navigate away
from this page before you've gone ahead
and click finish
so I will put my name in here Torres
Balog put some kind of comment and now
the rest of this information is used for
various notification services with an
open NMS for the purposes of this
training I'm going to put root at
localhost as my email address this will
send mail to the open an image server
itself and I can use command line mail
to look at it but if you're open an MS
servers already set up to
that's mail properly you could put
whatever your email address your real
email address is here but for the
purposes of the class I'm just going to
leave you to localize now email would be
an individual's email pager email would
be an email address that sends an SMS or
text so if I go to let's say if I did
nine one nine five five five one two one
two
at txt apt net if I actually put my real
phone number in here and I send an email
to my phone number at txt att.net I
would end up getting a SMS message a
text message to my phone now that works
great unless the networks down and so
you may want to set up some sort of
external paging system we have a ton of
other services that we will talk about
you can send an XMPP message which is
kind of like a jabber message a pop up
you could micro blog you can actually
tweet your your your set up we have an
integration with asterisks which is open
in MX PBS we're opening that's will
phone you and actually call you call
your phone and then speak the
notifications so there's lots and lots
of different ways to integrate here and
we don't actually use that quite a bit
in the fourth chapter which is where we
talk about notifications and then at the
very bottom here are this is a thing
called duty schedules by default what
you get a notification it will get sent
you period you're on duty basically 24
hours 24/7 but I can add a schedule and
then say well I only want to be notified
Monday to the winds be Thursday and
Friday from oh nine hundred hours to
1700 hours
which is nine to five and if I do that I
will only get notified during this time
I'm going to go ahead and delete that
because I wanna get notified all the
times but just letting minutes there so
I've added my name will comment female
ruler close and I'm going to go ahead
and finish this now and so now I have
two users now we're going to do a little
exercise so I'm going to get back to my
slides so we're going to we're going to
create our new user now we're going to
add the user the next step is we're
going to add the user to the admin group
now this does not make the user and
admin it just so happens that by the
users and groups and configured groups
you'll see that we have this admin group
and it just so happens that the default
notifications and everything set up with
opening ms is to email the admin group
so I want to add myself to this group so
I get them it does not make me an admin
I could have named this group the fubar
group and it would have worked as far
but we've got the scripts called the
admin group now so I'm going to click on
me and add me here now you notice this
move up move down section this new up
move down section is the order in which
people get notified now by default
everyone if I send a notification to a
group everyone in the group gets
notified but it is possible for me to
put in a delay and if I have like a one
minute delay or a 10 minute delay that
means I want to contact the first member
of the group I'm going to wait then the
second number of wait third member wait
etc and I want to make sure I'm always
last because I want someone else to get
the notice deployed because that's just
way now this over here in the corner is
these categories when we'll talk about
these later on categories are a way of
grouping different devices and the open
a mystery does have a basic access
control list feature which will allow
you to display just the devices that are
interested in to just the devices that
are interesting to a particular person
and so we have on
as you see here we have routers switches
servers so if I had a network guy who's
only interested in the routers group I
could add this group to his overall
group and if that happens then he would
only see devices that were in the
routers category now admin users get to
see everything and so I want to make
myself an admin user so I'm not going to
deal with this right now
and notice that groups themselves have
busy schedules and we're going to talk
about busy schedules and groups in the
notification section they made slightly
differently than then for individual
users but so you can have duty schedules
for users you can have these scheduler
poops
anyway the purpose of this screen is to
move my newly created torus user into
the end in group and I'll hit finish now
getting back to our exercise logout so
we'll go ahead and log out admin log out
and I'm going to login me now I've
logged in on me I'm in the admin group
but if I go to the menu item over here
you'll see that I don't have a
configuration maybe I can go to the help
sport page I can change my password I
log out that's all I can do because I am
not yet an admin user so let's talk
about what it takes to be attending user
um I'm going to go and edit a file on
the system so this is my this is a shell
to my VM running open in a mask for
training and I'm going to switch to opt
of an event et Cie this is running on
CentOS 7 if you were on Debian you would
want users share open in the mess et Cie
which is a sibling to ET c /a up into
the mess so I'm going to go here and you
can see there's tons of configuration
files there are two types there's XML
files and which property files in this
case I'm going to edit a property file
called magic users dot properties let me
get out of here and we shall clear it so
that everyone can see so we're going to
edit magic easier Scott
prodigies now I like them because it
does syntax checking I need to set this
up to use the dark background so I'm
going to set back equals dark just so we
can see and I'm going to go down here to
this section we have in this section
controls what we call rolls and they're
a number of different roles within the
user interface in the application itself
and what we want to do is we want to
associate our new user in my case the
new tarus user with an administrator so
I'm going to find this section here that
says role dot admin users you'll see
currently right now this section right
here you'll see that it only has admin
in it
and I'm going to go and add my username
and that's all it takes
once I put my username here I'll be in
admin user and we'll talk about some of
these other different things in the
future um one of the things I like is
there's a read-only user which is kind
of be pointy-haired boss user if you
have someone who needs access to open an
MS but you don't necessarily want them
acknowledging alarms or notifications or
anything like that you just kind of want
them to be able to see the status of the
network and to generally reports you can
make them a read-only user by putting
their user name here and it will prevent
them from doing this things let me save
that file switch back over to a web UI
and I'm going to go ahead and log out
like out and I'll log back in and now I
want to login you'll see I have open in
the configure open and if I have admin
access to the GUI and that's it so
that's getting started with opening the
master so you should now have open in
the MIS installed you should have access
to the GUI and you should have an admin
user under your name
let's not admin and so tell people to
totally forget the admin user password
now get back to through the slides just
kind of review what we did first of all
we need to be aware of where the opening
is
are located binary files or the opto
business bin directory remember if
you're on a Debian based distro you want
to substitute opt for user share so
it'll be use your share open an immense
being too optimistic we don't we run a
few files in bin but we don't spend much
time there we do spend a lot of time in
the Etsy directory which is where the
configuration file is the jetty web app
subdirectory is where the web server is
it's the root of the web server the Lib
directory contains all the jar files the
compiled libraries from Java the shared
directory is where reports are generated
and there's all the performance data is
stored there and then finally the logs
directory is where the log files are
stored she talks to files their XML
files XML files are very much like um
HTML at the market language I don't know
if you've if you guys remember but let's
go ahead and let me just look at let me
just edit vou food HTML and again I'm
going to do that whole set right article
start so if you've ever written your own
web page you've probably done something
like okay so you start out with an HTML
tag and then you might have a title and
you know this is my title and you end it
with a these are all called tags so this
is an HTML tag this is a title tag and
this is a closing tag it's basically the
same tag but with a slash in front of it
and that tells you that's the end of
this markup and then I might have a body
tag I should probably start like an
addicting this body has sorts of spaces
unless you guys deal back then I have a
paragraph you know this is my first
paragraph
I might close it and then I might close
body tag and then I might close the HTML
tag all right there is a basic HTML page
you know create a disappointing on page
notice that these things have to match I
have a HTML tag active a closing HTML
tag etc XML is very very similar to this
but instead of being a standard like
HTML XML lets you make up your own
markup structure and so we will end up
going through a lot of that moving
forward now the property files are
[Music]
variable equal value and it's just text
so you have a variable name that won't
have any spaces an equal sign and then
you can have anything else you have
spaces its delimited by character turn
so if you need to span multiple lines
you want to put a line continuation
character at the end of it again this
will become clear as we move forward but
I didn't want to tell you that the two
basic types of configuration files we're
going to deal with or XML files where
the syntax is very important and
properties files where the syntax is a
little looser the downside is it's a lot
harder to check for errors and
properties files and xml files now we
added the user we went to our admin
users and groups
I added my tarush user I set up my main
and comment I set my email for the
purposes of training to be root at
localhost of course this is where you'd
want to put a real email address you
have duty schedules duty schedules can
overlap in this case we have the 9 to 5
the 7 to 7 duty schedules the first one
Monday through Friday but then I added
the second one which went from 0 to 23
59 and made that 7 days that's as if I
had no duty schedule at all because I
would everything will match that in the
old days this is one way we manage on
call so basically what would happen
would be the on-call guy everyone would
be on call from 7 to 7 so they have this
duty schedule but the on-call guy would
be 24 hours so the manager would come in
add this duty schedule on Monday and
then the next Monday they believe it
to another person remember it took
finish again you go in you use once that
dialogue closes it seems intuitive that
you're done but you're not until you
click finish you will not create your
user now we added our user to our group
so we went in clicked on users and
groups we headed admin group we moved me
into the admin group we talked a bit
about categories you can assign if you
want to use ACLs you need to assign
devices to categories and then assign
categories to groups and that will limit
what you just in those groups can see
groups have duty schedules as well and
we talked about the magic users done
property file anyway that is it for this
lesson of open s 101 in the next lesson
we're going to talk about events so
we're going to actually start doing
stuff but feel free to poke around in
the web UI and play with it have fun I
mean I'm on network management so I
really enjoy doing stuff like this so I
hope you are too
feel free to put around and I look
forward to seeing you next time