View Source XenAPI.User (XenAPI v0.3.0)

A user of the system

Link to this section Summary

Functions

Add the given key-value pair to the other_config field of the given user.

Add the given key-value pair to the other_config field of the given user. (Raise error on XMLRPC failure)

Create a new user instance, and return its handle. The constructor args are: short_name, fullname, other_config (* = non-optional).

Create a new user instance, and return its handle. The constructor args are: short_name, fullname, other_config (* = non-optional). (Raise error on XMLRPC failure)

Destroy the specified user instance.

Destroy the specified user instance. (Raise error on XMLRPC failure)

Get a reference to the user instance with the specified UUID.

Get a reference to the user instance with the specified UUID. (Raise error on XMLRPC failure)

Get the fullname field of the given user.

Get the fullname field of the given user. (Raise error on XMLRPC failure)

Get the other_config field of the given user.

Get the other_config field of the given user. (Raise error on XMLRPC failure)

Get a record containing the current state of the given user. Returns XenAPI.User struct.

Get a record containing the current state of the given user. Returns XenAPI.User struct. (Raise error on XMLRPC failure)

Get the short_name field of the given user.

Get the short_name field of the given user. (Raise error on XMLRPC failure)

Get the uuid field of the given user.

Get the uuid field of the given user. (Raise error on XMLRPC failure)

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.

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. (Raise error on XMLRPC failure)

Set the fullname field of the given user.

Set the fullname field of the given user. (Raise error on XMLRPC failure)

Set the other_config field of the given user.

Set the other_config field of the given user. (Raise error on XMLRPC failure)

Link to this section Functions

Link to this function

add_to_other_config(xen_session, user_ref, key, value)

View Source

Add the given key-value pair to the other_config field of the given user.

Link to this function

add_to_other_config!(xen_session, user_ref, key, value)

View Source

Add the given key-value pair to the other_config field of the given user. (Raise error on XMLRPC failure)

Link to this function

create(xen_session, args)

View Source

Create a new user instance, and return its handle. The constructor args are: short_name, fullname, other_config (* = non-optional).

Link to this function

create!(xen_session, args)

View Source

Create a new user instance, and return its handle. The constructor args are: short_name, fullname, other_config (* = non-optional). (Raise error on XMLRPC failure)

Link to this function

destroy(xen_session, user_ref)

View Source

Destroy the specified user instance.

Link to this function

destroy!(xen_session, user_ref)

View Source

Destroy the specified user instance. (Raise error on XMLRPC failure)

Link to this function

get_by_uuid(xen_session, uuid)

View Source

Get a reference to the user instance with the specified UUID.

Link to this function

get_by_uuid!(xen_session, uuid)

View Source

Get a reference to the user instance with the specified UUID. (Raise error on XMLRPC failure)

Link to this function

get_fullname(xen_session, user_ref)

View Source

Get the fullname field of the given user.

Link to this function

get_fullname!(xen_session, user_ref)

View Source

Get the fullname field of the given user. (Raise error on XMLRPC failure)

Link to this function

get_other_config(xen_session, user_ref)

View Source

Get the other_config field of the given user.

Link to this function

get_other_config!(xen_session, user_ref)

View Source

Get the other_config field of the given user. (Raise error on XMLRPC failure)

Link to this function

get_record(xen_session, user_ref)

View Source

Get a record containing the current state of the given user. Returns XenAPI.User struct.

Link to this function

get_record!(xen_session, user_ref)

View Source

Get a record containing the current state of the given user. Returns XenAPI.User struct. (Raise error on XMLRPC failure)

Link to this function

get_short_name(xen_session, user_ref)

View Source

Get the short_name field of the given user.

Link to this function

get_short_name!(xen_session, user_ref)

View Source

Get the short_name field of the given user. (Raise error on XMLRPC failure)

Link to this function

get_uuid(xen_session, user_ref)

View Source

Get the uuid field of the given user.

Link to this function

get_uuid!(xen_session, user_ref)

View Source

Get the uuid field of the given user. (Raise error on XMLRPC failure)

Link to this function

remove_from_other_config(xen_session, user_ref, key)

View Source

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.

Link to this function

remove_from_other_config!(xen_session, user_ref, key)

View Source

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. (Raise error on XMLRPC failure)

Link to this function

set_fullname(xen_session, user_ref, value)

View Source

Set the fullname field of the given user.

Link to this function

set_fullname!(xen_session, user_ref, value)

View Source

Set the fullname field of the given user. (Raise error on XMLRPC failure)

Link to this function

set_other_config(xen_session, user_ref, value)

View Source

Set the other_config field of the given user.

Link to this function

set_other_config!(xen_session, user_ref, value)

View Source

Set the other_config field of the given user. (Raise error on XMLRPC failure)