about summary refs log tree commit diff
path: root/man/nmcli-examples.xml
diff options
context:
space:
mode:
authorSebastien Bacher <seb128@ubuntu.com>2019-01-25 11:26:25 +0100
committerSebastien Bacher <seb128@ubuntu.com>2019-01-25 11:26:25 +0100
commitf54a568880bf47c2ea54c9b30d291156b34d6539 (patch)
treeaab9bb44b306da7651e8caf38bbab5cfeeb81b7d /man/nmcli-examples.xml
parente8ac7dacdcf4b38addef4f8ac6ab038f9d29582c (diff)
parentbbae86d3d2997a853ca0365e8eb7a3ca7489ee09 (diff)
Update upstream source from tag 'upstream/1.15.2'
Update to upstream version '1.15.2'
with Debian dir b4be4b7cfce96679a31cb9d423107789761e3b49
Diffstat (limited to 'man/nmcli-examples.xml')
-rw-r--r--man/nmcli-examples.xml30
1 files changed, 30 insertions, 0 deletions
diff --git a/man/nmcli-examples.xml b/man/nmcli-examples.xml
index 0b15f112..e777c326 100644
--- a/man/nmcli-examples.xml
+++ b/man/nmcli-examples.xml
@@ -178,6 +178,19 @@ B,DISPATCH</screen>
       </para>
     </example>
 
+    <example><title>Activating a VPN connection profile requiring interactive password input</title>
+<screen><prompt>$ </prompt><userinput>nmcli --ask con up my-vpn-con</userinput></screen>
+      <para>
+        This command activates a VPN connection profile enabling nmcli to interact with the user
+        ('--ask'): this will allow nmcli to prompt for the VPN password on the command line when
+        the <emphasis>password-flags</emphasis> are set to '0x02' ('always ask', see
+        <link linkend='nm-settings'><citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>
+        ).
+        This is particularly useful for OTP based VPNs, as the user needs to be prompted for the
+        password each time the connection is activated.
+      </para>
+    </example>
+
     <example><title>Adding a bonding master and two slave connection profiles</title>
 <screen><prompt>$ </prompt><userinput>nmcli con add type bond ifname mybond0 mode active-backup</userinput>
 <prompt>$ </prompt><userinput>nmcli con add type ethernet ifname eth1 master mybond0</userinput>
@@ -272,6 +285,23 @@ IP4:192.168.1.12/24:192.168.1.1::192.168.1.1::</screen>
       </para>
     </example>
 
+    <example><title>Adding an Ethernet connection and configuring SR-IOV VFs</title>
+<screen><prompt>$ </prompt><userinput>nmcli con add type ethernet con-name EthernetPF ifname em1</userinput>
+<prompt>$ </prompt><userinput>nmcli con modify EthernetPF sriov.total-vfs 3 sriov.autoprobe-drivers false</userinput>
+<prompt>$ </prompt><userinput>nmcli con modify EthernetPF sriov.vfs '0 mac=00:11:22:33:44:55 vlans=10, 1 trust=true spoof-check=false'</userinput>
+<prompt>$ </prompt><userinput>nmcli con modify EthernetPF +sriov.vfs '2 max-tx-rate=20'</userinput></screen>
+      <para>
+        This example demonstrates adding an Ethernet connection for
+        physical function (PF) <emphasis>ens4</emphasis> and
+        configuring 3 SR-IOV virtual functions (VFs) on it. The first
+        VF is configured with MAC address 00:11:22:33:44:55 and VLAN
+        10, the second one has the <emphasis>trust</emphasis> and
+        <emphasis>spoof-check</emphasis> features respectively enabled
+        and disabled. VF number 2 has a maximux transmission rate of
+        20Mbps. The kernel is instructed to not automatically
+        instantiate a network interface for the VFs.
+      </para>
+    </example>
 
     <example><title>Escaping colon characters in tabular mode</title>
 <screen><prompt>$ </prompt><userinput>nmcli -t -f general -e yes -m tab dev show eth0</userinput>