Juniper Junos Snapshot Administrator (SLAX) Admin Guide

Juniper
Brand
Juniper
Model
Junos Snapshot Administrator (SLAX)
Type
Admin Guide
Junos Snapshot Administrator Guide
Published
2021-04-22
Juniper Networks, Inc.
1133 Innovaon Way
Sunnyvale, California 94089
USA
408-745-2000
www.juniper.net
Juniper Networks, the Juniper Networks logo, Juniper, and Junos are registered trademarks of Juniper Networks, Inc.
in the United States and other countries. All other trademarks, service marks, registered marks, or registered service
marks are the property of their respecve owners.
Juniper Networks assumes no responsibility for any inaccuracies in this document. Juniper Networks reserves the right
to change, modify, transfer, or otherwise revise this publicaon without noce.
Junos Snapshot Administrator Guide
Copyright © 2021 Juniper Networks, Inc. All rights reserved.
The informaon in this document is current as of the date on the tle page.
YEAR 2000 NOTICE
Juniper Networks hardware and soware products are Year 2000 compliant. Junos OS has no known me-related
limitaons through the year 2038. However, the NTP applicaon is known to have some diculty in the year 2036.
END USER LICENSE AGREEMENT
The Juniper Networks product that is the subject of this technical documentaon consists of (or is intended for use
with) Juniper Networks soware. Use of such soware is subject to the terms and condions of the End User License
Agreement ("EULA") posted at hps://support.juniper.net/support/eula/. By downloading, installing or using such
soware, you agree to the terms and condions of that EULA.
ii
Table of Contents
About This Guide | v
1
Junos Snapshot Administrator Overview
Junos Snapshot Administrator Overview | 2
2
Installing Junos Snapshot Administrator
Installing Junos Snapshot Administrator | 4
Installing Junos Snapshot Administrator | 4
Sasfying Requirements for SSHv2 Connecons | 5
3
Junos Snapshot Administrator Conguraon File
Junos Snapshot Administrator Conguraon File | 8
Understanding the Junos Snapshot Administrator Conguraon File | 8
Example: Creang the Junos Snapshot Administrator Conguraon File | 13
Requirements | 13
Overview | 13
Conguraon | 15
Understanding Junos Snapshot Administrator Reference Variables | 18
4
Junos Snapshot Administrator Test Operators
Understanding Junos Snapshot Administrator Test Operators | 22
Junos Snapshot Administrator Test Operators Summary | 25
all-same operator | 27
contains operator | 30
delta operator | 32
exists operator | 35
in-range operator | 36
is-equal operator | 39
iii
is-gt operator | 41
is-in operator | 43
is-lt operator | 45
list-not-less operator | 47
list-not more operator | 49
no-di operator | 51
not-equal operator | 53
not-exists operator | 55
not-in operator | 57
not-range operator | 59
5
Using Junos Snapshot Administrator
Using Junos Snapshot Administrator | 63
How to Take a Snapshot | 63
How to Compare Two Snapshots | 64
How to Take and Evaluate a Snapshot | 66
iv
About This Guide
Use this guide to capture and audit runme environment snapshots of your networked devices running
Junos OS using conguraon les wrien in SLAX.
RELATED DOCUMENTATION
Junos Snapshot Administrator Soware
v
1
CHAPTER
Junos Snapshot Administrator
Overview
Junos Snapshot Administrator Overview | 2
Junos Snapshot Administrator Overview
Junos® Snapshot enables you to capture and audit runme environment snapshots of your networked
devices running the Junos operang system (Junos OS). You can capture and validate the operaonal
status of a device and review operaonal changes to a device. You create conguraon les that dene
the scope of snapshots and customize the evaluaon criteria for the snapshot data.
Junos Snapshot Administrator can perform the following funcons on either a single device or list of
devices running Junos OS:
• Take a snapshot of the runme environment on a device.
• Compare two snapshots.
• Audit a device’s runme environment against pre-dened criteria.
For example, prior to a soware or hardware upgrade on a device, you can take a pre-install and post-
install snapshot of the device and then compare the two snapshots. You can then review the operaonal
changes on the device and validate these changes from a list of expected changes.
To be successful in using Junos Snapshot Administrator, you need a basic understanding of Junos OS
operaonal mode command
output in an XML format. You also need familiarity with XPath expressions.
For more informaon about the Junos XML structure and XPath expressions, see the Juniper Networks
Day One book
Navigang the Junos XML Hierarchy
at hps://www.juniper.net/dayone . For addional
informaon about XPath, review the W3Schools XPath website at hps://www.w3schools.com/xml/
xpath_intro.asp.
RELATED DOCUMENTATION
Installing Junos Snapshot Administrator | 4
Junos Snapshot Administrator Conguraon File | 8
2
2
CHAPTER
Installing Junos Snapshot
Administrator
Installing Junos Snapshot Administrator | 4
Installing Junos Snapshot Administrator
IN THIS SECTION
Installing Junos Snapshot Administrator | 4
Sasfying Requirements for SSHv2 Connecons | 5
You install Junos Snapshot Administrator on a remote server within the networking environment. Prior
to installing Junos Snapshot Administrator, ensure that the remote server meets the following minimum
requirements:
• 32-bit or 64-bit CentOS 5.5 or later operang system
For more informaon about installing the CentOS soware on your server, see the CentOS website
at hp://www.centos.org/ .
•getopt (GNU enhanced) program is installed
The getopt (GNU enhanced) ulity is a common ulity that is usually (but not always) installed as part
of the basic CentOS installaon process. For more informaon about installing this ulity, see the
installaon instrucons for the CentOS operang system.
Prior to using Junos Snapshot Administrator, ensure that you sasfy the requirements for SSHv2
connecons with devices running Junos OS.
The procedure for installing Junos Snapshot Administrator and the requirements for SSHv2 connecons
with devices running Junos OS are outlined in the following secons.
Installing Junos Snapshot Administrator
Before you begin, ensure that you have the following on the remote server:
• Administrator privileges
• Internet access
To install Junos Snapshot Administrator:
1. Access the download page at hps://www.juniper.net/support/downloads/?p=jsnap.
4
2. Select the soware tab.
3. Download the Junos Snapshot Administrator .rpm le to the remote server.
4. Install the package on the remote server.
$ rpm -i package-name
5. Validate the Junos Snapshot Administrator installaon.
You might need to restart the shell in order for the system to recognize the new command.
$ jsnap
Junos Snapshot Administrator should output informaon about the tool syntax and opons. If you
did not get the expected output, correct the Junos Snapshot Administrator installaon before going
any further.
Sasfying Requirements for SSHv2 Connecons
The NETCONF server communicates with client applicaons within the context of a NETCONF session.
The server and client explicitly establish a connecon and session before exchanging data, and close the
session and connecon when they are nished.
Junos Snapshot Administrator accesses the NETCONF server using the SSH protocol and uses the
standard SSH authencaon mechanism. To establish an SSHv2 connecon with a device running Junos
OS, you must ensure that the following requirements are met:
• The client applicaon has a user account and can log in to each device where a NETCONF session
will be established.
• The login account used by the client applicaon has an SSH public/private key pair or a text-based
password.
• The client applicaon can access the public/private keys or text-based password.
• The NETCONF service over SSH is enabled on each device where a NETCONF session will be
established.
For informaon about enabling NETCONF on a device running Junos OS and sasfying the
requirements for establishing an SSH session, see "Controlling the NETCONF Session" in the NETCONF
XML Management Protocol Developer Guide.
5
For informaon about NETCONF over SSH, see RFC 4742,
Using the NETCONF Conguraon Protocol
over Secure SHell (SSH)
, which is available at hp://www.ie.org/rfc/rfc4742.txt .
RELATED DOCUMENTATION
Junos Snapshot Administrator Overview | 2
6
3
CHAPTER
Junos Snapshot Administrator
Conguraon File
Junos Snapshot Administrator Conguraon File | 8
Understanding Junos Snapshot Administrator Reference Variables | 18
Junos Snapshot Administrator Conguraon File
IN THIS SECTION
Understanding the Junos Snapshot Administrator Conguraon File | 8
Example: Creang the Junos Snapshot Administrator Conguraon File | 13
Understanding the Junos Snapshot Administrator Conguraon File
IN THIS SECTION
do Secon | 8
Test Secons | 9
The Junos Snapshot Administrator conguraon le denes the scope of a snapshot and the evaluaon
criteria for either a single snapshot or a comparison of two snapshots. You provide the locaon of the
Junos Snapshot Administrator conguraon le as an argument to the jsnap command.
In the Junos Snapshot Administrator conguraon le, curly braces delimit code blocks, and semicolons
signal the end of a statement or command. You can insert comments into the conguraon le by using
either a hash (#) or a semicolon (;) at the start of a line.
The Junos Snapshot Administrator conguraon le consists of a required do code block placed at the
beginning of the conguraon le followed by any number of user-dened test secons. Details of the
individual conguraon le components are described in the following secons:
do Secon
The do code block lists the name of each test secon that will be used in the snapshot. This secon is
mandatory and must be placed at the start of the conguraon le. You can dene as many test secons
8
as desired, but you must include the test secon name in the do code block in order to execute that test.
The syntax of the do code block is:
do {
test-section-name1;
test-section-name2;
test-section-name3;
}
For example, the following do code block lists ve test secons. When Junos Snapshot Administrator
references the conguraon le, although the conguraon le might dene more than ve test
secons, the tool only executes the ve test secons listed in the do code block.
do {
re0-master;
ospf-checks;
l2vpn-list;
vpls-list;
bgp-checks;
}
Test Secons
Within the conguraon le, you dene one or more test secons. The test secons, which are placed
in any order aer the do code block, dene the scope of a snapshot and the evaluaon criteria for a
single snapshot or a comparison of two snapshots.
Each test secon consists of a unique conguraon stanza, which contains:
• The secon name—Unique, user-dened string that should describe the check being performed.
• One command statement—Species the Junos OS
operaonal mode command
that is executed to
collect the data.
• One or more item or iterate content secon declaraons—Denes the test cases used to evaluate
the data.
The general syntax of the test secon code block is:
test-section-name {
command command-syntax;
(item | iterate) xpath-expression {
9
[id xpath-expression;]
# test cases
}
}
For example:
re0-master {
command show chassis routing-engine;
item route-engine[slot = '0'] {
is-equal mastership-state, "master" {
info re0 is always master;
err " re0 is not master, rather %s", mastership-state;
err " Correct so that re0 is the master!";
}
}
}
The test secon components are described in detail in the following secons:
Test Secon Name
Test secon names are unique, user-dened strings that should describe the check being performed.
You add the names of the test secons that you want to execute to the do code block at the start of the
conguraon le. When Junos Snapshot Administrator references the conguraon le, the tool
executes any test secons that are listed in the do code block.
Ideally, you should create descripve test secon names so that you or anyone else working with the
conguraon le can quickly discern the scope and purpose of each test secon long aer the
conguraon le is created. For example, you might use acve-chassis-alarm-check for a test secon
that checks whether there are any acve chassis alarms, as shown here:
active-chassis-alarm-check {
command show chassis alarms;
item alarm-summary {
exists no-active-alarm {
info No chassis alarms;
err "There are %s chassis alarms", active-alarm-count;
}
}
}
10
Test Secon Command Statement
Each test secon consists of a single command idener followed by the Junos OS operaonal mode
command that is executed to collect the desired data for that check. For example, if you want to collect
and evaluate data about the OSPF neighbors for an interface, you would include the command idener
followed by the show ospf neighbor operaonal mode command, as shown here:
ospf-neighbor-check {
command show ospf neighbor;
iterate ospf-neighbor {
id interface-name;
#
# test cases
#
}
}
Provided the ospf-neighbor-check secon name is included in the do code block, the resulng snapshot
will include the XML data from the show ospf neighbor command output. For more informaon about
Junos OS operaonal mode commands, see the
Junos XML API Operaonal Reference
. A sample of the
show ospf neighbor output is shown here:
<ospf-neighbor-information>
<ospf-neighbor>
<neighbor-address>10.1.12.2</neighbor-address>
<interface-name>ae18.0</interface-name>
<ospf-neighbor-state>Full</ospf-neighbor-state>
<neighbor-id>10.0.0.2</neighbor-id>
<neighbor-priority>128</neighbor-priority>
<activity-timer>3</activity-timer>
</ospf-neighbor>
<ospf-neighbor>
<neighbor-address>10.1.15.2</neighbor-address>
<interface-name>ae19.0</interface-name>
<ospf-neighbor-state>Full</ospf-neighbor-state>
<neighbor-id>10.0.0.5</neighbor-id>
<neighbor-priority>128</neighbor-priority>
<activity-timer>3</activity-timer>
</ospf-neighbor>
</ospf-neighbor-information>
11
You can evaluate specic elements in the snapshot output or compare elements across mulple
snapshots by dening test cases.
Test Secon Evaluaon Criteria
The test secon command statement can be followed by either an item or iterate content secon
declaraon, within which you dene one or more test cases for evaluang the captured snapshot data.
You use the item statement to uniquely idenfy a specic element, and the iterate statement to iterate
over mulple elements.
The general syntax for the content secon declaraon is:
(item | iterate) xpath-expression {
test-operator operator-params {
#specify an ID for test operators that compare two collections
[id xpath-expression;]
info string;
err "string";
}
}
Each test case is dened by a test operator followed by any required parameters. For more informaon
about available test operators see "Understanding Junos Snapshot Administrator Test Operators" on
page 22 and "Junos Snapshot Administrator Test Operators Summary" on page 25. Within the test-
case code block you dene an info statement to provide informaon about the test case and expected
operang condions. You also dene one or more err statements, which are generated when the
content fails the specic test case.
The following example has a test case that checks the XML output of the show chassis roung-engine
command to determine if the Roung Engine in slot 0 is the primary Roung Engine. If the mastership-
state of the Roung Engine in slot 0 is not equal to "master", the code generates two err statements.
re0-master {
command show chassis routing-engine;
item route-engine[slot = '0'] {
is-equal mastership-state, "master" {
info RE-0 is always master;
err " RE-0 is not master, rather %s", mastership-state;
err " Correct error so that RE-0 is the master";
}
12
}
}
When using certain test operators to compare element values across two snapshots, in order to map the
rst snapshot data item to a second snapshot data item, you must select elements of the data that
create a unique ID. To create a unique ID for a test case, you include the id statement followed by an
XPath expression that references the unique element. To create a unique ID based on mulple element
values, you dene mulple id statements. You can also construct ID values relave to the content value.
For detailed informaon about creang ID values, see "Understanding Junos Snapshot Administrator
Test Operators" on page 22.
Example: Creang the Junos Snapshot Administrator Conguraon File
IN THIS SECTION
Requirements | 13
Overview | 13
Conguraon | 15
This example creates a basic sample Junos Snapshot Administrator conguraon le.
Requirements
• Junos Snapshot Administrator Release 1.0 is installed on the server.
Overview
This example creates a Junos Snapshot Administrator conguraon le with one test secon named
re0-master. The re0-master test secon retrieves and parses the XML output from the Junos OS
operaonal mode command show chassis roung-engine. A sample of the XML output from a dual
Roung Engine device is shown here:
<route-engine-information xmlns="http://xml.juniper.net/junos/11.4R1/junos-
chassis">
<route-engine>
<slot>0</slot>
<mastership-state>master</mastership-state>
13
<mastership-priority>master (default)</mastership-priority>
<status>OK</status>
<temperature junos:celsius="30">30 degrees C / 86 degrees F</temperature>
<cpu-temperature junos:celsius="27">
27 degrees C / 80 degrees F
</cpu-temperature>
<memory-dram-size>768</memory-dram-size>
<memory-buffer-utilization>48</memory-buffer-utilization>
<cpu-user>1</cpu-user>
<cpu-background>0</cpu-background>
<cpu-system>5</cpu-system>
<cpu-interrupt>1</cpu-interrupt>
<cpu-idle>94</cpu-idle>
<model>RE-5.0</model>
<serial-number>19995858810</serial-number>
<start-time junos:seconds="1337708989">
2012-05-22 10:49:49 PDT
</start-time>
<up-time junos:seconds="8735869">
101 days, 2 hours, 37 minutes, 49 seconds
</up-time>
<last-reboot-reason>
Router rebooted after a normal shutdown.
</last-reboot-reason>
<load-average-one>0.00</load-average-one>
<load-average-five>0.00</load-average-five>
<load-average-fifteen>0.00</load-average-fifteen>
</route-engine>
</route-engine-information>
For a dual Roung Engine device, the test case checks the XML output to determine if the Roung
Engine in slot 0 is the primary Roung Engine. The test secon uses the item route-engine[slot = '0']
expression to select the route-engine element that has the child element slot value of "0". The test case
uses the is-equal test operator to compare the value of the mastership-state child element with the
string value "master". If the test case returns true, the Roung Engine in slot 0 is the primary Roung
Engine. If the test case returns false, the code reports two error statements.
The mandatory do secon includes the names of all test secons that should be executed when Junos
Snapshot Administrator references this conguraon le. For this example, the do secon contains only
re0-master.
14
Conguraon
IN THIS SECTION
How to Congure the Test Secons | 15
How to Congure the "do" Secon | 17
Results | 17
The Junos Snapshot Administrator conguraon consists of a mandatory do secon and one or more
test secons.
How to Congure the Test Secons
Step-by-Step Procedure
The Junos Snapshot Administrator conguraon consists of test secons that dene the commands and
evaluaon criteria that are used in a snapshot or snapshot comparison. To congure a test secon:
1. Name the test secon using a unique and descripve string.
re0-master {
...
}
2. Add the command statement, and specify the Junos OS operaonal mode command that the code
executes to retrieve the desired XML data.
re0-master {
command show chassis routing-engine;
}
3. Add the iterate or item statement followed by the XPath expression that selects the desired
elements.
re0-master {
command show chassis routing-engine;
15
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
  • Page 1 1
  • Page 2 2
  • Page 3 3
  • Page 4 4
  • Page 5 5
  • Page 6 6
  • Page 7 7
  • Page 8 8
  • Page 9 9
  • Page 10 10
  • Page 11 11
  • Page 12 12
  • Page 13 13
  • Page 14 14
  • Page 15 15
  • Page 16 16
  • Page 17 17
  • Page 18 18
  • Page 19 19
  • Page 20 20
  • Page 21 21
  • Page 22 22
  • Page 23 23
  • Page 24 24
  • Page 25 25
  • Page 26 26
  • Page 27 27
  • Page 28 28
  • Page 29 29
  • Page 30 30
  • Page 31 31
  • Page 32 32
  • Page 33 33
  • Page 34 34
  • Page 35 35
  • Page 36 36
  • Page 37 37
  • Page 38 38
  • Page 39 39
  • Page 40 40
  • Page 41 41
  • Page 42 42
  • Page 43 43
  • Page 44 44
  • Page 45 45
  • Page 46 46
  • Page 47 47
  • Page 48 48
  • Page 49 49
  • Page 50 50
  • Page 51 51
  • Page 52 52
  • Page 53 53
  • Page 54 54
  • Page 55 55
  • Page 56 56
  • Page 57 57
  • Page 58 58
  • Page 59 59
  • Page 60 60
  • Page 61 61
  • Page 62 62
  • Page 63 63
  • Page 64 64
  • Page 65 65
  • Page 66 66
  • Page 67 67
  • Page 68 68
  • Page 69 69
  • Page 70 70
  • Page 71 71

Juniper Junos Snapshot Administrator (SLAX) Admin Guide

Juniper
Brand
Juniper
Model
Junos Snapshot Administrator (SLAX)
Type
Admin Guide
Download PDF
report

Ask a question and I''ll find the answer in the document

Finding information in a document is now easier with AI

Related papers

Other documents