MAAS Region Controller

Learn about actions >

• create-admin

  Create a MAAS administrator account.

  Params

  • email string

    Specifies the email of the admin user.

  • password string

    A password for this user.

  • ssh-import string

    Import SSH keys from Launchpad (lp:user-id) or Github (gh:user-id).

  • username string

    Username for the new account.

  Required

  username, password, email

• create-backup

  Create a backup of MAAS data not stored in the database.

• get-api-endpoint

  Get MAAS API URL

• get-api-key

  Get the API key for a user

  Params

  • username string

    Username for the new account.

• get-maas-secret

  Get MAAS secret

• get-maas-status

  Get MAAS status. Run on each unit to get its individual status.

• list-backups

  List available MAAS backups

• pre-upgrade-check

  Check if the workload can be upgraded to the latest version available to the machine for the relevant track of the charm, for example if the charm is deployed with --channel=3.7/stable, this action will check if the workload can be upgraded from the current version to the latest 3.7.x version available.

  Params

  • track

    The charm track to check for a minor or major upgrades. This is used to determine what upgrades would be available if you were to change charm tracks. This checks the MAAS version that is available on the target snap channel (<track>/stable on all charm tracks), and whether the target track's charm supports the deployed charm's Ubuntu base.

• restore-backup

  Restore from a MAAS backup

  Params

  • backup-id string

    The id of the backup to restore from. See list-backup for a list of backup ids

  • controller-id string

    The controller id to assign to this region. See list-backup for a list of controller ids

  • force boolean

    Skip pre-restore checks, such as backup version compatibility.

  Required

  backup-id, controller-id

• start-maas

  Start the MAAS snap on a unit (wraps snap start maas). Only useful in the case that a unit's snap has been stopped.

• stop-maas

  Stop the MAAS snap on a unit (wraps snap stop maas). Note that stopping MAAS may cause other actions to fail unexpectedly. This will result in downtime. Useful prior to minor/major upgrades to prevent different MAAS versions running simultaneously.

• upgrade

  Upgrade MAAS workload to the latest version available to the machine for the relevant track of the charm, for example if the charm is deployed with --channel=3.7/stable, this action will upgrade from the current version to the latest 3.7.x version available.

  Params

  • force boolean

    Skip pre-upgrade checks, including the check that MAAS is stopped on all units when moving a multi-region deployment between channels.