rbvmomi 1.11.2 → 1.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1539a4ed4c313bf1d30a9a42da3acc4d4726fb1f
-  data.tar.gz: d38e49f90790174c5042566b1b412199a902333b
+  metadata.gz: 291486048aa5b6cbd7146d49d7324a4b236212d5
+  data.tar.gz: 1586964068b6036bbee0a7b2beb3c0ca430c8aa6
 SHA512:
-  metadata.gz: be7f3b4523df9b36792aace9c86b1e462c5648064fdeee84e436a32c3d1de4a66f0fb75948418a07c841e6e97b731f440ac238b7b6acf89274acf89757d1d801
-  data.tar.gz: 5f92a99dcec647b46094618a2a835815801a3149515b6c6cd98d6c18ee03cc84079952ab2d005d6b381e1f958855fac19a83abf1b6d07a6daddb7fafb03c964a
+  metadata.gz: 7869ac4308e5c56472c42bb1359a1808956d9f2f83b30066825e88b7ab9be434d94b42521a45c335bf7718d8ae624a9102565ffe8c5abb04d3027b735476ca79
+  data.tar.gz: 7779212ffb10678dcae454875a381ff0beed76488fc77106490506d032b7b166f348a8678ea5577cfe0e2be3bf61967775d001f5f3a0776b0f145078056b372c

data/.yardopts

@@ -1,6 +1,6 @@
 --title "RbVmomi - a Ruby interface to the vSphere API"
 --no-private
