maas¶

Usage¶

$ maas <profile> <command> [parameters]

The available commands are dependent on the API you are connecting to and the profile you use. The currently available options are explained below.

Description¶

As well as the web interface, many tasks can be performed by accessing the MAAS API directly through the maas command. This section details how to login with this tool and perform some common operations.

Logging in¶

Before the API will accept any commands from maas, you must first login. To do this, you need the API key which can be found in the user interface.

Log in to the web interface on your MAAS. Click on the username in the top right corner and select ‘Preferences’ from the menu which appears.

A new page will load...

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 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 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 commands¶

The maas 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.

Configure DHCP and DNS services

Commission all enlisted nodes

Setting IPMI power parameters for a node

The main maas commands are:

list

lists the details [name url auth-key] of all the currently logged-in profiles.

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.

logout <profile>

Logs out from the given profile, flushing the stored credentials.

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.

<profile> [command] [options] ...

Using the given profile name instructs maas 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 <profile> account [-d –debug] [-h –help] create-authorisation-token | delete-authorisation-token [token_key=<value>]

-d, --debug

Displays debug information listing the API responses.

-h, --help

Display usage information.

-k, --insecure

Disables the SSL certificate check.

create-authorisation-token

Creates a new MAAS authorisation token for the current profile which can be used to authenticate connections to the API.

delete-authorisation-token token_key=<value>

Removes the given key from the list of authorisation tokens.

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 <profile> nodes list command.

samp:

-h, –help

Display usage information.

release <system_id>

Releases the node given by <system_id>

start <system_id>

Powers up the node identified by <system_id> (where MAAS has information for power management for this node).

stop <system_id>

Powers off the node identified by <system_id> (where MAAS has information for power management for this node).

delete <system_id>

Removes the given node from the MAAS database.

read <system_id>

Returns all the current known information about the node specified by <system_id>

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'.

Example: Setting the power parameters for an ipmi enabled node:

maas 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¶

-h, --help

Display usage information.

accept <system_id>

Accepts the node referenced by <system_id>.

accept-all

Accepts all currently discovered but not previously accepted nodes.

acquire

Allocates a node to the profile used to issue the command. Any ready node may be allocated.

is-registered mac_address=<address>

Checks to see whether the specified MAC address is registered to a node.

list

Returns a JSON formatted object listing all the currently known nodes, their system_id, status and other details.

list-allocated

Returns a JSON formatted object listing all the currently allocated nodes, their system_id, status and other details.

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.
power_type="<value>" - the power type of
the node (e.g. virsh, ipmi)

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”.

Examples: Accept and commission all discovered nodes:

$ maas maas nodes accept-all

List all known nodes:

$ maas maas nodes list

Filter the list using specific key/value pairs:

$ maas maas nodes list architecture="i386/generic"

node-groups¶

Usage: maas <profile> node-groups [-d –debug] [-h –help] [-k –insecure] register | list | refresh-workers | accept | reject

-d, --debug

Displays debug information listing the API responses.

-h, --help

Display usage information.

-k, --insecure

Disables the SSL certificate check.

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”}]’

list

Returns a JSON list of all currently defined node groups.

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.

accept <uuid>

Accepts a node-group or number of nodegroups indicated by the supplied UUID

reject <uuid>

Rejects a node-group or number of nodegroups indicated by the supplied UUID

node-group-interface¶

For managing the interfaces. See also node-group-interfaces

Usage: maas <profile> node-group-interfaces [-d –debug] [-h –help] [-k –insecure] read | update | delete [parameters...]

..program:: maas node-group-interface

read <uuid> <interface>

Returns the current settings for the given UUID and interface

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

delete <uuid> <interface>

Removes the entry for the given UUID and interface.

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 <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 <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¶

The node-group-interfaces commands are used for configuring the management of DHCP and DNS services where these are managed by MAAS.

Usage: maas <profile> node-group-interfaces [-d –debug] [-h –help] [-k –insecure] list | new [parameters...]

-d, --debug

Displays debug information listing the API responses.

-h, --help

Display usage information.

-k, --insecure

Disables the SSL certificate check.

list <label>

Lists the current stored configurations for the given identifier <label> in a key:value format which should be easy to decipher.

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 <profile> tag read | update-nodes | rebuild | update |: nodes | delete

read <tag_name>

Returns information on the tag specified by <name>

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.

rebuild

Triggers a rebuild of the tag to node mapping.

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.

nodes <tag_name>

Returns a list of nodes which are associated with the given tag.

delete <tag_name>

Deletes the given tag.

tags¶

Tags are a really useful way of identifying nodes with particular characteristics.

For more information on how to use them effectively, please see Making use of Tags

Usage: maas <profile> tag [-d –debug] [-h –help] [-k –insecure] list | new

-d, --debug

Displays debug information listing the API responses.

-h, --help

Display usage information.

-k, --insecure

Disables the SSL certificate check.

list

Returns a JSON object listing all the current tags known by the MAAS server

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 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 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.

Further Documentation¶

For more documentation of MAAS, please see https://maas.ubuntu.com/docs

maas¶

Usage¶

Description¶

Logging in¶

maas commands¶

account¶

node¶

nodes¶

node-groups¶

node-group-interface¶

node-group-interfaces¶

tag¶

tags¶

unused commands¶

Further Documentation¶

See Also¶

MAAS

Related Topics

This Page

Navigation

maas¶

Usage¶

Description¶

Logging in¶

maas commands¶

account¶

node¶

nodes¶

node-groups¶

node-group-interface¶

node-group-interfaces¶

tag¶

tags¶

unused commands¶

Further Documentation¶

See Also¶

MAAS

Related Topics

This Page

Quick search

Navigation