Class: SM
A storage manager plugin
| Published in: | XenServer 4.0 (rio) | A storage manager plugin |
Fields
Deprecated
string set
capabilities
[RO/runtime]
capabilities of the SM plugin
| Default value: | {} |
| Published in: | XenServer 4.1 (miami) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Use SM.features instead |
(string → string) map
configuration
[RO/runtime]
names and descriptions of device config keys
| Published in: | XenServer 4.0 (rio) | names and descriptions of device config keys |
string
copyright
[RO/runtime]
Entity which owns the copyright of this plugin
| Published in: | XenServer 4.0 (rio) | Entity which owns the copyright of this plugin |
string
driver_filename
[RO/runtime]
filename of the storage driver
| Default value: | "" |
| Published in: | XenServer 5.0 (orlando) | filename of the storage driver |
(string → int) map
features
[RO/runtime]
capabilities of the SM plugin, with capability version numbers
| Default value: | {} |
| Published in: | XenServer 6.2 (clearwater) | capabilities of the SM plugin, with capability version numbers |
string
name_description
[RO/runtime]
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/runtime]
a human-readable name
| Default value: | "" |
| Published in: | XenServer 4.0 (rio) | a human-readable name |
(string → string) map
other_config
[RW]
additional configuration
| Default value: | {} |
| Published in: | XenServer 4.1 (miami) | additional configuration |
string
required_api_version
[RO/runtime]
Minimum SM API version required on the server
| Published in: | XenServer 4.0 (rio) | Minimum SM API version required on the server |
string set
required_cluster_stack
[RO/runtime]
The storage plugin requires that one of these cluster stacks is configured and running.
| Default value: | {} |
| Published in: | XenServer 7.0 (dundee) | The storage plugin requires that one of these cluster stacks is configured and running. |
string
type
[RO/runtime]
SR.type
| Published in: | XenServer 4.0 (rio) | SR.type |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference |
string
vendor
[RO/runtime]
Vendor who created this plugin
| Published in: | XenServer 4.0 (rio) | Vendor who created this plugin |
string
version
[RO/runtime]
Version of the plugin
| Published in: | XenServer 4.0 (rio) | Version of the plugin |
Messages
void
add_to_other_config
(session ref, SM ref, string, string)
Add the given key-value pair to the other_config field of the given SM.
| Parameters: | session ref session_id | Reference to a valid session |
| SM ref self | reference to the object |
| string key | Key to add |
| string value | Value to add |
| Minimum role: | pool-operator |
| Published in: | XenServer 4.1 (miami) | additional configuration |
SM ref set
get_all
(session ref)
Return a list of all the SMs 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 4.0 (rio) | A storage manager plugin |
(SM ref → SM record) map
get_all_records
(session ref)
Return a map of SM references to SM records for all SMs 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 4.0 (rio) | A storage manager plugin |
SM ref set
get_by_name_label
(session ref, string)
Get all the SM 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 4.0 (rio) | A storage manager plugin |
SM ref
get_by_uuid
(session ref, string)
Get a reference to the SM 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 4.0 (rio) | A storage manager plugin |
Deprecated
string set
get_capabilities
(session ref, SM ref)
Get the capabilities field of the given SM.
| Parameters: | session ref session_id | Reference to a valid session |
| SM ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.1 (miami) | |
| Deprecated in: | XenServer 6.2 (clearwater) | Use SM.features instead |
(string → string) map
get_configuration
(session ref, SM ref)
Get the configuration field of the given SM.
| Parameters: | session ref session_id | Reference to a valid session |
| SM ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | names and descriptions of device config keys |
string
get_copyright
(session ref, SM ref)
Get the copyright field of the given SM.
| Parameters: | session ref session_id | Reference to a valid session |
| SM ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Entity which owns the copyright of this plugin |
string
get_driver_filename
(session ref, SM ref)
Get the driver_filename field of the given SM.
| Parameters: | session ref session_id | Reference to a valid session |
| SM ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 5.0 (orlando) | filename of the storage driver |
(string → int) map
get_features
(session ref, SM ref)
Get the features field of the given SM.
| Parameters: | session ref session_id | Reference to a valid session |
| SM ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.2 (clearwater) | capabilities of the SM plugin, with capability version numbers |
string
get_name_description
(session ref, SM ref)
Get the name/description field of the given SM.
| Parameters: | session ref session_id | Reference to a valid session |
| SM 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, SM ref)
Get the name/label field of the given SM.
| Parameters: | session ref session_id | Reference to a valid session |
| SM 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 |
(string → string) map
get_other_config
(session ref, SM ref)
Get the other_config field of the given SM.
| Parameters: | session ref session_id | Reference to a valid session |
| SM ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.1 (miami) | additional configuration |
SM record
get_record
(session ref, SM ref)
Get a record containing the current state of the given SM.
| Parameters: | session ref session_id | Reference to a valid session |
| SM ref self | reference to the object |
| Minimum role: | read-only |
| Result: | all fields from the object |
| Published in: | XenServer 4.0 (rio) | A storage manager plugin |
string
get_required_api_version
(session ref, SM ref)
Get the required_api_version field of the given SM.
| Parameters: | session ref session_id | Reference to a valid session |
| SM ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Minimum SM API version required on the server |
string set
get_required_cluster_stack
(session ref, SM ref)
Get the required_cluster_stack field of the given SM.
| Parameters: | session ref session_id | Reference to a valid session |
| SM ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.0 (dundee) | The storage plugin requires that one of these cluster stacks is configured and running. |
string
get_type
(session ref, SM ref)
Get the type field of the given SM.
| Parameters: | session ref session_id | Reference to a valid session |
| SM ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | SR.type |
string
get_uuid
(session ref, SM ref)
Get the uuid field of the given SM.
| Parameters: | session ref session_id | Reference to a valid session |
| SM ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference |
string
get_vendor
(session ref, SM ref)
Get the vendor field of the given SM.
| Parameters: | session ref session_id | Reference to a valid session |
| SM ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Vendor who created this plugin |
string
get_version
(session ref, SM ref)
Get the version field of the given SM.
| Parameters: | session ref session_id | Reference to a valid session |
| SM ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Version of the plugin |
void
remove_from_other_config
(session ref, SM ref, string)
Remove the given key and its corresponding value from the other_config field of the given SM. If the key is not in that Map, then do nothing.
| Parameters: | session ref session_id | Reference to a valid session |
| SM ref self | reference to the object |
| string key | Key to remove |
| Minimum role: | pool-operator |
| Published in: | XenServer 4.1 (miami) | additional configuration |
void
set_other_config
(session ref, SM ref, (string → string) map)
Set the other_config field of the given SM.
| Parameters: | session ref session_id | Reference to a valid session |
| SM ref self | reference to the object |
| (string → string) map value | New value to set |
| Minimum role: | pool-operator |
| Published in: | XenServer 4.1 (miami) | additional configuration |