دستورهای ایجاد پایگاه داده

این دستورها یک فایل پایگاه داده جدید OVSDB ایجاد می‌کنند. آن‌ها روی فایل‌های پایگاه داده موجود بازنویسی نخواهند کرد. برای جایگزینی یک پایگاه داده موجود با پایگاه داده‌ای جدید، ابتدا نسخه قدیمی را حذف کنید.

create [db [schema]]

از این دستور برای ایجاد پایگاه داده جهت کنترل ovs-vswitchd یا یک پایگاه داده مستقل یا فعال-پشتیبان دیگر استفاده کنید. این دستور فایل پایگاه داده db را با طرحواره (schema) داده‌شده ایجاد می‌کند؛ این طرحواره باید نام فایلی حاوی یک طرحواره OVSDB در قالب JSON باشد، همان‌طور که در مشخصات OVSDB تعیین شده است. پایگاه داده جدید در ابتدا خالی است. (می‌توانید از cp برای رونوشت‌برداری از یک پایگاه داده شامل طرحواره و داده‌های آن استفاده کنید.)

[--election-timer=ms] create-cluster db contents local

از این دستور برای راه‌اندازی اولیه نخستین کارساز در یک خوشه با دسترس‌پذیری بالا (HA) شامل ۳ (یا بیشتر) کارساز پایگاه داده استفاده کنید؛ برای نمونه برای پایگاه داده‌ای در محیطی که تحمل نقطه تکی خرابی را ندارد. این دستور فایل پایگاه داده خوشه‌ای db را ایجاد کرده و کارساز را برای گوش فرا دادن روی local پیکربندی می‌کند؛ این نشانی باید به قالب protocol:ip:port باشد، که در آن protocol برابر با tcp یا ssl است، ip نشانی IP کارساز (یا نشانی IPv4 یا نشانی IPv6 محصور در قلاب‌ها) است، و port شماره پورت TCP است. تنها یک نشانی برای نخستین کارساز در خوشه مشخص می‌شود، که معمولاً مربوط به کارسازی است که create-cluster را اجرا می‌کند. این نشانی برای ارتباطات درون خوشه استفاده می‌شود نه برای ارتباط با کلاینت‌های OVSDB، و نباید از همان پورتی که برای پروتکل OVSDB استفاده می‌شود بهره ببرد.

پایگاه داده جدید با contents مقداردهی اولیه می‌شود، که باید نام فایلی حاوی یک طرحواره OVSDB در قالب JSON یا یک پایگاه داده مستقل OVSDB باشد. اگر یک فایل طرحواره باشد، پایگاه داده جدید در ابتدا خالی و دارای طرحواره داده‌شده خواهد بود. اگر یک فایل پایگاه داده باشد، پایگاه داده جدید دارای همان طرحواره و محتویات خواهد بود.

اگر در مدت زمان تایمر انتخابات مشخص‌شده هیچ پیام ضربان قلبی (Heartbeat) از رهبر خوشه دریافت نشود، انتخاب رهبر توسط یک پیرو آغاز خواهد شد. زمان پیش‌فرض تایمر انتخابات رهبر ۱۰۰۰ میلی‌ثانیه است. برای استفاده از مقداری دیگر هنگام ایجاد پایگاه داده، گزینه --election-timer=ms را مشخص کنید که در آن ms مقداری بر حسب میلی‌ثانیه بین ۱۰۰ تا ۶۰۰۰۰۰ (شامل خود آن‌ها) است.

[--cid=uuid] join-cluster db name local remote...

از این دستور برای راه‌اندازی اولیه هر کارساز پس از کارساز اول در یک خوشه با دسترس‌پذیری بالای OVSDB استفاده کنید. این دستور فایل پایگاه داده خوشه‌ای db را برای پایگاه داده‌ای با نام name ایجاد کرده و کارساز را برای گوش فرا دادن روی local و اتصال اولیه به remote پیکربندی می‌کند؛ remote باید کارسازی باشد که از قبل به خوشه تعلق دارد. local و remote از همان ساختار نگارشی protocol:ip:port مشابه create-cluster استفاده می‌کنند.

مقدار name باید نام طرحواره یا پایگاه داده داده‌شده به create-cluster باشد. برای نمونه، نام طرحواره پایگاه داده OVN Southbound برابر با OVN_Southbound است. برای یافتن نام یک طرحواره یا پایگاه داده، به ترتیب از دستورهای schema-name یا db-name در ovsdb-tool استفاده کنید.

