APCUPSD.CONF(5) File Formats Manual APCUPSD.CONF(5)

apcupsd.conf — فایل پیکربندی apcupsd(8)

apcupsd.conf فایل پیکربندی برای برنامهٔ apcupsd(8) است. این فایل یک پروندهٔ متنی سادهٔ ASCII است که شامل تعدادی دستورالعمل پیکربندی بوده و نحوهٔ رفتار برنامهٔ apcupsd را هنگام کنترل اغلب دستگاه‌های یوپی‌اس شرکت American Power Conversion Corp (APC) تعیین می‌کند. این فایل پیکربندی همچنین توسط برنامهٔ apctest(8) هنگام برنامه‌ریزی دسته‌جمعی حافظهٔ EEPROM در مدل‌های Smart-UPS به کار می‌رود.

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

توجه داشته باشید که دیمن apcupsd برای فعال شدن تغییرات اعمال‌شده در فایل پیکربندی، باید مجدداً راه‌اندازی (restart) شود.

دستورالعمل‌های فایل پیکربندی در زیربخش‌های زیر توضیح داده شده‌اند.

UPSNAME <string>

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

UPSCABLE [ simple | smart | ether | usb | 940-0119A | 940-0127A | 940-0128A | 940-0020B | 940-0020C | 940-0023A | 940-0024B | 940-0024C | 940-1524C | 940-0024G | 940-0095A | 940-0095B | 940-0095C | 940-0625A | MAM-04-02-2000 ]

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

UPSTYPE [ dumb | apcsmart | net | usb | snmp | pcnet | modbus |test ]

نوع یوپی‌اس APC که در اختیار دارید.

DEVICE <name>

نام دستگاهی که برای برقراری ارتباط میان یوپی‌اس و رایانه استفاده می‌شود. برای یک یوپی‌اس USB، باید دستورالعمل DEVICE را خالی بگذارید تا apcupsd خود محل قرارگیری دستگاه را تشخیص دهد.

  • apcsmart : /dev/tty** (اتصال سریال)
  • usb : خالی بگذارید! (اتصال USB)
  • net : hostname:port (اتصال NIS)
  • snmp : hostname:port:vendor:community (اتصال SNMP)
  • dumb : /dev/tty** (اتصال سریال)
  • pcnet : ipaddr:username:passphrase (کارت AP9617 SmartSlot)
  • modbus : /dev/tty** (اتصال سریال)
  • modbus : خالی بگذارید (اتصال USB)

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

POLLTIME <seconds>

فاصلهٔ زمانی بر حسب ثانیه که دیمن وضعیت یوپی‌اس را بررسی (poll) می‌کند. این نرخ زمانی که یوپی‌اس روی باتری می‌رود به طور خودکار روی ۱ ثانیه تنظیم می‌شود و با بازگشت برق شبکه، به مقدار مشخص‌شده بازنشانی می‌گردد. این تنظیم هم برای یوپی‌اس‌های متصل مستقیم و هم برای یوپی‌اس‌های تحت شبکه اعمال می‌شود. مقدار کمتر، سرعت پاسخ‌دهی دیمن به رویدادهای خاص را به بهای مصرف بالاتر پردازنده (CPU) بهبود می‌بخشد. مقدار پیش‌فرض ۶۰ برای بیشتر موقعیت‌ها مناسب است.

LOCKFILE <path>

برنامه apcupsd یک فایل قفل (lockfile) برای درگاه سریال یا USB در دایرکتوری مشخص‌شده ایجاد می‌کند. در صورت اجرای بیش از یک نسخه از apcupsd روی یک رایانه جهت کنترل چندین یوپی‌اس، این مسیر باید تغییر داده شود.

SCRIPTDIR <path>

دایرکتوری‌ای که apccontrol و اسکریپت‌های رویداد در آن قرار دارند. مقدار پیش‌فرض /usr/local/etc/apcupsd است. در صورت اجرای بیش از یک نسخه از apcupsd روی یک رایانه جهت کنترل چندین یوپی‌اس، این مسیر باید تغییر کند.

PWRFAILDIR <path>

دایرکتوری‌ای که apcupsd فایل پرچم قطع برق (powerfail) را هنگام آغاز خاموش‌سازی سیستم در آن می‌نویسد. این دایرکتوری در اسکریپت‌های توقف سیستم (halt) بررسی می‌شود تا مشخص شود آیا خاموش کردن توان خروجی یوپی‌اس لازم است یا خیر. مقدار پیش‌فرض /var/run است. در صورت اجرای بیش از یک نسخه از apcupsd روی یک رایانه جهت کنترل چندین یوپی‌اس، این مسیر باید تغییر کند.

