Command development

Do you want to write your own command? You are at the right place. As a newcomer, you should start with Tutorial.

Once you have your command ready, don’t forget to make it public in our repository.

Command versus Script:

Until now we’ve been using command as a term for a subcommand of LMI metacommand and a package (rpm/python egg) containing it. In this documentation you’ll encounter another words seemingly meaning the same. Following dictionary tries to clear out any confusion:

Term	Description
command	Either a subcommand of LMI metacommand or a software package containing a script. It may have several subcommands.
script	Python library utilizing LMIShell for instrumenting CIM providers through a CIMOM broker comming with one or more commands for LMI metacommand.
subcommand	Same as command used in relation to either metacommand or another command.
command wrapper	Implementation of a command in a script as a subclass of LmiBaseCommand.
top-level command	Direct subcommand of LMI metacommand. It appers in its help message.
end-point command	command without any subcommand. It handles command-line arguments and renders output.
command multiplexer	command with one or more subcommands. They do not handle command line arguments.
command name	Is a single word denoting command on a command line.
command’s full name	All command names leading up to the command optionally including the lmi. For example in statement lmi -h myhost.example.org storage fs create ext4 /dev/vda5 the full name of command create is lmi storage fs create.

Contents:

• Tutorial
  • Required knowledge
  • Preparation
  • OpenLMI LogicalFile introduction
  • Let’s write some code
  • Summary
• Basics
  • Prerequisities
  • Introduction
  • Writing a library
  • Command wrappers overview
  • Setup script
  • Conventions
  • Debugging
• Command classes
  • End-point commands
  • Command multiplexers
• Command properties
  • Options pre-processing
  • Associating a function
  • Function invocation
  • Output rendering
  • Command specific properties
  • LmiSelectCommand properties