Class: VLAN
A VLAN mux/demux
| Published in: | XenServer 4.1 (miami) | A VLAN mux/demux |
Fields
(string → string) map
other_config
[RW]
additional configuration
| Default value: | {} |
| Published in: | XenServer 4.1 (miami) | additional configuration |
int
tag
[RO/constructor]
VLAN tag in use
| Default value: | -1 |
| Published in: | XenServer 4.1 (miami) | VLAN tag in use |
PIF ref
tagged_PIF
[RO/constructor]
interface on which traffic is tagged
| Default value: | Null |
| Published in: | XenServer 4.1 (miami) | interface on which traffic is tagged |
PIF ref
untagged_PIF
[RO/runtime]
interface on which traffic is untagged
| Default value: | Null |
| Published in: | XenServer 4.1 (miami) | interface on which traffic is untagged |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference |
Messages
void
add_to_other_config
(session ref, VLAN ref, string, string)
Add the given key-value pair to the other_config field of the given VLAN.
| Parameters: | session ref session_id | 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 |
| Published in: | XenServer 4.1 (miami) | additional configuration |
VLAN ref
create
(session ref, PIF ref, int, network ref)
Create a VLAN mux/demuxer
| Parameters: | session ref session_id | 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 |
| Result: | The reference of the created VLAN object |
| Published in: | XenServer 4.1 (miami) | Create a VLAN mux/demuxer |
void
destroy
(session ref, VLAN ref)
Destroy a VLAN mux/demuxer
| Parameters: | session ref session_id | Reference to a valid session |
| VLAN ref self | VLAN mux/demuxer to destroy |
| Minimum role: | pool-operator |
| Published in: | XenServer 4.1 (miami) | Destroy a VLAN mux/demuxer |
VLAN ref set
get_all
(session ref)
Return a list of all the VLANs known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only |
| Result: | references to all objects |
| Published in: | XenServer 4.1 (miami) | A VLAN mux/demux |
(VLAN ref → VLAN record) map
get_all_records
(session ref)
Return a map of VLAN references to VLAN records for all VLANs known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only |
| Result: | records of all objects |
| Published in: | XenServer 4.1 (miami) | A VLAN mux/demux |
VLAN ref
get_by_uuid
(session ref, string)
Get a reference to the VLAN instance with the specified UUID.
| Parameters: | session ref session_id | Reference to a valid session |
| string uuid | UUID of object to return |
| Minimum role: | read-only |
| Result: | reference to the object |
| Published in: | XenServer 4.1 (miami) | A VLAN mux/demux |
(string → string) map
get_other_config
(session ref, VLAN ref)
Get the other_config field of the given VLAN.
| Parameters: | session ref session_id | Reference to a valid session |
| VLAN ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.1 (miami) | additional configuration |
VLAN record
get_record
(session ref, VLAN ref)
Get a record containing the current state of the given VLAN.
| Parameters: | session ref session_id | Reference to a valid session |
| VLAN ref self | reference to the object |
| Minimum role: | read-only |
| Result: | all fields from the object |
| Published in: | XenServer 4.1 (miami) | A VLAN mux/demux |
int
get_tag
(session ref, VLAN ref)
Get the tag field of the given VLAN.
| Parameters: | session ref session_id | Reference to a valid session |
| VLAN ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.1 (miami) | VLAN tag in use |
PIF ref
get_tagged_PIF
(session ref, VLAN ref)
Get the tagged_PIF field of the given VLAN.
| Parameters: | session ref session_id | Reference to a valid session |
| VLAN ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.1 (miami) | interface on which traffic is tagged |
PIF ref
get_untagged_PIF
(session ref, VLAN ref)
Get the untagged_PIF field of the given VLAN.
| Parameters: | session ref session_id | Reference to a valid session |
| VLAN ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.1 (miami) | interface on which traffic is untagged |
string
get_uuid
(session ref, VLAN ref)
Get the uuid field of the given VLAN.
| Parameters: | session ref session_id | Reference to a valid session |
| VLAN ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference |
void
remove_from_other_config
(session ref, VLAN ref, string)
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.
| Parameters: | session ref session_id | Reference to a valid session |
| VLAN ref self | reference to the object |
| string key | Key to remove |
| Minimum role: | pool-operator |
| Published in: | XenServer 4.1 (miami) | additional configuration |
void
set_other_config
(session ref, VLAN ref, (string → string) map)
Set the other_config field of the given VLAN.
| Parameters: | session ref session_id | Reference to a valid session |
| VLAN ref self | reference to the object |
| (string → string) map value | New value to set |
| Minimum role: | pool-operator |
| Published in: | XenServer 4.1 (miami) | additional configuration |