نام (NAME)

kea-admin - اسکریپت شل برای مدیریت پایگاه‌های داده Kea

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

kea-admin [command] [backend] [-h database_host] [-P database_port] [-u database_username] [-p [database_password]] [-n database_name] [-d script_directory] [-v] [-x extra_argument [-x extra_argument ...]] [-4 | -6] [-i input_file] [-o output_file] [-y]

توضیحات (DESCRIPTION)

kea-admin یک اسکریپت شل است که امکان نگهداری و مدیریت پایگاه داده را فراهم می‌کند. به‌ویژه، این اسکریپت شامل قابلیت‌های مقداردهی اولیه پایگاه داده (initialization)، بررسی نسخه پایگاه داده و ارتقای طرحواره (schema) پایگاه داده است.

آرگومان‌ها (ARGUMENTS)

command: دستوری که باید به سرورها صادر شود را مشخص می‌کند. می‌تواند یکی از موارد زیر باشد:

db-init: یک طرحواره (schema) جدید برای پایگاه داده مقداردهی اولیه می‌کند. این دستور هنگام نصب جدید Kea مفید است. پایگاه داده به آخرین نسخه‌ای که توسط نسخه نرم‌افزار در حال نصب پشتیبانی می‌شود، مقداردهی اولیه می‌گردد.
db-version: شماره نسخه بک‌اند پایگاه داده را گزارش می‌دهد. این شماره لزوماً با شماره نسخه Kea برابر نیست، زیرا هر بک‌اند طرح نسخه‌گذاری مختص به خود را دارد.
db-upgrade: ارتقای طرحواره (schema) پایگاه داده را انجام می‌دهد. این دستور هنگام ارتقای Kea مفید است.
lease-dump: محتویات پایگاه داده اجاره‌ها (برای بک‌اندهای MySQL یا PostgreSQL) را در یک فایل متنی CSV (مقادیر جداشده با کاما) تخلیه (dump) می‌کند. (پشتیبانی از بک‌اند Cassandra منسوخ شده است.) سطر اول فایل حاوی نام ستون‌ها است. از این قابلیت می‌توان به عنوان روشی برای مهاجرت از یک بک‌اند پایگاه داده به بک‌اند memfile استفاده کرد. همچنین می‌تواند به عنوان یک ابزار عیب‌یابی استفاده شود، زیرا شکل قابل حملی از داده‌های اجاره را فراهم می‌آورد. آرگومان‌های اجباری دیگری وجود دارند که باید همراه با این دستور استفاده شوند: باید یکی از گزینه‌های -4 یا -6 مشخص شود، و یکی از گزینه‌های -o یا --output تعیین گردد.
lease-upload: اجاره‌ها را از یک فایل متنی CSV (مقادیر جداشده با کاما) در یک پایگاه داده اجاره MySQL یا PostgreSQL بارگذاری می‌کند. فایل CSV باید در قالب memfile باشد. آرگومان‌های اجباری دیگری وجود دارند که باید همراه با این دستور استفاده شوند: باید یکی از گزینه‌های -4 یا -6 مشخص شود، و یکی از گزینه‌های -i یا --input تعیین گردد.
stats-recount: آمار اجاره‌ها را برای یک پایگاه داده MySQL یا PostgreSQL مجدداً شمارش می‌کند.