NOLOGINDIR <path>

دایرکتوری‌ای که apcupsd فایل nologin را در آن می‌نویسد که به سیستم‌عامل دستور می‌دهد از ورود کاربران جدید جلوگیری کند. مقدار پیش‌فرض /var/run است. در صورت اجرای بیش از یک نسخه از apcupsd روی یک رایانه جهت کنترل چندین یوپی‌اس، این مقدار باید تغییر کند.

NETSERVER [ on | off ]

کارگزار اطلاعات شبکه (NIS) را فعال یا غیرفعال می‌کند. در صورت فعال بودن، apcupsd اطلاعات وضعیت و رویدادها را روی شبکه ارائه می‌دهد. این اطلاعات همچنین توسط برنامه‌های نظارتی تحت وب CGI استفاده می‌شود. مقدار پیش‌فرض on است.

NISIP <IP address>

آدرس IP رابط شبکه‌ای را مشخص می‌کند که apcupsd روی آن به اتصالات ورودی گوش فرا می‌دهد. مقدار پیش‌فرض 0.0.0.0 است که به این معناست NIS روی تمام رابط‌های شبکه به اتصالات ورودی گوش خواهد داد. اگر رایانه بیش از یک رابط شبکه دارد، می‌توانید IP یک رابط منفرد را مشخص کنید تا اتصالات به همان رابط محدود شوند. تعیین آدرس بازگشتی (127.0.0.1) باعث می‌شود دیمن NIS تنها اتصالات ورودی از رایانهٔ محلی را بپذیرد.

NISPORT <port>

درگاهی (پورت) را که توسط دیمن NIS استفاده می‌شود مشخص می‌کند. مقدار پیش‌فرض 3551 است که از سوی IANA به عنوان پورت رسمی شبکه apcupsd تعیین شده است. در صورت اجرای بیش از یک نسخه از apcupsd روی یک رایانه جهت کنترل چندین یوپی‌اس، این مقدار باید تغییر کند.

EVENTSFILE <filename>

اگر می‌خواهید NIS تعداد ۱۰ رویداد اخیر را از طریق شبکه ارائه دهد، باید فایلی را مشخص کنید که apcupsd این رویدادها را در آن ذخیره کند. مقدار پیش‌فرض عبارت است از: /var/log/apcupsd.events. برنامه apcupsd حداکثر ۵۰ رویداد آخر را در این فایل ذخیره خواهد کرد. هنگامی که بیش از ۵۰ رویداد ذخیره شده باشد و درخواستی از طریق شبکه برای رویدادها دریافت شود، apcupsd فایل را به ۱۰ رویداد اخیر کوتاه (truncate) می‌کند. در صورت اجرای بیش از یک نسخه از apcupsd روی یک رایانه جهت کنترل چندین یوپی‌اس، این مقدار باید تغییر کند.

STATTIME <seconds>

بازهٔ زمانی بر حسب ثانیه را میان دفعات نوشتن در فایل وضعیت مشخص می‌کند. اگر روی صفر تنظیم شود، در فایل وضعیت چیزی نوشته نخواهد شد. فایل وضعیت در نسخه‌های آیندهٔ apcupsd حذف خواهد شد چرا که کارکرد آن با سرور اطلاعات شبکه (NIS) و برنامهٔ apcaccess(8) جایگزین شده است.

STATFILE <file>

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

LOGSTATS [ on | off ]

فعال‌سازی فایل ثبت وقایع (لاگ). این گزینه خروجی بسیار زیادی تولید می‌کند؛ بنابراین اگر آن را فعال می‌کنید، اطمینان حاصل کنید فایلی که در syslog.conf(5) برای LOG_NOTICE تعریف شده است، یک لولهٔ نام‌گذاری‌شده (named pipe) باشد.

DATATIME <seconds>

فاصله زمانی بر حسب ثانیه را میان دفعات ثبت اطلاعات داده‌ای (مشابه نرم‌افزار APC PowerChute) در فایل لاگ مشخص می‌کند.

FACILITY <log-facility>

