MAAS 2.7 is released! Check out the release notes. Follow the install instructions to get the version.

"Give me an example of MAAS"

An evolving example may be useful to introduce you to MAAS, and it doesn’t have to be comprehensive – just coherent and plausible. This example will continue to expand and update over time.

So imagine that you’re the IT administrator for a new, 100-bed hospital that’s being planned to serve a suburban community of 5,000 people. Call it “Metaphorical General Hospital” (MGH). Your job is to design a flexible datacentre for this facility. You’ve decided to start with MAAS as your tool of choice, and for this planning exercise, you’ll use KVMs.


You’ll need to start with a little network thinking (and design). Talking through requirements with the staff, you come up with a random list of functions:

Charts Provider orders Provider documentation
Pharmacy Narcotics control Insurance collections
Housekeeping Nursing orders Med reconciliation
Timeclock Patient collections Med/surgical supplies
Office supplies Patient registration Insurance reconciliation
Payroll Medication admin Continuing education
Food service Instrumentation Information technology

This lowest level can be handled as individual machines. With MAAS, you’ll be able to modify how many machines are performing which functions, somewhat on-the-fly, but let’s assume that you start by creating (at least) one KVM for each function. Since you can reassign machines at will, you aren’t going to name them for their functions; instead, you’re just going to use the MAC address of each machine to uniquely identify it.

Try it!

Creating some sample KVMs

Assuming you’ve installed libvirt on the machine where you’ll be running MAAS, you can create a few virtual machines like this:

  1. Open the Virtual Machine Manager application. You’ll see a screen that looks something like this:


  1. Choose File --> New Virtual Machine, which brings you to a corresponding dialog:


  1. Select the “Network Boot (PXE)” option and click the “Forward” button:


  1. Choose the “Generic…” operating system by typing a few letters of “Generic” in the text box and selecting the relevant choice when it becomes available, then go Forward:


  1. For CPU and memory, you can usually accept the defaults:


  1. whereas the storage values have a noticeable effect on local disk usage, so note that, generally, only about 5.0 GiB are needed for a KVM, given an example exercise like this:


  1. In the next screen, you’ll have the chance to set a name; here, we’ve used a pseudo-MAC address, although you can name the machine whatever you want (and then return later to set the name to match the MAC address, if desired):


  1. Selecting “Finish” will create the virtual machine and attempt to boot it – which will fail, since no device currently knows about this KVM (and hence can’t boot it). Not to worry; you’re not done yet:


  1. Select the “information” button (blue circle, white lowercase “i”) to switch to the KVM configuration screens, then select the “Boot Options” choice from the left-hand menu:


  1. Turn off the “IDE” item under “Boot device order:”


  1. When you select “Apply,” a dialog will pop up to remind you that you need to restart this KVM for changes to take effect:


  1. Switch to the “NIC…” option and set the “Network source” and “Device model” as shown, then select “Apply” and respond to the dialog:


  1. You’ll next select the dropdown arrow next to the “on/off” menu bar option and select “Force reset,” then answer the prompt in the affirmative:


You now have a KVM that can be added to MAAS. If you want more than one, you can simply right-click on the one you’ve just created and select “Clone:”

Pro Tip: Cloned KVMs tend to use considerably less host disk space than newly-created ones.


Another KVM will instantiate, using the name of the cloned KVM with an added “-clone” suffix:


You can create as many KVMs as desired, remembering to mind your overall disk usage on your host system.

Let’s assume that once you’re done adding KVMs, you have around 20 up and ready, all named after their assigned MAC address:


No need to create that many KVMs for this example (unless you just want to do so).

Manually adding machines

Once you’ve created the necessary KVMs, you’ll want to manually add machines to MAAS that correspond to your KVMs.


Try it!

Creating a machine from a KVM requires just a few pieces of information, most of which you can gather from the KVM itself:


In the left column, you’re only required to enter a machine name and the machine’s MAC address:


Here, we’ve assigned a variant of the MAC address as the machine name. Note that the machine name cannot include colons (":"), so dashes are substituted. In the right column, it’s necessary to choose the power type. When enlisting KVMs, the correct power type is “Virsh,” as shown below:


For default configurations, the Virsh Address is “qemu+ssh://[your-login-id]@,” where “[your-login-id]” is replaced by your username or login ID on the machine where you’re hosting MAAS and the Virtual Machine Manager. Likewise, the password is your normal login password for the same host. Finally, the Virsh VM ID is retrieved from the “Overview” screen of the KVM itself:


As you add machines, they automatically commission:


When finished, the commissioned machines with be at the “Ready” state, as shown above.


Assigning machines to specific functions is something you can do after you commission and deploy them. (We’ll discuss later on ways to load user apps and data onto the machines using the MAAS API.) Once you’ve got machines running apps, you want to keep up to date about which machine is doing what, when you’re looking at the machine list. You’ll want to assign tags to machines.


Try it! Adding a tag to a machine is simple. Just decide which machine you want to tag:


You’ll want to click on the machine name (in this case, the MAC address), and then choose “Configuration” on the next screen that comes up. This will bring you to a screen from which you can edit some parameters about the machine:


Click on “Edit,” and then add a tag name to the “Tags” field. Tags are automatically remembered by MAAS, so the next time you want to enter the same tag, an autocomplete field will appear, as shown below:


Select “Save changes” to add the tag(s) to the machine. When you return to the machine list, you’ll note that the tag has been associated with that machine:


Tags can will help you keep up with which machine(s) are covering which functions as you apply your apps. You can search and filter by tags, and you can utilize tags from within the API, as well.

