source: rtems/doc/new_chapters/adminiface.t @ f9b0efb0

4.104.114.84.9
Last change on this file since f9b0efb0 was f9b0efb0, checked in by Wade A Smith <warm38@…>, on Sep 21, 1998 at 3:17:00 PM

Described the constants used by the admin_type in the background section
of this file.

  • Property mode set to 100644
File size: 3.0 KB
Line 
1@c
2@c  COPYRIGHT (c) 1988-1998.
3@c  On-Line Applications Research Corporation (OAR).
4@c  All rights reserved.
5@c
6@c  $Id$
7@c
8
9@chapter Administration Interface Manager
10
11@section Introduction
12
13The administration interface manager provides a portable
14interface for some system administrative functions.
15The capabilities in this manager are defined in the POSIX
161003.1h/D3 proposed standard titled @b{Services for Reliable,
17Available, and Serviceable Systems}.
18
19The directives provided by the administration interface manager are:
20
21@itemize @bullet
22@item @code{admin_shutdown} - Shutdown the system
23@end itemize
24
25@section Background
26
27@subsection admin_args Structure
28
29@example
30put structure here
31@end example
32
33@table @b
34@item admin_type
35This field ...
36
37@table @b
38@item ADMIN_AUTOBOOT
39The default, causing the system to reboot in its usual fashion.  The
40@code{admin_data} field points to an implementation defined string
41that specifies the system image to reboot.
42
43@item ADMIN_HALT
44The system is simply halted; no reboot takes place.
45
46@item ADMIN_FAST
47The system does no send SIGTERM to active processes before halting.
48
49@item ADMIN_IMMEDIATE
50The system does not perform any of the normal shutdown procedures.
51
52@item ADMIN_ALTSYSTEM
53The system reboots using the @code{admin_data} string as a specification
54of the system to be booted.
55
56@item ADMIN_ALTCONFIG
57The system reboots using the @code{admin_data} string as a specification
58of the initial implicit configuration space.
59
60@item ADMIN_SYSDUMP
61Dump kernal memory before rebooting.
62
63@item ADMIN_INIT
64An option allowing the specification of an alternate initial program
65to be run when the system reboots.
66
67@end table
68
69@item admin_data
70This field ...
71
72@end table
73
74@section Operations
75
76@subsection Shutting Down the System
77
78@section Directives
79
80This section details the administration interface manager's directives.
81A subsection is dedicated to each of this manager's directives
82and describes the calling sequence, related constants, usage,
83and status codes.
84
85@page
86@subsection admin_shutdown - Shutdown the system
87
88@subheading CALLING SEQUENCE:
89
90@ifset is-C
91@example
92#include <admin.h>
93
94int admin_shutdown(
95  struct admin_args   *args[],
96  size_t               nargs
97);
98@end example
99@end ifset
100
101@ifset is-Ada
102@end ifset
103
104@subheading STATUS CODES:
105
106@table @b
107@item EINVAL
108An invalid argument was passed to the function call.
109
110@item EPERM
111The caller does not have appropriate permission for shutting down the
112system.
113
114@end table
115
116@subheading DESCRIPTION:
117
118The @code{admin_shutdown} function restarts the system.  The
119@code{args} argument specifies alternate or optional behavior
120for the @code{admin_shutdown} function.  The @code{admin_type}
121member of each element of the @code{args} array specifies the
122optional behavior to be performed.  There are some @code{admin_types}
123values that may provoke unspecified behavior.  The @code{nargs}
124argument specifies the length of the @code{args} array.
125
126@subheading NOTES:
127
128The @code{_POSIX_ADMIN} feature flag is defined to indicate
129this service is available.
Note: See TracBrowser for help on using the repository browser.