Provision hosts using restful API

Dave_Johnston1 · October 8, 2014, 6:30am

Hi,

I have setup foreman and enabled the auto discovery plugin. When I network boot nodes they appear in the 'Discovered Hosts' group and I can manually provision them.

Is it possible to use the restful API to automatically provision hosts? I had a look through the API and couldn't find any methods, but hopefully I missed something?

My intention is to automatically provision a large group of machines (20-30) and automatically configure them for different roles and start the process, without having to click the provision button for each individual host.

Cheers

Dave Johnston

Xavier_Naveira · October 8, 2014, 7:30am

Hi Dave,

If you're ok with using python you might want to take a look to the
foreman-host-builder script that we're using on top of the python-foreman
wrapper:

Cheers,

Xavier

···

On Wed, Oct 8, 2014 at 8:30 AM, Dave Johnston wrote:

Hi,

I have setup foreman and enabled the auto discovery plugin. When I
network boot nodes they appear in the ‘Discovered Hosts’ group and I can
manually provision them.

Is it possible to use the restful API to automatically provision hosts?
I had a look through the API and couldn’t find any methods, but hopefully I
missed something?

My intention is to automatically provision a large group of machines
(20-30) and automatically configure them for different roles and start the
process, without having to click the provision button for each individual
host.

Cheers

Dave Johnston

–
You received this message because you are subscribed to the Google Groups
“Foreman users” group.
To unsubscribe from this group and stop receiving emails from it, send an
email to foreman-users+unsubscribe@googlegroups.com.
To post to this group, send email to foreman-users@googlegroups.com.
Visit this group at http://groups.google.com/group/foreman-users.
For more options, visit https://groups.google.com/d/optout.

Dominic_Cleal · October 8, 2014, 10:51am

I think foreman_discovery 1.3 and higher has an API which you could use.

Try hitting /api/v2/discovered_hosts to pull back a list, and then if
you PUT to /api/v2/discovered_hosts/$ID then it should provision it.

There's a list of parameters here:

github.com

theforeman/foreman_discovery/blob/develop/app/controllers/api/v2/discovered_hosts_controller.rb#L46


    param :mac, String, :required => true
    param :pxe_loader, Operatingsystem.all_loaders, :desc => N_("DHCP filename option (Grub2 or PXELinux by default)")
  end
end


api :POST, "/discovered_hosts/", N_("Create a discovered host for testing (use /facts to create new hosts)")
param_group :discovered_host, :as => :create


def create
  @discovered_host = Host::Discovered.new(discovered_host_params)
  @discovered_host.suggest_default_pxe_loader if params[:discovered_host] && params[:discovered_host][:pxe_loader].nil?
  process_response @discovered_host.save
end


api :PUT, "/discovered_hosts/:id/", N_("Provision a discovered host")
param :id, :identifier, :required => true
param :discovered_host, Hash, :action_aware => true do
  param :name, String
  param :environment_id, String
  param :ip, String, :desc => N_("not required if using a subnet with DHCP proxy")
  param :mac, String, :desc => N_("not required if it's a virtual machine")

But in theory it should also show up in /apidoc/ on the server, but it
doesn't seem to work here.

···

On 08/10/14 07:30, Dave Johnston wrote: > Hi, > > > I have setup foreman and enabled the auto discovery plugin. When I > network boot nodes they appear in the 'Discovered Hosts' group and I can > manually provision them. > > > Is it possible to use the restful API to automatically provision hosts? > I had a look through the API and couldn't find any methods, but > hopefully I missed something?

–
Dominic Cleal
Red Hat Engineering