irods  4.2.8
About: iRODS (the integrated Rule Oriented Data System) is a distributed data-management system for creating data grids, digital libraries, persistent archives, and real-time data systems.
  Fossies Dox: irods-4.2.8.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

Collaboration diagram for Client Administration Operations:

Functions

int rcGeneralAdmin (rcComm_t *conn, generalAdminInp_t *generalAdminInp)
 
int rcGeneralRowInsert (rcComm_t *conn, generalRowInsertInp_t *generalRowInsertInp)
 
int rcGeneralRowPurge (rcComm_t *conn, generalRowPurgeInp_t *generalRowPurgeInp)
 
int rcGeneralUpdate (rcComm_t *conn, generalUpdateInp_t *generalUpdateInp)
 
int rcUserAdmin (rcComm_t *conn, userAdminInp_t *userAdminInp)
 

Detailed Description

Function Documentation

◆ rcGeneralAdmin()

rcGeneralAdmin ( rcComm_t conn,
generalAdminInp_t generalAdminInp 
)
Description:\n Perform a general-administrative function.
Primary User:\n client (the API is restricted to admin users only)
Since
.5
Remarks
Perform a administrative function.
This is used extensively from iadmin.
The input is a set of text strings to be parsed on the server side.
This allows this same API to be easily extended with new functionality
and well managed backward compatability. See rsGeneralAdmin.cpp (and
iadmin.c) for how this is parsed and how it interfaces to the
catalog-high-level (chl*) functions.
Primary results are changes to rows in the ICAT database.
Note
none
Example Usage:\n
Parameters
[in]conn- A rcComm_t connection handle to the server
[in]generalAdminInp- input general-admin structure
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 49 of file rcGeneralAdmin.cpp.

References GENERAL_ADMIN_AN, NULL, procApiRequest(), and irods.pypyodbc::status.

Referenced by msi_update_unixfilesystem_resource_free_space(), and rsGeneralAdmin().

Here is the call graph for this function:

◆ rcGeneralRowInsert()

rcGeneralRowInsert ( rcComm_t conn,
generalRowInsertInp_t generalRowInsertInp 
)
Description:\n Insert rows into special purpose tables. Admin only.
Primary User:\n client (the API is restricted to admin users only)
Since
.5
Remarks
This client/server call is used to insert rows into certain special-purpose tables. See the rs file for the current list. Admin only. Also see generalRowPurge.
Note
none
Example Usage:\n
Parameters
[in]conn- A rcComm_t connection handle to the server
[in]generalRowInsertInp
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 36 of file rcGeneralRowInsert.cpp.

References GENERAL_ROW_INSERT_AN, NULL, procApiRequest(), and irods.pypyodbc::status.

Referenced by rsGeneralRowInsert().

Here is the call graph for this function:

◆ rcGeneralRowPurge()

rcGeneralRowPurge ( rcComm_t conn,
generalRowPurgeInp_t generalRowPurgeInp 
)
Description:\n Purge rows from special purpose tables. Admin only.
Primary User:\n client (the API is restricted to admin users only)
Since
.5
Remarks
This client/server calls is used to purge rows from certain special-purpose tables. See the rs file for the current list. Admin only. Also see generalRowInsert.
Note
none
Example Usage:\n
Parameters
[in]conn- A rcComm_t connection handle to the server
[in]generalRowPurgeInp
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 36 of file rcGeneralRowPurge.cpp.

References GENERAL_ROW_PURGE_AN, NULL, procApiRequest(), and irods.pypyodbc::status.

Referenced by rsGeneralRowPurge().

Here is the call graph for this function:

◆ rcGeneralUpdate()

rcGeneralUpdate ( rcComm_t conn,
generalUpdateInp_t generalUpdateInp 
)
Description:\n Add or remove rows from tables. Admin only.
Primary User:\n client (the API is restricted to admin users only)
Since
.5
Remarks
This call performs either a generalInsert or generalDelete call, which can add or remove specified rows from tables using input parameters similar to the generalQuery. This is restricted to irods-admin users.
Note
none
Example Usage:\n
Parameters
[in]conn- A rcComm_t connection handle to the server
[in]generalUpdateInp
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 41 of file rcGeneralUpdate.cpp.

References GENERAL_UPDATE_AN, NULL, procApiRequest(), and irods.pypyodbc::status.

Referenced by rsGeneralUpdate().

Here is the call graph for this function:

◆ rcUserAdmin()

rcUserAdmin ( rcComm_t conn,
userAdminInp_t userAdminInp 
)
Description:\n Perform a user-administrative function.
Primary User:\n client
Since
1.0 (or so)
Remarks
Perform a user administrative function.
This is similar to general-admin but is for the regular, non-admin, users.
The input is a set of text strings to be parsed on the server side.
This allows this same API to be easily extended with new functionality
and well managed backward compatability. This is used, for example,
to allow users to change their passwords (ipasswd).
Primary results are changes to rows in the ICAT database.
Note
none
Example Usage:\n
Parameters
[in]conn- A rcComm_t connection handle to the server
[in]userAdminInp- input user-admin structure
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 49 of file rcUserAdmin.cpp.

References NULL, procApiRequest(), irods.pypyodbc::status, and USER_ADMIN_AN.

Referenced by rsUserAdmin().

Here is the call graph for this function: