Class: OpenNebula::VirtualNetwork

Inherits:

PoolElement

• Object
• XMLElement
• PoolElement
• OpenNebula::VirtualNetwork

show all

Defined in:

OpenNebula/VirtualNetwork.rb

Constant Summary

VN_METHODS =

{
    :info       => "vn.info",
    :allocate   => "vn.allocate",
    :delete     => "vn.delete",
    :addleases  => "vn.addleases",
    :rmleases   => "vn.rmleases",
    :chown      => "vn.chown",
    :chmod      => "vn.chmod",
    :update     => "vn.update",
    :hold       => "vn.hold",
    :release    => "vn.release"
}

VN_TYPES =

%w{RANGED FIXED}

SHORT_VN_TYPES =

{
    "RANGED" => "R",
    "FIXED"  => "F"
}

Class Method Summary (collapse)

• + (Object) build_xml(pe_id = nil)

  Creates a VirtualNetwork description with just its identifier this method should be used to create plain VirtualNetwork objects.

Instance Method Summary (collapse)

• - (Object) addleases(ip, mac = nil)

  Adds a lease to the VirtualNetwork.

• - (Integer, OpenNebula::Error) allocate(description, cluster_id = ClusterPool::NONE_CLUSTER_ID)

  Allocates a new VirtualNetwork in OpenNebula.

• - (nil, OpenNebula::Error) chmod(owner_u, owner_m, owner_a, group_u, group_m, group_a, other_u, other_m, other_a)

  Changes the virtual network permissions.

• - (nil, OpenNebula::Error) chmod_octet(octet)

  Changes the virtual network permissions.

• - (nil, OpenNebula::Error) chown(uid, gid)

  Changes the owner/group.

• - (Object) delete

  Deletes the VirtualNetwork.

• - (Object) gid

  Returns the group identifier

  return

  Integer the element's group ID.

• - (Object) hold(ip)

  Holds a virtual network Lease as used.

• - (Object) info

  Retrieves the information of the given VirtualNetwork.

• - (VirtualNetwork) initialize(xml, client) constructor

  Class constructor.

• - (Boolean) public?
• - (Object) publish

  Publishes the VirtualNetwork, to be used by other users.

• - (Object) release(ip)

  Releases a virtual network Lease on hold.

• - (Object) rmleases(ip)

  Removes a lease from the VirtualNetwork.

• - (Object) short_type_str

  Returns the state of the Virtual Network (string value).

• - (Object) type

  Returns the type of the Virtual Network (numeric value).

• - (Object) type_str

  Returns the type of the Virtual Network (string value).

• - (Object) unpublish

  Unplubishes the VirtualNetwork.

• - (Object) update(new_template = nil)

  Replaces the template contents.

Methods inherited from PoolElement

#id, #name, new_with_id, #to_str

Methods inherited from XMLElement

#[], #add_element, #attr, #delete_element, #each, #each_xpath, #element_xml, #has_elements?, #initialize_xml, #name, #retrieve_elements, #template_like_str, #template_str, #template_xml, #text, #to_hash, #to_xml

65
66
67

# File 'OpenNebula/VirtualNetwork.rb', line 65

def initialize(xml, client)
    super(xml,client)
end

vnet = VirtualNetwork.new(VirtualNetwork.build_xml(3),rpc_client)

54
55
56
57
58
59
60
61
62

# File 'OpenNebula/VirtualNetwork.rb', line 54

def VirtualNetwork.build_xml(pe_id=nil)
    if pe_id
        vn_xml = "<VNET><ID>#{pe_id}</ID></VNET>"
    else
        vn_xml = "<VNET></VNET>"
    end

    XMLElement.build_xml(vn_xml, 'VNET')
end

113
114
115
116
117
118
119
120
121
122
123
124

# File 'OpenNebula/VirtualNetwork.rb', line 113

