tag

delete

Deletes a tag by name.

maas $PROFILE tag delete [--help] [-d] [-k] name

Positional arguments

Argument	Effect
name	The name of the resource (e.g., my-machine, my-zone)

Command-line options

Option	Effect
–help, -h	Show this help message and exit.
-d, –debug	Display more information about API responses.
-k, –insecure	Disable SSL certificate check.

devices

Get a JSON list containing device objects that match the given tag name.

maas $PROFILE tag devices [--help] [-d] [-k] name

Positional arguments

Argument	Effect
name	The name of the resource (e.g., my-machine, my-zone)

Command-line options

Option	Effect
–help, -h	Show this help message and exit.
-d, –debug	Display more information about API responses.
-k, –insecure	Disable SSL certificate check.

machines

Get a JSON list containing machine objects that match the given tag name.

maas $PROFILE tag machines [--help] [-d] [-k] name

Positional arguments

Argument	Effect
name	The name of the resource (e.g., my-machine, my-zone)

Command-line options

Option	Effect
–help, -h	Show this help message and exit.
-d, –debug	Display more information about API responses.
-k, –insecure	Disable SSL certificate check.

nodes

Get a JSON list containing node objects that match the given tag name.

maas $PROFILE tag nodes [--help] [-d] [-k] name

Positional arguments

Argument	Effect
name	The name of the resource (e.g., my-machine, my-zone)

Command-line options

Option	Effect
–help, -h	Show this help message and exit.
-d, –debug	Display more information about API responses.
-k, –insecure	Disable SSL certificate check.

rack-controllers

Get a JSON list containing rack-controller objects that match the given tag name.

maas $PROFILE tag rack-controllers [--help] [-d] [-k] name

Positional arguments

Argument	Effect
name	The name of the resource (e.g., my-machine, my-zone)

Command-line options

Option	Effect
–help, -h	Show this help message and exit.
-d, –debug	Display more information about API responses.
-k, –insecure	Disable SSL certificate check.

read

Returns a JSON object containing information about a specific tag.

maas $PROFILE tag read [--help] [-d] [-k] name

Positional arguments

Argument	Effect
name	The name of the resource (e.g., my-machine, my-zone)

Command-line options

Option	Effect
–help, -h	Show this help message and exit.
-d, –debug	Display more information about API responses.
-k, –insecure	Disable SSL certificate check.

rebuild

Tells MAAS to rebuild the tag-to-node mappings. This is a maintenance operation and should not be necessary under normal circumstances. Adding nodes or updating a tag definition should automatically trigger the mapping rebuild.

maas $PROFILE tag rebuild [--help] [-d] [-k] name

Positional arguments

Argument	Effect
name	The name of the resource (e.g., my-machine, my-zone)

Command-line options

Option	Effect
–help, -h	Show this help message and exit.
-d, –debug	Display more information about API responses.
-k, –insecure	Disable SSL certificate check.

region-controllers

Get a JSON list containing region-controller objects that match the given tag name.

maas $PROFILE tag region-controllers [--help] [-d] [-k] name

Positional arguments

Argument	Effect
name	The name of the resource (e.g., my-machine, my-zone)

Command-line options

Option	Effect
–help, -h	Show this help message and exit.
-d, –debug	Display more information about API responses.
-k, –insecure	Disable SSL certificate check.

update

Update elements of a given tag.

maas $PROFILE tag update [--help] [-d] [-k] name [data ...]

Positional arguments

Argument	Effect
name	The name of the resource (e.g., my-machine, my-zone)

Command-line options

Option	Effect
–help, -h	Show this help message and exit.
-d, –debug	Display more information about API responses.
-k, –insecure	Disable SSL certificate check.

Keywords

Keyword “name”

Optional String. The new tag name. Because the name will be used in urls, it should be short.

Keyword “comment”

Optional String. A description of what the tag will be used for in natural language.

Keyword “definition”

Optional String. An XPATH query that is evaluated against the hardware_details stored for all nodes (i.e. the output of lshw -xml).

Note: This command accepts JSON.

update-nodes

Add or remove nodes associated with the given tag. Note that you must supply either the add or remove parameter.

maas $PROFILE tag update-nodes [--help] [-d] [-k] name [data ...]

Positional arguments

Argument	Effect
name	The name of the resource (e.g., my-machine, my-zone)

Command-line options

Option	Effect
–help, -h	Show this help message and exit.
-d, –debug	Display more information about API responses.
-k, –insecure	Disable SSL certificate check.

Keywords

Keyword “add”

Optional String. The system_id to tag.

Keyword “remove”

Optional String. The system_id to untag.

Keyword “definition”

Optional String. If given, the definition (XPATH expression) will be validated against the current definition of the tag. If the value does not match, MAAS assumes the worker is out of date and will drop the update.

Keyword “rack_controller”

Optional String. The system ID of the rack controller that processed the given tag initially. If not given, the requester must be a MAAS admin. If given, the requester must be the rack controller.

Note: This command accepts JSON.

tags create

Create a new tag.

maas $PROFILE tags create [--help] [-d] [-k] [data ...]

Command-line options

Option	Effect
–help, -h	Show this help message and exit.
-d, –debug	Display more information about API responses.
-k, –insecure	Disable SSL certificate check.

Keywords

Keyword “name”

Optional String. The new tag name. Because the name will be used in urls, it should be short.

Keyword “comment”

Optional String. A description of what the tag will be used for in natural language.

Keyword “definition”

Optional String. An XPATH query that is evaluated against the hardware_details stored for all nodes (i.e. the output of lshw -xml).

Keyword “kernel_opts”

Optional String. Nodes associated with this tag will add this string to their kernel options when booting. The value overrides the global kernel_opts setting. If more than one tag is associated with a node, command line will be concatenated from all associated tags, in alphabetic tag name order.

Note: This command accepts JSON.

tags read

Outputs a JSON object containing an array of all currently defined tag objects.

maas $PROFILE tags read [--help] [-d] [-k]

Command-line options

Option	Effect
–help, -h	Show this help message and exit.
-d, –debug	Display more information about API responses.
-k, –insecure	Disable SSL certificate check.