Skip to main content

FreeBSD에서 apcupsd 설정

apcupsd는 APC UPS의 정보를 읽어, 정전시 UPS에 연결된 컴퓨터의 동작을 지시하는 데몬입니다. 
서버와 같이 UPS에 연결되어 있는 OS에서는 반드시 설치해야 합니다. 

상황

APC UPS에 AP9631 Network Management Card가 설치되어 있는 상황입니다. 
UPS 자체에는 USB나 시리얼 케이블로 컴퓨터와 연결되어 있지 않습니다. 

네트워크 카드의 자체 설정은 이미 되어 있는 것으로 간주합니다. 

과정

딱 필요한 내용만 기록하겠습니다. 

sudo pkg update
sudo pkg install apcupsd

설치가 끝나면 /usr/local/etc/apcupsd/apcupsd.conf 파일을 수정해야 합니다.

sudo nano /usr/local/etc/apcupsd/apcupsd.conf

다음 항목을 변경합니다. 

# 로그 파일에 기록될 이름입니다.
UPSNAME APCUPS  
# SNMP 신호를 받을때 이렇게 변경합니다.
UPSCABLE ether
# SNMP 모드로 작동하도록 합니다.
UPSTYPE snmp
# UPS의 카드가 등록된 IP 주소를 입력하세요. 기본 포트는 161번이며 기본 벤더는 apc, 커뮤니티는 public 입니다
DEVICE 192.168.0.255:161:apc:public  
# 장치 상태를 확인하기 위한 서버를 켭니다.
NETSERVER on
# 0.0.0.0 으로 해도 되나 localhost로 넣습니다.
NISIP 127.0.0.1
# NIS 포트는 기본값이 3551입니다.
NISPORT 3551
# UPS에 여러 장치가 연결되어 있는 경우 반드시 변경합니다.
UPSCLASS shareslave
# 아래와 같이 둡니다.
UPSMODE disable

여기까지 했으면 이제 서비스를 설정하거나 /etc/rc.conf를 수정합니다. 

sudo service apcupsd enable 
sudo service apcupsd start
           or 
sudo sysrc apcupsd_enable="YES"
sudo shutdown -r now 
# 재부팅...

이제 확인을 위해 apcaccess 명령으로 NIS에 접속합니다. 

$ apcaccess
APC      : 001,044,1028
DATE     : 2024-01-17 22:17:59 +0900
HOSTNAME : blurblur
VERSION  : 3.14.14 (31 May 2016) freebsd
UPSNAME  : APCUPS                           # 아까 설정한 이름으로 뜹니다.
CABLE    : Ethernet Link
DRIVER   : SNMP UPS Driver
UPSMODE  : ShareUPS Slave
STARTTIME: 2024-01-17 22:17:57 +0900
MODEL    : Smart-UPS 1500                   # 장치 자체의 모델명이 보입니다.
STATUS   : ONLINE                           # 반드시 ONLINE으로 표시되어야 합니다.
LINEV    : 205.0 Volts
LOADPCT  : 24.0 Percent
BCHARGE  : 100.0 Percent
TIMELEFT : 52.0 Minutes
MBATTCHG : 5 Percent
MINTIMEL : 3 Minutes
MAXTIME  : 0 Seconds
MAXLINEV : 205.0 Volts
MINLINEV : 204.0 Volts
OUTPUTV  : 205.0 Volts
SENSE    : High
DWAKE    : 1000 Seconds
DSHUTD   : 20 Seconds
DLOWBATT : 5 Minutes
LOTRANS  : 195.0 Volts
HITRANS  : 265.0 Volts
ITEMP    : 23.0 C
ALARMDEL : 30 Seconds
BATTV    : 27.0 Volts
LINEFREQ : 59.0 Hz
LASTXFER : No transfers since turnon
NUMXFERS : 0
TONBATT  : 0 Seconds
CUMONBATT: 0 Seconds
XOFFBATT : N/A
SELFTEST : OK
STESTI   : OFF
STATFLAG : 0x05000008
MANDATE  : 09/12/2019
SERIALNO : 3S1937X12596
BATTDATE : 12/15/2019
NOMOUTV  : 230 Volts
FIRMWARE : UPS 09.3 (ID18)
END APC  : 2024-01-17 22:18:20 +0900

apcupsd.conf 한글번역

원본 apcupsd.conf 파일을 한글로 번역해 두었습니다. 

## apcupsd.conf v1.1 ##
# 
#  for apcupsd release 3.14.14 (31 May 2016) - freebsd
#
# "apcupsd" POSIX config file

