usr/src/man/man1m/sconadm.1m

   1 '\" te
   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"
   7 .SH NAME
   8 sconadm \- register system information
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  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]
  18 .fi
  19
  20 .LP
  21 .nf
  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]
  25 .fi
  26
  27 .SH DESCRIPTION
  28 .sp
  29 .LP
  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.
  35 .sp
  36 .LP
  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).
  42 .sp
  43 .LP
  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.
  48 .SH OPTIONS
  49 .sp
  50 .LP
  51 The following options are supported:
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fB-a\fR\fR
  56 .ad
  57 .RS 30n
  58 Accept "Terms of Use and Binary Code License". Absence of this option means
  59 that you do not accept the license.
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fB-e\fR softwareUpdate\fR
  66 .ad
  67 .RS 30n
  68 Enable client to be managed at the Sun-hosted Update Connection Service.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fB-E\fR softwareUpdate\fR
  75 .ad
  76 .RS 30n
  77 Disable client's ability to be managed at the Sun-hosted Update Connection
  78 Service.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fB-h\fR \fIhostname\fR\fR
  85 .ad
  86 .RS 30n
  87 Hostname of the machine you want to register.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fB-l\fR \fIlogfile\fR\fR
  94 .ad
  95 .RS 30n
  96 Pathname of log file.
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fB-N\fR\fR
 103 .ad
 104 .RS 30n
 105 Never register.
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fB-p\fR \fIproxy_host\fR[:\fIproxy_port\fR]\fR
 112 .ad
 113 .RS 30n
 114 Proxy host name and optional proxy port number.
 115 .RE
 116
 117 .sp
 118 .ne 2
 119 .na
 120 \fB\fB-r\fR \fIregistration_profile\fR\fR
 121 .ad
 122 .RS 30n
 123 Pathname to a registration profile.
 124 .RE
 125
 126 .sp
 127 .ne 2
 128 .na
 129 \fB\fB-u\fR \fIusername\fR\fR
 130 .ad
 131 .RS 30n
 132 User name (a Sun Online Account).
 133 .RE
 134
 135 .sp
 136 .ne 2
 137 .na
 138 \fB\fB-x\fR \fIproxy_username\fR\fR
 139 .ad
 140 .RS 30n
 141 User name on the proxy host.
 142 .RE
 143
 144 .SH EXAMPLES
 145 .sp
 146 .LP
 147 Unless specified otherwise, the commands below require root privileges or
 148 privileges equivalent to root. See \fBprivileges\fR(5).
 149 .LP
 150 \fBExample 1 \fRRegistering a New System
 151 .sp
 152 .LP
 153 Assume a file \fBregistrationprofile.properties\fR in \fB/tmp\fR that contains
 154 the following:
 155
 156 .sp
 157 .in +2
 158 .nf
 159 userName=\fIuser123\fR
 160 password=\fIabc123\fR
 161 hostName=
 162 subscriptionKey=
 163 portalEnabled=false
 164 proxyHostName=
 165 proxyPort=
 166 proxyUserName=
 167 proxyPassword=
 168 .fi
 169 .in -2
 170
 171 .sp
 172 .LP
 173 To register a new system using the profile above, you enter:
 174
 175 .sp
 176 .in +2
 177 .nf
 178 \fB/usr/sbin/sconadm register -a -r /tmp/registrationprofile.properties\fR
 179 .fi
 180 .in -2
 181 .sp
 182
 183 .LP
 184 \fBExample 2 \fRReregistering a System with a Different User
 185 .sp
 186 .LP
 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
 189 \fBpassword\fR.
 190
 191 .sp
 192 .in +2
 193 .nf
 194 userName=\fInewuser\fR
 195 password=\fInewpassword\fR
 196 hostName=
 197 subscriptionKey=
 198 portalEnabled=false
 199 proxyHostName=
 200 proxyPort=
 201 proxyUserName=
 202 proxyPassword=
 203 .fi
 204 .in -2
 205
 206 .sp
 207 .LP
 208 To reregister a new system using the profile above, you enter the same command
 209 you entered to register the system:
 210
 211 .sp
 212 .in +2
 213 .nf
 214 \fB/usr/sbin/sconadm register -a -r /tmp/registrationprofile.properties\fR
 215 .fi
 216 .in -2
 217 .sp
 218
 219 .LP
 220 \fBExample 3 \fRReregistering a System, Adding a Sun Subscription Key
 221 .sp
 222 .LP
 223 Modify \fBregistrationprofile.properties\fR as follows:
 224
 225 .sp
 226 .in +2
 227 .nf
 228 userName=\fInewuser\fR
 229 password=\fInewpassword\fR
 230 hostName=
 231 subscriptionKey=\fIabc12345678\fR
 232 portalEnabled=false
 233 proxyHostName=
 234 proxyPort=
 235 proxyUserName=
 236 proxyPassword=
 237 .fi
 238 .in -2
 239
 240 .sp
 241 .LP
 242 Run the command:
 243
 244 .sp
 245 .in +2
 246 .nf
 247 \fB/usr/sbin/sconadm register -a -r /tmp/registrationprofile.properties\fR
 248 .fi
 249 .in -2
 250 .sp
 251
 252 .LP
 253 \fBExample 4 \fRReregistering and Enabling Access to all Update Connection
 254 Services
 255 .sp
 256 .LP
 257 Modify \fBregistrationprofile.properties\fR as follows:
 258
 259 .sp
 260 .in +2
 261 .nf
 262 userName=\fInewuser\fR
 263 password=\fInewpassword\fR
 264 hostName=
 265 subscriptionKey=\fIabc12345678\fR
 266 portalEnabled=false
 267 proxyHostName=
 268 proxyPort=
 269 proxyUserName=
 270 proxyPassword=
 271 .fi
 272 .in -2
 273
 274 .sp
 275 .LP
 276 Note that \fBportalEnabled\fR is set to \fBfalse\fR. Run the command:
 277
 278 .sp
 279 .in +2
 280 .nf
 281 \fB/usr/sbin/sconadm register -a -r /tmp/registrationprofile.properties \e
 282 -e softwareUpdate\fR
 283 .fi
 284 .in -2
 285 .sp
 286
 287 .LP
 288 \fBExample 5 \fRNever Registering
 289 .sp
 290 .LP
 291 To never register a system, enter:
 292
 293 .sp
 294 .in +2
 295 .nf
 296 \fB/usr/sbin/sconadm register -N\fR
 297 .fi
 298 .in -2
 299 .sp
 300
 301 .LP
 302 \fBExample 6 \fRUsing a Proxy Server With Proxy Authentication
 303 .sp
 304 .LP
 305 Edit \fBregistrationprofile.properties\fR as follows:
 306
 307 .sp
 308 .in +2
 309 .nf
 310 userName=
 311 password=
 312 hostName=
 313 subscriptionKey=
 314 portalEnabled=
 315 proxyHostName=webcache.mycompany.com
 316 proxyPort=8080
 317 proxyUserName=\fImyCompanyProxyUserName\fR
 318 proxyPassword=\fImyCompanyProxyPassword\fR
 319 .fi
 320 .in -2
 321
 322 .sp
 323 .LP
 324 Run the command:
 325
 326 .sp
 327 .in +2
 328 .nf
 329 \fB/usr/sbin/sconadm proxy -r /tmp/registrationprofile.properties\fR
 330 .fi
 331 .in -2
 332 .sp
 333
 334 .LP
 335 \fBExample 7 \fRChanging Proxy Host Settings
 336 .sp
 337 .LP
 338 Edit \fBregistrationprofile.properties\fR as follows:
 339
 340 .sp
 341 .in +2
 342 .nf
 343 userName=
 344 password=
 345 hostName=
 346 subscriptionKey=
 347 portalEnabled=
 348 proxyHostName=webcache.mycompany.com
 349 proxyPort=8080
 350 proxyUserName=\fImyCompanyProxyUserName\fR
 351 proxyPassword=\fImyCompanyProxyPassword\fR
 352 .fi
 353 .in -2
 354
 355 .sp
 356 .LP
 357 Run the command:
 358
 359 .sp
 360 .in +2
 361 .nf
 362 \fB/usr/sbin/sconadm proxy -r /tmp/registrationprofile.properties\fR
 363 .fi
 364 .in -2
 365 .sp
 366
 367 .sp
 368 .LP
 369 Then, change the \fBproxyHostName\fR value by running the following command:
 370
 371 .sp
 372 .in +2
 373 .nf
 374 \fB/usr/sbin/sconadm proxy -r /tmp/registrationprofile.properties \e
 375 -p newproxy.mycompany.com\fR
 376 .fi
 377 .in -2
 378 .sp
 379
 380 .sp
 381 .LP
 382 After the preceding command all proxies use \fBnewproxy.mycompany.com\fR.
 383
 384 .LP
 385 \fBExample 8 \fRResetting a System Not to Use a Proxy
 386 .sp
 387 .LP
 388 Edit \fBregistrationprofile.properties\fR as follows:
 389
 390 .sp
 391 .in +2
 392 .nf
 393 userName=
 394 password=
 395 hostName=
 396 subscriptionKey=
 397 portalEnabled=
 398 proxyHostName=
 399 proxyPort=
 400 proxyUserName=
 401 proxyPassword=
 402 .fi
 403 .in -2
 404
 405 .sp
 406 .LP
 407 Note that values for all proxy fields are null.
 408
 409 .sp
 410 .LP
 411 Run the command:
 412
 413 .sp
 414 .in +2
 415 .nf
 416 \fB/usr/sbin/sconadm proxy -r /tmp/registrationprofile.properties\fR
 417 .fi
 418 .in -2
 419 .sp
 420
 421 .SH EXIT STATUS
 422 .sp
 423 .ne 2
 424 .na
 425 \fB\fB0\fR\fR
 426 .ad
 427 .RS 6n
 428 Success.
 429 .RE
 430
 431 .sp
 432 .ne 2
 433 .na
 434 \fB\fB>0\fR\fR
 435 .ad
 436 .RS 6n
 437 An error occurred.
 438 .RE
 439
 440 .SH FILES
 441 .sp
 442 .ne 2
 443 .na
 444 \fB\fB/usr/lib/breg/data/RegistrationProfile.properties\fR\fR
 445 .ad
 446 .sp .6
 447 .RS 4n
 448 Registration profile template.
 449 .RE
 450
 451 .SH ATTRIBUTES
 452 .sp
 453 .LP
 454 See \fBattributes\fR(5) for descriptions of the following attributes:
 455 .sp
 456
 457 .sp
 458 .TS
 459 box;
 460 c | c
 461 l | l .
 462 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 463 _
 464 Interface Stability     Stable
 465 .TE
 466
 467 .SH SEE ALSO
 468 .sp
 469 .LP
 470 \fBregistration_profile\fR(4), \fBattributes\fR(5), \fBprivileges\fR(5)