vlan¶

delete¶

Delete VLAN on a given fabric.

maas $PROFILE vlan delete [--help] [-d] [-k] fabric_id vid

Positional arguments¶

Argument	Effect
fabric_id	The fabric_id parameter
vid	The vid parameter

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¶

Retrieves a VLAN on a given fabric_id.

maas $PROFILE vlan read [--help] [-d] [-k] fabric_id vid

Positional arguments¶

Argument	Effect
fabric_id	The fabric_id parameter
vid	The vid parameter

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¶

Updates a given VLAN.

maas $PROFILE vlan update [--help] [-d] [-k] fabric_id vid [data ...]

Positional arguments¶

Argument	Effect
fabric_id	The fabric_id parameter
vid	The vid parameter

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. Name of the VLAN.

Keyword “description”¶

Optional String. Description of the VLAN.

Keyword “mtu”¶

Optional Int. The MTU to use on the VLAN.

Keyword “dhcp_on”¶

Optional Boolean. Whether or not DHCP should be managed on the VLAN.

Keyword “primary_rack”¶

Optional String. The primary rack controller managing the VLAN (system_id).

Keyword “secondary_rack”¶

Optional String. The secondary rack controller managing the VLAN (system_id).

Keyword “relay_vlan”¶

Optional Int. Relay VLAN ID. Only set when this VLAN will be using a DHCP relay to forward DHCP requests to another VLAN that MAAS is managing. MAAS will not run the DHCP relay itself, it must be configured to proxy reqests to the primary and/or secondary rack controller interfaces for the VLAN specified in this field.

Keyword “space”¶

Optional String. The space this VLAN should be placed in. Passing in an empty string (or the string ‘undefined’) will cause the VLAN to be placed in the ‘undefined’ space.

Note: This command accepts JSON.

vlans create¶

Creates a new VLAN.

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

Positional arguments¶

Argument	Effect
fabric_id	The fabric_id parameter

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. Name of the VLAN.

Keyword “description”¶

Optional String. Description of the new VLAN.

Keyword “vid”¶

Optional Int. VLAN ID of the new VLAN.

Keyword “mtu”¶

Optional Int. The MTU to use on the VLAN.

Keyword “space”¶

Optional String. The space this VLAN should be placed in. Passing in an empty string (or the string ‘undefined’) will cause the VLAN to be placed in the ‘undefined’ space.

Note: This command accepts JSON.

vlans read¶

List all VLANs belonging to given fabric.

maas $PROFILE vlans read [--help] [-d] [-k] fabric_id

Positional arguments¶

Argument	Effect
fabric_id	The fabric_id parameter

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.