Yuma Installation Guide
Contents
1. 11 Version 2 2 Yuma Installation Guide e Restart the SSH server This is a platform specific task Refer to the sshd manual page for your system for more details This step may need to be run as root or with the sudo program Page 12 Version 2 22. Data models C code for agent C code for agent development written in YANG yangdump Cooked YANG for platform mgmt Translator XSD for NMS development NM HTML for user documentation HTML for user documentation for user documentation NM Tools SQL for object dictionary SQL for object dictionary object dictionary dales Refer to section 3 of the Yuma User Manual for a complete introduction to Yuma This section focuses on the client and server tools within the Yuma programs This document is intended for users of the Yuma NETCONF client and server programs It covers the installation of the Yuma packages 3 Installation Requirements The following requirements must be met for Yuma to be installed Page 4 Version 2 2 Yuma Installation Guide The following platforms are supported at this time for the Yuma binary package Ubuntu version 9 10 32 bit x86 and 64 bit AMD e Fedora version 12 32 bit x86 The following programs and libraries need to be available for Yuma to work The libxml2 package is needed by the yuma package for some of the XML parsing functions This package is installed by the default Linux installation process To build yuma sources also install the developer version of this package It is called libxml2 dev on Ubuntu systems The libssh2 package is needed by the yuma package for the yangcli program to connect to NETCONF servers using the SSH protocol This package is call
3. applications then there is no further mandatory setup required If a work directory is used then the YUMA_HOME environment variable needs to be defined Refer to the user manual for details If Yuma is installed in a location other than the default location described above then the YUMA_INSTALL environment variable needs to be defined Refer to the user manual for details The following binary applications are available o Jusr bin yangcli NETCONF over SSH client application o Jusr bin yangdump YANG compiler o Jusr bin yangdiff YANG compare program o Jusr bin make_sil_dir Bash script to create a new SIL work directory Refer to the Yuma Developer Manual for details The Yuma server does not automatically start running when installed This will be supported in a future release The following steps must be taken to start the netconfd server You must modify the etc ssh sshd_config file and add the netconf subsystem as described in the user manual If the yuma package was installed in a non default location then the path to the netconf subsystem will be different than the example below The following commands must be present Port 22 Port 830 Subsystem netconf usr sbin netconf subsystem Start the netconfd server as described in the user manual or quickstart guide This can be in the foreground or the background If it is in the background then the log CLI parameter should be provided as shown below Page
4. e NETCONF Working Group Wiki Page o http trac tools ietf org wg netconf trac wiki o Free information on NETCONF standardization activities and NETCONF implementations NETCONF WG Status Page o http tools ietf org wg netconf o IETF Internet draft status for NETCONF documents libsmi Home Page o http www ibr cs tu bs de projects libsmi o Free tools such as smidump to convert SMlv2 to YANG NETCONF Working Group o http www ietf org html charters netconf charter html o Technical issues related to the NETCONF protocol are discussed on the NETCONF WG mailing list Refer to the instructions on the WEB page for joining the mailing list NETMOD Working Group o http www ietf org html charters netmod charter html o Technical issues related to the YANG language and YANG data types are discussed on the NETMOD WG mailing list Refer to the instructions on the WEB page for joining the mailing list The following formatting conventions are used throughout this document Documentation Conventions Convention Description foo CLI parameter foo lt foo gt XML parameter foo foo yangcli command or parameter FOO Environment variable FOO foo yangcli global variable foo some text Example command or PDU some text Plain text Page 3 Version 2 2 Yuma Installation Guide 2 Introduction Yuma Tools Data models written in SMlv2 P ES ra netconfd smidump ES Server Translator
5. tives AAAI ARENT EEE ENIKE OE iA KEKEE T 10 6 1 More Documenta O ES 10 6 2 Running the Yuma PROGKAINS saves di A a idds 11 6 2 1 yangcli yangdump Yan Msi a A Aa 11 6 2 2 netconfd and netconf SUbDSySteM tvccnicconnrcica ii de Dad 11 Page 1 Version 2 2 Yuma Installation Guide 1 Preface Copyright 2009 2012 Andy Bierman All Rights Reserved Other documentation includes Yuma Quickstart Guide Yuma User Manual Yuma netconfd Manual Yuma yangcli Manual Yuma yangdiff Manual Yuma yangdump Manual Yuma Developer Manual To obtain additional support you may join the yuma users group on sourceforge net and send email to this e mail address yuma users lists sourceforge net The SourceForge net Support Page for Yuma can be found at this WEB page http sourceforge net projects yuma support There are several sources of free information and tools for use with YANG and or NETCONF The following section lists the resources available at this time Netconf Central o http www netconfcentral org o Yuma Home Page Free information on NETCONF and YANG tutorials on line YANG module validation and documentation database Yuma SourceFource OpenSource Project o http sourceforge net projects yuma Download Yuma source and binaries project forums and help Yang Central o http www yang central org Page 2 Version 2 2 Yuma Installation Guide o Free information and tutorials on YANG free YANG tools for download
6. Yuma Installation Guide YANG Based Unified Modular Automation Tools YUMA Package Installation Version 2 2 Last Updated January 26 2012 Yuma Installation Guide Table Of Contents Yuma Installation Guide T Preface er o No A 2 DD beGall State Men a A a Ea a r aa aaa a a a a AAA A AAAA EE EEA 2 1 2 Additional ROSOULCOS enn a E A AAEE EE EEE EEEE a EE AAEE AAAA EATA 2 1 2 L WEB SOS ti a a a A E A A o EE 2 ELL E O AY Rae ee 3 1 3 Conventions Used in this DOCUMENT ooccccccccnccnccnconcnnconnnononcnncnnnnncnnnonannnnnnnnncnnnnoros 3 2 MtroductioN iresi enaa E Raid 4 2 1 Intended AMIA aii 4 3 Installation REQUIFE MENS aia 4 SA SUPDOriSa PON id doi GAs 4 321 EXCEL PACA OS aa 5 O O 5 3 22 A 5 A A E O a A AE sea E aA a sa AE EERE ARE NS 5 BEDAR ZIM EE E EE E E T A E E A E E AE E E 5 Oo Ra Saen ara aae E eaa AAA AAA ee ce 5 E LA el EA E E T A E E E 5 3 3 2 yuma AO Cinni een e Aaa AA EAE E Eaa E EEE aia ainda Seats eat eae a its 6 A Y E O E A O O 6 QUICK ITASCA toc nt oso peri 6 A a NO 6 ALLEN NA MID Si SRA AAA A A A A ere 6 4 1 2 Install the Yuma Packd e S iii ida 6 7a P A ELO E EEEE A A An 7 4 2 1 External UDrafie Sesan eeraa a Ea E EEEE ia 7 4 2 2 Install the Yuma Package Sisa o ice 7 5 Installed Files ESO 7 UN PACKAGES sun senreceneewers sseicolsneeenssarse see Goh cn sae ae EAEn ACEC Aii 7 5 2 Vy uma doc Package nen ee raau osea 9 5 3 yuma dev PACK AGC star io tailed vai E noi 9 A sesees me enaslwaaes KERER
7. ed libssh2 1 on Ubuntu platforms This package is not installed by the default Linux installation process To build yuma sources also install the developer version of this package It is called libssh2 1 dev on Ubuntu systems The ncurses library is needed by the yuma package for some terminal support This package is installed by the default Linux installation process It is called libncurses5 on Ubuntu systems To build yuma sources also install the developer version of this package It is called libncurses5 dev on Ubuntu systems The zlib library is needed by the yuma package for some compression support used by other libraries that yuma imports This package is installed by the default Linux installation process To build yuma sources also install the developer version of this package It is called libz dev on Ubuntu systems The yuma files are split into 3 packages described below The yuma package contains all the shared libraries binary programs man files YANG files sample conf files needed to run all the programs It must be installed Page 5 Version 2 2 Yuma Installation Guide The yuma doc package contains all the documentation files including this file It is only needed if you want the PDF and HTML versions of the documentation installed Since these files take up a lot of disk space an optional package is used to install them The yuma dev package contains all the server instrumentation library SIL develo
8. l o yang o test usr share man man1 directory contains the following files o yangcli 1 gz o yangdiff 1 gz o yangdump 1 gz o netconfd 1 gz o netconf subsystem 1 gz o make_sil_dir 1 gz etc yuma directory contains the following sample configuration files o yangcli sample conf o yangdiff sample conf o yangdump sample conf o netconfd sample conf Version 2 2 Yuma Installation Guide This section describes all the files and or directories installed by the yuma doc package usr share doc yuma directory containing the following files o AUTHORS o README usr share doc yuma pdf directory containing the following files o yuma legal notices pdf o yuma installation guide pdf o yuma quickstart guide pdf o yuma user cmn manual pdf o yuma yangcli manual pdf o yuma yangdiff manual pdf o yuma yangdump manual pdf o yuma netconfd manual pdf o yuma dev manual pdf usr share doc yuma html directory containing the HTML files for all the manuals o index html o directories for each HTML manual usr share doc yuma doc directory Ubuntu only containing the following files o copyright o changelog Debian Page 9 usr bin directory contains the following programs o make_sil_dir usr include yuma directory contains H files needed to compile SIL code so it can be loaded into the server at runtime o ncx h o agt h o platform procdefs h usr share yuma src libtoaster directory contains the follo
9. per files It is only needed if you want to add YANG modules to the server and develop your own server instrumentation library code to load into the netconfd server at run time 4 Quick Installation This section describes how to use the platform package manager program to install the Yuma programs First make sure the external libraries are installed mydir gt dpkg list libxml2 libssh2 1 If the library is installed the status will show ii libxml2 as in the example below Desired Unknown Install Remove Purge Hold Status Not Inst Cfg files Unpacked Failed cfg Half inst trig aWait Trig pend Err none Reinst required Status Err uppercase bad Name Version Description SSS o SS SS SS SS Se ii libssh2 1 1 2 2 1 SSH2 client side library ii libxml2 2 7 6 dfsg 1ub GNOME XML library mydir gt If the libxml2 library is not installed then install it with following command mydir gt sudo apt get install libxml2 libssh2 1 Next install the Yuma package Here is an example showing all 3 packages being installed The actual hardware platform identifier may be different Page 6 Version 2 2 Yuma Installation Guide mydir gt sudo dpkg i yuma 2 1 1 u1004 i386 deb mydir gt sudo dpkg i yuma doc 2 1 1 u1004 i386 deb mydir gt sudo dpkg i yuma dev 12 1 1 u1004 i386 deb First make sure the external libraries are installed mydir gt rpm q Libxml2 ncurses libssh2 If the packages are installed then a line
10. will be printed for each package showing the version such as in the following example your versions may be different libxml2 2 7 6 2 fc14 1686 ncurses 5 7 3 20090207 fc14 i686 libssh2 2 3 8 fc14 i686 If a package is not already installed then install it This example shows how to install both external libraries mydir gt sudo yum install libxml2 ncurses libssh2 Next install the Yuma package Here is an example The actual yuma revision and hardware platform may be different mydir gt sudo yum localinstall yuma 2 1 1 fc14 i686 rpm 5 Installed Files This section describes all the files and or directories installed by the yuma package Jusr bin directory contains the following programs o yangcli Page 7 Version 2 2 Page 8 Yuma Installation Guide o yangdiff o yangdump usr sbin directory contains the following server programs o netconfd o netconf subsystem usr lib directory contains the following files o libncx so 2 1 file extension may vary based on platform o libagt so 2 1 file extension may vary based on platform usr lib yuma directory contains the following file o libtoaster so usr share doc yuma directory containing the following files o AUTHORS o README o yuma legal notices pdf usr share doc yuma directory Ubuntu only containing the following files o copyright o changelog Debian usr share yuma modules directory contains all the YANG modules o etf o netconfcentra
11. wing contents o Makefile o src directory Makefile toaster c toaster c start Version 2 2 Yuma Installation Guide toaster h toaster h start o bin directory o lib directory e usr share yuma util directory contains the following files o makefile sil o makefile top sil usr share doc yuma dev directory Ubuntu only containing the following files o copyright o changelog Debian e usr share man man1 directory contains the following files o make_sil_dir 1 gz 6 Next Steps 6 1 More Documentation e Yuma Quickstart Guide o Jusr share doc yuma pdf yuma quickstart quide pdf e Yuma Common User Manual o Jusr share doc yuma pdf yuma user cmn manual pdf e Yuma Program Specific User Manual o Jusr share doc yuma pdf yuma netconfd manual pdf o Jusr share doc yuma pdf yuma yangcli manual pdf o Jusr share doc yuma pdf yuma yangdiff manual pdf o Jusr share doc yuma pdf yuma yangdump manual pdf e Yuma Developer Manual o usr share doc yuma pdf yuma dev manual pdf The unix man program can be used to get documentation about each program For example man yangcli man yangdump e man yangdiff e man netconfd man netconf subsystem man make sil_dir Each ia also has extensive help information available with the help CLI parameter For example Page 10 Version 2 2 Yuma Installation Guide yangcli help yangdump help yangdiff help netconfd help If you are just using the Yuma client
Download Pdf Manuals
Related Search