Class: subject
A user or group that can log in xapi
| Published in: |
XenServer 5.5 (george) |
A user or group that can log in xapi |
Fields
(string → string) map
other_config
[RO/constructor]
additional configuration
| Default value: |
{} |
| Published in: |
XenServer 5.5 (george) |
additional configuration |
role ref set
roles
[RO/runtime]
the roles associated with this subject
| Default value: |
{OpaqueRef:0165f154-ba3e-034e-6b27-5d271af109ba} |
| Published in: |
XenServer 5.6 (midnight-ride) |
the roles associated with this subject |
string
subject_identifier
[RO/constructor]
the subject identifier, unique in the external directory service
| Default value: |
"" |
| Published in: |
XenServer 5.5 (george) |
the subject identifier, unique in the external directory service |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: |
XenServer 4.0 (rio) |
Unique identifier/object reference |
Messages
void
add_to_roles
(session ref, subject ref, role ref)
This call adds a new role to a subject
| Parameters: |
session ref session_id |
Reference to a valid session |
|
subject ref self |
The subject who we want to add the role to |
|
role ref role |
The unique role reference |
| Minimum role: |
pool-admin |
| Published in: |
XenServer 5.6 (midnight-ride) |
This call adds a new role to a subject |
subject ref
create
(session ref, subject record)
Create a new subject instance, and return its handle.
The constructor args are: subject_identifier, other_config (* = non-optional).
| Parameters: |
session ref session_id |
Reference to a valid session |
|
subject record args |
All constructor arguments |
| Minimum role: |
pool-admin |
| Result: |
reference to the newly created object |
| Published in: |
XenServer 5.5 (george) |
A user or group that can log in xapi |
void
destroy
(session ref, subject ref)
Destroy the specified subject instance.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
subject ref self |
reference to the object |
| Minimum role: |
pool-admin |
| Published in: |
XenServer 5.5 (george) |
A user or group that can log in xapi |
subject ref set
get_all
(session ref)
Return a list of all the subjects known to the system.
| Parameters: |
session ref session_id |
Reference to a valid session |
| Minimum role: |
read-only |
| Result: |
references to all objects |
| Published in: |
XenServer 5.5 (george) |
A user or group that can log in xapi |
(subject ref → subject record) map
get_all_records
(session ref)
Return a map of subject references to subject records for all subjects known to the system.
| Parameters: |
session ref session_id |
Reference to a valid session |
| Minimum role: |
read-only |
| Result: |
records of all objects |
| Published in: |
XenServer 5.5 (george) |
A user or group that can log in xapi |
subject ref
get_by_uuid
(session ref, string)
Get a reference to the subject instance with the specified UUID.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
string uuid |
UUID of object to return |
| Minimum role: |
read-only |
| Result: |
reference to the object |
| Published in: |
XenServer 5.5 (george) |
A user or group that can log in xapi |
(string → string) map
get_other_config
(session ref, subject ref)
Get the other_config field of the given subject.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
subject ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Published in: |
XenServer 5.5 (george) |
additional configuration |
string set
get_permissions_name_label
(session ref, subject ref)
This call returns a list of permission names given a subject
| Parameters: |
session ref session_id |
Reference to a valid session |
|
subject ref self |
The subject whose permissions will be retrieved |
| Minimum role: |
read-only |
| Result: |
a list of permission names |
| Published in: |
XenServer 5.6 (midnight-ride) |
This call returns a list of permission names given a subject |
subject record
get_record
(session ref, subject ref)
Get a record containing the current state of the given subject.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
subject ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
all fields from the object |
| Published in: |
XenServer 5.5 (george) |
A user or group that can log in xapi |
role ref set
get_roles
(session ref, subject ref)
Get the roles field of the given subject.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
subject ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Published in: |
XenServer 5.6 (midnight-ride) |
the roles associated with this subject |
string
get_subject_identifier
(session ref, subject ref)
Get the subject_identifier field of the given subject.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
subject ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Published in: |
XenServer 5.5 (george) |
the subject identifier, unique in the external directory service |
string
get_uuid
(session ref, subject ref)
Get the uuid field of the given subject.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
subject ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Published in: |
XenServer 4.0 (rio) |
Unique identifier/object reference |
void
remove_from_roles
(session ref, subject ref, role ref)
This call removes a role from a subject
| Parameters: |
session ref session_id |
Reference to a valid session |
|
subject ref self |
The subject from whom we want to remove the role |
|
role ref role |
The unique role reference in the subject's roles field |
| Minimum role: |
pool-admin |
| Published in: |
XenServer 5.6 (midnight-ride) |
This call removes a role from a subject |
