Class: RbVmomi::VIM::Folder

Inherits:
Object
  • Object
show all
Defined in:
lib/rbvmomi/vim/Folder.rb

Instance Method Summary (collapse)

Instance Method Details

- (Object) children

Alias to childEntity.



95
96
97
# File 'lib/rbvmomi/vim/Folder.rb', line 95

def children
  childEntity
end

- (VIM::ManagedEntity) find(name, type = Object)

Retrieve a child entity

Parameters:

  • name (String)

    Name of the child.

  • type (Class) (defaults to: Object)

    Return nil unless the found entity is_a? type.

Returns:



6
7
8
9
# File 'lib/rbvmomi/vim/Folder.rb', line 6

def find name, type=Object
  x = _connection.searchIndex.FindChild(:entity => self, :name => name)
  x if x.is_a? type
end

- (VIM::ManagedEntity) findByDnsName(name, type = RbVmomi::VIM::VirtualMachine, dc = nil)

Retrieve a virtual machine or host by DNS name

Parameters:

  • name (String)

    The fully qualified domain name to find.

  • type (Class) (defaults to: RbVmomi::VIM::VirtualMachine)

    Return nil unless the found entity is_a? type.

  • dc (RbVmomi::VIM::Datacenter) (defaults to: nil)

    Restricts the query to entities in the given Datacenter.

Returns:



16
17
18
19
20
21
22
23
24
# File 'lib/rbvmomi/vim/Folder.rb', line 16

def findByDnsName name, type=RbVmomi::VIM::VirtualMachine, dc=nil
  propSpecs = {
    :entity => self, :dnsName => name,
    :vmSearch => type == RbVmomi::VIM::VirtualMachine
  }
  propSpecs[:datacenter] = dc if dc
  x = _connection.searchIndex.FindByDnsName(propSpecs)
  x if x.is_a? type
end

- (VIM::ManagedEntity) findByIp(ip, type = RbVmomi::VIM::VirtualMachine, dc = nil)

Retrieve a virtual machine or host by IP address

Parameters:

  • ip (String)

    The IP address is in dot-decimal notation.

  • type (Class) (defaults to: RbVmomi::VIM::VirtualMachine)

    Return nil unless the found entity is_a? type.

  • dc (RbVmomi::VIM::Datacenter) (defaults to: nil)

    Restricts the query to entities in the given Datacenter.

Returns:



31
32
33
34
35
36
37
38
39
# File 'lib/rbvmomi/vim/Folder.rb', line 31

def findByIp ip, type=RbVmomi::VIM::VirtualMachine, dc=nil
  propSpecs = {
    :entity => self, :ip => ip,
    :vmSearch => type == RbVmomi::VIM::VirtualMachine
  }
  propSpecs[:datacenter] = dc if dc
  x = _connection.searchIndex.FindByIp(propSpecs)
  x if x.is_a? type
end

- (VIM::ManagedEntity) findByUuid(uuid, type = RbVmomi::VIM::VirtualMachine, dc = nil)

Retrieve a virtual machine or host by BIOS UUID.

Parameters:

  • uuid (String)

    The UUID to find.

  • type (Class) (defaults to: RbVmomi::VIM::VirtualMachine)

    Return nil unless the found entity is_a? type.

  • dc (RbVmomi::VIM::Datacenter) (defaults to: nil)

    Restricts the query to entities in the given Datacenter.

Returns:



46
47
48
49
50
51
52
53
54
# File 'lib/rbvmomi/vim/Folder.rb', line 46

def findByUuid uuid, type=RbVmomi::VIM::VirtualMachine, dc=nil
  propSpecs = {
    :entity => self, :uuid => uuid, :instanceUuid => false,
    :vmSearch => type == RbVmomi::VIM::VirtualMachine
  }
  propSpecs[:datacenter] = dc if dc
  x = _connection.searchIndex.FindByUuid(propSpecs)
  x if x.is_a? type
end

- (Hash) inventory(propSpecs = {})

Deprecated.

Efficiently retrieve properties from descendants of this folder.

Parameters:

  • propSpecs (Hash) (defaults to: {})

    Specification of which properties to retrieve from which entities. Keys may be symbols, strings, or classes identifying ManagedEntity subtypes to be included in the results. Values are an array of property paths (strings) or the symbol :all.

Returns:

  • (Hash)

    Tree of inventory items. Folders are hashes from child name to child result. Objects are hashes from property path to value.



186
187
188
189
190
191
192
193
194
195
196
# File 'lib/rbvmomi/vim/Folder.rb', line 186