تسهیلات (facility) ثبت وقایع سیستم (syslog) را تغییر می‌دهد. مقدار پیش‌فرض daemon است. این پارامتر در صورتی مفید است که بخواهید اطلاعات لاگ سیستم apcupsd را به جایی غیر از فایل‌های پیش‌فرض سیستم خود هدایت کنید. برای آگاهی از جزئیات سایر تسهیلات ممکن و پیکربندی عمومی ثبت وقایع سیستم، به syslog.conf(5) مراجعه کنید.

ONBATTERYDELAY <seconds>

تعداد ثانیه‌ها از زمان تشخیص قطع برق تا زمانی که apcupsd با یک رویداد onbattery واکنش نشان می‌دهد.

BATTERYLEVEL <percentage>

برنامه apcupsd در هنگام قطع برق، زمانی که شارژ باقی‌ماندهٔ باتری به زیر درصد مشخص‌شده کاهش یابد، سیستم را خاموش خواهد کرد. مقدار پیش‌فرض ۵ است.

MINUTES <minutes>

برنامه apcupsd در هنگام قطع برق، زمانی که زمان کارکرد باقی‌مانده روی باتری (که به صورت داخلی توسط یوپی‌اس محاسبه می‌شود) به کمتر از دقایق مشخص‌شده افت کند، سیستم را خاموش خواهد کرد. مقدار پیش‌فرض ۳ است.

TIMEOUT <seconds>

پس از وقوع قطع برق، apcupsd سیستم را پس از سپری شدن تعداد ثانیه‌های مشخص‌شده خاموش می‌کند. برای یک Smart-UPS، این مقدار معمولاً باید روی صفر تنظیم شود تا زمان خاموش شدن بر اساس سطح شارژ باتری یا زمان کارکرد باقی‌مانده تعیین شود (به بالا مراجعه کنید). با این حال، این دستور برای Back-UPS یا سایر یوپی‌اس‌های دارای سیگنال‌دهی ساده که سطح شارژ باتری یا زمان کارکرد باقی‌مانده را گزارش نمی‌کنند، مفید است. این دستور همچنین برای آزمایش apcupsd کاربرد دارد؛ زیرا می‌توانید با تعیین یک مقدار کم (مثلاً ۶۰) و قطع کردن برق ورودی یوپی‌اس، خاموش‌سازی سریع را اجبار کنید.

دستورالعمل‌های TIMEOUT و BATTERYLEVEL و MINUTES همگی بدون هیچ مشکلی می‌توانند هم‌زمان تنظیم شوند. برنامه apcupsd زمانی خاموش‌سازی را آغاز می‌کند که اولین مورد از این شرایط برقرار شود.

ANNOY <seconds>

فاصلهٔ زمانی بر حسب ثانیه میان پیام‌های همگانی (broadcast) ارسالی به کاربران واردشده جهت درخواست خروج از سیستم را مشخص می‌کند. این زمان‌سنج تنها زمانی شروع به کار می‌کند که یوپی‌اس روی باتری در حال اجرا باشد. مقدار پیش‌فرض ۳۰۰ ثانیه (۵ دقیقه) است.

ANNOYDELAY <seconds>

مدت زمان تأخیر بر حسب ثانیه را پیش از ارسال پیام‌های همگانی مبنی بر درخواست خروج کاربران از سیستم مشخص می‌کند. این زمان‌سنج تنها پس از آغاز کارکرد یوپی‌اس روی توان باتری شروع می‌شود. با بازگشت برق شبکه، این زمان‌سنج بازنشانی می‌گردد. مقدار پیش‌فرض ۶۰ ثانیه است (یعنی اولین درخواست خروج پس از ۶۰ ثانیه کار روی توان باتری ارسال می‌شود).

NOLOGON [ disable | timeout | percent | minutes | always ]

مشخص می‌کند که apcupsd چه زمانی باید فایل nologon را ایجاد کند تا از ورود کاربران به سیستم جلوگیری شود.

مقدار "disable" مانع از ایجاد فایل nologin توسط apcupsd می‌شود.

مقدار "timeout" زمان انتظار مشخصی را پیش از ایجاد فایل nologin توسط apcupsd تعیین می‌کند.

مقدار "percent" درصد شارژ باقی‌ماندهٔ باتری را پیش از ایجاد فایل nologin توسط apcupsd مشخص می‌سازد.

مقدار "minutes" مدت زمان کارکرد باقی‌مانده از باتری را پیش از ایجاد فایل nologin توسط apcupsd مشخص می‌کند.

