dhcpsnippet

delete

Delete a DHCP snippet with the given id.

maas $PROFILE dhcpsnippet delete [--help] [-d] [-k] id

Positional arguments

Argument

Effect

id

The ID of the resource (e.g., 1, 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

Read a DHCP snippet with the given id.

maas $PROFILE dhcpsnippet read [--help] [-d] [-k] id

Positional arguments

Argument

Effect

id

The ID of the resource (e.g., 1, 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.

revert

Revert the value of a DHCP snippet with the given id to an earlier revision.

maas $PROFILE dhcpsnippet revert [--help] [-d] [-k] id [data ...]

Positional arguments

Argument

Effect

id

The ID of the resource (e.g., 1, 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.

Keywords

Keyword “to”

Optional Int. What revision in the DHCP snippet’s history to revert to. This can either be an ID or a negative number representing how far back to go.

Note: This command accepts JSON.

update

Update a DHCP snippet with the given id.

maas $PROFILE dhcpsnippet update [--help] [-d] [-k] id [data ...]

Positional arguments

Argument

Effect

id

The ID of the resource (e.g., 1, 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.

Keywords

Keyword “name”

Optional String. The name of the DHCP snippet.

Keyword “value”

Optional String. The new value of the DHCP snippet to be used in dhcpd.conf. Previous values are stored and can be reverted.

Keyword “description”

Optional String. A description of what the DHCP snippet does.

Keyword “enabled”

Optional Boolean. Whether or not the DHCP snippet is currently enabled.

Keyword “node”

Optional String. The node the DHCP snippet is to be used for. Can not be set if subnet is set.

Keyword “subnet”

Optional String. The subnet the DHCP snippet is to be used for. Can not be set if node is set.

Keyword “global_snippet”

Optional Boolean. Set the DHCP snippet to be a global option. This removes any node or subnet links.

Note: This command accepts JSON.

dhcpsnippets create

Creates a DHCP snippet.

maas $PROFILE dhcpsnippets 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 name of the DHCP snippet.

Keyword “value”

Optional String. The snippet of config inserted into dhcpd.conf.

Keyword “description”

Optional String. A description of what the snippet does.

Keyword “enabled”

Optional Boolean. Whether or not the snippet is currently enabled.

Keyword “node”

Optional String. The node this snippet applies to. Cannot be used with subnet or global_snippet.

Keyword “subnet”

Optional String. The subnet this snippet applies to. Cannot be used with node or global_snippet.

Keyword “iprange”

Optional String. The iprange within a subnet this snippet applies to. Must also provide a subnet value.

Keyword “global_snippet”

Optional Boolean. Whether or not this snippet is to be applied globally. Cannot be used with node or subnet.

Note: This command accepts JSON.

dhcpsnippets read

List all available DHCP snippets.

maas $PROFILE dhcpsnippets 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.