launchpad-reviewers team mailing list archive
-
launchpad-reviewers team
-
Mailing list archive
-
Message #14182
[Merge] lp:~evilnick/maas/1.2-backport-bugfix1076373 into lp:maas/1.2
Nick Veitch has proposed merging lp:~evilnick/maas/1.2-backport-bugfix1076373 into lp:maas/1.2.
Commit message:
Backport of sphinx bug workaround, to fix #1076373 in 1.2
Requested reviews:
MAAS Maintainers (maas-maintainers)
For more details, see:
https://code.launchpad.net/~evilnick/maas/1.2-backport-bugfix1076373/+merge/134082
Backport of the sphinx bug workaround
--
https://code.launchpad.net/~evilnick/maas/1.2-backport-bugfix1076373/+merge/134082
Your team MAAS Maintainers is requested to review the proposed merge of lp:~evilnick/maas/1.2-backport-bugfix1076373 into lp:maas/1.2.
=== modified file 'docs/maascli.rst'
--- docs/maascli.rst 2012-10-04 15:14:12 +0000
+++ docs/maascli.rst 2012-11-13 12:03:21 +0000
@@ -1,24 +1,569 @@
-As well as the web interface, many tasks can be performed by accessing the MAAS API directly through the maas-cli command. This section details how to login with this tool and perform some common operations.
+As well as the web interface, many tasks can be performed by accessing
+the MAAS API directly through the maas-cli command. This section
+details how to login with this tool and perform some common
+operations.
.. _api-key:
Logging in
----------
-Before the API will accept any commands from maas-cli, you must first login. To do this, you need the API key which can be found in the user interface.
-
-Login to the web interface on your MAAS. Click on the username in the top right corner and select 'Preferences' from the menu which appears.
-
+Before the API will accept any commands from maas-cli, you must first
+login. To do this, you need the API key which can be found in the user
+interface.
+
+Login to the web interface on your MAAS. Click on the username in the
+top right corner and select 'Preferences' from the menu which appears.
+
+.. only:: html
.. image:: media/maascli-prefs.*
A new page will load...
.. image:: media/maascli-key.*
-The very first item is a list of MAAS keys. One will have already been generated when the system was installed. It's easiest to just select and copy the key (it's quite long!) and then paste it into the commandline::
-
- $ maas-cli login <key>
-
+The very first item is a list of MAAS keys. One will have already been
+generated when the system was installed. It's easiest to just select
+and copy the key (it's quite long!) and then paste it into the
+commandline. The format of the login command is::
+
+ $ maas-cli login <profile-name> <hostname> <key>
+
+The profile created is an easy way of associating your credentials with any
+subsequent call to the API. So an example login might look like this::
+
+$ maas-cli login maas http://10.98.0.13/MAAS/api/1.0 AWSCRMzqMNy:jjk...5e1FenoP82Qm5te2
+
+which creates the profile 'maas' and registers it with the given key at the
+specified API endpoint.
+If you omit the credentials, they will be prompted for in the console. It is
+also possible to use a hyphen, '-' in place of the credentials. In this case a
+single line will be read from stdin, stripped of any whitespace and used as the
+credentials, which can be useful if you are devolping scripts for specific
+tasks.
+If an empty string is passed instead of the credentials, the profile will be
+logged in anonymously (and consequently some of the API calls will not be
+available)
+
+
+maas-cli commands
+-----------------
+
+The ``maas-cli`` command exposes the whole API, so you can do anything
+you actually *can* do with MAAS using this command. Unsurprisingly,
+this leaves us with a vast number of options, but before we delve into
+detail on the specifics, here is a sort of 'cheat-sheet' for common
+tasks you might want to do using ``maas-cli``.
+
+ * :ref:`Configure DHCP and DNS services <cli-dhcp>`
+
+ * :ref:`Commission all enlisted nodes <cli-commission>`
+
+ * :ref:`Setting IPMI power parameters for a node <cli-power>`
+
+The main maas-cli commands are:
+
+.. program:: maas-cli
+
+:samp:`list`
+
+ lists the details [name url auth-key] of all the currently logged-in
+ profiles.
+
+:samp:`login <profile> <url> <key>`
+
+ Logs in to the MAAS controller API at the given URL, using the key
+ provided and associates this connection with the given profile name.
+
+:samp:`logout <profile>`
+
+ Logs out from the given profile, flushing the stored credentials.
+
+:samp:`refresh`
+
+ Refreshes the API descriptions of all the current logged in
+ profiles. This may become necessary for example when upgrading the
+ maas packages to ensure the command-line options match with the API.
+
+:samp:`<profile> [command] [options] ...`
+
+ Using the given profile name instructs ``maas-cli`` to direct the
+ subsequent commands and options to the relevant MAAS, which for the
+ current API are detailed below...
+
+
+account
+^^^^^^^
+This command is used for creating and destroying the
+MAAS authorisation tokens associated with a profile.
+
+Usage: maas-cli *<profile>* account [-d --debug] [-h --help]
+create-authorisation-token | delete-authorisation-token [token_key=\
+*<value>*]
+
+.. program:: maas-cli account
+
+:samp:`-d, --debug`
+
+ Displays debug information listing the API responses.
+
+:samp:`-h, --help`
+
+ Display usage information.
+
+:samp:`-k, --insecure`
+
+ Disables the SSL certificate check.
+
+:samp:`create-authorisation-token`
+
+ Creates a new MAAS authorisation token for the current profile
+ which can be used to authenticate connections to the API.
+
+:samp:`delete-authorisation-token token_key=<value>`
+
+ Removes the given key from the list of authorisation tokens.
+
+
+
+
+.. boot-images - not useful in user context
+.. ^^^^^^^^^^^
+
+
+.. files - not useful in user context
+.. ^^^^^
+
+
+node
+^^^^
+
+API calls which operate on individual nodes. With these commands, the
+node is always identified by its "system_id" property - a unique tag
+allocated at the time of enlistment. To discover the value of the
+system_id, you can use the ``maas-cli <profile> nodes list`` command.
+
+USAGE: maas-cli <profile> node [-h] release | start | stop | delete |
+read | update <system_id>
+
+.. program:: maas-cli node
+
+:samp:`-h, --help`
+
+ Display usage information.
+
+:samp:`release <system_id>`
+
+ Releases the node given by *<system_id>*
+
+:samp:`start <system_id>`
+
+ Powers up the node identified by *<system_id>* (where MAAS has
+ information for power management for this node).
+
+:samp:`stop <system_id>`
+
+ Powers off the node identified by *<system_id>* (where MAAS has
+ information for power management for this node).
+
+:samp:`delete <system_id>`
+
+ Removes the given node from the MAAS database.
+
+:samp:`read <system_id>`
+
+ Returns all the current known information about the node specified
+ by *<system_id>*
+
+:samp:`update <system_id> [parameters...]`
+
+ Used to change or set specific values for the node. The valid
+ parameters are listed below::
+
+ hostname=<value>
+ The new hostname for this node.
+
+ architecture=<value>
+ Sets the architecture type, where <value>
+ is a string containing a valid architecture type,
+ e.g. "i386/generic"
+
+ power_type=<value>
+ Apply the given dotted decimal value as the broadcast IP address
+ for this subnet.
+
+ power_parameters_{param1}... =<value>
+ Set the given power parameters. Note that the valid options for these
+ depend on the power type chosen.
+
+ power_parameters_skip_check 'true' | 'false'
+ Whether to sanity check the supplied parameters against this node's
+ declared power type. The default is 'false'.
+
+
+
+.. _cli-power:
+
+Example: Setting the power parameters for an ipmi enabled node::
+
+ maas-cli maas node update <system_id> \
+ power_type="ipmi" \
+ power_parameters_power_address=192.168.22.33 \
+ power_parameters_power_user=root \
+ power_parameters_power_pass=ubuntu;
+
+
+
+
+nodes
+^^^^^
+
+Usage: maas-cli <profile> nodes [-h] is-registered | list-allocated |
+acquire | list | accept | accept-all | new | check-commissioning
+
+.. program:: maas-cli nodes
+
+:samp:`-h, --help`
+
+ Display usage information.
+
+
+:samp:`accept <system_id>`
+
+ Accepts the node referenced by <system_id>.
+
+:samp:`accept-all`
+
+ Accepts all currently discovered but not previously accepted nodes.
+
+:samp:`acquire`
+
+ Allocates a node to the profile used to issue the command. Any
+ ready node may be allocated.
+
+:samp:`is-registered mac_address=<address>`
+
+ Checks to see whether the specified MAC address is registered to a
+ node.
+
+:samp:`list`
+
+ Returns a JSON formatted object listing all the currently known
+ nodes, their system_id, status and other details.
+
+:samp:`list-allocated`
+
+ Returns a JSON formatted object listing all the currently allocated
+ nodes, their system_id, status and other details.
+
+:samp:`new architecture=<value> mac_addresses=<value> [parameters]`
+
+ Creates a new node entry given the provided key=value information
+ for the node. A minimum of the MAC address and architecture must be
+ provided. Other parameters may also be supplied::
+
+ architecture="<value>" - The architecture of the node, must be
+ one of the recognised architecture strings (e.g. "i386/generic")
+ hostname="<value>" - a name for this node. If not supplied a name
+ will be generated.
+ mac_addresses="<value>" - The mac address(es)
+ allocated to this node.
+ powertype="<value>" - the power type of
+ the node (e.g. virsh, ipmi)
+
+
+:samp:`check-commissioning`
+
+ Displays current status of nodes in the commissioning phase. Any
+ that have not returned before the system timeout value are listed
+ as "failed".
+
+.. _cli-commission:
+
+Examples:
+Accept and commission all discovered nodes::
+
+ $ maas-cli maas nodes accept-all
+
+List all known nodes::
+
+ $ maas-cli maas nodes list
+
+Filter the list using specific key/value pairs::
+
+ $ maas-cli maas nodes list architecture="i386/generic"
+
+
+
+node-groups
+^^^^^^^^^^^
+Usage: maas-cli <profile> node-groups [-d --debug] [-h --help] [-k
+--insecure] register | list | refresh-workers | accept | reject
+
+.. program:: maas-cli node-groups
+
+:samp:`-d, --debug`
+
+ Displays debug information listing the API responses.
+
+:samp:`-h, --help`
+
+ Display usage information.
+
+:samp:`-k, --insecure`
+
+ Disables the SSL certificate check.
+
+:samp:`register uuid=<value> name=<value> interfaces=<json_string>`
+
+ Registers a new node group with the given name and uuid. The
+ interfaces parameter must be supplied in the form of a JSON string
+ comprising the key/value data for the interface to be used, for
+ example: interface='["ip":"192.168.21.5","interface":"eth1", \
+ "subnet_mask":"255.255.255.0","broadcast_ip":"192.168.21.255", \
+ "router_ip":"192.168.21.1", "ip_range_low":"192.168.21.10", \
+ "ip_range_high":"192.168.21.50"}]'
+
+:samp:`list`
+
+ Returns a JSON list of all currently defined node groups.
+
+:samp:`refresh_workers`
+
+ It sounds a bit like they will get a cup of tea and a
+ biscuit. Actually this just sends each node-group worker an update
+ of its credentials (API key, node-group name). This command is
+ usually not needed at a user level, but is often used by worker
+ nodes.
+
+:samp:`accept <uuid>`
+
+ Accepts a node-group or number of nodegroups indicated by the
+ supplied UUID
+
+:samp:`reject <uuid>`
+
+ Rejects a node-group or number of nodegroups indicated by the
+ supplied UUID
+
+
+
+node-group-interface
+^^^^^^^^^^^^^^^^^^^^
+For managing the interfaces. See also :ref:`node_group_interfaces`
+
+Usage: maas-cli *<profile>* node-group-interfaces [-d --debug] [-h
+--help] [-k --insecure] read | update | delete [parameters...]
+
+..program:: maas-cli node-group-interface
+
+:samp:`read <uuid> <interface>`
+
+ Returns the current settings for the given UUID and interface
+
+:samp:`update [parameters]`
+
+ Changes the settings for the interface according to the given
+ parameters::
+
+ management= 0 | 1 | 2
+ The service to be managed on the interface ( 0= none, 1=DHCP, 2=DHCP
+ and DNS).
+
+ subnet_mask=<value>
+ Apply the given dotted decimal value as the subnet mask.
+
+ broadcast_ip=<value>
+ Apply the given dotted decimal value as the broadcast IP address for
+ this subnet.
+
+ router_ip=<value>
+ Apply the given dotted decimal value as the default router address
+ for this subnet.
+
+ ip_range_low=<value>
+ The lowest value of IP address to allocate via DHCP
+
+ ip_range_high=<value>
+ The highest value of IP address to allocate via DHCP
+
+:samp:`delete <uuid> <interface>`
+
+ Removes the entry for the given UUID and interface.
+
+.. _cli-dhcp:
+
+Example:
+Configuring DHCP and DNS.
+
+To enable MAAS to manage DHCP and DNS, it needs to be supplied with the relevant
+interface information. To do this we need to first determine the UUID of the
+node group affected::
+
+ $ uuid=$(maas-cli <profile> node-groups list | grep uuid | cut -d\" -f4)
+
+Once we have the UUID we can use this to update the node-group-interface for
+that nodegroup, and pass it the relevant interface details::
+
+ $ maas-cli <profile> node-group-interface update $uuid eth0 \
+ ip_range_high=192.168.123.200 \
+ ip_range_low=192.168.123.100 \
+ management=2 \
+ broadcast_ip=192.168.123.255 \
+ router_ip=192.168.123.1 \
+
+Replacing the example values with those required for this network. The only
+non-obvious parameter is 'management' which takes the values 0 (no management), 1
+(manage DHCP) and 2 (manage DHCP and DNS).
+
+
+.. _node-group-interfaces
+node-group-interfaces
+^^^^^^^^^^^^^^^^^^^^^
+
+The node-group-interfaces commands are used for configuring the
+management of DHCP and DNS services where these are managed by MAAS.
+
+Usage: maas-cli *<profile>* node-group-interfaces [-d --debug] [-h
+--help] [-k --insecure] list | new [parameters...]
+
+.. program:: maas-cli node-group-interfaces
+
+:samp:`-d, --debug`
+
+ Displays debug information listing the API responses.
+
+:samp:`-h, --help`
+
+ Display usage information.
+
+:samp:`-k, --insecure`
+
+ Disables the SSL certificate check.
+
+:samp:`list <label>`
+
+ Lists the current stored configurations for the given identifier
+ <label> in a key:value format which should be easy to decipher.
+
+
+:samp:`new <label> ip=<value> interface=<if_device> [parameters...]`
+
+ Creates a new interface group. The required parameters are the IP
+ address and the network interface this appies to (e.g. eth0). In
+ order to do anything useful, further parameters are required::
+
+ management= 0 | 1 | 2
+ The service to be managed on the interface
+ ( 0= none, 1=DHCP, 2=DHCP and DNS).
+
+ subnet_mask=<value>
+ Apply the given dotted decimal value as the subnet mask.
+
+ broadcast_ip=<value>
+ Apply the given dotted decimal value as the
+ broadcast IP address for this subnet.
+
+ router_ip=<value>
+ Apply the given dotted decimal value as the
+ default router address for this subnet.
+
+ ip_range_low=<value>
+ The lowest value of IP address to allocate via DHCP
+
+ ip_range_high=<value>
+ The highest value of IP address to allocate via DHCP
+
+
+
+
+tag
+^^^
+
+Usage: maas-cli <profile> tag read | update-nodes | rebuild | update |
+ nodes | delete
+
+.. program:: maas-cli tag
+
+:samp:`read <tag_name>`
+
+ Returns information on the tag specified by <name>
+
+:samp:`update-nodes <tag_name> [add=<system_id>] [remove=<system_id>] [nodegroup=<system_id>]`
+
+ Applies or removes the given tag from a list of nodes specified by
+ either or both of add="<system_id>" and remove="<system_id>". The
+ nodegroup parameter, which restricts the operations to a particular
+ nodegroup, is optional, but only the superuser can execute this
+ command without it.
+
+:samp:`rebuild`
+
+ Triggers a rebuild of the tag to node mapping.
+
+:samp:`update <tag_name> [name=<value>] | [comment=<value>]|[definition=<value>]`
+
+ Updates the tag identified by tag_name. Any or all of name,comment
+ and definition may be supplied as parameters. If no parameters are
+ supplied, this command returns the current values.
+
+:samp:`nodes <tag_name>`
+
+ Returns a list of nodes which are associated with the given tag.
+
+:samp:`delete <tag_name>`
+
+ Deletes the given tag.
+
+tags
+^^^^
+Tags are a really useful way of identifying nodes with particular
+characteristics.
+
+.. only:: html For more information on how to use them effectively, please see :ref:`deploy-tags`
+
+Usage: maas-cli <profile> tag [-d --debug] [-h --help] [-k
+--insecure] list | new
+
+.. program:: maas-cli tag
+
+:samp:`-d, --debug`
+
+ Displays debug information listing the API responses.
+
+:samp:`-h, --help`
+
+ Display usage information.
+
+:samp:`-k, --insecure`
+
+ Disables the SSL certificate check.
+
+:samp:`list`
+
+ Returns a JSON object listing all the current tags known by the MAAS server
+
+:samp:`create name=<value> definition=<value> [comment=<value>]`
+
+ Creates a new tag with the given name and definition. A comment is
+ optional. Names must be unique, obviously - an error will be
+ returned if the given name already exists. The definition is in the form of
+ an XPath expression which parses the XML returned by running ``lshw`` on the
+ node.
+
+Example:
+Adding a tag to all nodes which have an Intel GPU::
+
+ $ maas-cli maas tags new name='intel-gpu' \
+ comment='Machines which have an Intel display driver' \
+ definition='contains(//node[@id="display"]/vendor, "Intel")
+
+
+unused commands
+^^^^^^^^^^^^^^^
+Because the ``maas-cli`` command exposes all of the API, it also lists
+some command options which are not really intended for end users, such
+as the "file" and "boot-images" options.
