diff options
author | Jan Safranek <jsafrane@redhat.com> | 2013-10-18 14:45:03 +0200 |
---|---|---|
committer | Jan Safranek <jsafrane@redhat.com> | 2013-10-18 14:45:03 +0200 |
commit | c15f9ee5a0e25a91781e4c23f1cfb0ca7c5b7336 (patch) | |
tree | dc34216411938495b489368e15e22a7e5a5d0878 /src/account | |
parent | 087d51a3b03815ddbacaf62bf2fa047dbcbb9537 (diff) | |
download | openlmi-providers-c15f9ee5a0e25a91781e4c23f1cfb0ca7c5b7336.tar.gz openlmi-providers-c15f9ee5a0e25a91781e4c23f1cfb0ca7c5b7336.tar.xz openlmi-providers-c15f9ee5a0e25a91781e4c23f1cfb0ca7c5b7336.zip |
Rework documentation.
- Everything is in openlmi-providers/doc/admin directory.
- 'make doc' automatically builds documentation of all
enabled providers.
- Documentation shares one 'conf.py' for sphinx.
- All documentation uses the same directory structure.
There is only one CMakefile.txt to generate all the docs.
Diffstat (limited to 'src/account')
-rw-r--r-- | src/account/doc/Makefile | 159 | ||||
-rw-r--r-- | src/account/doc/source/conf.py | 247 | ||||
-rw-r--r-- | src/account/doc/source/dmtf-profile.rst | 79 | ||||
-rw-r--r-- | src/account/doc/source/index.rst | 30 | ||||
-rw-r--r-- | src/account/doc/source/mof/Makefile | 14 | ||||
-rw-r--r-- | src/account/doc/source/mof/header.txt | 2 | ||||
-rw-r--r-- | src/account/doc/source/usage.rst | 241 |
7 files changed, 0 insertions, 772 deletions
diff --git a/src/account/doc/Makefile b/src/account/doc/Makefile deleted file mode 100644 index 7ba5e7b..0000000 --- a/src/account/doc/Makefile +++ /dev/null @@ -1,159 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = build - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext mof - -help: - @echo "Please use \`make <target>' where <target> is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -mof: - make -C source/mof - -mof-clean: - make -C source/mof clean - -clean: mof-clean - -rm -rf $(BUILDDIR)/* - -html: mof - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OpenLMIAccount.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OpenLMIAccount.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/OpenLMIAccount" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OpenLMIAccount" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." diff --git a/src/account/doc/source/conf.py b/src/account/doc/source/conf.py deleted file mode 100644 index 4d61fe6..0000000 --- a/src/account/doc/source/conf.py +++ /dev/null @@ -1,247 +0,0 @@ -# -*- coding: utf-8 -*- -# -# OpenLMI Account documentation build configuration file, created by -# sphinx-quickstart on Wed Aug 21 16:15:23 2013. -# -# This file is execfile()d with the current directory set to its containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys, os - -def setup(app): - # Register new option to include class list and class tree in index.rst - app.add_config_value('includeClasses', 'True', True) -includeClasses = True - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ----------------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.ifconfig', 'sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.viewcode'] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'OpenLMI Account' -copyright = u'2012-2013, Red Hat Inc.' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = '0.3.0' -# The full version, including alpha/beta/rc tags. -release = '0.3.0' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = [] - -# The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - - -# -- Options for HTML output --------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'openlmitheme' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -html_theme_path = ['../../../../tools/'] - -# The name for this set of Sphinx documents. If None, it defaults to -# "<project> v<release> documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a <link> tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'OpenLMIAccountdoc' - - -# -- Options for LaTeX output -------------------------------------------------- - -latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('index', 'OpenLMIAccount.tex', u'OpenLMI Account Documentation', - u'Roman Rakus', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output -------------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'openlmiaccount', u'OpenLMI Account Documentation', - [u'Roman Rakus'], 1) -] - -# If true, show URL addresses after external links. -#man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------------ - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ('index', 'OpenLMIAccount', u'OpenLMI Account Documentation', - u'Roman Rakus', 'OpenLMIAccount', 'One line description of project.', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' diff --git a/src/account/doc/source/dmtf-profile.rst b/src/account/doc/source/dmtf-profile.rst deleted file mode 100644 index 51ab366..0000000 --- a/src/account/doc/source/dmtf-profile.rst +++ /dev/null @@ -1,79 +0,0 @@ -.. _dmtf-profile: - -DMTF profile -============= -The provider implements DMTF's `Simple Identity Management Profile <http://www.dmtf.org/sites/default/files/standards/documents/DSP1034_1.0.1.pdf>`_, -version 1.0.1. - -Profile adjustment ------------------- -The settings classes are not implemented. Necessary settings are done directly -in methods of :ref:`LMI_AccountManagementService <LMI-AccountManagementService>`. -:ref:`LMI_AccountManagementService <LMI-AccountManagementService>` is -subclass of :ref:`CIM_SecurityService <CIM-SecurityService>`, because -there is a change in method parameters as follows: - -* :ref:`CreateAccount <LMI-AccountManagementService-CreateAccount>` does - not take EmbeddedInstance as parameter, but a list of parameters. - -Implementation --------------- -All mandatory classes are implemented. - -Classes -^^^^^^^ -Implemented DMTF classes: - -.. generated by for file in *Provider.c; do prov="${file%%Provider.c}"; printf '* :ref:`%s <%s>`\n\n' "$prov" "${prov/_/-}"; done - -* :ref:`LMI_AccountCapabilities <LMI-AccountCapabilities>` - -* :ref:`LMI_AccountInstanceCreationIndication <LMI-AccountInstanceCreationIndication>` - -* :ref:`LMI_AccountInstanceDeletionIndication <LMI-AccountInstanceDeletionIndication>` - -* :ref:`LMI_AccountManagementCapabilities <LMI-AccountManagementCapabilities>` - -* :ref:`LMI_AccountManagementServiceCapabilities <LMI-AccountManagementServiceCapabilities>` - -* :ref:`LMI_AccountManagementService <LMI-AccountManagementService>` - -* :ref:`LMI_AccountManagementServiceSettingData <LMI-AccountManagementServiceSettingData>` - -* :ref:`LMI_AccountOnSystem <LMI-AccountOnSystem>` - -* :ref:`LMI_Account <LMI-Account>` - -* :ref:`LMI_AccountSettingData <LMI-AccountSettingData>` - -* :ref:`LMI_AssignedAccountIdentity <LMI-AssignedAccountIdentity>` - -* :ref:`LMI_AssignedGroupIdentity <LMI-AssignedGroupIdentity>` - -* :ref:`LMI_EnabledAccountCapabilities <LMI-EnabledAccountCapabilities>` - -* :ref:`LMI_Group <LMI-Group>` - -* :ref:`LMI_HostedAccountManagementService <LMI-HostedAccountManagementService>` - -* :ref:`LMI_Identity <LMI-Identity>` - -* :ref:`LMI_MemberOfGroup <LMI-MemberOfGroup>` - -* :ref:`LMI_OwningGroup <LMI-OwningGroup>` - -* :ref:`LMI_ServiceAffectsIdentity <LMI-ServiceAffectsIdentity>` - -* :ref:`LMI_SettingsDefineAccountCapabilities <LMI-SettingsDefineAccountCapabilities>` - -* :ref:`LMI_SettingsDefineManagementCapabilities <LMI-SettingsDefineManagementCapabilities>` - -Methods -^^^^^^^ -Implemented: - -* :ref:`CreateAccount <LMI-AccountManagementService-CreateAccount>` - -Additional methods: - -* :ref:`CreateGroup <LMI-AccountManagementService-CreateGroup>` diff --git a/src/account/doc/source/index.rst b/src/account/doc/source/index.rst deleted file mode 100644 index 1ee6561..0000000 --- a/src/account/doc/source/index.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. OpenLMI Account documentation master file, created by - sphinx-quickstart on Wed Aug 21 16:15:23 2013. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -OpenLMI Account Provider documentation -=========================================== -OpenLMI Account is CIM provider which manages POSIX accounts. -It allows to create, delete and modify users and groups. - -The provider implements DMTF identity profile, for more details read -:ref:`DMTF profile <dmtf-profile>`. - -Contents: - -.. toctree:: - :maxdepth: 2 - - dmtf-profile - usage - -.. ifconfig:: includeClasses - - OpenLMI Account CIM Classes: - - .. toctree:: - :maxdepth: 1 - - mof/tree - mof/index diff --git a/src/account/doc/source/mof/Makefile b/src/account/doc/source/mof/Makefile deleted file mode 100644 index b5af489..0000000 --- a/src/account/doc/source/mof/Makefile +++ /dev/null @@ -1,14 +0,0 @@ -all: index.rst - -TOPDIR=../../../../.. -MOFS=$(TOPDIR)/mof/60_LMI_Account.mof - -clean: - rm -f *.rst - -index.rst: $(MOFS) - $(TOPDIR)/tools/openlmi-doc-class2rst -H header.txt -M `echo $(MOFS) | sed 's/ / -M /g'` \ - -S /usr/share/mof/cim-current/CIM_Schema.mof \ - -S $(TOPDIR)/mof/05_LMI_Qualifiers.mof \ - -S $(TOPDIR)/mof/30_LMI_Jobs.mof \ - `cat $(MOFS) | grep "^class" | cut -d ' ' -f 2 | sed 's/://'` diff --git a/src/account/doc/source/mof/header.txt b/src/account/doc/source/mof/header.txt deleted file mode 100644 index cc06402..0000000 --- a/src/account/doc/source/mof/header.txt +++ /dev/null @@ -1,2 +0,0 @@ -Class reference -=============== diff --git a/src/account/doc/source/usage.rst b/src/account/doc/source/usage.rst deleted file mode 100644 index f8a5e89..0000000 --- a/src/account/doc/source/usage.rst +++ /dev/null @@ -1,241 +0,0 @@ -OpenLMI Account usage -===================== - -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 - -List users ----------- -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"}) - - -List groups ------------ -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"}) - - -List group members ------------------- -: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(ResultClass="LMI_Identity", AssocClass="LMI_MemberOfGroup") - # 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(ResultClass="LMI_Account").Name - -Create user ------------ -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) - -Create group ------------- -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) - - -Delete user ------------ -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. - - -Delete group ------------- -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. - - -Add user to 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": "pegasus"}) - # get user root - acc = c.root.cimv2.LMI_Account.first_instance({"Name": "root"}) - # get identity of root user - identity = acc.first_associator(ResultClass="LMI_Identity") - # create instance of LMI_MemberOfGroup with the above references - c.root.cimv2.LMI_MemberOfGroup.create_instance({"Member":identity.path, "Collection":grp.path}) - -Remove user from group ----------------------- -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": "pegasus"}) - # get user root - acc = c.root.cimv2.LMI_Account.first_instance({"Name": "root"}) - # get identity of root user - identity = acc.associators(ResultClass="LMI_Identity")[0] - # 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.path: - mog.delete() - -Modify user ------------ -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() - -Indications ------------ -OpenLMI Account supports the following indications: - -* :ref:`LMI_AccountInstanceCreationIndication <LMI-AccountInstanceCreationIndication>` - -* :ref:`LMI_AccountInstanceDeletionIndication <LMI-AccountInstanceDeletionIndication>` - -Both indications works only on the following classes: - -* :ref:`LMI_Account <LMI-Account>` - -* :ref:`LMI_Group <LMI-Group>` - -* :ref:`LMI_Identity <LMI-Identity>` - -See more below. - -Creation Indication -^^^^^^^^^^^^^^^^^^^ -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 do it in one step), which will notify client when user is created: - -:: - - # Notify when a user is created - c.root.interop.create_indication( - FilterCreationClassName="CIM_IndicationFilter", - FilterSystemCreationClassName="CIM_ComputerSystem", - FilterSourceNamespace="root/cimv2", - QueryLanguage="WQL", - Query='SELECT * FROM LMI_AccountInstanceCreationIndication WHERE SOURCEINSTANCE ISA LMI_Account', - Name="account_creation", - HandlerCreationClassName="CIM_IndicationHandlerCIMXML", - HandlerSystemCreationClassName="CIM_ComputerSystem", - Destination="http://192.168.122.1:5988" # this is the destination computer, where all the indications will be delivered - ) - - -Deletion Indication -^^^^^^^^^^^^^^^^^^^ -Client can be notified when instance is deleted. The same rules like in `Creation Indication`_ applies here: - -:: - - # Notify when a user is deleted - c.root.interop.create_indication( - FilterCreationClassName="CIM_IndicationFilter", - FilterSystemCreationClassName="CIM_ComputerSystem", - FilterSourceNamespace="root/cimv2", - QueryLanguage="WQL", - Query='SELECT * FROM LMI_AccountInstanceDeletionIndication WHERE SOURCEINSTANCE ISA LMI_Account', - Name="account_creation", - HandlerCreationClassName="CIM_IndicationHandlerCIMXML", - HandlerSystemCreationClassName="CIM_ComputerSystem", - Destination="http://192.168.122.1:5988" # this is the destination computer, where all the indications will be delivered - ) - -.. note:: - Both indications uses indication manager and polling. |