Hallo, dies ist ein Test.

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

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

'\" t .\" Title: bemgr-1 .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> .\" Date: 2020-08-18 .\" Manual: RAD Module Definitions .\" Source: Solaris 11.4 .\" Language: English .\" .TH "BEMGR\-1" "3rad" "2020\-08\-18" "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" bemgr \- This API provides functionality for getting information about Boot Environments(BE) on the system\&. .SH "SYNOPSIS" .nf #include <rad/client/1/bemgr\&.h> cc [ flag\&.\&.\&. ] file\&.\&.\&. \fB\-lbemgr1_client\fR [ library\&.\&.\&. ] .fi .SS "interface BootEnv" .nf const char *\ \&name\ \&; (ro) .fi .nf const char *\ \&fmri\ \&; (ro) .fi .nf boolean_t\ \&active\ \&; (ro) .fi .nf boolean_t\ \&activeOnBoot\ \&; (ro) .fi .nf boolean_t *\ \&activeUnbootable\ \&; (ro) .fi .nf boolean_t\ \&mounted\ \&; (ro) .fi .nf const char *\ \&mountpoint\ \&; (ro) .fi .nf unsigned long long\ \&spaceUsed\ \&; (ro) .fi .nf const rc_instance_t *\ \&rootDataset\ \&; (ro) .fi .nf const rc_instance_t **\ \&datasets\ \&; (ro) .fi .nf const rc_instance_t **\ \&snapshots\ \&; (ro) .fi .nf const char *\ \&zpool\ \&; (ro) .fi .nf const char *\ \&uuid\ \&; (ro) .fi .nf const char *\ \&policy\ \&; (ro) .fi .nf const rc_instance_t *\ \&parentBE\ \&; (ro) .fi .nf const rc_instance_t **\ \&childBEs\ \&; (ro) .fi .nf int\ \&creation\ \&; (ro) .fi .nf unsigned long long\ \&pool_version\ \&; (ro) .fi .SS "interface BEDataset" .nf const char *\ \&name\ \&; (ro) .fi .nf const char *\ \&mountpoint\ \&; (ro) .fi .nf int\ \&creation\ \&; (ro) .fi .nf unsigned long long\ \&spaceUsed\ \&; (ro) .fi .SS "interface BESnapshot" .nf const char *\ \&name\ \&; (ro) .fi .nf int\ \&creation\ \&; (ro) .fi .nf unsigned long long\ \&spaceUsed\ \&; (ro) .fi .SS "interface BEManager" .nf .HP \w'rc_err_t\ \fBbemgr_BEManager_getActiveBE\fR('u .R rc_err_t \fBbemgr_BEManager_getActiveBE\fR(rc_instance_t\ *inst, . rc_instance_t\ **result, . bemgr_BeMgrRadError_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBbemgr_BEManager_getActiveOnBootBE\fR('u .R rc_err_t \fBbemgr_BEManager_getActiveOnBootBE\fR(rc_instance_t\ *inst, . const\ char\ *zpool, . rc_instance_t\ **result, . bemgr_BeMgrRadError_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBbemgr_BEManager_getActiveOnBootZBE\fR('u .R rc_err_t \fBbemgr_BEManager_getActiveOnBootZBE\fR(rc_instance_t\ *inst, . const\ char\ *zonename, . const\ char\ *gzbe_fmri, . rc_instance_t\ **result, . bemgr_BeMgrRadError_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBbemgr_BEManager_getZBEList\fR('u .R rc_err_t \fBbemgr_BEManager_getZBEList\fR(rc_instance_t\ *inst, . const\ char\ *zonename, . rc_instance_t\ ***result, . int\ *result_cnt, . bemgr_BeMgrRadError_t\ **error); .RS .RE .fi .SS "Enumerated Types" .PP \fBenum BeMgrRadErrType\fR .\" blockquote { .RS 4 .PP .nf typedef enum bemgr_BeMgrRadErrType { BBMRET_INVALID_ARG = 0, BBMRET_BE_OP_ERR = 1, BBMRET_BE_RAD_ERR = 2, } bemgr_BeMgrRadErrType_t; .fi .RE .\" } blockquote .SS "Structured Types" .PP \fBstruct BeMgrRadError\fR .\" blockquote { .RS 4 .PP typedef struct bemgr_BeMgrRadError bemgr_BeMgrRadError_t; .PP .nf struct bemgr_BeMgrRadError { bemgr_BeMgrRadErrType_t bbmre_errType; char *bbmre_info; }; .fi .nf .HP \w'void\ \fBbemgr_BeMgrRadError_free\fR('u .R void \fBbemgr_BeMgrRadError_free\fR(bemgr_BeMgrRadError_t\ *in); .RS .RE .fi .RE .\" } blockquote .SH "DESCRIPTION" .PP \fBAPI com\&.oracle\&.solaris\&.rad\&.bemgr \fR\fB\&\s-2\u[1]\d\s+2\fR .PP This API provides functionality for getting information about Boot Environments(BE) on the system\&. Management of BEs is not supported at this time\&. .PP The following sample Python clients illustrate some simple interactions with the module\&. .SH "INTERFACES" .SS "interface BootEnv" .PP Information about a Boot Environment\&. .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBBootEnv Properties\fR .RS 4 .PP \fB\fIconst char *\fR\fR\ \&\fBname\fR (\fIread\-only\fR) \(em Name of the BE\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BootEnv_get_name\fR('u .R rc_err_t \fBbemgr_BootEnv_get_name\fR(rc_instance_t\ *inst, . char\ **result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .RE .\" } blockquote .RE .\" } blockquote .PP \fB\fIconst char *\fR\fR\ \&\fBfmri\fR (\fIread\-only\fR) \(em Full BE FMRI\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BootEnv_get_fmri\fR('u .R rc_err_t \fBbemgr_BootEnv_get_fmri\fR(rc_instance_t\ *inst, . char\ **result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .RE .\" } blockquote .RE .\" } blockquote .PP \fB\fIboolean_t\fR\fR\ \&\fBactive\fR (\fIread\-only\fR) \(em Indicate whether this is an active BE\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BootEnv_get_active\fR('u .R rc_err_t \fBbemgr_BootEnv_get_active\fR(rc_instance_t\ *inst, . boolean_t\ *result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .RE .\" } blockquote .RE .\" } blockquote .PP \fB\fIboolean_t\fR\fR\ \&\fBactiveOnBoot\fR (\fIread\-only\fR) \(em Indicate whether this is an active on boot BE\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BootEnv_get_activeOnBoot\fR('u .R rc_err_t \fBbemgr_BootEnv_get_activeOnBoot\fR(rc_instance_t\ *inst, . boolean_t\ *result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .RE .\" } blockquote .RE .\" } blockquote .PP \fB\fIboolean_t *\fR\fR\ \&\fBactiveUnbootable\fR (\fIread\-only\fR, \fInullable\fR) .\" blockquote { .RS 4 .PP This field is only used for non\-global zone BEs\&. Indicate whether this BE is the active BE for global zone BE that\'s not currently running, so, it is not bootable\&. .RE .\" } blockquote .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BootEnv_get_activeUnbootable\fR('u .R rc_err_t \fBbemgr_BootEnv_get_activeUnbootable\fR(rc_instance_t\ *inst, . boolean_t\ **result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .RE .\" } blockquote .RE .\" } blockquote .PP \fB\fIboolean_t\fR\fR\ \&\fBmounted\fR (\fIread\-only\fR) \(em Indicate whether this BE is currently mounted\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BootEnv_get_mounted\fR('u .R rc_err_t \fBbemgr_BootEnv_get_mounted\fR(rc_instance_t\ *inst, . boolean_t\ *result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .RE .\" } blockquote .RE .\" } blockquote .PP \fB\fIconst char *\fR\fR\ \&\fBmountpoint\fR (\fIread\-only\fR, \fInullable\fR) \(em Mountpoint of the BE, if mounted\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BootEnv_get_mountpoint\fR('u .R rc_err_t \fBbemgr_BootEnv_get_mountpoint\fR(rc_instance_t\ *inst, . char\ **result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .RE .\" } blockquote .RE .\" } blockquote .PP \fB\fIunsigned long long\fR\fR\ \&\fBspaceUsed\fR (\fIread\-only\fR) \(em Total size of the BE\&. If the BE is a global BE, this includes size of all NGZ BEs associated with the global zone BE\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BootEnv_get_spaceUsed\fR('u .R rc_err_t \fBbemgr_BootEnv_get_spaceUsed\fR(rc_instance_t\ *inst, . unsigned\ long\ long\ *result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .RE .\" } blockquote .RE .\" } blockquote .PP \fB\fIconst rc_instance_t *\fR\fR\ \&\fBrootDataset\fR (\fIread\-only\fR) \(em BEDataset object representing the ZFS filesystem used as the root dataset for the BE\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BootEnv_get_rootDataset\fR('u .R rc_err_t \fBbemgr_BootEnv_get_rootDataset\fR(rc_instance_t\ *inst, . rc_instance_t\ **result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .RE .\" } blockquote .RE .\" } blockquote .PP \fB\fIconst rc_instance_t **\fR\fR\ \&\fBdatasets\fR (\fIread\-only\fR) \(em List of in\-BE datasets\&. The root dataset is also included in this list\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BootEnv_get_datasets\fR('u .R rc_err_t \fBbemgr_BootEnv_get_datasets\fR(rc_instance_t\ *inst, . rc_instance_t\ ***result, . int\ *result_cnt); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .PP \fIresult_cnt\fR \(em Number of items in result array .RE .\" } blockquote .RE .\" } blockquote .PP \fB\fIconst rc_instance_t **\fR\fR\ \&\fBsnapshots\fR (\fIread\-only\fR, \fInullable\fR) \(em List of ZFS snapshots for all in\-BE datasets\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BootEnv_get_snapshots\fR('u .R rc_err_t \fBbemgr_BootEnv_get_snapshots\fR(rc_instance_t\ *inst, . rc_instance_t\ ***result, . int\ *result_cnt); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .PP \fIresult_cnt\fR \(em Number of items in result array .RE .\" } blockquote .RE .\" } blockquote .PP \fB\fIconst char *\fR\fR\ \&\fBzpool\fR (\fIread\-only\fR) \(em Name of the zpool this BE resides on\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BootEnv_get_zpool\fR('u .R rc_err_t \fBbemgr_BootEnv_get_zpool\fR(rc_instance_t\ *inst, . char\ **result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .RE .\" } blockquote .RE .\" } blockquote .PP \fB\fIconst char *\fR\fR\ \&\fBuuid\fR (\fIread\-only\fR) \(em UUID for the BE resides on\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BootEnv_get_uuid\fR('u .R rc_err_t \fBbemgr_BootEnv_get_uuid\fR(rc_instance_t\ *inst, . char\ **result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .RE .\" } blockquote .RE .\" } blockquote .PP \fB\fIconst char *\fR\fR\ \&\fBpolicy\fR (\fIread\-only\fR) \(em BE\'s policy .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BootEnv_get_policy\fR('u .R rc_err_t \fBbemgr_BootEnv_get_policy\fR(rc_instance_t\ *inst, . char\ **result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .RE .\" } blockquote .RE .\" } blockquote .PP \fB\fIconst rc_instance_t *\fR\fR\ \&\fBparentBE\fR (\fIread\-only\fR, \fInullable\fR) \(em Only used for NGZ BEs\&. FMRI of the parent BE\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BootEnv_get_parentBE\fR('u .R rc_err_t \fBbemgr_BootEnv_get_parentBE\fR(rc_instance_t\ *inst, . rc_instance_t\ **result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .RE .\" } blockquote .RE .\" } blockquote .PP \fB\fIconst rc_instance_t **\fR\fR\ \&\fBchildBEs\fR (\fIread\-only\fR, \fInullable\fR) \(em List of FMRI of the child BE\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BootEnv_get_childBEs\fR('u .R rc_err_t \fBbemgr_BootEnv_get_childBEs\fR(rc_instance_t\ *inst, . rc_instance_t\ ***result, . int\ *result_cnt); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .PP \fIresult_cnt\fR \(em Number of items in result array .RE .\" } blockquote .RE .\" } blockquote .PP \fB\fIint\fR\fR\ \&\fBcreation\fR (\fIread\-only\fR) \(em BE\'s creation timestamp .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BootEnv_get_creation\fR('u .R rc_err_t \fBbemgr_BootEnv_get_creation\fR(rc_instance_t\ *inst, . int\ *result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .RE .\" } blockquote .RE .\" } blockquote .PP \fB\fIunsigned long long\fR\fR\ \&\fBpool_version\fR (\fIread\-only\fR) \(em The maximum pool version this BE supports, if the BE is not mounted\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BootEnv_get_pool_version\fR('u .R rc_err_t \fBbemgr_BootEnv_get_pool_version\fR(rc_instance_t\ *inst, . unsigned\ long\ long\ *result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .RE .\" } blockquote .RE .\" } blockquote .RE .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBBootEnv Retrieve\fR .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BootEnv__rad_get_name\fR('u .R rc_err_t \fBbemgr_BootEnv__rad_get_name\fR(adr_name_t\ **result, . int\ n, . \&.\&.\&.); .RS .RE .fi .\" blockquote { .RS 4 .PP Obtain RAD name of a BootEnv 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\ \fBbemgr_BootEnv__rad_lookup\fR('u .R rc_err_t \fBbemgr_BootEnv__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 BootEnv 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\ \fBbemgr_BootEnv__rad_list\fR('u .R rc_err_t \fBbemgr_BootEnv__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 BootEnv 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 .SS "interface BEDataset" .PP .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBBEDataset Properties\fR .RS 4 .PP \fB\fIconst char *\fR\fR\ \&\fBname\fR (\fIread\-only\fR) \(em BEDataset\'s ZFS filesystem name .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BEDataset_get_name\fR('u .R rc_err_t \fBbemgr_BEDataset_get_name\fR(rc_instance_t\ *inst, . char\ **result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .RE .\" } blockquote .RE .\" } blockquote .PP \fB\fIconst char *\fR\fR\ \&\fBmountpoint\fR (\fIread\-only\fR) \(em Dataset\'s mountpoint .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BEDataset_get_mountpoint\fR('u .R rc_err_t \fBbemgr_BEDataset_get_mountpoint\fR(rc_instance_t\ *inst, . char\ **result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .RE .\" } blockquote .RE .\" } blockquote .PP \fB\fIint\fR\fR\ \&\fBcreation\fR (\fIread\-only\fR) \(em BE Dataset\'s creation timestamp .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BEDataset_get_creation\fR('u .R rc_err_t \fBbemgr_BEDataset_get_creation\fR(rc_instance_t\ *inst, . int\ *result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .RE .\" } blockquote .RE .\" } blockquote .PP \fB\fIunsigned long long\fR\fR\ \&\fBspaceUsed\fR (\fIread\-only\fR) \(em Amount of space used by this BE Dataset .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BEDataset_get_spaceUsed\fR('u .R rc_err_t \fBbemgr_BEDataset_get_spaceUsed\fR(rc_instance_t\ *inst, . unsigned\ long\ long\ *result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .RE .\" } blockquote .RE .\" } blockquote .RE .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBBEDataset Retrieve\fR .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BEDataset__rad_get_name\fR('u .R rc_err_t \fBbemgr_BEDataset__rad_get_name\fR(adr_name_t\ **result, . int\ n, . \&.\&.\&.); .RS .RE .fi .\" blockquote { .RS 4 .PP Obtain RAD name of a BEDataset 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\ \fBbemgr_BEDataset__rad_lookup\fR('u .R rc_err_t \fBbemgr_BEDataset__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 BEDataset 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\ \fBbemgr_BEDataset__rad_list\fR('u .R rc_err_t \fBbemgr_BEDataset__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 BEDataset 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 .SS "interface BESnapshot" .PP .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBBESnapshot Properties\fR .RS 4 .PP \fB\fIconst char *\fR\fR\ \&\fBname\fR (\fIread\-only\fR) \(em BE Snapshot\'s ZFS snapshot name .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BESnapshot_get_name\fR('u .R rc_err_t \fBbemgr_BESnapshot_get_name\fR(rc_instance_t\ *inst, . char\ **result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .RE .\" } blockquote .RE .\" } blockquote .PP \fB\fIint\fR\fR\ \&\fBcreation\fR (\fIread\-only\fR) \(em BE Snapshot\'s creation timestamp .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BESnapshot_get_creation\fR('u .R rc_err_t \fBbemgr_BESnapshot_get_creation\fR(rc_instance_t\ *inst, . int\ *result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .RE .\" } blockquote .RE .\" } blockquote .PP \fB\fIunsigned long long\fR\fR\ \&\fBspaceUsed\fR (\fIread\-only\fR) \(em Amount of space used by this BE Snapshot .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BESnapshot_get_spaceUsed\fR('u .R rc_err_t \fBbemgr_BESnapshot_get_spaceUsed\fR(rc_instance_t\ *inst, . unsigned\ long\ long\ *result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em Property value returned .RE .\" } blockquote .RE .\" } blockquote .RE .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBBESnapshot Retrieve\fR .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BESnapshot__rad_get_name\fR('u .R rc_err_t \fBbemgr_BESnapshot__rad_get_name\fR(adr_name_t\ **result, . int\ n, . \&.\&.\&.); .RS .RE .fi .\" blockquote { .RS 4 .PP Obtain RAD name of a BESnapshot 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\ \fBbemgr_BESnapshot__rad_lookup\fR('u .R rc_err_t \fBbemgr_BESnapshot__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 BESnapshot 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\ \fBbemgr_BESnapshot__rad_list\fR('u .R rc_err_t \fBbemgr_BESnapshot__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 BESnapshot 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 .SS "interface BEManager" .PP The BEManager interface is a RAD singleton\&. It provides interfaces for getting information about Boot Environments on the system\&. .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBBEManager Methods\fR .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BEManager_getActiveBE\fR('u .R rc_err_t \fBbemgr_BEManager_getActiveBE\fR(rc_instance_t\ *inst, . rc_instance_t\ **result, . bemgr_BeMgrRadError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Returns a BootEnv object representing the currently running global zone BE\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIresult\fR \(em BootEnv object representing the currently running global zone BE\&. .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBbemgr_BEManager_getActiveOnBootBE\fR('u .R rc_err_t \fBbemgr_BEManager_getActiveOnBootBE\fR(rc_instance_t\ *inst, . const\ char\ *zpool, . rc_instance_t\ **result, . bemgr_BeMgrRadError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Returns a BootEnv object representing the activated global zone BE for the given zpool\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIzpool\fR (\fInullable\fR) \(em Optional\&. If name of a zpool is specified, the activated global zone BE for the given zpool is returned\&. If name of a zpool is not specified, the activated global zone BE for the running BE\'s zpool is returned\&. .PP \fIresult\fR \(em BootEnv object representing the activated global zone BE\&. .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBbemgr_BEManager_getActiveOnBootZBE\fR('u .R rc_err_t \fBbemgr_BEManager_getActiveOnBootZBE\fR(rc_instance_t\ *inst, . const\ char\ *zonename, . const\ char\ *gzbe_fmri, . rc_instance_t\ **result, . bemgr_BeMgrRadError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Returns a BootEnv object representing the activated non\-global zone BE that\'s associated with the given global zone BE\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIzonename\fR \(em Name of the zone for which the ZBE to be returned belongs\&. .PP \fIgzbe_fmri\fR (\fInullable\fR) \(em Optional\&. If this value is specified, this function will return the active\-on\-boot ZBE for the given global zone\&. If this value is not specified, this function will return the active\-on\-boot ZBE for the current running global BE\&. .PP \fIresult\fR \(em BootEnv object of the activated non\-global zone BE\&. .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBbemgr_BEManager_getZBEList\fR('u .R rc_err_t \fBbemgr_BEManager_getZBEList\fR(rc_instance_t\ *inst, . const\ char\ *zonename, . rc_instance_t\ ***result, . int\ *result_cnt, . bemgr_BeMgrRadError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Returns a list of BootEnv objects representing all the zone BEs in the given zone\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIzonename\fR \(em Name of the zone for which the ZBEs to be returned belongs\&. .PP \fIresult\fR \(em List of BootEnv objects representing NGZ BEs in a zone\&. .PP \fIresult_cnt\fR \(em Number of items in result array .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 \fBBEManager Retrieve\fR .RS 4 .nf .HP \w'rc_err_t\ \fBbemgr_BEManager__rad_get_name\fR('u .R rc_err_t \fBbemgr_BEManager__rad_get_name\fR(adr_name_t\ **result, . int\ n, . \&.\&.\&.); .RS .RE .fi .\" blockquote { .RS 4 .PP Obtain RAD name of a BEManager 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\ \fBbemgr_BEManager__rad_lookup\fR('u .R rc_err_t \fBbemgr_BEManager__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 BEManager 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\ \fBbemgr_BEManager__rad_list\fR('u .R rc_err_t \fBbemgr_BEManager__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 BEManager 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 BeMgrRadErrType\fR \(em Possible error types returned by the bemgr RAD Module\&. .\" blockquote { .RS 4 .PP .nf typedef enum bemgr_BeMgrRadErrType { BBMRET_INVALID_ARG = 0, BBMRET_BE_OP_ERR = 1, BBMRET_BE_RAD_ERR = 2, } bemgr_BeMgrRadErrType_t; .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP When the bemgr RAD Module encounters an error, it will return a payload containing both an error type and an error message\&. This enum defines the possible error types\&. .RE .\" } blockquote .\" blockquote { .RS 4 .PP BBMRET_INVALID_ARG (0) \(em This error type will be raised when a method has been called with an invalid argument\&. .PP BBMRET_BE_OP_ERR (1) \(em This error type will be raised when an error occurred while performing BE management operations\&. .PP BBMRET_BE_RAD_ERR (2) \(em This error type will be raised when an error is occur in the bemgr RAD module that\'s not related to BE managent operations\&. .RE .\" } blockquote .SH "STRUCTURED TYPES" .PP \fBstruct BeMgrRadError\fR \(em Contains information about an error that occurred in the bemgr RAD Module\&. .\" blockquote { .RS 4 .PP typedef struct bemgr_BeMgrRadError bemgr_BeMgrRadError_t; .PP .nf struct bemgr_BeMgrRadError { bemgr_BeMgrRadErrType_t bbmre_errType; char *bbmre_info; }; .fi .nf .HP \w'void\ \fBbemgr_BeMgrRadError_free\fR('u .R void \fBbemgr_BeMgrRadError_free\fR(bemgr_BeMgrRadError_t\ *in); .RS .RE .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBFields:\fR .PP \fIbbmre_errType\fR \(em The error type is an enum value of BeMgrRadErrType\&. .PP \fIbbmre_info\fR \(em This field contains the error message, which is a human readable string detailing the cause of the error\&. .RE .\" } blockquote .SH "VERSION" .PP 1\&.1 .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\-bemgr 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.bemgr_1 .fi .RE