---readme README.rdoc
+--readme README.md
 lib/rbvmomi/vim.rb
 lib/rbvmomi/vim/*.rb
 lib/rbvmomi/trollop.rb

data/README.md

@@ -0,0 +1,114 @@
+# RbVmomi
+
+[<img src="https://badge.fury.io/rb/rbvmomi.svg" alt="gem-version">](https://rubygems.org/gems/rbvmomi) 
+[<img src="https://travis-ci.org/vmware/rbvmomi.svg?branch=master" alt="travis-ci">](http://travis-ci.org/vmware/rbvmomi) 
+[<img src="https://badges.gitter.im/vmware/rbvmomi.svg">](https://gitter.im/vmware/rbvmomi)
+
+This is a community-supported, open source project at VMware. It is built and
+maintained by programmers like you!
+
+## Introduction
+
+RbVmomi is a Ruby interface to the vSphere API. Like the Perl and Java SDKs,
+you can use it to manage ESX and vCenter servers. The current release
+supports the vSphere 6.5 API. RbVmomi specific documentation is
+[online](http://rdoc.info/github/vmware/rbvmomi/master/frames) and is meant to
+be used alongside the official [documentation](http://pubs.vmware.com/vsphere-65/index.jsp#com.vmware.wssdk.apiref.doc/right-pane.html).
+
+## Installation
+
+    gem install rbvmomi
+
+### Support for older Ruby versions
+
+RbVmomi supports Ruby 1.8.7 and higher, but certain dependencies may need
+pinning to older versions to get a compatible set of gems.
+
+On Ruby 1.8.7:
+
+* use `nokogiri` 1.5.x (Gemfile: `gem 'nokogiri', '< 1.6'`)
+
+
+On both Ruby 1.9 and 1.8.7:
+
+* use `json` 1.x (Gemfile: `gem 'json', '< 2'`)
+
+
+## Usage
+
+A simple example of turning on a VM:
+
+```ruby
+require 'rbvmomi'
+
+vim = RbVmomi::VIM.connect(host: 'foo', user: 'bar', password: 'baz')
+dc = vim.serviceInstance.find_datacenter('my_datacenter') || fail('datacenter not found')
+vm = dc.find_vm('my_vm') || fail('VM not found')
+vm.PowerOnVM_Task.wait_for_completion
+```
+
+This code uses several RbVmomi extensions to the vSphere API for concision.
+The expanded snippet below uses only standard API calls and should be familiar
+to users of the Java SDK:
+
+```ruby
+require 'rbvmomi'
+
+vim = RbVmomi::VIM.connect(host: 'foo', user: 'bar', password: 'baz')
+root_folder = vim.serviceInstance.content.rootFolder
+dc = rootFolder.childEntity.grep(RbVmomi::VIM::Datacenter).find { |x| x.name == 'mydatacenter' } || fail('datacenter not found')
+vm = dc.vmFolder.childEntity.grep(RbVmomi::VIM::VirtualMachine).find { |x| x.name == 'my_vm' } || fail('VM not found')
+task = vm.PowerOnVM_Task
+filter = vim.propertyCollector.CreateFilter(
+  spec: {
+    propSet: [{ type: 'Task', all: false, pathSet: ['info.state']}],
+    objectSet: [{ obj: task }]
+  },
+  partialUpdates: false
+)
+ver = ''
+loop do
+  result = vim.propertyCollector.WaitForUpdates(version: ver)
+  ver = result.version
+  break if ['success', 'error'].member?(task.info.state)
+end
+filter.DestroyPropertyFilter
+raise(task.info.error) if task.info.state == 'error'
+```
+
+As you can see, the extensions RbVmomi adds can dramatically decrease the code
+needed to perform simple tasks while still letting you use the full power of
+the API when necessary. RbVmomi extensions are often more efficient than a
+naive implementation; for example, the find_vm method on VIM::Datacenter used
+in the first example uses the SearchIndex for fast lookups.
+
+A few important points:
+
+*   All class, method, parameter, and property names match the official [documentation](http://pubs.vmware.com/vsphere-65/index.jsp#com.vmware.wssdk.apiref.doc/right-pane.html).
+*   Properties are exposed as accessor methods.
+*   Data object types can usually be inferred from context, so you may use a hash instead.
+*   Enumeration values are simply strings.
+*   Example code is included in the examples/ directory.
+*   A set of helper methods for Trollop is included to speed up development of
+    command line apps. See the included examples for usage.
+*   If you don't have trusted SSL certificates installed on the host you're
+    connecting to, you'll get an `OpenSSL::SSL::SSLError` "certificate verify
+    failed". You can work around this by using the `:insecure` option to
+    `RbVmomi::VIM.connect`.
+*   This is a side project of a VMware employee and is entirely unsupported by
+    VMware.
+
+
+Built-in extensions are under `lib/rbvmomi/vim/`. You are encouraged to reopen
+VIM classes in your applications and add extensions of your own. If you write
+something generally useful please open a [pull request](https://github.com/vmware/rbvmomi/pulls) so it can be merged back in
+
+## Development
+
+Open an issue on the [issues page](https://github.com/vmware/rbvmomi/issues)
+or  fork the project on [GitHub](https://github.com/vmware/rbvmomi) and send a
+[pull request](https://github.com/vmware/rbvmomi/pulls).
+
+## Support
+
+You can chat on [Gitter](https://gitter.im/vmware/rbvmomi) or join the [VMware {code} Slack team](https://vmwarecode.slack.com/) and join the [#rbvmomi channel](https://vmwarecode.slack.com/messages/rbvmomi).

data/lib/rbvmomi/version.rb

@@ -2,5 +2,5 @@
 # SPDX-License-Identifier: MIT
 
 module RbVmomi
-  VERSION = '1.11.2'.freeze
+  VERSION = '1.11.3'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbvmomi
 version: !ruby/object:Gem::Version
-  version: 1.11.2
+  version: 1.11.3
 platform: ruby
 authors:
 - Rich Lane
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-28 00:00:00.000000000 Z
+date: 2017-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -136,7 +136,7 @@ files:
 - CONTRIBUTORS.md
 - Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - devel/analyze-vim-declarations.rb
 - devel/analyze-xml.rb
@@ -222,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Ruby interface to the VMware vSphere API

data/README.rdoc

@@ -1,105 +0,0 @@
-= RbVmomi
-
-{<img src="https://badge.fury.io/rb/rbvmomi.svg" alt="gem-version">}[https://rubygems.org/gems/rbvmomi]
-{<img src="https://travis-ci.org/vmware/rbvmomi.svg?branch=master" alt="travis-ci">}[http://travis-ci.org/vmware/rbvmomi]
-{<img src="https://badges.gitter.im/vmware/rbvmomi.svg">}[https://gitter.im/vmware/rbvmomi]
-
-This is a community-supported, open source project at VMware. It is built and maintained by programmers like you!
-
-== Introduction
-
-RbVmomi is a Ruby interface to the vSphere API. Like the Perl and Java SDKs,
-you can use it to manage ESX and vCenter servers. The current release
-supports the vSphere 6.5 API. RbVmomi specific documentation is
-online[http://rdoc.info/github/vmware/rbvmomi/master/frames] and is meant to
-be used alongside the official documentation[http://pubs.vmware.com/vsphere-65/index.jsp#com.vmware.wssdk.apiref.doc/right-pane.html].
-
-== Installation
-
-    gem install rbvmomi
-
-=== Support for older Ruby versions
-
-RbVmomi supports Ruby 1.8.7 and higher, but certain dependencies may need
-pinning to older versions to get a compatible set of gems.
-
-On Ruby 1.8.7:
-
-* use +nokogiri+ 1.5.x (Gemfile: <code>gem 'nokogiri', '< 1.6'</code>)
-
-On both Ruby 1.9 and 1.8.7:
-
-* use +json+ 1.x (Gemfile: <code>gem 'json', '< 2'</code>)
-
-== Usage
-
-A simple example of turning on a VM:
-
-    require 'rbvmomi'
-
-    vim = RbVmomi::VIM.connect(host: 'foo', user: 'bar', password: 'baz')
-    dc = vim.serviceInstance.find_datacenter('my_datacenter') || fail('datacenter not found')
-    vm = dc.find_vm('my_vm') || fail('VM not found')
-    vm.PowerOnVM_Task.wait_for_completion
-
-This code uses several RbVmomi extensions to the vSphere API for concision. The
-expanded snippet below uses only standard API calls and should be familiar to
-users of the Java SDK:
-
-    require 'rbvmomi'
-
-    vim = RbVmomi::VIM.connect(host: 'foo', user: 'bar', password: 'baz')
-    root_folder = vim.serviceInstance.content.rootFolder
-    dc = rootFolder.childEntity.grep(RbVmomi::VIM::Datacenter).find { |x| x.name == 'mydatacenter' } || fail('datacenter not found')
-    vm = dc.vmFolder.childEntity.grep(RbVmomi::VIM::VirtualMachine).find { |x| x.name == 'my_vm' } || fail('VM not found')
-    task = vm.PowerOnVM_Task
-    filter = vim.propertyCollector.CreateFilter(
-      spec: {
-        propSet: [{ type: 'Task', all: false, pathSet: ['info.state']}],
-        objectSet: [{ obj: task }]
-      },
-      partialUpdates: false
-    )
-    ver = ''
-    loop do
-      result = vim.propertyCollector.WaitForUpdates(version: ver)
-      ver = result.version
-      break if ['success', 'error'].member?(task.info.state)
-    end
-    filter.DestroyPropertyFilter
-    raise(task.info.error) if task.info.state == 'error'
-
-As you can see, the extensions RbVmomi adds can dramatically decrease the code
-needed to perform simple tasks while still letting you use the full power of
-the API when necessary. RbVmomi extensions are often more efficient than a
-naive implementation; for example, the find_vm method on VIM::Datacenter used
-in the first example uses the SearchIndex for fast lookups.
-
-A few important points:
-
-* All class, method, parameter, and property names match the official documentation[http://pubs.vmware.com/vsphere-65/index.jsp#com.vmware.wssdk.apiref.doc/right-pane.html].
-* Properties are exposed as accessor methods.
-* Data object types can usually be inferred from context, so you may use a hash instead.
-* Enumeration values are simply strings.
-* Example code is included in the examples/ directory.
-* A set of helper methods for Trollop is included to speed up development of
-  command line apps. See the included examples for usage.
-* If you don't have trusted SSL certificates installed on the host you're
-  connecting to, you'll get an +OpenSSL::SSL::SSLError+ "certificate verify failed".
-  You can work around this by using the +:insecure+ option to +RbVmomi::VIM.connect+.
-* This is a side project of a VMware employee and is entirely unsupported by VMware.
-
-Built-in extensions are under +lib/rbvmomi/vim/+. You are encouraged to
-reopen VIM classes in your applications and add extensions of your own. If you
-write something generally useful please open a {pull request}[https://github.com/vmware/rbvmomi/pulls] so it
-can be merged back in
-
-== Development
-
-Open an issue on the {issues page}[https://github.com/vmware/rbvmomi/issues] or 
-fork the project on {GitHub}[https://github.com/vmware/rbvmomi] and send a {pull request}[https://github.com/vmware/rbvmomi/pulls].
-
-== Support
-
-You can chat on {Gitter}[https://gitter.im/vmware/rbvmomi] or join the {VMware \{code} Slack team}[https://vmwarecode.slack.com/]
-and join the {#rbvmomi channel}[https://vmwarecode.slack.com/messages/rbvmomi].