View Source XenAPI.Network (XenAPI v0.3.1)

A virtual network

Link to this section Summary

Functions

Give a network a new purpose (if not present already)

Give a network a new purpose (if not present already) (Raise error on XMLRPC failure)

Add the given value to the tags field of the given network. If the value is already in that Set, then do nothing.

Add the given value to the tags field of the given network. If the value is already in that Set, then do nothing. (Raise error on XMLRPC failure)

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

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

Create a new network instance, and return its handle. The constructor args are: name_label, name_description, MTU, other_config, bridge, managed, tags ( = non-optional).

Create a new network instance, and return its handle. The constructor args are: name_label, name_description, MTU, other_config, bridge, managed, tags ( = non-optional). (Raise error on XMLRPC failure)

Create a placeholder for a named binary blob of data that is associated with this pool

Create a placeholder for a named binary blob of data that is associated with this pool (Raise error on XMLRPC failure)

Destroy the specified network instance.

Destroy the specified network instance. (Raise error on XMLRPC failure)

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

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

Return a map of network references to network records for all networks known to the system.

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

Get the allowed_operations field of the given network.

Get the allowed_operations field of the given network. (Raise error on XMLRPC failure)

Get the assigned_ips field of the given network.

Get the assigned_ips field of the given network. (Raise error on XMLRPC failure)

Get the blobs field of the given network.

Get the blobs field of the given network. (Raise error on XMLRPC failure)

Get the bridge field of the given network.

Get the bridge field of the given network. (Raise error on XMLRPC failure)

Get all the network instances with the given label.

Get all the network instances with the given label. (Raise error on XMLRPC failure)

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

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

Get the current_operations field of the given network.

Get the current_operations field of the given network. (Raise error on XMLRPC failure)

Get the default_locking_mode field of the given network.

Get the default_locking_mode field of the given network. (Raise error on XMLRPC failure)

Get the MTU field of the given network.

Get the MTU field of the given network. (Raise error on XMLRPC failure)

Get the managed field of the given network.

Get the managed field of the given network. (Raise error on XMLRPC failure)

Get the name/description field of the given network.

Get the name/description field of the given network. (Raise error on XMLRPC failure)

Get the name/label field of the given network.

Get the name/label field of the given network. (Raise error on XMLRPC failure)

Get the other_config field of the given network.

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

Get the PIFs field of the given network.

Get the PIFs field of the given network. (Raise error on XMLRPC failure)

Get the purpose field of the given network.

Get the purpose field of the given network. (Raise error on XMLRPC failure)

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

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

Get the tags field of the given network.

Get the tags field of the given network. (Raise error on XMLRPC failure)

Get the uuid field of the given network.

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

Get the VIFs field of the given network.

Get the VIFs field of the given network. (Raise error on XMLRPC failure)

Remove the given key and its corresponding value from the other_config field of the given network. 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 network. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)

Remove a purpose from a network (if present)

Remove a purpose from a network (if present) (Raise error on XMLRPC failure)

Remove the given value from the tags field of the given network. If the value is not in that Set, then do nothing.

Remove the given value from the tags field of the given network. If the value is not in that Set, then do nothing. (Raise error on XMLRPC failure)

Set the default locking mode for VIFs attached to this network

Set the default locking mode for VIFs attached to this network (Raise error on XMLRPC failure)

Set the MTU field of the given network.

Set the MTU field of the given network. (Raise error on XMLRPC failure)

Set the name/description field of the given network.

Set the name/description field of the given network. (Raise error on XMLRPC failure)

Set the name/label field of the given network.

Set the name/label field of the given network. (Raise error on XMLRPC failure)

Set the other_config field of the given network.

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

Set the tags field of the given network.

Set the tags field of the given network. (Raise error on XMLRPC failure)

Link to this section Functions

Link to this function

add_purpose(xen_session, network_ref, value)

View Source

Give a network a new purpose (if not present already)

Link to this function

add_purpose!(xen_session, network_ref, value)

View Source

Give a network a new purpose (if not present already) (Raise error on XMLRPC failure)

Link to this function

add_tags(xen_session, network_ref, value)

View Source

Add the given value to the tags field of the given network. If the value is already in that Set, then do nothing.