#
# 이 구성 파일의 변경 사항을 적용하려면 apcupsd 디먼을 다시 시작해야 합니다.
# 이 구성 파일을 활성화해야 합니다.
#

#
# ========= 일반 구성 매개 변수 ============
#

# UPSNAME xxx
#   이를 사용하여 로그 파일 등에 UPS 이름을 지정할 수 있습니다. 
#   여러 대의 UPS가 있는 경우 특히 유용합니다. 
#   이것은 EEPROM을 설정하지 않습니다. 8자 이내여야 합니다.
UPSNAME FOO

# UPSCABLE <cable>
#   UPS를 컴퓨터에 연결하는 케이블 유형을 정의합니다.
#
#   <cable>에 대해 가능한 일반적인 선택은 다음과 같습니다:
#     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, M-04-02-2000
#
UPSCABLE ether

# apcupsd가 작동하도록 하려면 위의 케이블을 정의하는 것 외에도 보유하고 있는
# UPS 유형에 해당하는 UPSTYPE도 정의해야 합니다(자세한 내용은 설명 참조).
# 또한 포트라고도 하는 DEVICE도 지정해야 합니다.
# USB UPS의 경우 DEVICE 지시어를 비워 두세요. 
# 다른 UPS 유형의 경우 적절한 포트 또는 주소를 지정해야 합니다.
#
# UPSTYPE   DEVICE           Description
# apcsmart  /dev/tty**       직렬 케이블(USB가 아닌)을 사용하는 스마트업 모델에  
#                            적합한 최신 직렬 문자 장치입니다.
#
# usb       <BLANK>          대부분의 새 UPS는 USB입니다.
#                            장치 설정을 비워두면 자동 감지가 가능하므로 대부분의 
#                            설치에 가장 적합한 선택입니다.
#
# net       hostname:port    apcupsd의 네트워크 정보 서버를 통해 마스터 
#                            apcupsd에 대한 네트워크 링크. 컴퓨터에 전원을 공급하는
#                            UPS가 모니터링을 위해 다른 컴퓨터에 연결되어 있는 
#                            경우에 사용됩니다.
#
# snmp      hostname:port:vendor:community
#                            SNMP 지원 UPS 장치에 대한 SNMP 네트워크 링크입니다.
#                            hostname은 네트워크에 있는 UPS의 IP 주소 또는 호스트 이름입니다. 
#                            vendor는 "APC" 또는 "APC_NOTRAP"일 수 있습니다. 
#                            "APC_NOTRAP"은 SNMP 트랩 수집을 비활성화하므로 
#                            일반적으로 "APC"를 사용합니다. 포트는 보통 161입니다. 
#                            커뮤니티는 보통 "private"입니다.
#
# netsnmp   hostname:port:vendor:community
#                            OBSOLETE
#                            위의 SNMP와 동일하지만 net-snmp 라이브러리를 사용해야 합니다. 
#                            이 이전 드라이버가 특별히 필요한 경우가 아니라면 대신 
#                            'snmp'를 사용하는 것이 좋습니다.
#
# dumb      /dev/tty**       simple-signaling UPS와 함께 사용하기 위한 
#                            구형 직렬 문자 장치입니다.
#
# pcnet     ipaddr:username:passphrase:port
#                            AP9617 스마트 슬롯 카드 제품군에서 SNMP의 대안으로
#                            사용할 수 있는 PowerChute 네트워크 종료 프로토콜입니다. 
#                            password는 카드가 구성된 자격 증명입니다. port는 UPS에서
#                            메시지를 수신할 포트 번호(일반적으로 3052)입니다. 이 매개변수가 
#                            비어 있거나 누락된 경우 기본값인 3052가 사용됩니다.
#
# modbus    /dev/tty**       MODBUS 프로토콜을 지원하는 최신 SmartUPS
#                            모델과 함께 사용할 수 있는 직렬 장치입니다.
# modbus    <BLANK>          MODBUS over USB의 경우 장치 설정을 비워 두거나
#                            UPS의 일련 번호로 설정하여 apcupsd가 특정 장치에 
#                            바인딩되도록 합니다(USB UPS가 두 개 이상인 경우 유용함).
#
UPSTYPE snmp
DEVICE IP:PORT:APC:PRIVATE

