class Chef::Provider::Ifconfig

use the ifconfig resource to manage interfaces on *nix systems

@example set a static ip on eth1

ifconfig '33.33.33.80' do
  device 'eth1'
end

Attributes

config_path[RW]
config_template[RW]
ifconfig_version[RW]

@api private @return [String] the major.minor of the net-tools version as a string

Public Class Methods

new(new_resource, run_context) click to toggle source
Calls superclass method Chef::Provider::new
# File lib/chef/provider/ifconfig.rb, line 43
def initialize(new_resource, run_context)
  super(new_resource, run_context)
  @config_template = nil
  @config_path = nil
end

Public Instance Methods

can_generate_config?() click to toggle source
# File lib/chef/provider/ifconfig.rb, line 227
def can_generate_config?
  !@config_template.nil? && !@config_path.nil?
end
define_resource_requirements() click to toggle source
# File lib/chef/provider/ifconfig.rb, line 161
def define_resource_requirements
  requirements.assert(:all_actions) do |a|
    a.assertion { @status.exitstatus == 0 }
    a.failure_message Chef::Exceptions::Ifconfig, "ifconfig failed - #{@status.inspect}!"
    # no whyrun - if the base ifconfig used in load_current_resource fails
    # there's no reasonable action that could have been taken in the course of
    # a chef run to fix it.
  end
end
delete_config() click to toggle source
# File lib/chef/provider/ifconfig.rb, line 246
def delete_config
  return unless can_generate_config?

  config = resource_for_config(@config_path)
  config.run_action(:delete)
  new_resource.updated_by_last_action(true) if config.updated?
end
generate_config() click to toggle source
# File lib/chef/provider/ifconfig.rb, line 235
def generate_config
  return unless can_generate_config?

  b = binding
  template = ::ERB.new(@config_template, nil, "-")
  config = resource_for_config(@config_path)
  config.content(template.result(b))
  config.run_action(:create)
  new_resource.updated_by_last_action(true) if config.updated?
