Class: blob

Last published : Oct 01, 2026
A placeholder for a binary blob
Related information
XenServer 9 Management API

Fields for class: blob

Field Type Qualifier Description
last_updated datetime RO/constructor Time at which the data in the blob was last updated
mime_type string RO/constructor The mime type associated with this object. Defaults to 'application/octet-stream' if the empty string is supplied
name_description string RW a notes field containing human-readable description
name_label string RW a human-readable name
public bool RW True if the blob is publicly accessible
size int RO/runtime Size of the binary data, in bytes
uuid string RO/runtime Unique identifier/object reference

RPCs associated with class: blob

RPC name: create

Overview:
Create a placeholder for a binary blob
Signature:
blob ref create (session ref session_ref, string mime_type, bool public)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
string mime_type The mime-type of the blob. Defaults to 'application/octet-stream' if the empty string is supplied
bool public True if the blob should be publicly available
Minimum Role: pool-operator
Return Type: blob ref
The reference of the created blob

RPC name: destroy

Overview:
Signature:
void destroy (session ref session_ref, blob ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
blob ref self The reference of the blob to destroy
Minimum Role: pool-operator
Return Type: void

RPC name: getall

Overview:
Return a list of all the blobs known to the system.
Signature:
blob 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: blob ref set
references to all objects

RPC name: getallrecords

Overview:
Return a map of blob references to blob records for all blobs known to the system.
Signature:
(blob ref -> blob 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: (blob ref -> blob record) map
records of all objects

RPC name: getbynamelabel

Overview:
Get all the blob instances with the given label.
Signature:
blob 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: blob ref set
references to objects with matching names

RPC name: getbyuuid

Overview:
Get a reference to the blob instance with the specified UUID.
Signature:
blob 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: blob ref
reference to the object

RPC name: getlastupdated

Overview:
Get the lastupdated field of the given blob.
Signature:
datetime get_last_updated (session ref session_ref, blob ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
blob ref self reference to the object
Minimum Role: read-only
Return Type: datetime
value of the field

RPC name: getmimetype

Overview:
Get the mimetype field of the given blob.
Signature:
string get_mime_type (session ref session_ref, blob ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
blob 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 blob.
Signature:
string get_name_description (session ref session_ref, blob ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
blob 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 blob.
Signature:
string get_name_label (session ref session_ref, blob ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
blob ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getpublic

Overview:
Get the public field of the given blob.
Signature:
bool get_public (session ref session_ref, blob ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
blob ref self reference to the object
Minimum Role: read-only
Return Type: bool
value of the field

RPC name: getrecord

Overview:
Get a record containing the current state of the given blob.
Signature:
blob record get_record (session ref session_ref, blob ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
blob ref self reference to the object
Minimum Role: read-only
Return Type: blob record
all fields from the object

RPC name: getsize

Overview:
Get the size field of the given blob.
Signature:
int get_size (session ref session_ref, blob ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
blob ref self reference to the object
Minimum Role: read-only
Return Type: int
value of the field

RPC name: getuuid

Overview:
Get the uuid field of the given blob.
Signature:
string get_uuid (session ref session_ref, blob ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
blob ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: setnamedescription

Overview:
Set the name/description field of the given blob.
Signature:
void set_name_description (session ref session_ref, blob ref self, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
blob ref self reference to the object
string value New value to set
Minimum Role: pool-operator
Return Type: void

RPC name: setnamelabel

Overview:
Set the name/label field of the given blob.
Signature:
void set_name_label (session ref session_ref, blob ref self, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
blob ref self reference to the object
string value New value to set
Minimum Role: pool-operator
Return Type: void

RPC name: setpublic

Overview:
Set the public field of the given blob.
Signature:
void set_public (session ref session_ref, blob ref self, bool value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
blob ref self reference to the object
bool value New value to set
Minimum Role: pool-operator
Return Type: void