Class: Repository
Repository for updates
Published in: |
XAPI 1.301.0 (1.301.0) |
|
Fields
string
binary_url
[RO/constructor]
Base URL of binary packages in this repository
Default value: |
"" |
Published in: |
XAPI 1.301.0 (1.301.0) |
|
Prototype
string
gpgkey_path
[RO/constructor]
The file name of the GPG public key of this repository
Default value: |
"" |
Prototyped in: |
XAPI 22.12.0 (22.12.0) |
|
string
hash
[RO/runtime]
SHA256 checksum of latest updateinfo.xml.gz in this repository if its 'update' is true
Default value: |
"" |
Published in: |
XAPI 1.301.0 (1.301.0) |
|
string
name_description
[RW]
a notes field containing human-readable description
Default value: |
"" |
Published in: |
XenServer 4.0 (rio) |
a notes field containing human-readable description |
string
name_label
[RW]
a human-readable name
Default value: |
"" |
Published in: |
XenServer 4.0 (rio) |
a human-readable name |
string
source_url
[RO/constructor]
Base URL of source packages in this repository
Default value: |
"" |
Published in: |
XAPI 1.301.0 (1.301.0) |
|
Removed
bool
up_to_date
[RO/runtime]
True if all hosts in pool is up to date with this repository
Default value: |
false |
Published in: |
XAPI 1.301.0 (1.301.0) |
|
Deprecated in: |
XAPI 23.18.0 (23.18.0) |
Dummy transition |
Removed in: |
XAPI 23.18.0 (23.18.0) |
The up_to_date field of repository was removed |
bool
update
[RO/constructor]
True if updateinfo.xml in this repository needs to be parsed
Default value: |
false |
Published in: |
XAPI 1.301.0 (1.301.0) |
|
string
uuid
[RO/runtime]
Unique identifier/object reference
Published in: |
XAPI 1.301.0 (1.301.0) |
|
Messages
void
forget
(session ref, Repository ref)
Remove the repository record from the database
Parameters: |
session ref session_id |
Reference to a valid session |
|
Repository ref self |
The repository to be removed from the database |
Minimum role: |
client-cert |
Published in: |
XAPI 1.301.0 (1.301.0) |
|
Repository ref set
get_all
(session ref)
Return a list of all the Repositorys known to the system.
Parameters: |
session ref session_id |
Reference to a valid session |
Minimum role: |
read-only |
Result: |
references to all objects |
Published in: |
XAPI 1.301.0 (1.301.0) |
|
(Repository ref → Repository record) map
get_all_records
(session ref)
Return a map of Repository references to Repository records for all Repositorys known to the system.
Parameters: |
session ref session_id |
Reference to a valid session |
Minimum role: |
read-only |
Result: |
records of all objects |
Published in: |
XAPI 1.301.0 (1.301.0) |
|
string
get_binary_url
(session ref, Repository ref)
Get the binary_url field of the given Repository.
Parameters: |
session ref session_id |
Reference to a valid session |
|
Repository ref self |
reference to the object |
Minimum role: |
read-only |
Result: |
value of the field |
Published in: |
XAPI 1.301.0 (1.301.0) |
|
Repository ref set
get_by_name_label
(session ref, string)
Get all the Repository instances with the given label.
Parameters: |
session ref session_id |
Reference to a valid session |
|
string label |
label of object to return |
Minimum role: |
read-only |
Result: |
references to objects with matching names |
Published in: |
XAPI 1.301.0 (1.301.0) |
|
Repository ref
get_by_uuid
(session ref, string)
Get a reference to the Repository instance with the specified UUID.
Parameters: |
session ref session_id |
Reference to a valid session |
|
string uuid |
UUID of object to return |
Minimum role: |
read-only |
Result: |
reference to the object |
Published in: |
XAPI 1.301.0 (1.301.0) |
|
Prototype
string
get_gpgkey_path
(session ref, Repository ref)
Get the gpgkey_path field of the given Repository.
Parameters: |
session ref session_id |
Reference to a valid session |
|
Repository ref self |
reference to the object |
Minimum role: |
read-only |
Result: |
value of the field |
Prototyped in: |
XAPI 22.12.0 (22.12.0) |
|
string
get_hash
(session ref, Repository ref)
Get the hash field of the given Repository.
Parameters: |
session ref session_id |
Reference to a valid session |
|
Repository ref self |
reference to the object |
Minimum role: |
read-only |
Result: |
value of the field |
Published in: |
XAPI 1.301.0 (1.301.0) |
|
string
get_name_description
(session ref, Repository ref)
Get the name/description field of the given Repository.
Parameters: |
session ref session_id |
Reference to a valid session |
|
Repository ref self |
reference to the object |
Minimum role: |
read-only |
Result: |
value of the field |
Published in: |
XenServer 4.0 (rio) |
a notes field containing human-readable description |
string
get_name_label
(session ref, Repository ref)
Get the name/label field of the given Repository.
Parameters: |
session ref session_id |
Reference to a valid session |
|
Repository ref self |
reference to the object |
Minimum role: |
read-only |
Result: |
value of the field |
Published in: |
XenServer 4.0 (rio) |
a human-readable name |
Repository record
get_record
(session ref, Repository ref)
Get a record containing the current state of the given Repository.
Parameters: |
session ref session_id |
Reference to a valid session |
|
Repository ref self |
reference to the object |
Minimum role: |
read-only |
Result: |
all fields from the object |
Published in: |
XAPI 1.301.0 (1.301.0) |
|
string
get_source_url
(session ref, Repository ref)
Get the source_url field of the given Repository.
Parameters: |
session ref session_id |
Reference to a valid session |
|
Repository ref self |
reference to the object |
Minimum role: |
read-only |
Result: |
value of the field |
Published in: |
XAPI 1.301.0 (1.301.0) |
|
Removed
bool
get_up_to_date
(session ref, Repository ref)
Get the up_to_date field of the given Repository.
Parameters: |
session ref session_id |
Reference to a valid session |
|
Repository ref self |
reference to the object |
Minimum role: |
read-only |
Result: |
value of the field |
Published in: |
XAPI 1.301.0 (1.301.0) |
|
Deprecated in: |
XAPI 23.18.0 (23.18.0) |
Dummy transition |
Removed in: |
XAPI 23.18.0 (23.18.0) |
The up_to_date field of repository was removed |
bool
get_update
(session ref, Repository ref)
Get the update field of the given Repository.
Parameters: |
session ref session_id |
Reference to a valid session |
|
Repository ref self |
reference to the object |
Minimum role: |
read-only |
Result: |
value of the field |
Published in: |
XAPI 1.301.0 (1.301.0) |
|
string
get_uuid
(session ref, Repository ref)
Get the uuid field of the given Repository.
Parameters: |
session ref session_id |
Reference to a valid session |
|
Repository ref self |
reference to the object |
Minimum role: |
read-only |
Result: |
value of the field |
Published in: |
XAPI 1.301.0 (1.301.0) |
|
Repository ref
introduce
(session ref, string, string, string, string, bool, string)
Add the configuration for a new repository
Parameters: |
session ref session_id |
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 |
Result: |
The ref of the created repository record. |
Published in: |
XAPI 1.301.0 (1.301.0) |
|
Prototype
void
set_gpgkey_path
(session ref, Repository ref, string)
Set the file name of the GPG public key of the repository
Parameters: |
session ref session_id |
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 |
Prototyped in: |
XAPI 22.12.0 (22.12.0) |
|
void
set_name_description
(session ref, Repository ref, string)
Set the name/description field of the given Repository.
Parameters: |
session ref session_id |
Reference to a valid session |
|
Repository ref self |
reference to the object |
|
string value |
New value to set |
Minimum role: |
client-cert |
Published in: |
XenServer 4.0 (rio) |
a notes field containing human-readable description |
void
set_name_label
(session ref, Repository ref, string)
Set the name/label field of the given Repository.
Parameters: |
session ref session_id |
Reference to a valid session |
|
Repository ref self |
reference to the object |
|
string value |
New value to set |
Minimum role: |
client-cert |
Published in: |
XenServer 4.0 (rio) |
a human-readable name |