method": "POST", "name": "mount"}, {"doc": "Format a partition.\n\n:param fstype: Type of filesystem.\n:param uuid: The UUID for the filesystem.\n:param label: The label for the filesystem.\n\nReturns 403 when the user doesn't have the ability to format the             partition.\nReturns 404 if the node, block device, or partition is not found.", "op": "format", "restful": false, "method": "POST", "name": "format"}, {"doc": "Read partition.\n\nReturns 404 if the node, block device, or partition are not found.", "op": null, "restful": true, "method": "GET", "name": "read"}, {"doc": "Unmount the filesystem on partition.\n\nReturns 400 if the partition is not formatted or not currently             mounted.\nReturns 403 when the user doesn't have the ability to unmount the             partition.\nReturns 404 if the node, block device, or partition is not found.", "op": "unmount", "restful": false, "method": "POST", "name": "unmount"}, {"doc": "Unformat a partition.", "op": "unformat", "restful": false, "method": "POST", "name": "unformat"}], "params": ["system_id", "device_id", "partition_id"], "path": "/MAAS/api/1.0/nodes/{system_id}/blockdevices/{device_id}/partition/{partition_id}"}, {"name": "CommissioningScriptsHandler", "doc": "Manage custom commissioning scripts.\n\nThis functionality is only available to administrators.", "uri": "http://10.0.2.15:5240/MAAS/api/1.0/commissioning-scripts/", "actions": [{"doc": "Create a new commissioning script.\n\nEach commissioning script is identified by a unique name.\n\nBy convention the name should consist of a two-digit number, a dash,\nand a brief descriptive identifier consisting only of ASCII\ncharacters.  You don't need to follow this convention, but not doing\nso opens you up to risks w.r.t. encoding and ordering.  The name must\nnot contain any whitespace, quotes, or apostrophes.\n\nA commissioning node will run each of the scripts in lexicographical\norder.  There are no promises about how non-ASCII characters are\nsorted, or even how upper-case letters are sorted relative to\nlower-case letters.  So where ordering matters, use unique numbers.\n\nScripts built into MAAS will have names starting with \"00-maas\" or\n\"99-maas\" to ensure that they run first or last, respectively.\n\nUsually a commissioning script will be just that, a script.  Ideally a\nscript should be ASCII text to avoid any confusion over encoding.  But\nin some cases a commissioning script might consist of a binary tool\nprovided by a hardware vendor.  Either way, the script gets passed to\nthe commissioning node in the exact form in which it was uploaded.\n\n:param name: Unique identifying name for the script.  Names should\n    follow the pattern of \"25-burn-in-hard-disk\" (all ASCII, and with\n    numbers greater than zero, and generally no \"weird\" characters).\n:param content: A script file, to be uploaded in binary form.  Note:\n    this is not a normal parameter, but a file upload.  Its filename\n    is ignored; MAAS will know it by the name you pass to the request.", "op": null, "restful": true, "method": "POST", "name": "create"}, {"doc": "List commissioning scripts.", "op": null, "restful": true, "method": "GET", "name": "read"}], "params": [], "path": "/MAAS/api/1.0/commissioning-scripts/"}, {"name": "VlansHandler", "doc": "Manage VLANs on a fabric.", "uri": "http://10.0.2.15:5240/MAAS/api/1.0/fabrics/{fabric_id}/vlans/", "actions": [{"doc": "Create a VLAN.\n\n:param name: Name of the VLAN.\n:param vid: VLAN ID of the VLAN.", "op": null, "restful": true, "method": "POST", "name": "create"}, {"doc": "List all VLANs belonging to fabric.\n\nReturns 404 if the fabric is not found.", "op": null, "restful": true, "method": "GET", "name": "read"}], "params": ["fabric_id"], "path": "/MAAS/api/1.0/fabrics/{fabric_id}/vlans/"}, {"name": "InterfacesHandler", "doc": "Manage interfaces on a node or device.", "uri": "http://10.0.2.15:5240/MAAS/api/1.0/nodes/{system_id}/interfaces/", "actions": [{"doc": "Create a physical interface on a node or device.\n\n:param name: Name of the interface.\n:param mac_address: MAC address of the interface.\n:param tags: Tags for the interface.\n:param vlan: Untagged VLAN the interface is connected to.\n\nFollowing are extra parameters that can be set on the interface:\n\n:param mtu: Maximum transmission unit.\n:param accept_ra: Accept router advertisements. (IPv6 only)\n:param autoconf: Perform stateless autoconfiguration. (IPv6 only)\n\nReturns 404 if the node is not found.", "op": "create_physical", "restful": false, "method": "POST", "name": "create_physical"}, {"doc": "List all interfaces belonging to a node or device.\n\nReturns 404 if the node is not found.", "op": null, "restful": true, "method": "GET", "name": "read"}, {"doc": "Create a bond interface on node.\n\n:param name: Name of the interface.\n:param mac_address: MAC address of the interface.\n:param tags: Tags for the interface.\n:param vlan: VLAN the interface is connected to.\n:param parents: Parent interfaces that make this bond.\n\nFollowing are parameters specific to bonds:\n\n:param bond_mode: The operating mode of the bond.\n    (Default: active-backup).\n:param bond_miimon: The link monitoring freqeuncy in milliseconds.\n    (Default: 100).\n:param bond_downdelay: Specifies the time, in milliseconds, to wait\n    before disabling a slave after a link failure has been detected.\n:param bond_updelay: Specifies the time, in milliseconds, to wait\n    before enabling a slave after a link recovery has been detected.\n:param bond_lacp_rate: Option specifying the rate in which we'll ask\n    our link partner to transmit LACPDU packets in 802.3ad mode.\n    Available options are fast or slow. (Default: slow).\n:param bond_xmit_hash_policy: The transmit hash policy to use for\n    slave selection in balance-xor, 802.3ad, and tlb modes.\n    (Default: layer2)\n\nSupported bonding modes (bond-mode):\nbalance-rr - Transmit packets in sequential order from the first\navailable slave through the last.  This mode provides load balancing\nand fault tolerance.\n\nactive-backup - Only one slave in the bond is active.  A different\nslave becomes active if, and only if, the active slave fails.  The\nbond's MAC address is externally visible on only one port (network\nadapter) to avoid confusing the switch.\n\nbalance-xor - Transmit based on the selected transmit hash policy.\nThe default policy is a simple [(source MAC address XOR'd with\ndestination MAC address XOR packet type ID) modulo slave count].\n\nbroadcast - Transmits everything on all slave interfaces. This mode\nprovides fault tolerance.\n\n802.3ad - IEEE 802.3ad Dynamic link aggregation.  Creates aggregation\ngroups that share the same speed and duplex settings.  Utilizes all\nslaves in the active aggregator according to the 802.3ad specification.\n\nbalance-tlb - Adaptive transmit load balancing: channel bonding that\ndoes not require any special switch support.\n\nbalance-alb - Adaptive load balancing: includes balance-tlb plus\nreceive load balancing (rlb) for IPV4 traffic, and does not require any\nspecial switch support.  The receive load balancing is achieved by\nARP negotiation.\n\nFollowing are extra parameters that can be set on the interface:\n\n:param mtu: Maximum transmission unit.\n:param accept_ra: Accept router advertisements. (IPv6 only)\n:param autoconf: Perform stateless autoconfiguration. (IPv6 only)\n\nReturns 404 if the node is not found.", "op": "create_bond", "restful": false, "method": "POST", "name": "create_bond"}, {"doc": "Create a VLAN interface on node.\n\n:param tags: Tags for the interface.\n:param vlan: Tagged VLAN the interface is connected to.\n:param parent: Parent interface for this VLAN interface.\n\nFollowing are extra parameters that can be set on the interface:\n\n:param mtu: Maximum transmission unit.\n:param accept_ra: Accept router advertisements. (IPv6 only)\n:param autoconf: Perform stateless autoconfiguration. (IPv6 only)\n\nReturns 404 if the node is not found.", "op": "create_vlan", "restful": false, "method": "POST", "name": "create_vlan"}], "params": ["system_id"], "path": "/MAAS/api/1.0/nodes/{system_id}/interfaces/"}, {"name": "FabricsHandler", "doc": "Manage fabrics.", "uri": "http://10.0.2.15:5240/MAAS/api/1.0/fabrics/", "actions": [{"doc": "Create a fabric.\n\n:param name: Name of the fabric.\n:param class_type: Class type of the fabric.", "op": null, "restful": true, "method": "POST", "name": "create"}, {"doc": "List all fabrics.", "op": null, "restful": true, "method": "GET", "name": "read"}], "params": [], "path": "/MAAS/api/1.0/fabrics/"}, {"name": "NodeResultsHandler", "doc": "Read the collection of NodeResult in the MAAS.", "uri": "http://10.0.2.15:5240/MAAS/api/1.0/installation-results/", "actions": [{"doc": "List NodeResult visible to the user, optionally filtered.\n\n:param system_id: An optional list of system ids.  Only the\n    results related to the nodes with these system ids\n    will be returned.\n:type system_id: iterable\n:param name: An optional list of names.  Only the results\n    with the specified names will be returned.\n:type name: iterable\n:param result_type: An optional result_type.  Only the results\n    with the specified result_type will be returned.\n:type name: iterable", "op": "list", "restful": false, "method": "GET", "name": "list"}], "params": [], "path": "/MAAS/api/1.0/installation-results/"}, {"name": "BootSourceHandler", "doc": "Manage a boot source.", "uri": "http://10.0.2.15:5240/MAAS/api/1.0/boot-sources/{id}/", "actions": [{"doc": "Update a specific boot source.\n\n:param url: The URL of the BootSource.\n:param keyring_filename: The path to the keyring file for this\n    BootSource.\n:param keyring_filename: The GPG keyring for this BootSource,\n    base64-encoded data.", "op": null, "restful": true, "method": "PUT", "name": "update"}, {"doc": "Read a boot source.", "op": null, "restful": true, "method": "GET", "name": "read"}, {"doc": "Delete a specific boot source.", "op": null, "restful": true, "method": "DELETE", "name": "delete"}], "params": ["id"], "path": "/MAAS/api/1.0/boot-sources/{id}/"}, {"name": "PartitionsHandler", "doc": "Manage partitions on a block device.", "uri": "http://10.0.2.15:5240/MAAS/api/1.0/nodes/{system_id}/blockdevices/{device_id}/partitions/", "actions": [{"doc": "Create a partition on the block device.\n\n:param size: The size of the partition.\n:param uuid: UUID for the partition. Only used if the partition table\n    type for the block device is GPT.\n:param bootable: If the partition should be marked bootable.\n\nReturns 404 if the node or the block device are not found.", "op": null, "restful": true, "method": "POST", "name": "create"}, {"doc": "List all partitions on the block device.\n\nReturns 404 if the node or the block device are not found.", "op": null, "restful": true, "method": "GET", "name": "read"}], "params": ["system_id", "device_id"], "path": "/MAAS/api/1.0/nodes/{system_id}/blockdevices/{device_id}/partitions/"}, {"name": "MaasHandler", "doc": "Manage the MAAS server.", "uri": "http://10.0.2.15:5240/MAAS/api/1.0/maas/", "actions": [{"doc": "Set a config value.\n\n:param name: The name of the config item to be set.\n:type name: unicode\n:param value: The value of the config item to be set.\n:type value: json object\n\nAvailable configuration items:\n- enable_http_proxy: Enable the use of an APT and HTTP/HTTPS proxy.         Provision nodes to use the built-in HTTP proxy (or user specified proxy) for APT. MAAS also uses the proxy for downloading boot images.\n- upstream_dns: Upstream DNS used to resolve domains not managed by this MAAS (space-separated IP addresses).         Only used when MAAS is running its own DNS server. This value is used as the value of 'forwarders' in the DNS server config.\n- default_storage_layout: Default storage layout.         Storage layout that is applied to a node when it is commissioned.        Available choices are: 'lvm' (LVM layout), 'flat' (Flat layout), 'bcache' (Bcache layout).\n- default_osystem: Default operating system used for deployment.\n- ports_archive: Ports archive.         Archive used by nodes to retrieve packages for non-Intel architectures. E.g. http://ports.ubuntu.com/ubuntu-ports.\n- http_proxy: Proxy for APT and HTTP/HTTPS.         This will be passed onto provisioned nodes to use as a proxy for APT traffic. MAAS also uses the proxy for downloading boot images. If no URL is provided, the built-in MAAS proxy will be used.\n- boot_images_auto_import: Automatically import/refresh the boot images every 60 minutes.\n- enable_third_party_drivers: Enable the installation of proprietary drivers (i.e. HPVSA).\n- kernel_opts: Boot parameters to pass to the kernel by default.\n- main_archive: Main archive.         Archive used by nodes to retrieve packages for Intel architectures. E.g. http://archive.ubuntu.com/ubuntu.\n- maas_name: MAAS name.\n- curtin_verbose: Run the fast-path installer with higher verbosity. This provides more detail in the installation logs..\n- dnssec_validation: Enable DNSSEC validation of upstream zones.         Only used when MAAS is running its own DNS server. This value is used as the value of 'dnssec_validation' in the DNS server config.\n- commissioning_distro_series: Default Ubuntu release used for commissioning.\n- windows_kms_host: Windows KMS activation host.         FQDN or IP address of the host that provides the KMS Windows activation service. (Only needed for Windows deployments using KMS activation.)\n- enable_disk_erasing_on_release: Erase nodes' disks prior to releasing..\n- default_distro_series: Default OS release used for deployment.\n- ntp_server: Address of NTP server for nodes.         NTP server address passed to nodes via a DHCP response. e.g. ntp.ubuntu.com\n- default_min_hwe_kernel: Default Minimum Kernel Version.         The default minimum kernel version used on all new and commissioned nodes.", "op": "set_config", "restful": false, "method": "POST", "name": "set_config"}, {"doc": "Get a config value.\n\n:param name: The name of the config item to be retrieved.\n:type name: unicode\n\nAvailable configuration items:\n- enable_http_proxy: Enable the use of an APT and HTTP/HTTPS proxy.         Provision nodes to use the built-in HTTP proxy (or user specified proxy) for APT. MAAS also uses the proxy for downloading boot images.\n- upstream_dns: Upstream DNS used to resolve domains not managed by this MAAS (space-separated IP addresses).         Only used when MAAS is running its own DNS server. This value is used as the value of 'forwarders' in the DNS server config.\n- default_storage_layout: Default storage layout.         Storage layout that is applied to a node when it is commissioned.        Available choices are: 'lvm' (LVM layout), 'flat' (Flat layout), 'bcache' (Bcache layout).\n- default_osystem: Default operating system used for deployment.\n- ports_archive: Ports archive.         Archive used by nodes to retrieve packages for non-Intel architectures. E.g. http://ports.ubuntu.com/ubuntu-ports.\n- http_proxy: Proxy for APT and HTTP/HTTPS.         This will be passed onto provisioned nodes to use as a proxy for APT traffic. MAAS also uses the proxy for downloading boot images. If no URL is provided, the built-in MAAS proxy will be used.\n- boot_images_auto_import: Automatically import/refresh the boot images every 60 minutes.\n- enable_third_party_drivers: Enable the installation of proprietary drivers (i.e. HPVSA).\n- kernel_opts: Boot parameters to pass to the kernel by default.\n- main_archive: Main archive.         Archive used by nodes to retrieve packages for Intel architectures. E.g. http://archive.ubuntu.com/ubuntu.\n- maas_name: MAAS name.\n- curtin_verbose: Run the fast-path installer with higher verbosity. This provides more detail in the installation logs..\n- dnssec_validation: Enable DNSSEC validation of upstream zones.         Only used when MAAS is running its own DNS server. This value is used as the value of 'dnssec_validation' in the DNS server config.\n- commissioning_distro_series: Default Ubuntu release used for commissioning.\n- windows_kms_host: Windows KMS activation host.         FQDN or IP address of the host that provides the KMS Windows activation service. (Only needed for Windows deployments using KMS activation.)\n- enable_disk_erasing_on_release: Erase nodes' disks prior to releasing..\n- default_distro_series: Default OS release used for deployment.\n- ntp_server: Address of NTP server for nodes.         NTP server address passed to nodes via a DHCP response. e.g. ntp.ubuntu.com\n- default_min_hwe_kernel: Default Minimum Kernel Version.         The default minimum kernel version used on all new and commissioned nodes.", "op": "get_config", "restful": false, "method": "GET", "name": "get_config"}], "params": [], "path": "/MAAS/api/1.0/maas/"}, {"name": "NodeGroupsHandler", "doc": "Manage the collection of all the nodegroups in this MAAS.", "uri": "http://10.0.2.15:5240/MAAS/api/1.0/nodegroups/", "actions": [{"doc": "List nodegroups.", "op": "list", "restful": false, "method": "GET", "name": "list"}, {"doc": "Reject nodegroup enlistment(s).\n\n:param uuid: The UUID (or list of UUIDs) of the nodegroup(s) to reject.\n:type name: unicode (or list of unicodes)\n\nThis method is reserved to admin users and returns 403 if the\nuser is not an admin.\n\nReturns 404 if the nodegroup (cluster) is not found.", "op": "reject", "restful": false, "method": "POST", "name": "reject"}, {"doc": "Import the boot images on all the accepted cluster controllers.", "op": "import_boot_images", "restful": false, "method": "POST", "name": "import_boot_images"}, {"doc": "Accept nodegroup enlistment(s).\n\n:param uuid: The UUID (or list of UUIDs) of the nodegroup(s) to accept.\n:type name: unicode (or list of unicodes)\n\nThis method is reserved to admin users and returns 403 if the\nuser is not an admin.\n\nReturns 404 if the nodegroup (cluster) is not found.", "op": "accept", "restful": false, "method": "POST", "name": "accept"}, {"doc": "Query all the cluster controllers for power information.\n\n:return: a list of dicts that describe the power types in this format.", "op": "describe_power_types", "restful": false, "method": "GET", "name": "describe_power_types"}], "params": [], "path": "/MAAS/api/1.0/nodegroups/"}, {"name": "NodeInterfaceHandler", "doc": "Manage a node's interface. (Deprecated)", "uri": "http://10.0.2.15:5240/MAAS/api/1.0/nodes/{system_id}/interfaces/{interface_id}/", "actions": [{"doc": "Update interface on node.\n\nFields for physical interface:\n:param name: Name of the interface.\n:param mac_address: MAC address of the interface.\n:param tags: Tags for the interface.\n:param vlan: Untagged VLAN the interface is connected to.\n\nFields for bond interface:\n:param name: Name of the interface.\n:param mac_address: MAC address of the interface.\n:param tags: Tags for the interface.\n:param vlan: Tagged VLAN the interface is connected to.\n:param parents: Parent interfaces that make this bond.\n\nFields for VLAN interface:\n:param tags: Tags for the interface.\n:param vlan: VLAN the interface is connected to.\n:param parent: Parent interface for this VLAN interface.\n\nFollowing are extra parameters that can be set on all interface types:\n\n:param mtu: Maximum transmission unit.\n:param accept_ra: Accept router advertisements. (IPv6 only)\n:param autoconf: Perform stateless autoconfiguration. (IPv6 only)\n\nFollowing are parameters specific to bonds:\n\n:param bond-mode: The operating mode of the bond.\n    (Default: active-backup).\n:param bond-miimon: The link monitoring freqeuncy in milliseconds.\n    (Default: 100).\n:param bond-downdelay: Specifies the time, in milliseconds, to wait\n    before disabling a slave after a link failure has been detected.\n:param bond-updelay: Specifies the time, in milliseconds, to wait\n    before enabling a slave after a link recovery has been detected.\n:param bond-lacp_rate: Option specifying the rate in which we'll ask\n    our link partner to transmit LACPDU packets in 802.3ad mode.\n    Available options are fast or slow. (Default: slow).\n:param bond-xmit_hash_policy: The transmit hash policy to use for\n    slave selection in balance-xor, 802.3ad, and tlb modes.\n\nSupported bonding modes (bond-mode):\nbalance-rr - Transmit packets in sequential order from the first\navailable slave through the last.  This mode provides load balancing\nand fault tolerance.\n\nactive-backup - Only one slave in the bond is active.  A different\nslave becomes active if, and only if, the active slave fails.  The\nbond's MAC address is externally visible on only one port (network\nadapter) to avoid confusing the switch.\n\nbalance-xor - Transmit based on the selected transmit hash policy.\nThe default policy is a simple [(source MAC address XOR'd with\ndestination MAC address XOR packet type ID) modulo slave count].\n\nbroadcast - Transmits everything on all slave interfaces. This mode\nprovides fault tolerance.\n\n802.3ad - IEEE 802.3ad Dynamic link aggregation.  Creates aggregation\ngroups that share the same speed and duplex settings.  Utilizes all\nslaves in the active aggregator according to the 802.3ad specification.\n\nbalance-tlb - Adaptive transmit load balancing: channel bonding that\ndoes not require any special switch support.\n\nbalance-alb - Adaptive load balancing: includes balance-tlb plus\nreceive load balancing (rlb) for IPV4 traffic, and does not require any\nspecial switch support.  The receive load balancing is achieved by\nARP negotiation.\n\nReturns 404 if the node or interface is not found.", "op": null, "restful": true, "method": "PUT", "name": "update"}, {"doc": "Read interface on node.\n\nReturns 404 if the node or interface is not found.", "op": null, "restful": true, "method": "GET", "name": "read"}, {"doc": "Delete interface on node.\n\nReturns 404 if the node or interface is not found.", "op": null, "restful": true, "method": "DELETE", "name": "delete"}], "params": ["system_id", "interface_id"], "path": "/MAAS/api/1.0/nodes/{system_id}/interfaces/{interface_id}/"}, {"name": "BootResourcesHandler", "doc": "Manage the boot resources.", "uri": "http://10.0.2.15:5240/MAAS/api/1.0/boot-resources/", "actions": [{"doc": "Uploads a new boot resource.\n\n:param name: Name of the boot resource.\n:param title: Title for the boot resource.\n:param architecture: Architecture the boot resource supports.\n:param filetype: Filetype for uploaded content. (Default: tgz)\n:param content: Image content. Note: this is not a normal parameter,\n    but a file upload.", "op": null, "restful": true, "method": "POST", "name": "create"}, {"doc": "List all boot resources.\n\n:param type: Type of boot resources to list. Default: all", "op": null, "restful": true, "method": "GET", "name": "read"}, {"doc": "Import the boot resources.", "op": "import", "restful": false, "method": "POST", "name": "import"}], "params": [], "path": "/MAAS/api/1.0/boot-resources/"}, {"name": "FanNetworkHandler", "doc": "Manage Fan Network.", "uri": "http://10.0.2.15:5240/MAAS/api/1.0/fannetworks/{fannetwork_id}/", "actions": [{"doc": "Update fannetwork.\n\n:param name: Name of the fannetwork.\n:param overlay: Overlay network\n:param underlay: Underlay network\n:param dhcp: confiugre dhcp server for overlay net\n:param host_reserve: number of IP addresses to reserve for host\n:param bridge: override bridge name\n:param off: put this int he config, but disable it.\n\nReturns 404 if the fannetwork is not found.", "op": null, "restful": true, "method": "PUT", "name": "update"}, {"doc": "Read fannetwork.\n\nReturns 404 if the fannetwork is not found.", "op": null, "restful": true, "method": "GET", "name": "read"}, {"doc": "Delete fannetwork.\n\nReturns 404 if the fannetwork is not found.", "op": null, "restful": true, "method": "DELETE", "name": "delete"}], "params": ["fannetwork_id"], "path": "/MAAS/api/1.0/fannetworks/{fannetwork_id}/"}, {"name": "TagHandler", "doc": "Manage a Tag.\n\nTags are properties that can be associated with a Node and serve as\ncriteria for selecting and allocating nodes.\n\nA Tag is identified by its name.", "uri": "http://10.0.2.15:5240/MAAS/api/1.0/tags/{name}/", "actions": [{"doc": "Delete a specific Tag.\n\nReturns 404 if the tag is not found.\nReturns 204 if the tag is successfully deleted.", "op": null, "restful": true, "method": "DELETE", "name": "delete"}, {"doc": "Update a specific Tag.\n\n:param name: The name of the Tag to be created. This should be a short\n    name, and will be used in the URL of the tag.\n:param comment: A long form description of what the tag is meant for.\n    It is meant as a human readable description of the tag.\n:param definition: An XPATH query that will be evaluated against the\n    hardware_details stored for all nodes (output of `lshw -xml`).\n\nReturns 404 if the tag is not found.", "op": null, "restful": true, "method": "PUT", "name": "update"}, {"doc": "Get the list of nodes that have this tag.\n\nReturns 404 if the tag is not found.", "op": "nodes", "restful": false, "method": "GET", "name": "nodes"}, {"doc": "Manually trigger a rebuild the tag <=> node mapping.\n\nThis is considered a maintenance operation, which should normally not\nbe necessary. Adding nodes or updating a tag's definition should\nautomatically trigger the appropriate changes.\n\nReturns 404 if the tag is not found.", "op": "rebuild", "restful": false, "method": "POST", "name": "rebuild"}, {"doc": "Read a specific Tag.\n\nReturns 404 if the tag is not found.", "op": null, "restful": true, "method": "GET", "name": "read"}, {"doc": "Add or remove nodes being associated with this tag.\n\n:param add: system_ids of nodes to add to this tag.\n:param remove: system_ids of nodes to remove from this tag.\n:param definition: (optional) If supplied, the definition will be\n    validated against the current definition of the tag. If the value\n    does not match, then the update will be dropped (assuming this was\n    just a case of a worker being out-of-date)\n:param nodegroup: A uuid of a nodegroup being processed. This value is\n    optional. If not supplied, the requester must be a superuser. If\n    supplied, then the requester must be the worker associated with\n    that nodegroup, and only nodes that are part of that nodegroup can\n    be updated.\n\nReturns 404 if the tag is not found.\nReturns 401 if the user does not have permission to update the nodes.\nReturns 409 if 'definition' doesn't match the current definition.", "op": "update_nodes", "restful": false, "method": "POST", "name": "update_nodes"}], "params": ["name"], "path": "/MAAS/api/1.0/tags/{name}/"}, {"name": "BootResourceHandler", "doc": "Manage a boot resource.", "uri": "http://10.0.2.15:5240/MAAS/api/1.0/boot-resources/{id}/", "actions": [{"doc": "Read a boot resource.", "op": null, "restful": true, "method": "GET", "name": "read"}, {"doc": "Delete boot resource.", "op": null, "restful": true, "method": "DELETE", "name": "delete"}], "params": ["id"], "path": "/MAAS/api/1.0/boot-resources/{id}/"}, {"name": "VolumeGroupHandler", "doc": "Manage volume group on a node.", "uri": "http://10.0.2.15:5240/MAAS/api/1.0/nodes/{system_id}/volume-group/{volume_group_id}/", "actions": [{"doc": "Read volume group on node.\n\n:param name: Name of the volume group.\n:param uuid: UUID of the volume group.\n:param add_block_devices: Block devices to add to the volume group.\n:param remove_block_devices: Block devices to remove from the\n    volume group.\n:param add_partitions: Partitions to add to the volume group.\n:param remove_partitions: Partitions to remove from the volume group.\n\nReturns 404 if the node or volume group is not found.\nReturns 409 if the node is not Ready.", "op": null, "restful": true, "method": "PUT", "name": "update"}, {"doc": "Delete a logical volume in the volume group.\n\n:param id: ID of the logical volume.\n\nReturns 403 if no logical volume with id.\nReturns 404 if the node or volume group is not found.\nReturns 409 if the node is not Ready.", "op": "delete_logical_volume", "restful": false, "method": "POST", "name": "delete_logical_volume"}, {"doc": "Read volume group on node.\n\nReturns 404 if the node or volume group is not found.", "op": null, "restful": true, "method": "GET", "name": "read"}, {"doc": "Delete volume group on node.\n\nReturns 404 if the node or volume group is not found.\nReturns 409 if the node is not Ready.", "op": null, "restful": true, "method": "DELETE", "name": "delete"}, {"doc": "Create a logical volume in the volume group.\n\n:param name: Name of the logical volume.\n:param uuid: (optional) UUID of the logical volume.\n:param size: Size of the logical volume.\n\nReturns 404 if the node or volume group is not found.\nReturns 409 if the node is not Ready.", "op": "create_logical_volume", "restful": false, "method": "POST", "name": "create_logical_volume"}], "params": ["system_id", "volume_group_id"], "path": "/MAAS/api/1.0/nodes/{system_id}/volume-group/{volume_group_id}/"}, {"name": "NodeInterfacesHandler", "doc": "Manage interfaces on a node. (Deprecated)", "uri": "http://10.0.2.15:5240/MAAS/api/1.0/nodes/{system_id}/interfaces/", "actions": [{"doc": "List all interfaces belonging to a node or device.\n\nReturns 404 if the node is not found.", "op": null, "restful": true, "method": "GET", "name": "read"}], "params": ["system_id"], "path": "/MAAS/api/1.0/nodes/{system_id}/interfaces/"}, {"name": "NodeGroupInterfacesHandler", "doc": "Manage the collection of all the NodeGroupInterfaces in this MAAS.\n\nA NodeGroupInterface is a network interface attached to a cluster\ncontroller, with its network properties.", "uri": "http://10.0.2.15:5240/MAAS/api/1.0/nodegroups/{uuid}/interfaces/", "actions": [{"doc": "List of NodeGroupInterfaces of a NodeGroup.", "op": "list", "restful": false, "method": "GET", "name": "list"}, {"doc": "Create a new NodeGroupInterface for this NodeGroup.\n\n:param name: Name for the interface.  Must be unique within this\n    cluster.  Only letters, digits, dashes, and colons are allowed.\n:param ip: Static IP of the interface.\n:type ip: unicode (IP Address)\n:param interface: Name of the network interface that connects the\n    cluster controller to this network.\n:type interface: unicode\n:param management: The service(s) MAAS should manage on this interface.\n:type management: Vocabulary `NODEGROUPINTERFACE_MANAGEMENT`\n:param subnet_mask: Subnet mask, e.g. 255.0.0.0.\n:type subnet_mask: unicode (IP Address)\n:param broadcast_ip: Broadcast address for this subnet.\n:type broadcast_ip: unicode (IP Address)\n:param router_ip: Address of default gateway.\n:type router_ip: unicode (IP Address)\n:param ip_range_low: Lowest dynamic IP address to assign to clients.\n:type ip_range_low: unicode (IP Address)\n:param ip_range_high: Highest dynamic IP address to assign to clients.\n:type ip_range_high: unicode (IP Address)\n:param static_ip_range_low: Lowest static IP address to assign to\n    clients.\n:type static_ip_range_low: unicode (IP Address)\n:param static_ip_range_high: Highest static IP address to assign to\n    clients.\n:type static_ip_range_high: unicode (IP Address)\n\nReturns 404 if the node group (cluster) is not found.\nReturns 403 if the user does not have permission to access the\ninterface.", "op": "new", "restful": false, "method": "POST", "name": "new"}], "params": ["uuid"], "path": "/MAAS/api/1.0/nodegroups/{uuid}/interfaces/"}, {"name": "BootSourceSelectionHandler", "doc": "Manage a boot source selection.", "uri": "http://10.0.2.15:5240/MAAS/api/1.0/boot-sources/{boot_source_id}/selections/{id}/", "actions": [{"doc": "Update a specific boot source selection.\n\n:param release: The release for which to import resources.\n:param arches: The list of architectures for which to import resources.\n:param subarches: The list of subarchitectures for which to import\n    resources.\n:param labels: The list of labels for which to import resources.", "op": null, "restful": true, "method": "PUT", "name": "update"}, {"doc": "Read a boot source selection.", "op": null, "restful": true, "method": "GET", "name": "read"}, {"doc": "Delete a specific boot source.", "op": null, "restful": true, "method": "DELETE", "name": "delete"}], "params": ["boot_source_id", "id"], "path": "/MAAS/api/1.0/boot-sources/{boot_source_id}/selections/{id}/"}, {"name": "FanNetworksHandler", "doc": "Manage Fan Networks.", "uri": "http://10.0.2.15:5240/MAAS/api/1.0/fannetworks/", "actions": [{"doc": "Create a fannetwork.\n\n:param name: Name of the fannetwork.\n:param overlay: Overlay network\n:param underlay: Underlay network\n:param dhcp: confiugre dhcp server for overlay net\n:param host_reserve: number of IP addresses to reserve for host\n:param bridge: override bridge name\n:param off: put this int he config, but disable it.", "op": null, "restful": true, "method": "POST", "name": "create"}, {"doc": "List all fannetworks.", "op": null, "restful": true, "method": "GET", "name": "read"}], "params": [], "path": "/MAAS/api/1.0/fannetworks/"}, {"name": "VolumeGroupsHandler", "doc": "Manage volume groups on a node.", "uri": "http://10.0.2.15:5240/MAAS/api/1.0/nodes/{system_id}/volume-groups/", "actions": [{"doc": "Create a volume group belonging to node.\n\n:param name: Name of the volume group.\n:param uuid: (optional) UUID of the volume group.\n:param block_devices: Block devices to add to the volume group.\n:param partitions: Partitions to add to the volume group.\n\nReturns 404 if the node is not found.\nReturns 409 if the node is not Ready.", "op": null, "restful": true, "method": "POST", "name": "create"}, {"doc": "List all volume groups belonging to node.\n\nReturns 404 if the node is not found.", "op": null, "restful": true, "method": "GET", "name": "read"}], "params": ["system_id"], "path": "/MAAS/api/1.0/nodes/{system_id}/volume-groups/"}, {"name": "SubnetsHandler", "doc": "Manage subnets.", "uri": "http://10.0.2.15:5240/MAAS/api/1.0/subnets/", "actions": [{"doc": "Create a subnet.\n\n:param name: Name of the subnet.\n:param fabric: Fabric for the subnet. Defaults to the fabric the\n    provided VLAN belongs to or defaults to the default fabric.\n:param vlan: VLAN this subnet belongs to. Defaults to the default\n    VLAN for the provided fabric or defaults to the default VLAN in\n    the default fabric.\n:param vid: VID of the VLAN this subnet belongs to. Only used when\n    vlan is not provided. Picks the VLAN with this VID in the provided\n    fabric or the default fabric if one is not given.\n:param space: Space this subnet is in. Defaults to the default space.\n:param cidr: The network CIDR for this subnet.\n:param gateway_ip: The gateway IP address for this subnet.\n:param dns_servers: Comma-seperated list of DNS servers for this             subnet.", "op": null, "restful": true, "method": "POST", "name": "create"}, {"doc": "List all subnets.", "op": null, "restful": true, "method": "GET", "name": "read"}], "params": [], "path": "/MAAS/api/1.0/subnets/"}, {"name": "FabricHandler", "doc": "Manage fabric.", "uri": "http://10.0.2.15:5240/MAAS/api/1.0/fabrics/{fabric_id}/", "actions": [{"doc": "Update fabric.\n\n:param name: Name of the fabric.\n:param class_type: Class type of the fabric.\n\nReturns 404 if the fabric is not found.", "op": null, "restful": true, "method": "PUT", "name": "update"}, {"doc": "Read fabric.\n\nReturns 404 if the fabric is not found.", "op": null, "restful": true, "method": "GET", "name": "read"}, {"doc": "Delete fabric.\n\nReturns 404 if the fabric is not found.", "op": null, "restful": true, "method": "DELETE", "name": "delete"}], "params": ["fabric_id"], "path": "/MAAS/api/1.0/fabrics/{fabric_id}/"}]}