Develop for XenServer

Class: Repository

October 11, 2024

Contributed by:

X X

Repository for updates

Fields for class: Repository

Field	Type	Qualifier	Description
`binary_url`	`string`	RO/constructor	Base URL of binary packages in 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 the repository. ‘remote’ if the origin of the repository is a remote one, ‘bundle’ if the origin of the repository is a local bundle file.
`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)
<!--NeedCopy-->

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: get_all

Overview:

Return a list of all the Repositorys known to the system.

Signature:

Repository ref set get_all (session ref session_ref)
<!--NeedCopy-->

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: get_all_records

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)
<!--NeedCopy-->

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: get_binary_url

Overview:

Get the binary_url field of the given Repository.

Signature:

string get_binary_url (session ref session_ref, Repository ref self)
<!--NeedCopy-->

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: get_by_name_label

Overview:

Get all the Repository instances with the given label.

Signature:

Repository ref set get_by_name_label (session ref session_ref, string label)
<!--NeedCopy-->

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: get_by_uuid

Overview:

Get a reference to the Repository instance with the specified UUID.

Signature:

Repository ref get_by_uuid (session ref session_ref, string uuid)
<!--NeedCopy-->

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: get_gpgkey_path

Overview:

Get the gpgkey_path field of the given Repository.

Signature:

string get_gpgkey_path (session ref session_ref, Repository ref self)
<!--NeedCopy-->

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: get_hash

Overview:

Get the hash field of the given Repository.

Signature:

string get_hash (session ref session_ref, Repository ref self)
<!--NeedCopy-->

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: get_name_description

Overview:

Get the name/description field of the given Repository.

Signature:

string get_name_description (session ref session_ref, Repository ref self)
<!--NeedCopy-->

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: get_name_label

Overview:

Get the name/label field of the given Repository.

Signature:

string get_name_label (session ref session_ref, Repository ref self)
<!--NeedCopy-->

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: get_origin

Overview:

Get the origin field of the given Repository.

Signature:

origin get_origin (session ref session_ref, Repository ref self)
<!--NeedCopy-->

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: get_record

Overview:

Get a record containing the current state of the given Repository.

Signature:

Repository record get_record (session ref session_ref, Repository ref self)
<!--NeedCopy-->

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: get_source_url

Overview:

Get the source_url field of the given Repository.

Signature:

string get_source_url (session ref session_ref, Repository ref self)
<!--NeedCopy-->

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: get_up_to_date

This message is removed.

Overview:

Get the up_to_date field of the given Repository.

Signature:

bool get_up_to_date (session ref session_ref, Repository ref self)
<!--NeedCopy-->

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: get_update

Overview:

Get the update field of the given Repository.

Signature:

bool get_update (session ref session_ref, Repository ref self)
<!--NeedCopy-->

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: get_uuid

Overview:

Get the uuid field of the given Repository.

Signature:

string get_uuid (session ref session_ref, Repository ref self)
<!--NeedCopy-->

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)
<!--NeedCopy-->

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: introduce_bundle

Overview:

Add the configuration for a new bundle repository

Signature:

Repository ref introduce_bundle (session ref session_ref, string name_label, string name_description)
<!--NeedCopy-->

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: set_gpgkey_path

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)
<!--NeedCopy-->

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: set_name_description

Overview:

Set the name/description field of the given Repository.

Signature:

void set_name_description (session ref session_ref, Repository ref self, string value)
<!--NeedCopy-->

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: set_name_label

Overview:

Set the name/label field of the given Repository.

Signature:

void set_name_label (session ref session_ref, Repository ref self, string value)
<!--NeedCopy-->

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

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Class: Repository

October 11, 2024

Contributed by:

X X

October 11, 2024

Contributed by:

X X

Was this helpful

Class: Repository

Fields for class: Repository

RPCs associated with class: Repository

RPC name: forget

RPC name: get_all

RPC name: get_all_records

RPC name: get_binary_url

RPC name: get_by_name_label

RPC name: get_by_uuid

RPC name: get_gpgkey_path

RPC name: get_hash

RPC name: get_name_description

RPC name: get_name_label

RPC name: get_origin

RPC name: get_record

RPC name: get_source_url

RPC name: get_up_to_date

RPC name: get_update

RPC name: get_uuid

RPC name: introduce

RPC name: introduce_bundle

RPC name: set_gpgkey_path

RPC name: set_name_description

RPC name: set_name_label

In this article