Class: user

Last published : Oct 01, 2026
This class is deprecated.
A user of the system
Related information
XenServer 8.4 Management API

Fields for class: user

Field Type Qualifier Description
fullname string RW Deprecated. full name
other_config (string -> string) map RW Deprecated. additional configuration
short_name string RO/constructor Deprecated. short name (for example, userid)
uuid string RO/runtime Deprecated. Unique identifier/object reference

RPCs associated with class: user

RPC name: addtootherconfig

This message is deprecated.
Overview:
Add the given keyvalue pair to the otherconfig field of the given user.
Signature:
void add_to_other_config (session ref session_ref, user ref self, string key, string value)
Arguments:
Type Name Description
session ref session_ref 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
Return Type: void

RPC name: create

This message is deprecated.
Overview:
Create a new user instance, and return its handle.
Signature:
user ref create (session ref session_ref, user record args)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
user record args All constructor arguments
Minimum Role: pool-admin
Return Type: user ref
reference to the newly created object

RPC name: destroy

This message is deprecated.
Overview:
Destroy the specified user instance.
Signature:
void destroy (session ref session_ref, user ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
user ref self reference to the object
Minimum Role: pool-admin
Return Type: void

RPC name: getbyuuid

This message is deprecated.
Overview:
Get a reference to the user instance with the specified UUID.
Signature:
user 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: user ref
reference to the object

RPC name: getfullname

This message is deprecated.
Overview:
Get the fullname field of the given user.
Signature:
string get_fullname (session ref session_ref, user ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
user ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getotherconfig

This message is deprecated.
Overview:
Get the otherconfig field of the given user.
Signature:
(string -> string) map get_other_config (session ref session_ref, user ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
user ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: getrecord

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

RPC name: getshortname

This message is deprecated.
Overview:
Get the shortname field of the given user.
Signature:
string get_short_name (session ref session_ref, user ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
user ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getuuid

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

RPC name: removefromotherconfig

This message is deprecated.
Overview:
Remove the given key and its corresponding value from the otherconfig field of the given user. If the key is not in that Map, then do nothing.
Signature:
void remove_from_other_config (session ref session_ref, user ref self, string key)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
user ref self reference to the object
string key Key to remove
Minimum Role: pool-admin
Return Type: void

RPC name: setfullname

This message is deprecated.
Overview:
Set the fullname field of the given user.
Signature:
void set_fullname (session ref session_ref, user ref self, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
user ref self reference to the object
string value New value to set
Minimum Role: pool-admin
Return Type: void

RPC name: setotherconfig

This message is deprecated.
Overview:
Set the otherconfig field of the given user.
Signature:
void set_other_config (session ref session_ref, user ref self, (string -> string) map value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
user ref self reference to the object
(string -> string) map value New value to set
Minimum Role: pool-admin
Return Type: void