Package org.opennebula.client.vmgroup
Class VMGroup
java.lang.Object
org.opennebula.client.PoolElement
org.opennebula.client.vmgroup.VMGroup
This class represents an OpenNebula vmgroup.
It also offers static XML-RPC call wrappers.
-
Field Summary
Fields inherited from class org.opennebula.client.PoolElement
client, id, xml, xpath
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic OneResponse
Allocates a new vmgroup in OpenNebula.chgrp
(int gid) Changes the groupchmod
(int octet) Changes the permissionschmod
(int owner_u, int owner_m, int owner_a, int group_u, int group_m, int group_a, int other_u, int other_m, int other_a) Changes the vmgroup permissionsChanges the permissionsstatic OneResponse
Changes the permissionsstatic OneResponse
chmod
(Client client, int id, int owner_u, int owner_m, int owner_a, int group_u, int group_m, int group_a, int other_u, int other_m, int other_a) Changes the vmgroup permissionsstatic OneResponse
Changes the permissionschown
(int uid) Changes the ownerchown
(int uid, int gid) Changes the owner/groupstatic OneResponse
Changes the owner/groupdelete()
Deletes the vmgroup from OpenNebula.static OneResponse
Deletes a vmgroup from OpenNebula.info()
Loads the xml representation of the vmgroup.static OneResponse
Retrieves the information of the given vmgroupstatic OneResponse
Retrieves the information of the given VMGroup.lock
(int level) Lock this vmgroupstatic OneResponse
lock this vmgroupRenames this vmgroupstatic OneResponse
Renames this vmgroupAdd VM Group rolestatic OneResponse
Add VM Group roleroleDelete
(int roleID) Delete VM Group rolestatic OneResponse
roleDelete
(Client client, int id, int roleID) Delete VM Group roleroleUpdate
(int roleID, String roleTemplate) Update VM Group rolestatic OneResponse
roleUpdate
(Client client, int id, int roleID, String roleTemplate) Unlock this vmgroupunlock()
Unlock this vmgroupstatic OneResponse
Unlock this vmgroupReplaces the vmgroup template contents.Replaces the vmgroup template contents.static OneResponse
Replaces the vmgroup template contents.
-
Constructor Details
-
VMGroup
Creates a new vmgroup representation.- Parameters:
id
- The vmgroup id.client
- XML-RPC Client.
-
VMGroup
- See Also:
-
-
Method Details
-
allocate
Allocates a new vmgroup in OpenNebula.- Parameters:
client
- XML-RPC Client.description
- A string containing the template of the vmgroup.- Returns:
- If successful the message contains the associated id generated for this vmgroup.
-
info
Retrieves the information of the given vmgroup- Parameters:
client
- XML-RPC Client.id
- the id for the vmgroup to retrieve the information from.- Returns:
- If successful the message contains the string with the information returned by OpenNebula.
-
info
Retrieves the information of the given VMGroup.- Parameters:
client
- XML-RPC Client.id
- The VMGroup id for the VMGroup to retrieve the information fromdecrypt
- If true decrypt sensitive attributes- Returns:
- If successful the message contains the string with the information returned by OpenNebula.
-
delete
Deletes a vmgroup from OpenNebula.- Parameters:
client
- XML-RPC Client.id
- The id of the target vmgroup.- Returns:
- A encapsulated response.
-
chown
Changes the owner/group- Parameters:
client
- XML-RPC Client.id
- The id of the target vmgroup.uid
- The new owner user ID. Set it to -1 to leave the current one.gid
- The new group ID. Set it to -1 to leave the current one.- Returns:
- If an error occurs the error message contains the reason.
-
chmod
public static OneResponse chmod(Client client, int id, int owner_u, int owner_m, int owner_a, int group_u, int group_m, int group_a, int other_u, int other_m, int other_a) Changes the vmgroup permissions- Parameters:
client
- XML-RPC Client.id
- The id of the target vmgroup.owner_u
- 1 to allow, 0 deny, -1 do not changeowner_m
- 1 to allow, 0 deny, -1 do not changeowner_a
- 1 to allow, 0 deny, -1 do not changegroup_u
- 1 to allow, 0 deny, -1 do not changegroup_m
- 1 to allow, 0 deny, -1 do not changegroup_a
- 1 to allow, 0 deny, -1 do not changeother_u
- 1 to allow, 0 deny, -1 do not changeother_m
- 1 to allow, 0 deny, -1 do not changeother_a
- 1 to allow, 0 deny, -1 do not change- Returns:
- If an error occurs the error message contains the reason.
-
chmod
Changes the permissions- Parameters:
client
- XML-RPC Client.id
- The id of the target object.octet
- Permissions octed , e.g. 640- Returns:
- If an error occurs the error message contains the reason.
-
chmod
Changes the permissions- Parameters:
client
- XML-RPC Client.id
- The id of the target object.octet
- Permissions octed , e.g. 640- Returns:
- If an error occurs the error message contains the reason.
-
update
Replaces the vmgroup template contents.- Parameters:
client
- XML-RPC Client.id
- The id of the target vmgroup we want to modify.new_template
- New template contents.append
- True to append new attributes instead of replace the whole template- Returns:
- If successful the message contains the vmgroup id.
-
rename
Renames this vmgroup- Parameters:
client
- XML-RPC Client.id
- The id of the target vmgroup.name
- New name for the vmgroup.- Returns:
- If an error occurs the error message contains the reason.
-
lock
lock this vmgroup- Parameters:
client
- XML-RPC Client.id
- The id of the target vmgroup.level
- Lock level.- Returns:
- If an error occurs the error message contains the reason.
-
unlock
Unlock this vmgroup- Parameters:
client
- XML-RPC Client.id
- The id of the target vmgroup.- Returns:
- If an error occurs the error message contains the reason.
-
roleAdd
Add VM Group role- Parameters:
client
- XML-RPC Client.id
- The id of the target VM Group.roleTemplate
- New template content.- Returns:
- If an error occurs the error message contains the reason.
-
roleDelete
Delete VM Group role- Parameters:
client
- XML-RPC Client.id
- The id of the target VM Group.roleID
- The id of the target role.- Returns:
- If an error occurs the error message contains the reason.
-
roleUpdate
Unlock this vmgroup- Parameters:
client
- XML-RPC Client.id
- The id of the target VM Group.roleID
- The id of the target role.roleTemplate
- Updated template content.- Returns:
- If an error occurs the error message contains the reason.
-
info
Loads the xml representation of the vmgroup. The info is also stored internally.- See Also:
-
delete
Deletes the vmgroup from OpenNebula.- Returns:
- A encapsulated response.
-
chown
Changes the owner/group- Parameters:
uid
- The new owner user ID. Set it to -1 to leave the current one.gid
- The new group ID. Set it to -1 to leave the current one.- Returns:
- If an error occurs the error message contains the reason.
-
chown
Changes the owner- Parameters:
uid
- The new owner user ID.- Returns:
- If an error occurs the error message contains the reason.
-
chgrp
Changes the group- Parameters:
gid
- The new group ID.- Returns:
- If an error occurs the error message contains the reason.
-
chmod
public OneResponse chmod(int owner_u, int owner_m, int owner_a, int group_u, int group_m, int group_a, int other_u, int other_m, int other_a) Changes the vmgroup permissions- Parameters:
owner_u
- 1 to allow, 0 deny, -1 do not changeowner_m
- 1 to allow, 0 deny, -1 do not changeowner_a
- 1 to allow, 0 deny, -1 do not changegroup_u
- 1 to allow, 0 deny, -1 do not changegroup_m
- 1 to allow, 0 deny, -1 do not changegroup_a
- 1 to allow, 0 deny, -1 do not changeother_u
- 1 to allow, 0 deny, -1 do not changeother_m
- 1 to allow, 0 deny, -1 do not changeother_a
- 1 to allow, 0 deny, -1 do not change- Returns:
- If an error occurs the error message contains the reason.
-
chmod
Changes the permissions- Parameters:
octet
- Permissions octed , e.g. 640- Returns:
- If an error occurs the error message contains the reason.
-
chmod
Changes the permissions- Parameters:
octet
- Permissions octed , e.g. 640- Returns:
- If an error occurs the error message contains the reason.
-
update
Replaces the vmgroup template contents.- Parameters:
new_template
- New template contents.- Returns:
- If successful the message contains the vmgroup id.
-
update
Replaces the vmgroup template contents.- Parameters:
new_template
- New template contents.append
- True to append new attributes instead of replace the whole template- Returns:
- If successful the message contains the vmgroup id.
-
rename
Renames this vmgroup- Parameters:
name
- New name for the vmgroup.- Returns:
- If an error occurs the error message contains the reason.
-
lock
Lock this vmgroup- Parameters:
level
- Lock level.- Returns:
- If an error occurs the error message contains the reason.
-
unlock
Unlock this vmgroup- Returns:
- If an error occurs the error message contains the reason.
-
roleAdd
Add VM Group role- Parameters:
roleTemplate
- Updated template content.- Returns:
- If an error occurs the error message contains the reason.
-
roleDelete
Delete VM Group role- Parameters:
roleID
- The id of the target role.- Returns:
- If an error occurs the error message contains the reason.
-
roleUpdate
Update VM Group role- Parameters:
roleID
- The id of the target role.roleTemplate
- Updated template content.- Returns:
- If an error occurs the error message contains the reason.
-