Class: Repository
Repository for updates
Fields for class: Repository
| Field | Type | Qualifier | Description |
|---|---|---|---|
binary_url |
string |
RO/constructor | Base URL of binary packages in this repository |
certificate |
string |
RO/constructor | The certificate of the host which hosts this repository |
gpgkey_path |
string |
RO/constructor | The file name of the GPG public key of this repository |
hash |
string |
RO/runtime | SHA256 checksum of latest updateinfo.xml.gz in this repository if its 'update' is true |
name_description |
string |
RW | a notes field containing human-readable description |
name_label |
string |
RW | a human-readable name |
origin |
origin |
RO/constructor | The origin of this repository. 'remote' if the origin of the repository is a remote one, 'bundle' if the origin of the repository is a local bundle file, 'remote_pool' if the origin of the repository is a remote pool |
source_url |
string |
RO/constructor | Base URL of source packages in this repository |
up_to_date |
bool |
RO/runtime | Removed. True if all hosts in pool is up to date with this repository |
update |
bool |
RO/constructor | True if updateinfo.xml in this repository needs to be parsed |
uuid |
string |
RO/runtime | Unique identifier/object reference |
RPCs associated with class: Repository
RPC name: forget
Overview:
Remove the repository record from the database
Signature:
void forget (session ref session_ref, Repository ref self)
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Repository ref |
self |
The repository to be removed from the database |
Minimum Role: client-cert
Return Type:
void
RPC name: getall
Overview:
Return a list of all the Repositorys known to the system.
Signature:
Repository ref set get_all (session ref session_ref)
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Minimum Role: read-only
Return Type:
Repository ref set
references to all objects
RPC name: getallrecords
Overview:
Return a map of Repository references to Repository records for all Repositorys known to the system.
Signature:
(Repository ref -> Repository record) map get_all_records (session ref session_ref)
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Minimum Role: read-only
Return Type:
(Repository ref -> Repository record) map
records of all objects
RPC name: getbinaryurl
Overview:
Get the binaryurl field of the given Repository.
Signature:
string get_binary_url (session ref session_ref, Repository ref self)
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Repository ref |
self |
reference to the object |
Minimum Role: read-only
Return Type:
string
value of the field
RPC name: getbynamelabel
Overview:
Get all the Repository instances with the given label.
Signature:
Repository ref set get_by_name_label (session ref session_ref, string label)
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
string |
label |
label of object to return |
Minimum Role: read-only
Return Type:
Repository ref set
references to objects with matching names
RPC name: getbyuuid
Overview:
Get a reference to the Repository instance with the specified UUID.
Signature:
Repository ref get_by_uuid (session ref session_ref, string uuid)
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
string |
uuid |
UUID of object to return |
Minimum Role: read-only
Return Type:
Repository ref
reference to the object
RPC name: getcertificate
Overview:
Get the certificate field of the given Repository.
Signature:
string get_certificate (session ref session_ref, Repository ref self)
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Repository ref |
self |
reference to the object |
Minimum Role: read-only
Return Type:
string
value of the field
RPC name: getgpgkeypath
Overview:
Get the gpgkeypath field of the given Repository.
Signature:
string get_gpgkey_path (session ref session_ref, Repository ref self)
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Repository ref |
self |
reference to the object |
Minimum Role: read-only
Return Type:
string
value of the field
RPC name: gethash
Overview:
Get the hash field of the given Repository.
Signature:
string get_hash (session ref session_ref, Repository ref self)
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Repository ref |
self |
reference to the object |
Minimum Role: read-only
Return Type:
string
value of the field
RPC name: getnamedescription
Overview:
Get the name/description field of the given Repository.
Signature:
string get_name_description (session ref session_ref, Repository ref self)
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Repository ref |
self |
reference to the object |
Minimum Role: read-only
Return Type:
string
value of the field
RPC name: getnamelabel
Overview:
Get the name/label field of the given Repository.
Signature:
string get_name_label (session ref session_ref, Repository ref self)
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Repository ref |
self |
reference to the object |
Minimum Role: read-only
Return Type:
string
value of the field
RPC name: getorigin
Overview:
Get the origin field of the given Repository.
Signature:
origin get_origin (session ref session_ref, Repository ref self)
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Repository ref |
self |
reference to the object |
Minimum Role: read-only
Return Type:
origin
value of the field
RPC name: getrecord
Overview:
Get a record containing the current state of the given Repository.
Signature:
Repository record get_record (session ref session_ref, Repository ref self)
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Repository ref |
self |
reference to the object |
Minimum Role: read-only
Return Type:
Repository record
all fields from the object
RPC name: getsourceurl
Overview:
Get the sourceurl field of the given Repository.
Signature:
string get_source_url (session ref session_ref, Repository ref self)
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Repository ref |
self |
reference to the object |
Minimum Role: read-only
Return Type:
string
value of the field
RPC name: getuptodate
This message is removed.
Overview:
Get the uptodate field of the given Repository.
Signature:
bool get_up_to_date (session ref session_ref, Repository ref self)
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Repository ref |
self |
reference to the object |
Minimum Role: read-only
Return Type:
bool
value of the field
RPC name: getupdate
Overview:
Get the update field of the given Repository.
Signature:
bool get_update (session ref session_ref, Repository ref self)
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Repository ref |
self |
reference to the object |
Minimum Role: read-only
Return Type:
bool
value of the field
RPC name: getuuid
Overview:
Get the uuid field of the given Repository.
Signature:
string get_uuid (session ref session_ref, Repository ref self)
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Repository ref |
self |
reference to the object |
Minimum Role: read-only
Return Type:
string
value of the field
RPC name: introduce
Overview:
Add the configuration for a new remote repository
Signature:
Repository ref introduce (session ref session_ref, string name_label, string name_description, string binary_url, string source_url, bool update, string gpgkey_path)
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
string |
name_label |
The name of the repository |
string |
name_description |
The description of the repository |
string |
binary_url |
Base URL of binary packages in this repository |
string |
source_url |
Base URL of source packages in this repository |
bool |
update |
True if the repository is an update repository. This means that updateinfo.xml will be parsed |
string |
gpgkey_path |
The GPG public key file name |
Minimum Role: client-cert
Return Type:
Repository ref
The ref of the created repository record.
RPC name: introducebundle
Overview:
Add the configuration for a new bundle repository
Signature:
Repository ref introduce_bundle (session ref session_ref, string name_label, string name_description)
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
string |
name_label |
The name of the repository |
string |
name_description |
The description of the repository |
Minimum Role: client-cert
Return Type:
Repository ref
The ref of the created repository record.
RPC name: introduceremotepool
Overview:
Add the configuration for a new remote pool repository
Signature:
Repository ref introduce_remote_pool (session ref session_ref, string name_label, string name_description, string binary_url, string certificate)
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
string |
name_label |
The name of the repository |
string |
name_description |
The description of the repository |
string |
binary_url |
Base URL of binary packages in the local repository of this remote pool in https://<coordinator-ip>/repository/enabled format |
string |
certificate |
The host certificate of the coordinator of the remote pool |
Minimum Role: client-cert
Return Type:
Repository ref
The ref of the created repository record.
RPC name: setgpgkeypath
Overview:
Set the file name of the GPG public key of the repository
Signature:
void set_gpgkey_path (session ref session_ref, Repository ref self, string value)
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Repository ref |
self |
The repository |
string |
value |
The file name of the GPG public key of the repository |
Minimum Role: client-cert
Return Type:
void
RPC name: setnamedescription
Overview:
Set the name/description field of the given Repository.
Signature:
void set_name_description (session ref session_ref, Repository ref self, string value)
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Repository ref |
self |
reference to the object |
string |
value |
New value to set |
Minimum Role: client-cert
Return Type:
void
RPC name: setnamelabel
Overview:
Set the name/label field of the given Repository.
Signature:
void set_name_label (session ref session_ref, Repository ref self, string value)
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Repository ref |
self |
reference to the object |
string |
value |
New value to set |
Minimum Role: client-cert
Return Type:
void