مقدار "always" مشخص می‌کند که apcupsd باید بلافاصله پس از وقوع قطع برق، فایل nologin را ایجاد کند.

این دستورالعمل برای آن حائز اهمیت است که به سیستم‌های دارای یوپی‌اس‌های بزرگ اجازه دهد تا زمانی که مدیر سیستم نیاز به اخراج کاربران را تشخیص دهد، به طور عادی به کار خود ادامه دهند. همچنین به مدیر سیستم امکان می‌دهد ارسال پیام‌های هشدار ("ANNOY") را تا زمان ایجاد فایل /etc/nologin متوقف نگه دارد.

KILLDELAY <seconds>

تعداد ثانیه‌هایی را مشخص می‌کند که apcupsd پس از درخواست خاموش‌سازی، همچنان به اجرا ادامه خواهد داد. پس از زمان مشخص‌شده، apcupsd تلاش می‌کند یوپی‌اس را به حالت خواب زمستانی (hibernate) برده و جریان برق رایانه را قطع کند. این قابلیت برای استفاده در سیستم‌عامل‌هایی است که apcupsd پس از خاموش شدن سیستم نمی‌تواند برای صدور دستور apcupsd --killpower دوباره کنترل را به دست گیرد (مانند FreeBSD). تنظیم این تأخیر روی ۰ آن را غیرفعال می‌کند.

UPSCLASS [ standalone | shareslave | sharemaster ]

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

اگر از گسترش‌دهندهٔ رابط Share-UPS استفاده می‌کنید و به درگاه BASIC (سیگنال‌دهی ساده) متصل هستید، از "shareslave" استفاده کنید.

اگر از گسترش‌دهندهٔ رابط Share-UPS استفاده می‌کنید و به درگاه ADVANCED (سیگنال‌دهی هوشمند) متصل هستید، از "sharemaster" استفاده نمایید.

UPSMODE [ disable | share ]

برای عملکرد مستقل عادی این مقدار را روی "disable" تنظیم کنید تا نشان دهد پشتیبانی از گسترش‌دهندهٔ رابط Share-UPS را غیرفعال کرده‌اید.

برای بهره‌گیری از دو تا هفت درگاه سیگنال‌دهی سادهٔ اضافی روی یک گسترش‌دهندهٔ رابط Share-UPS، آن را روی "share" قرار دهید. این بخش از کد ممکن است در همهٔ نسخه‌های جدید به طور کامل آزمایش نشده باشد.

این دستورالعمل‌ها هیچ تأثیری بر عملکرد apcupsd(8) ندارند، اما برای استفاده توسط apctest(8) هنگام برنامه‌ریزی دسته‌جمعی مقادیر متغیرهای پیکربندی EEPROM یوپی‌اس در مدل‌های Smart-UPS رزرو شده‌اند.

UPSNAME <string>

نام یوپی‌اس؛ حداکثر ۸ کاراکتر.

BATTDATE [ mm/dd/yy | dd/mm/yy ]

تاریخ آخرین تعویض باتری؛ حداکثر ۸ کاراکتر.

SENSITIVITY [ H | M | L ]
  • H : بالا (حساس‌ترین تنظیم)
  • M : متوسط
  • L : پایین (کم‌حساس‌ترین تنظیم)
WAKEUP [ 000 | 060 | 180 | 300 ]

تأخیر زمانی بر حسب ثانیه که یوپی‌اس پس از بازگشت برق شبکه، پیش از «بیدار شدن» و برقراری مجدد برق تجهیزات متصل، منتظر می‌ماند.

SLEEP [ 020 | 180 | 300 | 600 ]

تأخیر زمانی بر حسب ثانیه که یوپی‌اس پس از دریافت درخواست قطع برق سیستم متصل، منتظر مانده یا اصطلاحاً به «خواب» می‌رود.

LOTRANSFER <voltage>

ولتاژ پایین خط برق که موجب انتقال به توان باتری یا فعال‌سازی SmartBoost می‌شود. مقادیر مجاز به آخرین حرف نگارش میان‌افزار (firmware) یا APCMODEL بستگی دارد. مقادیر معمول عبارت‌اند از:

D  106  103  100  097
M  177  172  168  182
A  092  090  088  086
I  208  204  200  196

که در آن D = داخلی (آمریکا)، M = کانادا، A = آسیا و I = بین‌المللی است.

