Class: Feature

Last published : Oct 01, 2026
A new piece of functionality
Related information
XenServer 8.4 Management API

Fields for class: Feature

Field Type Qualifier Description
enabled bool RO/runtime Indicates whether the feature is enabled
experimental bool RO/constructor Indicates whether the feature is experimental (as opposed to stable and fully supported)
host host ref RO/runtime The host where this feature is available
name_description string RO/constructor a notes field containing human-readable description
name_label string RO/constructor a human-readable name
uuid string RO/runtime Unique identifier/object reference
version string RO/constructor The version of this feature

RPCs associated with class: Feature

RPC name: getall

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

RPC name: getallrecords

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

RPC name: getbynamelabel

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

RPC name: getbyuuid

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

RPC name: getenabled

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

RPC name: getexperimental

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

RPC name: gethost

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

RPC name: getnamedescription

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

RPC name: getrecord

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

RPC name: getuuid

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

RPC name: getversion

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