Resource pools

As you look at the list of functions you’ve created, and talk more with the staff, you discover that some of these functions fit together more closely than others. With some effort, you work out the following update to your network design:

Provider services
Charts Provider orders Provider documentation
Nursing services
Nursing orders Continuing education
Nursing meds
Medication administration Narcotics control
Prescriber controls
Pharmacy Narcotics control Medication reconciliation
Staff compensation
Timeclock Payroll
Supplies & services
Medical and surgical supplies Office and general supplies
Business office
Patient registration Insurance reconciliation
Patient collections Insurance collections
Patient support
Housekeeping Food service
Staff support
Instrumentation Information technology

You’re aware that the number of machines you’ll need use for each of the individual functions with vary according to real-world events in the hospital. Still, you’d prefer to budget machines for these different functions, so that you know you can meet the needs of each. The easiest way to handle this? Creating resource pools and naming them after the (new) top-level headings in your outline. That way, you can reserve some number of machines for those functions, learning over time how many to allocate to each.

Try it!

Notice at the top of the machine list, there is also a tab labeled, “Resource pools:”


In this example, there are already some resource pools defined to match the different functions above, except for one: Provider services. Click the “Resource pools” tab to go there:


To add the “Provider services” (ProServ) pool, click on “Add pool:”


Fill in the fields for “Name” (which is required, and which can’t have any spaces), and for “Description.” In this case, we’ve filled them in with “ProServ” and “Provider services:”


Click on “Add pool” to add this resource pool to the list, then click on “Machines” to return to the machine list. Once there, it’s simple to add machines to a particular pool. In the column marked “POOL/NOTE,” you’ll see that your machines are in the “default” pool when created. If you click on “default” there, you’ll bring up a dropdown of already-created resource pools:


Just choose the one you want for this machine (in our example, ProServ) and you’re done:


Here’s a snippet of the updated machine list, with all machines added to the appropriate resource pool:


Resource pools are mostly for your use, helping you to budget servers within a given category. Servers can be in a pool, for example, without being tagged, so if you’ve got five servers in the “Prescriber controls” resource pool, you can tag them with “Pharmacy,” “Medication reconciliation,” etc., as you use them. It will also be obvious when you’re running low on servers for that pool, and need to either provision more or move some unused ones from another pool.


Another optional identifier for machines is the “Note” field. While it can be relatively long, a portion of it shows up on the machine list, which makes it useful for adding special identifiers or groupings. In this example, we’ve added a vague identifier which might help an IT admin remember where servers are connected or who can access them.


Try it!

You can edit notes by clicking on a machine name in the machine list, switching to the “Configuration” tab, and selecting the “Edit” button. These choices will bring you to a screen like this one:


From here, you can add freeform text into the “Note” field:


When you save the changes and return to the machine list, you’ll notice that the NOTE field for that machine has been updated with your changes:



Looking over your design, you notice that some of these resource pools must have their network traffic “firewalled” from others – for example, Provider services and Nursing services shouldn’t be readily visible to Staff compensation or Food service. Likewise, the relevant monitoring agencies require that medications be managed separately from other activities. The traditional way to separate these networks (other than creating entirely separate networks) would be a VLAN. Luckily, MAAS supports multiple VLANS. Adding one higher level to your design, you find yourself with this updated network topology:

Caregiver services
Provider services Nursing services
Medication management
Nursing meds Prescriber controls
Accounts payable
Staff compensation Supplies & services
Accounts receivable
Business office Collections
Patient support
Housekeeping Food service
Staff support
Instrumentation Information technology

Clearly, each of these higher-level groupings is ideal for a VLAN, so you create six of them, one for each division:


Try it!

Adding a functional VLAN requires some additional (common) networking aspects, which we’ll cover later. In the meantime, though, here’s the short version of adding and naming the VLAN itself.

From anywhere on the MAAS page, select “Subnets” from the top menubar, which brings you to this screen:


Using the “Add” dropdown, select “VLAN:”


You’ll arrive at this screen, which allows you to specify the VLAN:


Enter the Name and ID of the VLAN, and select the fabric to enclose it (in this case, the “default” fabric):


When you’re satisfied with your choices, select “Add VLAN” to complete the operation.

Ignoring the networking aspects (for now), these VLANs should help isolate major functions and provide a level of data integrity and access control for your new hospital network.


Considering your network design so far, you notice that some of the VLANs need to be able to communicate with each other some of the time. In fact, you decide on three pairs of VLANs to cover this new networking situation:

Patient management
Caregiver services Medication management
Accounts payable Accounts receivable
Patient support Staff support

You want to incorporate these highest-level groupings into your network, but how? MAAS provides the answer with fabrics. A fabric is a set of interconnected VLANs that can communicate, so you simply create three fabrics, each covering one of these top-level categories.

Try it!

You can add a fabric by selecting the “Subnets” tab, clicking on the “Add” dropdown, and choosing “Fabric:”


You’ll see the “Add fabric” dialog appear. Enter the desired fabric name and click “Add fabric:”


Here you’ll notice three new fabrics, one for each of the top-level groupings in your example network design:


Next, you’ll want to assign your VLANs to this fabric. Begin by clicking on any VLAN you want to move, which will bring you to a summary screen for that VLAN:


You can click “Edit” and choose the desired fabric from the dropdown list:


Finally, click “Save summary” to move this VLAN to the desired fabric. The end result of assigning our example VLANs to the three fabrics is shown below.


Last updated 15 days ago.