node¶

delete¶

Deletes a node with a given system_id.

maas $PROFILE node delete [--help] [-d] [-k] system_id

Positional arguments¶

Argument	Effect
system_id	The system ID of the machine/device (e.g., `abc123`)

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.

details¶

Returns system details – for example, LLDP and lshw XML dumps. Returns a {detail_type: xml, …} map, where detail_type is something like “lldp” or “lshw”. Note that this is returned as BSON and not JSON. This is for efficiency, but mainly because JSON can’t do binary content without applying additional encoding like base-64. The example output below is represented in ASCII using bsondump example.bson and is for demonstrative purposes.

maas $PROFILE node details [--help] [-d] [-k] system_id

Positional arguments¶

Argument	Effect
system_id	The system ID of the machine/device (e.g., `abc123`)

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.

power-parameters¶

Gets power parameters for a given system_id, if any. For some types of power control this will include private information such as passwords and secret keys. Note that this method is reserved for admin users and returns a 403 if the user is not one.

maas $PROFILE node power-parameters [--help] [-d] [-k] system_id

Positional arguments¶

Argument	Effect
system_id	The system ID of the machine/device (e.g., `abc123`)

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¶

Reads a node with the given system_id.

maas $PROFILE node read [--help] [-d] [-k] system_id

Positional arguments¶

Argument	Effect
system_id	The system ID of the machine/device (e.g., `abc123`)

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 is-registered¶

Returns whether or not the given MAC address is registered within this MAAS (and attached to a non-retired node).

maas $PROFILE nodes is-registered [--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 “mac_address”¶

Optional URL String. The MAC address to be checked.

Note: This command accepts JSON.

nodes read¶

List nodes visible to current user, optionally filtered by criteria. Nodes are sorted by id (i.e. most recent last) and grouped by type.

maas $PROFILE nodes read [--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 “hostname”¶

Optional String. Only nodes relating to the node with the matching hostname will be returned. This can be specified multiple times to see multiple nodes.

Keyword “cpu_count”¶

Optional Int. Only nodes with the specified minimum number of CPUs will be included.

Keyword “mem”¶

Optional String. Only nodes with the specified minimum amount of RAM (in MiB) will be included.

Keyword “mac_address”¶

Optional String. Only nodes relating to the node owning the specified MAC address will be returned. This can be specified multiple times to see multiple nodes.

Keyword “id”¶

Optional String. Only nodes relating to the nodes with matching system ids will be returned.

Keyword “domain”¶

Optional String. Only nodes relating to the nodes in the domain will be returned.

Keyword “zone”¶

Optional String. Only nodes relating to the nodes in the zone will be returned.

Keyword “pool”¶

Optional String. Only nodes belonging to the pool will be returned.

Keyword “agent_name”¶

Optional String. Only nodes relating to the nodes with matching agent names will be returned.

Keyword “fabrics”¶

Optional String. Only nodes with interfaces in specified fabrics will be returned.

Keyword “not_fabrics”¶

Optional String. Only nodes with interfaces not in specified fabrics will be returned.

Keyword “vlans”¶

Optional String. Only nodes with interfaces in specified VLANs will be returned.

Keyword “not_vlans”¶

Optional String. Only nodes with interfaces not in specified VLANs will be returned.

Keyword “subnets”¶

Optional String. Only nodes with interfaces in specified subnets will be returned.

Keyword “not_subnets”¶

Optional String. Only nodes with interfaces not in specified subnets will be returned.

Keyword “link_speed”¶

Optional String. Only nodes with interfaces with link speeds greater than or equal to link_speed will be returned.

Keyword “status”¶

Optional String. Only nodes with specified status will be returned.

Keyword “pod”¶

Optional String. Only nodes that belong to a specified pod will be returned.

Keyword “not_pod”¶

Optional String. Only nodes that don’t belong to a specified pod will be returned.

Keyword “pod_type”¶

Optional String. Only nodes that belong to a pod of the specified type will be returned.

Keyword “not_pod_type”¶

Optional String. Only nodes that don’t belong to a pod of the specified type will be returned.

Keyword “devices”¶

Optional String. Only return nodes which have one or more devices containing the following constraints in the format key=value[,key2=value2[,…]] Each key can be one of the following: - vendor_id: The device vendor id - product_id: The device product id - vendor_name: The device vendor name, not case sensitive - product_name: The device product name, not case sensitive - commissioning_driver: The device uses this driver during commissioning.

Keyword “arch”¶

Optional String. Only nodes with the specified architecture will be returned.

Keyword “not_arch”¶

Optional String. Only nodes without the specified architecture will be returned.

Keyword “cpu_speed”¶

Optional String. Only nodes with CPUs running at the specified speed (in MHz) will be returned.

Keyword “deployment_target”¶

Optional String. Only nodes with the specified deployment target will be returned.

Keyword “not_deployment_target”¶

Optional String. Only nodes without the specified deployment target will be returned.

Keyword “fabric_classes”¶

Optional String. Attached to fabric with specified classes.

Keyword “not_fabric_classes”¶

Optional String. Not attached to fabric with specified classes.

Keyword “interfaces”¶

Optional String. Only nodes with interfaces matching the specified constraints will be returned.

Keyword “not_hostname”¶

Optional String. Hostnames to ignore.

Keyword “not_id”¶

Optional String. System IDs to ignore.

Keyword “not_domain”¶

Optional String. Domain names to ignore.

Keyword “not_agent_name”¶

Optional String. Excludes nodes with events matching the agent name.

Keyword “not_in_pool”¶

Optional String. Only nodes not in the specified resource pools will be returned.

Keyword “not_in_zone”¶

Optional String. Not in zone.

Keyword “not_owner”¶

Optional String. Only nodes not owned by the specified users will be returned.

Keyword “not_power_state”¶

Optional String. Only nodes not in the specified power states will be returned.

Keyword “not_simple_status”¶

Optional String. Exclude nodes with the specified simplified status.

Keyword “not_status”¶

Optional String. Exclude nodes with the specified status.

Keyword “not_tags”¶

Optional String. Not having tags.

Keyword “owner”¶

Optional String. Only nodes owned by the specified users will be returned.

Keyword “power_state”¶

Optional String. Only nodes in the specified power states will be returned.

Keyword “simple_status”¶

Optional String. Only includes nodes with the specified simplified status.

Keyword “storage”¶

Optional String. Only nodes with storage matching the specified constraints will be returned.

Keyword “system_id”¶

Optional String. Only nodes with the specified system IDs will be returned.

Keyword “tags”¶

Optional String. Only nodes with the specified tags will be returned.

Note: This command accepts JSON.

nodes set-zone¶

Assigns a given node to a given zone.

maas $PROFILE nodes set-zone [--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 “zone”¶

Optional String. The zone name.

Keyword “nodes”¶

Optional String. The node to add.

Note: This command accepts JSON.