2 .\" Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved
3 .\" 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.
4 .\" 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.
5 .\" 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]
6 .TH SCONADM 1M "Feb 27, 2006"
8 sconadm \- register system information
12 \fB/usr/sbin/sconadm\fR register \fB-a\fR
13 [\fB-e\fR softwareUpdate | \fB-E\fR softwareUpdate]
14 [\fB-h\fR \fIhostname\fR] [\fB-l\fR \fIlogfile\fR] [\fB-N\fR]
15 [\fB-p\fR \fIproxy_host\fR[:\fIproxy_port\fR]]
16 [\fB-r\fR \fIregistration_profile\fR] [\fB-u\fR \fIusername\fR]
17 [\fB-x\fR \fIproxy_username\fR]
22 \fB/usr/sbin/sconadm\fR proxy [\fB-l\fR \fIlogfile\fR]
23 [\fB-p\fR \fIproxy_host\fR[:\fIproxy_port\fR]]
24 [\fB-r\fR \fIregistration_profile\fR] [\fB-x\fR \fIproxy_username\fR]
30 The \fBsconadm\fR utility is a command-line version of the Basic Registration
31 GUI. In the first form of the command in the SYNOPSIS, \fBsconadm\fR uses the
32 \fBregister\fR subcommand to register a host with a registration server. In the
33 second form, \fBsconadm\fR uses the \fBproxy\fR subcommand to configure all of
34 the components for software update to use an HTTP web proxy.
37 The parameters specified with \fB-u\fR, \fB-e\fR (or \fB-E\fR), \fB-h\fR,
38 \fB-p\fR, and \fB-x\fR override values specified in your registration profile.
39 A template for this profile, owned by root, with read-only permissions, is
40 stored in \fB/usr/lib/breg/data/RegistrationProfile.properties\fR. See
41 \fBregistration_profile\fR(4).
44 For the \fBproxy\fR subcommand, the proxy password is stored in the
45 \fBRegistrationProfile.properties\fR file, available if proxy authentication is
46 needed. Storage in the profile prevents proxy passwords from being exposed as
47 part of a listing of processes on a system.
51 The following options are supported:
58 Accept "Terms of Use and Binary Code License". Absence of this option means
59 that you do not accept the license.
65 \fB\fB-e\fR softwareUpdate\fR
68 Enable client to be managed at the Sun-hosted Update Connection Service.
74 \fB\fB-E\fR softwareUpdate\fR
77 Disable client's ability to be managed at the Sun-hosted Update Connection
84 \fB\fB-h\fR \fIhostname\fR\fR
87 Hostname of the machine you want to register.
93 \fB\fB-l\fR \fIlogfile\fR\fR
111 \fB\fB-p\fR \fIproxy_host\fR[:\fIproxy_port\fR]\fR
114 Proxy host name and optional proxy port number.
120 \fB\fB-r\fR \fIregistration_profile\fR\fR
123 Pathname to a registration profile.
129 \fB\fB-u\fR \fIusername\fR\fR
132 User name (a Sun Online Account).
138 \fB\fB-x\fR \fIproxy_username\fR\fR
141 User name on the proxy host.
147 Unless specified otherwise, the commands below require root privileges or
148 privileges equivalent to root. See \fBprivileges\fR(5).
150 \fBExample 1 \fRRegistering a New System
153 Assume a file \fBregistrationprofile.properties\fR in \fB/tmp\fR that contains
159 userName=\fIuser123\fR
160 password=\fIabc123\fR
173 To register a new system using the profile above, you enter:
178 \fB/usr/sbin/sconadm register -a -r /tmp/registrationprofile.properties\fR
184 \fBExample 2 \fRReregistering a System with a Different User
187 Assume a file \fBregistrationprofile.properties\fR in \fB/tmp\fR with the
188 contents shown below. Note the changed specification for \fBuserName\fR and
194 userName=\fInewuser\fR
195 password=\fInewpassword\fR
208 To reregister a new system using the profile above, you enter the same command
209 you entered to register the system:
214 \fB/usr/sbin/sconadm register -a -r /tmp/registrationprofile.properties\fR
220 \fBExample 3 \fRReregistering a System, Adding a Sun Subscription Key
223 Modify \fBregistrationprofile.properties\fR as follows:
228 userName=\fInewuser\fR
229 password=\fInewpassword\fR
231 subscriptionKey=\fIabc12345678\fR
247 \fB/usr/sbin/sconadm register -a -r /tmp/registrationprofile.properties\fR
253 \fBExample 4 \fRReregistering and Enabling Access to all Update Connection
257 Modify \fBregistrationprofile.properties\fR as follows:
262 userName=\fInewuser\fR
263 password=\fInewpassword\fR
265 subscriptionKey=\fIabc12345678\fR
276 Note that \fBportalEnabled\fR is set to \fBfalse\fR. Run the command:
281 \fB/usr/sbin/sconadm register -a -r /tmp/registrationprofile.properties \e
288 \fBExample 5 \fRNever Registering
291 To never register a system, enter:
296 \fB/usr/sbin/sconadm register -N\fR
302 \fBExample 6 \fRUsing a Proxy Server With Proxy Authentication
305 Edit \fBregistrationprofile.properties\fR as follows:
315 proxyHostName=webcache.mycompany.com
317 proxyUserName=\fImyCompanyProxyUserName\fR
318 proxyPassword=\fImyCompanyProxyPassword\fR
329 \fB/usr/sbin/sconadm proxy -r /tmp/registrationprofile.properties\fR
335 \fBExample 7 \fRChanging Proxy Host Settings
338 Edit \fBregistrationprofile.properties\fR as follows:
348 proxyHostName=webcache.mycompany.com
350 proxyUserName=\fImyCompanyProxyUserName\fR
351 proxyPassword=\fImyCompanyProxyPassword\fR
362 \fB/usr/sbin/sconadm proxy -r /tmp/registrationprofile.properties\fR
369 Then, change the \fBproxyHostName\fR value by running the following command:
374 \fB/usr/sbin/sconadm proxy -r /tmp/registrationprofile.properties \e
375 -p newproxy.mycompany.com\fR
382 After the preceding command all proxies use \fBnewproxy.mycompany.com\fR.
385 \fBExample 8 \fRResetting a System Not to Use a Proxy
388 Edit \fBregistrationprofile.properties\fR as follows:
407 Note that values for all proxy fields are null.
416 \fB/usr/sbin/sconadm proxy -r /tmp/registrationprofile.properties\fR
444 \fB\fB/usr/lib/breg/data/RegistrationProfile.properties\fR\fR
448 Registration profile template.
454 See \fBattributes\fR(5) for descriptions of the following attributes:
462 ATTRIBUTE TYPE ATTRIBUTE VALUE
464 Interface Stability Stable
470 \fBregistration_profile\fR(4), \fBattributes\fR(5), \fBprivileges\fR(5)