آشنایی با Netplan (Introduction to Netplan)(5)

File Formats Manual

آشنایی با Netplan (Introduction to Netplan)(5)

نام (NAME)

netplan - لایه انتزاعی پیکربندی شبکه با YAML برای بک‌اندهای مختلف

خلاصه دستور (SYNOPSIS)

netplan [COMMAND|help]

دستورها (COMMANDS)

برای مشاهده فهرستی از دستورهای موجود در این سیستم، netplan help را ببینید.

توضیحات (DESCRIPTION)

نصب‌کننده‌های توزیع، نمونه‌سازی ابری، ساخت ایمیج برای دستگاه‌های خاص یا هر روش دیگر برای استقرار یک سیستم‌عامل، پیکربندی شبکه مورد نظر خود را در فایل(های) پیکربندی YAML قرار می‌دهند. در مراحل اولیه راه‌اندازی (early boot)، «رندرکننده شبکه» (network renderer) Netplan اجرا می‌شود که /{lib,etc,run}/netplan/*.yaml را خوانده و پیکربندی را در /run می‌نویسد تا کنترل دستگاه‌ها را به دیمن شبکه مشخص‌شده واگذار کند.

•: دستگاه‌های پیکربندی‌شده به طور پیش‌فرض توسط systemd-networkd مدیریت می‌شوند، مگر اینکه صریحاً به عنوان مدیریت‌شده توسط یک رندرکننده خاص (NetworkManager) علامت‌گذاری شده باشند.
•: دستگاه‌هایی که در پیکربندی شبکه پوشش داده نشده‌اند به هیچ وجه دستکاری نمی‌شوند.
•: قابل استفاده در initramfs (وابستگی‌های کم و سریع).
•: عدم وجود پیکربندی تولیدشده دائمی؛ تنها پیکربندی اصلی YAML حفظ می‌شود.
•: تجزیه‌کننده (parser) از چندین فایل پیکربندی پشتیبانی می‌کند تا به برنامه‌هایی مانند libvirt یا lxd اجازه دهد پیکربندی شبکه مورد انتظار خود را بسته‌بندی کنند (virbr0، lxdbr0)، یا خط‌مشی پیش‌فرض سراسری را برای استفاده از NetworkManager برای همه‌چیز تغییر دهند.
•: انعطاف‌پذیری برای تغییر بک‌اندها/خط‌مشی در آینده یا سازگاری با حذف NetworkManager را حفظ می‌کند، زیرا پیکربندی تولیدشده موقتی (ephemeral) است.

ساختار کلی (General structure)

فایل‌های پیکربندی Netplan از قالب YAML استفاده می‌کنند. تمام فایل‌های /{lib,etc,run}/netplan/*.yaml در نظر گرفته می‌شوند. فایل‌هایی که از نظر الفبایی دیرتر قرار دارند (صرف نظر از اینکه در کدام دایرکتوری هستند)، فایل‌های قبلی را اصلاح (کلیدهای نگاشت جدید) یا بازنویسی (همان کلیدهای نگاشت) می‌کنند. یک فایل در /run/netplan به طور کامل روی فایلی با همان نام در /etc/netplan سایه می‌اندازد (آن را نادیده می‌گیرد)، و یک فایل در هر یک از این دایرکتوری‌ها روی فایلی با همان نام در /lib/netplan سایه می‌اندازد.

گره سطح بالا در یک فایل پیکربندی Netplan نگاشت network: است که حاوی version: 2 است (قالب YAML که در حال حاضر توسط curtin، MAAS و غیره استفاده می‌شود نسخه ۱ است)، و سپس تعاریف دستگاه‌ها بر اساس نوع آنها گروه‌بندی می‌شوند، مانند ethernets:، modems:، wifis: یا bridges:. اینها انواعی هستند که رندرکننده ما می‌تواند آنها را درک کند و توسط بک‌اندهای ما پشتیبانی می‌شوند.

هر بلوک نوع شامل تعاریف دستگاه به صورت یک نگاشت است که در آن کلیدها (که «شناسه‌های پیکربندی» یا configuration IDs نامیده می‌شوند) به شرح زیر تعریف شده‌اند.

شناسه‌های پیکربندی دستگاه (Device configuration IDs)

نام کلیدها در زیر نگاشت‌های تعریف بر پایه نوع دستگاه (مانند ethernets:) «شناسه» (ID) نامیده می‌شوند. آنها باید در کل مجموعه فایل‌های پیکربندی یکتا باشند. هدف اصلی آنها این است که به عنوان نام‌های لنگر برای دستگاه‌های مرکب عمل کنند، به عنوان مثال برای شمارش اعضای پلی (bridge) که در حال حاضر تعریف می‌شود.

(از نسخه 0.97) اگر یک رابط با یک شناسه در یک فایل پیکربندی تعریف شود، توسط رندرکننده مربوطه فعال و راه‌اندازی (bring up) خواهد شد. برای اینکه Netplan به هیچ وجه به یک رابط دست نزند، باید به طور کامل از فایل‌های پیکربندی Netplan حذف شود.

دو دسته از نظر فیزیکی/ساختاری متفاوت از تعاریف دستگاه وجود دارد و فیلد شناسه برای هر یک تفسیر متفاوتی دارد:

دستگاه‌های فیزیکی

(مثال‌ها: اترنت، مودم، وای‌فای) این دستگاه‌ها می‌توانند بین راه‌اندازی‌های مجدد و حتی در طول زمان اجرا (اتصال حین کار یا hot plugging) به صورت پویا بیایند و بروند. در حالت کلی، آنها را می‌توان با قوانین match: بر روی ویژگی‌های مورد نظر، مانند نام/الگوی نام، آدرس MAC، درایور یا مسیرهای دستگاه انتخاب کرد. به طور کلی این قوانین با هر تعداد دستگاه مطابقت خواهند داشت (مگر اینکه به ویژگی‌های یکتا مانند مسیر کامل یا آدرس MAC اشاره کنند)، بنابراین بدون دانش بیشتر در مورد سخت‌افزار، اینها همیشه به عنوان یک گروه در نظر گرفته می‌شوند.

معتبر است که هیچ قانون تطبیقی مشخص نشود، که در این صورت فیلد شناسه صرفاً نام رابطی است که باید مطابقت داده شود. این بیشتر زمانی مفید است که بخواهید موارد ساده را ساده نگه دارید، و این روشی است که پیکربندی دستگاه‌های شبکه برای مدت طولانی انجام شده است.

اگر قوانین match: وجود داشته باشد، فیلد شناسه یک نام کاملاً مات (opaque) است که فقط برای ارجاع از تعاریف دستگاه‌های ترکیبی در پیکربندی استفاده می‌شود.

دستگاه‌های مجازی

(مثال‌ها: veth، bridge، bond، vrf) این دستگاه‌ها کاملاً تحت کنترل فایل(های) پیکربندی و پشته شبکه هستند. به عبارت دیگر، این دستگاه‌ها به جای تطبیق داده شدن، ایجاد می‌شوند. بنابراین match: و set-name: برای اینها کاربردی ندارند و فیلد شناسه همان نام دستگاه مجازی ایجادشده است.

پیکربندی YAML (YAML configuration)

ساختار سطح بالای پیکربندی (Top-level configuration structure)

ساختار کلی یک فایل Netplan YAML در زیر نشان داده شده است.

network:
  version: NUMBER
  renderer: STRING
  bonds: MAPPING
  bridges: MAPPING
  dummy-devices: MAPPING
  ethernets: MAPPING
  modems: MAPPING
  tunnels: MAPPING
  virtual-ethernets: MAPPING
  vlans: MAPPING
  vrfs: MAPPING
  wifis: MAPPING
  nm-devices: MAPPING

•

version (عدد)

مشخص می‌کند چه نسخه‌ای از قالب پیکربندی استفاده شده است. تنها مقدار پشتیبانی‌شده 2 است. در صورت عدم تعریف، مقدار پیش‌فرض 2 است.

•: renderer (اسکالر)

مشخص می‌کند چه ابزار پیکربندی شبکه‌ای برای تنظیم پیکربندی شما استفاده خواهد شد. مقادیر معتبر networkd و NetworkManager هستند. در صورت عدم تعریف، مقدار پیش‌فرض networkd است.

•: bonds (نگاشت)

دستگاه‌های تجمیع پیوند (باندینگ) را ایجاد و پیکربندی می‌کند.

•: bridges (نگاشت)

دستگاه‌های پل (bridge) را ایجاد و پیکربندی می‌کند.

•: dummy-devices (نگاشت) – از نسخه 0.107

دستگاه‌های مجازی را ایجاد و پیکربندی می‌کند.

•: ethernets (نگاشت)

رابط‌های فیزیکی اترنت را پیکربندی می‌کند.

•: modems (نگاشت)

مودم‌ها را پیکربندی می‌کند.

•: tunnels (نگاشت)

انواع مختلف تونل‌های مجازی را ایجاد و پیکربندی می‌کند.

•: virtual-ethernets (نگاشت) – از نسخه 0.107

دستگاه‌های اترنت مجازی (veth) را ایجاد و پیکربندی می‌کند.

•: vlans (نگاشت)

VLANها را ایجاد و پیکربندی می‌کند.

•: vrfs (نگاشت)

دستگاه‌های مسیریابی و فوروارد مجازی (VRF) را پیکربندی می‌کند.

•: wifis (نگاشت)

رابط‌های فیزیکی وای‌فای را به صورت client، adhoc یا access point پیکربندی می‌کند.

•: nm-devices (نگاشت)

دستگاه‌های nm-devices در شرایطی استفاده می‌شوند که Netplan از نوع اتصال پشتیبانی نمی‌کند. پیکربندی خامی که توسط NetworkManager انتظار می‌رود می‌تواند تعریف شود و همان‌طور که هست (passthrough) به فایل .nmconnection منتقل می‌شود. کاربران معمولاً از این نوع دستگاه استفاده نخواهند کرد.

تمام ویژگی‌ها برای تمامی انواع دستگاه‌ها در بخش‌های بعدی توضیح داده خواهد شد.

ویژگی‌های انواع دستگاه‌های فیزیکی (Properties for physical device types)

این ویژگی‌ها برای دستگاه‌های فیزیکی مانند رابط‌های شبکه اترنت و وای‌فای استفاده می‌شوند.

نکته: برخی از گزینه‌ها برای دستگاه‌هایی که فقط بر اساس نام مطابقت داده شده‌اند و توسط networkd رندر می‌شوند، به دلیل تداخل با تغییر نام دستگاه در udev، به درستی کار نخواهند کرد. هنگام تنظیم گزینه‌هایی مانند: wakeonlan یا *-offload دستگاه‌ها را بر اساس MAC مطابقت دهید.

•: match (نگاشت)

این ویژگی زیرمجموعه‌ای از دستگاه‌های فیزیکی موجود را بر اساس ویژگی‌های سخت‌افزاری مختلف انتخاب می‌کند. پیکربندی زیر سپس بر روی تمام دستگاه‌های منطبق، به محض ظاهر شدن آنها اعمال خواهد شد. تمام ویژگی‌های مشخص‌شده باید مطابقت داشته باشند.

•: name (اسکالر)

نام فعلی رابط. الگوهای تطبیق سراسری (Globs) پشتیبانی می‌شوند و مورد استفاده اصلی برای تطبیق روی نام‌ها هستند، زیرا انتخاب یک نام ثابت را می‌توان با عدم استفاده از match: و صرفاً استفاده از شناسه (ID) راحت‌تر انجام داد (بالا را ببینید). (NetworkManager: از نسخه v1.14.0 به بعد)

•: macaddress (اسکالر)

آدرس دائمی ۶ بایتی MAC دستگاه در قالب XX:XX:XX:XX:XX:XX یا ۲۰ بایت برای دستگاه‌های اینفینی‌بند (IPoIB). الگوهای تطبیق (Globs) مجاز نیستند. این گزینه با آدرس‌های MAC مجازی برای veth، bridge، bond، vlan و ... مطابقت ندارد.

•: driver (اسکالر یا دنباله‌ای از اسکالرها) – دنباله از نسخه 0.104

نام درایور هسته، مطابق با ویژگی udev به نام DRIVER. دنباله‌ای از الگوها (globs) پشتیبانی می‌شود که هر یک از آنها می‌تواند مطابقت داشته باشد. تطبیق بر اساس درایور تنها با networkd پشتیبانی می‌شود.

مثال‌ها:

•: تمام کارت‌های روی گذرگاه دوم PCI:

network:
  ethernets:
    myinterface:
      match:
        name: enp2*

•: آدرس MAC ثابت:

network:
  ethernets:
    interface0:
      match:
        macaddress: 11:22:33:AA:BB:FF

•: اولین کارت درایور ixgbe:

network:
  ethernets:
    nic0:
      match:
        driver: ixgbe
        name: en*s0

•: اولین کارت با درایوری منطبق با bcmgenet یا smsc*:

network:
  ethernets:
    nic0:
      match:
        driver: ["bcmgenet", "smsc*"]
        name: en*

•: set-name (اسکالر)

هنگام تطبیق بر روی ویژگی‌های یکتا مانند مسیر یا MAC، یا با فرضیات اضافی مانند «تنها یک دستگاه وای‌فای وجود خواهد داشت»، قوانین تطبیق را می‌توان طوری نوشت که تنها با یک دستگاه مطابقت داشته باشند. سپس می‌توان از این ویژگی استفاده کرد تا نام خاص‌تر یا مطلوب‌تری نسبت به نام پیش‌فرض udev ifnames به آن دستگاه اختصاص داده شود. هر دستگاه اضافی که قوانین تطبیق را برآورده کند، در تغییر نام ناموفق خواهد بود و نام اصلی هسته را حفظ می‌کند (و dmesg یک خطا را نشان می‌دهد).

•: wakeonlan (بولی)

قابلیت Wake on LAN را فعال می‌کند. به طور پیش‌فرض غیرفعال (خاموش) است.

•: emit-lldp (بولی) – از نسخه 0.99

(فقط بک‌اند networkd) ارسال بسته‌های LLDP را مشخص می‌کند. به طور پیش‌فرض غیرفعال است.

•: receive-checksum-offload (بولی) – از نسخه 0.104

(فقط بک‌اند networkd) اگر روی true (false) تنظیم شود، برون‌سپاری سخت‌افزاری برای محاسبه چکسام بسته‌های ورودی شبکه فعال (غیرفعال) می‌شود. در صورت عدم تنظیم، از مقدار پیش‌فرض هسته استفاده خواهد شد.

•: transmit-checksum-offload (بولی) – از نسخه 0.104

(فقط بک‌اند networkd) اگر روی true (false) تنظیم شود، برون‌سپاری سخت‌افزاری برای محاسبه چکسام بسته‌های خروجی شبکه فعال (غیرفعال) می‌شود. در صورت عدم تنظیم، از مقدار پیش‌فرض هسته استفاده خواهد شد.

•: tcp-segmentation-offload (بولی) – از نسخه 0.104

(فقط بک‌اند networkd) اگر روی true (false) تنظیم شود، برون‌سپاری قطعه‌بندی TCP (یا TSO) فعال (غیرفعال) می‌شود. در صورت عدم تنظیم، از مقدار پیش‌فرض هسته استفاده خواهد شد.

•: tcp6-segmentation-offload (بولی) – از نسخه 0.104

(فقط بک‌اند networkd) اگر روی true (false) تنظیم شود، برون‌سپاری قطعه‌بندی TCP6 (tx-tcp6-segmentation) فعال (غیرفعال) می‌شود. در صورت عدم تنظیم، از مقدار پیش‌فرض هسته استفاده خواهد شد.

•: generic-segmentation-offload (بولی) – از نسخه 0.104

(فقط بک‌اند networkd) اگر روی true (false) تنظیم شود، برون‌سپاری قطعه‌بندی عمومی (GSO) فعال (غیرفعال) می‌شود. در صورت عدم تنظیم، از مقدار پیش‌فرض هسته استفاده خواهد شد.

•: generic-receive-offload (بولی) – از نسخه 0.104

(فقط بک‌اند networkd) اگر روی true (false) تنظیم شود، برون‌سپاری دریافت عمومی (GRO) فعال (غیرفعال) می‌شود. در صورت عدم تنظیم، از مقدار پیش‌فرض هسته استفاده خواهد شد.

•: large-receive-offload (بولی) – از نسخه 0.104

(فقط بک‌اند networkd) اگر روی true (false) تنظیم شود، برون‌سپاری دریافت بزرگ (LRO) فعال (غیرفعال) می‌شود. در صورت عدم تنظیم، از مقدار پیش‌فرض هسته استفاده خواهد شد.

•: openvswitch (نگاشت) – از نسخه 0.100

این ویژگی پیکربندی اضافی را برای دستگاه شبکه openvswitch فراهم می‌کند. اگر Open vSwitch روی سیستم در دسترس نباشد، Netplan وجود پیکربندی openvswitch را به عنوان یک خطا در نظر می‌گیرد.

هر دستگاه شبکه پشتیبانی‌شده‌ای که با نگاشت openvswitch اعلان شده باشد (یا هر bond/bridge که شامل رابطی با پیکربندی openvswitch باشد) به جای رندرکننده تعریف‌شده، در openvswitch ایجاد خواهد شد. در صورت تعریف یک vlan که به همین ترتیب اعلان شده باشد، Netplan یک پل ساختگی VLAN در openvswitch با ویژگی‌های درخواستی vlan ایجاد خواهد کرد.

•: external-ids (نگاشت) – از نسخه 0.100

به طور مستقیم به Open vSwitch منتقل می‌شود.

•: other-config (نگاشت) – از نسخه 0.100

به طور مستقیم به Open vSwitch منتقل می‌شود.

•: lacp (اسکالر) – از نسخه 0.100

برای رابط‌های bond معتبر است. مقادیر active، passive یا off (پیش‌فرض) را می‌پذیرد.

•: fail-mode (اسکالر) – از نسخه 0.100

برای رابط‌های bridge معتبر است. مقادیر secure یا standalone (پیش‌فرض) را می‌پذیرد.

•: mcast-snooping (بولی) – از نسخه 0.100

برای رابط‌های bridge معتبر است. به طور پیش‌فرض False است.

•: protocols (دنباله‌ای از اسکالرها) – از نسخه 0.100

برای رابط‌های bridge یا بخش network معتبر است. فهرستی از پروتکل‌هایی که باید هنگام مذاکره برای اتصال با کنترل‌کننده استفاده شوند. مقادیر OpenFlow10، OpenFlow11، OpenFlow12، OpenFlow13، OpenFlow14 و OpenFlow15 را می‌پذیرد.

•: rstp (بولی) – از نسخه 0.100

برای رابط‌های bridge معتبر است. به طور پیش‌فرض False است.

•: controller (نگاشت) – از نسخه 0.100

برای رابط‌های bridge معتبر است. یک کنترل‌کننده خارجی OpenFlow را مشخص می‌کند.

•: addresses (دنباله‌ای از اسکالرها)

فهرستی از آدرس‌ها را برای اهداف کنترل‌کننده تنظیم می‌کند. نحو این آدرس‌ها همان‌طور است که در ovs-vsctl(8) تعریف شده است. مثال: addresses: [tcp:127.0.0.1:6653, "ssl:[fe80::1234%eth0]:6653"].

•: connection-mode (اسکالر)

حالت اتصال را برای کنترل‌کننده تنظیم می‌کند. گزینه‌های پشتیبانی‌شده in-band و out-of-band هستند. مقدار پیش‌فرض in-band است.

•: ports (دنباله‌ای از دنباله‌های اسکالر) – از نسخه 0.100

پورت‌های پچ Open vSwitch. هر پورت به عنوان یک جفت نام اعلان می‌شود که می‌توان به عنوان رابط در دستگاه‌های مجازی وابسته (bonds، bridges) به آنها ارجاع داد.

مثال:

openvswitch:
  ports:
    - [patch0-1, patch1-0]

•: ssl (نگاشت) – از نسخه 0.100

برای تنظیمات سراسری openvswitch معتبر است. گزینه‌هایی برای پیکربندی نقطه پایانی سرور SSL برای سوئیچ.

•: ca-cert (اسکالر)

مسیر فایلی که حاوی گواهی CA مورد استفاده است.

•: certificate (اسکالر)

مسیر فایلی که حاوی گواهی سرور است.

•: private-key (اسکالر)

مسیر فایلی که حاوی کلید خصوصی برای سرور است.

ویژگی‌های تمام انواع دستگاه‌ها (Properties for all device types)

•: renderer (اسکالر)

از بک‌اند شبکه داده‌شده برای این تعریف استفاده کنید. در حال حاضر networkd و NetworkManager پشتیبانی می‌شوند. این ویژگی را می‌توان به صورت سراسری در network:، برای یک نوع دستگاه (مثلاً در ethernets:) یا برای یک تعریف دستگاه خاص مشخص کرد. پیش‌فرض networkd است.

(از نسخه 0.99) ویژگی renderer یک مقدار قابل قبول اضافی برای شیء‌های VLAN دارد (یعنی تعریف‌شده در vlans:): sriov. اگر یک VLAN با رندرکننده sriov برای یک رابط تابع مجازی (Virtual Function) SR-IOV تعریف شود، این کار باعث می‌شود Netplan یک فیلتر VLAN سخت‌افزاری برای آن تنظیم کند. در هر VF فقط یک مورد می‌تواند تعریف شود.

•: dhcp4 (بولی)

فعال‌سازی DHCP برای IPv4. به طور پیش‌فرض خاموش است.

•: dhcp6 (بولی)

فعال‌سازی DHCP برای IPv6. به طور پیش‌فرض خاموش است. این گزینه هم DHCP بدون وضعیت (stateless) - جایی که سرور DHCP اطلاعاتی مانند سرورهای نام DNS را ارائه می‌دهد اما آدرس IP را تعیین نمی‌کند - و هم DHCP دارای وضعیت (stateful) را پوشش می‌دهد، جایی که سرور هم آدرس و هم سایر اطلاعات را ارائه می‌دهد.

اگر در یک محیط منحصراً IPv6 با پیکربندی خودکار کاملاً بدون وضعیت (SLAAC به همراه RDNSS) هستید، این گزینه می‌تواند طوری تنظیم شود که باعث فعال‌سازی و بالا آمدن رابط شود. (تنظیم accept-ra به تنهایی کافی نیست.) پیکربندی خودکار همچنان از محتوای اعلان روتر (Router Advertisement) پیروی می‌کند و تنها در صورت درخواست در RA از DHCP استفاده خواهد کرد.

توجه داشته باشید که برای استفاده از RDNSS با networkd، به rdnssd(8) نیاز است. هیچ نرم‌افزار اضافی برای NetworkManager مورد نیاز نیست.

•: ipv6-mtu (اسکالر) – از نسخه 0.98 > مقدار MTU برای IPv6 را تنظیم می‌کند (فقط با بک‌اند networkd پشتیبانی می‌شود). توجه داشته باشید > که نیاز به تنظیم این مورد یک الزام غیرمعمول است. > > نیازمند ویژگی: ipv6-mtu
•: ipv6-privacy (بولی)

پسوندهای حریم خصوصی IPv6 (RFC 4941) را برای رابط مشخص‌شده فعال کرده و آدرس‌های موقت را ترجیح می‌دهد. پیش‌فرض false است - بدون پسوندهای حریم خصوصی. در حال حاضر راهی برای داشتن آدرس خصوصی اما ترجیح دادن آدرس عمومی وجود ندارد.

•: link-local (دنباله‌ای از اسکالرها)

آدرس‌های پیوند-محلی (link-local) را برای راه‌اندازی پیکربندی می‌کند. گزینه‌های معتبر ipv4 و ipv6 هستند که به ترتیب اجازه فعال‌سازی آدرس‌دهی پیوند-محلی IPv4 و IPv6 را می‌دهند. اگر این فیلد تعریف نشود، پیش‌فرض فعال‌سازی تنها آدرس‌های پیوند-محلی IPv6 است. اگر فیلد تعریف شده اما به عنوان یک مجموعه خالی پیکربندی شود، آدرس‌های پیوند-محلی IPv6 و همچنین آدرس‌های پیوند-محلی IPv4 غیرفعال می‌شوند.

این ویژگی آدرس‌های پیوند-محلی را برای یک پروتکل فعال یا غیرفعال می‌کند، اما پیاده‌سازی واقعی در هر بک‌اند متفاوت است. در networkd، این مورد مستقیماً رفتار را تغییر می‌دهد و ممکن است یک آدرس اضافی روی یک رابط اضافه کند. هنگام استفاده از بک‌اند NetworkManager، در صورتی که رابط DHCP را نیز فعال داشته باشد، فعال‌سازی پیوند-محلی هیچ تاثیری ندارد.

مثال‌ها:

•: فقط فعال‌سازی پیوند-محلی IPv4: link-local: [ ipv4 ]
•: فعال‌سازی تمام آدرس‌های پیوند-محلی: link-local: [ ipv4, ipv6 ]
•: غیرفعال‌سازی تمام آدرس‌های پیوند-محلی: link-local: [ ]

•: ignore-carrier (بولی) – از نسخه 0.104

(فقط بک‌اند networkd) به رابط مشخص‌شده اجازه می‌دهد حتی در صورت نداشتن حامل (carrier) پیکربندی شود.

•: critical (بولی)

اتصال را به عنوان «حیاتی برای سیستم» (critical to the system) تعیین می‌کند، به این معنی که توجه ویژه‌ای صورت می‌گیرد تا هنگام راه‌اندازی مجدد دیمن، IP اختصاص‌یافته آزاد نشود. (توسط NetworkManager شناخته نمی‌شود)

•: dhcp-identifier (اسکالر)

(فقط بک‌اند networkd) منبع شناسه کلاینت DHCP (v4) را تنظیم می‌کند. اگر mac مشخص شود، از آدرس MAC پیوند استفاده می‌شود. اگر این گزینه حذف شود، یا اگر duid مشخص شود، networkd یک شناسه کلاینت منطبق با RFC4361 برای رابط با ترکیب IAID و DUID پیوند تولید می‌کند.

•: dhcp4-overrides (نگاشت)

(فقط بک‌اند networkd) رفتار پیش‌فرض DHCP را بازنویسی می‌کند؛ بخش بازنویسی‌های DHCP را در زیر ببینید.

•: dhcp6-overrides (نگاشت)

(فقط بک‌اند networkd) رفتار پیش‌فرض DHCP را بازنویسی می‌کند؛ بخش بازنویسی‌های DHCP را در زیر ببینید.

•: accept-ra (بولی)

اعلان‌های روتر (Router Advertisement) را که باعث می‌شود هسته به خودی خود IPv6 را پیکربندی کند، می‌پذیرد. هنگامی که فعال باشد، اعلان‌های روتر پذیرفته می‌شوند. هنگامی که غیرفعال باشد، به اعلان‌های روتر پاسخی داده نمی‌شود. در صورت عدم تنظیم، از مقدار پیش‌فرض هسته میزبان استفاده می‌شود.

•: ra-overrides (نگاشت) – از نسخه 1.1

(فقط بک‌اند networkd) رفتار پیش‌فرض اعلان روتر IPv6 (RA) را بازنویسی می‌کند؛ بخش بازنویسی‌های اعلان روتر IPv6 را در زیر ببینید.

•: addresses (دنباله‌ای از اسکالرها و نگاشت‌ها)

افزودن آدرس‌های ایستا به رابط علاوه بر آدرس‌های دریافت شده از طریق DHCP یا RA. هر ورودی دنباله در نمادگذاری CIDR است، یعنی به شکل addr/prefixlen. addr یک آدرس IPv4 یا IPv6 است که توسط inet_pton(3) شناخته می‌شود و prefixlen تعداد بیت‌های زیرشبکه است.

برای دستگاه‌های مجازی (پل‌ها، باندها، VLAN) اگر هیچ آدرسی پیکربندی نشده باشد و DHCP غیرفعال باشد، رابط ممکن است همچنان آنلاین شود، اما از طریق شبکه قابل آدرس‌دهی نخواهد بود.

علاوه بر خود آدرس‌ها، می‌توان پارامترهای پیکربندی را به صورت نگاشت مشخص کرد. گزینه‌های پشتیبانی‌شده فعلی عبارتند از:

•: lifetime (اسکالر) – از نسخه 0.100

پیش‌فرض: forever. این مقدار می‌تواند forever یا 0 باشد و با گزینه PreferredLifetime در بخش Address از systemd-networkd مطابقت دارد. در حال حاضر فقط در بک‌اند networkd پشتیبانی می‌شود.

•: label (اسکالر) – از نسخه 0.100

برچسب آدرس IP، معادل دستور ip address label. در حال حاضر فقط در بک‌اند networkd پشتیبانی می‌شود.

مثال‌ها:

•: ساده: addresses: [192.168.14.2/24, "2001:1::1/64"]
•: پیشرفته:

network:
  ethernets:
    eth0:
      addresses:
        - "10.0.0.15/24":
            lifetime: 0
            label: "maas"
        - "2001:1::1/64"

•: ipv6-address-generation (اسکالر) – از نسخه 0.99

پیکربندی روش ایجاد آدرس برای استفاده با پیکربندی خودکار آدرس بدون وضعیت IPv6 طبق RFC4862. مقادیر ممکن eui64 یا stable-privacy هستند.

•: ipv6-address-token (اسکالر) – از نسخه 0.100

تعریف یک توکن آدرس IPv6 برای ایجاد یک شناسه رابط ایستا برای پیکربندی خودکار آدرس بدون وضعیت IPv6. این گزینه با ipv6-address-generation مانعة‌الجمع است.

•: gateway4، gateway6 (اسکالر)

منسوخ شده است، مسیرهای پیش‌فرض را ببینید. تنظیم دروازه (gateway) پیش‌فرض برای IPv4/6، برای پیکربندی دستی آدرس. این مورد نیازمند تنظیم addresses نیز می‌باشد. آدرس‌های IP دروازه باید در قالبی باشند که توسط inet_pton(3) شناخته می‌شود. در پیکربندی سراسری شما تنها باید یک دروازه به ازای هر خانواده آدرس IP تنظیم شود تا ابهامی وجود نداشته باشد. در صورت نیاز به چندین مسیر پیش‌فرض، لطفاً آنها را از طریق routing-policy تعریف کنید.

مثال‌ها:

•: IPv4: gateway4: 172.16.0.1
•: IPv6: gateway6: "2001:4::1"

•: nameservers (نگاشت)

تنظیم سرورهای DNS و دامنه‌های جستجو، برای پیکربندی دستی آدرس. دو فیلد پشتیبانی‌شده وجود دارد: addresses: فهرستی از آدرس‌های IPv4 یا IPv6 مشابه با gateway* است، و search: فهرستی از دامنه‌های جستجو است.

مثال:

network:
  ethernets:
    id0:
      [...]
      nameservers:
        search: [lab, home]
        addresses: [8.8.8.8, "FEDC::1"]

•: macaddress (اسکالر)

تنظیم آدرس MAC دستگاه. آدرس MAC باید در قالب "XX:XX:XX:XX:XX:XX" باشد. گزینه‌های ویژه زیر نیز پذیرفته می‌شوند: permanent و random. علاوه بر این گزینه‌ها، رندرکننده NetworkManager مقادیر stable، stable-ssid (فقط وای‌فای) و preserve را نیز می‌پذیرد.

نکته: این گزینه برای دستگاه‌هایی که فقط بر اساس نام مطابقت داده شده و توسط networkd رندر می‌شوند، به دلیل تداخل با تغییر نام دستگاه در udev، به درستی کار نخواهد کرد. هنگام تنظیم آدرس‌های MAC دستگاه‌ها را بر اساس MAC تطبیق دهید.

مثال:

network:
  ethernets:
    id0:
      match:
        macaddress: 52:54:00:6b:3c:58
      [...]
      macaddress: 52:54:00:6b:3c:59

•: mtu (اسکالر)

تنظیم واحد بیشینه انتقال (MTU) برای رابط. پیش‌فرض 1500 است. مقادیر معتبر به رابط شبکه شما بستگی دارد.

نکته: این گزینه برای دستگاه‌هایی که فقط بر اساس نام مطابقت داده شده و توسط networkd رندر می‌شوند، به دلیل تداخل با تغییر نام دستگاه در udev، به درستی کار نخواهد کرد. هنگام تنظیم MTU دستگاه‌ها را بر اساس MAC تطبیق دهید.

•: optional (بولی)

یک دستگاه اختیاری برای راه‌اندازی سیستم (booting) الزامی نیست. به طور معمول، networkd قبل از ادامه راه‌اندازی مدتی منتظر می‌ماند تا دستگاه پیکربندی شود. با این حال، اگر یک دستگاه به عنوان اختیاری علامت‌گذاری شود، networkd منتظر آن نخواهد ماند. این گزینه تنها توسط networkd پشتیبانی می‌شود و مقدار پیش‌فرض false است.

مثال:

network:
  ethernets:
    eth7:
      # این به یک شبکه آزمایشی متصل است که اغلب
      # قطع است - در طول بوت منتظر بالا آمدن آن نباشید.
      dhcp4: true
      optional: true

•: optional-addresses (دنباله‌ای از اسکالرها)

تعیین انواع آدرس‌هایی که برای آنلاین در نظر گرفته شدن یک دستگاه الزامی نیستند. این کار رفتار بک‌اندها را در زمان راه‌اندازی تغییر می‌دهد تا از انتظار برای آدرس‌هایی که اختیاری علامت‌گذاری شده‌اند جلوگیری شود و در نتیجه رابط زودتر به عنوان «قابل استفاده» در نظر گرفته شود. این کار این آدرس‌ها را غیرفعال نمی‌کند و آنها در هر صورت بالا خواهند آمد.

مثال:

network:
  ethernets:
    eth7:
      dhcp4: true
      dhcp6: true
      optional-addresses: [ ipv4-ll, dhcp6 ]

•: activation-mode (اسکالر) – از نسخه 0.103

امکان تعیین خط‌مشی مدیریت رابط انتخاب‌شده را فراهم می‌کند. به طور پیش‌فرض، Netplan هر رابط پیکربندی‌شده را در صورت امکان بالا می‌آورد. با استفاده از تنظیم activation-mode کاربران می‌توانند آن رفتار را لغو کرده و با تعیین manual، کنترل وضعیت رابط را به مدیر سیستم واگذار کنند یا (فقط برای بک‌اند networkd) با تعیین off پیوند را در تمام اوقات در حالت خاموش (down) نگه دارند. هر رابطی که activation-mode برای آن تعریف شده باشد، به صورت ضمنی optional در نظر گرفته می‌شود. به طور رسمی از networkd نسخه v248+ پشتیبانی می‌شود.

مثال:

network:
  ethernets:
    eth1:
      # این رابط به طور خودکار در وضعیت UP قرار نخواهد گرفت
      dhcp4: true
      activation-mode: manual

•: routes (دنباله‌ای از نگاشت‌ها)

مسیریابی ایستا را برای دستگاه پیکربندی می‌کند؛ بخش مسیریابی را در زیر ببینید.

•: routing-policy (دنباله‌ای از نگاشت‌ها)

مسیریابی مبتنی بر خط‌مشی (Policy Routing) را برای دستگاه پیکربندی می‌کند؛ بخش مسیریابی را در زیر ببینید.

•: neigh-suppress (اسکالر) – از نسخه 0.105

یک مقدار بولی می‌گیرد. مشخص می‌کند که آیا سرکوب همسایه (Neighbour Suppression) برای ARP و ND برای این پورت پل فعال است یا خیر. در صورت عدم تنظیم، از مقدار پیش‌فرض هسته استفاده خواهد شد.

•: hairpin (اسکالر) – از نسخه 1.0

یک مقدار بولی می‌گیرد. مشخص می‌کند که آیا ترافیک مجاز است به همان پورت پلی که از آن دریافت شده بازگردانده شود یا خیر. هنگامی که این پرچم false باشد، پل ترافیک را به پورت دریافت‌کننده بازنمی‌فرستد. در صورت عدم تنظیم، از پیش‌فرض بک‌اند استفاده می‌شود.

•: port-mac-learning (اسکالر) – از نسخه 1.0

یک مقدار بولی می‌گیرد. مشخص می‌کند که آیا یادگیری آدرس MAC برای این پورت پل فعال است یا خیر. در صورت عدم تنظیم، از مقدار پیش‌فرض هسته استفاده می‌شود. در حال حاضر فقط در بک‌اند networkd پشتیبانی می‌شود.

بازنویسی‌های DHCP (DHCP Overrides)

چندین بازنویسی رفتار DHCP در دسترس است. در حال حاضر اکثر آنها فقط هنگام استفاده از بک‌اند networkd تاثیر دارند، به استثنای use-routes و route-metric.

بازنویسی‌ها تنها در صورتی اثر دارند که dhcp4 یا dhcp6 مربوطه روی true تنظیم شده باشد.

اگر هم dhcp4 و هم dhcp6 برابر true باشند، بک‌اند networkd نیازمند آن است که dhcp4-overrides و dhcp6-overrides شامل کلیدها و مقادیر یکسانی باشند. اگر مقادیر مطابقت نداشته باشند، خطایی نمایش داده می‌شود و پیکربندی شبکه اعمال نخواهد شد.

هنگام استفاده از بک‌اند NetworkManager، مقادیر مختلفی را می‌توان برای dhcp4-overrides و dhcp6-overrides مشخص کرد و مطابق با Netplan YAML به فرایندهای کلاینت DHCP اعمال خواهد شد.

•: dhcp4-overrides، dhcp6-overrides (نگاشت)

نگاشت‌های dhcp4-overrides و dhcp6-overrides رفتار پیش‌فرض DHCP را بازنویسی می‌کنند.

•: use-dns (بولی)

پیش‌فرض: true. هنگامی که true باشد، سرورهای DNS دریافت‌شده از سرور DHCP استفاده می‌شوند و بر هر سرور پیکربندی‌شده به صورت ایستا اولویت خواهند داشت. در حال حاضر فقط روی بک‌اند networkd تاثیر دارد.

•: use-ntp (بولی)

پیش‌فرض: true. هنگامی که true باشد، سرورهای NTP دریافت‌شده از سرور DHCP توسط systemd-timesyncd استفاده می‌شوند و بر هر سرور پیکربندی‌شده به صورت ایستا اولویت خواهند داشت. در حال حاضر فقط روی بک‌اند networkd تاثیر دارد.

•: send-hostname (بولی)

پیش‌فرض: true. هنگامی که true باشد، نام میزبان ماشین (hostname) به سرور DHCP ارسال می‌شود. در حال حاضر فقط روی بک‌اند networkd تاثیر دارد.

•: use-hostname (بولی)

پیش‌فرض: true. هنگامی که true باشد، نام میزبان دریافت‌شده از سرور DHCP به عنوان نام میزبان گذرا (transient hostname) سیستم تنظیم می‌شود. در حال حاضر فقط روی بک‌اند networkd تاثیر دارد.

•: use-mtu (بولی)

پیش‌فرض: true. هنگامی که true باشد، مقدار MTU دریافت‌شده از سرور DHCP به عنوان MTU رابط شبکه تنظیم می‌شود. هنگامی که false باشد، MTU اعلام‌شده توسط سرور DHCP نادیده گرفته می‌شود. در حال حاضر فقط روی بک‌اند networkd تاثیر دارد.

•: hostname (اسکالر)

از این مقدار به جای نام میزبان ماشین برای ارسال به سرور DHCP استفاده کنید. در حال حاضر فقط روی بک‌اند networkd تاثیر دارد.

•: use-routes (بولی)

پیش‌فرض: true. هنگامی که true باشد، مسیرهای دریافت‌شده از سرور DHCP به طور معمول در جدول مسیریابی نصب می‌شوند. هنگامی که روی false تنظیم شود، مسیرهای سرور DHCP نادیده گرفته می‌شوند: در این حالت، در صورت نیاز به عملکرد صحیح شبکه، مسئولیت افزودن مسیرهای ایستا بر عهده کاربر است. این به کاربران اجازه می‌دهد تا از نصب دروازه پیش‌فرض برای رابط‌های پیکربندی‌شده از طریق DHCP جلوگیری کنند. برای هر دو بک‌اند networkd و NetworkManager در دسترس است.

•: route-metric (اسکالر)

از این مقدار به عنوان متریک پیش‌فرض برای مسیرهای اضافه‌شده خودکار استفاده کنید. از این مورد برای اولویت‌بندی مسیرها برای دستگاه‌ها با تنظیم متریک پایین‌تر روی رابط ترجیحی استفاده کنید. برای هر دو بک‌اند networkd و NetworkManager در دسترس است.

•: use-domains (اسکالر) – از نسخه 0.98

یک مقدار بولی یا مقدار ویژه route را می‌پذیرد. هنگامی که true باشد، نام دامنه دریافت‌شده از سرور DHCP به عنوان دامنه جستجوی DNS روی این پیوند استفاده می‌شود، مشابه اثر تنظیم Domains=. اگر روی route تنظیم شود، نام دامنه دریافت‌شده از سرور DHCP تنها برای مسیریابی درخواست‌های DNS استفاده می‌شود و نه برای جستجو، مشابه اثر تنظیم Domains= هنگامی که آرگومان با ~ (تیلدا) پیشوند شده است.

نیازمند ویژگی: dhcp-use-domains

بازنویسی‌های اعلان روتر IPv6 (IPv6 Router Advertisement Overrides)

بازنویسی‌هایی برای رفتار اعلان روتر (RA) در IPv6 (فقط با بک‌اند networkd پشتیبانی می‌شود).

•: ra-overrides (نگاشت) – از نسخه 1.1

نگاشت‌های ra-overrides رفتار پیش‌فرض اعلان روتر IPv6 را بازنویسی می‌کنند.

•: use-dns (بولی)

پیش‌فرض: true. هنگامی که true باشد، سرورهای DNS دریافت‌شده از اعلان روتر استفاده خواهند شد. در حال حاضر فقط روی بک‌اند networkd تاثیر دارد.

•: use-domains (اسکالر)

یک مقدار بولی یا مقدار ویژه route را می‌پذیرد. هنگامی که true باشد، نام دامنه دریافت‌شده از اعلان روتر به عنوان دامنه جستجوی DNS روی این پیوند استفاده خواهد شد. اگر روی route تنظیم شود، نام دامنه دریافت‌شده از IPv6 RA تنها برای مسیریابی درخواست‌های DNS استفاده خواهد شد و نه برای جستجو. پیش‌فرض false است.

•: table (اسکالر)

شماره جدول مسیریابی برای مسیرهای دریافت‌شده در IPv6 RA. مقادیر مجاز اعداد صحیح مثبت هستند که از ۱ شروع می‌شوند. برخی مقادیر از قبل برای اشاره به جداول مسیریابی خاص استفاده شده‌اند: {/etc,/usr/share}/iproute2/rt_tables را ببینید.

مسیریابی (Routing)

مسیریابی پیچیده با Netplan امکان‌پذیر است. مسیرهای ایستای استاندارد و همچنین مسیریابی مبتنی بر خط‌مشی با استفاده از جداول مسیریابی از طریق بک‌اند networkd پشتیبانی می‌شوند.

این گزینه‌ها برای تمام انواع رابط‌ها در دسترس هستند.

مسیرهای پیش‌فرض (Default routes)

متداول‌ترین نیاز برای مسیریابی مربوط به تعریف مسیرهای پیش‌فرض برای دسترسی به اینترنت گسترده‌تر است. این مسیرهای پیش‌فرض فقط یک بار به ازای هر خانواده IP و جدول مسیریابی قابل تعریف هستند. یک مثال معمولی به صورت زیر خواهد بود:

network:
  ethernets:
    eth0:
      [...]
      routes:
        - to: default # می‌تواند به صورت اختیاری 0.0.0.0/0 باشد
          via: 10.0.0.1
          metric: 100
          on-link: true
          advertised-mss: 1400
        - to: default # می‌تواند به صورت اختیاری ::/0 باشد
          via: cf02:de:ad:be:ef::2
    eth1:
      [...]
      routes:
        - to: default
          via: 172.134.67.1
          metric: 100
          on-link: true
          # در جدول مسیریابی اصلی نیست،
          # با مسیر پیش‌فرض eth0 تداخل ندارد
      table: 76

•

routes (نگاشت)

بلوک routes مسیرهای ایستای استاندارد را برای یک رابط تعریف می‌کند. حداقل مقدار to باید مشخص شود. اگر نوع local یا nat باشد، محدوده پیش‌فرض host فرض می‌شود. اگر نوع unicast باشد و هیچ دروازه‌ای (via) داده نشود یا نوع broadcast، multicast یا anycast باشد، محدوده پیش‌فرض link فرض می‌شود. در غیر این صورت، محدوده global تنظیم پیش‌فرض است.

برای from، to و via، هر دو آدرس IPv4 و IPv6 شناخته می‌شوند و باید به شکل addr/prefixlen یا addr باشند.

•: from (اسکالر)

یک آدرس IP مبدأ برای ترافیکی که از این مسیر عبور می‌کند تنظیم می‌کند. (NetworkManager: از نسخه v1.8.0 به بعد)

•: to (اسکالر)

آدرس مقصد برای مسیر.

•: via (اسکالر)

آدرس دروازه‌ای (gateway) که باید برای این مسیر استفاده شود.

•: on-link (بولی)

هنگامی که روی true تنظیم شود، مشخص می‌کند که مسیر مستقیماً به رابط متصل است. (NetworkManager: از نسخه v1.12.0 برای IPv4 و v1.18.0 برای IPv6)

•: metric (اسکالر)

اولویت نسبی مسیر. باید یک مقدار عدد صحیح مثبت باشد.

•: type (اسکالر)

نوع مسیر. گزینه‌های معتبر عبارتند از: unicast (پیش‌فرض)، anycast، blackhole، broadcast، local، multicast، nat، prohibit، throw، unreachable یا xresolve.

•: scope (اسکالر)

محدوده (scope) مسیر، اینکه تا چه اندازه در شبکه گسترده است. مقادیر ممکن global، link یا host هستند. فقط برای IPv4 کاربرد دارد.

•: table (اسکالر)

شماره جدول مورد استفاده برای مسیر. در برخی سناریوها، ممکن است تنظیم مسیرها در یک جدول مسیریابی جداگانه مفید باشد. همچنین ممکن است برای ارجاع به قوانین خط‌مشی مسیریابی که پارامتر table را نیز می‌پذیرند استفاده شود. مقادیر مجاز اعداد صحیح مثبت هستند که از ۱ شروع می‌شوند. برخی مقادیر از قبل برای اشاره به جداول مسیریابی خاص استفاده شده‌اند: /etc/iproute2/rt_tables را ببینید. (NetworkManager: از نسخه v1.10.0 به بعد)

•: mtu (اسکالر) – از نسخه 0.101

مقدار MTU مورد استفاده برای مسیر، بر حسب بایت. باید یک مقدار عدد صحیح مثبت باشد.

•: congestion-window (اسکالر) – از نسخه 0.102

پنجره ازدحام (congestion window) مورد استفاده برای مسیر که با تعداد بخش‌ها (segments) نمایش داده می‌شود. باید یک مقدار عدد صحیح مثبت باشد.

•: advertised-receive-window (اسکالر) – از نسخه 0.102

پنجره دریافت اعلام‌شده برای مسیر که با تعداد بخش‌ها نمایش داده می‌شود. باید یک مقدار عدد صحیح مثبت باشد.

•: advertised-mss (اسکالر) – از نسخه 1.1

حداکثر اندازه بخش (MSS یا 'Maximal Segment Size') که هنگام برقراری اتصالات TCP به این مقاصد اعلام می‌شود. اگر داده نشود، لینوکس از یک مقدار پیش‌فرض که از MTU دستگاه اولین گام (hop) محاسبه می‌شود استفاده می‌کند. باید یک عدد صحیح مثبت باشد.

•: routing-policy (نگاشت)

بلوک routing-policy خط‌مشی مسیریابی اضافی را برای یک شبکه تعریف می‌کند، جایی که ترافیک ممکن است بر اساس IP مبدأ، علامت‌گذاری فایروال و غیره به صورت ویژه مدیریت شود.

برای from، to، هر دو آدرس IPv4 و IPv6 شناخته می‌شوند و باید به شکل addr/prefixlen یا addr باشند.

•: from (اسکالر)

یک آدرس IP مبدأ برای تطبیق ترافیک برای این قانون خط‌مشی تنظیم می‌کند.

•: to (اسکالر)

تطبیق روی ترافیکی که به مقصد مشخص‌شده می‌رود.

•: table (اسکالر)

شماره جدول برای تطبیق مسیر. در برخی سناریوها، ممکن است تنظیم مسیرها در یک جدول مسیریابی جداگانه مفید باشد. همچنین ممکن است برای ارجاع به مسیرهایی که پارامتر table را نیز می‌پذیرند استفاده شود. مقادیر مجاز اعداد صحیح مثبت هستند که از 1 شروع می‌شوند. برخی مقادیر از قبل برای اشاره به جداول مسیریابی خاص استفاده شده‌اند: /etc/iproute2/rt_tables را ببینید.

•: priority (اسکالر)

یک اولویت برای قانون خط‌مشی مسیریابی تعیین می‌کند تا بر ترتیبی که قوانین مسیریابی پردازش می‌شوند تأثیر بگذارد. عدد بالاتر به معنای اولویت کمتر است: قوانین به ترتیب افزایش شماره اولویت پردازش می‌شوند. تعیین یک اولویت صریح و یکتا برای هر قانون خط‌مشی مسیریابی به شدت توصیه می‌شود و در بک‌اند NetworkManager اجباری است.

•: mark (اسکالر)

این قانون خط‌مشی مسیریابی را با ترافیکی که توسط فایروال iptables با این مقدار علامت‌گذاری شده تطبیق می‌دهد. مقادیر مجاز اعداد صحیح مثبت هستند که از 1 شروع می‌شوند.

•: type-of-service (اسکالر)

این قانون خط‌مشی را بر اساس شماره نوع سرویس (Type of Service) اعمال‌شده به ترافیک تطبیق می‌دهد.

(yaml-auth)= ## احراز هویت

Netplan با استفاده از بلوک auth از تنظیمات پیشرفته احراز هویت برای رابط‌های اترنت و وای‌فای و همچنین شبکه‌های وای‌فای جداگانه پشتیبانی می‌کند.

•: auth (نگاشت)

تنظیمات احراز هویت را برای دستگاهی از نوع ethernets: یا یک ورودی access-points: در یک دستگاه wifis: مشخص می‌کند.

بلوک auth از ویژگی‌های زیر پشتیبانی می‌کند:

•: key-management (اسکالر)

حالت‌های مدیریت کلید پشتیبانی‌شده عبارتند از: none (بدون مدیریت کلید)؛ psk (WPA با کلید پیش‌اشتراکی، متداول برای وای‌فای خانگی)؛ psk-sha256 (WPA2 با کلید پیش‌اشتراکی، متداول برای وای‌فای خانگی)؛ eap (WPA با EAP، متداول برای وای‌فای سازمانی)؛ eap-sha256 (مورد استفاده با WPA3-Enterprise)؛ eap-suite-b-192 (مورد استفاده با WPA3-Enterprise)؛ sae (مورد استفاده توسط WPA3)؛ و 802.1x (عمدتاً برای اتصالات سیمی اترنت استفاده می‌شود).

•: password (اسکالر)

رشته گذرواژه برای EAP، یا کلید پیش‌اشتراکی برای WPA-PSK.

ویژگی‌های زیر در صورتی قابل استفاده هستند که key-management برابر با eap یا 802.1x باشد:

•: method (اسکالر)

روش EAP مورد استفاده. روش‌های EAP پشتیبانی‌شده عبارتند از: tls (TLS)، peap (EAP محافظت‌شده)، leap (EAP سبک‌وزن)، pwd (گذرواژه EAP) و ttls (TLS تونل‌شده).

•: identity (اسکالر)

هویت (identity) مورد استفاده برای EAP.

•: anonymous-identity (اسکالر)

هویتی که در صورت پشتیبانی روش EAP انتخاب‌شده از ارسال یک هویت تونل‌شده متفاوت، باید از طریق کانال رمزگذاری‌نشده ارسال شود.

•: ca-certificate (اسکالر)

مسیر فایلی با یک یا چند گواهی مرجع صدور گواهی (CA) معتمد.

•: client-certificate (اسکالر)

مسیر فایلی حاوی گواهی مورد استفاده کلاینت در طول احراز هویت.

•: client-key (اسکالر)

مسیر فایلی حاوی کلید خصوصی مربوط به client-certificate.

•: client-key-password (اسکالر)

گذرواژه مورد استفاده برای رمزگشایی کلید خصوصی مشخص‌شده در client-key در صورت رمزگذاری بودن آن.

•: phase2-auth (اسکالر) – از نسخه 0.99

سازوکار احراز هویت فاز ۲ (Phase 2).

ویژگی‌های نوع دستگاه ethernets (Properties for device type ethernets)

وضعیت (Status): اختیاری.

هدف (Purpose): از کلید ethernets برای پیکربندی رابط‌های اترنت استفاده کنید.

ساختار (Structure): این کلید شامل نگاشتی از شناسه‌های رابط اترنت است. هر ethernet دارای تعدادی گزینه پیکربندی است. نیازی نیست هر رابط را با نام آن در داخل نگاشت ethernets تعریف کنید. می‌توانید از هر شناسه‌ای که رابط را توصیف می‌کند استفاده کرده و کارت شبکه واقعی را با استفاده از کلید match تطبیق دهید. ساختار کلی پیکربندی برای اترنت در زیر نشان داده شده است:

network:
  ethernets:
    device-id:
      ...

device-id شناسه رابط است. اگر از نام رابط به عنوان شناسه استفاده کنید، Netplan آن رابط را مطابقت خواهد داد.

مثال زیر را در نظر بگیرید. در این حالت، رابطی به نام eth0 با DHCP پیکربندی می‌شود:

network:
  ethernets:
    eth0:
      dhcp4: true

مقدار device-id می‌تواند هر نام توصیفی باشد که معنادار می‌دانید. با این حال، اگر با نام واقعی رابط مطابقت نداشته باشد، باید از ویژگی match برای شناسایی دستگاهی که می‌خواهید پیکربندی کنید استفاده نمایید.

مثال زیر یک اتصال اترنت به نام isp-interface (احتمالاً یک رابط خارجی متصل به ارائه‌دهنده خدمات اینترنت) تعریف می‌کند و از match برای اعمال پیکربندی به دستگاه فیزیکی با آدرس MAC برابر با aa:bb:cc:00:11:22 استفاده می‌کند:

network:
  ethernets:
    isp-interface:
      match:
        macaddress: aa:bb:cc:00:11:22
      dhcp4: true

تعاریف دستگاه اترنت، علاوه بر موارد مشترک توصیف‌شده در بالا، از برخی ویژگی‌های اضافی نیز پشتیبانی می‌کنند که می‌توان برای دستگاه‌های SR-IOV استفاده کرد.

•: link (اسکالر) – از نسخه 0.99

(فقط دستگاه‌های SR-IOV) ویژگی link دستگاه را به عنوان یک تابع مجازی (Virtual Function) از دستگاه تابع فیزیکی (Physical Function) انتخاب‌شده، همان‌طور که توسط شناسه Netplan داده‌شده مشخص شده است، اعلان می‌کند.

مثال:

network:
  ethernets:
    enp1: {...}
    enp1s16f1:
      link: enp1

•: virtual-function-count (اسکالر) – از نسخه 0.99

(فقط دستگاه‌های SR-IOV) در موارد خاص ممکن است نیاز باشد VFها خارج از Netplan پیکربندی شوند. برای چنین پیکربندی‌هایی، virtual-function-count می‌تواند به صورت اختیاری برای تنظیم تعداد صریح توابع مجازی برای تابع فیزیکی داده‌شده استفاده شود. در صورت عدم تنظیم، پیش‌فرض ایجاد تنها به همان تعداد VF است که در پیکربندی Netplan تعریف شده است. این مورد فقط باید برای موارد خاص استفاده شود.

نیازمند ویژگی: sriov

•: embedded-switch-mode (اسکالر) – از نسخه 0.104

(فقط دستگاه‌های SR-IOV) تغییر حالت عملیاتی سوئیچ تعبیه‌شده یک دستگاه PCI SmartNIC پشتیبانی‌شده (مانند Mellanox ConnectX-5). مقادیر ممکن switchdev یا legacy هستند؛ در صورت عدم تعیین، از پیکربندی پیش‌فرض سازنده استفاده می‌شود.

نیازمند ویژگی: eswitch-mode

•: delay-virtual-functions-rebind (بولی) – از نسخه 0.104

(فقط دستگاه‌های SR-IOV) به تأخیر انداختن اتصال مجدد توابع مجازی SR-IOV به درایور آن پس از تغییر تنظیمات embedded-switch-mode به مرحله بعد. هنگام استفاده از bonding/VF LAG می‌توان آن را فعال کرد. پیش‌فرض false است.

نیازمند ویژگی: eswitch-mode

•: infiniband-mode (اسکالر) – از نسخه 0.105

(فقط دستگاه‌های InfiniBand) تغییر حالت عملیاتی یک دستگاه IPoIB. مقادیر ممکن datagram یا connected هستند. در صورت عدم تعیین، از پیکربندی پیش‌فرض هسته استفاده می‌شود.

نیازمند ویژگی: infiniband

(yaml-modems)= ## ویژگی‌های نوع دستگاه modems

وضعیت (Status): اختیاری.

هدف (Purpose): از کلید modems برای پیکربندی رابط‌های مودم استفاده کنید. پیکربندی مودم GSM/CDMA فقط برای بک‌اند NetworkManager پشتیبانی می‌شود. systemd-networkd از مودم‌ها پشتیبانی نمی‌کند.

ساختار (Structure): این کلید شامل نگاشتی از شناسه‌های مودم است. هر modem دارای تعدادی گزینه پیکربندی است. ساختار کلی پیکربندی برای مودم‌ها در زیر نشان داده شده است:

network:
  version: 2
  renderer: NetworkManager
  modems:
    cdc-wdm1:
      mtu: 1600
      apn: ISP.CINGULAR
      username: ISP@CINGULARGPRS.COM
      password: CINGULAR1
      number: "*99#"
      network-id: 24005
      device-id: da812de91eec16620b06cd0ca5cbc7ea25245222
      pin: 2345
      sim-id: 89148000000060671234
      sim-operator-id: 310260

نیازمند ویژگی: modems

•: apn (اسکالر) – از نسخه 0.99

تنظیم APN (نام نقطه دسترسی) اپراتور. در صورت فعال بودن auto-config می‌توان این گزینه را حذف کرد.

•: auto-config (بولی) – از نسخه 0.99

مشخص می‌کند که آیا باید با جستجوی اپراتور در پایگاه داده ارائه‌دهندگان پهن‌باند تلفن همراه، پیکربندی خودکار مودم انجام شود یا خیر. ممکن است این قابلیت برای همه اپراتورها کار نکند.

•: device-id (اسکالر) – از نسخه 0.99

شناسه دستگاه (همان‌طور که توسط سرویس مدیریت WWAN داده شده است) مودم را برای تطبیق مشخص می‌کند. این مورد را می‌توان با استفاده از mmcli پیدا کرد.

•: network-id (اسکالر) – از نسخه 0.99

شناسه شبکه را مشخص می‌کند (قالب GSM LAI). در صورت تعیین این گزینه، دستگاه رومینگ شبکه انجام نخواهد داد.

•: number (اسکالر) – از نسخه 0.99

شماره‌ای که باید برای برقراری اتصال به شبکه پهن‌باند تلفن همراه شماره‌گیری شود. (برای GSM منسوخ شده است)

•: password (اسکالر) – از نسخه 0.99

گذرواژه مورد استفاده برای احراز هویت در شبکه اپراتور را مشخص می‌کند. در صورت فعال بودن auto-config می‌توان این گزینه را حذف کرد.

•: pin (اسکالر) – از نسخه 0.99

پین‌کد (PIN) سیم‌کارت را مشخص می‌کند تا در صورت فعال بودن پین، امکان کارکرد آن فراهم شود.

•: sim-id (اسکالر) – از نسخه 0.99

شناسه یکتای سیم‌کارت (همان‌طور که توسط سرویس مدیریت WWAN داده شده است) که این اتصال برای آن اعمال می‌شود را مشخص می‌کند. در صورت ارائه، اتصال برای هر دستگاهی که توسط device-id مجاز شناخته شده و حاوی سیم‌کارتی منطبق با شناسه داده‌شده باشد اعمال خواهد شد.

•: sim-operator-id (اسکالر) – از نسخه 0.99

رشته MCC/MNC (مانند 310260 یا 21601) را مشخص می‌کند که اپراتور مورد نظر برای اعمال این اتصال را مشخص می‌نماید. در صورت ارائه، اتصال برای هر دستگاهی که توسط device-id و sim-id مجاز شناخته شده و حاوی سیم‌کارت ارائه‌شده توسط اپراتور داده‌شده باشد اعمال خواهد شد.

•: username (اسکالر) – از نسخه 0.99

نام کاربری مورد استفاده برای احراز هویت با شبکه اپراتور را مشخص می‌کند. در صورت فعال بودن auto-config می‌توان این گزینه را حذف کرد.

ویژگی‌های نوع دستگاه wifis (Properties for device type wifis)

وضعیت (Status): اختیاری.

هدف (Purpose): از کلید wifis برای پیکربندی نقاط دسترسی وای‌فای استفاده کنید.

ساختار (Structure): این کلید شامل نگاشتی از شناسه‌های وای‌فای است. هر wifi دارای تعدادی گزینه پیکربندی است. ساختار کلی پیکربندی برای وای‌فای در زیر نشان داده شده است:

network:
  version: 2
  wifis:
    wlp0s1:
      access-points:
        "network_ssid_name":
          password: "**********"

توجه داشته باشید که systemd-networkd پشتیبانی بومی از وای‌فای ندارد، بنابراین اگر اجازه می‌دهید رندرکننده networkd وای‌فای را مدیریت کند، به نصب wpasupplicant نیاز دارید.

•: access-points (نگاشت)

اتصالات از پیش پیکربندی‌شده را برای NetworkManager فراهم می‌کند. توجه داشته باشید که کاربران البته می‌توانند نقاط دسترسی/SSIDهای دیگر را انتخاب کنند. کلیدهای نگاشت همان SSIDها هستند و مقادیر آنها نگاشت‌هایی با ویژگی‌های پشتیبانی‌شده زیر می‌باشند:

•: password (اسکالر)

احراز هویت WPA/WPA2 را فعال کرده و عبارت عبور (passphrase) را برای آن تنظیم می‌کند. اگر نه این گزینه و نه یک بلوک auth داده نشود، فرض بر این است که شبکه باز (open) است. تنظیم

password: "S3kr1t"

معادل است با:

auth:
  key-management: psk
  password: "S3kr1t"

•: mode (اسکالر)

حالت‌های ممکن نقطه دسترسی عبارتند از: infrastructure (پیش‌فرض)، ap (ایجاد یک نقطه دسترسی که دستگاه‌های دیگر می‌توانند به آن متصل شوند) و adhoc (شبکه‌های همتا به همتا بدون نقطه دسترسی مرکزی). مقدار ap فقط با NetworkManager پشتیبانی می‌شود.

•: bssid (اسکالر) – از نسخه 0.99

در صورت تعیین، دستگاه را هدایت می‌کند تا تنها با نقطه دسترسی داده‌شده مرتبط شود.

•: band (اسکالر) – از نسخه 0.99

باندهای ممکن 5GHz (برای 802.11a در فرکانس 5GHz) و 2.4GHz (برای 802.11 در فرکانس 2.4GHz) هستند؛ در صورت عدم تنظیم (پیش‌فرض)، باند فرکانس 802.11 شبکه محدود نمی‌شود.

•: channel (اسکالر) – از نسخه 0.99

کانال بی‌سیم مورد استفاده برای اتصال وای‌فای. از آنجا که شماره کانال‌ها بین باندها همپوشانی دارند، این ویژگی تنها در صورتی اعمال می‌شود که ویژگی band نیز تنظیم شده باشد.

•: hidden (بولی) – از نسخه 0.100

برای تغییر روش پویش SSID جهت اتصال به شبکه‌های مخفی وای‌فای، روی true تنظیم کنید. توجه داشته باشید که این گزینه ممکن است در مقایسه با false (پیش‌فرض) هنگام اتصال به SSIDهایی که به صورت عمومی پخش می‌شوند، عملکرد کندتری داشته باشد.

•: wakeonwlan (دنباله‌ای از اسکالرها) – از نسخه 0.99

قابلیت WakeOnWLan را روی دستگاه‌های پشتیبانی‌شده فعال می‌کند. همه درایورها از تمام گزینه‌ها پشتیبانی نمی‌کنند. می‌تواند هر ترکیبی از any، disconnect، magic_pkt، gtk_rekey_failure، eap_identity_req، four_way_handshake، rfkill_release یا tcp (فقط NetworkManager) باشد. یا پرچم انحصاری default (پیش‌فرض).

•: regulatory-domain (اسکالر) – از نسخه 0.105

می‌توان از این گزینه برای تعریف دامنه مقرراتی رادیو استفاده کرد تا از کانال‌های وای‌فای اضافی خارج از «دامنه جهانی» (world domain) استفاده شود. یک کد کشور ISO/IEC 3166 (مانند GB) یا 00 را برای بازنشانی به «دامنه جهانی» می‌پذیرد. برای مقادیر موجود به wireless-regdb مراجعه کنید.

نیازمند وابستگی: iw، در صورتی که قرار است خارج از بک‌اند networkd (wpasupplicant) استفاده شود.

ویژگی‌های نوع دستگاه bridges (Properties for device type bridges)

وضعیت (Status): اختیاری.

هدف (Purpose): از کلید bridges برای ایجاد رابط‌های پل (Bridge) استفاده کنید.

ساختار (Structure): این کلید شامل نگاشتی از نام‌های رابط پل است. هر bridge دارای فهرستی اختیاری از رابط‌هایی است که به یکدیگر پل می‌شوند. رابط‌های فهرست‌شده در کلید interfaces (enp5s0 و enp5s1 در زیر) باید در پیکربندی Netplan شما نیز تعریف شوند. ساختار کلی پیکربندی برای پل‌ها در زیر نشان داده شده است:

network:
  bridges:
    br0:
      interfaces:
        - enp5s0
        - enp5s1
      dhcp4: true
      ...

پس از اعمال، یک رابط مجازی از نوع پل با نام br0 در سیستم ایجاد خواهد شد.

تنظیمات خاص برای پل‌ها در زیر تعریف شده‌اند:

•: interfaces (دنباله‌ای از اسکالرها)

تمام دستگاه‌هایی که با این فهرست شناسه مطابقت دارند به پل اضافه خواهند شد. این می‌تواند یک فهرست خالی باشد، که در این صورت پل بدون هیچ رابط عضوی آنلاین خواهد شد.

مثال:

network:
  ethernets:
    switchports:
      match: {name: "enp2*"}
  [...]
  bridges:
    br0:
      interfaces: [switchports]

•: parameters (نگاشت)

پارامترهای سفارشی‌سازی برای گزینه‌های ویژه پل‌بندی. فواصل زمانی ممکن است نیاز باشد به صورت تعداد ثانیه‌ها یا میلی‌ثانیه‌ها بیان شوند: نوع مقدار پیش‌فرض در زیر مشخص شده است. در صورت لزوم، فواصل زمانی را می‌توان با استفاده از یک پسوند زمان (مانند s برای ثانیه، ms برای میلی‌ثانیه) تعیین کرد تا امکان کنترل بیشتر بر رفتار آن فراهم شود.

•: ageing-time، aging-time (اسکالر)

مدت زمانی را که پس از دریافت یک بسته، آدرس MAC در پایگاه داده فورواردینگ (FDB) نگه داشته می‌شود، تنظیم می‌کند. این مورد هنگام استفاده از رندرکننده networkd به ویژگی AgeingTimeSec= نگاشت می‌شود. اگر پسوند زمانی مشخص نشود، مقدار به عنوان ثانیه تفسیر خواهد شد.

•: priority (اسکالر)

مقدار اولویت را برای پل تنظیم می‌کند. این مقدار باید عددی بین 0 و 65535 باشد. مقادیر کمتر به معنای اولویت بالاتر هستند. پلی که اولویت بالاتری دارد به عنوان پل ریشه (root bridge) انتخاب خواهد شد.

•: port-priority (نگاشت)

اولویت پورت را به ازای هر رابط تنظیم می‌کند. مقدار اولویت عددی بین 0 و 63 است. این معیار در الگوریتم‌های انتخاب پورت اختصاص‌یافته (designated port) و پورت ریشه استفاده می‌شود.

مثال:

network:
  ethernets:
    eth0:
      dhcp4: false
    eth1:
      dhcp4: false
  bridges:
    br0:
      interfaces: [eth0, eth1]
      parameters:
        port-priority:
          eth0: 10
          eth1: 20

•: forward-delay (اسکالر)

مدت زمانی را مشخص می‌کند که پل قبل از رسیدن به وضعیت فورواردینگ (Forwarding)، در وضعیت‌های شنود (Listening) و یادگیری (Learning) باقی خواهد ماند. این فیلد برای رندرکننده networkd به ویژگی ForwardDelaySec= نگاشت می‌شود. اگر پسوند زمانی مشخص نشود، مقدار به عنوان ثانیه تفسیر خواهد شد.

•: hello-time (اسکالر)

فاصله زمانی بین ارسال دو بسته hello از پل‌های ریشه و اختصاص‌یافته را مشخص می‌کند. بسته‌های Hello اطلاعات مربوط به توپولوژی شبکه را منتقل می‌کنند. هنگامی که رندرکننده networkd استفاده می‌شود، این مورد به ویژگی HelloTimeSec= نگاشت می‌شود. اگر پسوند زمانی مشخص نشود، مقدار به عنوان ثانیه تفسیر خواهد شد.

•: max-age (اسکالر)

حداکثر عمر یک بسته hello را تنظیم می‌کند. اگر آخرین بسته hello قدیمی‌تر از آن مقدار باشد، پل تلاش خواهد کرد تا به پل ریشه تبدیل شود. این مورد هنگام استفاده از رندرکننده networkd به ویژگی MaxAgeSec= نگاشت می‌شود. اگر پسوند زمانی مشخص نشود، مقدار به عنوان ثانیه تفسیر خواهد شد.

•: path-cost (نگاشت)

هزینه مسیر روی پل را به ازای هر رابط تنظیم می‌کند. رابط‌های سریع‌تر باید هزینه کمتری داشته باشند. این اجازه می‌دهد تا کنترل دقیق‌تری روی توپولوژی شبکه وجود داشته باشد تا سریع‌ترین مسیرها در هر زمان ممکن در دسترس باشند.

مثال:

network:
  ethernets:
    eth0:
      dhcp4: false
    eth1:
      dhcp4: false
  bridges:
    br0:
      interfaces: [eth0, eth1]
      parameters:
        path-cost:
          eth0: 100
          eth1: 200

•: stp (بولی)

مشخص می‌کند که آیا پل باید از پروتکل درخت پوشا (Spanning Tree Protocol) استفاده کند یا خیر. مقدار پیش‌فرض true است، به این معنی که پروتکل درخت پوشا باید استفاده شود.

ویژگی‌های نوع دستگاه dummy-devices (Properties for device type dummy-devices)

وضعیت (Status): اختیاری.

هدف (Purpose): از کلید dummy-devices برای ایجاد رابط‌های مجازی استفاده کنید.

ساختار (Structure): این کلید شامل نگاشتی از نام‌های رابط است. دستگاه‌های ساختگی (Dummy devices) دستگاه‌های مجازی هستند که می‌توان از آنها برای مسیریابی بسته‌ها بدون ارسال واقعی آنها استفاده کرد.

network:
  dummy-devices:
    dm0:
      addresses:
        - 192.168.0.123/24
      ...

پس از اعمال، یک رابط مجازی به نام dm0 در سیستم ایجاد خواهد شد.

برای مشاهده فهرست ویژگی‌هایی که می‌توان با این نوع رابط استفاده کرد، بخش «ویژگی‌های تمام انواع دستگاه‌ها» را ببینید.

ویژگی‌های نوع دستگاه bonds (Properties for device type bonds)

وضعیت (Status): اختیاری.

هدف (Purpose): از کلید bonds برای ایجاد رابط‌های تجمیع پیوند (Bond / Link Aggregation) استفاده کنید.

ساختار (Structure): این کلید شامل نگاشتی از نام‌های رابط Bond است. هر bond دارای فهرستی اختیاری از رابط‌هایی است که بخشی از تجمیع خواهند بود. رابط‌های فهرست‌شده در کلید interfaces باید در پیکربندی Netplan شما نیز تعریف شده باشند. ساختار کلی پیکربندی برای باندها در زیر نشان داده شده است:

network:
  bonds:
    bond0:
      interfaces:
        - enp5s0
        - enp5s1
        - enp5s2
      parameters:
        mode: active-backup
      ...

پس از اعمال، یک رابط مجازی از نوع bond با نام bond0 در سیستم ایجاد خواهد شد.

تنظیمات خاص برای باندها در زیر تعریف شده‌اند:

•: interfaces (دنباله‌ای از اسکالرها)

تمام دستگاه‌هایی که با این فهرست شناسه مطابقت دارند به bond اضافه خواهند شد.

مثال:

network:
  ethernets:
    switchports:
      match: {name: "enp2*"}
  [...]
  bonds:
    bond0:
      interfaces: [switchports]

•: parameters (نگاشت)

پارامترهای سفارشی‌سازی برای گزینه‌های ویژه باندینگ. فواصل زمانی ممکن است نیاز باشد به صورت تعداد ثانیه‌ها یا میلی‌ثانیه‌ها بیان شوند: نوع مقدار پیش‌فرض در زیر مشخص شده است. در صورت لزوم، فواصل زمانی را می‌توان با استفاده از یک پسوند زمان (مانند s برای ثانیه، ms برای میلی‌ثانیه) تعیین کرد تا امکان کنترل بیشتر بر رفتار آن فراهم شود.

•: mode (اسکالر)

حالت باندینگ مورد استفاده برای رابط‌ها را تنظیم می‌کند. پیش‌فرض balance-rr (توزیع نوبتی یا round robin) است. مقادیر ممکن عبارتند از: balance-rr، active-backup، balance-xor، broadcast، 802.3ad، balance-tlb و balance-alb. برای Open vSwitch، حالت‌های active-backup و حالت‌های اضافی balance-tcp و balance-slb پشتیبانی می‌شوند.

•: lacp-rate (اسکالر)

نرخ ارسال LACPDUها را تنظیم می‌کند. این مورد فقط در حالت 802.3ad مفید است. مقادیر ممکن slow (۳۰ ثانیه، پیش‌فرض) و fast (هر ثانیه) هستند.

•: mii-monitor-interval (اسکالر)

فاصله زمانی را برای پایش MII (بررسی اینکه آیا یک رابط bond دارای حامل است یا خیر) مشخص می‌کند. پیش‌فرض 0 است که پایش MII را غیرفعال می‌کند. این معادل فیلد MIIMonitorSec= برای بک‌اند networkd است. اگر پسوند زمانی مشخص نشود، مقدار به عنوان میلی‌ثانیه تفسیر خواهد شد.

•: min-links (اسکالر)

حداقل تعداد پیوندهای فعال در یک bond برای اینکه رابط bond فعال (up) در نظر گرفته شود.

•: transmit-hash-policy (اسکالر)

خط‌مشی هش ارسال را برای انتخاب پورت‌ها مشخص می‌کند. این مورد فقط در حالت‌های balance-xor، 802.3ad و balance-tlb مفید است. مقادیر ممکن عبارتند از: layer2، layer3+4، layer2+3، encap2+3 و encap3+4.

•: ad-select (اسکالر)

حالت انتخاب تجمیع (Aggregation Selection) را تنظیم می‌کند. مقادیر ممکن عبارتند از: stable، bandwidth و count. این گزینه فقط در حالت 802.3ad استفاده می‌شود.

•: all-members-active (بولی) – از نسخه 0.106

اگر bond باید فریم‌های تکراری دریافت‌شده روی پورت‌های غیرفعال را دور بریزد، این گزینه را روی false تنظیم کنید. اگر باید تحویل داده شوند، این گزینه را روی true تنظیم کنید. مقدار پیش‌فرض false است و در اکثر شرایط رفتار مطلوب به شمار می‌رود.

نام مستعار: all-slaves-active

•: arp-interval (اسکالر)

مقدار فاصله زمانی را برای اینکه پایش پیوند ARP با چه بسامدی انجام شود تنظیم می‌کند. مقدار پیش‌فرض 0 است که پایش ARP را غیرفعال می‌کند. برای بک‌اند networkd، این مورد به ویژگی ARPIntervalSec= نگاشت می‌شود. اگر پسوند زمانی مشخص نشود، مقدار به عنوان میلی‌ثانیه تفسیر خواهد شد.

•: arp-ip-targets (دنباله‌ای از اسکالرها)

آدرس‌های IP سایر میزبان‌های روی پیوند که باید درخواست‌های ARP برای آنها ارسال شود تا تأیید شود که یک پورت فعال است. این گزینه فقط زمانی استفاده می‌شود که arp-interval روی مقداری غیر از 0 تنظیم شده باشد. برای عملکرد پایش پیوند ARP حداقل باید یک آدرس IP داده شود. تنها آدرس‌های IPv4 پشتیبانی می‌شوند. می‌توانید تا ۱۶ آدرس IP را مشخص کنید. مقدار پیش‌فرض یک فهرست خالی است.

•: arp-validate (اسکالر)

نحوه اعتبارسنجی پاسخ‌های ARP را هنگام استفاده از پایش پیوند ARP پیکربندی می‌کند. مقادیر ممکن عبارتند از: none، active، backup و all.

•: arp-all-targets (اسکالر)

مشخص می‌کند که آیا بالا بودن هر کدام از اهداف IP ARP برای بالا در نظر گرفته شدن یک پورت کافی است یا اینکه همه اهداف باید بالا باشند. این مورد فقط برای حالت active-backup زمانی که arp-validate فعال است استفاده می‌شود. مقادیر ممکن any و all هستند.

•: up-delay (اسکالر)

تاخیر قبل از فعال کردن پیوند پس از بالا آمدن فیزیکی پیوند را مشخص می‌کند. مقدار پیش‌فرض 0 است. این مورد برای رندرکننده networkd به ویژگی UpDelaySec= نگاشت می‌شود. این گزینه فقط برای پایشگر پیوند miimon معتبر است. اگر پسوند زمانی مشخص نشود، مقدار به عنوان میلی‌ثانیه تفسیر خواهد شد.

•: down-delay (اسکالر)

تاخیر قبل از غیرفعال کردن پیوند پس از قطع شدن پیوند را مشخص می‌کند. مقدار پیش‌فرض 0 است. این مورد برای رندرکننده networkd به ویژگی DownDelaySec= نگاشت می‌شود. این گزینه فقط برای پایشگر پیوند miimon معتبر است. اگر پسوند زمانی مشخص نشود، مقدار به عنوان میلی‌ثانیه تفسیر خواهد شد.

•: fail-over-mac-policy (اسکالر)

مشخص می‌کند که آیا هنگام افزودن پورت‌ها به bond، تمام پورت‌ها روی یک آدرس MAC تنظیم شوند یا سیستم چگونه باید با آدرس‌های MAC رفتار کند. مقادیر ممکن عبارتند از: none، active و follow.

•: gratuitous-arp (اسکالر)

تعداد بسته‌های ARP ارسالی پس از تغییر وضعیت اضطراری (failover) را مشخص می‌کند. به محض اینکه پیوندی روی یک پورت جدید برقرار شد، یک اعلان ارسال می‌شود و اگر این مقدار روی عددی بزرگ‌تر از 1 تنظیم شود، احتمالاً تکرار خواهد شد. مقدار پیش‌فرض 1 است و مقادیر معتبر بین 1 و 255 هستند. این مورد فقط بر حالت active-backup تأثیر می‌گذارد.

به دلایل تاریخی، املای نادرست gratuitious-arp نیز پذیرفته می‌شود و عملکرد یکسانی دارد.

•: packets-per-member (اسکالر) – از نسخه 0.106

در حالت balance-rr، تعداد بسته‌هایی را که باید قبل از جابجایی به پورت بعدی روی یک پورت ارسال شوند، مشخص می‌کند. هنگامی که این مقدار روی 0 تنظیم شود، پورت‌ها به صورت تصادفی انتخاب می‌شوند. مقادیر مجاز بین 0 و 65535 هستند. مقدار پیش‌فرض 1 است. این تنظیم فقط در حالت balance-rr استفاده می‌شود.

نام مستعار: packets-per-slave

•: primary-reselect-policy (اسکالر)

خط‌مشی انتخاب مجدد را برای پورت اصلی (primary port) تنظیم می‌کند. در صورت خرابی پورت فعال، سیستم از این خط‌مشی برای تصمیم‌گیری در مورد نحوه انتخاب پورت فعال جدید و نحوه مدیریت بازیابی استفاده خواهد کرد. مقادیر ممکن عبارتند از: always، better و failure.

•: resend-igmp (اسکالر)

در حالت‌های balance-rr، active-backup، balance-tlb و balance-alb، یک تغییر وضعیت اضطراری (failover) می‌تواند ترافیک IGMP را از یک پورت به پورت دیگر تغییر دهد.

این پارامتر مشخص می‌کند چه تعداد گزارش عضویت IGMP در یک رویداد failover صادر شود. مقادیر از 0 تا 255 متغیر است. مقدار 0 ارسال گزارش‌های عضویت را غیرفعال می‌کند. در غیر این صورت، اولین گزارش عضویت در هنگام failover ارسال می‌شود و گزارش‌های بعدی در فواصل 200 میلی‌ثانیه‌ای ارسال می‌گردند.

•: learn-packet-interval (اسکالر)

فاصله زمانی بین ارسال بسته‌های یادگیری به هر پورت را مشخص می‌کند. محدوده مقدار بین 1 و 0x7fffffff است. مقدار پیش‌فرض 1 است. این گزینه فقط بر حالت‌های balance-tlb و balance-alb تأثیر می‌گذارد. با استفاده از رندرکننده networkd، این فیلد به ویژگی LearnPacketIntervalSec= نگاشت می‌شود. اگر پسوند زمانی مشخص نشود، مقدار به عنوان ثانیه تفسیر خواهد شد.

•: primary (اسکالر)

دستگاهی را برای استفاده به عنوان پورت اصلی، یا دستگاه ترجیحی برای استفاده به عنوان پورت برای bond (یعنی دستگاه ترجیحی برای ارسال داده از طریق آن) در هر زمان که در دسترس باشد مشخص می‌کند. این مورد فقط بر حالت‌های active-backup، balance-alb و balance-tlb تأثیر می‌گذارد.

(yaml-tunnels)= ## ویژگی‌های نوع دستگاه tunnels

وضعیت (Status): اختیاری.

هدف (Purpose): از کلید tunnels برای ایجاد رابط‌های تونل مجازی استفاده کنید.

ساختار (Structure): این کلید شامل نگاشتی از نام‌های رابط تونل است. هر tunnel نیازمند شناسایی حالت تونل است (بخش mode زیر را برای فهرست حالت‌های پشتیبانی‌شده ببینید). ساختار کلی پیکربندی برای تونل‌ها در زیر نشان داده شده است:

network:
  tunnels:
    tunnel0:
      mode: SCALAR
      ...

پس از اعمال، یک رابط مجازی به نام tunnel0 در سیستم ایجاد خواهد شد. حالت عملکرد آن توسط ویژگی mode تعریف می‌شود.

تونل‌ها اجازه می‌دهند ترافیک به گونه‌ای عبور کند که گویی بین سیستم‌های موجود در یک شبکه محلی یکسان است، حتی اگر سیستم‌ها از یکدیگر دور باشند اما از طریق اینترنت قابل دسترسی باشند. آنها ممکن است برای پشتیبانی از ترافیک IPv6 در شبکه‌ای که ISP این سرویس را ارائه نمی‌دهد، یا برای گسترش و «اتصال» شبکه‌های محلی جداگانه استفاده شوند. برای اطلاعات کلی بیشتر درباره تونل‌ها به Tunneling_protocol مراجعه کنید.

تنظیمات خاص برای تونل‌ها در زیر تعریف شده‌اند:

•: mode (اسکالر)

حالت تونل را مشخص می‌کند. گزینه‌های معتبر عبارتند از حالت‌های sit، gre، ip6gre، ipip، ipip6، ip6ip6، vti، vti6، wireguard، vxlan، gretap و ip6gretap. علاوه بر این، بک‌اند NetworkManager از تونل‌های isatap پشتیبانی می‌کند.

•: local (اسکالر)

آدرس نقطه پایانی محلی (local endpoint) تونل را تعریف می‌کند. (برای VXLAN) این باید با یکی از آدرس‌های IP والد مطابقت داشته باشد یا از مقادیر ویژه networkd استفاده کند.

•: remote (اسکالر)

آدرس نقطه پایانی راه دور (remote endpoint) تونل یا آدرس IP گروه چندپخشی (multicast group) را برای VXLAN تعریف می‌کند.

•: ttl (اسکالر) – از نسخه 0.103

طول عمر (TTL) تونل را مشخص می‌کند. عددی در محدوده 1..255 می‌گیرد.

•: key (اسکالر یا نگاشت)

کلیدهای مورد استفاده برای تونل را تعریف می‌کند. کلید می‌تواند یک عدد یا یک آدرس IPv4 چهاربخشی نقطه‌دار (dotted quad) باشد. برای wireguard می‌تواند یک کلید خصوصی کدگذاری‌شده با base64 یا (از networkd نسخه v242+) یک مسیر مطلق به فایلی حاوی کلید خصوصی باشد (از نسخه 0.100). از آن برای شناسایی تبدیل‌های IP استفاده می‌شود. این مورد فقط برای vti و vti6 هنگام استفاده از بک‌اند networkd الزامی است.

این فیلد ممکن است به عنوان یک اسکالر استفاده شود (به این معنی که یک کلید واحد مشخص شده و برای ورودی، خروجی و کلید خصوصی استفاده می‌شود)، یا به عنوان یک نگاشت، که در آن می‌توانید input/output/private را بیشتر مشخص کنید.

•: input (اسکالر)

کلید ورودی برای تونل.

•: output (اسکالر)

کلید خروجی برای تونل.

•: private (اسکالر) – از نسخه 0.100

یک کلید خصوصی کدگذاری‌شده با base64 که برای تونل‌های WireGuard مورد نیاز است. هنگامی که از بک‌اند systemd-networkd (نسخه v242+) استفاده می‌شود، این می‌تواند یک مسیر مطلق به فایلی حاوی کلید خصوصی نیز باشد.

•: private-key-flags (دنباله‌ای از اسکالرها) – از نسخه 0.107

پرچم‌های کلید خصوصی مورد استفاده توسط NetworkManager. مقادیر ممکن عبارتند از: agent-owned، not-saved و not-required.

agent-owned: یک عامل مخفی نشست کاربر مسئول ارائه و ذخیره این راز است.

not-saved: این راز نباید ذخیره شود، بلکه باید هر بار که لازم است از کاربر درخواست شود.

not-required: این پرچم اشاره می‌کند که راز الزامی نیست و نباید از کاربر درخواست شود.

مثال:

network:
  renderer: NetworkManager
  tunnels:
    wg0:
      mode: wireguard
      port: 5182
      key:
        private-key-flags:
          - agent-owned
      peers:
        - keys:
            public: rlbInAj0qV69CysWPQY7KEBnKxpYCpaWqOs/dLevdWc=
          allowed-ips: [0.0.0.0/0, "2001:fe:ad:de:ad:be:ef:1/24"]
          keepalive: 23
          endpoint: 1.2.3.4:5

•: keys (اسکالر یا نگاشت)

نام جایگزین برای فیلد key. بالا را ببینید.

مثال‌ها:

network:
  tunnels:
    tun0:
      mode: gre
      local: ...
      remote: ...
      keys:
        input: 1234
        output: 5678

network:
  tunnels:
    tun0:
      mode: vti6
      local: ...
      remote: ...
      key: 59568549

network:
  tunnels:
    wg0:
      mode: wireguard
      addresses: [...]
      peers:
        - keys:
            public: rlbInAj0qV69CysWPQY7KEBnKxpYCpaWqOs/dLevdWc=
            shared: /path/to/shared.key
          ...
      key: mNb7OIIXTdgW4khM7OFlzJ+UPs7lmcWHV7xjPgakMkQ=

network:
  tunnels:
    wg0:
      mode: wireguard
      addresses: [...]
      peers:
        - keys:
            public: rlbInAj0qV69CysWPQY7KEBnKxpYCpaWqOs/dLevdWc=
          ...
      keys:
        private: /path/to/priv.key

کلیدهای خاص WireGuard:

•: mark (اسکالر) – از نسخه 0.100

علامت فایروال برای بسته‌های خروجی WireGuard از این رابط، اختیاری است.

•: port (اسکالر) – از نسخه 0.100

پورت UDP برای شنود یا auto. اختیاری است، پیش‌فرض auto است.

•: peers (دنباله‌ای از نگاشت‌ها) – از نسخه 0.100

فهرستی از همتاها (peers) که هر کدام دارای کلیدهای مستندشده در زیر هستند.

مثال:

network:
  tunnels:
    wg0:
      mode: wireguard
      key: /path/to/private.key
      mark: 42
      port: 5182
      peers:
        - keys:
            public: rlbInAj0qV69CysWPQY7KEBnKxpYCpaWqOs/dLevdWc=
          allowed-ips: [0.0.0.0/0, "2001:fe:ad:de:ad:be:ef:1/24"]
          keepalive: 23
          endpoint: 1.2.3.4:5
        - keys:
            public: M9nt4YujIOmNrRmpIRTmYSfMdrpvE7u6WkG8FY8WjG4=
            shared: /some/shared.key
          allowed-ips: [10.10.10.20/24]
          keepalive: 22
          endpoint: 5.4.3.2:1

•

endpoint (اسکالر) – از نسخه 0.100

آدرس IPv4/IPv6 یا نام میزبان نقطه پایانی راه دور که به دنبال آن دونقطه و شماره پورت قرار می‌گیرد.

•: allowed-ips (دنباله‌ای از اسکالرها) – از نسخه 0.100

فهرستی از آدرس‌های IP (v4 یا v6) با ماسک‌های CIDR که این همتا مجاز به ارسال ترافیک ورودی از آنها است و ترافیک خروجی برای این همتا به آنها هدایت می‌شود. مقدار فراگیر 0.0.0.0/0 ممکن است برای تطبیق تمام آدرس‌های IPv4 مشخص شود و ::/0 ممکن است برای تطبیق تمام آدرس‌های IPv6 مشخص شود.

•: keepalive (اسکالر) – از نسخه 0.100

فاصله‌ای بر حسب ثانیه، بین ۱ تا ۶۵۵۳۵ شامل هر دو، برای اینکه هر چند وقت یک‌بار یک بسته خالی احراز هویت‌شده به همتا ارسال شود تا یک فایروال با وضعیت (stateful) یا نگاشت NAT به طور مداوم معتبر بماند. اختیاری است.

•: keys (نگاشت) – از نسخه 0.100

کلیدهای مورد استفاده برای همتاهای WireGuard را تعریف می‌کند.

این فیلد می‌تواند به عنوان یک نگاشت استفاده شود، جایی که می‌توانید کلیدهای public و shared را بیشتر مشخص کنید.

•: public (اسکالر) – از نسخه 0.100

یک کلید عمومی با کدگذاری base64 که برای همتاهای WireGuard الزامی است.

•: shared (اسکالر) – از نسخه 0.100

یک کلید از پیش اشتراک‌گذاری‌شده با کدگذاری base64. برای همتاهای WireGuard اختیاری است. هنگامی که از بک‌اند systemd-networkd (نسخه v242+) استفاده می‌شود، این می‌تواند یک مسیر مطلق به فایلی حاوی کلید از پیش اشتراک‌گذاری‌شده نیز باشد.

کلیدهای خاص VXLAN:

•: id (اسکالر) – از نسخه 0.105

شناسه شبکه VXLAN (VNI یا شناسه بخش VXLAN). عددی در محدوده 1..16777215 می‌گیرد.

•: link (اسکالر) – از نسخه 0.105

شناسه Netplan مربوط به تعریف دستگاه والدی که این VXLAN به آن متصل می‌شود.

•: type-of-service (اسکالر) – از نسخه 0.105

مقدار بایت نوع سرویس (Type Of Service) برای یک رابط VXLAN.

•: mac-learning (اسکالر) – از نسخه 0.105

یک مقدار بولی می‌گیرد. هنگامی که true باشد، یادگیری پویای MAC را برای کشف آدرس‌های MAC راه دور فعال می‌کند.

•: ageing، aging (اسکالر) – از نسخه 0.105

طول عمر ورودی پایگاه داده فورواردینگ (FDB) که توسط هسته یاد گرفته شده است، بر حسب ثانیه.

•: limit (اسکالر) – از نسخه 0.105

حداکثر تعداد ورودی‌های FDB را پیکربندی می‌کند.

•: arp-proxy (اسکالر) – از نسخه 0.105

یک مقدار بولی می‌گیرد. هنگامی که true باشد، نقطه پایانی تونل VXLAN متصل به پل به درخواست‌های ARP از پل محلی به نمایندگی از کلاینت‌های راه دور Distributed Overlay Virtual Ethernet (DOVE) پاسخ می‌دهد. پیش‌فرض false است.

•: notifications (دنباله‌ای از اسکالرها) – از نسخه 0.105

پرچم‌های l2-miss و l3-miss را برای فعال‌سازی اعلان‌های عدم تطابق (miss notifications) آدرس IP نت‌لینک و/یا netlink LLADDR می‌پذیرد.

•: short-circuit (اسکالر) – از نسخه 0.105

یک مقدار بولی می‌گیرد. هنگامی که true باشد، مدار کوتاه مسیریابی (route short circuiting) روشن می‌شود.

•: checksums (دنباله‌ای از اسکالرها) – از نسخه 0.105

پرچم‌های udp، zero-udp6-tx، zero-udp6-rx، remote-tx و remote-rx را برای فعال‌سازی ارسال چکسام‌های UDP در VXLAN/IPv4، ارسال/دریافت چکسام‌های صفر در VXLAN/IPv6 و فعال‌سازی برون‌سپاری ارسال/دریافت چکسام در VXLAN می‌پذیرد.

•: extensions (دنباله‌ای از اسکالرها) – از نسخه 0.105

پرچم‌های group-policy و generic-protocol را برای فعال‌سازی پسوندهای VXLAN مربوط به "Group Policy" و/یا "Generic Protocol" می‌پذیرد.

•: port (اسکالر) – از نسخه 0.105

پورت پیش‌فرض مقصد UDP را پیکربندی می‌کند. اگر پورت مقصد مشخص نشود، از مقدار پیش‌فرض هسته لینوکس استفاده خواهد شد. برای دریافت مقدار اختصاص‌یافته توسط IANA روی 4789 تنظیم کنید.

•: port-range (دنباله‌ای از اسکالرها) – از نسخه 0.105

محدوده پورت مبدأ را برای VXLAN پیکربندی می‌کند. هسته، پورت مبدأ UDP را بر اساس جریان (flow) اختصاص می‌دهد تا به گیرنده در انجام متعادل‌سازی بار (load balancing) کمک کند. هنگامی که این گزینه تنظیم نشده باشد، محدوده معمولی پورت‌های UDP محلی استفاده می‌شود. از قالب [LOWER, UPPER] استفاده می‌کند.

•: flow-label (اسکالر) – از نسخه 0.105

برچسب جریان (flow label) را برای استفاده در بسته‌های خروجی مشخص می‌کند. محدوده معتبر 0-1048575 است.

•: do-not-fragment (اسکالر) – از نسخه 0.105

امکان تنظیم بیت «عدم قطعه‌بندی» (Do not Fragment یا DF) در IPv4 را در بسته‌های خروجی فراهم می‌کند. یک مقدار بولی می‌گیرد. در صورت عدم تنظیم، از پیش‌فرض هسته استفاده خواهد شد.

ویژگی‌های نوع دستگاه virtual-ethernets (Properties for device type virtual-ethernets)

وضعیت (Status): اختیاری.

هدف (Purpose): از کلید virtual-ethernets برای ایجاد رابط‌های اترنت مجازی استفاده کنید.

ساختار (Structure): این کلید شامل نگاشتی از نام‌های رابط veth است. هر veth نیازمند یک peer (همتا) است. به منظور داشتن یک جفت veth کاملاً کاربردی، هر دو دستگاه باید تعریف شوند، یعنی صرفاً تنظیم کلید peer با نام همتا کافی نیست؛ رابط همتا نیز باید تعریف شده و دستگاه اول را به عنوان همتای خود تنظیم کند. ساختار کلی پیکربندی برای اترنت مجازی در زیر نشان داده شده است:

network:
  virtual-ethernets:
    veth0:
      peer: veth1
    veth1:
      peer: veth0

پس از اعمال، دو رابط مجازی به نام‌های veth0 و veth1 در سیستم ایجاد خواهد شد.

دستگاه‌های اترنت مجازی مانند تونل‌هایی عمل می‌کنند که ترافیک را از یک رابط به رابط دیگر ارسال می‌کنند. می‌توان از آنها برای اتصال دو شبکه مجازی جداگانه مانند فضاهای نام شبکه (network namespaces) و پل‌ها استفاده کرد. در حال حاضر امکان انتقال virtual-ethernets به فضاهای نام مختلف از طریق Netplan وجود ندارد.

تنظیمات خاص برای virtual-ethernets در زیر تعریف شده‌اند:

•: peer (اسکالر)

همتای virtual-ethernet را تعریف می‌کند. رابط همتا نیز باید یک دستگاه virtual-ethernet باشد.

در زیر یک مثال کامل آورده شده است که از یک جفت دستگاه اترنت مجازی برای ایجاد یک پیوند بین دو پل استفاده می‌کند:

network:
  version: 2
  renderer: networkd
  virtual-ethernets:
    veth0-peer1:
      peer: veth0-peer2
    veth0-peer2:
      peer: veth0-peer1
  bridges:
    br0:
      interfaces:
        - veth0-peer1
    br1:
      interfaces:
        - veth0-peer2

ویژگی‌های نوع دستگاه vlans (Properties for device type vlans)

وضعیت (Status): اختیاری.

هدف (Purpose): از کلید vlans برای ایجاد رابط‌های VLAN استفاده کنید.

ساختار (Structure): این کلید شامل نگاشتی از نام‌های رابط VLAN است. رابط مورد استفاده در گزینه link (enp5s0 در مثال زیر) باید در پیکربندی Netplan نیز تعریف شده باشد. ساختار کلی پیکربندی برای VLANها در زیر نشان داده شده است:

network:
  vlans:
    vlan123:
      id: 123
      link: enp5s0
      dhcp4: yes

تنظیمات خاص برای VLANها در زیر تعریف شده‌اند:

•: id (اسکالر)

شناسه VLAN، عددی بین 0 و 4094.

•: link (اسکالر)

شناسه Netplan مربوط به تعریف دستگاه زیربنایی که این VLAN روی آن ایجاد می‌شود.

مثال:

network:
  ethernets:
    eno1: {...}
  vlans:
    en-intra:
      id: 1
      link: eno1
      dhcp4: yes
    en-vpn:
      id: 2
      link: eno1
      addresses: [...]

ویژگی‌های نوع دستگاه vrfs (Properties for device type vrfs)

وضعیت (Status): اختیاری.

هدف (Purpose): از کلید vrfs برای ایجاد رابط‌های مسیریابی و فوروارد مجازی (VRF) استفاده کنید.

ساختار (Structure): این کلید شامل نگاشتی از نام‌های رابط VRF است. رابط مورد استفاده در گزینه link (enp5s0 در مثال زیر) باید در پیکربندی Netplan نیز تعریف شده باشد. ساختار کلی پیکربندی برای VRFها در زیر نشان داده شده است:

network:
  renderer: networkd
  vrfs:
    vrf1:
      table: 1
      interfaces:
        - enp5s0
      routes:
        - to: default
          via: 10.10.10.4
      routing-policy:
        - from: 10.10.10.42

•

table (اسکالر) – از نسخه 0.105

شناسه عددی جدول مسیریابی. این تنظیم اجباری است.

•: interfaces (دنباله‌ای از اسکالرها) – از نسخه 0.105

تمام دستگاه‌هایی که با این فهرست شناسه مطابقت دارند به VRF اضافه خواهند شد. این می‌تواند یک فهرست خالی باشد، که در این صورت VRF بدون هیچ رابط عضوی آنلاین خواهد شد.

•: routes (دنباله‌ای از نگاشت‌ها) – از نسخه 0.105

مسیریابی ایستا را برای دستگاه پیکربندی می‌کند؛ بخش مسیریابی را ببینید. مقدار table به صورت ضمنی روی table مربوط به VRF تنظیم می‌شود.

•: routing-policy (دنباله‌ای از نگاشت‌ها) – از نسخه 0.105

مسیریابی مبتنی بر خط‌مشی را برای دستگاه پیکربندی می‌کند؛ بخش مسیریابی را ببینید. مقدار table به صورت ضمنی روی table مربوط به VRF تنظیم می‌شود.

مثال:

network:
  vrfs:
    vrf20:
      table: 20
      interfaces: [ br0 ]
      routes:
        - to: default
          via: 10.10.10.3
      routing-policy:
        - from: 10.10.10.42
    [...]
  bridges:
    br0:
      interfaces: []

ویژگی‌های نوع دستگاه nm-devices (Properties for device type nm-devices)

وضعیت (Status): اختیاری. استفاده از آن توصیه نمی‌شود.

هدف (Purpose): از کلید nm-devices برای پیکربندی انواع دستگاه‌هایی که توسط Netplan پشتیبانی نمی‌شوند استفاده کنید. این یک پیکربندی مختص NetworkManager است.

ساختار (Structure): این کلید شامل نگاشتی از اتصالات NetworkManager است. نوع دستگاه nm-devices فقط برای استفاده داخلی است و نباید در فایل‌های پیکربندی معمولی استفاده شود. این گزینه یک حالت بازگشتی (fallback) را برای تنظیمات پشتیبانی‌نشده، با استفاده از نگاشت passthrough فعال می‌کند. ساختار کلی پیکربندی برای اتصالات NM در زیر نشان داده شده است:

network:
  version: 2
  nm-devices:
    NM-db5f0f67-1f4c-4d59-8ab8-3d278389cf87:
      renderer: NetworkManager
      networkmanager:
        uuid: "db5f0f67-1f4c-4d59-8ab8-3d278389cf87"
        name: "myvpnconnection"
        passthrough:
          connection.type: "vpn"
          vpn.ca: "path to ca.crt"
          vpn.cert: "path to client.crt"
          vpn.cipher: "AES-256-GCM"
          vpn.connection-type: "tls"
          vpn.dev: "tun"
          vpn.key: "path to client.key"
          vpn.remote: "1.2.3.4:1194"
          vpn.service-type: "org.freedesktop.NetworkManager.openvpn"

پارامترهای پیکربندی خاص بک‌اند (Back end-specific configuration parameters)

علاوه بر سایر فیلدهای موجود برای پیکربندی رابط‌ها، برخی از بک‌اندها ممکن است نیاز به ثبت برخی پارامترهای خود در Netplan داشته باشند، به ویژه اگر تعاریف Netplan به صورت خودکار توسط مصرف‌کننده آن بک‌اند تولید شوند. در حال حاضر، این مورد فقط با NetworkManager استفاده می‌شود.

•: networkmanager (نگاشت) – از نسخه 0.99

پارامترهای پیکربندی خاص NetworkManager را که توسط دیمن برای شناسایی اتصالات استفاده می‌شود، نگه می‌دارد.

•: name (اسکالر) – از نسخه 0.99

نام نمایشی را برای اتصال تنظیم می‌کند.

•: uuid (اسکالر) – از نسخه 0.99

مقدار UUID (شناسه یکتا) را برای این اتصال، همان‌طور که توسط خود NetworkManager تولید شده است، تعریف می‌کند.

•: stable-id (اسکالر) – از نسخه 0.99

شناسه پایدار (stable ID ‏- شکل متفاوتی از نام اتصال) مورد استفاده توسط NetworkManager را در صورتی که نام اتصال ممکن است به گونه‌ای دیگر تغییر کند، مانند زمانی که اتصالات بین کاربران به اشتراک گذاشته می‌شود، تعریف می‌کند.

•: device (اسکالر) – از نسخه 0.99

نام رابطی را که این اتصال برای آن اعمال می‌شود، تعریف می‌کند.

•: passthrough (نگاشت) – از نسخه 0.102

می‌تواند به عنوان یک سازوکار بازگشتی (fallback) برای تنظیمات ناموجود key-file استفاده شود.

مشاهده نیز (SEE ALSO)

netplan-generate(8)، netplan-apply(8)، netplan-try(8)، netplan-get(8)، netplan-set(8)، netplan-info(8)، netplan-ip(8)، netplan-rebind(8)، netplan-status(8)، netplan-dbus(8)، systemd-networkd(8)، NetworkManager(8)

نویسندگان (AUTHORS)

Mathieu Trudel-Lapierre (cyphermox@ubuntu.com)؛ Martin Pitt (martin.pitt@ubuntu.com)؛ Lukas Märdian (slyon@ubuntu.com).