Repository : http://git.fedorahosted.org/cgit/cura-tools.git
On branch : master
commit 059f54f7ff903da916b899485e4a8c0f12c52457 Author: Peter Hatina phatina@redhat.com Date: Thu Nov 29 14:12:59 2012 +0100
add example usage for cli-tools to README
README | 103 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 103 insertions(+), 0 deletions(-)
diff --git a/README b/README index 6e382b2..46f8b4b 100644 --- a/README +++ b/README @@ -57,3 +57,106 @@ python clients for each OpenLMI provider. $ mkdir build && cd build $ ../configure --prefix=/usr # make install + +******************************************************************************* +* Example usage * +******************************************************************************* + +Following examples show, how to use command-line tools: + +* lmi-service.py + $ lmi-service.py -h <hostname> -u <username> -p <password> status <service_name> + $ lmi-service.py -h <hostname> -u <username> -p <password> start <service_name> + $ lmi-service.py -h <hostname> -u <username> -p <password> stop <service_name> + +* lmi-power.py + $ lmi-power.py -h <hostname> -u <username> -p <password> poweroff + $ lmi-power.py -h <hostname> -u <username> -p <password> reboot + +* lmi-user.py + $ lmi-user.py -h <hostname> -u <username> -p <password> list-users + $ lmi-user.py -h <hostname> -u <username> -p <password> list-groups + $ lmi-user.py -h <hostname> -u <username> -p <password> group-members <group_name> + +* lmi-ip.py + $ lmi-ip.py -h <hostname> -u <username> -p <password> addr show + - shows available network interfaces and their associated addresses + $ lmi-ip.py -h <hostname> -u <username> -p <password> addr set <address>/<mask> dev <device_name> + - sets the ipv4 address to specified interface + $ lmi-ip.py -h <hostname> -u <username> -p <password> addr + +* lmi-shell + - general usage example: + - how to start a shell: + $ lmi-shell.py + > + + - how to exit from the shell: + > <ctrl+d> + $ + - how to use previous commands: + - press up arrow to list previous commands in history + - reverse-search by <ctrl+r> and type substring of the command + + - how to clear a history: + > clear_history() + + - how to connect to a remote machine: + > c = connect("hostname", "username", "password") + + or + + > c = connect("hostname", "username") + password: <not echoed> + > + - how to turn off display "sugar" for return values: + > use_display_sugar(False) + + - example how to stop a service: + $ lmi-shell.py + > c = connect("hostname", "username", "password") + > service = c.cimv2.LMI_Service.first_instance("service") + > service.Status + OK + > service.StopService() + hostname: ok (0) + > service.Status + Stopped + > <ctrl+d> + $ + + - example how to show a class documentation: + $ lmi-shell.py + > c = connect("hostname", "username", "password") + > lmi_service = c.cimv2.LMI_Service + > lmi_service.doc() + ... class documentation ... + q + > <ctrl+d> + $ + + -example how to show an instance documentation with properties: + $ lmi-shell.py + > c = connect("hostname", "username", "password") + > service = c.cimv2.LMI_Service.first_instance() + > service.doc() + ... instance documentation with properties ... + > <ctrl+d> + $ + + - example how to print available namespaces, classes, methods, etc + $ lmi-shell.py + > c = connect("hostname", "username", "password") + > c.print_namespaces() + root + cimv2 + interop + > c.cimv2.print_classes() + ... available classes ... + > service = c.cimv2.LMI_Service.first_instance() + > service.print_methods() + ... instance methods ... + > service.print_properties() + ... instance properties ... + > <ctrl+d> + $
cura-tools-devel@lists.fedorahosted.org