xref: /illumos-gate/usr/src/man/man8/pmconfig.8 (revision dd72704bd9e794056c558153663c739e2012d721)
te
Copyright (c) 2017 Peter Tribble
Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
PMCONFIG 8 "May 1, 2017"
NAME
pmconfig - Configure the Power Management system
SYNOPSIS

/usr/sbin/pmconfig [-r]
DESCRIPTION

The pmconfig utility sets the Power Management and suspend-resume configuration. User has permission to change Power Management configuration using pmconfig only if he is allowed to do so according to PMCHANGEPERM keyword of /etc/default/power. User has permission to change the suspend-resume configuration using pmconfig only if he is allowed to do so according to the CPRCHANGEPERM keyword of /etc/default/power. See FILES section below for a description of the PMCHANGEPERM and CPRCHANGEPERM keywords of /etc/default/power.

Based on user permissions, pmconfig first resets the Power Management and/or suspend-resume state back to its default and then reads the new Power Management and/or suspend-resume configuration from /etc/power.conf and issues the commands to activate the new configuration. The pmconfig utility is run at system boot. This utility can also be run from the command line after manual changes have been made to the /etc/power.conf file. For changes made to the /etc/power.conf file to take effect, users must run pmconfig.

OPTIONS

The following options are supported: -r

Reset Power Management and suspend-resume state to default and exit. User must have both Power Management and suspend-resume configuration permission for this option.

EXIT STATUS

The following exit values are returned: 0

Upon successful completion

>0

An error occurred

FILES
/etc/power.conf

System Power Management configuration file.

/etc/default/power

File that controls permissions for system's Power Management and suspend-resume features. The PMCHANGEPERM keyboard controls the Power Management configuration permissions, while the CPRCHANGEPERM keyword controls the suspend-resume configuration permissions.

Allowed values are: all

Any user can change the configuration.

-

No one except super-user can change the configuration.

<user1, user2,...>

A user in this user list or a super-user can change the configuration. The user list is a space and/or comma (,) separated list. You must enclose the list in < and > characters.

console-owner

A user who owns the system console device node or a super-user can change the configuration.

The default values are PMCHANGEPERM=console-owner and CPRCHANGEPERM=console-owner.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Unstable
SEE ALSO

svcs (1), cpr (4), pm (4D), power.conf (5), attributes (7), smf (7), powerd (8), svcadm (8)

Using Power Management

NOTES

The pmconfig service is managed by the service management facility, smf(7), under the service identifier:

svc:/system/power:default

Administrative actions on this service, such as enabling, disabling, or requesting restart, can be performed using svcadm(8). The service's status can be queried using the svcs(1) command.

DIAGNOSTICS

If the program cannot open the configuration file, it prints an error message to standard error. If the program encounters a syntax error in the configuration file, it prints an error message and the line number of the error in the configuration file. It then skips the rest of the information on that line and processes the next line. Any configuration information already processed on the line containing the error is used. If user does not have permission to change Power Management and/or suspend-resume configuration, and configuration file has entries for which user doesn't have permission, it process the entries for which user has permissions and prints error on rest.