rfc6022.YANG

InternetEngineeringTaskForce(IETF)M.ScottRequestforComments:6022EricssonCategory:StandardsTrackM.BjorklundISSN:2070-1721Tail-fSystemsOctober2010YANGModuleforNETCONFMonitoringAbstractThisdocumentdefinesaNetworkConfigurationProtocol(NETCONF)datamodeltobeusedtomonitortheNETCONFprotocol.ThemonitoringdatamodelincludesinformationaboutNETCONFdatastores,sessions,locks,andstatistics.ThisdatafacilitatesthemanagementofaNETCONFserver.ThisdocumentalsodefinesmethodsforNETCONFclientstodiscoverdatamodelssupportedbyaNETCONFserveranddefinesanewNETCONFget-schemaoperationtoretrievethem.StatusofThisMemoThisisanInternetStandardsTrackdocument.ThisdocumentisaproductoftheInternetEngineeringTaskForce(IETF).ItrepresentstheconsensusoftheIETFcommunity.IthasreceivedpublicreviewandhasbeenapprovedforpublicationbytheInternetEngineeringSteeringGroup(IESG).FurtherinformationonInternetStandardsisavailableinSection2ofRFC5741.Informationaboutthecurrentstatusofthisdocument,anyerrata,andhowtoprovidefeedbackonitmaybeobtainedat(c)2010IETFTrustandthepersonsidentifiedasthedocumentauthors.Allrightsreserved.ThisdocumentissubjecttoBCP78andtheIETFTrust’sLegalProvisionsRelatingtoIETFDocuments()ineffectonthedateofpublicationofthisdocument.Pleasereviewthesedocumentscarefully,astheydescribeyourrightsandrestrictionswithrespecttothisdocument.CodeComponentsextractedfromthisdocumentmustincludeSimplifiedBSDLicensetextasdescribedinSection4.eoftheTrustLegalProvisionsandareprovidedwithoutwarrantyasdescribedintheSimplifiedBSDLicense.Scott&BjorklundStandardsTrack[Page1]RFC6022YANGModuleforNETCONFMonitoringOctober2010ThisdocumentmaycontainmaterialfromIETFDocumentsorIETFContributionspublishedormadepubliclyavailablebeforeNovember10,2008.Theperson(s)controllingthecopyrightinsomeofthismaterialmaynothavegrantedtheIETFTrusttherighttoallowmodificationsofsuchmaterialoutsidetheIETFStandardsProcess.Withoutobtaininganadequatelicensefromtheperson(s)controllingthecopyrightinsuchmaterials,thisdocumentmaynotbemodifiedoutsidetheIETFStandardsProcess,andderivativeworksofitmaynotbecreatedoutsidetheIETFStandardsProcess,excepttoformatitforpublicationasanRFCortotranslateitintolanguagesotherthanEnglish.TableofContents1.Introduction....................................................31.1.DefinitionofTerms........................................32.DataModeltoMonitorNETCONF...................................32.1.The/netconf-stateSubtree.................................32.1.1.The/netconf-state/capabilitiesSubtree.............42.1.2.The/netconf-state/datastoresSubtree...............42.1.3.The/netconf-state/schemasSubtree..................52.1.4.The/netconf-state/sessionsSubtree.................62.1.5.The/netconf-state/statisticsSubtree...............73.SchemaSpecificOperations......................................83.1.Theget-schemaOperation.................................84.Examples........................................................94.1.RetrievingSchemaListviagetOperation.................94.2.RetrievingSchemaInstances...............................115.NETCONFMonitoringDataModel..................................136.SecurityConsiderations........................................257.Acknowledgements...............................................268.IANAConsiderations............................................269.References.....................................................269.1.NormativeReferences......................................269.2.InformativeReferences....................................27Scott&BjorklundStandardsTrack[Page2]RFC6022YANGModuleforNETCONFMonitoringOctober20101.IntroductionThisdocumentdefinesaYANG[RFC6020]modeltobeusedtomonitortheNETCONFprotocol.ItprovidesinformationaboutNETCONFsessionsandsupportedschemaasdefinedin[RFC4741].Considerationssuchasdifferentschemaformats,featureoptionality,andaccesscontrolscanallimpacttheapplicabilityandlevelofdetailtheNETCONFserversendstoaclientduringsessionsetup.ThemethodsdefinedinthisdocumentaddresstheneedforfurthermeanstoqueryandretrieveschemaandNETCONFstateinformationfromaNETCONFserver.TheseareprovidedtocomplementexistingbaseNETCONFcapabilitiesandoperationsandinnowayaffectexistingbehaviour.Anewget-schemaoperationisalsodefinedtosupportexplicitschemaretrievalviaNETCONF.1.1.DefinitionofTermsThekeywordsMUST,MUSTNOT,REQUIRED,SHALL,SHALLNOT,SHOULD,SHOULDNOT,RECOMMENDED,NOTRECOMMENDED,MAY,andOPTIONALinthisdocumentaretobeinterpretedasdescribedinBCP14[RFC2119].2.DataModeltoMonitorNETCONFTheNETCONFmonitoringdatamodeldefinedinthisdocumentprovidesoperationalinformationontheNETCONFserver.ThisincludesdetailsspecifictotheNETCONFprotocol(e.g.,protocol-specificcounterssuchas’in-sessions’)aswellasdatarelatedtoschemaretrieval(e.g.,schemalist).Aserverthatimplementsthedatamodeldefinedinthisdocument(urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring)MUSTadvertisethecapabilityURIasdescribedin[RFC6020].Thissectionpresentsanoverviewofthemonitoringdatamodel