Go to main content

man pages section 3: Remote Administration Daemon Module Interfaces

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

modules-1 (3rad)

Name

modules-1 - API for RAD module enumeration

Synopsis

#include <rad/client/1/modules.h>
cc [ flag... ] file... -lmodules1_client [ library... ]

interface Modules
modules_Module_t ** modules ; (ro)

Structured Types
struct Module

typedef struct modules_Module modules_Module_t;

struct modules_Module {
char *mm_name;
char *mm_version;
char *mm_namespace;
char *mm_description;
};


void modules_Module_free(modules_Module_t *in);

Description

MODULES-1(3rad)             RAD Module Definitions             MODULES-1(3rad)



NAME
       modules - API for RAD module enumeration

SYNOPSIS
       #include <rad/client/1/modules.h>
       cc [ flag... ] file... -lmodules1_client [ library... ]

   interface Modules
       modules_Module_t ** modules ; (ro)

   Structured Types
       struct Module

           typedef struct modules_Module modules_Module_t;

           struct modules_Module {
                char *mm_name;
                char *mm_version;
                char *mm_namespace;
                char *mm_description;
           };


           void modules_Module_free(modules_Module_t *in);

DESCRIPTION
       API com.oracle.solaris.rad.modules [1]

INTERFACES
   interface Modules
       Modules Properties
           modules_Module_t ** modules (read-only)

               rc_err_t modules_Modules_get_modules(rc_instance_t *inst,
                                                    modules_Module_t ***result,
                                                    int *result_cnt);

                   Get property value.

                   Arguments:

                   inst -- RAD instance

                   result -- Property value returned

                   result_cnt -- Number of items in result array

       Modules Retrieve
           rc_err_t modules_Modules__rad_get_name(adr_name_t **result,
                                                  int n,
                                                  ...);

               Obtain RAD name of a Modules object.

               Arguments:

               result -- RAD name

               n -- Number of key-value pairs provided as variadic arguments

               ... -- Optional key-value pairs that compose the primary key

           rc_err_t modules_Modules__rad_lookup(rc_conn_t *c,
                                                boolean_t strict,
                                                rc_instance_t **result,
                                                int n,
                                                ...);

               Lookup a Modules instance.

               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.

               Arguments:

               c -- RAD connection handle

               strict -- Strict (B_TRUE) or relaxed (B_FALSE) versioning

               result -- RAD instance

               n -- Number of key-value pairs provided as variadic arguments

               ... -- Optional key-value pairs that compose the primary key

           rc_err_t modules_Modules__rad_list(rc_conn_t *c,
                                              boolean_t strict,
                                              adr_pattern_scheme_t scheme,
                                              adr_name_t ***result,
                                              int *result_count,
                                              int n,
                                              ...);

               List RAD names of a available Modules instances.

               Returns an array and array size of matching object names.

               Arguments:

               c -- RAD connection handle

               strict -- Strict (B_TRUE) or relaxed (B_FALSE) versioning

               scheme -- Apply glob (NS_GLOB) or regex (NS_REGEX) matching

               result -- Array of RAD names

               result_count -- Number of names in result array

               n -- Number of key-value pairs provided as variadic arguments

               ... -- Optional key-value pairs that compose the primary key

STRUCTURED TYPES
       struct Module

           typedef struct modules_Module modules_Module_t;

           struct modules_Module {
                char *mm_name;
                char *mm_version;
                char *mm_namespace;
                char *mm_description;
           };


           void modules_Module_free(modules_Module_t *in);

           Fields:

           mm_name

           mm_version

           mm_namespace

           mm_description

VERSION
       1.0

ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:

       +--------------------+-----------------------+
       |  ATTRIBUTE TYPE    |    ATTRIBUTE VALUE    |
       +--------------------+-----------------------+
       |Availability        | system/management/rad |
       +--------------------+-----------------------+
       |Interface Stability | Private               |
       +--------------------+-----------------------+

SEE ALSO
       rad(8)

NOTES
        1. Accessing Python documentation for this module:

           $ pydoc rad.bindings.com.oracle.solaris.rad.modules_1





Solaris 11.4                      2017-02-01                   MODULES-1(3rad)