1 alagaraja 1.4 .\" .TA w \" lowercase initial letter of .TH name
  2               .TH "osinfo" "1" "" "" ""
  3               .SH "NAME"
  4               .PP 

  5 kumpf     1.2 osinfo \- gather information regarding the running operating system

  6 alagaraja 1.4 .SH "SYNOPSIS"
  7               \fBosinfo\fP [ \fB\-s\fP ] [ \fB\-h\fP hostname ] [ \fB\-p\fP portnumber ]
  8                      [ \fB\-u\fP username ] [ \fB\-w\fP password ] [ \fB\-t\fP timeout ]
  9                      [ \fB\-c\fP ] [ \fB\-\-help\fP ] [ \fB\-\-version\fP ]
 10               .SH "DESCRIPTION"
 11               .PP 

 12 kumpf     1.2 The 
 13               .B osinfo 
 14               command displays information regarding the operating system,
 15               gathered via WBEM using the PG_OperatingSystem class supported by the

 16 denise.eckstein 1.3 OperatingSystem Provider (bundled with OpenPegasus).

 17 kumpf           1.2 .B osinfo

 18 denise.eckstein 1.3 requires the CIM Server to be installed and running.

 19 alagaraja       1.4 .PP 

 20 kumpf           1.2 By default, the information is formatted for display, converting

 21 alagaraja       1.4 CIMDateTime strings into a more user\-readable format (see Examples),

 22 kumpf           1.2 and converting the total number of seconds of uptime into the 
 23                     appropriate number of days, hours, minutes, and seconds.

 24 alagaraja       1.4 .PP 

 25 kumpf           1.2 If a property value is unavailable, it will be shown as "Unknown"
 26                     .SS Options
 27                     .B osinfo
 28                     recognizes the following options:
 29                     .RS
 30                     .TP 15

 31 alagaraja       1.4 .B \-c

 32 kumpf           1.2 Use the CIM formats for DateTime and SystemUpTime values (not
 33                     the formatting done by default).
 34                     As specified by the DMTF, the CIMDateTime format is 
 35                     yyyymmddhhmmss.mmmmmmsutc, where yyyy is

 36 alagaraja       1.4 a 4\-digit year, mm is the month, dd is the day, hh is the hour on a 24\-hour

 37 kumpf           1.2 clock, mm is the minute, ss is the second, mmmmmm is the number of

 38 alagaraja       1.4 microseconds, s is a "+" or "\-" indicating the sign of the UTC

 39 kumpf           1.2 (Universal Time Code) correction field (since the DateTime is returned in
 40                     the local time zone of the system), and utc is the offset from UTC in
 41                     minutes.

 42 alagaraja       1.4 .TP 
 43                     \fB\-h\fP hostname
 44                     Connect to the CIM Server on the specified host.
 45                     If this option is not specified, 
 46                     .B osinfo 
 47                     connects to the localhost.
 48                     .TP 
 49                     .B \-\-help
 50                     Display command usage information.
 51                     .TP 
 52                     \fB\-p\fP portnumber
 53                     Connect to the CIM Server on the specified port number.  
 54                     If this option is not specified, 
 55                     .B osinfo
 56                     connects to the default port for the wbem\-http service, or if the 
 57                     .B \-s
 58                     option is specified, to the default port for the wbem\-https service.
 59                     .TP 
 60                     .B \-s
 61                     Enable the use of the SSL protocol between 
 62                     .B osinfo 
 63 alagaraja       1.4 and the CIM server.
 64                     The 
 65                     .B \-s
 66                     option should be specified if the CIM Server 
 67                     on the specified hostname/portnumber expects clients to connect using HTTPS.
 68                     .TP 
 69                     \fB\-t\fP timeout
 70                     Wait the specified number of milliseconds on sending a request, before timing out if no response has been received.  The 
 71                     .I timeout 
 72                     value must be an integer value greater than 0.
 73                     .TP 
 74                     \fB\-u\fP username
 75                     Connect as the specified 
 76                     .I R username . 
 77                     If 
 78                     .I username 
 79                     is not specified, the current logged in user is used for authentication.
 80                     This option is ignored if neither
 81                     .I hostname 
 82                     nor 
 83                     .I portnumber 
 84 alagaraja       1.4 is specified.
 85                     .TP 
 86                     \fB\-\-version\fP 
 87                     Display CIM Server version.
 88                     .TP 
 89                     \fB\-w\fP password
 90                     Authenticate the connection using the specified 

 91 kumpf           1.5 .I password .

 92 alagaraja       1.4 This option is ignored if neither
 93                     .I hostname 
 94                     nor 
 95                     .I portnumber 
 96                     is specified.

 97 kumpf           1.5 WARNING: A password should not be specified on the command line on a
 98                     multi-user system, since command-line options are typically world-readable
 99                     for a short window of time.  If the remote host requests authentication and