# POLLTIME <int>
#   Interval (in seconds) at which apcupsd polls the UPS for status. This
#   setting applies both to directly-attached UPSes (UPSTYPE apcsmart, usb, 
#   dumb) and networked UPSes (UPSTYPE net, snmp). Lowering this setting
#   will improve apcupsd's responsiveness to certain events at the cost of
#   higher CPU utilization. The default of 60 is appropriate for most
#   situations.
#POLLTIME 60

# LOCKFILE <path to lockfile>
#   Path for device lock file. This is the directory into which the lock file
#   will be written. The directory must already exist; apcupsd will not create
#   it. The actual name of the lock file is computed from DEVICE.
#   Not used on Win32.
LOCKFILE /var/spool/lock

# SCRIPTDIR <path to script directory>
#   Directory in which apccontrol and event scripts are located.
SCRIPTDIR /usr/local/etc/apcupsd

# PWRFAILDIR <path to powerfail directory>
#   Directory in which to write the powerfail flag file. This file
#   is created when apcupsd initiates a system shutdown and is
#   checked in the OS halt scripts to determine if a killpower
#   (turning off UPS output power) is required.
PWRFAILDIR /var/run

# NOLOGINDIR <path to nologin directory>
#   Directory in which to write the nologin file. The existence
#   of this flag file tells the OS to disallow new logins.
NOLOGINDIR /var/run


#
# ======== Configuration parameters used during power failures ==========
#

# The ONBATTERYDELAY is the time in seconds from when a power failure
#   is detected until we react to it with an onbattery event.
#
#   This means that, apccontrol will be called with the powerout argument
#   immediately when a power failure is detected.  However, the
#   onbattery argument is passed to apccontrol only after the 
#   ONBATTERYDELAY time.  If you don't want to be annoyed by short
#   powerfailures, make sure that apccontrol powerout does nothing
#   i.e. comment out the wall.
ONBATTERYDELAY 6

# 
# Note: BATTERYLEVEL, MINUTES, and TIMEOUT work in conjunction, so
# the first that occurs will cause the initation of a shutdown.
#

# If during a power failure, the remaining battery percentage
# (as reported by the UPS) is below or equal to BATTERYLEVEL, 
# apcupsd will initiate a system shutdown.
BATTERYLEVEL 5

# If during a power failure, the remaining runtime in minutes 
# (as calculated internally by the UPS) is below or equal to MINUTES,
# apcupsd, will initiate a system shutdown.
MINUTES 3

# If during a power failure, the UPS has run on batteries for TIMEOUT
# many seconds or longer, apcupsd will initiate a system shutdown.
# A value of 0 disables this timer.
#
#  Note, if you have a Smart UPS, you will most likely want to disable
#    this timer by setting it to zero. That way, you UPS will continue
#    on batteries until either the % charge remaing drops to or below BATTERYLEVEL,
#    or the remaining battery runtime drops to or below MINUTES.  Of course,
#    if you are testing, setting this to 60 causes a quick system shutdown
#    if you pull the power plug.   
#  If you have an older dumb UPS, you will want to set this to less than
#    the time you know you can run on batteries.
TIMEOUT 0

#  Time in seconds between annoying users to signoff prior to
#  system shutdown. 0 disables.
ANNOY 300

# Initial delay after power failure before warning users to get
# off the system.
ANNOYDELAY 60

# The condition which determines when users are prevented from
# logging in during a power failure.
# NOLOGON <string> [ disable | timeout | percent | minutes | always ]
NOLOGON disable

# If KILLDELAY is non-zero, apcupsd will continue running after a
# shutdown has been requested, and after the specified time in
# seconds attempt to kill the power. This is for use on systems
# where apcupsd cannot regain control after a shutdown.
# KILLDELAY <seconds>  0 disables
KILLDELAY 0

#
# ==== Configuration statements for Network Information Server ====
#

# NETSERVER [ on | off ] on enables, off disables the network
#  information server. If netstatus is on, a network information
#  server process will be started for serving the STATUS and
#  EVENT data over the network (used by CGI programs).
NETSERVER on

# NISIP <dotted notation ip address>
#  IP address on which NIS server will listen for incoming connections.
#  This is useful if your server is multi-homed (has more than one
#  network interface and IP address). Default value is 0.0.0.0 which
#  means any incoming request will be serviced. Alternatively, you can
#  configure this setting to any specific IP address of your server and 
#  NIS will listen for connections only on that interface. Use the
#  loopback address (127.0.0.1) to accept connections only from the
#  local machine.
NISIP 0.0.0.0