end
load_current_resource() click to toggle source
# File lib/chef/provider/ifconfig.rb, line 49
def load_current_resource
  @current_resource = Chef::Resource::Ifconfig.new(new_resource.name)

  @ifconfig_success = true
  @interfaces = {}

  @ifconfig_version = nil

  @net_tools_version = shell_out("ifconfig", "--version")
  @net_tools_version.stdout.each_line do |line|
    if /^net-tools (\d+\.\d+)/.match?(line)
      @ifconfig_version = line.match(/^net-tools (\d+\.\d+)/)[1]
    end
  end
  @net_tools_version.stderr.each_line do |line|
    if /^net-tools (\d+\.\d+)/.match?(line)
      @ifconfig_version = line.match(/^net-tools (\d+\.\d+)/)[1]
    end
  end

  if @ifconfig_version.nil?
    raise "net-tools not found - this is required for ifconfig"
  elsif @ifconfig_version.to_i < 2
    # Example output for 1.60 is as follows: (sanitized but format intact)
    # eth0      Link encap:Ethernet  HWaddr 00:00:00:00:00:00
    #           inet addr:192.168.1.1  Bcast:192.168.0.1  Mask:255.255.248.0
    #           inet6 addr: 0000::00:0000:0000:0000/64 Scope:Link
    #           UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
    #           RX packets:65158911 errors:0 dropped:0 overruns:0 frame:0
    #           TX packets:41723949 errors:0 dropped:0 overruns:0 carrier:0
    #           collisions:0 txqueuelen:1000
    #           RX bytes:42664658792 (39.7 GiB)  TX bytes:52722603938 (49.1 GiB)
    #           Interrupt:30
    @status = shell_out("ifconfig")
    @status.stdout.each_line do |line|
      if !line[0..9].strip.empty?
        @int_name = line[0..9].strip
        @interfaces[@int_name] = { "hwaddr" => (line =~ /(HWaddr)/ ? ($') : "nil").strip.chomp }
      else
        @interfaces[@int_name]["inet_addr"] = (line =~ /inet addr:(\S+)/ ? Regexp.last_match(1) : "nil") if /inet addr:/.match?(line)
        @interfaces[@int_name]["bcast"] = (line =~ /Bcast:(\S+)/ ? Regexp.last_match(1) : "nil") if /Bcast:/.match?(line)
        @interfaces[@int_name]["mask"] = (line =~ /Mask:(\S+)/ ? Regexp.last_match(1) : "nil") if /Mask:/.match?(line)
        @interfaces[@int_name]["mtu"] = (line =~ /MTU:(\S+)/ ? Regexp.last_match(1) : "nil") if /MTU:/.match?(line)
        @interfaces[@int_name]["metric"] = (line =~ /Metric:(\S+)/ ? Regexp.last_match(1) : "nil") if /Metric:/.match?(line)
      end

      next unless @interfaces.key?(new_resource.device)

      @interface = @interfaces.fetch(new_resource.device)

      current_resource.target(new_resource.target)
      current_resource.device(new_resource.device)
      current_resource.inet_addr(@interface["inet_addr"])
      current_resource.hwaddr(@interface["hwaddr"])
      current_resource.bcast(@interface["bcast"])
      current_resource.mask(@interface["mask"])
      current_resource.mtu(@interface["mtu"])
      current_resource.metric(@interface["metric"])
    end
  elsif @ifconfig_version.to_i >= 2
    # Example output for 2.10-alpha is as follows: (sanitized but format intact)
    # eth0: flags=4163<UP,BROADCAST,RUNNING,MULTICAST>  mtu 1500
    #       inet 192.168.1.1  netmask 255.255.240.0  broadcast 192.168.0.1
    #       inet6 0000::0000:000:0000:0000  prefixlen 64  scopeid 0x20<link>
    #       ether 00:00:00:00:00:00  txqueuelen 1000  (Ethernet)
    #       RX packets 2383836  bytes 1642630840 (1.5 GiB)
    #       RX errors 0  dropped 0  overruns 0  frame 0
    #       TX packets 1244218  bytes 977339327 (932.0 MiB)
    #       TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0
    #
    # Permalink for addr_regex : https://rubular.com/r/JrykUpfjRnYeQD
    @status = shell_out("ifconfig")
    @status.stdout.each_line do |line|
      addr_regex = /^((\w|-)+):?(\d*):?\ .+$/
      if line =~ addr_regex
        if line.match(addr_regex).nil?
          @int_name = "nil"
        elsif line.match(addr_regex)[3] == ""
          @int_name = line.match(addr_regex)[1]
          @interfaces[@int_name] = {}
          @interfaces[@int_name]["mtu"] = (line =~ /mtu (\S+)/ ? Regexp.last_match(1) : "nil") if line.include?("mtu") && @interfaces[@int_name]["mtu"].nil?
        else
          @int_name = "#{line.match(addr_regex)[1]}:#{line.match(addr_regex)[3]}"
          @interfaces[@int_name] = {}
          @interfaces[@int_name]["mtu"] = (line =~ /mtu (\S+)/ ? Regexp.last_match(1) : "nil") if line.include?("mtu") && @interfaces[@int_name]["mtu"].nil?
        end
      else
        @interfaces[@int_name]["inet_addr"] = (line =~ /inet (\S+)/ ? Regexp.last_match(1) : "nil") if line.include?("inet") && @interfaces[@int_name]["inet_addr"].nil?
        @interfaces[@int_name]["bcast"] = (line =~ /broadcast (\S+)/ ? Regexp.last_match(1) : "nil") if line.include?("broadcast") && @interfaces[@int_name]["bcast"].nil?
        @interfaces[@int_name]["mask"] = (line =~ /netmask (\S+)/ ? Regexp.last_match(1) : "nil") if line.include?("netmask") && @interfaces[@int_name]["mask"].nil?
        @interfaces[@int_name]["hwaddr"] = (line =~ /ether (\S+)/ ? Regexp.last_match(1) : "nil") if line.include?("ether") && @interfaces[@int_name]["hwaddr"].nil?
        @interfaces[@int_name]["metric"] = (line =~ /Metric:(\S+)/ ? Regexp.last_match(1) : "nil") if line.include?("Metric:") && @interfaces[@int_name]["metric"].nil?
      end

      next unless @interfaces.key?(new_resource.device)

      @interface = @interfaces.fetch(new_resource.device)

      current_resource.target(new_resource.target)
      current_resource.device(new_resource.device)
      current_resource.inet_addr(@interface["inet_addr"])
      current_resource.hwaddr(@interface["hwaddr"])
      current_resource.bcast(@interface["bcast"])
      current_resource.mask(@interface["mask"])
      current_resource.mtu(@interface["mtu"])
      current_resource.metric(@interface["metric"])
    end
  end

  current_resource
end
resource_for_config(path) click to toggle source
# File lib/chef/provider/ifconfig.rb, line 231
def resource_for_config(path)
  Chef::Resource::File.new(path, run_context)
end

Private Instance Methods

add_command() click to toggle source
# File lib/chef/provider/ifconfig.rb, line 256
def add_command
  command = [ "ifconfig", new_resource.device, new_resource.target ]
  command += [ "netmask", new_resource.mask ] if new_resource.mask
  command += [ "metric", new_resource.metric ] if new_resource.metric
  command += [ "mtu", new_resource.mtu ] if new_resource.mtu
  command
end
delete_command() click to toggle source
# File lib/chef/provider/ifconfig.rb, line 276
def delete_command
  [ "ifconfig", new_resource.device, "down" ]
end
disable_command() click to toggle source
# File lib/chef/provider/ifconfig.rb, line 272
def disable_command
  [ "ifconfig", new_resource.device, "down" ]
end
enable_command() click to toggle source
# File lib/chef/provider/ifconfig.rb, line 264
def enable_command
  command = [ "ifconfig", new_resource.device, new_resource.target ]
  command += [ "netmask", new_resource.mask ] if new_resource.mask
  command += [ "metric", new_resource.metric ] if new_resource.metric
  command += [ "mtu", new_resource.mtu ] if new_resource.mtu
  command
end
loopback_device() click to toggle source
# File lib/chef/provider/ifconfig.rb, line 280
def loopback_device
  "lo"
end