General manipulation of users and groups are done with the objects from following classes:
- :ref:`LMI_AccountManagementService <LMI-AccountManagementService>`
- :ref:`LMI_Account <LMI-Account>`
- :ref:`LMI_Group <LMI-Group>`
- :ref:`LMI_MemberOfGroup <LMI-MemberOfGroup>`
- :ref:`LMI_Identity <LMI-Identity>`
- :ref:`LMI_AccountInstanceCreationIndication <LMI-AccountInstanceCreationIndication>`
- :ref:`LMI_AccountInstanceDeletionIndication <LMI-AccountInstanceDeletionIndication>`
Some common use cases are described in the following parts
Note
Examples are written for lmishell version 0.9.
List of users are provided by :ref:`LMI_Account <LMI-Account>`. Each one object of this class represents one user on the system. Both system and non-sytem users are directly in :ref:`LMI_Account <LMI-Account>` class:
# List user by name
print c.root.cimv2.LMI_Account.first_instance({"Name": "root"})
# List user by id
print c.root.cimv2.LMI_Account.first_instance({"UserID": "0"})
Similarly like users, groups are represented by objects of :ref:`LMI_Group <LMI-Group>` class:
# List group by name
print c.root.cimv2.LMI_Group.first_instance({"Name": "root"})
# List group by id
print c.root.cimv2.LMI_Group.first_instance({"InstanceID": "LMI:GID:0"})
:ref:`LMI_Identity <LMI-Identity>` is class representing users and groups on the system. Group membership is represented by :ref:`LMI_MemberOfGroup <LMI-MemberOfGroup>` association. It associates :ref:`LMI_Group <LMI-Group>` and :ref:`LMI_Identity <LMI-Identity>`, where :ref:`LMI_Identity <LMI-Identity>` is associated by :ref:`LMI_AssignedAccountIdentity <LMI-AssignedAccountIdentity>` with :ref:`LMI_Account <LMI-Account>`:
# Get users from root group
# 1) Get root group object
root_group = c.root.cimv2.LMI_Group.first_instance({"Name": "root"})
# 2) Get LMI_Identity objects associated with root group
identities = root_group.associators(
AssocClass="LMI_MemberOfGroup", ResultClass="LMI_Identity")
# 3) go through all identites, get LMI_Account associated with identity and print user name
# Note: associators returns a list, but there is just one LMI_Account
for i in identities:
print i.first_associator(
AssocClass="LMI_AssignedAccountIdentity",
ResultClass="LMI_Account").Name
For user creation we have to use :ref:`LMI_AccountManagementService <LMI-AccountManagementService>`. There is :ref:`CreateAccount <LMI-AccountManagementService-CreateAccount>` method, which will create user with descired attributes:
# get computer system cs = c.root.cimv2.PG_ComputerSystem.first_instance() # get service lams = c.root.cimv2.LMI_AccountManagementService.first_instance() # invoke method, print result lams.CreateAccount(Name="lmishell-user", System=cs)
Similarly like creating user, creating groups are don in :ref:`LMI_AccountManagementService <LMI-AccountManagementService>`, using :ref:`CreateGroup <LMI-AccountManagementService-CreateGroup>` method:
# get computer system cs = c.root.cimv2.PG_ComputerSystem.first_instance() # get service lams = c.root.cimv2.LMI_AccountManagementService.first_instance() # invoke method, print result print lams.CreateGroup(Name="lmishell-group", System=cs)
User deletion is done with :ref:`DeleteUser <LMI-Account-DeleteUser>` method on the desired :ref:`LMI_Account <LMI-Account>` object.
# get the desired user
acci = c.root.cimv2.LMI_Account.first_instance({"Name": "tobedeleted"})
# delete the user
acci.DeleteUser()
Note
Previous releases allowed to use DeleteInstance intrinsic method to
delete LMI_Account. This method is now deprecated and
will be removed from future releases of OpenLMI Account. The reason is that
DeleteInstance cannot have parameters; it is equivalent to call
DeleteAccount without specifying parameters.
Group deletion is done with :ref:`DeleteGroup <LMI-Group-DeleteGroup>` method on the desired :ref:`LMI_Group <LMI-Group>` object,
# get the desired group
grp = c.root.cimv2.LMI_Group.first_instance({"Name": "tobedeleted"})
# delete the group
grp.DeleteGroup()
Note
Previous releases allowed to use DeleteInstance intrinsic method to
delete LMI_Group. This method is now deprecated and
will be removed from future releases of OpenLMI Account. The reason is that
we want to have consistent way to delete user and group.
Adding user to group is done with CreateInstance intrinsic method on the
:ref:`LMI_MemberOfGroup <LMI-MemberOfGroup>` class, which requires reference
to :ref:`LMI_Group <LMI-Group>` and :ref:`LMI_Identity <LMI-Identity>`:
# We will add root user to pegasus group
# get group pegasus
grp = c.root.cimv2.LMI_Group.first_instance_name({"Name": "pegasus"})
# get user root
acc = c.root.cimv2.LMI_Account.first_instance({"Name": "root"})
# get identity of root user
identity = acc.first_associator_name(
AssocClass='LMI_AssignedAccountIdentity',
ResultClass="LMI_Identity")
# create instance of LMI_MemberOfGroup with the above references
c.root.cimv2.LMI_MemberOfGroup.create_instance({"Member":identity, "Collection":grp})
Removing user from group is done with DeleteInstance intrinsic method
on the desired :ref:`LMI_MemberOfGroup <LMI-MemberOfGroup>` object:
# We will remove root user from pegasus group
# get group pegasus
grp = c.root.cimv2.LMI_Group.first_instance_name({"Name": "pegasus"})
# get user root
acc = c.root.cimv2.LMI_Account.first_instance({"Name": "root"})
# get identity of root user
identity = acc.first_associator(
AssocClass="LMI_AssignedAccountIdentity",
ResultClass="LMI_Identity")
# iterate through all LMI_MemberOfGroup associated with identity and remove the one with our group
for mog in identity.references(ResultClass="LMI_MemberOfGroup"):
if mog.Collection == grp:
mog.delete()
It is also possible to modify user details and it is done by ModifyInstance
intrinsic method on the desired :ref:`LMI_Account <LMI-Account>` object:
# Change login shell of test user
acci = c.root.cimv2.LMI_Account.first_instance({"Name": "test"})
acci.LoginShell = '/bin/sh'
# propagate changes
acci.push()
OpenLMI Account supports the following indications:
- :ref:`LMI_AccountInstanceCreationIndication <LMI-AccountInstanceCreationIndication>`
- :ref:`LMI_AccountInstanceDeletionIndication <LMI-AccountInstanceDeletionIndication>`
Both indications work only on the following classes:
Please see LMIShell Indications API reference for an overview how indications work.
Client can be notified when instance of class has been created. It is done with
:ref:`LMI_AccountInstanceCreationIndication <LMI-AccountInstanceCreationIndication>`. The indication filter query must be in the following form:
SELECT * FROM LMI_AccountInstanceCreationIndication WHERE SOURCEINSTANCE ISA class_name, where class_name is one of the allowed classes.
The following example creates filter, handler and subscription (lmi shell does that in one step), which will notify client when user is created:
# Notify when a user is created
c.subscribe_indication(
Name="account_creation",
Query='SELECT * FROM LMI_AccountInstanceCreationIndication WHERE SOURCEINSTANCE ISA LMI_Account',
Destination="http://192.168.122.1:5988" # this is the destination computer, where all the indications will be delivered
)
Client can be notified when instance is deleted. The same rules like in Creation Indication applies here:
# Notify when a user is deleted
c.subscribe_indication(
Name="account_deletion",
Query='SELECT * FROM LMI_AccountInstanceDeletionIndication WHERE SOURCEINSTANCE ISA LMI_Account',
Destination="http://192.168.122.1:5988" # this is the destination computer, where all the indications will be delivered
)
Note
Both indications use the indication manager and polling.
The following code snippet illustrates usage of indication listener and subscription. It is a complete minimal example of user creation. Once a new account is added, simple informational message is printed on the standard output.
#!/usr/bin/lmishell
from lmi.shell import LMIIndicationListener
import socket
import time
import random
def ind_handler(indication, **kwargs):
print "User '%s' added" % indication["SourceInstance"]["Name"]
c = connect("localhost", "pegasus", "test")
indication_port = random.randint(12000, 13000)
listener = LMIIndicationListener("0.0.0.0", indication_port)
uniquename = listener.add_handler("account_watch-XXXXXXXX", ind_handler)
listener.start()
c.subscribe_indication(
Name=uniquename,
Query="select * from LMI_AccountInstanceCreationIndication where SourceInstance isa LMI_Account",
Destination="http://%s:%d" % (socket.gethostname(), indication_port)
)
try:
while True:
time.sleep(0.1)
pass
except KeyboardInterrupt:
pass
c.unsubscribe_indication(uniquename)
Note
Press Ctrl+C to terminate the script. Also, remember to change the login credentials! The example picks a random port in the 12000 - 13000 range, no check for port occupancy is made, a conflict on a busy system is possible.