consadm(1m) - osol9

1consadm(1m)             System Administration Commands             consadm(1m)
2
3
4

NAME

6       consadm - select or display devices used as auxiliary console devices
7

SYNOPSIS

9       /usr/sbin/consadm
10
11
12       /usr/sbin/consadm [-a device...] [-p]
13
14
15       /usr/sbin/consadm [-d device...] [-p]
16
17
18       /usr/sbin/consadm [-p]
19
20

DESCRIPTION

22       consadm  selects the hardware device or devices to be used as auxiliary
23       console devices, or displays the current device.  Only  superusers  are
24       allowed to make or display auxiliary console device selections.
25
26
27       Auxiliary  console  devices receive copies of console messages, and can
28       be used as the console during single user  mode.  In  particular,  they
29       receive  kernel  messages  and  messages  directed  to  /dev/sysmsg. On
30       Solaris x86 based systems they can also be used  for  interaction  with
31       the bootstrap.
32
33
34       By  default, selecting a display device to be used as an auxiliary con‐
35       sole device selects that device for the duration the system remains up.
36       If  the administrator needs the selection to persist across reboots the
37       -p option can be specified.
38
39
40       consadm runs a daemon in the background, monitoring  auxiliary  console
41       devices.  Any devices that are disconnected (hang up, lose carrier) are
42       removed from the auxiliary console device list,  though  not  from  the
43       persistent  list. While auxiliary console devices may have been removed
44       from the device list receiving copies of console messages,  those  mes‐
45       sages  will  always  continue  to  be  displayed by the default console
46       device.
47
48
49       The daemon will not run if it finds there are not any auxiliary devices
50       configured  to  monitor.  Likewise, after the last auxiliary console is
51       removed, the daemon will shut itself down. Therefore  the  daemon  per‐
52       sists for only as long as auxiliary console devices remain active.
53
54
55       See  eeprom(1M)  for  instructions  on  assigning  an auxiliary console
56       device as the system console.
57

OPTIONS

59       The following options are supported:
60
61       -a device    Adds device to the  list  of  auxiliary  console  devices.
62                    Specify  device  as the path name to the device or devices
63                    to be added to the auxiliary console device list.
64
65
66       -d device    Removes device from the list of auxiliary console devices.
67                    Specify  device  as the path name to the device or devices
68                    to be removed from the auxiliary console device list.
69
70
71       -p           Prints the list of auxiliary consoles that will be  auxil‐
72                    iary across reboots.
73
74                    When  invoked with the -a or -d options , tells the appli‐
75                    cation to make the change persist across reboot.
76
77

EXAMPLES

79       Example 1 Adding to the list of devices that will receive console  mes‐
80       sages
81
82
83       The following command adds /dev/term/a to the list of devices that will
84       receive console messages.
85
86
87         example# consadm -a /dev/term/a
88
89
90
91       Example 2 Removing from the list of devices that will  receive  console
92       messages
93
94
95       The following command removes /dev/term/a from the list of devices that
96       will receive console messages. This includes removal from  the  persis‐
97       tent list.
98
99
100         example# consadm -d -p /dev/term/a
101
102
103
104       Example  3  Printing  the list of devices selected as auxiliary console
105       devices
106
107
108       The following command prints the name or names of the device or devices
109       currently selected as auxiliary console devices.
110
111
112         example# consadm
113
114
115

ENVIRONMENT VARIABLES

117       See  environ(5) for descriptions of the following environment variables
118       that affect  the  execution  of  consadm:  LC_CTYPE,  LC_MESSAGES,  and
119       NLSPATH.
120

EXIT STATUS

122       The following exit values are returned:
123
124       0     Successful completion.
125
126
127       >0    An error occurred.
128
129

ATTRIBUTES

131       See attributes(5) for descriptions of the following attributes:
132
133
134
135
136       ┌─────────────────────────────┬─────────────────────────────┐
137       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
138       ├─────────────────────────────┼─────────────────────────────┤
139       │Availability                 │SUNWcsu                      │
140       ├─────────────────────────────┼─────────────────────────────┤
141       │Stability Level              │Evolving                     │
142       └─────────────────────────────┴─────────────────────────────┘
143

NOTES

149       Auxiliary console devices are not usable for kadb or firmware  I/O,  do
150       not  receive  panic  messages,  and  do  not receive output directed to
151       /dev/console.
152
153
154       The consadm service is managed  by  the  service  management  facility,
155       smf(5), under the service identifier:
156
157         svc:/system/consadm
158
159
160
161
162       Administrative actions on this service, such as enabling, disabling, or
163       requesting restart, can be performed using  svcadm(1M).  The  service's
164       status can be queried using the svcs(1) command.
165
166
167
168SunOS 5.11                        27 Oct 2004                      consadm(1m)