این دستور هیچ‌گونه دسترسی به شبکه انجام نمی‌دهد، به این معنی که عملاً نمی‌تواند کارساز جدید را در همان لحظه به خوشه متصل کند. در عوض، فایل db ایجاد‌شده، کارساز را آماده می‌کند تا در نخستین باری که ovsdb-server آن را سرویس‌دهی می‌کند، به خوشه بپیوندد. به عنوان بخشی از پیوستن به خوشه، کارساز جدید طرحواره پایگاه داده را دریافت کرده و فهرست تمام اعضای خوشه را به دست می‌آورد. تنها پس از آن است که به عضوی کامل از خوشه تبدیل می‌شود.

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

به‌طور پیش‌فرض، فایل db ایجاد‌شده توسط join-cluster به هر پایگاه داده خوشه‌ای با نام name که روی یک remote در دسترس باشد ملحق خواهد شد. از نظر تئوری، اگر ماشین‌ها خاموش و روشن شوند و نشانی‌های IP به نحوی خاص تغییر کنند، ممکن است به خوشه پایگاه داده اشتباهی ملحق شود. برای جلوگیری از این احتمال، گزینه --cid=uuid را مشخص کنید که در آن uuid شناسه خوشه‌ای است که می‌خواهید به آن بپیوندید، همان‌طور که توسط ovsdb-tool get-cid چاپ می‌شود.

دستورهای مهاجرت پایگاه داده

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

cluster-to-standalone db clusterdb

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

دستورهای مدیریت نسخه

یک طرحواره OVSDB دارای شماره نسخه طرحواره است و یک پایگاه داده OVSDB نسخه خاصی از یک طرحواره OVSDB را در خود جای داده است. این شماره نسخه‌ها به شکل x.y.z هستند، مانند 1.2.3. پیاده‌سازی OVSDB طرح شماره‌گذاری نسخه خاصی را تحمیل نمی‌کند، اما طرحواره‌های مدیریت‌شده در پروژه Open vSwitch از رویکرد زیر استفاده می‌کنند. هر زمان که طرحواره پایگاه داده به شیوه‌ای ناسازگار با گذشته تغییر کند (مانند حذف یک ستون یا یک جدول)، مقدار x افزایش می‌یابد (و y و z به ۰ بازنشانی می‌شوند). هنگامی که طرحواره پایگاه داده به شیوه‌ای سازگار با گذشته تغییر کند (مانند افزودن یک ستون جدید)، مقدار y افزایش می‌یابد (و z به ۰ بازنشانی می‌شود). هنگامی که تغییرات طرحواره صرفاً ظاهری باشد (مانند اصلاح فاصله‌گذاری‌ها در ساختار آن)، مقدار z افزایش می‌یابد.

برخی پایگاه‌های داده و طرحواره‌های OVSDB، به‌ویژه نسخه‌های بسیار قدیمی، فاقد شماره نسخه هستند.

شماره نسخه‌های طرحواره و شماره نسخه‌های Open vSwitch مستقل از یکدیگر هستند.

این دستورها با نسخه‌های مختلف طرحواره‌ها و پایگاه‌های داده OVSDB کار می‌کنند.

convert [db [schema [target]]]

فایل db را خوانده، آن را به طرحواره مشخص‌شده در schema تبدیل کرده و تفسیر جدید را می‌نویسد. اگر target مشخص شده باشد، نسخه تبدیل‌شده به عنوان یک فایل جدید به نام target نوشته می‌شود که نباید از قبل وجود داشته باشد. اگر target حذف شود، نسخه تبدیل‌شده پایگاه داده جایگزین درجا برای db خواهد شد. اگر پایگاه داده در حال حاضر توسط ovsdb-server سرویس‌دهی می‌شود، تبدیل درجا امکان‌پذیر نیست (در عوض، یا ابتدا ovsdb-server را متوقف کنید یا از دستور convert در ovsdb-client استفاده نمایید).

این دستور می‌تواند «ارتقاها» و «تنزل‌های» ساده‌ای را روی طرحواره پایگاه داده انجام دهد. داده‌های موجود در db هنگام تفسیر تحت schema باید معتبر باشند، به جز یک استثنا: داده‌های موجود در db برای جداول و ستون‌هایی که در schema وجود ندارند نادیده گرفته می‌شوند. ستون‌هایی که در schema وجود دارند اما در db نیستند، روی مقادیر پیش‌فرض خود تنظیم می‌شوند. تمام محدودیت‌های schema به طور کامل اعمال خواهند شد.

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

