View Source XenAPI.Role (XenAPI v0.1.1)

Link to this section Summary

Functions

Return a list of all the roles known to the system.

Return a list of all the roles known to the system. (Raise error on XMLRPC failure)

Return a map of role references to role records for all roles known to the system.

Return a map of role references to role records for all roles known to the system. (Raise error on XMLRPC failure)

Get all the role instances with the given label.

Get all the role instances with the given label. (Raise error on XMLRPC failure)

This call returns a list of roles given a permission

This call returns a list of roles given a permission (Raise error on XMLRPC failure)

This call returns a list of roles given a permission name

This call returns a list of roles given a permission name (Raise error on XMLRPC failure)

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

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

Get the name/description field of the given role.

Get the name/description field of the given role. (Raise error on XMLRPC failure)

Get the name/label field of the given role.

Get the name/label field of the given role. (Raise error on XMLRPC failure)

This call returns a list of permissions given a role

This call returns a list of permissions given a role (Raise error on XMLRPC failure)

This call returns a list of permission names given a role

This call returns a list of permission names given a role (Raise error on XMLRPC failure)

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

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

Get the subroles field of the given role.

Get the subroles field of the given role. (Raise error on XMLRPC failure)

Get the uuid field of the given role.

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

Link to this section Functions

Return a list of all the roles known to the system.

Return a list of all the roles known to the system. (Raise error on XMLRPC failure)

Link to this function

get_all_records(xen_session)

View Source

Return a map of role references to role records for all roles known to the system.

Link to this function

get_all_records!(xen_session)

View Source

Return a map of role references to role records for all roles known to the system. (Raise error on XMLRPC failure)

Link to this function

get_by_name_label(xen_session, label)

View Source

Get all the role instances with the given label.

Link to this function

get_by_name_label!(xen_session, label)

View Source

Get all the role instances with the given label. (Raise error on XMLRPC failure)

Link to this function

get_by_permission(xen_session, permission)

View Source

This call returns a list of roles given a permission

Link to this function

get_by_permission!(xen_session, permission)

View Source

This call returns a list of roles given a permission (Raise error on XMLRPC failure)

Link to this function

get_by_permission_name_label(xen_session, label)

View Source

This call returns a list of roles given a permission name

Link to this function

get_by_permission_name_label!(xen_session, label)

View Source

This call returns a list of roles given a permission name (Raise error on XMLRPC failure)

Link to this function

get_by_uuid(xen_session, uuid)

View Source

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

Link to this function

get_by_uuid!(xen_session, uuid)

View Source

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

Link to this function

get_name_description(xen_session, role_ref)

View Source

Get the name/description field of the given role.

Link to this function

get_name_description!(xen_session, role_ref)

View Source

Get the name/description field of the given role. (Raise error on XMLRPC failure)

Link to this function

get_name_label(xen_session, role_ref)

View Source

Get the name/label field of the given role.

Link to this function

get_name_label!(xen_session, role_ref)

View Source

Get the name/label field of the given role. (Raise error on XMLRPC failure)

Link to this function

get_permissions(xen_session, role_ref)

View Source

This call returns a list of permissions given a role

Link to this function

get_permissions!(xen_session, role_ref)

View Source

This call returns a list of permissions given a role (Raise error on XMLRPC failure)

Link to this function

get_permissions_name_label(xen_session, role_ref)

View Source

This call returns a list of permission names given a role

Link to this function

get_permissions_name_label!(xen_session, role_ref)

View Source

This call returns a list of permission names given a role (Raise error on XMLRPC failure)

Link to this function

get_record(xen_session, role_ref)

View Source

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

Link to this function

get_record!(xen_session, role_ref)

View Source

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

Link to this function

get_subroles(xen_session, role_ref)

View Source

Get the subroles field of the given role.

Link to this function

get_subroles!(xen_session, role_ref)

View Source

Get the subroles field of the given role. (Raise error on XMLRPC failure)

Link to this function

get_uuid(xen_session, role_ref)

View Source

Get the uuid field of the given role.

Link to this function

get_uuid!(xen_session, role_ref)

View Source

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