vlanrange : VLAN Range object.

Object Reference

References to vlanrange are object references.

The name part of the vlanrange object reference has the following components:

• Name of the VLAN View to which this VLAN Range belongs.
• Name of the VLAN Range.
• Start vlan id of the VLAN Range.
• End vlan id of the VLAN Range.

Example:

vlanrange/ZG5zLm5ldHdvcmskMTAuMC4wLjAvMjQvMA:vl_view1/vl_range1/1/10

Restrictions

The object does not support the following operations:

• Scheduling
• CSV export

The object cannot be managed on Cloud Platform members.

Fields

These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.

The basic version of the object contains the field(s): end_vlan_id, name, start_vlan_id, vlan_view.

The following fields are required to create this object:

Field	Notes
end_vlan_id
name
pre_create_vlan	This can be specified only on creation
start_vlan_id
vlan_name_prefix	This can be specified only on creation
vlan_view

comment

comment

A descriptive comment for this VLAN Range.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is empty.

Search

The field is available for search via

• ‘:=’ (case insensitive search)
• ‘=’ (exact equality)
• ‘~=’ (regular expression)

end_vlan_id

end_vlan_id

End ID for VLAN Range.

Type

Unsigned integer.

Create

The field is required on creation.

Search

The field is available for search via

• ‘!=’ (negative search)
• ‘=’ (exact equality)
• ‘<=’ (less than search)
• ‘>=’ (greater than search)

Notes

The end_vlan_id is part of the base object.

extattrs

extattrs

Extensible attributes associated with the object.

For valid values for extensible attributes, see the following information.

Type

Extensible attributes.

This field allows +/- to be specified as part of the field name when updating the object, see the following information.

Create

The default value is empty.

Search

For how to search extensible attributes, see the following information.

name

name

Name of the VLAN Range.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

Search

The field is available for search via

• ‘:=’ (case insensitive search)
• ‘=’ (exact equality)
• ‘~=’ (regular expression)

Notes

The name is part of the base object.

pre_create_vlan

pre_create_vlan

If set on creation VLAN objects will be created once VLAN Range created.

Type

Bool.

Create

The field is required and can be specifiedonly on creation.

Search

The field is not available for search.

start_vlan_id

start_vlan_id

Start ID for VLAN Range.

Type

Unsigned integer.

Create

The field is required on creation.

Search

The field is available for search via

• ‘!=’ (negative search)
• ‘=’ (exact equality)
• ‘<=’ (less than search)
• ‘>=’ (greater than search)

Notes

The start_vlan_id is part of the base object.

vlan_name_prefix

vlan_name_prefix

If set on creation prefix string will be used for VLAN name.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required and can be specifiedonly on creation.

Search

The field is not available for search.

vlan_view

vlan_view

The VLAN View to which this VLAN Range belongs.

Type

String.

This field supports nested return fields as described here.

Create

The field is required on creation.

Search

The field is available for search via

• ‘=’ (exact equality)

Notes

The vlan_view is part of the base object.

Function Calls

next_available_vlan_id

This function retrieves the next available VLAN IDs in the VLAN Range.

This function supports multiple object matches when called as part of an atomic insertion operation.

Input fields

exclude ( String array. ) A list of VLAN IDs to exclude.

num ( Unsigned integer. ) The number of VLAN IDs you are requesting.

Output fields

vlan_ids ( String array. ) The requested VLAN IDs addresses.

Delete arguments

These fields are used only as delete arguments. They are not actual members of the object and therefore will never be returned by the server with this name unless they are nested return fields.

delete_vlans

delete_vlans

Vlans delete option. Determines whether all child objects should be removed alongside with the VLAN Range or child objects should be assigned to another parental VLAN Range/View. By default child objects are re-parented.

Type

Bool.

Notes

delete_vlans is a delete argument.

Fields List

Field	Type	Req	R/O	Base	Search
comment	String	N	N	N	: = ~
end_vlan_id	Unsigned int	Y	N	Y	! < = >
extattrs	Extattr	N	N	N	ext
name	String	Y	N	Y	: = ~
pre_create_vlan	Bool	N	N	N	N/A
start_vlan_id	Unsigned int	Y	N	Y	! < = >
vlan_name_prefix	String	N	N	N	N/A
vlan_view	String	Y	N	Y	=

Delete Arguments List

Argument	Type
delete_vlans	Bool