def addleases(ip, mac = nil)
    return Error.new('ID not defined') if !@pe_id

    lease_template = "LEASES = [ IP = #{ip}"
    lease_template << ", MAC = #{mac}" if mac
    lease_template << " ]"

    rc = @client.call(VN_METHODS[:addleases], @pe_id, lease_template)
    rc = nil if !OpenNebula.is_error?(rc)

    return rc
end

85
86
87

# File 'OpenNebula/VirtualNetwork.rb', line 85

def allocate(description,cluster_id=ClusterPool::NONE_CLUSTER_ID)
    super(VN_METHODS[:allocate], description, cluster_id)
end

189
190
191
192
193

# File 'OpenNebula/VirtualNetwork.rb', line 189

def chmod(owner_u, owner_m, owner_a, group_u, group_m, group_a, other_u,
        other_m, other_a)
    super(VN_METHODS[:chmod], owner_u, owner_m, owner_a, group_u,
        group_m, group_a, other_u, other_m, other_a)
end

180
181
182

# File 'OpenNebula/VirtualNetwork.rb', line 180

def chmod_octet(octet)
    super(VN_METHODS[:chmod], octet)
end

171
172
173

# File 'OpenNebula/VirtualNetwork.rb', line 171

def chown(uid, gid)
    super(VN_METHODS[:chown], uid, gid)
end

108
109
110

# File 'OpenNebula/VirtualNetwork.rb', line 108

def delete()
    super(VN_METHODS[:delete])
end

201
202
203

# File 'OpenNebula/VirtualNetwork.rb', line 201

def gid
    self['GID'].to_i
end

140
141
142
143
144
145
146
147
148
149

# File 'OpenNebula/VirtualNetwork.rb', line 140

def hold(ip)
    return Error.new('ID not defined') if !@pe_id

    lease_template = "LEASES = [ IP = #{ip} ]"

    rc = @client.call(VN_METHODS[:hold], @pe_id, lease_template)
    rc = nil if !OpenNebula.is_error?(rc)

    return rc
end

74
75
76

# File 'OpenNebula/VirtualNetwork.rb', line 74

def info()
    super(VN_METHODS[:info], 'VNET')
end

220
221
222
223
224
225
226

# File 'OpenNebula/VirtualNetwork.rb', line 220

def public?
    if self['PERMISSIONS/GROUP_U'] == "1" || self['PERMISSIONS/OTHER_U'] == "1"
        true
    else
        false
    end
end

98
99
100

# File 'OpenNebula/VirtualNetwork.rb', line 98

def publish
    set_publish(true)
end

153
154
155
156
157
158
159
160
161
162

# File 'OpenNebula/VirtualNetwork.rb', line 153

def release(ip)
    return Error.new('ID not defined') if !@pe_id

    lease_template = "LEASES = [ IP = #{ip} ]"

    rc = @client.call(VN_METHODS[:release], @pe_id, lease_template)
    rc = nil if !OpenNebula.is_error?(rc)

    return rc
end

127
128
129
130
131
132
133
134
135
136

# File 'OpenNebula/VirtualNetwork.rb', line 127

def rmleases(ip)
    return Error.new('ID not defined') if !@pe_id

    lease_template = "LEASES = [ IP = #{ip} ]"

    rc = @client.call(VN_METHODS[:rmleases], @pe_id, lease_template)
    rc = nil if !OpenNebula.is_error?(rc)

    return rc
end

216
217
218

# File 'OpenNebula/VirtualNetwork.rb', line 216

def short_type_str
    SHORT_VN_TYPES[type_str]
end

206
207
208

# File 'OpenNebula/VirtualNetwork.rb', line 206

def type
    self['TYPE'].to_i
end

211
212
213

# File 'OpenNebula/VirtualNetwork.rb', line 211

def type_str
    VN_TYPES[type]
end

103
104
105

# File 'OpenNebula/VirtualNetwork.rb', line 103

def unpublish
    set_publish(false)
end

the object will be updated using the @xml variable

93
94
95

# File 'OpenNebula/VirtualNetwork.rb', line 93

def update(new_template=nil)
    super(VN_METHODS[:update], new_template)
end