backend: نوع بک‌اند را مشخص می‌کند. بک‌اندهای مجاز در حال حاضر عبارتند از: memfile، mysql و pgsql؛ گزینه cql منسوخ شده است.
-h|--host hostname: نام میزبان را هنگام اتصال به پایگاه داده مشخص می‌کند. مقدار پیش‌فرض localhost است.
-i|--input input_file: فایل متنی CSV (مقادیر جداشده با کاما) حاوی اجاره‌ها برای بارگذاری را مشخص می‌کند؛ برای lease-upload الزامی است.
-P|--port port: درگاه (پورت) را هنگام اتصال به پایگاه داده مشخص می‌کند. اگر تعیین نشود، از مقدار پیش‌فرض انتخاب‌شده توسط کلاینت پایگاه داده استفاده می‌شود.
-u|--user username: نام کاربری را هنگام اتصال به پایگاه داده مشخص می‌کند. مقدار پیش‌فرض keatest است.
-p|--password password: رمز عبور را هنگام اتصال به پایگاه داده مشخص می‌کند. اگر فقط -p یا --password داده شود، از کاربر رمز عبور درخواست می‌شود. اگر اصلاً مشخص نشود، متغیر محیطی KEA_ADMIN_DB_PASSWORD برای یافتن مقدار بررسی شده و در صورت وجود استفاده می‌شود. در غیر این صورت از مقدار پیش‌فرض 1234 استفاده می‌گردد.
-n|--name database-name: نام پایگاه داده برای اتصال را مشخص می‌کند. مقدار پیش‌فرض keatest است.
-d|--directory script-directory: پوشه اسکریپت‌های جایگزین را مشخص می‌کند. این اسکریپت در طول ارتقا، مقداردهی اولیه پایگاه داده و احتمالاً سایر عملیات استفاده می‌شود. مقدار پیش‌فرض (prefix)/share/kea/scripts/ است.
-o|--output output_file: فایلی را که داده‌های اجاره در آن تخلیه می‌شوند مشخص می‌کند. برای lease-dump الزامی است.
-v|--version: نسخه Kea را نمایش می‌دهد.
-V: نسخه گسترش‌یافته Kea را نمایش می‌دهد.
-4: به kea-admin دستور می‌دهد که داده‌های اجاره DHCPv4 را تخلیه کند. با گزینه -6 ناسازگار است.
-6: به kea-admin دستور می‌دهد که داده‌های اجاره DHCPv6 را تخلیه کند. با گزینه -4 ناسازگار است.
-x|--extra: یک آرگومان اضافی را برای ارسال به ابزار خط فرمان پایگاه داده مشخص می‌کند، مثلاً برای فراخوانی mysql با آرگومان --ssl. این گزینه می‌تواند برای ارسال بیش از یک آرگومان تکرار شود. علامت‌های نقل‌قول حفظ نمی‌شوند. از دستورهای حاوی فاصله خودداری کنید.
-y|--yes: پاسخ مثبت (yes) را هنگام بازنویسی فایل‌های موقت فرض می‌کند.

مستندات (DOCUMENTATION)

پروژه Kea همراه با یک «راهنمای مرجع مدیران Kea» جامع ارائه می‌شود که تمامی جنبه‌های اجرای نرم‌افزار Kea - کامپایل، نصب، پیکربندی، نمونه‌های پیکربندی و موارد بسیار دیگر را پوشش می‌دهد. Kea همچنین دارای یک «راهنمای پیام‌های Kea» است که فهرستی از تمامی پیام‌های احتمالی قابل چاپ توسط Kea را به همراه توضیحی کوتاه برای هر یک ارائه می‌دهد. هر دو سند در قالب‌های مختلف (.txt، .html، .pdf) همراه با توزیع Kea در دسترس هستند. مستندات Kea در نشانی https://kea.readthedocs.io در دسترس است.

کد منبع Kea در «راهنمای توسعه‌دهندگان Kea» (Kea Developer's Guide) مستند شده است و در نشانی https://reports.kea.isc.org/dev_guide/ در دسترس است.

وب‌سایت پروژه Kea در نشانی https://kea.isc.org در دسترس است.

فهرست‌های پستی و پشتیبانی (MAILING LISTS AND SUPPORT)

دو فهرست پستی عمومی برای پروژه Kea در دسترس است: kea-users (kea-users در lists.isc.org) برای کاربران Kea در نظر گرفته شده است، در حالی که kea-dev (kea-dev در lists.isc.org) برای توسعه‌دهندگان Kea، مشارکت‌کنندگان آینده و سایر کاربران پیشرفته در نظر گرفته شده است. هر دو فهرست در نشانی https://lists.isc.org در دسترس هستند. جامعه کاربری پشتیبانی برمبنای بهترین تلاش (best-effort) را در هر دو فهرست ارائه می‌دهد.

مجموعه ISC پشتیبانی حرفه‌ای برای خدمات Kea ارائه می‌کند. برای جزئیات به https://www.isc.org/kea/ مراجعه کنید.

همچنین ببینید (SEE ALSO)

kea-dhcp4(8), kea-dhcp6(8), kea-dhcp-ddns(8), keactrl(8), perfdhcp(8), kea-netconf(8), Kea Administrator Reference Manual.

نویسنده (AUTHOR)

Internet Systems Consortium

حق نشر (COPYRIGHT)

2019-2026, Internet Systems Consortium