Class: Feature
A new piece of functionality
| Published in: | XenServer 7.2 (falcon) | |
Fields
bool
enabled
[RO/runtime]
Indicates whether the feature is enabled
| Default value: | false |
| Published in: | XenServer 7.2 (falcon) | |
bool
experimental
[RO/constructor]
Indicates whether the feature is experimental (as opposed to stable and fully supported)
| Default value: | false |
| Published in: | XenServer 7.2 (falcon) | |
host ref
host
[RO/runtime]
The host where this feature is available
| Published in: | XenServer 7.2 (falcon) | |
string
name_description
[RO/constructor]
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
[RO/constructor]
a human-readable name
| Default value: | "" |
| Published in: | XenServer 4.0 (rio) | a human-readable name |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 7.2 (falcon) | |
string
version
[RO/constructor]
The version of this feature
| Default value: | "1.0" |
| Published in: | XenServer 7.2 (falcon) | |
Messages
Feature ref set
get_all
(session ref)
Return a list of all the Features 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: | XenServer 7.2 (falcon) | |
(Feature ref → Feature record) map
get_all_records
(session ref)
Return a map of Feature references to Feature records for all Features 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: | XenServer 7.2 (falcon) | |
Feature ref set
get_by_name_label
(session ref, string)
Get all the Feature 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: | XenServer 7.2 (falcon) | |
Feature ref
get_by_uuid
(session ref, string)
Get a reference to the Feature 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: | XenServer 7.2 (falcon) | |
bool
get_enabled
(session ref, Feature ref)
Get the enabled field of the given Feature.
| Parameters: | session ref session_id | Reference to a valid session |
| Feature ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.2 (falcon) | |
bool
get_experimental
(session ref, Feature ref)
Get the experimental field of the given Feature.
| Parameters: | session ref session_id | Reference to a valid session |
| Feature ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.2 (falcon) | |
host ref
get_host
(session ref, Feature ref)
Get the host field of the given Feature.
| Parameters: | session ref session_id | Reference to a valid session |
| Feature ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.2 (falcon) | |
string
get_name_description
(session ref, Feature ref)
Get the name/description field of the given Feature.
| Parameters: | session ref session_id | Reference to a valid session |
| Feature 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, Feature ref)
Get the name/label field of the given Feature.
| Parameters: | session ref session_id | Reference to a valid session |
| Feature 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 |
Feature record
get_record
(session ref, Feature ref)
Get a record containing the current state of the given Feature.
| Parameters: | session ref session_id | Reference to a valid session |
| Feature ref self | reference to the object |
| Minimum role: | read-only |
| Result: | all fields from the object |
| Published in: | XenServer 7.2 (falcon) | |
string
get_uuid
(session ref, Feature ref)
Get the uuid field of the given Feature.
| Parameters: | session ref session_id | Reference to a valid session |
| Feature ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.2 (falcon) | |
string
get_version
(session ref, Feature ref)
Get the version field of the given Feature.
| Parameters: | session ref session_id | Reference to a valid session |
| Feature ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.2 (falcon) | |