user
Deprecated
Class: user
A user of the system
| Published in: | XenServer 4.0 (rio) | A user of the system |
| Deprecated in: | XenServer 5.5 (george) | Deprecated in favor of subject |
Fields
string
fullname
[RW]
full name
| Published in: | XenServer 4.0 (rio) | full name |
(string → string) map
other_config
[RW]
additional configuration
| Default value: | {} |
| Published in: | XenServer 5.0 (orlando) | additional configuration |
string
short_name
[RO/constructor]
short name (e.g. userid)
| Published in: | XenServer 4.0 (rio) | short name (e.g. userid) |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference |
Messages
void
add_to_other_config
(session ref, user ref, string, string)
Add the given key-value pair to the other_config field of the given user.
| Parameters: | session ref session_id | Reference to a valid session |
| user ref self | reference to the object |
| string key | Key to add |
| string value | Value to add |
| Minimum role: | pool-admin |
| Published in: | XenServer 5.0 (orlando) | additional configuration |
Deprecated
user ref
create
(session ref, user record)
Create a new user instance, and return its handle.
The constructor args are: short_name*, fullname*, other_config (* = non-optional).
| Parameters: | session ref session_id | Reference to a valid session |
| user record args | All constructor arguments |
| Minimum role: | pool-admin |
| Result: | reference to the newly created object |
| Published in: | XenServer 4.0 (rio) | A user of the system |
| Deprecated in: | XenServer 5.5 (george) | Deprecated in favor of subject |
Deprecated
void
destroy
(session ref, user ref)
Destroy the specified user instance.
| Parameters: | session ref session_id | Reference to a valid session |
| user ref self | reference to the object |
| Minimum role: | pool-admin |
| Published in: | XenServer 4.0 (rio) | A user of the system |
| Deprecated in: | XenServer 5.5 (george) | Deprecated in favor of subject |
Deprecated
user ref
get_by_uuid
(session ref, string)
Get a reference to the user 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 user of the system |
| Deprecated in: | XenServer 5.5 (george) | Deprecated in favor of subject |
string
get_fullname
(session ref, user ref)
Get the fullname field of the given user.
| Parameters: | session ref session_id | Reference to a valid session |
| user ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | full name |
(string → string) map
get_other_config
(session ref, user ref)
Get the other_config field of the given user.
| Parameters: | session ref session_id | Reference to a valid session |
| user ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 5.0 (orlando) | additional configuration |
Deprecated
user record
get_record
(session ref, user ref)
Get a record containing the current state of the given user.
| Parameters: | session ref session_id | Reference to a valid session |
| user ref self | reference to the object |
| Minimum role: | read-only |
| Result: | all fields from the object |
| Published in: | XenServer 4.0 (rio) | A user of the system |
| Deprecated in: | XenServer 5.5 (george) | Deprecated in favor of subject |
string
get_short_name
(session ref, user ref)
Get the short_name field of the given user.
| Parameters: | session ref session_id | Reference to a valid session |
| user ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | short name (e.g. userid) |
string
get_uuid
(session ref, user ref)
Get the uuid field of the given user.
| Parameters: | session ref session_id | Reference to a valid session |
| user 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 |
void
remove_from_other_config
(session ref, user ref, string)
Remove the given key and its corresponding value from the other_config field of the given user. If the key is not in that Map, then do nothing.
| Parameters: | session ref session_id | Reference to a valid session |
| user ref self | reference to the object |
| string key | Key to remove |
| Minimum role: | pool-admin |
| Published in: | XenServer 5.0 (orlando) | additional configuration |
void
set_fullname
(session ref, user ref, string)
Set the fullname field of the given user.
| Parameters: | session ref session_id | Reference to a valid session |
| user ref self | reference to the object |
| string value | New value to set |
| Minimum role: | pool-admin |
| Published in: | XenServer 4.0 (rio) | full name |
void
set_other_config
(session ref, user ref, (string → string) map)
Set the other_config field of the given user.
| Parameters: | session ref session_id | Reference to a valid session |
| user ref self | reference to the object |
| (string → string) map value | New value to set |
| Minimum role: | pool-admin |
| Published in: | XenServer 5.0 (orlando) | additional configuration |