Develop for XenServer

Class: VLAN

June 19, 2024

Contributed by:

X X

A VLAN mux/demux

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: add_to_other_config

Overview:

Add the given key-value pair to the other_config field of the given VLAN.

Signature:

void add_to_other_config (session ref session_ref, VLAN ref self, string key, string value)
<!--NeedCopy-->

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)
<!--NeedCopy-->

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)
<!--NeedCopy-->

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: get_all

Overview:

Return a list of all the VLANs known to the system.

Signature:

VLAN ref set get_all (session ref session_ref)
<!--NeedCopy-->

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: get_all_records

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)
<!--NeedCopy-->

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: get_by_uuid

Overview:

Get a reference to the VLAN instance with the specified UUID.

Signature:

VLAN ref get_by_uuid (session ref session_ref, string uuid)
<!--NeedCopy-->

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: get_other_config

Overview:

Get the other_config field of the given VLAN.

Signature:

(string -> string) map get_other_config (session ref session_ref, VLAN ref self)
<!--NeedCopy-->

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: get_record

Overview:

Get a record containing the current state of the given VLAN.

Signature:

VLAN record get_record (session ref session_ref, VLAN ref self)
<!--NeedCopy-->

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: get_tag

Overview:

Get the tag field of the given VLAN.

Signature:

int get_tag (session ref session_ref, VLAN ref self)
<!--NeedCopy-->

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: get_tagged_PIF

Overview:

Get the tagged_PIF field of the given VLAN.

Signature:

PIF ref get_tagged_PIF (session ref session_ref, VLAN ref self)
<!--NeedCopy-->

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: get_untagged_PIF

Overview:

Get the untagged_PIF field of the given VLAN.

Signature:

PIF ref get_untagged_PIF (session ref session_ref, VLAN ref self)
<!--NeedCopy-->

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: get_uuid

Overview:

Get the uuid field of the given VLAN.

Signature:

string get_uuid (session ref session_ref, VLAN ref self)
<!--NeedCopy-->

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: remove_from_other_config

Overview:

Remove the given key and its corresponding value from the other_config 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)
<!--NeedCopy-->

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: set_other_config

Overview:

Set the other_config field of the given VLAN.

Signature:

void set_other_config (session ref session_ref, VLAN ref self, (string -> string) map value)
<!--NeedCopy-->

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

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Class: VLAN

June 19, 2024

Contributed by:

X X

June 19, 2024

Contributed by:

X X

Class: VLAN

Fields for class: VLAN

RPCs associated with class: VLAN

RPC name: add_to_other_config

RPC name: create

RPC name: destroy

RPC name: get_all

RPC name: get_all_records

RPC name: get_by_uuid

RPC name: get_other_config

RPC name: get_record

RPC name: get_tag

RPC name: get_tagged_PIF

RPC name: get_untagged_PIF

RPC name: get_uuid

RPC name: remove_from_other_config

RPC name: set_other_config

In this article