این دستور تنها برای پایگاه‌های داده مستقل و فعال-پشتیبان است. برای پایگاه‌های داده خوشه‌ای، از دستور convert در ovsdb-client برای تبدیل برخط استفاده کنید.

needs-conversion [db [schema]]

طرحواره تعبیه‌شده در db و طرحواره JSON را از schema خوانده و آن‌ها را مقایسه می‌کند. اگر طرحواره‌ها یکسان باشند، no و در صورت تفاوت، yes را در خروجی استاندارد چاپ می‌کند.

این دستور فقط برای پایگاه‌های داده مستقل و فعال-پشتیبان است. برای پایگاه‌های داده خوشه‌ای، به جای آن از دستور needs-conversion در ovsdb-client استفاده کنید.

db-version [db]

schema-version [schema]

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

دستور db-version فقط برای پایگاه‌های داده مستقل و فعال-پشتیبان کاربرد دارد. برای پایگاه‌های داده خوشه‌ای، به جای آن از دستور schema-version در ovsdb-client استفاده کنید.

db-cksum [db]

schema-cksum [schema]

چک‌سام موجود در طرحواره تعبیه‌شده در پایگاه داده db یا طرحواره JSON به نام schema را در خروجی استاندارد چاپ می‌کند. اگر schema یا db پیش از معرفی چک‌سام طرحواره ایجاد شده باشد، چک‌سام نخواهد داشت و این دستور یک خط خالی چاپ می‌کند.

دستور db-cksum فقط برای پایگاه‌های داده مستقل و فعال-پشتیبان است. برای پایگاه‌های داده خوشه‌ای، به جای آن از دستور schema-cksum در ovsdb-client استفاده کنید.

compare-versions a op b

دو مقدار a و b را بر اساس عملگر op مقایسه می‌کند. هر دو مقدار a و b باید شماره نسخه طرحواره OVSDB به شکل x.y.z باشند، همان‌طور که در ovsdb(7) شرح داده شده است، و op باید یکی از عملگرهای < <= == >= > != باشد. اگر مقایسه برقرار باشد، با وضعیت 0 خارج می‌شود؛ اگر نادرست باشد با وضعیت 2 خارج می‌شود. (وضعیت خروج 1 نشان‌دهنده خطا است، برای نمونه نادرست بودن ساختار نگارشی نسخه OVSDB در a یا b یا معتبر نبودن عملگر مقایسه‌ای op).

سایر دستورها

compact [db [target]]

فایل db را خوانده و نسخه‌ای فشرده‌شده از آن را می‌نویسد. اگر target مشخص شده باشد، نسخه فشرده‌شده به عنوان فایل جدیدی با نام target نوشته می‌شود که نباید از قبل وجود داشته باشد. اگر target حذف شود، نسخه فشرده‌شده پایگاه داده به صورت درجا جایگزین db می‌شود. این دستور در شرایط عادی عملیاتی لازم نیست، زیرا ovsdb-server هرازگاهی به‌طور خودکار پایگاه داده‌ای را که بسیار بزرگ‌تر از حداقل اندازه خود شده باشد فشرده‌سازی می‌کند.

اگر db در حال حاضر توسط ovsdb-server در حال سرویس‌دهی باشد، یا به نحوی دیگر برای نوشتن توسط پردازش دیگری قفل شده باشد، این دستور کار نخواهد کرد. همچنین این دستور روی پایگاه‌های داده خوشه‌ای کار نمی‌کند. در هر دو مورد، به جای آن دستور ovsdb-server/compact را از طریق ovs-appctl به ovsdb-server ارسال کنید.

[--rbac-role=role] query [db] transaction

فایل db را باز کرده، transaction را روی آن اجرا می‌کند و نتایج را چاپ می‌نماید. مقدار transaction باید یک آرایه JSON در قالب آرایه params برای متد JSON-RPC بنام transact باشد، همان‌گونه که در مشخصات OVSDB تشریح شده است.

