ilo-sdk 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7d69fdc25188262aeac98e737390e8816483736
-  data.tar.gz: 6d4ee8248719197181c07065d57c5dfecd21beb5
+  metadata.gz: 719398b8e8cbf0b240edab29282a232691405b99
+  data.tar.gz: 3d1f8d562fefd4cb9502f20d322702b28a156a0d
 SHA512:
-  metadata.gz: 20cecf33036d39ec7d1cb2c580c9925b08fc378b988cebb2b67b6388dcb795c3f76cf12c653d995062392ec48ef973a864a5e1216594dd2ec05fc5d0fcdfe44d
-  data.tar.gz: fd390be798147aac7992bb2b3a992aaca7f2febd49241d29a476134ea0282f63f51fc7f04d2edf5cd40dd34ce99034a95e190aa8852506b621009b213820ee08
+  metadata.gz: b0ce46b05b61ab55b663fa665c2ff36cefe319ee59c881ac174a7410dd4605b437cf44d54e09f15c74e3a77aaa80ef07955b551f7d7441b925fca8259cf7e503
+  data.tar.gz: 90257545f83a88547e14d3c1296ad78dc433eb631fe85ab1d276e730c9cac5cd07f8c02979411b2bcb8cf36bbd370d46ab4b50e77d0e10dacd6f379b3b07d7e2

data/.rubocop.yml

@@ -1,4 +1,6 @@
 # See default at https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+AllCops:
+  TargetRubyVersion: 2.1
 
 Metrics/ClassLength:
   Max: 200

data/README.md

@@ -239,6 +239,25 @@ ntp_servers = ['10.1.1.1', '10.1.1.2']
 client.set_ntp_server(ntp_servers)
 ```
 
+#### Manager EthernetInterface settings
+
+```ruby
+# Get EthernetInteface settings
+client.get_ilo_ethernet_interface
+
+# Set EthernetInterface to obtain all IPv4 parameters from DHCP server
+client.set_ilo_ipv4_dhcp
+
+# Set static IPv4 address, netmask and gateway
+client.set_ilo_ipv4_static(ip: '192.168.1.1', netmask: '255.255.255.0', gateway: '192.168.1.254')
+
+# Set IPv4 DNS servers
+client.set_ilo_ipv4_dns_servers(dns_servers: ['2.2.2.2', '4.4.4.4', '8.8.8.8'])
+
+# Set hostname and domain name 'server-ilo.domain.local'
+client.set_ilo_hostname(hostname: 'server-ilo', domain_name: 'domain.local')
+```
+
 #### Firmware
 
 ```ruby
@@ -398,7 +417,7 @@ client.eject_virtual_media(id)
 
 ## Custom requests
 
-This gem includes some usefull helper methods, but sometimes you need to make your own custom requests to the iLO.
+This gem includes some useful helper methods, but sometimes you need to make your own custom requests to the iLO.
 This project makes it extremely easy to do with some built-in methods for the client object. Here are some examples:
 
 ```ruby
@@ -412,11 +431,11 @@ data = client.response_handler(response)
 
 # For updating iLO resources, use patch:
 options = { ServiceName: 'iLO Admin', ServiceEmail: 'admin@domain.com' }
-response = rest_patch('/redfish/v1/Systems/1/bios/Settings/', body: options)
+response = client.rest_patch('/redfish/v1/Systems/1/bios/Settings/', body: options)
 
 # For creating new iLO resources, use post:
 options = { UserName: 'admin', Password: '123' }
-response = rest_post('/redfish/v1/AccountService/Accounts/', body: options)
+response = client.rest_post('/redfish/v1/AccountService/Accounts/', body: options)
 ```
 
 These example are about as basic as it gets, but you can make any type of iLO API request.
@@ -426,7 +445,7 @@ Please refer to the documentation and [code](lib/ilo-sdk/rest.rb) for complete l
 
 ## CLI
 
-This gem also comes with a command-line interface to make interracting with the iLO API without needing to create a Ruby program.
+This gem also comes with a command-line interface to make interacting with the iLO API possible without needing to create a Ruby program.
 
 Note: In order to use this, you will need to make sure your ruby bin directory is in your path. Run $ gem environment to see where the executable paths are for your Ruby installation.
 

data/lib/ilo-sdk/client.rb

@@ -81,5 +81,6 @@ module ILO_SDK
     include ChassisHelper
     include ServiceRootHelper
     include HttpsCertHelper
+    include EthernetInterfaceHelper
   end
 end

data/lib/ilo-sdk/helpers/ethernet_interface_helper.rb

