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",
    :publish    => "vn.publish",
    :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.

• - (Object) allocate(description)

  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.

• - (Object) chown(uid, gid)

  Changes the owner/group

  uid	Integer the new owner id.

• - (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)

  Replaces the template contents.

Methods inherited from PoolElement

#id, #name, new_with_id, #to_str

Methods inherited from XMLElement

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

66
67
68

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

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

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

55
56
57
58
59
60
61
62
63

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

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

109
110
111
112
113
114
115
116
117
118
119
120

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

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

82
83
84

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

def allocate(description)
    super(VN_METHODS[:allocate],description)
end

182
183
184
185
186

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

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

173
174
175

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

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

164
165
166

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

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

104
105
106

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

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

194
195
196

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

def gid
    self['GID'].to_i
end

136
137
138
139
140
141
142
143
144
145

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

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

75
76
77

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

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

213
214
215
216
217
218
219

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

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

94
95
96

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

def publish
    set_publish(true)
end

149
150
151
152
153
154
155
156
157
158

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

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

123
124
125
126
127
128
129
130
131
132

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

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

209
210
211

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

def short_type_str
    SHORT_VN_TYPES[type_str]
end

199
200
201

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

def type
    self['TYPE'].to_i
end

204
205
206

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

def type_str
    VN_TYPES[type]
end

99
100
101

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

def unpublish
    set_publish(false)
end

89
90
91

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

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