Skip to main content

Your submission was sent successfully! Close

Thank you for signing up for our newsletter!
In these regular emails you will find the latest updates from Canonical and upcoming events where you can meet our team.Close

Thank you for contacting us. A member of our team will be in touch shortly. Close

An error occurred while submitting your form. Please try again or file a bug report. Close

node

Enter keyword arguments in the form key=value.

Delete a node

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

Positional arguments

  • system_id

Deletes a node with a given system_id.

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

Get system details

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

Positional arguments

  • system_id

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.

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

Get power parameters

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

Positional arguments

  • system_id

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.

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 a node

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

Positional arguments

  • system_id

Reads a node with the given system_id.

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

Last updated 3 months ago. Help improve this document in the forum.