Docs build 2025-04-16

Author: github-actions

en/latest/_sources/operations/server.rst.txt

@@ -450,7 +450,7 @@ Add/remove/update system users & their ssh `authorized_keys`.
 
     server.user(
         user: str, present=True, home: str | None=None, shell: str | None=None,
-        group: str | None=None, groups: list[str] | None=None,
+        group: str | None=None, groups: list[str] | None=None, append=False,
         public_keys: str | list[str] | None=None, delete_keys=False, ensure_home=True,
         create_home=False, system=False, uid: int | None=None, comment: str | None=None,
         unique=True, password: str | None=None, **kwargs,
@@ -462,6 +462,7 @@ Add/remove/update system users & their ssh `authorized_keys`.
 + **shell**: the users shell
 + **group**: the users primary group
 + **groups**: the users secondary groups
++ **append**: whether to add `user` to `groups`, w/o losing membership of other groups
 + **public_keys**: list of public keys to attach to this user, ``home`` must be specified
 + **delete_keys**: whether to remove any keys not specified in ``public_keys``
 + **ensure_home**: whether to ensure the ``home`` directory exists

en/latest/operations/server.html

@@ -577,7 +577,7 @@ <h1>Server Operations<a class="headerlink" href="#server-operations" title="Link
 <p>Add/remove/update system users &amp; their ssh <cite>authorized_keys</cite>.</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">user</span><span class="p">(</span>
     <span class="n">user</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">present</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">home</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">shell</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
-    <span class="n">group</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">groups</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+    <span class="n">group</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">groups</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">append</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
     <span class="n">public_keys</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">delete_keys</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">ensure_home</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
     <span class="n">create_home</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">system</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">uid</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">comment</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
     <span class="n">unique</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">password</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
@@ -591,6 +591,7 @@ <h1>Server Operations<a class="headerlink" href="#server-operations" title="Link
 <li><p><strong>shell</strong>: the users shell</p></li>
 <li><p><strong>group</strong>: the users primary group</p></li>
 <li><p><strong>groups</strong>: the users secondary groups</p></li>
+<li><p><strong>append</strong>: whether to add <cite>user</cite> to <cite>groups</cite>, w/o losing membership of other groups</p></li>
 <li><p><strong>public_keys</strong>: list of public keys to attach to this user, <code class="docutils literal notranslate"><span class="pre">home</span></code> must be specified</p></li>
 <li><p><strong>delete_keys</strong>: whether to remove any keys not specified in <code class="docutils literal notranslate"><span class="pre">public_keys</span></code></p></li>
 <li><p><strong>ensure_home</strong>: whether to ensure the <code class="docutils literal notranslate"><span class="pre">home</span></code> directory exists</p></li>

en/latest/searchindex.js

@@ -450,7 +450,7 @@ Add/remove/update system users & their ssh `authorized_keys`.
 
     server.user(
         user: str, present=True, home: str | None=None, shell: str | None=None,
-        group: str | None=None, groups: list[str] | None=None,
+        group: str | None=None, groups: list[str] | None=None, append=False,
         public_keys: str | list[str] | None=None, delete_keys=False, ensure_home=True,
         create_home=False, system=False, uid: int | None=None, comment: str | None=None,
         unique=True, password: str | None=None, **kwargs,
@@ -462,6 +462,7 @@ Add/remove/update system users & their ssh `authorized_keys`.
 + **shell**: the users shell
 + **group**: the users primary group
 + **groups**: the users secondary groups
++ **append**: whether to add `user` to `groups`, w/o losing membership of other groups
 + **public_keys**: list of public keys to attach to this user, ``home`` must be specified
 + **delete_keys**: whether to remove any keys not specified in ``public_keys``
 + **ensure_home**: whether to ensure the ``home`` directory exists

en/next/_sources/operations/server.rst.txt

@@ -577,7 +577,7 @@ <h1>Server Operations<a class="headerlink" href="#server-operations" title="Link
 <p>Add/remove/update system users &amp; their ssh <cite>authorized_keys</cite>.</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">user</span><span class="p">(</span>
     <span class="n">user</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">present</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">home</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">shell</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
-    <span class="n">group</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">groups</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+    <span class="n">group</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">groups</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">append</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
     <span class="n">public_keys</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">delete_keys</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">ensure_home</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
     <span class="n">create_home</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">system</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">uid</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">comment</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
     <span class="n">unique</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">password</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
@@ -591,6 +591,7 @@ <h1>Server Operations<a class="headerlink" href="#server-operations" title="Link
 <li><p><strong>shell</strong>: the users shell</p></li>
 <li><p><strong>group</strong>: the users primary group</p></li>
 <li><p><strong>groups</strong>: the users secondary groups</p></li>
+<li><p><strong>append</strong>: whether to add <cite>user</cite> to <cite>groups</cite>, w/o losing membership of other groups</p></li>
 <li><p><strong>public_keys</strong>: list of public keys to attach to this user, <code class="docutils literal notranslate"><span class="pre">home</span></code> must be specified</p></li>
 <li><p><strong>delete_keys</strong>: whether to remove any keys not specified in <code class="docutils literal notranslate"><span class="pre">public_keys</span></code></p></li>
 <li><p><strong>ensure_home</strong>: whether to ensure the <code class="docutils literal notranslate"><span class="pre">home</span></code> directory exists</p></li>