View Source XenAPI.Session (XenAPI v0.1.2)

Link to this section Summary

Functions

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

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

Change the account password; if your session is authenticated with root priviledges then the old_pwd is validated and the new_pwd is set regardless

Change the account password; if your session is authenticated with root priviledges then the old_pwd is validated and the new_pwd is set regardless (Raise error on XMLRPC failure)

(Raise error on XMLRPC failure)

Return a list of all the user subject-identifiers of all existing sessions

Return a list of all the user subject-identifiers of all existing sessions (Raise error on XMLRPC failure)

Get the auth_user_name field of the given session.

Get the auth_user_name field of the given session. (Raise error on XMLRPC failure)

Get the auth_user_sid field of the given session.

Get the auth_user_sid field of the given session. (Raise error on XMLRPC failure)

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

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

Get the is_local_superuser field of the given session.

Get the is_local_superuser field of the given session. (Raise error on XMLRPC failure)

Get the last_active field of the given session.

Get the last_active field of the given session. (Raise error on XMLRPC failure)

Get the originator field of the given session.

Get the originator field of the given session. (Raise error on XMLRPC failure)

Get the other_config field of the given session.

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

Get the parent field of the given session.

Get the parent field of the given session. (Raise error on XMLRPC failure)

Get the pool field of the given session.

Get the pool field of the given session. (Raise error on XMLRPC failure)

Get the rbac_permissions field of the given session.

Get the rbac_permissions field of the given session. (Raise error on XMLRPC failure)

Get a record containing the current state of the given session.

Get a record containing the current state of the given session. (Raise error on XMLRPC failure)

Get the subject field of the given session.

Get the subject field of the given session. (Raise error on XMLRPC failure)

Get the tasks field of the given session.

Get the tasks field of the given session. (Raise error on XMLRPC failure)

Get the this_host field of the given session.

Get the this_host field of the given session. (Raise error on XMLRPC failure)

Get the this_user field of the given session.

Get the this_user field of the given session. (Raise error on XMLRPC failure)

Get the uuid field of the given session.

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

Get the validation_time field of the given session.

Get the validation_time field of the given session. (Raise error on XMLRPC failure)

Log out of local session.

Log out of local session. (Raise error on XMLRPC failure)

Attempt to authenticate the user, returning a session reference if successful

Attempt to authenticate the user, returning a session reference if successful (Raise error on XMLRPC failure)

Log out of a session

Log out of a session (Raise error on XMLRPC failure)

Log out all sessions associated to a user subject-identifier, except the session associated with the context calling this function

Log out all sessions associated to a user subject-identifier, except the session associated with the context calling this function (Raise error on XMLRPC failure)

Remove the given key and its corresponding value from the other_config field of the given session. 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 session. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)

Set the other_config field of the given session.

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

Authenticate locally against a slave in emergency mode. Note the resulting sessions are only good for use on this host.

Authenticate locally against a slave in emergency mode. Note the resulting sessions are only good for use on this host. (Raise error on XMLRPC failure)

Link to this section Functions

Link to this function

add_to_other_config(xen_session, session_ref, key, value)

View Source

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

Link to this function

add_to_other_config!(xen_session, session_ref, key, value)

View Source

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

Link to this function

change_password(xen_session, old_pwd, new_pwd)

View Source

Change the account password; if your session is authenticated with root priviledges then the old_pwd is validated and the new_pwd is set regardless

Link to this function

change_password!(xen_session, old_pwd, new_pwd)

View Source

Change the account password; if your session is authenticated with root priviledges then the old_pwd is validated and the new_pwd is set regardless (Raise error on XMLRPC failure)

Link to this function

create_from_db_file(xen_session, filename)

View Source
Link to this function

create_from_db_file!(xen_session, filename)

View Source

(Raise error on XMLRPC failure)

Link to this function

get_all_subject_identifiers(xen_session)

View Source

Return a list of all the user subject-identifiers of all existing sessions

Link to this function

get_all_subject_identifiers!(xen_session)

View Source

Return a list of all the user subject-identifiers of all existing sessions (Raise error on XMLRPC failure)

Link to this function

get_auth_user_name(xen_session, session_ref)

View Source

Get the auth_user_name field of the given session.

Link to this function

get_auth_user_name!(xen_session, session_ref)

View Source

Get the auth_user_name field of the given session. (Raise error on XMLRPC failure)

Link to this function

get_auth_user_sid(xen_session, session_ref)

View Source

Get the auth_user_sid field of the given session.

Link to this function

get_auth_user_sid!(xen_session, session_ref)

View Source

Get the auth_user_sid field of the given session. (Raise error on XMLRPC failure)

Link to this function

get_by_uuid(xen_session, uuid)

View Source

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

Link to this function

get_by_uuid!(xen_session, uuid)

View Source

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

Link to this function

get_is_local_superuser(xen_session, session_ref)

View Source

Get the is_local_superuser field of the given session.

Link to this function

get_is_local_superuser!(xen_session, session_ref)