این دستور db را با دسترسی فقط‌خواندنی باز می‌کند، بنابراین اجرای آن به صورت همزمان با سایر فعالیت‌های پایگاه داده، از جمله ovsdb-server و سایر نویسندگان پایگاه داده، کاملاً ایمن است. تراکنش transaction ممکن است تغییراتی را برای پایگاه داده مشخص کند، اما این تغییرات هیچ اثری روی db نخواهند داشت.

به‌طور پیش‌فرض، تراکنش با استفاده از نقش RBAC مدیر ارشد («superuser») اجرا می‌شود. از --rbac-role برای تعیین یک نقش دیگر استفاده کنید.

این دستور با پایگاه‌های داده خوشه‌ای کار نمی‌کند. در عوض، از دستور query در ovsdb-client برای ارسال پرس‌وجو به ovsdb-server استفاده کنید.

[--rbac-role=role] transact [db] transaction

فایل db را باز کرده، transaction را روی آن اجرا می‌کند، نتایج را چاپ می‌نماید و هرگونه تغییر را در db ثبت (commit) می‌کند. مقدار transaction باید یک آرایه JSON در قالب آرایه params برای متد JSON-RPC بنام transact باشد، همان‌گونه که در مشخصات OVSDB تشریح شده است.

اگر db در حال حاضر توسط ovsdb-server در حال سرویس‌دهی باشد، یا به هر نحوی برای نوشتن توسط فرایندی دیگر قفل شده باشد، این دستور کار نمی‌کند. همچنین این دستور برای پایگاه‌های داده خوشه‌ای کارایی ندارد. در هر دو حالت، در عوض از دستور transact در ovsdb-client برای ارسال پرس‌وجو به ovsdb-server استفاده کنید.

به‌طور پیش‌فرض، تراکنش با استفاده از نقش RBAC کاربر ارشد («superuser») اجرا می‌شود. از --rbac-role برای تعیین نقشی دیگر استفاده کنید.

[-m | --more]... show-log [db]

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

برای افزایش جزئیات خروجی، گزینه -m (یا --more) را یک یا چند بار به خط فرمان بیفزایید. با یک بار استفاده از -m، دستور show-log خلاصه‌ای از رکوردهای اضافه‌شده، حذف‌شده یا تغییر‌یافته توسط هر تراکنش را چاپ می‌کند. با دو بار استفاده از -m، دستور show-log مقادیر ستون‌هایی را نیز که با هر تغییر رکورد دستخوش دگرگونی شده‌اند چاپ می‌کند.

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

check-cluster db...

تمام رکوردهای پایگاه‌های داده ارائه‌شده را می‌خواند؛ این پایگاه‌های داده باید از کارسازهای مختلف (و در حالت ایده‌آل تمامی کارسازها) در یک خوشه یکسان جمع‌آوری شده باشند. این دستور سازگاری درونی هر پایگاه داده و همچنین سازگاری متقابل مجموعه آن‌ها با یکدیگر را بررسی می‌کند. اگر ovsdb-tool متوجه محتوایی غیرعادی شود که لزوماً نادرست نیست، یک یا چند هشدار در خروجی استاندارد چاپ می‌کند. اگر ovsdb-tool خطاهای عدم سازگاری بیابد، خطایی را در خروجی خطای استاندارد (stderr) چاپ کرده و با وضعیت 1 خارج می‌شود. این خطاها معمولاً نشان‌دهنده اشکالات نرم‌افزاری در ovsdb-server هستند؛ لطفاً گزارش آن‌ها را برای توسعه‌دهندگان Open vSwitch ارسال کنید.

db-name [db]

schema-name [schema]

نام طرحواره تعبیه‌شده در پایگاه داده db یا در طرحواره JSON به نام schema را در خروجی استاندارد چاپ می‌کند.

db-cid db

شناسه خوشه (Cluster ID) را که یک شناسه یکتا (UUID) برای شناسایی خوشه است، برای db چاپ می‌کند. اگر db یک پایگاه داده تازه‌تولیدشده توسط ovsdb-tool cluster-join باشد که هنوز با موفقیت به خوشه‌اش ملحق نشده است، و گزینه --cid نیز در خط فرمان cluster-join مشخص نشده باشد، این دستور خطایی چاپ کرده و با وضعیت 2 خارج می‌شود، زیرا شناسه خوشه هنوز مشخص نیست. این دستور تنها با پایگاه‌های داده خوشه‌ای کار می‌کند.

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

db-sid db

