Class: VLAN

Last published : Oct 01, 2026
A VLAN mux/demux
Related information
XenServer 9 Management API

Fields for class: VLAN

Field Type Qualifier Description
other_config (string -> string) map RW additional configuration
tag int RO/constructor VLAN tag in use
tagged_PIF PIF ref RO/constructor interface on which traffic is tagged
untagged_PIF PIF ref RO/runtime interface on which traffic is untagged
uuid string RO/runtime Unique identifier/object reference

RPCs associated with class: VLAN

RPC name: addtootherconfig

Overview:
Add the given keyvalue pair to the otherconfig field of the given VLAN.
Signature:
void add_to_other_config (session ref session_ref, VLAN ref self, string key, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VLAN ref self reference to the object
string key Key to add
string value Value to add
Minimum Role: pool-operator
Return Type: void

RPC name: create

Overview:
Create a VLAN mux/demuxer
Signature:
VLAN ref create (session ref session_ref, PIF ref tagged_PIF, int tag, network ref network)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PIF ref tagged_PIF PIF which receives the tagged traffic
int tag VLAN tag to use
network ref network Network to receive the untagged traffic
Minimum Role: pool-operator
Return Type: VLAN ref
The reference of the created VLAN object

RPC name: destroy

Overview:
Destroy a VLAN mux/demuxer
Signature:
void destroy (session ref session_ref, VLAN ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VLAN ref self VLAN mux/demuxer to destroy
Minimum Role: pool-operator
Return Type: void

RPC name: getall

Overview:
Return a list of all the VLANs known to the system.
Signature:
VLAN ref set get_all (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: VLAN ref set
references to all objects

RPC name: getallrecords

Overview:
Return a map of VLAN references to VLAN records for all VLANs known to the system.
Signature:
(VLAN ref -> VLAN record) map get_all_records (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: (VLAN ref -> VLAN record) map
records of all objects

RPC name: getbyuuid

Overview:
Get a reference to the VLAN instance with the specified UUID.
Signature:
VLAN ref get_by_uuid (session ref session_ref, string uuid)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
string uuid UUID of object to return
Minimum Role: read-only
Return Type: VLAN ref
reference to the object

RPC name: getotherconfig

Overview:
Get the otherconfig field of the given VLAN.
Signature:
(string -> string) map get_other_config (session ref session_ref, VLAN ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VLAN ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: getrecord

Overview:
Get a record containing the current state of the given VLAN.
Signature:
VLAN record get_record (session ref session_ref, VLAN ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VLAN ref self reference to the object
Minimum Role: read-only
Return Type: VLAN record
all fields from the object

RPC name: gettag

Overview:
Get the tag field of the given VLAN.
Signature:
int get_tag (session ref session_ref, VLAN ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VLAN ref self reference to the object
Minimum Role: read-only
Return Type: int
value of the field

RPC name: gettaggedPIF

Overview:
Get the taggedPIF field of the given VLAN.
Signature:
PIF ref get_tagged_PIF (session ref session_ref, VLAN ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VLAN ref self reference to the object
Minimum Role: read-only
Return Type: PIF ref
value of the field

RPC name: getuntaggedPIF

Overview:
Get the untaggedPIF field of the given VLAN.
Signature:
PIF ref get_untagged_PIF (session ref session_ref, VLAN ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VLAN ref self reference to the object
Minimum Role: read-only
Return Type: PIF ref
value of the field

RPC name: getuuid

Overview:
Get the uuid field of the given VLAN.
Signature:
string get_uuid (session ref session_ref, VLAN ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VLAN ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: removefromotherconfig

Overview:
Remove the given key and its corresponding value from the otherconfig field of the given VLAN. If the key is not in that Map, then do nothing.
Signature:
void remove_from_other_config (session ref session_ref, VLAN ref self, string key)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VLAN ref self reference to the object
string key Key to remove
Minimum Role: pool-operator
Return Type: void

RPC name: setotherconfig

Overview:
Set the otherconfig field of the given VLAN.
Signature:
void set_other_config (session ref session_ref, VLAN ref self, (string -> string) map value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VLAN ref self reference to the object
(string -> string) map value New value to set
Minimum Role: pool-operator
Return Type: void