Link to this function

add_tags!(xen_session, network_ref, value)

View Source

Add the given value to the tags field of the given network. If the value is already in that Set, then do nothing. (Raise error on XMLRPC failure)

Link to this function

add_to_other_config(xen_session, network_ref, key, value)

View Source

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

Link to this function

add_to_other_config!(xen_session, network_ref, key, value)

View Source

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

Link to this function

create(xen_session, args)

View Source

Create a new network instance, and return its handle. The constructor args are: name_label, name_description, MTU, other_config, bridge, managed, tags ( = non-optional).

Link to this function

create!(xen_session, args)

View Source

Create a new network instance, and return its handle. The constructor args are: name_label, name_description, MTU, other_config, bridge, managed, tags ( = non-optional). (Raise error on XMLRPC failure)

Link to this function

create_new_blob(xen_session, network, name, mime_type, public)

View Source

Create a placeholder for a named binary blob of data that is associated with this pool

Link to this function

create_new_blob!(xen_session, network, name, mime_type, public)

View Source

Create a placeholder for a named binary blob of data that is associated with this pool (Raise error on XMLRPC failure)

Link to this function

destroy(xen_session, network_ref)

View Source

Destroy the specified network instance.

Link to this function

destroy!(xen_session, network_ref)

View Source

Destroy the specified network instance. (Raise error on XMLRPC failure)

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

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

Link to this function

get_all_records(xen_session)

View Source

Return a map of network references to network records for all networks known to the system.

Link to this function

get_all_records!(xen_session)

View Source

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

Link to this function

get_allowed_operations(xen_session, network_ref)

View Source

Get the allowed_operations field of the given network.

Link to this function

get_allowed_operations!(xen_session, network_ref)

View Source

Get the allowed_operations field of the given network. (Raise error on XMLRPC failure)

Link to this function

get_assigned_ips(xen_session, network_ref)

View Source

Get the assigned_ips field of the given network.

Link to this function

get_assigned_ips!(xen_session, network_ref)

View Source

Get the assigned_ips field of the given network. (Raise error on XMLRPC failure)

Link to this function

get_blobs(xen_session, network_ref)

View Source

Get the blobs field of the given network.

Link to this function

get_blobs!(xen_session, network_ref)

View Source

Get the blobs field of the given network. (Raise error on XMLRPC failure)

Link to this function

get_bridge(xen_session, network_ref)

View Source

Get the bridge field of the given network.

Link to this function

get_bridge!(xen_session, network_ref)

View Source

Get the bridge field of the given network. (Raise error on XMLRPC failure)

Link to this function

get_by_name_label(xen_session, label)

View Source

Get all the network instances with the given label.

Link to this function

get_by_name_label!(xen_session, label)

View Source

Get all the network instances with the given label. (Raise error on XMLRPC failure)

Link to this function

get_by_uuid(xen_session, uuid)

View Source

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

Link to this function

get_by_uuid!(xen_session, uuid)

View Source

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

Link to this function

get_current_operations(xen_session, network_ref)

View Source

Get the current_operations field of the given network.

Link to this function

get_current_operations!(xen_session, network_ref)

View Source

Get the current_operations field of the given network. (Raise error on XMLRPC failure)

Link to this function

get_default_locking_mode(xen_session, network_ref)

View Source

Get the default_locking_mode field of the given network.

Link to this function

get_default_locking_mode!(xen_session, network_ref)

View Source

Get the default_locking_mode field of the given network. (Raise error on XMLRPC failure)

Link to this function

get_MTU(xen_session, network_ref)

View Source

Get the MTU field of the given network.

Link to this function

get_MTU!(xen_session, network_ref)

View Source

Get the MTU field of the given network. (Raise error on XMLRPC failure)

Link to this function

get_managed(xen_session, network_ref)

View Source

Get the managed field of the given network.

Link to this function

get_managed!(xen_session, network_ref)

View Source

Get the managed field of the given network. (Raise error on XMLRPC failure)

Link to this function

get_name_description(xen_session, network_ref)

View Source

Get the name/description field of the given network.

Link to this function

get_name_description!(xen_session, network_ref)

View Source