HITRANSFER <voltage>

ولتاژ بالای خط برق که موجب انتقال به توان باتری یا فعال‌سازی SmartTrim می‌شود. مقادیر مجاز به آخرین حرف نگارش میان‌افزار یا APCMODEL بستگی دارد. مقادیر معمول عبارت‌اند از:

D  127  130  133  136
M  229  234  239  224
A  108  110  112  114
I  253  257  261  265

که در آن D = داخلی (آمریکا)، M = کانادا، A = آسیا و I = بین‌المللی است.

RETURNCHARGE [ 00 | 15 | 50 | 90 ]

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

BEEPSTATE [ 0 | T | L | N ]

تأخیر هشدار صوتی (بوق).

  • 0 : بدون تأخیر پس از قطع برق.
  • T : زمان قطع برق به‌علاوهٔ ۳۰ ثانیه.
  • L : هنگام وقوع وضعیت باتری ضعیف (low battery).
  • N : هرگز.
LOWBATT <minutes>

هشدار باتری ضعیف زمانی رخ می‌دهد که تعداد دقایق مشخص‌شده پیش از پایان کامل تخمینی انرژی باتری توسط یوپی‌اس باقی مانده باشد. چهار تنظیم قابل تغییر توسط کاربر وجود دارد: ۲، ۵، ۷ یا ۱۰ دقیقه.

OUTPUTVOLTS <voltage>

ولتاژ خروجی نامی یوپی‌اس هنگام کار روی باتری. مقادیر مجاز به آخرین حرف نگارش میان‌افزار یا APCMODEL بستگی دارد. مقادیر معمول عبارت‌اند از:

D  115
M  208
A  100
I  230  240  220  225

که در آن D = داخلی (آمریکا)، M = کانادا، A = آسیا و I = بین‌المللی است.

SELFTEST [ 336 | 168 | ON | OFF ]

بازهٔ زمانی آزمون خودکار (Self test) بر حسب ساعت (۳۳۶ = ۲ هفته، ۱۶۸ = ۱ هفته، ON = هنگام روشن شدن، OFF = هرگز).

توجه داشته باشید که در مثال‌های زیر فرض بر این است که شما از لینوکس استفاده می‌کنید. نام دستگاه‌ها برای درگاه‌های سریال در سیستم‌عامل‌های *BSD و سایر سیستم‌عامل‌ها متفاوت خواهد بود.

UPSCABLE usb
UPSTYPE usb
DEVICE
LOCKFILE /var/lock
UPSCLASS standalone
UPSMODE disable

توجه کنید که هیچ نام دستگاهی مشخص نشده است. برنامهٔ apcupsd(8) تمام درگاه‌های شناخته‌شدهٔ USB را امتحان خواهد کرد. تنها در صورتی یک نام دستگاه USB خاص را مشخص کنید که دقیقاً می‌دانید چه می‌کنید. برای اطلاعات تفصیلی در خصوص راه‌اندازی یک یوپی‌اس USB، به بخش "USB Configuration" در دفترچه راهنمای apcupsd مراجعه کنید.

UPSCABLE smart
UPSTYPE apcsmart
DEVICE /dev/ttyS0
LOCKFILE /var/lock
UPSCLASS standalone
UPSMODE disable

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

UPSCABLE <number of the cable used>
UPSTYPE dumb
DEVICE /dev/ttyS0
LOCKFILE /var/lock
UPSCLASS standalone
UPSMODE disable

اگر کابل شما فاقد قابلیت تشخیص باتری ضعیف است (مثلاً کابل‌های APC 940-0020B و 940-0023A از این نوع هستند)، باید دستورالعمل پیکربندی TIMEOUT <seconds> را نیز تعریف کنید تا تعداد ثانیه‌های کار روی باتری در زمان قطع برق را که پس از آن apcupsd اقدام به خاموش کردن سیستم می‌کند، تعیین نمایید.

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

/etc/apcupsd/apcupsd.conf فایل پیکربندی پیش‌فرض

syslog.conf(5), apcupsd(8), apctest(8).

کتابچه راهنمای HTML برنامه apcupsd که روی سیستم شما نصب شده است یا به صورت آنلاین در نشانی زیر در دسترس است: http://www.apcupsd.org

Trevor Roydhouse (فعلی) Andre M. Hedrick Christopher J. Reimer

January 10, 2009 apcupsd.conf v3.14.6