@@ -0,0 +1,108 @@
+# (C) Copyright 2016 Hewlett Packard Enterprise Development LP
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# You may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed
+# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+# CONDITIONS OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the License.
+
+module ILO_SDK
+  # Contains helper methods for EthernetInterface IPv4 actions
+  module EthernetInterfaceHelper
+    # Get all the Ethernet Interface settings
+    # @param manager_id [Integer, String] ID of the Manager
+    # @param ethernet_interface [Integer, String] ID of the EthernetInterface
+    # @raise [RuntimeError] if the request failed
+    # @return [Hash] EthernetInterface settings
+    def get_ilo_ethernet_interface(manager_id: 1, ethernet_interface: 1)
+      response_handler(rest_get("/redfish/v1/Managers/#{manager_id}/EthernetInterfaces/#{ethernet_interface}/"))
+    end
+
+    # Set EthernetInterface to obtain IPv4 settings from DHCP
+    # @param manager_id [Integer, String] ID of the Manager
+    # @param ethernet_interface [Integer, String] ID of the EthernetInterface
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def set_ilo_ipv4_dhcp(manager_id: 1, ethernet_interface: 1)
+      new_action = {
+        'Oem' => {
+          'Hp' => {
+            'DHCPv4' => {
+              'Enabled' => true,
+              'UseDNSServers' => true,
+              'UseDomainName' => true,
+              'UseGateway' => true,
+              'UseNTPServers' => true,
+              'UseStaticRoutes' => true,
+              'UseWINSServers' => true
+            }
+          }
+        }
+      }
+      response = rest_patch("/redfish/v1/Managers/#{manager_id}/EthernetInterfaces/#{ethernet_interface}/", body: new_action)
+      response_handler(response)
+      true
+    end
+
+    # Set EthernetInterface to static IPv4 address
+    # @param ip [String] IPv4 address
+    # @param netmask [String] IPv4 subnet mask
+    # @param gateway [String] IPv4 default gateway
+    # @param manager_id [Integer, String] ID of the Manager
+    # @param ethernet_interface [Integer, String] ID of the EthernetInterface
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def set_ilo_ipv4_static(ip:, netmask:, gateway: '0.0.0.0', manager_id: 1, ethernet_interface: 1)
+      new_action = {
+        'Oem' => { 'Hp' => { 'DHCPv4' => { 'Enabled' => false } } },
+        'IPv4Addresses' => [
+          'Address' => ip, 'SubnetMask' => netmask, 'Gateway' => gateway
+        ]
+      }
+      response = rest_patch("/redfish/v1/Managers/#{manager_id}/EthernetInterfaces/#{ethernet_interface}/", body: new_action)
+      response_handler(response)
+      true
+    end
+
+    # Set EthernetInterface DNS servers
+    # @param dns_servers [Array] list of DNS servers
+    # @param manager_id [Integer, String] ID of the Manager
+    # @param ethernet_interface [Integer, String] ID of the EthernetInterface
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def set_ilo_ipv4_dns_servers(dns_servers:, manager_id: 1, ethernet_interface: 1)
+      new_action = {
+        'Oem' => {
+          'Hp' => {
+            'DHCPv4' => { 'UseDNSServers' => false },
+            'IPv4' => { 'DNSServers' => dns_servers }
+          }
+        }
+      }
+      response = rest_patch("/redfish/v1/Managers/#{manager_id}/EthernetInterfaces/#{ethernet_interface}/", body: new_action)
+      response_handler(response)
+      true
+    end
+
+    # Set iLO hostname and domain name
+    # @param hostname [String] iLO hostname
+    # @param domain_name [String] iLO domain name
+    # @param manager_id [Integer, String] ID of the Manager
+    # @param ethernet_interface [Integer, String] ID of the EthernetInterface
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def set_ilo_hostname(hostname:, domain_name: nil, manager_id: 1, ethernet_interface: 1)
+      new_action = { 'Oem' => { 'Hp' => { 'HostName' => hostname } } }
+      new_action['Oem']['Hp'].merge!('DHCPv4' => {}, 'DHCPv6' => {}) if domain_name
+      new_action['Oem']['Hp']['DHCPv4']['UseDomainName'] = false if domain_name
+      new_action['Oem']['Hp']['DHCPv6']['UseDomainName'] = false if domain_name
+      new_action['Oem']['Hp']['DomainName'] = domain_name if domain_name
+      response = rest_patch("/redfish/v1/Managers/#{manager_id}/EthernetInterfaces/#{ethernet_interface}/", body: new_action)
+      response_handler(response)
+      true
+    end
+  end
+end

data/lib/ilo-sdk/version.rb

@@ -11,5 +11,5 @@
 
 # Gem version defined here
 module ILO_SDK
-  VERSION = '1.2.2'.freeze
+  VERSION = '1.3.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ilo-sdk
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Anirudh Gupta
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-08 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -143,6 +143,7 @@ files:
 - lib/ilo-sdk/helpers/computer_details_helper.rb
 - lib/ilo-sdk/helpers/computer_system_helper.rb
 - lib/ilo-sdk/helpers/date_time_helper.rb
+- lib/ilo-sdk/helpers/ethernet_interface_helper.rb
 - lib/ilo-sdk/helpers/firmware_update.rb
 - lib/ilo-sdk/helpers/https_cert_helper.rb
 - lib/ilo-sdk/helpers/log_entry_helper.rb
@@ -175,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Gem to interact with iLO API