Get the name/description field of the given network. (Raise error on XMLRPC failure)

Link to this function

get_name_label(xen_session, network_ref)

View Source

Get the name/label field of the given network.

Link to this function

get_name_label!(xen_session, network_ref)

View Source

Get the name/label field of the given network. (Raise error on XMLRPC failure)

Link to this function

get_other_config(xen_session, network_ref)

View Source

Get the other_config field of the given network.

Link to this function

get_other_config!(xen_session, network_ref)

View Source

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

Link to this function

get_PIFs(xen_session, network_ref)

View Source

Get the PIFs field of the given network.

Link to this function

get_PIFs!(xen_session, network_ref)

View Source

Get the PIFs field of the given network. (Raise error on XMLRPC failure)

Link to this function

get_purpose(xen_session, network_ref)

View Source

Get the purpose field of the given network.

Link to this function

get_purpose!(xen_session, network_ref)

View Source

Get the purpose field of the given network. (Raise error on XMLRPC failure)

Link to this function

get_record(xen_session, network_ref)

View Source

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

Link to this function

get_record!(xen_session, network_ref)

View Source

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

Link to this function

get_tags(xen_session, network_ref)

View Source

Get the tags field of the given network.

Link to this function

get_tags!(xen_session, network_ref)

View Source

Get the tags field of the given network. (Raise error on XMLRPC failure)

Link to this function

get_uuid(xen_session, network_ref)

View Source

Get the uuid field of the given network.

Link to this function

get_uuid!(xen_session, network_ref)

View Source

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

Link to this function

get_VIFs(xen_session, network_ref)

View Source

Get the VIFs field of the given network.

Link to this function

get_VIFs!(xen_session, network_ref)

View Source

Get the VIFs field of the given network. (Raise error on XMLRPC failure)

Link to this function

remove_from_other_config(xen_session, network_ref, key)

View Source

Remove the given key and its corresponding value from the other_config field of the given network. If the key is not in that Map, then do nothing.

Link to this function

remove_from_other_config!(xen_session, network_ref, key)

View Source

Remove the given key and its corresponding value from the other_config field of the given network. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)

Link to this function

remove_purpose(xen_session, network_ref, value)

View Source

Remove a purpose from a network (if present)

Link to this function

remove_purpose!(xen_session, network_ref, value)

View Source

Remove a purpose from a network (if present) (Raise error on XMLRPC failure)

Link to this function

remove_tags(xen_session, network_ref, value)

View Source

Remove the given value from the tags field of the given network. If the value is not in that Set, then do nothing.

Link to this function

remove_tags!(xen_session, network_ref, value)

View Source

Remove the given value from the tags field of the given network. If the value is not in that Set, then do nothing. (Raise error on XMLRPC failure)

Link to this function

set_default_locking_mode(xen_session, network, value)

View Source

Set the default locking mode for VIFs attached to this network

Link to this function

set_default_locking_mode!(xen_session, network, value)

View Source

Set the default locking mode for VIFs attached to this network (Raise error on XMLRPC failure)

Link to this function

set_MTU(xen_session, network_ref, value)

View Source

Set the MTU field of the given network.

Link to this function

set_MTU!(xen_session, network_ref, value)

View Source

Set the MTU field of the given network. (Raise error on XMLRPC failure)

Link to this function

set_name_description(xen_session, network_ref, value)

View Source

Set the name/description field of the given network.

Link to this function

set_name_description!(xen_session, network_ref, value)

View Source

Set the name/description field of the given network. (Raise error on XMLRPC failure)

Link to this function

set_name_label(xen_session, network_ref, value)

View Source

Set the name/label field of the given network.

Link to this function

set_name_label!(xen_session, network_ref, value)

View Source

Set the name/label field of the given network. (Raise error on XMLRPC failure)

Link to this function

set_other_config(xen_session, network_ref, value)

View Source

Set the other_config field of the given network.

Link to this function

set_other_config!(xen_session, network_ref, value)

View Source

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

Link to this function

set_tags(xen_session, network_ref, value)

View Source

Set the tags field of the given network.

Link to this function

set_tags!(xen_session, network_ref, value)

View Source

Set the tags field of the given network. (Raise error on XMLRPC failure)