100                     this option is not specified,
101                     .B osinfo 
102                     will prompt for the password.

103 kumpf           1.2 .RE

104 alagaraja       1.4 .SH "EXIT STATUS"
105                     .PP 

106 kumpf           1.2 When an error occurs, an error message is written to stderr and an
107                     appropriate value is returned.  The following values are returned:
108                     .RS

109 alagaraja       1.4 .TP 

110 kumpf           1.2 .B 0 
111                     Success
112                     .PD 0

113 alagaraja       1.4 .TP 

114 kumpf           1.2 .B 1
115                     Error
116                     .PD
117                     .RE

118 alagaraja       1.4 .SH "USAGE NOTE"
119                     .PP 
120                     The 
121                     .B osinfo 
122                     command requires that the CIM Server is running.
123                     .SH "DIAGNOSTICS"
124                     .PP 
125                     .B "osinfo error: Cannot connect"
126                     .IP 

127 kumpf           1.2 The CIMOM is not running.  Start the CIMOM with the

128 alagaraja       1.4 .B cimserver
129                     command and re\-run

130 kumpf           1.2 .B osinfo .

131 alagaraja       1.4 .SH "EXAMPLES"
132                     .PP 

133 kumpf           1.2 Run the default 
134                     .B osinfo 
135                     command.

136 alagaraja       1.4 .TP 

137 kumpf           1.2 .PD 0
138                     .C osinfo
139                     

140 alagaraja       1.4 .TP 

141 kumpf           1.2 .B "OperatingSystem Information"

142 alagaraja       1.4 .TP 

143 denise.eckstein 1.3 .B "  Host: myserver.hp.com "

144 alagaraja       1.4 .TP 
145                     .B "  Name: HP\-UX "
146                     .TP 

147 kumpf           1.2 .B "  Version: B.11.00 "

148 alagaraja       1.4 .TP 

149 kumpf           1.2 .B "  UserLicense: Unlimited user license "

150 alagaraja       1.4 .TP 

151 kumpf           1.2 .B "  OSCapability: 32 bit "

152 alagaraja       1.4 .TP 
153                     .B "  LastBootTime: Sep 24, 2001  9:16:18 (\-0700) "
154                     .TP 
155                     .B "  LocalDateTime: May 23, 2002  10:55:54 (\-0700) "
156                     .TP 

157 kumpf           1.2 .B "  SystemUpTime: 20828377 seconds = 241 days, 1 hr, 39 mins, 37 secs  "
158                     .PD

159 alagaraja       1.4 .PP 
160                     The system myserver.hp.com is running version B.11.00 of HP\-UX,
161                     has an unlimited user license, and is 32\-bit capable.  The Operating

162 kumpf           1.2 System was last booted on Sept 24, 2001 and the local date and time

163 alagaraja       1.4 are given.  All time values are offset from GMT by \-7 hours.
164                     .PP 

165 kumpf           1.2 Run 
166                     .B osinfo ,
167                     with the values displayed in their CIM format

168 alagaraja       1.4 .TP 

169 kumpf           1.2 .PD 0

170 alagaraja       1.4 .B "osinfo \-c"

171 kumpf           1.2 

172 alagaraja       1.4 .TP 

173 kumpf           1.2 .B "OperatingSystem Information"

174 alagaraja       1.4 .TP 

175 kumpf           1.2 .B "  Host: rushmore.cup.hp.com"

176 alagaraja       1.4 .TP 
177                     .B "  Name: HP\-UX"
178                     .TP 

179 kumpf           1.2 .B "  Version: B.11.00"

180 alagaraja       1.4 .TP 

181 kumpf           1.2 .B "  UserLicense: Unlimited user license"

182 alagaraja       1.4 .TP 

183 kumpf           1.2 .B "  OSCapability: 32 bit"

184 alagaraja       1.4 .TP 
185                     .B "  LastBootTime: 20010924091618.000000\-420"
186                     .TP 
187                     .B "  LocalDateTime: 20020523105801.000000\-420"
188                     .TP 

189 kumpf           1.2 .B "  SystemUpTime: 20828504"
190                     .PD

191 alagaraja       1.4 .PP 

192 kumpf           1.2 The same rushmore.cup.hp.com system is displayed, but in this output the
193                     LastBootTime and LocalDateTime values are in the CIM format.  The SystemUpTime
194                     value is in total seconds (as specified by CIM).  Other fields do not change,
195                     as their CIM specification is the strings themselves.

196 alagaraja       1.4 .SH "SEE ALSO"
197                     .PP 

198 kumpf           1.2 cimserver(1).

199 alagaraja       1.4 .SH "STANDARDS CONFORMANCE"
200                     .PP 
201                     \fBosinfo\fP : DMTF WBEM (Web\-Based Enterprise Management) and CIM 

202 kumpf           1.2 (Common Information Model)