Hallo, dies ist ein Test.

PWD: /www/data-lst1/unixsoft/unixsoft/kaempfer/.public_html

Running in File Mode
Relative path: ./../../../../../../usr/man/./man3rad/sysmgr.3rad
Real path: /usr/share/man/man3rad/sysmgr-1.3rad
Zurück

'\" t
.\"     Title: sysmgr-1
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 2017-02-01
.\"    Manual: RAD Module Definitions
.\"    Source: Solaris 11.4
.\"  Language: English
.\"
.TH "SYSMGR\-1" "3rad" "2017\-02\-01" "Solaris 11.4" "RAD Module Definitions"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
sysmgr \- API for controlling overall system state
.SH "SYNOPSIS"
.nf
#include <rad/client/1/sysmgr\&.h>
cc [ flag\&.\&.\&. ] file\&.\&.\&. \fB\-lsysmgr1_client\fR [ library\&.\&.\&. ]
.fi
.SS "interface SystemManager"
.nf
.HP \w'rc_err_t\ \fBsysmgr_SystemManager_beginMaintenance\fR('u
.R rc_err_t \fBsysmgr_SystemManager_beginMaintenance\fR(rc_instance_t\ *inst, 
.
sysmgr_Maintenance_t\ *typeref, 
.
sysmgr_Error_t\ **error);
.RS
.RE
.fi
.nf
.HP \w'rc_err_t\ \fBsysmgr_SystemManager_listMaintenance\fR('u
.R rc_err_t \fBsysmgr_SystemManager_listMaintenance\fR(rc_instance_t\ *inst, 
.
sysmgr_Maintenance_t\ ***result, 
.
int\ *result_cnt, 
.
sysmgr_Error_t\ **error);
.RS
.RE
.fi
.nf
.HP \w'rc_err_t\ \fBsysmgr_SystemManager_endMaintenance\fR('u
.R rc_err_t \fBsysmgr_SystemManager_endMaintenance\fR(rc_instance_t\ *inst, 
.
const\ char\ *type, 
.
sysmgr_Error_t\ **error);
.RS
.RE
.fi
.SS "Enumerated Types"
.PP
\fBenum ErrorDomain\fR
.\" blockquote {
.RS 4
.PP
.nf
typedef enum sysmgr_ErrorDomain {
	SED_SYSTEM = 0,
	SED_ZONECFG = 1,
} sysmgr_ErrorDomain_t;
.fi
.RE
.\" } blockquote
.SS "Structured Types"
.PP
\fBstruct Errno\fR
.\" blockquote {
.RS 4
.PP
typedef struct sysmgr_Errno sysmgr_Errno_t;
.PP
.nf
struct sysmgr_Errno {
	sysmgr_ErrorDomain_t se_domain;
	int se_errno;
};
.fi

.nf
.HP \w'void\ \fBsysmgr_Errno_free\fR('u
.R void \fBsysmgr_Errno_free\fR(sysmgr_Errno_t\ *in);
.RS
.RE
.fi
.RE
.\" } blockquote
.PP
\fBstruct Error\fR
.\" blockquote {
.RS 4
.PP
typedef struct sysmgr_Error sysmgr_Error_t;
.PP
.nf
struct sysmgr_Error {
	sysmgr_Errno_t *se_err;
	char *se_str;
};
.fi

.nf
.HP \w'void\ \fBsysmgr_Error_free\fR('u
.R void \fBsysmgr_Error_free\fR(sysmgr_Error_t\ *in);
.RS
.RE
.fi
.RE
.\" } blockquote
.PP
\fBstruct Maintenance\fR
.\" blockquote {
.RS 4
.PP
typedef struct sysmgr_Maintenance sysmgr_Maintenance_t;
.PP
.nf
struct sysmgr_Maintenance {
	char *sm_type;
	char *sm_user;
	struct timespec sm_timestamp;
	char *sm_message;
};
.fi