def inventory propSpecs={}
  inv = inventory_flat propSpecs
  tree = { self => {} }
  inv.each do |obj,x|
    next if obj == self
    h = Hash[x.propSet.map { |y| [y.name, y.val] }]
    tree[h['parent']][h['name']] = [obj, h]
    tree[obj] = {} if obj.is_a? RbVmomi::VIM::Folder
  end
  tree
end

- (Hash) inventory_flat(propSpecs = {})

Efficiently retrieve properties from descendants of this folder.

Parameters:

  • propSpecs (Hash) (defaults to: {})

    Specification of which properties to retrieve from which entities. Keys may be symbols, strings, or classes identifying ManagedEntity subtypes to be included in the results. Values are an array of property paths (strings) or the symbol :all.

Returns:

  • (Hash)

    Hash of ManagedObjects to properties.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
# File 'lib/rbvmomi/vim/Folder.rb', line 108

def inventory_flat propSpecs={}
  propSet = [{ :type => 'Folder', :pathSet => ['name', 'parent', 'childEntity'] }]
  propSpecs.each do |k,v|
    case k
    when Class
      fail "key must be a subclass of ManagedEntity" unless k < RbVmomi::VIM::ManagedEntity
      k = k.wsdl_name
    when Symbol, String
      k = k.to_s
    else
      fail "invalid key"
    end

    h = { :type => k }
    if v == :all
      h[:all] = true
    elsif v.is_a? Array
      h[:pathSet] = v + %w(parent)
    else
      fail "value must be an array of property paths or :all"
    end
    propSet << h
  end

  filterSpec = RbVmomi::VIM.PropertyFilterSpec(
    :objectSet => [
      :obj => self,
      :selectSet => [
        RbVmomi::VIM.TraversalSpec(
          :name => 'tsFolder',
          :type => 'Folder',
          :path => 'childEntity',
          :skip => false,
          :selectSet => [
            RbVmomi::VIM.SelectionSpec(:name => 'tsFolder')
          ]
        )
      ]
    ],
    :propSet => propSet
  )

  result = _connection.propertyCollector.RetrieveProperties(:specSet => [filterSpec])
  {}.tap do |h|
    result.each { |r| h[r.obj] = r }
  end
end

- (Hash) inventory_tree(propSpecs = {})

Efficiently retrieve properties from descendants of this folder.

Parameters:

  • propSpecs (Hash) (defaults to: {})

    Specification of which properties to retrieve from which entities. Keys may be symbols, strings, or classes identifying ManagedEntity subtypes to be included in the results. Values are an array of property paths (strings) or the symbol :all.

Returns:

  • (Hash)

    Tree of inventory items. Each node is a hash from VIM::ObjectContent to children.



166
167
168
169
170
171
# File 'lib/rbvmomi/vim/Folder.rb', line 166

def inventory_tree propSpecs={}
  inv = inventory_flat propSpecs
  children = inv.values.group_by { |v| v['parent'] }
  rec = lambda { |parent| Hash[(children[parent]||[]).map { |x| [x, rec[x.obj]] }] }
  rec[self]
end

- (VIM::ManagedEntity) traverse(path, type = Object, create = false)

TODO:

Move create functionality into another method.

Retrieve a descendant of this Folder.

Parameters:

  • path (String)

    Path delimited by '/', or an array of path elements.

  • create (Boolean) (defaults to: false)

    If set, create folders that don't exist.

  • type (Class) (defaults to: Object)

    Return nil unless the found entity is_a? type.

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/rbvmomi/vim/Folder.rb', line 68

def traverse path, type=Object, create=false
  if path.is_a? String
    es = path.split('/').reject(&:empty?)
  elsif path.is_a? Enumerable
    es = path
  else
    fail "unexpected path class #{path.class}"
  end
  return self if es.empty?
  final = es.pop

  p = es.inject(self) do |f,e|
    f.find(e, RbVmomi::VIM::Folder) || (create && f.CreateFolder(:name => e)) || return
  end

  if x = p.find(final, type)
    x
  elsif create and type == RbVmomi::VIM::Folder
    p.CreateFolder(:name => final)
  elsif create and type == RbVmomi::VIM::Datacenter
    p.CreateDatacenter(:name => final)
  else
    nil
  end
end

- (Object) traverse!(path, type = Object)

Alias to traverse path, type, true

See Also:



58
59
60
# File 'lib/rbvmomi/vim/Folder.rb', line 58

def traverse! path, type=Object
  traverse path, type, true
end