cookbook 'ilo', '= 1.3.0'
ilo (6) Versions 1.3.0 Follow7
Configure HPE iLO
cookbook 'ilo', '= 1.3.0', :supermarket
knife supermarket install ilo
knife supermarket download ilo
iLO Cookbook
Enables configuration of HPE iLOs via their APIs.
Requirements
- Chef 12+
- iLO 4
Cookbook Dependencies
- compat_resource
How to use the iLO Cookbook:
This cookbook is not intended to include any recipes.
Use it by specifying a dependency on this cookbook in your own cookbook.
# my_cookbook/metadata.rb ... depends 'ilo'
Now you can use the resources this cookbook provides. See below for some examples.
iLO Authentication
Each of the resources below requires you to pass in the info necessary to connect with the iLO API.
The basic structure accepted by the ilos
property is an array of hashes (or ILO_SDK::Client
objects):
ilos = [ { host: 'ilo1.example.com', # Required. IP or hostname user: 'Administrator', # Optional. Defaults to 'Administrator' password: 'secret123', # Required ssl_enabled: false # Optional }, { host: '10.0.0.3', user: 'User2', password: 'secret456' } ]
This array can be built using a variety of different sources, including [encrypted] databags, attributes, or read from json or yaml files.
For example:
# Set directly in recipe: ilo_list1 = [] ilo_list1.push { host: 'ilo1.example.com', user: 'Administrator', password: 'secret123' } # Read from data_bag: ilo_list2 = data_bag_item('ilo_secrets', 'data_center_1') # Load from yaml file: ilo_list3 = YAML.load_file('/root/ilo_secrets.yml')
iLO Resources
The following resources are available for usage in your recipes:
ilo_bios
- Set BIOS configuration:
ilo_bios 'set BIOS configuration' do ilos [ilo1, ilo2] settings( UefiShellStartup: 'Enabled', UefiShellStartupLocation: 'Auto', UefiShellStartupUrl: 'http://www.uefi.nsh', Dhcpv4: 'Enabled', Ipv4Address: '10.1.1.0', Ipv4Gateway: '10.1.1.11', Ipv4PrimaryDNS: '10.1.1.1', Ipv4SecondaryDNS: '10.1.1.2', Ipv4SubnetMask: '255.255.255.0', UrlBootFile: 'http://www.urlbootfile.iso', ServiceName: 'iLO Admin', ServiceEmail: 'admin@domain.com' # NOTE: This is just an example; you can set as many or as few settings as you want. # (And there's a whole lot more you can set. See the API docs for the complete list.) ) action :set # Not necessary, as this is the default end
- Revert to default BIOS base configuration:
ilo_bios 'revert BIOS' do ilos [ilo1, ilo2] action :revert end
ilo_boot_settings
Revert to default Boot base configuration:
Set boot configuration:
ilo_boot_settings 'set boot configuration' do ilos [ilo1, ilo2] boot_order [ "FD.Virtual.1.1", "Generic.USB.1.1", "HD.Emb.1.1", "HD.Emb.1.2", "NIC.LOM.1.1.IPv4", "NIC.LOM.1.1.IPv6" ] boot_target 'None' action :set # Not necessary, as this is the default end
ilo_boot_settings 'revert boot' do ilos [ilo1, ilo2] action :revert end
- Dump the boot configuration to a file:
ilo_boot_settings 'dump boot configuration' do ilos [ilo1, ilo2] dump_file '/full/path/to/boot_settings.yml' owner 'JohnDoe' group 'Administrators' action :dump end
ilo_chassis
- Dump power metrics and thermal metrics information to a file:
ilo_chassis 'dump power metrics and thermal metrics' do ilos [ilo1, ilo2] power_metrics_file '/full/path/to/power_metrics.yml' thermal_metrics_file '/full/path/to/thermal_metrics.yml' owner 'JohnDoe' group 'Administrators' action :dump end
ilo_computer_details
- Dump computer details to a file and data bag:
ilo_computer_details 'dump computer details' do ilos [ilo1, ilo2] dump_file '/full/path/to/computer_details.yml' data_bag 'computer_details_bag' owner 'JohnDoe' group 'Administrators' action :dump end
ilo_computer_system
- Set computer system information:
ilo_computer_system 'set computer system info' do ilos [ilo1, ilo2] asset_tag 'HPE001' led_state 'Lit' action :set end
ilo_date_time
- Set the time zone:
ilo_date_time 'set time zone' do ilos [ilo1, ilo2] time_zone 'Africa/Abidjan' action :set # Not necessary, as this is the default end
- Set whether or not to use NTP:
ilo_date_time 'use NTP' do ilos [ilo1, ilo2] use_ntp true action :set_ntp end
- Set the NTP servers:
ilo_date_time 'set NTP servers' do ilos [ilo1, ilo2] ntp_servers [ "10.168.0.2", "10.168.0.3" ] action :set_ntp_servers end
ilo_firmware_update
- Upgrade firmware:
ilo_firmware_update 'upgrade firmware' do ilos [ilo1, ilo2] fw_version '2.5' fw_uri 'www.firmwareuri.com' action :upgrade end
ilo_https_cert
- Generate Certificate Signing Request (CSR):
ilo_https_cert 'generate CSR' do ilo ilo1 country 'USA' state 'Texas' city 'Houston' orgName 'Example Company' orgUnit 'Example' commonName 'example.com' action :generate_csr end
- Dump CSR to a file:
ilo_https_cert 'dump CSR to file' do ilo ilo1 file_path '/c/CSR.cert' action :dump_csr end
- Import certificate:
ilo_https_cert 'import certificate' do ilo ilo1 certificate '-----BEGIN CERTIFICATE----- SecretCertificateContent -----END CERTIFICATE-----' action :import end
- Import certificate from file:
ilo_https_cert 'import certificate from file' do ilo ilo1 file_path '/c/certificate_file.cert' action :import end
- Complete HTTPS Certificate Replacement Example
require 'ilo-sdk' ilo1 = ILO_SDK::Client.new( host: 'ilo1.example.com', user: 'Administrator', password: 'secret123' ) # Get the current SSL Certificate and check to see if expires within 24 hours expiration = ilo1.get_certificate.not_after.to_datetime tomorrow = DateTime.now + 1 valid = expiration > tomorrow ilo_https_cert 'generate CSR' do ilo ilo1 country 'USA' state 'Texas' city 'Houston' orgName 'Example Company' orgUnit 'Example' commonName 'example.com' action :generate_csr not_if { valid || ilo1.get_csr } # Only generate if the cert is expiring soon and the CSR has not already been generated end ilo_https_cert 'dump CSR to file' do ilo ilo1 file_path '~/certs/CSR.cert' action :get_csr not_if { valid || ilo1.get_csr.nil? } end # Here you'll need to have a step that submits the CSR to a certificate authority # (or self-signs it) and gets back the signed certificate. It will look something like: # -----BEGIN CERTIFICATE----- # lines_of_secret_text # -----END CERTIFICATE----- # For this example, we're assuming we've read in the content of the certificate to the # "cert" variable (as a string). ilo_https_cert 'import certificate' do ilo ilo1 certificate cert action :import not_if { valid || cert.nil? } end
ilo_log_entry
- Dump log entries to a file:
ilo_log_entry 'dump log entries' do ilos [ilo1, ilo2] log_type 'IEL' dump_file 'IEL_logs.txt' owner 'JohnDoe' group 'Administrators' duration 30 # up to hours back from now action :dump # Not necessary, as this is the default end
- Clear log entries:
ilo_log_entry 'clear log entries' do ilos [ilo1, ilo2] log_type 'IEL' action :clear end
ilo_manager_network_protocol
- Set ilo session timeout:
ilo_manager_network_protocol 'set timeout' do ilos [ilo1, ilo2] timeout 60 # minutes action :set end
ilo_power
- Power on the system:
ilo_power 'power on' do ilos [ilo1, ilo2] action :poweron # Not necessary, as this is the default end
- Power off the system:
ilo_power 'power off' do ilos [ilo1, ilo2] action :poweroff end
- Reset the system:
ilo_power 'reset system' do ilos [ilo1, ilo2] action :resetsys end
- Reset ilo:
ilo_power 'reset ilo' do ilos [ilo1, ilo2] action :resetilo end
ilo_secure_boot
- Set whether or not to enable UEFI secure boot:
ilo_secure_boot 'enable secure boot' do ilos [ilo1, ilo2] enable true action :set end
ilo_service_root
- Dump schema and registry information to a file:
ilo_service_root 'dump schema and registry' do ilos [ilo1, ilo2] schema_prefix 'Account' schema_file 'schema.txt' registry_prefix 'Base' registry_file 'registry.txt' owner 'JohnDoe' group 'Administrators' action :dump end
ilo_snmp_service
- Configure SNMP service:
ilo_snmp_service 'set snmp mode and turn alerts on' do ilos [ilo1, ilo2] snmp_mode 'Agentless' snmp_alerts true action :configure end
ilo_user
- Create or modify user:
ilo_user 'creater user' do ilos [ilo1, ilo2] username 'test' password 'password123' login_priv true remote_console_priv false user_config_priv true virtual_media_priv false virtual_power_and_reset_priv true ilo_config_priv false action :create end
- Delete user:
ilo_user 'delete user' do ilos [ilo1, ilo2] username 'test' action :delete end
ilo_virtual_media
- Insert virtual media:
ilo_virtual_media 'insert virtual media' do ilos [ilo1, ilo2] iso_uri 'http://10.254.224.38:5000/ubuntu-15.04-desktop-amd64.iso' action :insert # Not necessary, as this is the default end
- Eject virtual media:
ilo_virtual_media 'eject virtual media' do ilos [ilo1, ilo2] action :eject end
Contributing & Feature Requests
Contributing: Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more info.
Feature Requests: If you have a need that is not met by the current implementation, please let us know (via a new issue).
This feedback is crucial for us to deliver a useful product. Do not assume we have already thought of everything, because we assure you that is not the case.
License
This project is licensed under the Apache 2.0 license. Please see [LICENSE](LICENSE) for more info.
Testing
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more info.
Authors
- Anirudh Gupta - @Anirudh-Gupta
- Bik Bajwa - @bikbajwa
- Jared Smartt - @jsmartt
- Vivek Bhatia - @vivekbhatia14
Dependent cookbooks
compat_resource >= 0.0.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
1.3.0
- Refactored ilo_bios resource to support all settings. (Breaking Change)
1.2.0
- Moved resources into libraries
- Added ilo_https_cert resource
1.0.1
- Updated metadata.rb file
1.0.0
Initial release
Collaborator Number Metric
1.3.0 passed this metric
Foodcritic Metric
1.3.0 failed this metric
FC023: Prefer conditional attributes: /tmp/7a5892f2d88cea1b05fc9d82/ilo/libraries/chassis.rb:35
FC023: Prefer conditional attributes: /tmp/7a5892f2d88cea1b05fc9d82/ilo/libraries/chassis.rb:42
FC023: Prefer conditional attributes: /tmp/7a5892f2d88cea1b05fc9d82/ilo/libraries/computer_details.rb:34
FC023: Prefer conditional attributes: /tmp/7a5892f2d88cea1b05fc9d82/ilo/libraries/computer_system.rb:30
FC023: Prefer conditional attributes: /tmp/7a5892f2d88cea1b05fc9d82/ilo/libraries/computer_system.rb:35
FC023: Prefer conditional attributes: /tmp/7a5892f2d88cea1b05fc9d82/ilo/libraries/service_root.rb:40
FC023: Prefer conditional attributes: /tmp/7a5892f2d88cea1b05fc9d82/ilo/libraries/service_root.rb:47
FC023: Prefer conditional attributes: /tmp/7a5892f2d88cea1b05fc9d82/ilo/libraries/user.rb:44
1.3.0 passed this metric
1.3.0 failed this metric
FC023: Prefer conditional attributes: /tmp/7a5892f2d88cea1b05fc9d82/ilo/libraries/chassis.rb:35
FC023: Prefer conditional attributes: /tmp/7a5892f2d88cea1b05fc9d82/ilo/libraries/chassis.rb:42
FC023: Prefer conditional attributes: /tmp/7a5892f2d88cea1b05fc9d82/ilo/libraries/computer_details.rb:34
FC023: Prefer conditional attributes: /tmp/7a5892f2d88cea1b05fc9d82/ilo/libraries/computer_system.rb:30
FC023: Prefer conditional attributes: /tmp/7a5892f2d88cea1b05fc9d82/ilo/libraries/computer_system.rb:35
FC023: Prefer conditional attributes: /tmp/7a5892f2d88cea1b05fc9d82/ilo/libraries/service_root.rb:40
FC023: Prefer conditional attributes: /tmp/7a5892f2d88cea1b05fc9d82/ilo/libraries/service_root.rb:47
FC023: Prefer conditional attributes: /tmp/7a5892f2d88cea1b05fc9d82/ilo/libraries/user.rb:44