.nf
.HP \w'void\ \fBsysmgr_Maintenance_free\fR('u
.R void \fBsysmgr_Maintenance_free\fR(sysmgr_Maintenance_t\ *in);
.RS
.RE
.fi
.RE
.\" } blockquote
.SH "DESCRIPTION"
.PP
\fBAPI com\&.oracle\&.solaris\&.rad\&.sysmgr \fR\fB\&\s-2\u[1]\d\s+2\fR
.PP
This API provides functionality for controlling overall system state\&.
.SH "INTERFACES"
.SS "interface SystemManager"
.PP
Manage the operating system instance
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSystemManager Methods\fR
.RS 4
.nf
.HP \w'rc_err_t\ \fBsysmgr_SystemManager_beginMaintenance\fR('u
.R rc_err_t \fBsysmgr_SystemManager_beginMaintenance\fR(rc_instance_t\ *inst, 
.
sysmgr_Maintenance_t\ *typeref, 
.
sysmgr_Error_t\ **error);
.RS
.RE
.fi
.\" blockquote {
.RS 4
.PP
Initiate a maintenance mode
.PP
If the maintenance type is "admin" or "zone", then any zones evacuation state is cleared\&. While in this maintenance mode, zones cannot be attached or booted (including migrations into the system)\&.
.PP
If the maintenance type is "admin" or "software", then any software defects or alerts are not processed by FMA and no Automatic Service Requests are logged\&.
.PP
A maintenance type of "noreboot" prevents a system reboot or halt using the reboot(8)/halt(8)/shutdown(8)/init(8) commands, or use of the uadmin(2) system call to halt or reboot the system, until the maintenance is ended\&.
.PP
\fBArguments:\fR
.PP
\fIinst\fR
\(em RAD instance
.PP
\fItyperef\fR
\(em The maintenance data
.\" blockquote {
.RS 4
.PP
The caller should populate \&.user (typically a UNIX username, but the value is freeform)\&. The type should be either software, zone or admin\&. The timestamp will be automatically generated\&.
.RE
.\" } blockquote
.PP
\fIerror\fR
.RE
.\" } blockquote
.nf
.HP \w'rc_err_t\ \fBsysmgr_SystemManager_listMaintenance\fR('u
.R rc_err_t \fBsysmgr_SystemManager_listMaintenance\fR(rc_instance_t\ *inst, 
.
sysmgr_Maintenance_t\ ***result, 
.
int\ *result_cnt, 
.
sysmgr_Error_t\ **error);
.RS
.RE
.fi
.\" blockquote {
.RS 4
.PP
List enabled maintenance modes
.PP
\fBArguments:\fR
.PP
\fIinst\fR
\(em RAD instance
.PP
\fIresult\fR
.PP
\fIresult_cnt\fR
\(em Number of items in result array
.PP
\fIerror\fR
.RE
.\" } blockquote
.nf
.HP \w'rc_err_t\ \fBsysmgr_SystemManager_endMaintenance\fR('u
.R rc_err_t \fBsysmgr_SystemManager_endMaintenance\fR(rc_instance_t\ *inst, 
.
const\ char\ *type, 
.
sysmgr_Error_t\ **error);
.RS
.RE
.fi
.\" blockquote {
.RS 4
.PP
End a maintenance mode\&.
.PP
\fBArguments:\fR
.PP
\fIinst\fR
\(em RAD instance
.PP
\fItype\fR
\(em The type of maintenance to end
.PP
\fIerror\fR
.RE
.\" } blockquote
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSystemManager Retrieve\fR
.RS 4
.nf
.HP \w'rc_err_t\ \fBsysmgr_SystemManager__rad_get_name\fR('u
.R rc_err_t \fBsysmgr_SystemManager__rad_get_name\fR(adr_name_t\ **result, 
.
int\ n, 
.
\&.\&.\&.);
.RS
.RE
.fi
.\" blockquote {
.RS 4
.PP
Obtain RAD name of a SystemManager object\&.
.PP
\fBArguments:\fR
.PP
\fIresult\fR
\(em RAD name
.PP
\fIn\fR
\(em Number of key\-value pairs provided as variadic arguments
.PP
\&.\&.\&. \(em Optional key\-value pairs that compose the primary key
.RE
.\" } blockquote
.nf
.HP \w'rc_err_t\ \fBsysmgr_SystemManager__rad_lookup\fR('u
.R rc_err_t \fBsysmgr_SystemManager__rad_lookup\fR(rc_conn_t\ *c, 
.
boolean_t\ strict, 
.
rc_instance_t\ **result, 
.
int\ n, 
.
\&.\&.\&.);
.RS
.RE
.fi
.\" blockquote {
.RS 4
.PP
Lookup a SystemManager instance\&.
.PP
Construct a RAD name for the interface based on the provided key\-value pairs and perform a lookup\&. If successful, instance reference is returned in the result\&.
.PP
\fBArguments:\fR
.PP
\fIc\fR
\(em RAD connection handle
.PP
\fIstrict\fR
\(em Strict (B_TRUE) or relaxed (B_FALSE) versioning
.PP
\fIresult\fR
\(em RAD instance
.PP
\fIn\fR
\(em Number of key\-value pairs provided as variadic arguments
.PP
\&.\&.\&. \(em Optional key\-value pairs that compose the primary key
.RE
.\" } blockquote
.nf
.HP \w'rc_err_t\ \fBsysmgr_SystemManager__rad_list\fR('u
.R rc_err_t \fBsysmgr_SystemManager__rad_list\fR(rc_conn_t\ *c, 
.
boolean_t\ strict, 
.
adr_pattern_scheme_t\ scheme, 
.
adr_name_t\ ***result, 
.
int\ *result_count, 
.
int\ n, 
.
\&.\&.\&.);
.RS
.RE
.fi
.\" blockquote {
.RS 4
.PP
List RAD names of a available SystemManager instances\&.
.PP
Returns an array and array size of matching object names\&.
.PP
\fBArguments:\fR
.PP
\fIc\fR
\(em RAD connection handle
.PP
\fIstrict\fR
\(em Strict (B_TRUE) or relaxed (B_FALSE) versioning
.PP
\fIscheme\fR
\(em Apply glob (NS_GLOB) or regex (NS_REGEX) matching
.PP
\fIresult\fR
\(em Array of RAD names
.PP
\fIresult_count\fR
\(em Number of names in result array
.PP
\fIn\fR
\(em Number of key\-value pairs provided as variadic arguments
.PP
\&.\&.\&. \(em Optional key\-value pairs that compose the primary key
.RE
.\" } blockquote
.RE
.SH "ENUMERATED TYPES"
.PP
\fBenum ErrorDomain\fR
\(em Type of error number
.\" blockquote {
.RS 4
.PP
.nf
typedef enum sysmgr_ErrorDomain {
	SED_SYSTEM = 0,
	SED_ZONECFG = 1,
} sysmgr_ErrorDomain_t;
.fi
.RE
.\" } blockquote
.\" blockquote {
.RS 4
.PP
SED_SYSTEM
(0) \(em As per strerror()
.PP
SED_ZONECFG
(1) \(em As per zonecfg_strerror()
.RE
.\" } blockquote
.SH "STRUCTURED TYPES"
.PP
\fBstruct Errno\fR
\(em Error number description
.\" blockquote {
.RS 4
.PP
typedef struct sysmgr_Errno sysmgr_Errno_t;
.PP
.nf
struct sysmgr_Errno {
	sysmgr_ErrorDomain_t se_domain;
	int se_errno;
};
.fi

.nf
.HP \w'void\ \fBsysmgr_Errno_free\fR('u
.R void \fBsysmgr_Errno_free\fR(sysmgr_Errno_t\ *in);
.RS
.RE
.fi
.RE
.\" } blockquote
.\" blockquote {
.RS 4
.PP
\fBFields:\fR
.PP
\fIse_domain\fR
.PP
\fIse_errno\fR
.RE
.\" } blockquote
.PP
\fBstruct Error\fR
\(em An error occurred for the given operation
.\" blockquote {
.RS 4
.PP
typedef struct sysmgr_Error sysmgr_Error_t;
.PP
.nf
struct sysmgr_Error {
	sysmgr_Errno_t *se_err;
	char *se_str;
};
.fi

.nf
.HP \w'void\ \fBsysmgr_Error_free\fR('u
.R void \fBsysmgr_Error_free\fR(sysmgr_Error_t\ *in);
.RS
.RE
.fi
.RE
.\" } blockquote
.\" blockquote {
.RS 4
.PP
Note that the error string includes any expanded strerror() equivalent\&.
.RE
.\" } blockquote
.\" blockquote {
.RS 4
.PP
\fBFields:\fR
.PP
\fIse_err\fR
.PP
\fIse_str\fR
.RE
.\" } blockquote
.PP
\fBstruct Maintenance\fR
\(em A maintenance mode
.\" blockquote {
.RS 4
.PP
typedef struct sysmgr_Maintenance sysmgr_Maintenance_t;
.PP
.nf
struct sysmgr_Maintenance {
	char *sm_type;
	char *sm_user;
	struct timespec sm_timestamp;
	char *sm_message;
};
.fi

.nf
.HP \w'void\ \fBsysmgr_Maintenance_free\fR('u
.R void \fBsysmgr_Maintenance_free\fR(sysmgr_Maintenance_t\ *in);
.RS
.RE
.fi
.RE
.\" } blockquote
.\" blockquote {
.RS 4
.PP
\fBFields:\fR
.PP
\fIsm_type\fR
\(em The type of maintenance
.PP
\fIsm_user\fR
\(em The user who set the mode
.PP
\fIsm_timestamp\fR
\(em Time the mode was set, in seconds since the epoch
.PP
\fIsm_message\fR
\(em Free\-form message used to indicate reason for maintenance\&.
.RE
.\" } blockquote
.SH "VERSION"
.PP
1\&.0
.SH "ATTRIBUTES"
.PP
See attributes(7) for descriptions of the following attributes:
.TS
allbox tab(:);
cB cB.
T{
ATTRIBUTE TYPE
T}:T{
ATTRIBUTE VALUE
T}
.T&
l l
l l.
T{
Availability
T}:T{
system/management/rad/module/rad\-sysmgr
T}
T{
Interface Stability
T}:T{
Private
T}
.TE
.sp 1
.SH "SEE ALSO"
.PP
\fBrad\fR(8)
.SH "NOTES"
.IP " 1." 4
Accessing Python documentation for this module:
.sp
.RS 4
.nf
$ pydoc rad.bindings.com.oracle.solaris.rad.sysmgr_1
.fi
.RE