vlanview : VLAN View object.

Object Reference

References to vlanview are object references.

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

• Name of the VLAN View.
• Start vlan id of the VLAN View.
• End vlan id of the VLAN View.

Example:

vlanview/ZG5zLnZsYW5fdmlldyRWbGFuVmlldy4xLjEwMA:vl_view1/1/100

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.

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

allow_range_overlapping

allow_range_overlapping

When set to true VLAN Ranges under VLAN View can have overlapping ID.

Type

Bool.

Create

The default value is False.

Search

The field is available for search via

• ‘=’ (exact equality)

comment

comment

A descriptive comment for this VLAN View.

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 View.

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 View.

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 View 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 View.

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.

Function Calls

next_available_vlan_id

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

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.

Fields List

Field	Type	Req	R/O	Base	Search
allow_range_overlapping	Bool	N	N	N	=
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