شناسه کارساز (Server ID) را که یک شناسه یکتا (UUID) برای شناسایی کارساز است، برای db چاپ می‌کند. این دستور تنها با پایگاه‌های داده خوشه‌ای کار می‌کند. این دستور حتی در صورتی که db یک پایگاه داده تازه‌تولیدشده توسط ovsdb-tool cluster-join باشد که هنوز به خوشه ملحق نشده است نیز کار می‌کند.

db-local-address db

نشانی محلی مورد استفاده برای خوشه‌بندی پایگاه داده را برای db، به همان شکل protocol:ip:port به کار رفته در create-cluster و join-cluster چاپ می‌کند.

db-is-clustered db

db-is-standalone db

بررسی می‌کند که آیا db یک فایل پایگاه داده در قالب خوشه‌ای است یا مستقل. در صورت تطابق، با وضعیت 0 خارج می‌شود؛ در غیر این صورت با وضعیت 2 پایان می‌یابد. (وضعیت خروج 1 نشان‌دهنده خطا است، برای نمونه فایل db یک پایگاه داده OVSDB نباشد یا وجود نداشته باشد).

گزینه‌های گزارش‌گیری (Logging Options)

-v[spec]

--verbose=[spec]

سطوح ثبت گزارش (لاگ) را تنظیم می‌کند. بدون هیچ spec، سطح لاگ را برای همه ماژول‌ها و مقصدها روی dbg تنظیم می‌کند. در غیر این صورت، spec فهرستی از کلمات جداشده با فاصله، کاما یا دونقطه است که از هر یک از دسته‌های زیر حداکثر یک مورد انتخاب می‌شود:

بزرگی یا کوچکی حروف در spec اهمیتی ندارد.

صرف‌نظر از سطوح گزارش تنظیم‌شده برای file، ثبت گزارش در یک فایل انجام نمی‌شود مگر اینکه گزینه --log-file نیز مشخص شده باشد (در ادامه ببینید).

برای سازگاری با نسخه‌های قدیمی‌تر OVS، واژه any پذیرفته می‌شود اما هیچ اثری ندارد.

-v

--verbose

حداکثر سطح پرحرفی (جزئیات) ثبت گزارش را تنظیم می‌کند که معادل با --verbose=dbg است.

-vPATTERN:destination:pattern

--verbose=PATTERN:destination:pattern

الگوی لاگ را برای destination روی pattern تنظیم می‌کند. برای شرح نحو معتبر برای pattern به ovs-appctl(8) مراجعه کنید.

-vFACILITY:facility

--verbose=FACILITY:facility

مکانیسم لاگ (RFC5424 facility) پیام لاگ را تنظیم می‌کند. مقدار facility می‌تواند یکی از مقادیر kern، user، mail، daemon، auth، syslog، lpr، news، uucp، clock، ftp، ntp، audit، alert، clock2، local0، local1، local2، local3، local4، local5، local6 یا local7 باشد. اگر این گزینه مشخص نشده باشد، daemon به عنوان پیش‌فرض برای syslog محلی سیستم استفاده می‌شود و local0 هنگام ارسال پیام به مقصدی که از طریق گزینه --syslog-target فراهم شده، به کار می‌رود.

--log-file[=file]

ثبت گزارش در یک فایل را فعال می‌کند. اگر file مشخص شده باشد، به عنوان نام دقیق فایل گزارش استفاده می‌شود. نام پیش‌فرض فایل گزارش در صورت حذف file برابر با /var/log/openvswitch/ovsdb-tool.log است.

--syslog-target=host:port

علاوه بر syslog سیستم، پیام‌های syslog را به پورت UDP به شماره port روی host ارسال می‌کند. مقدار host باید یک نشانی IP عددی باشد، نه یک نام میزبان.

--syslog-method=method

روش (method) ارسال پیام‌های syslog به دیمن syslog را مشخص می‌کند. حالت‌های زیر پشتیبانی می‌شوند:

مقدار پیش‌فرض از متغیر محیطی OVS_SYSLOG_METHOD خوانده می‌شود؛ در صورت تنظیم نبودن آن، مقدار پیش‌فرض libc است.

سایر گزینه‌ها

-h

--help

پیام راهنمای کوتاهی را در کنسول نمایش می‌دهد.

-V

--version

اطلاعات نسخه برنامه را در کنسول چاپ می‌کند.