View Source XenAPI.Subject (XenAPI v0.2.0)

Link to this section Summary

Functions

This call adds a new role to a subject

This call adds a new role to a subject (Raise error on XMLRPC failure)

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

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

Destroy the specified subject instance.

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

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

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

Return a map of subject references to subject records for all subjects known to the system.

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

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

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

Get the other_config field of the given subject.

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

This call returns a list of permission names given a subject

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

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

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

Get the roles field of the given subject.

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

Get the subject_identifier field of the given subject.

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

Get the uuid field of the given subject.

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

This call removes a role from a subject

This call removes a role from a subject (Raise error on XMLRPC failure)

Link to this section Functions

Link to this function

add_to_roles(xen_session, subject_ref, role)

View Source

This call adds a new role to a subject

Link to this function

add_to_roles!(xen_session, subject_ref, role)

View Source

This call adds a new role to a subject (Raise error on XMLRPC failure)

Link to this function

create(xen_session, args)

View Source

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

Link to this function

create!(xen_session, args)

View Source

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

Link to this function

destroy(xen_session, subject_ref)

View Source

Destroy the specified subject instance.

Link to this function

destroy!(xen_session, subject_ref)

View Source

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

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

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

Link to this function

get_all_records(xen_session)

View Source

Return a map of subject references to subject records for all subjects known to the system.

Link to this function

get_all_records!(xen_session)

View Source

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

Link to this function

get_by_uuid(xen_session, uuid)

View Source

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

Link to this function

get_by_uuid!(xen_session, uuid)

View Source

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

Link to this function

get_other_config(xen_session, subject_ref)

View Source

Get the other_config field of the given subject.

Link to this function

get_other_config!(xen_session, subject_ref)

View Source

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

Link to this function

get_permissions_name_label(xen_session, subject_ref)

View Source

This call returns a list of permission names given a subject

Link to this function

get_permissions_name_label!(xen_session, subject_ref)

View Source

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

Link to this function

get_record(xen_session, subject_ref)

View Source

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

Link to this function

get_record!(xen_session, subject_ref)

View Source

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

Link to this function

get_roles(xen_session, subject_ref)

View Source

Get the roles field of the given subject.

Link to this function

get_roles!(xen_session, subject_ref)

View Source

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

Link to this function

get_subject_identifier(xen_session, subject_ref)

View Source

Get the subject_identifier field of the given subject.

Link to this function

get_subject_identifier!(xen_session, subject_ref)

View Source

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

Link to this function

get_uuid(xen_session, subject_ref)

View Source

Get the uuid field of the given subject.

Link to this function

get_uuid!(xen_session, subject_ref)

View Source

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

Link to this function

remove_from_roles(xen_session, subject_ref, role)

View Source

This call removes a role from a subject

Link to this function

remove_from_roles!(xen_session, subject_ref, role)

View Source

This call removes a role from a subject (Raise error on XMLRPC failure)