ups.update

Update UPS Service Configuration.

powerdown when enabled, sets UPS to power off after shutting down the system.

nocommwarntime is a value in seconds which makes UPS Service wait the specified seconds before alerting that the Service cannot reach configured UPS.

shutdowntimer is a value in seconds which tells the Service to wait specified seconds for the UPS before initiating a shutdown. This only applies when shutdown is set to “BATT”.

shutdowncmd is the command which is executed to initiate a shutdown. It defaults to “poweroff”.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: ups_update

ups_update

Type: object

UPSUpdateArgs parameters.

 No Additional Properties

Powerdown

Type: boolean

Whether the UPS should power down after completing the shutdown sequence.

Rmonitor

Type: boolean

Whether to enable remote monitoring of the UPS status over the network.

Nocommwarntime


Seconds to wait before warning about communication loss with UPS. null for default.

Type: integer
Type: null

Remoteport

Type: integer

Network port for communicating with remote UPS monitoring systems.

Value must be greater or equal to 1 and lesser or equal to 65535

Shutdowntimer

Type: integer

Seconds to wait after initiating shutdown before forcing power off.

Hostsync

Type: integer

Maximum seconds to wait for other systems to shutdown before continuing.

Value must be greater or equal to 0

Description

Type: string

Human-readable description of this UPS configuration.

Driver

Type: string

UPS driver name that handles communication with the specific UPS hardware model.

Extrausers

Type: string

Additional user configurations for UPS monitoring access.

Identifier

Type: string

Unique identifier name for this UPS device within the monitoring system.

Must be at least 1 characters long

Mode

Type: enum (of string)

Operating mode.
* MASTER controls the UPS directly
* SLAVE monitors remotely

Must be one of:
  • "MASTER"
  • "SLAVE"

Monpwd

Type: string

Password for UPS monitoring authentication (required for updates).

Must be at least 1 characters long

Monuser

Type: string

Username for UPS monitoring authentication.

Must be at least 1 characters long

Options

Type: string

Additional configuration options passed to the UPS driver.

Optionsupsd

Type: string

Additional configuration options for the UPS daemon.

Port

Type: string

Serial port or device path for UPS communication.

Remotehost

Type: string

Hostname or IP address of remote UPS server when operating in SLAVE mode.

Shutdown

Type: enum (of string)

Shutdown trigger condition: LOWBATT on low battery, BATT when on battery power.

Must be one of:
  • "LOWBATT"
  • "BATT"

Shutdowncmd


Custom command to execute during UPS shutdown sequence. null for default.

Type: string
Type: null

UPSEntry

Type: object

The updated UPS configuration.

 No Additional Properties

Powerdown

Type: boolean

Whether the UPS should power down after completing the shutdown sequence.

Rmonitor

Type: boolean

Whether to enable remote monitoring of the UPS status over the network.

Id

Type: integer

Unique identifier for the UPS configuration.

Nocommwarntime


Seconds to wait before warning about communication loss with UPS. null for default.

Type: integer
Type: null

Remoteport

Type: integer

Network port for communicating with remote UPS monitoring systems.

Value must be greater or equal to 1 and lesser or equal to 65535

Shutdowntimer

Type: integer

Seconds to wait after initiating shutdown before forcing power off.

Hostsync

Type: integer

Maximum seconds to wait for other systems to shutdown before continuing.

Value must be greater or equal to 0

Description

Type: string

Human-readable description of this UPS configuration.

Driver

Type: string

UPS driver name that handles communication with the specific UPS hardware model.

Extrausers

Type: string

Additional user configurations for UPS monitoring access.

Identifier

Type: string

Unique identifier name for this UPS device within the monitoring system.

Must be at least 1 characters long

Mode

Type: enum (of string)

Operating mode.
* MASTER controls the UPS directly
* SLAVE monitors remotely

Must be one of:
  • "MASTER"
  • "SLAVE"

Monpwd

Type: string

Password for UPS monitoring authentication.

Monuser

Type: string

Username for UPS monitoring authentication.

Must be at least 1 characters long

Options

Type: string

Additional configuration options passed to the UPS driver.

Optionsupsd

Type: string

Additional configuration options for the UPS daemon.

Port

Type: string

Serial port or device path for UPS communication.

Remotehost

Type: string

Hostname or IP address of remote UPS server when operating in SLAVE mode.

Shutdown

Type: enum (of string)

Shutdown trigger condition: LOWBATT on low battery, BATT when on battery power.

Must be one of:
  • "LOWBATT"
  • "BATT"

Shutdowncmd


Custom command to execute during UPS shutdown sequence. null for default.

Type: string
Type: null

Complete Identifier

Type: string

Complete UPS identifier including hostname for network monitoring.


Required roles: SYSTEM_GENERAL_WRITE