View Source XenAPI.Session (XenAPI v0.3.0)
A session
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. Returns XenAPI.Session
struct.
Get a record containing the current state of the given session. Returns XenAPI.Session
struct. (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
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. Returns XenAPI.Session
struct.
Get a record containing the current state of the given session. Returns XenAPI.Session
struct. (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
login_with_password!(xen_session, uname, pwd, version, originator)
View SourceAttempt 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)