Hallo, dies ist ein Test.

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

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

'\" t .\" Title: ips-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 "IPS\-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" ips \- API for pkg operations in IPS .SH "SYNOPSIS" .nf #include <rad/client/1/ips\&.h> cc [ flag\&.\&.\&. ] file\&.\&.\&. \fB\-lips1_client\fR [ library\&.\&.\&. ] .fi .SS "interface PkgSource" .nf const char *\ \&URI\ \&; (ro) .fi .nf const char *\ \&type\ \&; (ro) .fi .nf const char *\ \&status\ \&; (ro) .fi .nf const char **\ \&proxies\ \&; (ro) .fi .nf const char *\ \&cert_effective_date\ \&; (ro) .fi .nf const char *\ \&cert_expiration_date\ \&; (ro) .fi .nf const char *\ \&SSL_key\ \&; (ro) .fi .nf const char *\ \&SSL_cert\ \&; (ro) .fi .SS "interface PkgPublisher" .nf const char *\ \&prefix\ \&; (ro) .fi .nf const char *\ \&alias\ \&; (ro) .fi .nf const char *\ \&client_UUID\ \&; (ro) .fi .nf const char *\ \&cat_updated_time\ \&; (ro) .fi .nf const char *\ \&enabled\ \&; (ro) .fi .nf const char *\ \&sticky\ \&; (ro) .fi .nf const char *\ \&syspub\ \&; (ro) .fi .nf const rc_instance_t **\ \&mirrors\ \&; (ro) .fi .nf const rc_instance_t **\ \&origins\ \&; (ro) .fi .nf ips_PkgProperty_t **\ \&properties\ \&; (ro) .fi .nf const char **\ \&approved_CAs\ \&; (ro) .fi .nf const char **\ \&revoked_CAs\ \&; (ro) .fi .SS "interface PkgFmri" .nf .HP \w'rc_err_t\ \fBips_PkgFmri_get_name\fR('u .R rc_err_t \fBips_PkgFmri_get_name\fR(rc_instance_t\ *inst, . char\ **result); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBips_PkgFmri_get_publisher\fR('u .R rc_err_t \fBips_PkgFmri_get_publisher\fR(rc_instance_t\ *inst, . char\ **result); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBips_PkgFmri_get_pkg_stem\fR('u .R rc_err_t \fBips_PkgFmri_get_pkg_stem\fR(rc_instance_t\ *inst, . boolean_t\ *no_publisher, . boolean_t\ *include_scheme, . char\ **result); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBips_PkgFmri_get_fmri\fR('u .R rc_err_t \fBips_PkgFmri_get_fmri\fR(rc_instance_t\ *inst, . const\ char\ *default_publisher, . boolean_t\ *no_publisher, . boolean_t\ *include_scheme, . boolean_t\ *include_build, . boolean_t\ *include_timestamp, . char\ **result); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBips_PkgFmri_get_version\fR('u .R rc_err_t \fBips_PkgFmri_get_version\fR(rc_instance_t\ *inst, . char\ **result); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBips_PkgFmri_get_timestamp\fR('u .R rc_err_t \fBips_PkgFmri_get_timestamp\fR(rc_instance_t\ *inst, . char\ **result); .RS .RE .fi .SS "interface PkgInfo" .nf const char *\ \&pkg_name\ \&; (ro) .fi .nf const char *\ \&summary\ \&; (ro) .fi .nf const char *\ \&description\ \&; (ro) .fi .nf const char *\ \&category\ \&; (ro) .fi .nf const char *\ \&state\ \&; (ro) .fi .nf const char *\ \&renamed_to\ \&; (ro) .fi .nf const char *\ \&publisher\ \&; (ro) .fi .nf const char *\ \&last_install_time\ \&; (ro) .fi .nf const char *\ \&last_update_time\ \&; (ro) .fi .nf const char *\ \&size\ \&; (ro) .fi .nf const rc_instance_t *\ \&fmri\ \&; (ro) .fi .nf const char **\ \&licenses\ \&; (ro) .fi .SS "interface PkgImage" .nf const char *\ \&image_path\ \&; (ro) .fi .nf const char *\ \&mode\ \&; (rw) .fi .nf float\ \&progress_interval\ \&; (rw) .fi .nf .HP \w'rc_err_t\ \fBips_PkgImage_list_packages\fR('u .R rc_err_t \fBips_PkgImage_list_packages\fR(rc_instance_t\ *inst, . const\ char\ **pkg_fmri_patterns, . int\ pkg_fmri_patterns_count, . boolean_t\ *refresh_catalogs, . const\ char\ **origins, . int\ origins_count, . boolean_t\ *list_installed_newest, . boolean_t\ *list_all, . boolean_t\ *list_newest, . boolean_t\ *list_upgradable, . const\ char\ *mode, . rc_instance_t\ ***result, . int\ *result_cnt, . ips_PkgError_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBips_PkgImage_install\fR('u .R rc_err_t \fBips_PkgImage_install\fR(rc_instance_t\ *inst, . const\ char\ **pkg_fmri_patterns, . int\ pkg_fmri_patterns_count, . const\ char\ *backup_be_name, . const\ char\ *be_name, . boolean_t\ *deny_new_be, . boolean_t\ *no_backup_be, . boolean_t\ *be_activate, . boolean_t\ *require_backup_be, . boolean_t\ *require_new_be, . int\ *concurrency, . boolean_t\ *accept, . boolean_t\ *show_licenses, . const\ char\ **reject_pats, . int\ reject_pats_count, . boolean_t\ *update_index, . boolean_t\ *refresh_catalogs, . boolean_t\ *noexecute, . int\ *parsable_version, . const\ char\ **origins, . int\ origins_count, . boolean_t\ *li_erecurse_all, . const\ char\ **li_erecurse_list, . int\ li_erecurse_list_count, . const\ char\ **li_erecurse_excl, . int\ li_erecurse_excl_count, . boolean_t\ *sync_act, . int\ *act_timeout, . const\ char\ *mode, . ips_PkgReturn_t\ **result, . ips_PkgError_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBips_PkgImage_exact_install\fR('u .R rc_err_t \fBips_PkgImage_exact_install\fR(rc_instance_t\ *inst, . const\ char\ **pkg_fmri_patterns, . int\ pkg_fmri_patterns_count, . const\ char\ *backup_be_name, . const\ char\ *be_name, . boolean_t\ *deny_new_be, . boolean_t\ *no_backup_be, . boolean_t\ *be_activate, . boolean_t\ *require_backup_be, . boolean_t\ *require_new_be, . int\ *concurrency, . boolean_t\ *accept, . boolean_t\ *show_licenses, . const\ char\ **reject_pats, . int\ reject_pats_count, . boolean_t\ *update_index, . boolean_t\ *refresh_catalogs, . boolean_t\ *noexecute, . int\ *parsable_version, . const\ char\ **origins, . int\ origins_count, . const\ char\ *mode, . ips_PkgReturn_t\ **result, . ips_PkgError_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBips_PkgImage_update\fR('u .R rc_err_t \fBips_PkgImage_update\fR(rc_instance_t\ *inst, . const\ char\ **pkg_fmri_patterns, . int\ pkg_fmri_patterns_count, . const\ char\ *backup_be_name, . const\ char\ *be_name, . boolean_t\ *deny_new_be, . boolean_t\ *no_backup_be, . boolean_t\ *be_activate, . boolean_t\ *require_backup_be, . boolean_t\ *require_new_be, . int\ *concurrency, . boolean_t\ *accept, . boolean_t\ *show_licenses, . const\ char\ **reject_pats, . int\ reject_pats_count, . boolean_t\ *update_index, . boolean_t\ *refresh_catalogs, . boolean_t\ *noexecute, . int\ *parsable_version, . const\ char\ **origins, . int\ origins_count, . boolean_t\ *li_erecurse_all, . const\ char\ **li_erecurse_list, . int\ li_erecurse_list_count, . const\ char\ **li_erecurse_excl, . int\ li_erecurse_excl_count, . boolean_t\ *sync_act, . int\ *act_timeout, . boolean_t\ *ignore_missing, . boolean_t\ *force, . const\ char\ *mode, . ips_PkgReturn_t\ **result, . ips_PkgError_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBips_PkgImage_uninstall\fR('u .R rc_err_t \fBips_PkgImage_uninstall\fR(rc_instance_t\ *inst, . const\ char\ **pkg_fmri_patterns, . int\ pkg_fmri_patterns_count, . const\ char\ *backup_be_name, . const\ char\ *be_name, . boolean_t\ *deny_new_be, . boolean_t\ *no_backup_be, . boolean_t\ *be_activate, . boolean_t\ *require_backup_be, . boolean_t\ *require_new_be, . int\ *concurrency, . boolean_t\ *update_index, . boolean_t\ *refresh_catalogs, . boolean_t\ *noexecute, . int\ *parsable_version, . boolean_t\ *li_erecurse_all, . const\ char\ **li_erecurse_list, . int\ li_erecurse_list_count, . const\ char\ **li_erecurse_excl, . int\ li_erecurse_excl_count, . boolean_t\ *sync_act, . int\ *act_timeout, . boolean_t\ *ignore_missing, . const\ char\ *mode, . ips_PkgReturn_t\ **result, . ips_PkgError_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBips_PkgImage_info\fR('u .R rc_err_t \fBips_PkgImage_info\fR(rc_instance_t\ *inst, . const\ char\ **pkg_fmri_patterns, . int\ pkg_fmri_patterns_count, . boolean_t\ *license_only, . boolean_t\ *info_local, . boolean_t\ *info_remote, . const\ char\ **origins, . int\ origins_count, . const\ char\ *mode, . rc_instance_t\ ***result, . int\ *result_cnt, . ips_PkgError_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBips_PkgImage_publisher\fR('u .R rc_err_t \fBips_PkgImage_publisher\fR(rc_instance_t\ *inst, . const\ char\ **publishers, . int\ publishers_count, . boolean_t\ *preferred_only, . boolean_t\ *include_disabled, . const\ char\ *mode, . rc_instance_t\ ***result, . int\ *result_cnt, . ips_PkgError_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBips_PkgImage_set_publisher\fR('u .R rc_err_t \fBips_PkgImage_set_publisher\fR(rc_instance_t\ *inst, . const\ char\ **publishers, . int\ publishers_count, . const\ char\ *ssl_key, . const\ char\ *ssl_cert, . const\ char\ **approved_ca_certs, . int\ approved_ca_certs_count, . const\ char\ **revoked_ca_certs, . int\ revoked_ca_certs_count, . const\ char\ **unset_ca_certs, . int\ unset_ca_certs_count, . const\ char\ *origin_uri, . boolean_t\ *reset_uuid, . const\ char\ **add_mirrors, . int\ add_mirrors_count, . const\ char\ **remove_mirrors, . int\ remove_mirrors_count, . const\ char\ **add_origins, . int\ add_origins_count, . const\ char\ **remove_origins, . int\ remove_origins_count, . boolean_t\ *refresh_allowed, . boolean_t\ *disable, . boolean_t\ *sticky, . const\ char\ *repo_uri, . const\ char\ *proxy_uri, . const\ char\ **set_props, . int\ set_props_count, . const\ char\ **add_prop_values, . int\ add_prop_values_count, . const\ char\ **remove_prop_values, . int\ remove_prop_values_count, . const\ char\ **unset_props, . int\ unset_props_count, . const\ char\ *search_before, . const\ char\ *search_after, . const\ char\ *search_first, . const\ char\ *mode, . ips_PkgReturn_t\ **result, . ips_PkgError_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBips_PkgImage_unset_publisher\fR('u .R rc_err_t \fBips_PkgImage_unset_publisher\fR(rc_instance_t\ *inst, . const\ char\ **publishers, . int\ publishers_count, . const\ char\ *mode, . ips_PkgReturn_t\ **result, . ips_PkgError_t\ **error); .RS .RE .fi .nf .HP \w'typedef\ void\ \fB(*ips_PkgImage_progress_cb_f)\fR('u .R typedef void \fB(*ips_PkgImage_progress_cb_f)\fR(rc_instance_t\ *inst, . ips_PkgProgress_t\ *payload, . struct\ timespec\ ts, . void\ *arg); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBips_PkgImage_subscribe_progress\fR('u .R rc_err_t \fBips_PkgImage_subscribe_progress\fR(rc_instance_t\ *inst, . ips_PkgImage_progress_cb_f\ cb, . void\ *arg); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBips_PkgImage_unsubscribe_progress\fR('u .R rc_err_t \fBips_PkgImage_unsubscribe_progress\fR(rc_instance_t\ *inst, . void\ **arg); .RS .RE .fi .SS "interface IPSManager" .nf .HP \w'rc_err_t\ \fBips_IPSManager_image_create\fR('u .R rc_err_t \fBips_IPSManager_image_create\fR(rc_instance_t\ *inst, . const\ char\ *image_path, . rc_instance_t\ **result, . ips_PkgError_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBips_IPSManager_image_remove\fR('u .R rc_err_t \fBips_IPSManager_image_remove\fR(rc_instance_t\ *inst, . const\ adr_name_t\ *name, . ips_PkgError_t\ **error); .RS .RE .fi .nf .HP \w'rc_err_t\ \fBips_IPSManager_image_open\fR('u .R rc_err_t \fBips_IPSManager_image_open\fR(rc_instance_t\ *inst, . const\ char\ *image_path, . rc_instance_t\ **result, . ips_PkgError_t\ **error); .RS .RE .fi .SS "Enumerated Types" .PP \fBenum PkgRetErrCode\fR .\" blockquote { .RS 4 .PP .nf typedef enum ips_PkgRetErrCode { IPREC_OK = 0, IPREC_GENERAL_ERROR = 1, IPREC_BAD_ARGS = 2, IPREC_PARTIAL_SUCCEED = 3, IPREC_NO_OP = 4, IPREC_NO_PERMIT_LIVE = 5, IPREC_LICENSE_ACCEPT = 6, IPREC_IMAGE_LOCKED = 7, IPREC_ACTUATOR_TIMEOUT = 8, IPREC_UNANTICIPATED = 99, } ips_PkgRetErrCode_t; .fi .RE .\" } blockquote .SS "Structured Types" .PP \fBstruct PkgProgress\fR .\" blockquote { .RS 4 .PP typedef struct ips_PkgProgress ips_PkgProgress_t; .PP .nf struct ips_PkgProgress { char *ipp_phase; char *ipp_message; char *ipp_time_taken; char *ipp_time_unit; char *ipp_action_type; char *ipp_processed_items; char *ipp_goal_items; char *ipp_percent_done; char *ipp_item_unit; char *ipp_speed; char **ipp_running; int ipp_running_count; char *ipp_goal_processed_items; char *ipp_reversioned_items; char *ipp_goal_reversion_items; char *ipp_adjusted_items; char **ipp_li_output; int ipp_li_output_count; char **ipp_li_errors; int ipp_li_errors_count; }; .fi .nf .HP \w'void\ \fBips_PkgProgress_free\fR('u .R void \fBips_PkgProgress_free\fR(ips_PkgProgress_t\ *in); .RS .RE .fi .RE .\" } blockquote .PP \fBstruct PkgError\fR .\" blockquote { .RS 4 .PP typedef struct ips_PkgError ips_PkgError_t; .PP .nf struct ips_PkgError { ips_PkgRetErrCode_t ipe_error_code; char *ipe_error_message; }; .fi .nf .HP \w'void\ \fBips_PkgError_free\fR('u .R void \fBips_PkgError_free\fR(ips_PkgError_t\ *in); .RS .RE .fi .RE .\" } blockquote .PP \fBstruct PkgProperty\fR .\" blockquote { .RS 4 .PP typedef struct ips_PkgProperty ips_PkgProperty_t; .PP .nf struct ips_PkgProperty { char *ipp_name; char **ipp_value; int ipp_value_count; }; .fi .nf .HP \w'void\ \fBips_PkgProperty_free\fR('u .R void \fBips_PkgProperty_free\fR(ips_PkgProperty_t\ *in); .RS .RE .fi .RE .\" } blockquote .PP \fBstruct PkgReturn\fR .\" blockquote { .RS 4 .PP typedef struct ips_PkgReturn ips_PkgReturn_t; .PP .nf struct ips_PkgReturn { ips_PkgRetErrCode_t ipr_return_code; char *ipr_parsable_data; }; .fi .nf .HP \w'void\ \fBips_PkgReturn_free\fR('u .R void \fBips_PkgReturn_free\fR(ips_PkgReturn_t\ *in); .RS .RE .fi .RE .\" } blockquote .SH "DESCRIPTION" .PP \fBAPI com\&.oracle\&.solaris\&.rad\&.ips \fR\fB\&\s-2\u[1]\d\s+2\fR .PP This API exposes common \fBpkg(1)\fR operations in IPS to \fBrad(8)\fR clients\&. .PP The following six interfaces are provided: .sp .RS 4 .ie n \{\ \h'-04' 1.\h'+01'\c .\} .el \{\ .sp -1 .IP " 1." 4.2 .\} IPSManager \- Singleton interface that provides management of pkg images instances\&. .RE .sp .RS 4 .ie n \{\ \h'-04' 2.\h'+01'\c .\} .el \{\ .sp -1 .IP " 2." 4.2 .\} PkgSource \- Interface provides access to publisher source such as publisher origins or mirrors\&. .RE .sp .RS 4 .ie n \{\ \h'-04' 3.\h'+01'\c .\} .el \{\ .sp -1 .IP " 3." 4.2 .\} PkgPublisher \- Interface provides access to publisher information\&. .RE .sp .RS 4 .ie n \{\ \h'-04' 4.\h'+01'\c .\} .el \{\ .sp -1 .IP " 4." 4.2 .\} PkgFmri \- Interface provides access to package fmri\&. .RE .sp .RS 4 .ie n \{\ \h'-04' 5.\h'+01'\c .\} .el \{\ .sp -1 .IP " 5." 4.2 .\} PkgInfo \- Interface provides access to package information\&. .RE .sp .RS 4 .ie n \{\ \h'-04' 6.\h'+01'\c .\} .el \{\ .sp -1 .IP " 6." 4.2 .\} PkgImage \- Interface provides access to image operations\&. .RE .PP A limited number of pkg operations is accessible through \fBrad(8)\fRPkgImage instances\&. .PP The following is a complete client example: .SH "INTERFACES" .SS "interface PkgSource" .PP Interface to provide publisher source information\&. .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBPkgSource Properties\fR .RS 4 .PP \fB\fIconst char *\fR\fR\ \&\fBURI\fR (\fIread\-only\fR, \fInullable\fR) \(em Source URI\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgSource_get_URI\fR('u .R rc_err_t \fBips_PkgSource_get_URI\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 .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIvoid **\fR\fR .RE .\" } blockquote .PP \fB\fIconst char *\fR\fR\ \&\fBtype\fR (\fIread\-only\fR, \fInullable\fR) \(em Source type: origin or mirror\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgSource_get_type\fR('u .R rc_err_t \fBips_PkgSource_get_type\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 .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIvoid **\fR\fR .RE .\" } blockquote .PP \fB\fIconst char *\fR\fR\ \&\fBstatus\fR (\fIread\-only\fR, \fInullable\fR) \(em Source status\&. Valid values are \'online\' and \'disabled\'\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgSource_get_status\fR('u .R rc_err_t \fBips_PkgSource_get_status\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 .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIvoid **\fR\fR .RE .\" } blockquote .PP \fB\fIconst char **\fR\fR\ \&\fBproxies\fR (\fIread\-only\fR, \fInullable\fR) \(em Source proxies\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgSource_get_proxies\fR('u .R rc_err_t \fBips_PkgSource_get_proxies\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 .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIvoid **\fR\fR .RE .\" } blockquote .PP \fB\fIconst char *\fR\fR\ \&\fBcert_effective_date\fR (\fIread\-only\fR, \fInullable\fR) \(em Source certificate effective date\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgSource_get_cert_effective_date\fR('u .R rc_err_t \fBips_PkgSource_get_cert_effective_date\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 .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIvoid **\fR\fR .RE .\" } blockquote .PP \fB\fIconst char *\fR\fR\ \&\fBcert_expiration_date\fR (\fIread\-only\fR, \fInullable\fR) \(em Source certificate expiration date\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgSource_get_cert_expiration_date\fR('u .R rc_err_t \fBips_PkgSource_get_cert_expiration_date\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 .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIvoid **\fR\fR .RE .\" } blockquote .PP \fB\fIconst char *\fR\fR\ \&\fBSSL_key\fR (\fIread\-only\fR, \fInullable\fR) \(em Source SSL key\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgSource_get_SSL_key\fR('u .R rc_err_t \fBips_PkgSource_get_SSL_key\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 .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIvoid **\fR\fR .RE .\" } blockquote .PP \fB\fIconst char *\fR\fR\ \&\fBSSL_cert\fR (\fIread\-only\fR, \fInullable\fR) \(em Source SSL certificate\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgSource_get_SSL_cert\fR('u .R rc_err_t \fBips_PkgSource_get_SSL_cert\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 .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIvoid **\fR\fR .RE .\" } blockquote .RE .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBPkgSource Retrieve\fR .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgSource__rad_get_name\fR('u .R rc_err_t \fBips_PkgSource__rad_get_name\fR(adr_name_t\ **result, . int\ n, . \&.\&.\&.); .RS .RE .fi .\" blockquote { .RS 4 .PP Obtain RAD name of a PkgSource 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\ \fBips_PkgSource__rad_lookup\fR('u .R rc_err_t \fBips_PkgSource__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 PkgSource 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\ \fBips_PkgSource__rad_list\fR('u .R rc_err_t \fBips_PkgSource__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 PkgSource 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 PkgPublisher" .PP A package publisher\&. .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBPkgPublisher Properties\fR .RS 4 .PP \fB\fIconst char *\fR\fR\ \&\fBprefix\fR (\fIread\-only\fR, \fInullable\fR) \(em Publisher prefix\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgPublisher_get_prefix\fR('u .R rc_err_t \fBips_PkgPublisher_get_prefix\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 .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIvoid **\fR\fR .RE .\" } blockquote .PP \fB\fIconst char *\fR\fR\ \&\fBalias\fR (\fIread\-only\fR, \fInullable\fR) \(em Publisher alias\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgPublisher_get_alias\fR('u .R rc_err_t \fBips_PkgPublisher_get_alias\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 .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIvoid **\fR\fR .RE .\" } blockquote .PP \fB\fIconst char *\fR\fR\ \&\fBclient_UUID\fR (\fIread\-only\fR, \fInullable\fR) \(em Publisher client UUID\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgPublisher_get_client_UUID\fR('u .R rc_err_t \fBips_PkgPublisher_get_client_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 .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIvoid **\fR\fR .RE .\" } blockquote .PP \fB\fIconst char *\fR\fR\ \&\fBcat_updated_time\fR (\fIread\-only\fR, \fInullable\fR) \(em Time the catalog was last updated\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgPublisher_get_cat_updated_time\fR('u .R rc_err_t \fBips_PkgPublisher_get_cat_updated_time\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 .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIvoid **\fR\fR .RE .\" } blockquote .PP \fB\fIconst char *\fR\fR\ \&\fBenabled\fR (\fIread\-only\fR, \fInullable\fR) \(em Publisher is enabled flag\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgPublisher_get_enabled\fR('u .R rc_err_t \fBips_PkgPublisher_get_enabled\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 .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIvoid **\fR\fR .RE .\" } blockquote .PP \fB\fIconst char *\fR\fR\ \&\fBsticky\fR (\fIread\-only\fR, \fInullable\fR) \(em Publisher is sticky flag\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgPublisher_get_sticky\fR('u .R rc_err_t \fBips_PkgPublisher_get_sticky\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 .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIvoid **\fR\fR .RE .\" } blockquote .PP \fB\fIconst char *\fR\fR\ \&\fBsyspub\fR (\fIread\-only\fR, \fInullable\fR) \(em Publisher is a system publisher flag\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgPublisher_get_syspub\fR('u .R rc_err_t \fBips_PkgPublisher_get_syspub\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 .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIvoid **\fR\fR .RE .\" } blockquote .PP \fB\fIconst rc_instance_t **\fR\fR\ \&\fBmirrors\fR (\fIread\-only\fR, \fInullable\fR) \(em A list of mirror type PkgSource instances\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgPublisher_get_mirrors\fR('u .R rc_err_t \fBips_PkgPublisher_get_mirrors\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 .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIvoid **\fR\fR .RE .\" } blockquote .PP \fB\fIconst rc_instance_t **\fR\fR\ \&\fBorigins\fR (\fIread\-only\fR, \fInullable\fR) \(em A list of origin type PkgSource instances\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgPublisher_get_origins\fR('u .R rc_err_t \fBips_PkgPublisher_get_origins\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 .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIvoid **\fR\fR .RE .\" } blockquote .PP \fB\fIips_PkgProperty_t **\fR\fR\ \&\fBproperties\fR (\fIread\-only\fR, \fInullable\fR) \(em A list of PkgProperty structs\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgPublisher_get_properties\fR('u .R rc_err_t \fBips_PkgPublisher_get_properties\fR(rc_instance_t\ *inst, . ips_PkgProperty_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 .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIvoid **\fR\fR .RE .\" } blockquote .PP \fB\fIconst char **\fR\fR\ \&\fBapproved_CAs\fR (\fIread\-only\fR, \fInullable\fR) \(em A list approved CAs\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgPublisher_get_approved_CAs\fR('u .R rc_err_t \fBips_PkgPublisher_get_approved_CAs\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 .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIvoid **\fR\fR .RE .\" } blockquote .PP \fB\fIconst char **\fR\fR\ \&\fBrevoked_CAs\fR (\fIread\-only\fR, \fInullable\fR) \(em A list of revoked CAs\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgPublisher_get_revoked_CAs\fR('u .R rc_err_t \fBips_PkgPublisher_get_revoked_CAs\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 .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIvoid **\fR\fR .RE .\" } blockquote .RE .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBPkgPublisher Retrieve\fR .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgPublisher__rad_get_name\fR('u .R rc_err_t \fBips_PkgPublisher__rad_get_name\fR(adr_name_t\ **result, . int\ n, . \&.\&.\&.); .RS .RE .fi .\" blockquote { .RS 4 .PP Obtain RAD name of a PkgPublisher 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\ \fBips_PkgPublisher__rad_lookup\fR('u .R rc_err_t \fBips_PkgPublisher__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 PkgPublisher 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\ \fBips_PkgPublisher__rad_list\fR('u .R rc_err_t \fBips_PkgPublisher__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 PkgPublisher 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 PkgFmri" .PP A package FMRI\&. .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBPkgFmri Methods\fR .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgFmri_get_name\fR('u .R rc_err_t \fBips_PkgFmri_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 .nf .HP \w'rc_err_t\ \fBips_PkgFmri_get_publisher\fR('u .R rc_err_t \fBips_PkgFmri_get_publisher\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 .nf .HP \w'rc_err_t\ \fBips_PkgFmri_get_pkg_stem\fR('u .R rc_err_t \fBips_PkgFmri_get_pkg_stem\fR(rc_instance_t\ *inst, . boolean_t\ *no_publisher, . boolean_t\ *include_scheme, . char\ **result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIno_publisher\fR (\fInullable\fR) \(em Property value returned .PP \fIinclude_scheme\fR (\fInullable\fR) .PP \fIresult\fR \(em Package stem\&. .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBips_PkgFmri_get_fmri\fR('u .R rc_err_t \fBips_PkgFmri_get_fmri\fR(rc_instance_t\ *inst, . const\ char\ *default_publisher, . boolean_t\ *no_publisher, . boolean_t\ *include_scheme, . boolean_t\ *include_build, . boolean_t\ *include_timestamp, . char\ **result); .RS .RE .fi .\" blockquote { .RS 4 .PP Get property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIdefault_publisher\fR (\fInullable\fR) \(em Provide a default publisher name if the FMRI does not have one\&. .PP \fIno_publisher\fR (\fInullable\fR) \(em Flag to include the publisher in the FMRI\&. .PP \fIinclude_scheme\fR (\fInullable\fR) \(em Flag to include the scheme such as (pkg:/) in the FMRI\&. .PP \fIinclude_build\fR (\fInullable\fR) \(em Flag to include build number in the FMRI\&. .PP \fIinclude_timestamp\fR (\fInullable\fR) \(em Flag to include time stamp in the FMRI\&. .PP \fIresult\fR \(em A package FMRI\&. .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBips_PkgFmri_get_version\fR('u .R rc_err_t \fBips_PkgFmri_get_version\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 .nf .HP \w'rc_err_t\ \fBips_PkgFmri_get_timestamp\fR('u .R rc_err_t \fBips_PkgFmri_get_timestamp\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 .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBPkgFmri Retrieve\fR .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgFmri__rad_get_name\fR('u .R rc_err_t \fBips_PkgFmri__rad_get_name\fR(adr_name_t\ **result, . int\ n, . \&.\&.\&.); .RS .RE .fi .\" blockquote { .RS 4 .PP Obtain RAD name of a PkgFmri 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\ \fBips_PkgFmri__rad_lookup\fR('u .R rc_err_t \fBips_PkgFmri__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 PkgFmri 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\ \fBips_PkgFmri__rad_list\fR('u .R rc_err_t \fBips_PkgFmri__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 PkgFmri 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 PkgInfo" .PP Collect package\-related in formation\&. .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBPkgInfo Properties\fR .RS 4 .PP \fB\fIconst char *\fR\fR\ \&\fBpkg_name\fR (\fIread\-only\fR, \fInullable\fR) \(em Package name\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgInfo_get_pkg_name\fR('u .R rc_err_t \fBips_PkgInfo_get_pkg_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\ \&\fBsummary\fR (\fIread\-only\fR, \fInullable\fR) \(em Package summary\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgInfo_get_summary\fR('u .R rc_err_t \fBips_PkgInfo_get_summary\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\ \&\fBdescription\fR (\fIread\-only\fR, \fInullable\fR) \(em Package description\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgInfo_get_description\fR('u .R rc_err_t \fBips_PkgInfo_get_description\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\ \&\fBcategory\fR (\fIread\-only\fR, \fInullable\fR) \(em Package category\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgInfo_get_category\fR('u .R rc_err_t \fBips_PkgInfo_get_category\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\ \&\fBstate\fR (\fIread\-only\fR, \fInullable\fR) \(em Package state\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgInfo_get_state\fR('u .R rc_err_t \fBips_PkgInfo_get_state\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\ \&\fBrenamed_to\fR (\fIread\-only\fR, \fInullable\fR) \(em New name of a renamed package\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgInfo_get_renamed_to\fR('u .R rc_err_t \fBips_PkgInfo_get_renamed_to\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\ \&\fBpublisher\fR (\fIread\-only\fR, \fInullable\fR) \(em Package publisher\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgInfo_get_publisher\fR('u .R rc_err_t \fBips_PkgInfo_get_publisher\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\ \&\fBlast_install_time\fR (\fIread\-only\fR, \fInullable\fR) \(em Package last install time\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgInfo_get_last_install_time\fR('u .R rc_err_t \fBips_PkgInfo_get_last_install_time\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\ \&\fBlast_update_time\fR (\fIread\-only\fR, \fInullable\fR) \(em Package last update time\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgInfo_get_last_update_time\fR('u .R rc_err_t \fBips_PkgInfo_get_last_update_time\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\ \&\fBsize\fR (\fIread\-only\fR, \fInullable\fR) \(em Package size\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgInfo_get_size\fR('u .R rc_err_t \fBips_PkgInfo_get_size\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\ \&\fBfmri\fR (\fIread\-only\fR, \fInullable\fR) \(em Package FMRI\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgInfo_get_fmri\fR('u .R rc_err_t \fBips_PkgInfo_get_fmri\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 char **\fR\fR\ \&\fBlicenses\fR (\fIread\-only\fR, \fInullable\fR) \(em Package licenses\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgInfo_get_licenses\fR('u .R rc_err_t \fBips_PkgInfo_get_licenses\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 \fBPkgInfo Retrieve\fR .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgInfo__rad_get_name\fR('u .R rc_err_t \fBips_PkgInfo__rad_get_name\fR(adr_name_t\ **result, . int\ n, . \&.\&.\&.); .RS .RE .fi .\" blockquote { .RS 4 .PP Obtain RAD name of a PkgInfo 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\ \fBips_PkgInfo__rad_lookup\fR('u .R rc_err_t \fBips_PkgInfo__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 PkgInfo 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\ \fBips_PkgInfo__rad_list\fR('u .R rc_err_t \fBips_PkgInfo__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 PkgInfo 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 PkgImage" .PP A package image\&. .PP A collection of methods similar to the pkg commands, including representations of command options\&. See the \fBpkg(1)\fR man page for option details\&. .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBPkgImage Properties\fR .RS 4 .PP \fB\fIconst char *\fR\fR\ \&\fBimage_path\fR (\fIread\-only\fR, \fInullable\fR) \(em The image path to operate on\&. .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgImage_get_image_path\fR('u .R rc_err_t \fBips_PkgImage_get_image_path\fR(rc_instance_t\ *inst, . char\ **result, . char\ **error); .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 \fIerror\fR .RE .\" } blockquote .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBRead Error:\fR \fB\fIchar **\fR\fR .RE .\" } blockquote .PP \fB\fIconst char *\fR\fR\ \&\fBmode\fR (\fIread\-write\fR, \fInullable\fR) \(em The running mode\&. .\" blockquote { .RS 4 .PP This property has two valid values: native and fork\&. native allows the pkg command to be invoked within the same process as the RAD connection\&. fork means the pkg command will be invoked within a subprocess\&. This global mode can be overwritten by mode for a particular operation\&. .RE .\" } blockquote .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgImage_get_mode\fR('u .R rc_err_t \fBips_PkgImage_get_mode\fR(rc_instance_t\ *inst, . char\ **result, . ips_PkgError_t\ **error); .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 \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBips_PkgImage_set_mode\fR('u .R rc_err_t \fBips_PkgImage_set_mode\fR(rc_instance_t\ *inst, . const\ char\ *mode, . ips_PkgError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Set property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fImode\fR \(em Property value written .PP \fIerror\fR .RE .\" } blockquote .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBRead\-Write Error:\fR \fB\fIips_PkgError_t **\fR\fR .RE .\" } blockquote .PP \fB\fIfloat\fR\fR\ \&\fBprogress_interval\fR (\fIread\-write\fR) \(em The progress delay in seconds\&. .\" blockquote { .RS 4 .PP Enables the client to control how often periodic progress events are reported\&. For example, if many pieces of data are downloaded, this property can be used to sample the download status to avoid generating too many progress events\&. The default value is 5 seconds\&. .RE .\" } blockquote .\" blockquote { .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgImage_get_progress_interval\fR('u .R rc_err_t \fBips_PkgImage_get_progress_interval\fR(rc_instance_t\ *inst, . float\ *result, . ips_PkgError_t\ **error); .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 \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBips_PkgImage_set_progress_interval\fR('u .R rc_err_t \fBips_PkgImage_set_progress_interval\fR(rc_instance_t\ *inst, . float\ progress_interval, . ips_PkgError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Set property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIprogress_interval\fR \(em Property value written .PP \fIerror\fR .RE .\" } blockquote .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBRead\-Write Error:\fR \fB\fIips_PkgError_t **\fR\fR .RE .\" } blockquote .RE .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBPkgImage Methods\fR .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgImage_list_packages\fR('u .R rc_err_t \fBips_PkgImage_list_packages\fR(rc_instance_t\ *inst, . const\ char\ **pkg_fmri_patterns, . int\ pkg_fmri_patterns_count, . boolean_t\ *refresh_catalogs, . const\ char\ **origins, . int\ origins_count, . boolean_t\ *list_installed_newest, . boolean_t\ *list_all, . boolean_t\ *list_newest, . boolean_t\ *list_upgradable, . const\ char\ *mode, . rc_instance_t\ ***result, . int\ *result_cnt, . ips_PkgError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIpkg_fmri_patterns\fR (\fInullable\fR) \(em Packages to be listed\&. .PP \fIpkg_fmri_patterns_count\fR \(em Number of items in pkg_fmri_patterns array .PP \fIrefresh_catalogs\fR (\fInullable\fR) \(em Equivalent to \-\-no\-refresh\&. Default: True\&. .PP \fIorigins\fR (\fInullable\fR) \(em Equivalent to \-g\&. Default: None\&. .PP \fIorigins_count\fR \(em Number of items in origins array .PP \fIlist_installed_newest\fR (\fInullable\fR) \(em Equivalent to \-a\&. Default: False\&. .PP \fIlist_all\fR (\fInullable\fR) \(em Equivalent to \-f\&. Default: False\&. Must be used with list_installed_newest\&. .PP \fIlist_newest\fR (\fInullable\fR) \(em Equivalent to \-n\&. Default: False\&. .PP \fIlist_upgradable\fR (\fInullable\fR) \(em Equivalent to \-u\&. Default: False\&. .PP \fImode\fR (\fInullable\fR) \(em The running mode\&. see PkgImage\&.mode property for valid values\&. .PP \fIresult\fR \(em A list of PkgFmri objects\&. .PP \fIresult_cnt\fR \(em Number of items in result array .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBips_PkgImage_install\fR('u .R rc_err_t \fBips_PkgImage_install\fR(rc_instance_t\ *inst, . const\ char\ **pkg_fmri_patterns, . int\ pkg_fmri_patterns_count, . const\ char\ *backup_be_name, . const\ char\ *be_name, . boolean_t\ *deny_new_be, . boolean_t\ *no_backup_be, . boolean_t\ *be_activate, . boolean_t\ *require_backup_be, . boolean_t\ *require_new_be, . int\ *concurrency, . boolean_t\ *accept, . boolean_t\ *show_licenses, . const\ char\ **reject_pats, . int\ reject_pats_count, . boolean_t\ *update_index, . boolean_t\ *refresh_catalogs, . boolean_t\ *noexecute, . int\ *parsable_version, . const\ char\ **origins, . int\ origins_count, . boolean_t\ *li_erecurse_all, . const\ char\ **li_erecurse_list, . int\ li_erecurse_list_count, . const\ char\ **li_erecurse_excl, . int\ li_erecurse_excl_count, . boolean_t\ *sync_act, . int\ *act_timeout, . const\ char\ *mode, . ips_PkgReturn_t\ **result, . ips_PkgError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Operation to install packages\&. .PP Operation for installing packages\&. This operation is equivalent to the pkg install command\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIpkg_fmri_patterns\fR (\fInullable\fR) \(em Packages to install\&. .PP \fIpkg_fmri_patterns_count\fR \(em Number of items in pkg_fmri_patterns array .PP \fIbackup_be_name\fR (\fInullable\fR) \(em Equivalent to \-\-backup\-be\-name\&. Default: None\&. .PP \fIbe_name\fR (\fInullable\fR) \(em Equivalent to \-\-be\-name\&. Default: None\&. .PP \fIdeny_new_be\fR (\fInullable\fR) \(em Equivalent to \-\-deny\-new\-be\&. Default: False\&. .PP \fIno_backup_be\fR (\fInullable\fR) \(em Equivalent to \-\-no\-backup\-be\&. Default: False\&. .PP \fIbe_activate\fR (\fInullable\fR) \(em Opposite to \-\-no\-be\-activate\&. Default: True\&. .PP \fIrequire_backup_be\fR (\fInullable\fR) \(em Equivalent to \-\-require\-backup\-be\&. Default: False\&. .PP \fIrequire_new_be\fR (\fInullable\fR) \(em Equivalent to \-\-require\-new\-be\&. Default: False\&. .PP \fIconcurrency\fR (\fInullable\fR) \(em Equivalent to \-C\&. Default: None\&. Minimum: 0\&. .PP \fIaccept\fR (\fInullable\fR) \(em Equivalent to \-\-accept\&. Default: False\&. .PP \fIshow_licenses\fR (\fInullable\fR) \(em Equivalent to \-\-licenses\&. Default: False\&. .PP \fIreject_pats\fR (\fInullable\fR) \(em Equivalent to \-\-reject\&. Default: None\&. .PP \fIreject_pats_count\fR \(em Number of items in reject_pats array .PP \fIupdate_index\fR (\fInullable\fR) \(em Opposite to \-\-no\-index\&. Default: True\&. .PP \fIrefresh_catalogs\fR (\fInullable\fR) \(em Opposite to \-\-no\-refresh\&. Default: True\&. .PP \fInoexecute\fR (\fInullable\fR) \(em Equivalent to \-n\&. Default: False\&. .PP \fIparsable_version\fR (\fInullable\fR) \(em Required to show licenses to be accepted\&. Default: None\&. The only acceptable value is 0\&. .\" blockquote { .RS 4 .PP For software with licenses that must be viewed and accepted, the RAD client must specify the parsable_version and accept options to allow the RAD server to return the parsable version of the image plan that contains software licenses, and to set licenses as accepted\&. .RE .\" } blockquote .PP \fIorigins\fR (\fInullable\fR) \(em Equivalent to \-g\&. Default: None\&. .PP \fIorigins_count\fR \(em Number of items in origins array .PP \fIli_erecurse_all\fR (\fInullable\fR) \(em Equivalent to \-r\&. Default: False\&. .PP \fIli_erecurse_list\fR (\fInullable\fR) \(em Equivalent to \-z\&. Default: None\&. .PP \fIli_erecurse_list_count\fR \(em Number of items in li_erecurse_list array .PP \fIli_erecurse_excl\fR (\fInullable\fR) \(em Equivalent to \-Z\&. Default: None\&. .PP \fIli_erecurse_excl_count\fR \(em Number of items in li_erecurse_excl array .PP \fIsync_act\fR (\fInullable\fR) \(em Equivalent to \-\-sync\-actuators\&. Default: False\&. .PP \fIact_timeout\fR (\fInullable\fR) \(em Equivalent to \-\-sync\-actuators\-timeout\&. Default: None\&. Minimum: 0\&. .PP \fImode\fR (\fInullable\fR) \(em The running mode\&. see PkgImage\&.mode property for valid values\&. .PP \fIresult\fR \(em The returned data\&. .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBips_PkgImage_exact_install\fR('u .R rc_err_t \fBips_PkgImage_exact_install\fR(rc_instance_t\ *inst, . const\ char\ **pkg_fmri_patterns, . int\ pkg_fmri_patterns_count, . const\ char\ *backup_be_name, . const\ char\ *be_name, . boolean_t\ *deny_new_be, . boolean_t\ *no_backup_be, . boolean_t\ *be_activate, . boolean_t\ *require_backup_be, . boolean_t\ *require_new_be, . int\ *concurrency, . boolean_t\ *accept, . boolean_t\ *show_licenses, . const\ char\ **reject_pats, . int\ reject_pats_count, . boolean_t\ *update_index, . boolean_t\ *refresh_catalogs, . boolean_t\ *noexecute, . int\ *parsable_version, . const\ char\ **origins, . int\ origins_count, . const\ char\ *mode, . ips_PkgReturn_t\ **result, . ips_PkgError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Operation to install only named packages and their dependencies\&. .PP Operation for installing only packages specified by pkg_fmri_patterns and their dependencies\&. This operation is equivalent to the pkg exact\-install command\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIpkg_fmri_patterns\fR (\fInullable\fR) \(em Packages to be installed\&. .PP \fIpkg_fmri_patterns_count\fR \(em Number of items in pkg_fmri_patterns array .PP \fIbackup_be_name\fR (\fInullable\fR) \(em Equivalent to \-\-backup\-be\-name\&. Default: None\&. .PP \fIbe_name\fR (\fInullable\fR) \(em Equivalent to \-\-be\-name\&. Default: None\&. .PP \fIdeny_new_be\fR (\fInullable\fR) \(em Equivalent to \-\-deny\-new\-be\&. Default: False\&. .PP \fIno_backup_be\fR (\fInullable\fR) \(em Equivalent to \-\-no\-backup\-be\&. Default: False\&. .PP \fIbe_activate\fR (\fInullable\fR) \(em Opposite to \-\-no\-be\-activate\&. Default: True\&. .PP \fIrequire_backup_be\fR (\fInullable\fR) \(em Equivalent to \-\-require\-backup\-be\&. Default: False\&. .PP \fIrequire_new_be\fR (\fInullable\fR) \(em Equivalent to \-\-require\-new\-be\&. Default: False\&. .PP \fIconcurrency\fR (\fInullable\fR) \(em Equivalent to \-C\&. Default: None\&. Minimum: 0\&. .PP \fIaccept\fR (\fInullable\fR) \(em Equivalent to \-\-accept\&. Default: False\&. .PP \fIshow_licenses\fR (\fInullable\fR) \(em Equivalent to \-\-licenses\&. Default: False\&. .PP \fIreject_pats\fR (\fInullable\fR) \(em Equivalent to \-\-reject\&. Default: None\&. .PP \fIreject_pats_count\fR \(em Number of items in reject_pats array .PP \fIupdate_index\fR (\fInullable\fR) \(em Opposite to \-\-no\-index\&. Default: True\&. .PP \fIrefresh_catalogs\fR (\fInullable\fR) \(em Opposite to \-\-no\-refresh\&. Default: True\&. .PP \fInoexecute\fR (\fInullable\fR) \(em Equivalent to \-n\&. Default: False\&. .PP \fIparsable_version\fR (\fInullable\fR) \(em Required to show licenses to be accepted\&. Default: None\&. The only acceptable value is 0\&. .\" blockquote { .RS 4 .PP For software with licenses that must be viewed and accepted, the RAD client must specify the parsable_version and accept options to allow the RAD server to return the parsable version of the image plan that contains software licenses, and to set licenses as accepted\&. .RE .\" } blockquote .PP \fIorigins\fR (\fInullable\fR) \(em Equivalent to \-g\&. Default: None\&. .PP \fIorigins_count\fR \(em Number of items in origins array .PP \fImode\fR (\fInullable\fR) \(em The running mode\&. see PkgImage\&.mode property for valid values\&. .PP \fIresult\fR \(em The returned data\&. .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBips_PkgImage_update\fR('u .R rc_err_t \fBips_PkgImage_update\fR(rc_instance_t\ *inst, . const\ char\ **pkg_fmri_patterns, . int\ pkg_fmri_patterns_count, . const\ char\ *backup_be_name, . const\ char\ *be_name, . boolean_t\ *deny_new_be, . boolean_t\ *no_backup_be, . boolean_t\ *be_activate, . boolean_t\ *require_backup_be, . boolean_t\ *require_new_be, . int\ *concurrency, . boolean_t\ *accept, . boolean_t\ *show_licenses, . const\ char\ **reject_pats, . int\ reject_pats_count, . boolean_t\ *update_index, . boolean_t\ *refresh_catalogs, . boolean_t\ *noexecute, . int\ *parsable_version, . const\ char\ **origins, . int\ origins_count, . boolean_t\ *li_erecurse_all, . const\ char\ **li_erecurse_list, . int\ li_erecurse_list_count, . const\ char\ **li_erecurse_excl, . int\ li_erecurse_excl_count, . boolean_t\ *sync_act, . int\ *act_timeout, . boolean_t\ *ignore_missing, . boolean_t\ *force, . const\ char\ *mode, . ips_PkgReturn_t\ **result, . ips_PkgError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Operation to update packages\&. .PP Operation for updating packages\&. This operation is equivalent to the pkg update command\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIpkg_fmri_patterns\fR (\fInullable\fR) \(em Packages to update\&. .PP \fIpkg_fmri_patterns_count\fR \(em Number of items in pkg_fmri_patterns array .PP \fIbackup_be_name\fR (\fInullable\fR) \(em Equivalent to \-\-backup\-be\-name\&. Default: None\&. .PP \fIbe_name\fR (\fInullable\fR) \(em Equivalent to \-\-be\-name\&. Default: None\&. .PP \fIdeny_new_be\fR (\fInullable\fR) \(em Equivalent to \-\-deny\-new\-be\&. Default: False\&. .PP \fIno_backup_be\fR (\fInullable\fR) \(em Equivalent to \-\-no\-backup\-be\&. Default: False\&. .PP \fIbe_activate\fR (\fInullable\fR) \(em Opposite to \-\-no\-be\-activate\&. Default: True\&. .PP \fIrequire_backup_be\fR (\fInullable\fR) \(em Equivalent to \-\-require\-backup\-be\&. Default: False\&. .PP \fIrequire_new_be\fR (\fInullable\fR) \(em Equivalent to \-\-require\-new\-be\&. Default: False\&. .PP \fIconcurrency\fR (\fInullable\fR) \(em Equivalent to \-C\&. Default: None\&. Minimum: 0\&. .PP \fIaccept\fR (\fInullable\fR) \(em Equivalent to \-\-accept\&. Default: False\&. .PP \fIshow_licenses\fR (\fInullable\fR) \(em Equivalent to \-\-licenses\&. Default: False\&. .PP \fIreject_pats\fR (\fInullable\fR) \(em Equivalent to \-\-reject\&. Default: None\&. .PP \fIreject_pats_count\fR \(em Number of items in reject_pats array .PP \fIupdate_index\fR (\fInullable\fR) \(em Opposite to \-\-no\-index\&. Default: True\&. .PP \fIrefresh_catalogs\fR (\fInullable\fR) \(em Opposite to \-\-no\-refresh\&. Default: True\&. .PP \fInoexecute\fR (\fInullable\fR) \(em Equivalent to \-n\&. Default: False\&. .PP \fIparsable_version\fR (\fInullable\fR) \(em Required to show licenses to be accepted\&. Default: None\&. The only acceptable value is 0\&. .\" blockquote { .RS 4 .PP For software with licenses that must be viewed and accepted, the RAD client must specify the parsable_version and accept options to allow the RAD server to return the parsable version of the image plan that contains software licenses, and to set licenses as accepted\&. .RE .\" } blockquote .PP \fIorigins\fR (\fInullable\fR) \(em Equivalent to \-g\&. Default: None\&. .PP \fIorigins_count\fR \(em Number of items in origins array .PP \fIli_erecurse_all\fR (\fInullable\fR) \(em Equivalent to \-r\&. Default: False\&. .PP \fIli_erecurse_list\fR (\fInullable\fR) \(em Equivalent to \-z\&. Default: None\&. .PP \fIli_erecurse_list_count\fR \(em Number of items in li_erecurse_list array .PP \fIli_erecurse_excl\fR (\fInullable\fR) \(em Equivalent to \-Z\&. Default: None\&. .PP \fIli_erecurse_excl_count\fR \(em Number of items in li_erecurse_excl array .PP \fIsync_act\fR (\fInullable\fR) \(em Equivalent to \-\-sync\-actuators\&. Default: False\&. .PP \fIact_timeout\fR (\fInullable\fR) \(em Equivalent to \-\-sync\-actuators\-timeout\&. Default: None\&. Minimum: 0\&. .PP \fIignore_missing\fR (\fInullable\fR) \(em Equivalent to \-\-ignore\-missing\&. Default: False\&. .PP \fIforce\fR (\fInullable\fR) \(em Equivalent to \-f\&. Default: False\&. .PP \fImode\fR (\fInullable\fR) \(em The running mode\&. see PkgImage\&.mode property for valid values\&. .PP \fIresult\fR \(em The returned data\&. .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBips_PkgImage_uninstall\fR('u .R rc_err_t \fBips_PkgImage_uninstall\fR(rc_instance_t\ *inst, . const\ char\ **pkg_fmri_patterns, . int\ pkg_fmri_patterns_count, . const\ char\ *backup_be_name, . const\ char\ *be_name, . boolean_t\ *deny_new_be, . boolean_t\ *no_backup_be, . boolean_t\ *be_activate, . boolean_t\ *require_backup_be, . boolean_t\ *require_new_be, . int\ *concurrency, . boolean_t\ *update_index, . boolean_t\ *refresh_catalogs, . boolean_t\ *noexecute, . int\ *parsable_version, . boolean_t\ *li_erecurse_all, . const\ char\ **li_erecurse_list, . int\ li_erecurse_list_count, . const\ char\ **li_erecurse_excl, . int\ li_erecurse_excl_count, . boolean_t\ *sync_act, . int\ *act_timeout, . boolean_t\ *ignore_missing, . const\ char\ *mode, . ips_PkgReturn_t\ **result, . ips_PkgError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Operation to uninstall packages\&. .PP Operation for uninstalling packages\&. This operation is equivalent to the pkg uninstall command\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIpkg_fmri_patterns\fR (\fInullable\fR) \(em Packages to uninstall\&. .PP \fIpkg_fmri_patterns_count\fR \(em Number of items in pkg_fmri_patterns array .PP \fIbackup_be_name\fR (\fInullable\fR) \(em Equivalent to \-\-backup\-be\-name\&. Default: None\&. .PP \fIbe_name\fR (\fInullable\fR) \(em Equivalent to \-\-be\-name\&. Default: None\&. .PP \fIdeny_new_be\fR (\fInullable\fR) \(em Equivalent to \-\-deny\-new\-be\&. Default: False\&. .PP \fIno_backup_be\fR (\fInullable\fR) \(em Equivalent to \-\-no\-backup\-be\&. Default: False\&. .PP \fIbe_activate\fR (\fInullable\fR) \(em Opposite to \-\-no\-be\-activate\&. Default: True\&. .PP \fIrequire_backup_be\fR (\fInullable\fR) \(em Equivalent to \-\-require\-backup\-be\&. Default: False\&. .PP \fIrequire_new_be\fR (\fInullable\fR) \(em Equivalent to \-\-require\-new\-be\&. Default: False\&. .PP \fIconcurrency\fR (\fInullable\fR) \(em Equivalent to \-C\&. Default: None\&. Minimum: 0\&. .PP \fIupdate_index\fR (\fInullable\fR) \(em Opposite to \-\-no\-index\&. Default: True\&. .PP \fIrefresh_catalogs\fR (\fInullable\fR) \(em Opposite to \-\-no\-refresh\&. Default: True\&. .PP \fInoexecute\fR (\fInullable\fR) \(em Equivalent to \-n\&. Default: False\&. .PP \fIparsable_version\fR (\fInullable\fR) \(em Required to show licenses to be accepted\&. Default: None\&. The only acceptable value is 0\&. .\" blockquote { .RS 4 .PP For software with licenses that must be viewed and accepted, the RAD client must specify the parsable_version and accept options to allow the RAD server to return the parsable version of the image plan that contains software licenses, and to set licenses as accepted\&. .RE .\" } blockquote .PP \fIli_erecurse_all\fR (\fInullable\fR) \(em Equivalent to \-r\&. Default: False\&. .PP \fIli_erecurse_list\fR (\fInullable\fR) \(em Equivalent to \-z\&. Default: None\&. .PP \fIli_erecurse_list_count\fR \(em Number of items in li_erecurse_list array .PP \fIli_erecurse_excl\fR (\fInullable\fR) \(em Equivalent to \-Z\&. Default: None\&. .PP \fIli_erecurse_excl_count\fR \(em Number of items in li_erecurse_excl array .PP \fIsync_act\fR (\fInullable\fR) \(em Equivalent to \-\-sync\-actuators\&. Default: False\&. .PP \fIact_timeout\fR (\fInullable\fR) \(em Equivalent to \-\-sync\-actuators\-timeout\&. Default: None\&. Minimum: 0\&. .PP \fIignore_missing\fR (\fInullable\fR) \(em Equivalent to \-\-ignore\-missing\&. Default: False\&. .PP \fImode\fR (\fInullable\fR) \(em The running mode\&. see PkgImage\&.mode property for valid values\&. .PP \fIresult\fR \(em The returned data\&. .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBips_PkgImage_info\fR('u .R rc_err_t \fBips_PkgImage_info\fR(rc_instance_t\ *inst, . const\ char\ **pkg_fmri_patterns, . int\ pkg_fmri_patterns_count, . boolean_t\ *license_only, . boolean_t\ *info_local, . boolean_t\ *info_remote, . const\ char\ **origins, . int\ origins_count, . const\ char\ *mode, . rc_instance_t\ ***result, . int\ *result_cnt, . ips_PkgError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Operation to retrieve information about packages\&. .PP Operation for getting package information\&. This operation is equivalent to the pkg info command\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIpkg_fmri_patterns\fR (\fInullable\fR) \(em Packages for which you want information\&. .PP \fIpkg_fmri_patterns_count\fR \(em Number of items in pkg_fmri_patterns array .PP \fIlicense_only\fR (\fInullable\fR) \(em Equivalent to \-\-license\&. Default: False\&. .PP \fIinfo_local\fR (\fInullable\fR) \(em Equivalent to \-l\&. Default: True\&. .PP \fIinfo_remote\fR (\fInullable\fR) \(em Equivalent to \-r\&. Default: False\&. .PP \fIorigins\fR (\fInullable\fR) \(em Equivalent to \-g\&. Default: None\&. .PP \fIorigins_count\fR \(em Number of items in origins array .PP \fImode\fR (\fInullable\fR) \(em The running mode\&. see PkgImage\&.mode property for valid values\&. .PP \fIresult\fR \(em Return a list of PkgInfo objects\&. .PP \fIresult_cnt\fR \(em Number of items in result array .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBips_PkgImage_publisher\fR('u .R rc_err_t \fBips_PkgImage_publisher\fR(rc_instance_t\ *inst, . const\ char\ **publishers, . int\ publishers_count, . boolean_t\ *preferred_only, . boolean_t\ *include_disabled, . const\ char\ *mode, . rc_instance_t\ ***result, . int\ *result_cnt, . ips_PkgError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Operation to list publishers\&. .PP Operation for listing publishers and some of their attributes Equivalent to the pkg publisher command\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIpublishers\fR (\fInullable\fR) \(em Publishers to list\&. .PP \fIpublishers_count\fR \(em Number of items in publishers array .PP \fIpreferred_only\fR (\fInullable\fR) \(em Equivalent to \-P\&. Default: False\&. .PP \fIinclude_disabled\fR (\fInullable\fR) \(em Opposite to \-n\&. Default: True\&. .PP \fImode\fR (\fInullable\fR) \(em The running mode\&. see PkgImage\&.mode property for valid values\&. .PP \fIresult\fR \(em Return a list of PkgPublisher objects\&. .PP \fIresult_cnt\fR \(em Number of items in result array .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBips_PkgImage_set_publisher\fR('u .R rc_err_t \fBips_PkgImage_set_publisher\fR(rc_instance_t\ *inst, . const\ char\ **publishers, . int\ publishers_count, . const\ char\ *ssl_key, . const\ char\ *ssl_cert, . const\ char\ **approved_ca_certs, . int\ approved_ca_certs_count, . const\ char\ **revoked_ca_certs, . int\ revoked_ca_certs_count, . const\ char\ **unset_ca_certs, . int\ unset_ca_certs_count, . const\ char\ *origin_uri, . boolean_t\ *reset_uuid, . const\ char\ **add_mirrors, . int\ add_mirrors_count, . const\ char\ **remove_mirrors, . int\ remove_mirrors_count, . const\ char\ **add_origins, . int\ add_origins_count, . const\ char\ **remove_origins, . int\ remove_origins_count, . boolean_t\ *refresh_allowed, . boolean_t\ *disable, . boolean_t\ *sticky, . const\ char\ *repo_uri, . const\ char\ *proxy_uri, . const\ char\ **set_props, . int\ set_props_count, . const\ char\ **add_prop_values, . int\ add_prop_values_count, . const\ char\ **remove_prop_values, . int\ remove_prop_values_count, . const\ char\ **unset_props, . int\ unset_props_count, . const\ char\ *search_before, . const\ char\ *search_after, . const\ char\ *search_first, . const\ char\ *mode, . ips_PkgReturn_t\ **result, . ips_PkgError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Set property value\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIpublishers\fR (\fInullable\fR) \(em Publishers to set\&. .PP \fIpublishers_count\fR \(em Number of items in publishers array .PP \fIssl_key\fR (\fInullable\fR) \(em Equivalent to \-k\&. Default: None\&. .PP \fIssl_cert\fR (\fInullable\fR) \(em Equivalent to \-c\&. Default: None\&. .PP \fIapproved_ca_certs\fR (\fInullable\fR) \(em Equivalent to \-\-approve\-ca\-cert\&. Default: None\&. .PP \fIapproved_ca_certs_count\fR \(em Number of items in approved_ca_certs array .PP \fIrevoked_ca_certs\fR (\fInullable\fR) \(em Equivalent to \-\-revoke\-ca\-cert\&. Default: None\&. .PP \fIrevoked_ca_certs_count\fR \(em Number of items in revoked_ca_certs array .PP \fIunset_ca_certs\fR (\fInullable\fR) \(em Equivalent to \-\-unset\-ca\-cert\&. Default: None\&. .PP \fIunset_ca_certs_count\fR \(em Number of items in unset_ca_certs array .PP \fIorigin_uri\fR (\fInullable\fR) \(em Add a single origin or replace existing origins with the one specified\&. Compare with add_origins\&. Default: None\&. .PP \fIreset_uuid\fR (\fInullable\fR) \(em Equivalent to \-\-reset\-uuid\&. Default: False\&. .PP \fIadd_mirrors\fR (\fInullable\fR) \(em Equivalent to \-m\&. Default: None\&. .PP \fIadd_mirrors_count\fR \(em Number of items in add_mirrors array .PP \fIremove_mirrors\fR (\fInullable\fR) \(em Equivalent to \-M\&. Default: None\&. .PP \fIremove_mirrors_count\fR \(em Number of items in remove_mirrors array .PP \fIadd_origins\fR (\fInullable\fR) \(em Equivalent to \-g\&. Default: None\&. .PP \fIadd_origins_count\fR \(em Number of items in add_origins array .PP \fIremove_origins\fR (\fInullable\fR) \(em Equivalent to \-G\&. Default: None\&. .PP \fIremove_origins_count\fR \(em Number of items in remove_origins array .PP \fIrefresh_allowed\fR (\fInullable\fR) \(em Opposite to \-\-no\-refresh\&. Default: True\&. .PP \fIdisable\fR (\fInullable\fR) \(em Equivalent to \-\-disable\&. Default: False\&. .PP \fIsticky\fR (\fInullable\fR) \(em Equivalent to \-\-sticky\&. Default: True\&. .PP \fIrepo_uri\fR (\fInullable\fR) \(em Equivalent to \-\-p\&. Default: None\&. .PP \fIproxy_uri\fR (\fInullable\fR) \(em Equivalent to \-\-proxy\&. Default: None\&. .PP \fIset_props\fR (\fInullable\fR) \(em Equivalent to \-\-set\-property\&. Default: None\&. .PP \fIset_props_count\fR \(em Number of items in set_props array .PP \fIadd_prop_values\fR (\fInullable\fR) \(em Equivalent to \-\-add\-property\-value\&. Default: None\&. .PP \fIadd_prop_values_count\fR \(em Number of items in add_prop_values array .PP \fIremove_prop_values\fR (\fInullable\fR) \(em Equivalent to \-\-remove\-property\-value\&. Default: None\&. .PP \fIremove_prop_values_count\fR \(em Number of items in remove_prop_values array .PP \fIunset_props\fR (\fInullable\fR) \(em Equivalent to \-\-unset\-property\&. Default: None\&. .PP \fIunset_props_count\fR \(em Number of items in unset_props array .PP \fIsearch_before\fR (\fInullable\fR) \(em Equivalent to \-\-search\-before\&. Default: None\&. .PP \fIsearch_after\fR (\fInullable\fR) \(em Equivalent to \-\-search\-after\&. Default: None\&. .PP \fIsearch_first\fR (\fInullable\fR) \(em Equivalent to \-\-search\-first\&. Default: None\&. .PP \fImode\fR (\fInullable\fR) \(em The running mode\&. see PkgImage\&.mode property for valid values\&. .PP \fIresult\fR \(em The returned data\&. .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBips_PkgImage_unset_publisher\fR('u .R rc_err_t \fBips_PkgImage_unset_publisher\fR(rc_instance_t\ *inst, . const\ char\ **publishers, . int\ publishers_count, . const\ char\ *mode, . ips_PkgReturn_t\ **result, . ips_PkgError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Unsetting publishers operation\&. .PP Operation for removing a publisher\&. Equivalent to the pkg unset\-publisher command\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIpublishers\fR (\fInullable\fR) \(em Publishers to be removed\&. .PP \fIpublishers_count\fR \(em Number of items in publishers array .PP \fImode\fR (\fInullable\fR) \(em The running mode\&. see PkgImage\&.mode property for valid values\&. .PP \fIresult\fR \(em The returned data\&. .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 \fBPkgImage Retrieve\fR .RS 4 .nf .HP \w'rc_err_t\ \fBips_PkgImage__rad_get_name\fR('u .R rc_err_t \fBips_PkgImage__rad_get_name\fR(adr_name_t\ **result, . int\ n, . \&.\&.\&.); .RS .RE .fi .\" blockquote { .RS 4 .PP Obtain RAD name of a PkgImage 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\ \fBips_PkgImage__rad_lookup\fR('u .R rc_err_t \fBips_PkgImage__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 PkgImage 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\ \fBips_PkgImage__rad_list\fR('u .R rc_err_t \fBips_PkgImage__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 PkgImage 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 \fBPkgImage Events\fR .RS 4 .PP \fIprogress\fR .\" blockquote { .RS 4 .PP Report pkg operation progress\&. This event is used for time\-consuming operations such as \'install\', \'update\', and \'uninstall\'\&. The event payload is a PkgProgress struct .nf .HP \w'typedef\ void\ \fB(*ips_PkgImage_progress_cb_f)\fR('u .R typedef void \fB(*ips_PkgImage_progress_cb_f)\fR(rc_instance_t\ *inst, . ips_PkgProgress_t\ *payload, . struct\ timespec\ ts, . void\ *arg); .RS .RE .fi .\" blockquote { .RS 4 .PP Function invoked when event "progress" 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\ \fBips_PkgImage_subscribe_progress\fR('u .R rc_err_t \fBips_PkgImage_subscribe_progress\fR(rc_instance_t\ *inst, . ips_PkgImage_progress_cb_f\ cb, . void\ *arg); .RS .RE .fi .\" blockquote { .RS 4 .PP Subscribe to event "progress"\&. .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\ \fBips_PkgImage_unsubscribe_progress\fR('u .R rc_err_t \fBips_PkgImage_unsubscribe_progress\fR(rc_instance_t\ *inst, . void\ **arg); .RS .RE .fi .\" blockquote { .RS 4 .PP Unsubscribe from event "progress"\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIarg\fR \(em User data returned .RE .\" } blockquote .RE .\" } blockquote .RE .SS "interface IPSManager" .PP Singleton interface providing package image\-related operations\&. serves as an entry point\&. .sp .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBIPSManager Methods\fR .RS 4 .nf .HP \w'rc_err_t\ \fBips_IPSManager_image_create\fR('u .R rc_err_t \fBips_IPSManager_image_create\fR(rc_instance_t\ *inst, . const\ char\ *image_path, . rc_instance_t\ **result, . ips_PkgError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Create a package image on the disk and create a corresponding PkgImage instance\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIimage_path\fR \(em Image path for creating an image\&. .PP \fIresult\fR .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBips_IPSManager_image_remove\fR('u .R rc_err_t \fBips_IPSManager_image_remove\fR(rc_instance_t\ *inst, . const\ adr_name_t\ *name, . ips_PkgError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Remove a package image on the disk and also remove the corresponding PkgImage instance\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIname\fR \(em RAD ADR name object for removing the associated PkgImage instance\&. .PP \fIerror\fR .RE .\" } blockquote .nf .HP \w'rc_err_t\ \fBips_IPSManager_image_open\fR('u .R rc_err_t \fBips_IPSManager_image_open\fR(rc_instance_t\ *inst, . const\ char\ *image_path, . rc_instance_t\ **result, . ips_PkgError_t\ **error); .RS .RE .fi .\" blockquote { .RS 4 .PP Create a PkgImage instance based on an existing pkg image on the disk\&. .PP \fBArguments:\fR .PP \fIinst\fR \(em RAD instance .PP \fIimage_path\fR \(em Image path to create a PkgImage instance for an existing image on the disk\&. .PP \fIresult\fR .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 \fBIPSManager Retrieve\fR .RS 4 .nf .HP \w'rc_err_t\ \fBips_IPSManager__rad_get_name\fR('u .R rc_err_t \fBips_IPSManager__rad_get_name\fR(adr_name_t\ **result, . int\ n, . \&.\&.\&.); .RS .RE .fi .\" blockquote { .RS 4 .PP Obtain RAD name of a IPSManager 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\ \fBips_IPSManager__rad_lookup\fR('u .R rc_err_t \fBips_IPSManager__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 IPSManager 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\ \fBips_IPSManager__rad_list\fR('u .R rc_err_t \fBips_IPSManager__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 IPSManager 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 PkgRetErrCode\fR \(em This enum contains a list of codes for pkg operation return or error\&. .\" blockquote { .RS 4 .PP .nf typedef enum ips_PkgRetErrCode { IPREC_OK = 0, IPREC_GENERAL_ERROR = 1, IPREC_BAD_ARGS = 2, IPREC_PARTIAL_SUCCEED = 3, IPREC_NO_OP = 4, IPREC_NO_PERMIT_LIVE = 5, IPREC_LICENSE_ACCEPT = 6, IPREC_IMAGE_LOCKED = 7, IPREC_ACTUATOR_TIMEOUT = 8, IPREC_UNANTICIPATED = 99, } ips_PkgRetErrCode_t; .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP IPREC_OK (0) \(em Operation succeeded\&. .PP IPREC_GENERAL_ERROR (1) \(em General error\&. .PP IPREC_BAD_ARGS (2) \(em Argument usage error\&. .PP IPREC_PARTIAL_SUCCEED (3) \(em Multiple operations were requested, but not all succeeded\&. .PP IPREC_NO_OP (4) \(em Nothing to do\&. .PP IPREC_NO_PERMIT_LIVE (5) \(em The requested operation cannot be performed on a live image\&. .PP IPREC_LICENSE_ACCEPT (6) \(em License acceptance required for requested operation\&. .PP IPREC_IMAGE_LOCKED (7) \(em Image is currently locked by another process\&. .PP IPREC_ACTUATOR_TIMEOUT (8) \(em Actuator timed out\&. .PP IPREC_UNANTICIPATED (99) \(em An unanticipated error occurred\&. .RE .\" } blockquote .SH "STRUCTURED TYPES" .PP \fBstruct PkgProgress\fR \(em This struct is used as the progress event payload\&. .\" blockquote { .RS 4 .PP typedef struct ips_PkgProgress ips_PkgProgress_t; .PP .nf struct ips_PkgProgress { char *ipp_phase; char *ipp_message; char *ipp_time_taken; char *ipp_time_unit; char *ipp_action_type; char *ipp_processed_items; char *ipp_goal_items; char *ipp_percent_done; char *ipp_item_unit; char *ipp_speed; char **ipp_running; int ipp_running_count; char *ipp_goal_processed_items; char *ipp_reversioned_items; char *ipp_goal_reversion_items; char *ipp_adjusted_items; char **ipp_li_output; int ipp_li_output_count; char **ipp_li_errors; int ipp_li_errors_count; }; .fi .nf .HP \w'void\ \fBips_PkgProgress_free\fR('u .R void \fBips_PkgProgress_free\fR(ips_PkgProgress_t\ *in); .RS .RE .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP Phase and message fields always have content\&. Examples of phases include Planning, Download, Actions\&. \'Utility\' indicates a pkg utility operation is running\&. Other fields are optional and null in most cases\&. Those fields are documented in per field section\&. The particular implementation should be able to cope with those optional fields defensively\&. .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBFields:\fR .PP \fIipp_phase\fR \(em Current operating phase\&. .PP \fIipp_message\fR \(em Event message for a phase\&. .PP \fIipp_time_taken\fR \(em Indicate the total time taken\&. Currently expected on some task complete events including planning, downloading, action activities and archiving\&. Note a phase ending event does not necessarily set this field\&. A phase usually contains several tasks\&. Therefore setting this field sometimes occurs within a phase\&. .PP \fIipp_time_unit\fR \(em Units for a time value\&. A time_unit is always provided with time_taken\&. Example value: second .PP \fIipp_action_type\fR \(em The action type for an action activity\&. The action_type is only provided with phases involving action activities\&. .PP \fIipp_processed_items\fR \(em Current number of items processed, where the items are countable items such as manifests, actions, packages, bytes and linked images\&. .PP \fIipp_goal_items\fR \(em Total number of items to process for an event, where the items are countable items such as manifests, actions, bytes and linked images\&. .PP \fIipp_percent_done\fR \(em Percent complete for the current task\&. For tasks such as fetching manifests, downloading and archiving\&. .PP \fIipp_item_unit\fR \(em The unit of an item, which can be the same as the type of the item\&. Example values: byte, action and manifest\&. Always provided with item related fields\&. .PP \fIipp_speed\fR \(em The speed for a phase\&. Currently only on download phase\&. Example value: cache, \-\- and M/s\&. cache indicates source is from cache\&. \-\- indicates no speed available\&. .PP \fIipp_running\fR \(em Indicate which linked images the operations is running\&. Only provided with event reporting linked image status\&. .PP \fIipp_running_count\fR .PP \fIipp_goal_processed_items\fR \(em Total number of items to process for a reversion task\&. Compare with goal_items and goal_reversion_items\&. .PP \fIipp_reversioned_items\fR \(em Current number of items reversioned for a reversion task\&. Compare with processed_items and goal_processed_items\&. .PP \fIipp_goal_reversion_items\fR \(em Total number of items to reversion for a reversion task\&. Compare with goal_items\&. .PP \fIipp_adjusted_items\fR \(em Current number of items adjusted for a reversion task\&. .PP \fIipp_li_output\fR \(em Linked image output\&. This is a list of output lines\&. .PP \fIipp_li_output_count\fR .PP \fIipp_li_errors\fR \(em Linked image errors output\&. This is a list of error output lines\&. .PP \fIipp_li_errors_count\fR .RE .\" } blockquote .PP \fBstruct PkgError\fR \(em This struct is used as general error payload for pkg\-related methods\&. .\" blockquote { .RS 4 .PP typedef struct ips_PkgError ips_PkgError_t; .PP .nf struct ips_PkgError { ips_PkgRetErrCode_t ipe_error_code; char *ipe_error_message; }; .fi .nf .HP \w'void\ \fBips_PkgError_free\fR('u .R void \fBips_PkgError_free\fR(ips_PkgError_t\ *in); .RS .RE .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBFields:\fR .PP \fIipe_error_code\fR \(em Error code\&. .\" blockquote { .RS 4 .PP Current possible values are listed in PkgRetErrCode enum but not include values OK, NO_OP and ACTUATOR_TIMEOUT\&. .RE .\" } blockquote .PP \fIipe_error_message\fR \(em Error message\&. .RE .\" } blockquote .PP \fBstruct PkgProperty\fR \(em This struct is used to represent a PkgPublisher\-related property\&. .\" blockquote { .RS 4 .PP typedef struct ips_PkgProperty ips_PkgProperty_t; .PP .nf struct ips_PkgProperty { char *ipp_name; char **ipp_value; int ipp_value_count; }; .fi .nf .HP \w'void\ \fBips_PkgProperty_free\fR('u .R void \fBips_PkgProperty_free\fR(ips_PkgProperty_t\ *in); .RS .RE .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBFields:\fR .PP \fIipp_name\fR \(em Property name\&. .PP \fIipp_value\fR \(em Property value\&. .PP \fIipp_value_count\fR .RE .\" } blockquote .PP \fBstruct PkgReturn\fR \(em Served as a general pkg\-related method return value for operations such as install and uninstall\&. .\" blockquote { .RS 4 .PP typedef struct ips_PkgReturn ips_PkgReturn_t; .PP .nf struct ips_PkgReturn { ips_PkgRetErrCode_t ipr_return_code; char *ipr_parsable_data; }; .fi .nf .HP \w'void\ \fBips_PkgReturn_free\fR('u .R void \fBips_PkgReturn_free\fR(ips_PkgReturn_t\ *in); .RS .RE .fi .RE .\" } blockquote .\" blockquote { .RS 4 .PP \fBFields:\fR .PP \fIipr_return_code\fR \(em Return code\&. .\" blockquote { .RS 4 .PP Current possible values are OK, NO_OP and ACTUATOR_TIMEOUT\&. .RE .\" } blockquote .PP \fIipr_parsable_data\fR \(em Parsable return data as JSON formatted string\&. .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\-ips 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.ips_1 .fi .RE