2.17.
CLASS: NETWORK
CHAPTER 2.
API REFERENCE
2.17
Class: network
2.17.1
Fields for class: network
Name
network
Description
A virtual network.
Quals
Field
Type
Description
RO
run
uuid
string
unique identifier/object reference
RW
name/label
string
a human-readable name
RW
name/description
string
a
notes
field
containg
human-
readable description
RO
run
allowed operations
(network operations) Set
list of the operations allowed in this
state. This list is advisory only and
the server state may have changed by
the time this field is read by a client.
RO
run
current operations
(string
→
network operations) Map
links each of the running tasks using
this object (by reference) to a cur-
rent operation enum which describes
the nature of the task.
RO
run
VIFs
(VIF ref) Set
list of connected vifs
RO
run
PIFs
(PIF ref) Set
list of connected pifs
RW
other config
(string
→
string) Map
additional configuration
RO
run
bridge
string
name of the bridge corresponding to
this network on the local host
2.17.2
RPCs associated with class: network
RPC name: get all
Overview:
Return a list of all the networks known to the system.
Signature:
((network ref) Set) get_all (session_id s)
Return Type:
(network ref) Set
references to all objects
RPC name: get all records
Overview:
Return a map of network references to network records for all networks known to the system.
Signature:
((network ref -> network record) Map) get_all_records (session_id s)
Return Type:
(network ref
→
network record) Map
records of all objects
154