Offline docs (switch to live docs)                        

Tutorial: Try the MAAS CLI

Errors or typos? Topics missing? Hard to read? Let us know.

This tutorial will walk you through the basics of the MAAS CLI.

Log in

  1. Fetch your API key: Generate your unique key with the following command:
    maas apikey --username=$MAAS_USER > api-key
  1. Login: Use your API key to authenticate:
    maas login admin http://<maas.domain>:5240/MAAS/api/2.0/ < api-key

Configure MAAS

  1. Set the DNS forwarder: If it’s your first time, set up DNS forwarding:
    maas $MAAS_USER maas set-config name=upstream_dns value=8.8.8.8
  1. Import Ubuntu images: Again, if new, pull in Ubuntu images:
    maas $MAAS_USER boot-resources import

Manage nodes

  1. Enlist a node: Add a new machine to MAAS:
    maas $MAAS_USER machines create architecture=amd64 \
            power_type=virsh mac_addresses=52:54:00:00:00:01
  1. Review status: Confirm the node’s state:
    maas $MAAS_USER machines read | jq '.[].status_name'
  1. Commission a node: Prepare the node for deployment:
    maas $MAAS_USER machine commission <node_id>
  1. Acquire a node: Claim the commissioned node:
    maas $MAAS_USER machines allocate system_id=<id>
  1. Deploy a node: Execute the deployment:
    maas $MAAS_USER machine deploy <id>

Connect nodes

  1. Fetch a node’s IP: Retrieve the IP of a deployed node:
    lxc list

  1. Gain SSH access: Just log in as ubuntu.

  2. File transfer: Use scp for transferring files, and apply your customisations.

Explore more