1 kumpf 1.5 .\" $Header: /cvs/MSB/pegasus/rpm/manLinux/man1.Z/osinfo.1,v 1.4 2004/11/23 11:36:42 alagaraja Exp $

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

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

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

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

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

 18 kumpf           1.2 .B osinfo

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

 20 alagaraja       1.4 .PP 

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

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

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

 25 alagaraja       1.4 .PP 

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

 32 alagaraja       1.4 .B \-c

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

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

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

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

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

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

 92 kumpf           1.5 .I password .

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

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

104 kumpf           1.2 .RE

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

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

110 alagaraja       1.4 .TP 

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

114 alagaraja       1.4 .TP 

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

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

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

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

131 kumpf           1.2 .B osinfo .

132 alagaraja       1.4 .SH "EXAMPLES"
133                     .PP 

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

137 alagaraja       1.4 .TP 

138 kumpf           1.2 .PD 0
139                     .C osinfo
140                     

141 alagaraja       1.4 .TP 

142 kumpf           1.2 .B "OperatingSystem Information"

143 alagaraja       1.4 .TP 

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

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

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

149 alagaraja       1.4 .TP 

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

151 alagaraja       1.4 .TP 

152 kumpf           1.2 .B "  OSCapability: 32 bit "

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

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

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

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

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

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

169 alagaraja       1.4 .TP 

170 kumpf           1.2 .PD 0

171 alagaraja       1.4 .B "osinfo \-c"

172 kumpf           1.2 

173 alagaraja       1.4 .TP 

174 kumpf           1.2 .B "OperatingSystem Information"

175 alagaraja       1.4 .TP 

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

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

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

181 alagaraja       1.4 .TP 

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

183 alagaraja       1.4 .TP 

184 kumpf           1.2 .B "  OSCapability: 32 bit"

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

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

192 alagaraja       1.4 .PP 

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

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

199 kumpf           1.2 cimserver(1).

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

203 kumpf           1.2 (Common Information Model)