Advanced CLI Tasks

This is a list of advanced tasks to perform with the MAAS CLI. See MAAS CLI on how to get started.

Update node hostname and power parameters

To update the hostname and power parameters of a node:

maas $PROFILE machine update $SYSTEM_ID \
    hostname=$HOSTNAME \
    power_type=$POWER_TYPE \
    power_parameters_power_address=$POWER_ADDRESS \

For example, to configure a KVM-based node:

maas $PROFILE machine update $SYSTEM_ID \
    hostname=$HOSTNAME \
    power_type=virsh \
    power_parameters_power_address=qemu+ssh://ubuntu@$KVM_HOST/system \

See Common CLI tasks for how to find a node's system id and BMC Power Types for details on different power types.

Relay DHCP

To relay DHCP traffic for a VLAN (source) through another VLAN (target):

maas $PROFILE vlan update $FABRIC_ID $VLAN_VID_SRC relay_vlan=$VLAN_ID_TARGET

For example, to relay VLAN with vid 0 (on fabric-2) through VLAN with id 5002 :

maas $PROFILE vlan update 2 0 relay_van=5002

See DHCP relay for more information.

Assign a network interface to a fabric

This task is made easier with the aid of the jq utility. It filters the maas command (JSON formatted) output and prints it in a desired way. This allows one to quickly view and compare data. Go ahead and install it:

sudo apt install jq

In summary, an interface is indirectly assigned to a fabric by assigning it to a VLAN. First we need to gather various bits of data.

List some information on all machines:

maas $PROFILE machines read | jq '.[] | \
    {hostname:.hostname, system_id: .system_id, status:.status}' --compact-output

Example output:


Note: An interface can only be edited when the corresponding machine has a status of 'Ready'. This is numberically denoted by the integer '4'.

List some information for all interfaces on the machine in question (identified by its system id 'dfgnnd'):

maas $PROFILE interfaces read dfgnnd | jq '.[] | \
    {,, mac:.mac_address, vid:.vlan.vid, fabric:.vlan.fabric}' --compact-output

Example output:


List some information for all fabrics:

maas $PROFILE fabrics read | jq '.[] | \
    {, vlans:.vlans[] | {, vid:.vid}}' --compact-output

Example output:


This example will show how to move interface '8' (on machine 'dfgnnd') from 'fabric-1' to 'fabric-0'. Based on the gathered information, this will consist of changing the interface's VLAN from '5002' to '5001':

maas $PROFILE interface update dfgnnd 8 vlan=5001 >/dev/null

Verify the operation by relisting information for the machine's interface:

maas $PROFILE interfaces read dfgnnd | jq '.[] | \
    {,, mac:.mac_address, vid:.vlan.vid, fabric:.vlan.fabric}' --compact-output

The output shows that the interface is now on fabric-0:


Change the IP assignment mode of a network interface

To edit the IP assignment mode of a network interface the existing subnet link first needs to be removed.

Begin by finding the interface ID as well as the interface's subnet link ID with the command:

maas $PROFILE node read $SYSTEM_ID

Once that's done, proceed to unlink and link:

maas $PROFILE interface unlink-subnet $SYSTEM_ID $INTERFACE_ID id=$SUBNET_LINK_ID
maas $PROFILE interface link-subnet $SYSTEM_ID $INTERFACE_ID mode=$IP_MODE subnet=$SUBNET_CIDR [$OPTIONS]

For instance, to have interface '58', with subnet link '146', on node 'exqn37' use DHCP on subnet '':

maas $PROFILE interface unlink-subnet exqn37 58 id=146
maas $PROFILE interface link-subnet exqn37 58 mode=dhcp subnet=

If, instead of DHCP, a static address was desired, then the second command would have looked like:

maas $PROFILE interface link-subnet exqn37 58 mode=static subnet= ip_address=

For a summary of IP assignment modes see Post-commission configuration.

Install a rack controller

To install and register a rack controller with the MAAS:

sudo apt install maas-rack-controller
sudo maas-rack register

Note: The register command is only needed if the rack controller is not being added to a system that already houses an API server.

You will be asked for the URL of the region API server. If you provide a hostname ensure it is resolvable. Next, you will be prompted for the secret key that is stored in file /var/lib/maas/secret on the API server.

You can get the above information from the web UI by visiting the 'Nodes' page, then the Controller tab, and clicking the button 'Add rack controller'. Here is an example of what you may see:


Based on the above, then, we could have also entered:

sudo maas-rack register --url \
    --secret fa847000e7cb681101d26e3477e6e39e

See Rack controller for an overview.

List rack controllers

To list all rack controllers registered with the region:

maas $PROFILE rack-controllers read | grep hostname | cut -d '"' -f 4

Set the default storage layout

To set the default storage layout for all nodes:

maas $PROFILE maas set-config name=default_storage_layout value=$LAYOUT_TYPE

For example, to set the default layout to Flat:

maas $PROFILE maas set-config name=default_storage_layout value=flat

Important: The new default will only apply to newly-commissioned nodes.

See Storage for more details on MAAS storage features.

Set a storage layout

An administrator can set a storage layout for a node with a status of 'Ready' like this:

maas $PROFILE machine set-storage-layout $SYSTEM_ID storage_layout=$LAYOUT_TYPE [$OPTIONS]

For example, to set an LVM layout where the logical volume has a size of 5 GB:

maas $PROFILE machine set-storage-layout $SYSTEM_ID storage_layout=lvm lv_size=5368709120

All storage sizes are currently required to be specified in bytes.

Warning: This will remove the configuration that may exist on any block device.