Hallo, dies ist ein Test.

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

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

'\" t .\" Title: archivemgr-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 "ARCHIVEMGR\-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" archivemgr \- API for creation of and interaction with a Solaris Unified Archive .SH "SYNOPSIS" .nf #include <rad/client/1/archivemgr\&.h> cc [ flag\&.\&.\&. ] file\&.\&.\&. \fB\-larchivemgr1_client\fR [ library\&.\&.\&. ] .fi .SS "interface ArchiveManager" .nf const char *\ \&archiveRadLogPath\ \&; (ro) .fi .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchiveManager_exit\fR('u .R rc_err_t \fBarchivemgr_ArchiveManager_exit\fR(rc_instance_t\ *inst); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchiveManager_createArchive\fR('u .R rc_err_t \fBarchivemgr_ArchiveManager_createArchive\fR(rc_instance_t\ *inst, . const\ char\ *path, . const\ char\ **zones, . int\ zones_count, . const\ char\ **excludeZones, . int\ excludeZones_count, . const\ char\ **excludeDataset, . int\ excludeDataset_count, . boolean_t\ *recovery, . boolean_t\ *skipCheck, . boolean_t\ *excludeMedia, . boolean_t\ *rootOnly, . boolean_t\ *dehydrate, . const\ char\ **dehydratedPublishers, . int\ dehydratedPublishers_count, . archivemgr_ArchiveRADError_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchiveManager_getArchive\fR('u .R rc_err_t \fBarchivemgr_ArchiveManager_getArchive\fR(rc_instance_t\ *inst, . const\ char\ *path, . const\ char\ *key, . const\ char\ *cert, . const\ char\ *cacert, . rc_instance_t\ **result, . archivemgr_ArchiveRADError_t\ **error); .RS .RE .fi .nf .HP \w'typedef\ void\ \fB(*archivemgr_ArchiveManager_ArchiveCreationProgress_cb_f)\fR('u .R typedef void \fB(*archivemgr_ArchiveManager_ArchiveCreationProgress_cb_f)\fR(rc_instance_t\ *inst, . archivemgr_ArchiveCreationProgress_t\ *payload, . struct\ timespec\ ts, . void\ *arg); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchiveManager_subscribe_ArchiveCreationProgress\fR('u .R rc_err_t \fBarchivemgr_ArchiveManager_subscribe_ArchiveCreationProgress\fR(rc_instance_t\ *inst, . archivemgr_ArchiveManager_ArchiveCreationProgress_cb_f\ cb, . void\ *arg); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchiveManager_unsubscribe_ArchiveCreationProgress\fR('u .R rc_err_t \fBarchivemgr_ArchiveManager_unsubscribe_ArchiveCreationProgress\fR(rc_instance_t\ *inst, . void\ **arg); .RS .RE .fi .nf .HP \w'typedef\ void\ \fB(*archivemgr_ArchiveManager_ArchiveCreationStatus_cb_f)\fR('u .R typedef void \fB(*archivemgr_ArchiveManager_ArchiveCreationStatus_cb_f)\fR(rc_instance_t\ *inst, . archivemgr_ArchiveCreationStatus_t\ *payload, . struct\ timespec\ ts, . void\ *arg); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchiveManager_subscribe_ArchiveCreationStatus\fR('u .R rc_err_t \fBarchivemgr_ArchiveManager_subscribe_ArchiveCreationStatus\fR(rc_instance_t\ *inst, . archivemgr_ArchiveManager_ArchiveCreationStatus_cb_f\ cb, . void\ *arg); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchiveManager_unsubscribe_ArchiveCreationStatus\fR('u .R rc_err_t \fBarchivemgr_ArchiveManager_unsubscribe_ArchiveCreationStatus\fR(rc_instance_t\ *inst, . void\ **arg); .RS .RE .fi .SS "interface UnifiedArchive" .nf const char *\ \&archiveUUID\ \&; (ro) .fi .nf archivemgr_ArchiveType_t\ \&archiveType\ \&; (ro) .fi .nf const char *\ \&archiveVersion\ \&; (ro) .fi .nf const char *\ \&creationTime\ \&; (ro) .fi .nf const char **\ \&dehydratedPublishers\ \&; (ro) .fi .nf archivemgr_ISA_t\ \&isa\ \&; (ro) .fi .nf const char *\ \&originTargetInfo\ \&; (ro) .fi .nf const char *\ \&originTargetVerboseInfo\ \&; (ro) .fi .nf const char *\ \&osName\ \&; (ro) .fi .nf const char *\ \&hostOSVersion\ \&; (ro) .fi .nf const char *\ \&hostOSBranch\ \&; (ro) .fi .nf const char *\ \&path\ \&; (ro) .fi .nf const char *\ \&sourceHost\ \&; (ro) .fi .nf const char **\ \&systems\ \&; (ro) .fi .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_getArchivedSystems\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_getArchivedSystems\fR(rc_instance_t\ *inst, . const\ char\ **systems, . int\ systems_count, . rc_instance_t\ ***result, . int\ *result_cnt, . archivemgr_ArchiveRADError_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_createMedia\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_createMedia\fR(rc_instance_t\ *inst, . const\ char\ *mediaPath, . const\ char\ *zone, . const\ char\ *source, . const\ char\ *key, . const\ char\ *cert, . const\ char\ *dataset, . archivemgr_MediaFormat_t\ *mediaFormat, . archivemgr_ArchiveRADError_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_rehydrateArchive\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_rehydrateArchive\fR(rc_instance_t\ *inst, . const\ char\ *rehydratePath, . archivemgr_ArchiveRADError_t\ **error); .RS .RE .fi .nf .HP \w'typedef\ void\ \fB(*archivemgr_UnifiedArchive_MediaCreationProgress_cb_f)\fR('u .R typedef void \fB(*archivemgr_UnifiedArchive_MediaCreationProgress_cb_f)\fR(rc_instance_t\ *inst, . archivemgr_MediaCreationProgress_t\ *payload, . struct\ timespec\ ts, . void\ *arg); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_subscribe_MediaCreationProgress\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_subscribe_MediaCreationProgress\fR(rc_instance_t\ *inst, . archivemgr_UnifiedArchive_MediaCreationProgress_cb_f\ cb, . void\ *arg); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_unsubscribe_MediaCreationProgress\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_unsubscribe_MediaCreationProgress\fR(rc_instance_t\ *inst, . void\ **arg); .RS .RE .fi .nf .HP \w'typedef\ void\ \fB(*archivemgr_UnifiedArchive_MediaCreationStatus_cb_f)\fR('u .R typedef void \fB(*archivemgr_UnifiedArchive_MediaCreationStatus_cb_f)\fR(rc_instance_t\ *inst, . archivemgr_MediaCreationStatus_t\ *payload, . struct\ timespec\ ts, . void\ *arg); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_subscribe_MediaCreationStatus\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_subscribe_MediaCreationStatus\fR(rc_instance_t\ *inst, . archivemgr_UnifiedArchive_MediaCreationStatus_cb_f\ cb, . void\ *arg); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_unsubscribe_MediaCreationStatus\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_unsubscribe_MediaCreationStatus\fR(rc_instance_t\ *inst, . void\ **arg); .RS .RE .fi .nf .HP \w'typedef\ void\ \fB(*archivemgr_UnifiedArchive_RehydrateProgress_cb_f)\fR('u .R typedef void \fB(*archivemgr_UnifiedArchive_RehydrateProgress_cb_f)\fR(rc_instance_t\ *inst, . archivemgr_RehydrateProgress_t\ *payload, . struct\ timespec\ ts, . void\ *arg); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_subscribe_RehydrateProgress\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_subscribe_RehydrateProgress\fR(rc_instance_t\ *inst, . archivemgr_UnifiedArchive_RehydrateProgress_cb_f\ cb, . void\ *arg); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_unsubscribe_RehydrateProgress\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_unsubscribe_RehydrateProgress\fR(rc_instance_t\ *inst, . void\ **arg); .RS .RE .fi .nf .HP \w'typedef\ void\ \fB(*archivemgr_UnifiedArchive_RehydrateStatus_cb_f)\fR('u .R typedef void \fB(*archivemgr_UnifiedArchive_RehydrateStatus_cb_f)\fR(rc_instance_t\ *inst, . archivemgr_RehydrateStatus_t\ *payload, . struct\ timespec\ ts, . void\ *arg); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_subscribe_RehydrateStatus\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_subscribe_RehydrateStatus\fR(rc_instance_t\ *inst, . archivemgr_UnifiedArchive_RehydrateStatus_cb_f\ cb, . void\ *arg); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_unsubscribe_RehydrateStatus\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_unsubscribe_RehydrateStatus\fR(rc_instance_t\ *inst, . void\ **arg); .RS .RE .fi .SS "interface ArchivedSystem" .nf const char *\ \&activeBE\ \&; (ro) .fi .nf const char *\ \&aiMedia\ \&; (ro) .fi .nf const char *\ \&brand\ \&; (ro) .fi .nf const char **\ \&embeddedZones\ \&; (ro) .fi .nf const char *\ \&name\ \&; (ro) .fi .nf const char *\ \&osBranch\ \&; (ro) .fi .nf const char *\ \&osVersion\ \&; (ro) .fi .nf boolean_t\ \&rootOnly\ \&; (ro) .fi .nf long long\ \&size\ \&; (ro) .fi .nf const char *\ \&systemUUID\ \&; (ro) .fi .nf const char *\ \&originTargetInfo\ \&; (ro) .fi .nf const char *\ \&originTargetVerboseInfo\ \&; (ro) .fi .SS "Enumerated Types" .PP \fBenum ArchiveRADErrType\fR .\" blockquote { .RS 4 .PP .nf typedef enum archivemgr_ArchiveRADErrType { AARADET_ARCHIVE_OPTION_ERR = 0, AARADET_INVALID_ARG_VALUE = 1, AARADET_ARCHIVE_ERR = 2, AARADET_RUNTIME_ERR = 3, AARADET_LOCKFILE_ERR = 4, } archivemgr_ArchiveRADErrType_t; .fi .RE .\" } blockquote .PP \fBenum ArchiveOpExecStatus\fR .\" blockquote { .RS 4 .PP .nf typedef enum archivemgr_ArchiveOpExecStatus { AAOES_EXEC_SUCCESSFUL = 0, AAOES_EXEC_FAILED = 1, AAOES_EXEC_CANCELED = 2, } archivemgr_ArchiveOpExecStatus_t; .fi .RE .\" } blockquote .PP \fBenum ArchiveType\fR .\" blockquote { .RS 4 .PP .nf typedef enum archivemgr_ArchiveType { AAT_RECOVERY = 0, AAT_CLONE = 1, } archivemgr_ArchiveType_t; .fi .RE .\" } blockquote .PP \fBenum ISA\fR .\" blockquote { .RS 4 .PP .nf typedef enum archivemgr_ISA { AISA_SPARC = 0, AISA_I386 = 1, } archivemgr_ISA_t; .fi .RE .\" } blockquote .PP \fBenum MediaFormat\fR .\" blockquote { .RS 4 .PP .nf typedef enum archivemgr_MediaFormat { AMF_ISO = 0, AMF_USB = 1, } archivemgr_MediaFormat_t; .fi .RE .\" } blockquote .SS "Structured Types" .PP \fBstruct ArchiveRADError\fR .\" blockquote { .RS 4 .PP typedef struct archivemgr_ArchiveRADError archivemgr_ArchiveRADError_t; .PP .nf struct archivemgr_ArchiveRADError { archivemgr_ArchiveRADErrType_t aarade_errType; char *aarade_info; }; .fi .nf .HP \w'void\ \fBarchivemgr_ArchiveRADError_free\fR('u .R void \fBarchivemgr_ArchiveRADError_free\fR(archivemgr_ArchiveRADError_t\ *in); .RS .RE .fi .RE .\" } blockquote .PP \fBstruct ArchiveCreationProgress\fR .\" blockquote { .RS 4 .PP typedef struct archivemgr_ArchiveCreationProgress archivemgr_ArchiveCreationProgress_t; .PP .nf struct archivemgr_ArchiveCreationProgress { int aacp_percent; char *aacp_message; boolean_t aacp_is_error; }; .fi .nf .HP \w'void\ \fBarchivemgr_ArchiveCreationProgress_free\fR('u .R void \fBarchivemgr_ArchiveCreationProgress_free\fR(archivemgr_ArchiveCreationProgress_t\ *in); .RS .RE .fi .RE .\" } blockquote .PP \fBstruct MediaCreationProgress\fR .\" blockquote { .RS 4 .PP typedef struct archivemgr_MediaCreationProgress archivemgr_MediaCreationProgress_t; .PP .nf struct archivemgr_MediaCreationProgress { int amcp_percent; char *amcp_message; }; .fi .nf .HP \w'void\ \fBarchivemgr_MediaCreationProgress_free\fR('u .R void \fBarchivemgr_MediaCreationProgress_free\fR(archivemgr_MediaCreationProgress_t\ *in); .RS .RE .fi .RE .\" } blockquote .PP \fBstruct RehydrateProgress\fR .\" blockquote { .RS 4 .PP typedef struct archivemgr_RehydrateProgress archivemgr_RehydrateProgress_t; .PP .nf struct archivemgr_RehydrateProgress { int arp_percent; char *arp_message; }; .fi .nf .HP \w'void\ \fBarchivemgr_RehydrateProgress_free\fR('u .R void \fBarchivemgr_RehydrateProgress_free\fR(archivemgr_RehydrateProgress_t\ *in); .RS .RE .fi .RE .\" } blockquote .PP \fBstruct ArchiveCreationStatus\fR .\" blockquote { .RS 4 .PP typedef struct archivemgr_ArchiveCreationStatus archivemgr_ArchiveCreationStatus_t; .PP .nf struct archivemgr_ArchiveCreationStatus { archivemgr_ArchiveOpExecStatus_t aacs_status; archivemgr_ArchiveRADErrType_t *aacs_errType; char *aacs_errorMessage; }; .fi .nf .HP \w'void\ \fBarchivemgr_ArchiveCreationStatus_free\fR('u .R void \fBarchivemgr_ArchiveCreationStatus_free\fR(archivemgr_ArchiveCreationStatus_t\ *in); .RS .RE .fi .RE .\" } blockquote .PP \fBstruct MediaCreationStatus\fR .\" blockquote { .RS 4 .PP typedef struct archivemgr_MediaCreationStatus archivemgr_MediaCreationStatus_t; .PP .nf struct archivemgr_MediaCreationStatus { archivemgr_ArchiveOpExecStatus_t amcs_status; archivemgr_ArchiveRADErrType_t *amcs_errType; char *amcs_errorMessage; }; .fi .nf .HP \w'void\ \fBarchivemgr_MediaCreationStatus_free\fR('u .R void \fBarchivemgr_MediaCreationStatus_free\fR(archivemgr_MediaCreationStatus_t\ *in); .RS .RE .fi .RE .\" } blockquote .PP \fBstruct RehydrateStatus\fR .\" blockquote { .RS 4 .PP typedef struct archivemgr_RehydrateStatus archivemgr_RehydrateStatus_t; .PP .nf struct archivemgr_RehydrateStatus { archivemgr_ArchiveOpExecStatus_t ars_status; archivemgr_ArchiveRADErrType_t *ars_errType; char *ars_errorMessage; }; .fi .nf .HP \w'void\ \fBarchivemgr_RehydrateStatus_free\fR('u .R void \fBarchivemgr_RehydrateStatus_free\fR(archivemgr_RehydrateStatus_t\ *in); .RS .RE .fi .RE .\" } blockquote .SH "DESCRIPTION" .PP \fBAPI com\&.oracle\&.solaris\&.rad\&.archivemgr \fR\fB\&\s-2\u[1]\d\s+2\fR .PP This API provides functionality for the creation of and interaction with a Solaris Unified Archive\&. .SH "INTERFACES" .SS "interface ArchiveManager" .PP The ArchiveManager interface is a RAD singleton, and is the main and only entry point to this RAD module\&. It provides the interfaces for creating a new Unified Archive and fetching an existing Unified Archive\&. .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBArchiveManager Properties\fR .RS 4 .PP \fB\fIconst char *\fR\fR\ \&\fBarchiveRadLogPath\fR (\fIread\-only\fR) \(em The location of the archive log that is generated by this Archive RAD Module\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchiveManager_get_archiveRadLogPath\fR('u .R rc_err_t \fBarchivemgr_ArchiveManager_get_archiveRadLogPath\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 .RE .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBArchiveManager Methods\fR .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchiveManager_exit\fR('u .R rc_err_t \fBarchivemgr_ArchiveManager_exit\fR(rc_instance_t\ *inst); .RS .RE .fi .\" blockquote { .RS 4 .PP Clear all checkpoints, clean up temporary files and exit\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchiveManager_createArchive\fR('u .R rc_err_t \fBarchivemgr_ArchiveManager_createArchive\fR(rc_instance_t\ *inst, . const\ char\ *path, . const\ char\ **zones, . int\ zones_count, . const\ char\ **excludeZones, . int\ excludeZones_count, . const\ char\ **excludeDataset, . int\ excludeDataset_count, . boolean_t\ *recovery, . boolean_t\ *skipCheck, . boolean_t\ *excludeMedia, . boolean_t\ *rootOnly, . boolean_t\ *dehydrate, . const\ char\ **dehydratedPublishers, . int\ dehydratedPublishers_count, . archivemgr_ArchiveRADError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Create a new Solaris Unified Archive with the path and options given\&. Similar to the "create" subcommand in archiveadm(8)\&. .PP Note: The createArchive method submits the requested parameters for the resulting archive, and returns immediately, without waiting for the actual archive creation to complete\&. Users should register for the "ArchiveCreationProgress" and "ArchiveCreationStatus" events to observe the state of the archive creation request\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIpath\fR \(em The location and name of the new Unified Archive\&. The path must be an absolute path\&. .PP \fIzones\fR (\fInullable\fR) \(em Optional: a list of zonenames to be archived, implicitly excluding all other systems from being archived\&. .PP \fIzones_count\fR \(em Number of items in zones array .PP \fIexcludeZones\fR (\fInullable\fR) \(em Optional: a list of zonenames to be excluded from the archive, implicitly including all other systems\&. \'zones\' and \'excludeZones\' are mutually exclusive, and \'excludeZones\' is not valid when \'recovery\' is set to True\&. .PP \fIexcludeZones_count\fR \(em Number of items in excludeZones array .PP \fIexcludeDataset\fR (\fInullable\fR) \(em Optional: a list of dataset names to be recursively excluded from the archive\&. .PP \fIexcludeDataset_count\fR \(em Number of items in excludeDataset array .PP \fIrecovery\fR (\fInullable\fR) \(em Optional: If specified, create a "recovery archive", which is suitable for system recovery\&. "recovery" by default is False\&. .PP \fIskipCheck\fR (\fInullable\fR) \(em Optional: If specified, skip the capacity check in the staging directory prior to archive stream creation\&. "skipCheck" by default is False\&. .PP \fIexcludeMedia\fR (\fInullable\fR) \(em Optional: If specified, skip the generation of bootable media for each global zone in the Unified Archive\&. "excludeMedia" by default is False\&. .PP \fIrootOnly\fR (\fInullable\fR) \(em Optional: If specified, exclude all non\-root pool data\&. Each non\-root pool is excluded recursively from the resulting archive image\&. This is useful when a root\-only archive is desired and the list of non\-root pools is not known\&. "rootOnly" by default is False\&. .PP \fIdehydrate\fR (\fInullable\fR) \(em Optional: If specified, dehydrate the publishers from the archive\&. If the publishers argument is specified only dehydrate those publishers listed\&. Otherwise by default, all publishers will be dehydrated\&. This is useful when trying to create an archive of minimal size\&. .PP \fIdehydratedPublishers\fR (\fInullable\fR) \(em Optional: Provides a list of publishers to be dehydrated\&. This option may only be used when the dehydrate option is specified\&. This is useful when trying to dehydrate select publishers from an archive\&. .PP \fIdehydratedPublishers_count\fR \(em Number of items in dehydratedPublishers array .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchiveManager_getArchive\fR('u .R rc_err_t \fBarchivemgr_ArchiveManager_getArchive\fR(rc_instance_t\ *inst, . const\ char\ *path, . const\ char\ *key, . const\ char\ *cert, . const\ char\ *cacert, . rc_instance_t\ **result, . archivemgr_ArchiveRADError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Fetch the Unified Archive that matches the path given\&. Returns a handle to a UnifiedArchive object for RAD Client programs to interact with\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIpath\fR \(em The path to the Unified Archive\&. The path must be an absolute path\&. .PP \fIkey\fR (\fInullable\fR) \(em Optional: SSL key, for use with HTTPS URIs\&. .PP \fIcert\fR (\fInullable\fR) \(em Optional: SSL cert, for use with HTTPS URIs\&. .PP \fIcacert\fR (\fInullable\fR) \(em Optional: CA cert, for use with HTTPS URIs\&. .PP \fIresult\fR \(em A UnifiedArchive object representing the Unified Archive that was just fetched\&. .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 \fBArchiveManager Retrieve\fR .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchiveManager__rad_get_name\fR('u .R rc_err_t \fBarchivemgr_ArchiveManager__rad_get_name\fR(adr_name_t\ **result, . int\ n, . \&.\&.\&.); .RS .RE .fi .\" blockquote { .RS 4 .PP Obtain RAD name of a ArchiveManager 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\ \fBarchivemgr_ArchiveManager__rad_lookup\fR('u .R rc_err_t \fBarchivemgr_ArchiveManager__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 ArchiveManager 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\ \fBarchivemgr_ArchiveManager__rad_list\fR('u .R rc_err_t \fBarchivemgr_ArchiveManager__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 ArchiveManager 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 .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBArchiveManager Events\fR .RS 4 .PP \fIArchiveCreationProgress\fR \(em Event that is dispatched during archive creation, which passes progress messages to client for consumption by user\&. .\" blockquote { .RS 4 .nf .HP \w'typedef\ void\ \fB(*archivemgr_ArchiveManager_ArchiveCreationProgress_cb_f)\fR('u .R typedef void \fB(*archivemgr_ArchiveManager_ArchiveCreationProgress_cb_f)\fR(rc_instance_t\ *inst, . archivemgr_ArchiveCreationProgress_t\ *payload, . struct\ timespec\ ts, . void\ *arg); .RS .RE .fi .\" blockquote { .RS 4 .PP Function invoked when event "ArchiveCreationProgress" occurs\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance that generated the event .PP \fIpayload\fR \(em Event payload .PP \fIts\fR \(em Time stamp .PP \fIarg\fR \(em User data: custom parameter to invoke the function with .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchiveManager_subscribe_ArchiveCreationProgress\fR('u .R rc_err_t \fBarchivemgr_ArchiveManager_subscribe_ArchiveCreationProgress\fR(rc_instance_t\ *inst, . archivemgr_ArchiveManager_ArchiveCreationProgress_cb_f\ cb, . void\ *arg); .RS .RE .fi .\" blockquote { .RS 4 .PP Subscribe to event "ArchiveCreationProgress"\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIcb\fR \(em Event callback function .PP \fIarg\fR \(em User data: custom parameter to invoke the function with .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchiveManager_unsubscribe_ArchiveCreationProgress\fR('u .R rc_err_t \fBarchivemgr_ArchiveManager_unsubscribe_ArchiveCreationProgress\fR(rc_instance_t\ *inst, . void\ **arg); .RS .RE .fi .\" blockquote { .RS 4 .PP Unsubscribe from event "ArchiveCreationProgress"\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIarg\fR \(em User data returned .RE .\" } blockquote .RE .\" } blockquote .PP \fIArchiveCreationStatus\fR \(em Event that is dispatched when archive creation operation completes\&. .\" blockquote { .RS 4 .nf .HP \w'typedef\ void\ \fB(*archivemgr_ArchiveManager_ArchiveCreationStatus_cb_f)\fR('u .R typedef void \fB(*archivemgr_ArchiveManager_ArchiveCreationStatus_cb_f)\fR(rc_instance_t\ *inst, . archivemgr_ArchiveCreationStatus_t\ *payload, . struct\ timespec\ ts, . void\ *arg); .RS .RE .fi .\" blockquote { .RS 4 .PP Function invoked when event "ArchiveCreationStatus" occurs\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance that generated the event .PP \fIpayload\fR \(em Event payload .PP \fIts\fR \(em Time stamp .PP \fIarg\fR \(em User data: custom parameter to invoke the function with .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchiveManager_subscribe_ArchiveCreationStatus\fR('u .R rc_err_t \fBarchivemgr_ArchiveManager_subscribe_ArchiveCreationStatus\fR(rc_instance_t\ *inst, . archivemgr_ArchiveManager_ArchiveCreationStatus_cb_f\ cb, . void\ *arg); .RS .RE .fi .\" blockquote { .RS 4 .PP Subscribe to event "ArchiveCreationStatus"\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIcb\fR \(em Event callback function .PP \fIarg\fR \(em User data: custom parameter to invoke the function with .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchiveManager_unsubscribe_ArchiveCreationStatus\fR('u .R rc_err_t \fBarchivemgr_ArchiveManager_unsubscribe_ArchiveCreationStatus\fR(rc_instance_t\ *inst, . void\ **arg); .RS .RE .fi .\" blockquote { .RS 4 .PP Unsubscribe from event "ArchiveCreationStatus"\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIarg\fR \(em User data returned .RE .\" } blockquote .RE .\" } blockquote .RE .SS "interface UnifiedArchive" .PP Interface describing a RAD UnifiedArchive object, which represents a Solaris Unified Archive\&. It provides the interfaces for creating bootable media from a Unified Archive, as well as interfaces for getting property information from a Unified Archive\&. .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBUnifiedArchive Properties\fR .RS 4 .PP \fB\fIconst char *\fR\fR\ \&\fBarchiveUUID\fR (\fIread\-only\fR) \(em The 128\-bit unique identifier for this Unified Archive\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_get_archiveUUID\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_get_archiveUUID\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\fIarchivemgr_ArchiveType_t\fR\fR\ \&\fBarchiveType\fR (\fIread\-only\fR) \(em The type of this Unified Archive, which is a value from the ArchiveType enum\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_get_archiveType\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_get_archiveType\fR(rc_instance_t\ *inst, . archivemgr_ArchiveType_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\ \&\fBarchiveVersion\fR (\fIread\-only\fR) \(em The version of this Unified Archive\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_get_archiveVersion\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_get_archiveVersion\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\ \&\fBcreationTime\fR (\fIread\-only\fR) \(em The creation timestamp (UTC) of this Unified Archive\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_get_creationTime\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_get_creationTime\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\ \&\fBdehydratedPublishers\fR (\fIread\-only\fR) \(em The dehydrated publishers of an archive\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_get_dehydratedPublishers\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_get_dehydratedPublishers\fR(rc_instance_t\ *inst, . char\ ***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\fIarchivemgr_ISA_t\fR\fR\ \&\fBisa\fR (\fIread\-only\fR) \(em The architecture type of the systems that are archived in this Unified Archive\&. A value from the ISA enum\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_get_isa\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_get_isa\fR(rc_instance_t\ *inst, . archivemgr_ISA_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\ \&\fBoriginTargetInfo\fR (\fIread\-only\fR) .\" blockquote { .RS 4 .PP The XML of the origin system\'s target discovery output, it is valid for an ai_manifest(5)\&. It can be used as a starting point for creating a custom ai_manifest(5) target section\&. .RE .\" } blockquote .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_get_originTargetInfo\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_get_originTargetInfo\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\ \&\fBoriginTargetVerboseInfo\fR (\fIread\-only\fR) .\" blockquote { .RS 4 .PP The XML of the origin system\'s target discovery verbose output, which includes additional disk name attributes (such as devid, devpath, etc\&.) that may be useful, but will not be valid for an ai_manifest(5)\&. .RE .\" } blockquote .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_get_originTargetVerboseInfo\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_get_originTargetVerboseInfo\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\ \&\fBosName\fR (\fIread\-only\fR) \(em Provides the Solaris release and architecture\&. e\&.g\&. \'Oracle Solaris 11\&.4 X86\'\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_get_osName\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_get_osName\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\ \&\fBhostOSVersion\fR (\fIread\-only\fR) \(em The version of Solaris installed on the host system, e\&.g\&. \'11\&.4\'\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_get_hostOSVersion\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_get_hostOSVersion\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\ \&\fBhostOSBranch\fR (\fIread\-only\fR) \(em The os branch of osnet\-incorporation installed on the host system, e\&.g\&. \'11\&.4\&.0\&.0\&.0\&.100\&.0\'\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_get_hostOSBranch\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_get_hostOSBranch\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\ \&\fBpath\fR (\fIread\-only\fR) \(em Path to this Unified Archive (URI)\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_get_path\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_get_path\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\ \&\fBsourceHost\fR (\fIread\-only\fR) \(em The host name of the origin archived system\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_get_sourceHost\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_get_sourceHost\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\ \&\fBsystems\fR (\fIread\-only\fR) \(em The deployable archived systems contained in this Unified Archive\&. The output is a list of strings of system names\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_get_systems\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_get_systems\fR(rc_instance_t\ *inst, . char\ ***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 .RE .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBUnifiedArchive Methods\fR .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_getArchivedSystems\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_getArchivedSystems\fR(rc_instance_t\ *inst, . const\ char\ **systems, . int\ systems_count, . rc_instance_t\ ***result, . int\ *result_cnt, . archivemgr_ArchiveRADError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Get a list of the deployable systems contained in this Unified Archive\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIsystems\fR (\fInullable\fR) \(em Optional: a list of system names to query from the Unified Archive\&. If the user does not specify any systems, all the systems contained in the archive will be returned\&. .PP \fIsystems_count\fR \(em Number of items in systems array .PP \fIresult\fR \(em List of ArchivedSystem objects\&. .PP \fIresult_cnt\fR \(em Number of items in result array .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_createMedia\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_createMedia\fR(rc_instance_t\ *inst, . const\ char\ *mediaPath, . const\ char\ *zone, . const\ char\ *source, . const\ char\ *key, . const\ char\ *cert, . const\ char\ *dataset, . archivemgr_MediaFormat_t\ *mediaFormat, . archivemgr_ArchiveRADError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Create bootable media from a Solaris Unified Archive\&. Similar to the "create\-media" subcommand in archiveadm(8)\&. .PP Note: The createMedia method submits the requested parameters for the resulting media, and returns immediately, without waiting for the actual media creation to complete\&. Users should register for the "MediaCreationProgress" and "MediaCreationStatus" events to observe the state of the media creation request\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fImediaPath\fR \(em The name of the resulting media image file\&. The mediaPath must be an absolute path\&. .PP \fIzone\fR (\fInullable\fR) \(em Optional: selects the global zone from which media is created\&. If not specified, the host global zone is used\&. .PP \fIsource\fR (\fInullable\fR) \(em Optional: provides a source for an AI image\&. Valid sources are either a path to a compatible Solaris Automated Install ISO image file or the URI of a Solaris IPS repository which contains a compatible pkg:/install\-image/solaris\-auto\-install package\&. Compatibility is based upon the version of Solaris\&. If source is not specified, all IPS publishers which are set on the system for which media is being created will be searched for a compatible version of the solaris\-auto\-install package\&. .PP \fIkey\fR (\fInullable\fR) \(em Optional: SSL key, this argument is used to pass HTTPS credentials to the source when the source provided is an HTTPS URI\&. .PP \fIcert\fR (\fInullable\fR) \(em Optional: SSL cert, this argument is used to pass HTTPS credentials to the source when the source provided is an HTTPS URI\&. .PP \fIdataset\fR (\fInullable\fR) \(em Optional: provides a ZFS dataset to be used as a staging area for media creation\&. If this is not passed, a default staging area on rpool is used\&. The staging area will be cleaned up and removed at the end of media creation\&. .PP \fImediaFormat\fR (\fInullable\fR) \(em Optional: a value from the MediaFormat enum, selects the format of the resulting bootable media, either ISO or USB image file\&. If not specified, the USB format is used\&. If the resulting media image will be larger than 4GB, only the USB format is supported\&. .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_rehydrateArchive\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_rehydrateArchive\fR(rc_instance_t\ *inst, . const\ char\ *rehydratePath, . archivemgr_ArchiveRADError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Create a rehydrated Solaris Unified Archive from a dehydrated Solaris Unified Archive\&. .PP Note: The rehydrateArchive method submits the requested parameters for the resulting rehydrated archive, and returns immediately, without waiting for the actual rehydration to complete\&. Users should register for the "RehydrateProgress" and "RehydrateStatus" events to observe the state of the rehydrate request\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIrehydratePath\fR \(em The name of the resulting rehydrated Solaris Unified Archive\&. The rehydratePath must be an absolute path\&. .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 \fBUnifiedArchive Retrieve\fR .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive__rad_get_name\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive__rad_get_name\fR(adr_name_t\ **result, . int\ n, . \&.\&.\&.); .RS .RE .fi .\" blockquote { .RS 4 .PP Obtain RAD name of a UnifiedArchive 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\ \fBarchivemgr_UnifiedArchive__rad_lookup\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive__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 UnifiedArchive 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\ \fBarchivemgr_UnifiedArchive__rad_list\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive__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 UnifiedArchive 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 .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBUnifiedArchive Events\fR .RS 4 .PP \fIMediaCreationProgress\fR \(em Event that is dispatched during archive media creation, which passes progress messages to client for consumption by user\&. .\" blockquote { .RS 4 .nf .HP \w'typedef\ void\ \fB(*archivemgr_UnifiedArchive_MediaCreationProgress_cb_f)\fR('u .R typedef void \fB(*archivemgr_UnifiedArchive_MediaCreationProgress_cb_f)\fR(rc_instance_t\ *inst, . archivemgr_MediaCreationProgress_t\ *payload, . struct\ timespec\ ts, . void\ *arg); .RS .RE .fi .\" blockquote { .RS 4 .PP Function invoked when event "MediaCreationProgress" occurs\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance that generated the event .PP \fIpayload\fR \(em Event payload .PP \fIts\fR \(em Time stamp .PP \fIarg\fR \(em User data: custom parameter to invoke the function with .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_subscribe_MediaCreationProgress\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_subscribe_MediaCreationProgress\fR(rc_instance_t\ *inst, . archivemgr_UnifiedArchive_MediaCreationProgress_cb_f\ cb, . void\ *arg); .RS .RE .fi .\" blockquote { .RS 4 .PP Subscribe to event "MediaCreationProgress"\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIcb\fR \(em Event callback function .PP \fIarg\fR \(em User data: custom parameter to invoke the function with .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_unsubscribe_MediaCreationProgress\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_unsubscribe_MediaCreationProgress\fR(rc_instance_t\ *inst, . void\ **arg); .RS .RE .fi .\" blockquote { .RS 4 .PP Unsubscribe from event "MediaCreationProgress"\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIarg\fR \(em User data returned .RE .\" } blockquote .RE .\" } blockquote .PP \fIMediaCreationStatus\fR \(em Event that is dispatched when media creation operation completes\&. .\" blockquote { .RS 4 .nf .HP \w'typedef\ void\ \fB(*archivemgr_UnifiedArchive_MediaCreationStatus_cb_f)\fR('u .R typedef void \fB(*archivemgr_UnifiedArchive_MediaCreationStatus_cb_f)\fR(rc_instance_t\ *inst, . archivemgr_MediaCreationStatus_t\ *payload, . struct\ timespec\ ts, . void\ *arg); .RS .RE .fi .\" blockquote { .RS 4 .PP Function invoked when event "MediaCreationStatus" occurs\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance that generated the event .PP \fIpayload\fR \(em Event payload .PP \fIts\fR \(em Time stamp .PP \fIarg\fR \(em User data: custom parameter to invoke the function with .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_subscribe_MediaCreationStatus\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_subscribe_MediaCreationStatus\fR(rc_instance_t\ *inst, . archivemgr_UnifiedArchive_MediaCreationStatus_cb_f\ cb, . void\ *arg); .RS .RE .fi .\" blockquote { .RS 4 .PP Subscribe to event "MediaCreationStatus"\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIcb\fR \(em Event callback function .PP \fIarg\fR \(em User data: custom parameter to invoke the function with .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_unsubscribe_MediaCreationStatus\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_unsubscribe_MediaCreationStatus\fR(rc_instance_t\ *inst, . void\ **arg); .RS .RE .fi .\" blockquote { .RS 4 .PP Unsubscribe from event "MediaCreationStatus"\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIarg\fR \(em User data returned .RE .\" } blockquote .RE .\" } blockquote .PP \fIRehydrateProgress\fR \(em Event that is dispatched during archive rehydrate, which passes progress messages to client for consumption by user\&. .\" blockquote { .RS 4 .nf .HP \w'typedef\ void\ \fB(*archivemgr_UnifiedArchive_RehydrateProgress_cb_f)\fR('u .R typedef void \fB(*archivemgr_UnifiedArchive_RehydrateProgress_cb_f)\fR(rc_instance_t\ *inst, . archivemgr_RehydrateProgress_t\ *payload, . struct\ timespec\ ts, . void\ *arg); .RS .RE .fi .\" blockquote { .RS 4 .PP Function invoked when event "RehydrateProgress" occurs\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance that generated the event .PP \fIpayload\fR \(em Event payload .PP \fIts\fR \(em Time stamp .PP \fIarg\fR \(em User data: custom parameter to invoke the function with .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_subscribe_RehydrateProgress\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_subscribe_RehydrateProgress\fR(rc_instance_t\ *inst, . archivemgr_UnifiedArchive_RehydrateProgress_cb_f\ cb, . void\ *arg); .RS .RE .fi .\" blockquote { .RS 4 .PP Subscribe to event "RehydrateProgress"\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIcb\fR \(em Event callback function .PP \fIarg\fR \(em User data: custom parameter to invoke the function with .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_unsubscribe_RehydrateProgress\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_unsubscribe_RehydrateProgress\fR(rc_instance_t\ *inst, . void\ **arg); .RS .RE .fi .\" blockquote { .RS 4 .PP Unsubscribe from event "RehydrateProgress"\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIarg\fR \(em User data returned .RE .\" } blockquote .RE .\" } blockquote .PP \fIRehydrateStatus\fR \(em Event that is dispatched when the rehydrate operation completes\&. .\" blockquote { .RS 4 .nf .HP \w'typedef\ void\ \fB(*archivemgr_UnifiedArchive_RehydrateStatus_cb_f)\fR('u .R typedef void \fB(*archivemgr_UnifiedArchive_RehydrateStatus_cb_f)\fR(rc_instance_t\ *inst, . archivemgr_RehydrateStatus_t\ *payload, . struct\ timespec\ ts, . void\ *arg); .RS .RE .fi .\" blockquote { .RS 4 .PP Function invoked when event "RehydrateStatus" occurs\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance that generated the event .PP \fIpayload\fR \(em Event payload .PP \fIts\fR \(em Time stamp .PP \fIarg\fR \(em User data: custom parameter to invoke the function with .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_subscribe_RehydrateStatus\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_subscribe_RehydrateStatus\fR(rc_instance_t\ *inst, . archivemgr_UnifiedArchive_RehydrateStatus_cb_f\ cb, . void\ *arg); .RS .RE .fi .\" blockquote { .RS 4 .PP Subscribe to event "RehydrateStatus"\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIcb\fR \(em Event callback function .PP \fIarg\fR \(em User data: custom parameter to invoke the function with .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBarchivemgr_UnifiedArchive_unsubscribe_RehydrateStatus\fR('u .R rc_err_t \fBarchivemgr_UnifiedArchive_unsubscribe_RehydrateStatus\fR(rc_instance_t\ *inst, . void\ **arg); .RS .RE .fi .\" blockquote { .RS 4 .PP Unsubscribe from event "RehydrateStatus"\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIarg\fR \(em User data returned .RE .\" } blockquote .RE .\" } blockquote .RE .SS "interface ArchivedSystem" .PP Interface describing a RAD ArchivedSystem object, which represents a single deployable system contained in the Unified Archive\&. Information about the deployable system\'s properties can be accessed\&. .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBArchivedSystem Properties\fR .RS 4 .PP \fB\fIconst char *\fR\fR\ \&\fBactiveBE\fR (\fIread\-only\fR) \(em The name of the active boot environment on this system\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchivedSystem_get_activeBE\fR('u .R rc_err_t \fBarchivemgr_ArchivedSystem_get_activeBE\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\ \&\fBaiMedia\fR (\fIread\-only\fR) \(em The name of the AI media associated with this archived system\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchivedSystem_get_aiMedia\fR('u .R rc_err_t \fBarchivemgr_ArchivedSystem_get_aiMedia\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\ \&\fBbrand\fR (\fIread\-only\fR) \(em The brand of the zone that is archived, e\&.g\&. solaris\-kz\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchivedSystem_get_brand\fR('u .R rc_err_t \fBarchivemgr_ArchivedSystem_get_brand\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\ \&\fBembeddedZones\fR (\fIread\-only\fR, \fInullable\fR) \(em The list of zones that are embedded in this system\&. The output is a list of zones or None if there are no embedded zones\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchivedSystem_get_embeddedZones\fR('u .R rc_err_t \fBarchivemgr_ArchivedSystem_get_embeddedZones\fR(rc_instance_t\ *inst, . char\ ***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\ \&\fBname\fR (\fIread\-only\fR) \(em The name of this system\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchivedSystem_get_name\fR('u .R rc_err_t \fBarchivemgr_ArchivedSystem_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\ \&\fBosBranch\fR (\fIread\-only\fR) \(em The os branch of osnet\-incorporation, e\&.g\&. \'11\&.4\&.0\&.0\&.0\&.55\&.0\'\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchivedSystem_get_osBranch\fR('u .R rc_err_t \fBarchivemgr_ArchivedSystem_get_osBranch\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\ \&\fBosVersion\fR (\fIread\-only\fR) \(em The version of Solaris installed on this system, e\&.g\&. \'11\&.4\'\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchivedSystem_get_osVersion\fR('u .R rc_err_t \fBarchivemgr_ArchivedSystem_get_osVersion\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\ \&\fBrootOnly\fR (\fIread\-only\fR) \(em True if this system contains only root data; Otherwise False\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchivedSystem_get_rootOnly\fR('u .R rc_err_t \fBarchivemgr_ArchivedSystem_get_rootOnly\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\fIlong long\fR\fR\ \&\fBsize\fR (\fIread\-only\fR) \(em The size needed to deploy this system, byte\-count output\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchivedSystem_get_size\fR('u .R rc_err_t \fBarchivemgr_ArchivedSystem_get_size\fR(rc_instance_t\ *inst, . 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 char *\fR\fR\ \&\fBsystemUUID\fR (\fIread\-only\fR) \(em The 128\-bit unique identifier for this system\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchivedSystem_get_systemUUID\fR('u .R rc_err_t \fBarchivemgr_ArchivedSystem_get_systemUUID\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\ \&\fBoriginTargetInfo\fR (\fIread\-only\fR) .\" blockquote { .RS 4 .PP The XML of the system\'s target discovery output, it is valid for an ai_manifest(5)\&. It can be used as a starting point for creating a custom ai_manifest(5) target section\&. .RE .\" } blockquote .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchivedSystem_get_originTargetInfo\fR('u .R rc_err_t \fBarchivemgr_ArchivedSystem_get_originTargetInfo\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\ \&\fBoriginTargetVerboseInfo\fR (\fIread\-only\fR) .\" blockquote { .RS 4 .PP The XML of the system\'s target discovery verbose output, which may include additional disk name attributes (such as devid, devpath, etc\&.) that might be useful, but will not be valid for an ai_manifest(5)\&. .RE .\" } blockquote .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchivedSystem_get_originTargetVerboseInfo\fR('u .R rc_err_t \fBarchivemgr_ArchivedSystem_get_originTargetVerboseInfo\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 .RE .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBArchivedSystem Retrieve\fR .RS 4 .nf .HP \w'rc_err_t\ \fBarchivemgr_ArchivedSystem__rad_get_name\fR('u .R rc_err_t \fBarchivemgr_ArchivedSystem__rad_get_name\fR(adr_name_t\ **result, . int\ n, . \&.\&.\&.); .RS .RE .fi .\" blockquote { .RS 4 .PP Obtain RAD name of a ArchivedSystem 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\ \fBarchivemgr_ArchivedSystem__rad_lookup\fR('u .R rc_err_t \fBarchivemgr_ArchivedSystem__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 ArchivedSystem 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\ \fBarchivemgr_ArchivedSystem__rad_list\fR('u .R rc_err_t \fBarchivemgr_ArchivedSystem__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 ArchivedSystem 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 ArchiveRADErrType\fR \(em Possible error types returned by the Archive RAD Module\&. .\" blockquote { .RS 4 .PP .nf typedef enum archivemgr_ArchiveRADErrType { AARADET_ARCHIVE_OPTION_ERR = 0, AARADET_INVALID_ARG_VALUE = 1, AARADET_ARCHIVE_ERR = 2, AARADET_RUNTIME_ERR = 3, AARADET_LOCKFILE_ERR = 4, } archivemgr_ArchiveRADErrType_t; .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP When the Archive 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 AARADET_ARCHIVE_OPTION_ERR (0) \(em This error type will be raised when a user specified invalid or conflicting options\&. .PP AARADET_INVALID_ARG_VALUE (1) \(em This error type will be raised when a method has been called with an invalid argument\&. .PP AARADET_ARCHIVE_ERR (2) \(em This error type represents a general exception raised by the archive library\&. .PP AARADET_RUNTIME_ERR (3) \(em This error type will be raised when an error is detected that does not fall in any of the other categories\&. .PP AARADET_LOCKFILE_ERR (4) \(em This error type will be raised when the Lockfile is unable to acquire a lock\&. .RE .\" } blockquote .PP \fBenum ArchiveOpExecStatus\fR \(em Indicates the execution status of an archive operation\&. .\" blockquote { .RS 4 .PP .nf typedef enum archivemgr_ArchiveOpExecStatus { AAOES_EXEC_SUCCESSFUL = 0, AAOES_EXEC_FAILED = 1, AAOES_EXEC_CANCELED = 2, } archivemgr_ArchiveOpExecStatus_t; .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP AAOES_EXEC_SUCCESSFUL (0) \(em The archive operation has executed successfully\&. .PP AAOES_EXEC_FAILED (1) \(em The archive operation execution has failed\&. .PP AAOES_EXEC_CANCELED (2) \(em The archive operation execution has been canceled\&. .RE .\" } blockquote .PP \fBenum ArchiveType\fR \(em The type of a Unified Archive\&. .\" blockquote { .RS 4 .PP .nf typedef enum archivemgr_ArchiveType { AAT_RECOVERY = 0, AAT_CLONE = 1, } archivemgr_ArchiveType_t; .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP AAT_RECOVERY (0) .PP AAT_CLONE (1) .RE .\" } blockquote .PP \fBenum ISA\fR \(em The architecture type of the systems that are archived in a Unified Archive\&. .\" blockquote { .RS 4 .PP .nf typedef enum archivemgr_ISA { AISA_SPARC = 0, AISA_I386 = 1, } archivemgr_ISA_t; .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP AISA_SPARC (0) .PP AISA_I386 (1) .RE .\" } blockquote .PP \fBenum MediaFormat\fR \(em The format of a bootable media\&. .\" blockquote { .RS 4 .PP .nf typedef enum archivemgr_MediaFormat { AMF_ISO = 0, AMF_USB = 1, } archivemgr_MediaFormat_t; .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP AMF_ISO (0) .PP AMF_USB (1) .RE .\" } blockquote .SH "STRUCTURED TYPES" .PP \fBstruct ArchiveRADError\fR \(em Contains information about an error that occurred in the Archive RAD Module\&. .\" blockquote { .RS 4 .PP typedef struct archivemgr_ArchiveRADError archivemgr_ArchiveRADError_t; .PP .nf struct archivemgr_ArchiveRADError { archivemgr_ArchiveRADErrType_t aarade_errType; char *aarade_info; }; .fi .nf .HP \w'void\ \fBarchivemgr_ArchiveRADError_free\fR('u .R void \fBarchivemgr_ArchiveRADError_free\fR(archivemgr_ArchiveRADError_t\ *in); .RS .RE .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBFields:\fR .PP \fIaarade_errType\fR \(em The error type is an enum value of ArchiveRADErrType\&. .PP \fIaarade_info\fR \(em This field contains the error message, which is a human readable string detailing the cause of the error\&. .RE .\" } blockquote .PP \fBstruct ArchiveCreationProgress\fR \(em Event that is dispatched whenever there is a progress message to be passed to the client during archive creation\&. .\" blockquote { .RS 4 .PP typedef struct archivemgr_ArchiveCreationProgress archivemgr_ArchiveCreationProgress_t; .PP .nf struct archivemgr_ArchiveCreationProgress { int aacp_percent; char *aacp_message; boolean_t aacp_is_error; }; .fi .nf .HP \w'void\ \fBarchivemgr_ArchiveCreationProgress_free\fR('u .R void \fBarchivemgr_ArchiveCreationProgress_free\fR(archivemgr_ArchiveCreationProgress_t\ *in); .RS .RE .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBFields:\fR .PP \fIaacp_percent\fR \(em The percentage integer describing the current progress status of an archive creation\&. .PP \fIaacp_message\fR \(em The progress message\&. .PP \fIaacp_is_error\fR \(em Information if this message should be logged to stderr\&. .RE .\" } blockquote .PP \fBstruct MediaCreationProgress\fR \(em Event that is dispatched whenever there is a progress message to be passed to the client during media creation\&. .\" blockquote { .RS 4 .PP typedef struct archivemgr_MediaCreationProgress archivemgr_MediaCreationProgress_t; .PP .nf struct archivemgr_MediaCreationProgress { int amcp_percent; char *amcp_message; }; .fi .nf .HP \w'void\ \fBarchivemgr_MediaCreationProgress_free\fR('u .R void \fBarchivemgr_MediaCreationProgress_free\fR(archivemgr_MediaCreationProgress_t\ *in); .RS .RE .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBFields:\fR .PP \fIamcp_percent\fR \(em The percentage integer describing the current progress status of a media creation\&. .PP \fIamcp_message\fR \(em The progress message\&. .RE .\" } blockquote .PP \fBstruct RehydrateProgress\fR \(em Event that is dispatched whenever there is a progress message to be passed to the client during rehydration\&. .\" blockquote { .RS 4 .PP typedef struct archivemgr_RehydrateProgress archivemgr_RehydrateProgress_t; .PP .nf struct archivemgr_RehydrateProgress { int arp_percent; char *arp_message; }; .fi .nf .HP \w'void\ \fBarchivemgr_RehydrateProgress_free\fR('u .R void \fBarchivemgr_RehydrateProgress_free\fR(archivemgr_RehydrateProgress_t\ *in); .RS .RE .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBFields:\fR .PP \fIarp_percent\fR \(em The percentage integer describing the current progress status of rehydration\&. .PP \fIarp_message\fR \(em The progress message\&. .RE .\" } blockquote .PP \fBstruct ArchiveCreationStatus\fR \(em Event that is dispatched when the long running archive creation operation completes\&. Return the status of the operation\&. .\" blockquote { .RS 4 .PP typedef struct archivemgr_ArchiveCreationStatus archivemgr_ArchiveCreationStatus_t; .PP .nf struct archivemgr_ArchiveCreationStatus { archivemgr_ArchiveOpExecStatus_t aacs_status; archivemgr_ArchiveRADErrType_t *aacs_errType; char *aacs_errorMessage; }; .fi .nf .HP \w'void\ \fBarchivemgr_ArchiveCreationStatus_free\fR('u .R void \fBarchivemgr_ArchiveCreationStatus_free\fR(archivemgr_ArchiveCreationStatus_t\ *in); .RS .RE .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBFields:\fR .PP \fIaacs_status\fR .\" blockquote { .RS 4 .PP The archive creation operation status, indicates whether the operation is "EXEC_SUCCESSFUL", "EXEC_FAILED" or "EXEC_CANCELED"\&. The status is an enum value of ArchiveOpExecStatus\&. .RE .\" } blockquote .PP \fIaacs_errType\fR \(em This field is used if the status is "EXEC_FAILED"\&. The error type is an enum value of ArchiveRADErrType\&. .PP \fIaacs_errorMessage\fR \(em This field is used if the status is "EXEC_FAILED"\&. This field contains the message that describes the reason for the failure\&. .RE .\" } blockquote .PP \fBstruct MediaCreationStatus\fR \(em Event that is dispatched when the long running media creation operation completes\&. Return the status of the operation\&. .\" blockquote { .RS 4 .PP typedef struct archivemgr_MediaCreationStatus archivemgr_MediaCreationStatus_t; .PP .nf struct archivemgr_MediaCreationStatus { archivemgr_ArchiveOpExecStatus_t amcs_status; archivemgr_ArchiveRADErrType_t *amcs_errType; char *amcs_errorMessage; }; .fi .nf .HP \w'void\ \fBarchivemgr_MediaCreationStatus_free\fR('u .R void \fBarchivemgr_MediaCreationStatus_free\fR(archivemgr_MediaCreationStatus_t\ *in); .RS .RE .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBFields:\fR .PP \fIamcs_status\fR .\" blockquote { .RS 4 .PP The archive media creation operation status, indicates whether the operation is "EXEC_SUCCESSFUL", "EXEC_FAILED" or "EXEC_CANCELED"\&. The status is an enum value of ArchiveOpExecStatus\&. .RE .\" } blockquote .PP \fIamcs_errType\fR \(em This field is used if the status is "EXEC_FAILED"\&. The error type is an enum value of ArchiveRADErrType\&. .PP \fIamcs_errorMessage\fR \(em This field is used if the status is "EXEC_FAILED"\&. This field contains the message that describes the reason for the failure\&. .RE .\" } blockquote .PP \fBstruct RehydrateStatus\fR \(em Event that is dispatched when the long running rehydrate operation completes\&. Return the status of the operation\&. .\" blockquote { .RS 4 .PP typedef struct archivemgr_RehydrateStatus archivemgr_RehydrateStatus_t; .PP .nf struct archivemgr_RehydrateStatus { archivemgr_ArchiveOpExecStatus_t ars_status; archivemgr_ArchiveRADErrType_t *ars_errType; char *ars_errorMessage; }; .fi .nf .HP \w'void\ \fBarchivemgr_RehydrateStatus_free\fR('u .R void \fBarchivemgr_RehydrateStatus_free\fR(archivemgr_RehydrateStatus_t\ *in); .RS .RE .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBFields:\fR .PP \fIars_status\fR .\" blockquote { .RS 4 .PP The archive rehydrate operation status, indicates whether the operation is "EXEC_SUCCESSFUL", "EXEC_FAILED" or "EXEC_CANCELED"\&. The status is an enum value of ArchiveOpExecStatus\&. .RE .\" } blockquote .PP \fIars_errType\fR \(em This field is used if the status is "EXEC_FAILED"\&. The error type is an enum value of ArchiveRADErrType\&. .PP \fIars_errorMessage\fR \(em This field is used if the status is "EXEC_FAILED"\&. This field contains the message that describes the reason for the failure\&. .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\-archivemgr 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.archivemgr_1 .fi .RE