View Source XenAPI.VLAN (XenAPI v0.3.0)

A VLAN mux/demux

Link to this section Summary

Functions

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

Add the given key-value pair to the other_config field of the given VLAN. (Raise error on XMLRPC failure)

Create a VLAN mux/demuxer (Raise error on XMLRPC failure)

Destroy a VLAN mux/demuxer

Destroy a VLAN mux/demuxer (Raise error on XMLRPC failure)

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

Return a list of all the VLANs known to the system. (Raise error on XMLRPC failure)

Return a map of VLAN references to VLAN records for all VLANs known to the system.

Return a map of VLAN references to VLAN records for all VLANs known to the system. (Raise error on XMLRPC failure)

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

Get a reference to the VLAN instance with the specified UUID. (Raise error on XMLRPC failure)

Get the other_config field of the given VLAN.

Get the other_config field of the given VLAN. (Raise error on XMLRPC failure)

Get a record containing the current state of the given VLAN. Returns XenAPI.VLAN struct.

Get a record containing the current state of the given VLAN. Returns XenAPI.VLAN struct. (Raise error on XMLRPC failure)

Get the tag field of the given VLAN.

Get the tag field of the given VLAN. (Raise error on XMLRPC failure)

Get the tagged_PIF field of the given VLAN.

Get the tagged_PIF field of the given VLAN. (Raise error on XMLRPC failure)

Get the untagged_PIF field of the given VLAN.

Get the untagged_PIF field of the given VLAN. (Raise error on XMLRPC failure)

Get the uuid field of the given VLAN.

Get the uuid field of the given VLAN. (Raise error on XMLRPC failure)

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.

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. (Raise error on XMLRPC failure)

Set the other_config field of the given VLAN.

Set the other_config field of the given VLAN. (Raise error on XMLRPC failure)

Link to this section Functions

Link to this function

add_to_other_config(xen_session, vlan_ref, key, value)

View Source

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

Link to this function

add_to_other_config!(xen_session, vlan_ref, key, value)

View Source

Add the given key-value pair to the other_config field of the given VLAN. (Raise error on XMLRPC failure)

Link to this function

create(xen_session, tagged_PIF, tag, network)

View Source

Create a VLAN mux/demuxer

Link to this function

create!(xen_session, tagged_PIF, tag, network)

View Source

Create a VLAN mux/demuxer (Raise error on XMLRPC failure)

Link to this function

destroy(xen_session, vlan_ref)

View Source

Destroy a VLAN mux/demuxer

Link to this function

destroy!(xen_session, vlan_ref)

View Source

Destroy a VLAN mux/demuxer (Raise error on XMLRPC failure)

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

Return a list of all the VLANs known to the system. (Raise error on XMLRPC failure)

Link to this function

get_all_records(xen_session)

View Source

Return a map of VLAN references to VLAN records for all VLANs known to the system.

Link to this function

get_all_records!(xen_session)

View Source

Return a map of VLAN references to VLAN records for all VLANs known to the system. (Raise error on XMLRPC failure)

Link to this function

get_by_uuid(xen_session, uuid)

View Source

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

Link to this function

get_by_uuid!(xen_session, uuid)

View Source

Get a reference to the VLAN instance with the specified UUID. (Raise error on XMLRPC failure)

Link to this function

get_other_config(xen_session, vlan_ref)

View Source

Get the other_config field of the given VLAN.

Link to this function

get_other_config!(xen_session, vlan_ref)

View Source

Get the other_config field of the given VLAN. (Raise error on XMLRPC failure)

Link to this function

get_record(xen_session, vlan_ref)

View Source

Get a record containing the current state of the given VLAN. Returns XenAPI.VLAN struct.

Link to this function

get_record!(xen_session, vlan_ref)

View Source

Get a record containing the current state of the given VLAN. Returns XenAPI.VLAN struct. (Raise error on XMLRPC failure)

Link to this function

get_tag(xen_session, vlan_ref)

View Source

Get the tag field of the given VLAN.

Link to this function

get_tag!(xen_session, vlan_ref)

View Source

Get the tag field of the given VLAN. (Raise error on XMLRPC failure)

Link to this function

get_tagged_PIF(xen_session, vlan_ref)

View Source

Get the tagged_PIF field of the given VLAN.

Link to this function

get_tagged_PIF!(xen_session, vlan_ref)

View Source

Get the tagged_PIF field of the given VLAN. (Raise error on XMLRPC failure)

Link to this function

get_untagged_PIF(xen_session, vlan_ref)

View Source

Get the untagged_PIF field of the given VLAN.

Link to this function

get_untagged_PIF!(xen_session, vlan_ref)

View Source

Get the untagged_PIF field of the given VLAN. (Raise error on XMLRPC failure)

Link to this function

get_uuid(xen_session, vlan_ref)

View Source

Get the uuid field of the given VLAN.

Link to this function

get_uuid!(xen_session, vlan_ref)

View Source

Get the uuid field of the given VLAN. (Raise error on XMLRPC failure)

Link to this function

remove_from_other_config(xen_session, vlan_ref, key)

View Source

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.

Link to this function

remove_from_other_config!(xen_session, vlan_ref, key)

View Source

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. (Raise error on XMLRPC failure)

Link to this function

set_other_config(xen_session, vlan_ref, value)

View Source

Set the other_config field of the given VLAN.

Link to this function

set_other_config!(xen_session, vlan_ref, value)

View Source

Set the other_config field of the given VLAN. (Raise error on XMLRPC failure)