# NISPORT <port> default is 3551 as registered with the IANA
#  port to use for sending STATUS and EVENTS data over the network.
#  It is not used unless NETSERVER is on. If you change this port,
#  you will need to change the corresponding value in the cgi directory
#  and rebuild the cgi programs.
NISPORT 3551

# If you want the last few EVENTS to be available over the network
# by the network information server, you must define an EVENTSFILE.
EVENTSFILE /var/log/apcupsd.events

# EVENTSFILEMAX <kilobytes>
#  By default, the size of the EVENTSFILE will be not be allowed to exceed
#  10 kilobytes.  When the file grows beyond this limit, older EVENTS will
#  be removed from the beginning of the file (first in first out).  The
#  parameter EVENTSFILEMAX can be set to a different kilobyte value, or set
#  to zero to allow the EVENTSFILE to grow without limit.
EVENTSFILEMAX 10

#
# ========== Configuration statements used if sharing =============
#            a UPS with more than one machine

#
# Remaining items are for ShareUPS (APC expansion card) ONLY
#

# UPSCLASS [ standalone | shareslave | sharemaster ]
#   Normally standalone unless you share an UPS using an APC ShareUPS
#   card.
UPSCLASS shareslave

# UPSMODE [ disable | share ]
#   Normally disable unless you share an UPS using an APC ShareUPS card.
UPSMODE disable

#
# ===== Configuration statements to control apcupsd system logging ========
#

# Time interval in seconds between writing the STATUS file; 0 disables
STATTIME 0

# Location of STATUS file (written to only if STATTIME is non-zero)
STATFILE /var/log/apcupsd.status

# LOGSTATS [ on | off ] on enables, off disables
# Note! This generates a lot of output, so if         
#       you turn this on, be sure that the
#       file defined in syslog.conf for LOG_NOTICE is a named pipe.
#  You probably do not want this on.
LOGSTATS off

# Time interval in seconds between writing the DATA records to
#   the log file. 0 disables.
DATATIME 0

# FACILITY defines the logging facility (class) for logging to syslog. 
#          If not specified, it defaults to "daemon". This is useful 
#          if you want to separate the data logged by apcupsd from other
#          programs.
#FACILITY DAEMON

#
# ========== Configuration statements used in updating the UPS EPROM =========
#

#
# These statements are used only by apctest when choosing "Set EEPROM with conf
# file values" from the EEPROM menu. THESE STATEMENTS HAVE NO EFFECT ON APCUPSD.
#

# UPS name, max 8 characters 
#UPSNAME UPS_IDEN

# Battery date - 8 characters
#BATTDATE mm/dd/yy

# Sensitivity to line voltage quality (H cause faster transfer to batteries)  
# SENSITIVITY H M L        (default = H)
#SENSITIVITY H

# UPS delay after power return (seconds)
# WAKEUP 000 060 180 300   (default = 0)
#WAKEUP 60

# UPS Grace period after request to power off (seconds)
# SLEEP 020 180 300 600    (default = 20)
#SLEEP 180

# Low line voltage causing transfer to batteries
# The permitted values depend on your model as defined by last letter 
#  of FIRMWARE or APCMODEL. Some representative values are:
#    D 106 103 100 097
#    M 177 172 168 182
#    A 092 090 088 086
#    I 208 204 200 196     (default = 0 => not valid)
#LOTRANSFER  208

# High line voltage causing transfer to batteries
# The permitted values depend on your model as defined by last letter 
#  of FIRMWARE or APCMODEL. Some representative values are:
#    D 127 130 133 136
#    M 229 234 239 224
#    A 108 110 112 114
#    I 253 257 261 265     (default = 0 => not valid)
#HITRANSFER 253

# Battery charge needed to restore power
# RETURNCHARGE 00 15 50 90 (default = 15)
#RETURNCHARGE 15

# Alarm delay 
# 0 = zero delay after pwr fail, T = power fail + 30 sec, L = low battery, N = never
# BEEPSTATE 0 T L N        (default = 0)
#BEEPSTATE T

# Low battery warning delay in minutes
# LOWBATT 02 05 07 10      (default = 02)
#LOWBATT 2

# UPS Output voltage when running on batteries
# The permitted values depend on your model as defined by last letter 
#  of FIRMWARE or APCMODEL. Some representative values are:
#    D 115
#    M 208
#    A 100
#    I 230 240 220 225     (default = 0 => not valid)
#OUTPUTVOLTS 230

# Self test interval in hours 336=2 weeks, 168=1 week, ON=at power on
# SELFTEST 336 168 ON OFF  (default = 336)
#SELFTEST 336