View Source

Get the is_local_superuser field of the given session. (Raise error on XMLRPC failure)

Link to this function

get_last_active(xen_session, session_ref)

View Source

Get the last_active field of the given session.

Link to this function

get_last_active!(xen_session, session_ref)

View Source

Get the last_active field of the given session. (Raise error on XMLRPC failure)

Link to this function

get_originator(xen_session, session_ref)

View Source

Get the originator field of the given session.

Link to this function

get_originator!(xen_session, session_ref)

View Source

Get the originator field of the given session. (Raise error on XMLRPC failure)

Link to this function

get_other_config(xen_session, session_ref)

View Source

Get the other_config field of the given session.

Link to this function

get_other_config!(xen_session, session_ref)

View Source

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

Link to this function

get_parent(xen_session, session_ref)

View Source

Get the parent field of the given session.

Link to this function

get_parent!(xen_session, session_ref)

View Source

Get the parent field of the given session. (Raise error on XMLRPC failure)

Link to this function

get_pool(xen_session, session_ref)

View Source

Get the pool field of the given session.

Link to this function

get_pool!(xen_session, session_ref)

View Source

Get the pool field of the given session. (Raise error on XMLRPC failure)

Link to this function

get_rbac_permissions(xen_session, session_ref)

View Source

Get the rbac_permissions field of the given session.

Link to this function

get_rbac_permissions!(xen_session, session_ref)

View Source

Get the rbac_permissions field of the given session. (Raise error on XMLRPC failure)

Link to this function

get_record(xen_session, session_ref)

View Source

Get a record containing the current state of the given session.

Link to this function

get_record!(xen_session, session_ref)

View Source

Get a record containing the current state of the given session. (Raise error on XMLRPC failure)

Link to this function

get_subject(xen_session, session_ref)

View Source

Get the subject field of the given session.

Link to this function

get_subject!(xen_session, session_ref)

View Source

Get the subject field of the given session. (Raise error on XMLRPC failure)

Link to this function

get_tasks(xen_session, session_ref)

View Source

Get the tasks field of the given session.

Link to this function

get_tasks!(xen_session, session_ref)

View Source

Get the tasks field of the given session. (Raise error on XMLRPC failure)

Link to this function

get_this_host(xen_session, session_ref)

View Source

Get the this_host field of the given session.

Link to this function

get_this_host!(xen_session, session_ref)

View Source

Get the this_host field of the given session. (Raise error on XMLRPC failure)

Link to this function

get_this_user(xen_session, session_ref)

View Source

Get the this_user field of the given session.

Link to this function

get_this_user!(xen_session, session_ref)

View Source

Get the this_user field of the given session. (Raise error on XMLRPC failure)

Link to this function

get_uuid(xen_session, session_ref)

View Source

Get the uuid field of the given session.

Link to this function

get_uuid!(xen_session, session_ref)

View Source

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

Link to this function

get_validation_time(xen_session, session_ref)

View Source

Get the validation_time field of the given session.

Link to this function

get_validation_time!(xen_session, session_ref)

View Source

Get the validation_time field of the given session. (Raise error on XMLRPC failure)

Link to this function

local_logout(xen_session)

View Source

Log out of local session.

Link to this function

local_logout!(xen_session)

View Source

Log out of local session. (Raise error on XMLRPC failure)

Link to this function

login_with_password(xen_session, uname, pwd, version, originator)

View Source

Attempt to authenticate the user, returning a session reference if successful

Link to this function

login_with_password!(xen_session, uname, pwd, version, originator)

View Source

Attempt to authenticate the user, returning a session reference if successful (Raise error on XMLRPC failure)

Log out of a session

Log out of a session (Raise error on XMLRPC failure)

Link to this function

logout_subject_identifier(xen_session, subject_identifier)

View Source

Log out all sessions associated to a user subject-identifier, except the session associated with the context calling this function

Link to this function

logout_subject_identifier!(xen_session, subject_identifier)

View Source

Log out all sessions associated to a user subject-identifier, except the session associated with the context calling this function (Raise error on XMLRPC failure)

Link to this function

remove_from_other_config(xen_session, session_ref, key)

View Source

Remove the given key and its corresponding value from the other_config field of the given session. If the key is not in that Map, then do nothing.

Link to this function

remove_from_other_config!(xen_session, session_ref, key)

View Source

Remove the given key and its corresponding value from the other_config field of the given session. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)

Link to this function

set_other_config(xen_session, session_ref, value)

View Source

Set the other_config field of the given session.

Link to this function

set_other_config!(xen_session, session_ref, value)

View Source

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

Link to this function

slave_local_login_with_password(xen_session, uname, pwd)

View Source

Authenticate locally against a slave in emergency mode. Note the resulting sessions are only good for use on this host.

Link to this function

slave_local_login_with_password!(xen_session, uname, pwd)

View Source

Authenticate locally against a slave in emergency mode. Note the resulting sessions are only good for use on this host. (Raise error on XMLRPC failure)