interfaces_controller.rb

require_dependency File.join(Rails.root, "app/models/nic/base")

module Api
  module V2
    class InterfacesController < V2::BaseController
      include Api::Version2
      include Foreman::Controller::Parameters::NicInterface

      before_action :find_required_nested_object, :only => [:index, :show, :create, :destroy]
      before_action :find_resource, :only => [:show, :update, :destroy]
      before_action :convert_type, :only => [:create, :update]

      api :GET, '/hosts/:host_id/interfaces', N_("List all interfaces for host")
      api :GET, '/domains/:domain_id/interfaces', N_('List all interfaces for domain')
      api :GET, '/subnets/:subnet_id/interfaces', N_('List all interfaces for subnet')
      param :host_id, String, :required => true, :desc => N_("ID or name of host")
      param :domain_id, String, :required => false, :desc => N_('ID or name of domain')
      param :subnet_id, String, :required => false, :desc => N_('ID or name of subnet')
      param_group :pagination, ::Api::V2::BaseController

      def index
        @interfaces = resource_scope_for_index
      end

      api :GET, '/hosts/:host_id/interfaces/:id', N_("Show an interface for host")
      param :host_id, String, :required => true, :desc => N_("ID or name of host")
      param :id, String, :required => true, :desc => N_("ID or name of interface")

      def show
      end

      def_param_group :interface_attributes do
        # common parameters
        param :mac, String, :desc => N_("MAC address of interface. Required for managed interfaces on bare metal.")
        param :ip, String, :desc => N_("IPv4 address of interface")
        param :ip6, String, :desc => N_("IPv6 address of interface")
        param :type, InterfaceTypeMapper::ALLOWED_TYPE_NAMES, :desc => N_("Interface type, e.g. bmc. Default is %{default_nic_type}")
        param :name, String, :desc => N_("Interface's DNS name")
        param :subnet_id, :number, :desc => N_("Foreman subnet ID of IPv4 interface")
        param :subnet6_id, :number, :desc => N_("Foreman subnet ID of IPv6 interface")
        param :domain_id, :number, :desc => N_("Foreman domain ID of interface. Required for primary interfaces on managed hosts.")
        param :identifier, String, :desc => N_("Device identifier, e.g. eth0 or eth1.1")
        param :managed, :bool, :desc => N_("Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?")
        param :primary, :bool, :desc => N_("Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.")
        param :provision, :bool, :desc => N_("Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.")
        # bmc specific parameters
        param :username, String, :desc => N_("Only for BMC interfaces.")
        param :password, String, :desc => N_("Only for BMC interfaces.")
        param :provider, Nic::BMC::PROVIDERS, :desc => N_("Interface provider, e.g. IPMI. Only for BMC interfaces.")
        # virtual device specific parameters
        param :virtual, :bool, :desc => N_("Alias or VLAN device")
        param :tag, String, :desc => N_("VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.")
        param :mtu, Integer, :desc => N_("MTU, this attribute has precedence over the subnet MTU.")
        param :attached_to, String, :desc => N_("Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.")
        # bond specific parameters
        param :mode, Nic::Bond::MODES, :desc => N_("Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.")
        param :attached_devices, Array, :desc => N_("Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.")
        param :bond_options, String, :desc => N_("Space separated options, e.g. miimon=100. Only for bond interfaces.")
        # compute specific attributes
        param :compute_attributes, Hash, :desc => N_("Additional compute resource specific attributes for the interface.")
      end

      def_param_group :interface do
        param :interface, Hash, :required => true, :action_aware => true, :desc => N_("interface information") do
          param_group :interface_attributes
        end
      end

      api :POST, '/hosts/:host_id/interfaces', N_("Create an interface on a host")
      param :host_id, String, :required => true, :desc => N_("ID or name of host")
      param_group :interface, :as => :create

      def create
        @interface = @nested_obj.interfaces.new(nic_interface_params)
        process_response @interface.save
      end

      api :PUT, "/hosts/:host_id/interfaces/:id", N_("Update a host's interface")
      param :host_id, String, :required => true, :desc => N_("ID or name of host")
      param :id, :identifier, :required => true, :desc => N_("ID of interface")
      param_group :interface

      def update
        process_response @interface.update(nic_interface_params)
      end

      api :DELETE, "/hosts/:host_id/interfaces/:id", N_("Delete a host's interface")
      param :host_id, String, :required => true, :desc => N_('ID or name of host')
      param :id, String, :required => true, :desc => N_("ID of interface")

      def destroy
        process_response @interface.destroy
      end

      private

      def allowed_nested_id
        %w(host_id domain_id subnet_id)
      end

      def resource_class
        Nic::Base
      end

      def convert_type
        if params[:action] != 'update' || params[:interface].has_key?(:type)
          params[:interface][:type] = InterfaceTypeMapper.map(params[:interface][:type])
        end
      rescue InterfaceTypeMapper::UnknownTypeException => e
        render_error :custom_error, :status => :unprocessable_entity, :locals => { :message => e.to_s }
      end
    end
  end
end