1<!DOCTYPE html> 2<html lang="en"><head> 3 <meta charset="utf-8"> 4 <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> 5 6 7 <link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH" crossorigin="anonymous"> 8 9 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.2/css/all.min.css" integrity="sha512-SnH5WK+bZxgPHs44uWIX+LLJAJ9/2PkPKZ5QiAj6Ta86w+fsb2TkcmfRyVX3pBnMFcV7oQPJkl9QevSCWr3W6A==" crossorigin="anonymous" referrerpolicy="no-referrer" /> 10 11 12 13 <link class="markdown-style" rel="stylesheet" href="/third_party/ghm/github-markdown.css" type="text/css"> 14 15 16 17 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/tocbot/4.25.0/tocbot.css" type="text/css"> 18 19 20 21 22 <link rel="stylesheet" href="/css/oc-std.css" type="text/css"> 23 24 25 26 27 <title>OpenConfig - Documentation</title> 28</head> 29<body class="d-flex flex-column min-vh-100"><nav class="navbar navbar-expand-lg navbar-light sticky-top py-3" id="oc-main-nav"> 30 <div class="container"> 31 <a class="navbar-brand d-flex align-items-center" href="/"> 32 <img class="oc-logo me-2" src="/img/oc-logo-accent.svg" alt="OpenConfig" style="height: 32px;" /> 33 <span class="font-weight-bold text-dark h5 mb-0" style="font-weight: 700!important;">OpenConfig</span> 34 </a> 35 <button class="navbar-toggler border-0" type="button" data-bs-toggle="collapse" data-bs-target="#oc-navbar-main-collapse" aria-controls="oc-navbar-main-collapse" aria-expanded="false" aria-label="Toggle nav"> 36 <span class="navbar-toggler-icon"></span> 37 </button> 38 39 <div class="collapse navbar-collapse justify-content-end" id="oc-navbar-main-collapse"> 40 <ul class="navbar-nav align-items-center"> 41 42 43 <li class="nav-item dropdown px-2"> 44 <a class="nav-link dropdown-toggle" href="#" id="navbarDropdown-projects" role="button" data-bs-toggle="dropdown" aria-expanded="false"> 45 Projects 46 </a> 47 <ul class="dropdown-menu dropdown-menu-end shadow border-0" aria-labelledby="navbarDropdown-projects"> 48 49 <li><a class="dropdown-item py-2" href="/projects/">Overview</a></li> 50 51 <li><a class="dropdown-item py-2" href="/projects/models/">Data models</a></li> 52 53 <li><a class="dropdown-item py-2" href="/rpc/">RPCs</a></li> 54 55 </ul> 56 </li> 57 58 59 60 <li class="nav-item px-2"> 61 <a class="nav-link" href="/docs/"> Documentation</a> 62 </li> 63 64 65 66 <li class="nav-item px-2"> 67 <a class="nav-link" href="https://github.com/openconfig"><span class="fa-brands fa-github"></span> Code</a> 68 </li> 69 70 71 72 <li class="nav-item dropdown px-2"> 73 <a class="nav-link dropdown-toggle" href="#" id="navbarDropdown-about" role="button" data-bs-toggle="dropdown" aria-expanded="false"> 74 About 75 </a> 76 <ul class="dropdown-menu dropdown-menu-end shadow border-0" aria-labelledby="navbarDropdown-about"> 77 78 <li><a class="dropdown-item py-2" href="/about/participants/">Participants</a></li> 79 80 <li><a class="dropdown-item py-2" href="/about/contribute/">Contribute</a></li> 81 82 </ul> 83 </li> 84 85 86 </ul> 87 </div> 88 </div> 89</nav> 90<div id="content" class="content-spacer flex-grow-1"> 91<div class="container-fluid"> 92 <div class="row"> 93 94 <div class="col-md-3 col-lg-2 docs-side-nav px-4"><nav class="py-4" id="docs-sidebar"> 95 <div class="docs-side-nav-header"> 96 <h4>Documentation</h4> 97 </div> 98 99 <ul class="list-unstyled"> 100 101 <li class="docs-nav-section mb-2"> 102 103 <a class="dropdown-toggle d-flex align-items-center justify-content-between" href="#faqs_submenu" data-bs-toggle="collapse" role="button" aria-expanded="false" aria-controls="faqs_submenu">
104 <span class="d-flex align-items-center"> 105 <span class="fa fa-question"></span> FAQs 106 </span> 107 </a> 108 <ul class="collapse list-unstyled ms-3 mt-1" id="faqs_submenu"> 109 110 <li class="docs-nav-item"> 111 <a class="py-2 px-3 d-block rounded" href="/docs/faqs/faq/"> OpenConfig FAQ</a> 112 </li> 113 114 <li class="docs-nav-item"> 115 <a class="py-2 px-3 d-block rounded" href="/docs/faqs/operator_faq/"> OpenConfig FAQ for operators</a> 116 </li> 117 118 </ul> 119 120 </li> 121 122 <li class="docs-nav-section mb-2"> 123 124 <a class="d-flex align-items-center" href="https://github.com/openconfig/public/tree/master/doc"><span class="fa fa-map"></span> Guides (GitHub)</a> 125 126 </li> 127 128 <li class="docs-nav-section mb-2"> 129 130 <a class="d-flex align-items-center" href="https://github.com/openconfig/public/tree/master/doc"><span class="fa fa-sitemap"></span> Model Info (GitHub)</a> 131 132 </li> 133 134 <li class="docs-nav-section mb-2"> 135 136 <a class="d-flex align-items-center" href="https://github.com/openconfig/reference/tree/master/rpc/gnmi"><span class="fa fa-long-arrow-down"></span><span class="fa fa-long-arrow-up"></span> gNMI (GitHub)</a> 137 138 </li> 139 140 <li class="docs-nav-section mb-2"> 141 142 <a class="d-flex align-items-center" href="https://github.com/openconfig/gnoi/tree/master/docs"><span class="fa fa-gears"></span> gNOI (GitHub)</a> 143 144 </li> 145 146 <li class="docs-nav-section mb-2"> 147 148 <a class="d-flex align-items-center" href="https://github.com/openconfig/gribi"><span class="fa fa-road"></span> gRIBI (GitHub)</a> 149 150 </li> 151 152 <li class="docs-nav-section mb-2"> 153 154 <a class="d-flex align-items-center" href="https://github.com/openconfig/gnsi"><span class="fa fa-shield"></span> gNSI (GitHub)</a> 155 156 </li> 157 158 </ul> 159</nav> 160</div> 161 162 <main class="col-md-9 col-lg-10 px-md-5 py-5"> 163 <div class="col-xl-9"> 164 <h1 id="openconfig-documentation-portal">OpenConfig Documentation Portal</h1> 165<p>Welcome to the OpenConfig documentation portal. To ensure our technical documentation remains up-to-date and close to the implementation, most of our detailed guides and specifications are hosted directly in their respective GitHub repositories.</p> 166<p>Use the cards below to navigate to the relevant documentation.</p> 167<div class="row mt-4 mb-5"> 168 <div class="col-md-6 mb-4"> 169 <div class="card h-100 shadow-sm"> 170 <div class="card-body d-flex flex-column"> 171 <h3 class="card-title h5 font-weight-bold"><span class="fa fa-question-circle me-2 text-primary"></span>FAQs</h3> 172 <p class="card-text text-muted flex-grow-1">Common questions about the OpenConfig project, goals, and participation.</p> 173 <a href="/docs/faqs/" class="btn btn-outline-primary btn-sm mt-3">Read FAQs</a> 174 </div> 175 </div> 176 </div> 177 <div class="col-md-6 mb-4"> 178 <div class="card h-100 shadow-sm"> 179 <div class="card-body d-flex flex-column"> 180 <h3 class="card-title h5 font-weight-bold"><span class="fa fa-book me-2 text-primary"></span>User Guides</h3> 181 <p class="card-text text-muted flex-grow-1">Tutorials, style guides, and "OpenConfig by Example" documentation hosted on GitHub.</p> 182 <a target="_blank" href="https://github.com/openconfig/public/tree/master/doc" class="btn btn-outline-primary btn-sm mt-3">View on GitHub</a> 183 </div> 184 </div> 185 </div> 186</div> 187<h2 class="h4 font-weight-bold mb-3">YANG Data Models</h2> 188<div class="row mb-5"> 189 <div class="col-md-4 mb-4"> 190 <div class="card h-100 shadow-sm"> 191 <div class="card-body d-flex flex-column"> 192 <h3 class="card-title h6 font-weight-bold"><span class="fa fa-route me-2 text-primary"></span>Schema Path Explorer</h3> 193 <p class="card-text small text-muted flex-grow-1">Search, filter, and browse the unified list of all schema paths defined in OpenConfig models.</p> 194 <a href="/projects/models/paths/" class="btn btn-outline-secondary btn-sm mt-3">Explore Paths</a> 195 </div> 196 </div> 197 </div> 198 <div class="col-md-4 mb-4"> 199 <div class="card h-100 shadow-sm"> 200 <div class="card-body d-flex flex-column"> 201 <h3 class="card-title h6 font-weight-bold"><span class="fa fa-book-open me-2 text-primary"></span>Schema Documentation</h3> 202 <p class="card-text small text-muted flex-grow-1">View detailed, interactive documentation and tree views for each YANG module.</p> 203 <a href="/projects/models/schemadocs/" class="btn btn-outline-secondary btn-sm mt-3">View Documentation</a> 204 </div> 205 </div> 206 </div> 207 <div class="col-md-4 mb-4"> 208 <div class="card h-100 shadow-sm"> 209 <div class="card-body d-flex flex-column"> 210 <h3 class="card-title h6 font-weight-bold"><span class="fa fa-sitemap me-2 text-primary"></span>Model Info (GitHub)</h3> 211 <p class="card-text small text-muted flex-grow-1">Specific model overviews (QoS, Network Instance, EVPN, etc.) on GitHub.</p> 212 <a target="_blank" href="https://github.com/openconfig/public/tree/master/doc" class="btn btn-outline-secondary btn-sm mt-3">View on GitHub</a> 213 </div> 214 </div> 215 </div> 216</div> 217<h2 class="h4 font-weight-bold mb-3">Management Protocols</h2> 218<div class="row"> 219 <div class="col-md-6 col-lg-4 mb-4"> 220 <div class="card h-100 shadow-sm"> 221 <div class="card-body d-flex flex-column"> 222 <h3 class="card-title h6 font-weight-bold"><span class="fa fa-code me-2 text-primary"></span>gNMI Spec</h3> 223 <p class="card-text small text-muted flex-grow-1">Detailed specification for the gRPC Network Management Interface.</p> 224 <a target="_blank" href="https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-specification.md" class="btn btn-outline-secondary btn-sm mt-3">View Spec</a> 225 </div> 226 </div> 227 </div> 228 <div class="col-md-6 col-lg-4 mb-4"> 229 <div class="card h-100 shadow-sm"> 230 <div class="card-body d-flex flex-column"> 231 <h3 class="card-title h6 font-weight-bold"><span class="fa fa-cogs me-2 text-primary"></span>gNOI Spec</h3> 232 <p class="card-text small text-muted flex-grow-1">Documentation and protobufs for the gRPC Network Operations Interface.</p> 233 <a target="_blank" href="https://github.com/openconfig/gnoi/tree/master/docs" class="btn btn-outline-secondary btn-sm mt-3">View Docs</a> 234 </div> 235 </div> 236 </div> 237 <div class="col-md-6 col-lg-4 mb-4"> 238 <div class="card h-100 shadow-sm"> 239 <div class="card-body d-flex flex-column"> 240 <h3 class="card-title h6 font-weight-bold d-flex align-items-center"> 241 <img src="/img/protomap-logo.svg" alt="ProtoMap Logo" class="me-2" style="height: 1.25rem; width: 1.25rem;"> 242 ProtoMap Explorer 243 </h3> 244 <p class="card-text small text-muted flex-grow-1">An interactive visual map for navigating OpenConfig gRPC services and message structures. Created by Roman Dodin.</p> 245 <a target="_blank" href="https://protomap.netdevops.me/" class="btn btn-outline-secondary btn-sm mt-3">Explore ProtoMap</a> 246 </div> 247 </div> 248 </div> 249</div> 250 251 </div> 252 </main> 253 </div> 254</div> 255 256 </div><footer class="oc-footer py-5 mt-auto bg-dark text-light"> 257 <div class="container"> 258 <div class="row align-items-center"> 259 <div class="col-md-6 text-center text-md-start mb-3 mb-md-0"> 260 <p class="mb-0 text-muted">© 2016-2026 OpenConfig Project. All rights reserved.</p> 261 </div> 262 <div class="col-md-6 text-center text-md-end"> 263 <a href="https://github.com/openconfig" class="text-muted h4" target="_blank" rel="noopener noreferrer">
264 <span class="fa-brands fa-github"></span> 265 </a> 266 </div> 267 </div> 268 </div> 269</footer> 270 271
272<script src="https://code.jquery.com/jquery-3.7.1.min.js" integrity="sha256-/JqT3SQfawRcv/BIHPThkBvs0OEvtFFmqPF/lYI/Cxo=" crossorigin="anonymous"></script>
vendor: 1 bytes, line 272
272
273<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js" integrity="sha384-YvpcrYf0tY3lHB60NNkmXc5s9fDVZLESaAA55NDzOxhy9GkcIdslK1eN7N6jIeHz" crossorigin="anonymous"></script>
273 274 275 276
277<script src="https://cdnjs.cloudflare.com/ajax/libs/tocbot/4.25.0/tocbot.min.js"></script>
vendor: 1 bytes, line 277
277
278<script src="/js/oc-toc.js"></script>
278 279 280 281 282</body> 283</html>
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.