Project

General

Profile

API » History » Version 36

Lukas Zapletal, 02/18/2016 11:30 AM
Added logs endpoint

1 1 Ohad Levy
h1. API
2
3 20 Stephen Benjamin
Foreman Smart Proxy provides a "REST":http://en.wikipedia.org/wiki/Representational_State_Transfer API, communicating via JSON.  For providers that take POST requests, some take form parameters as inputs (var=1&var=2), others may take JSON. Please refer to this document for latest information about Foreman Smart Proxy API.
4 1 Ohad Levy
5 10 Paul Kelly
_The API entries containing *variant* are only available in smart-proxy v2.0 and later._
6 1 Ohad Levy
7
h2. List of API's
8
9 20 Stephen Benjamin
|_.Path|_.REST Type|_.Description|_.Example Input |  
10
|
11 1 Ohad Levy
|_.FEATURES |
12
|/features|GET|List of features supported by the proxy||
13 9 Ohad Levy
|/version|GET|Proxy version||
14 1 Ohad Levy
|_.DHCP |
15
|/dhcp|GET|Retrieve a list of subnets||
16
|/dhcp/10.1.2.0|GET|Retrieve 10.1.2.0 subnets records||
17
|/dhcp/10.1.2.0/10.1.2.5|GET|Retrieve 10.1.2.5 reservation information ||
18
|/dhcp/10.1.2.0/unused_ip|GET|Provides an unused ip address in 10.1.2.0 subnet ||
19 33 Klaas D
|/dhcp/10.1.2.0|POST|creates new reservation in 10.1.2.0 subnet |@{"hostname":string, "name":string, "filename":string, "ip":string, "nextServer":string, "mac":string}@|
20 1 Ohad Levy
|/dhcp/10.1.2.0/10.1.2.5|DELETE|Deletes 10.1.2.5 reservation from 10.1.2.0 subnet||
21
|_.DNS |
22 20 Stephen Benjamin
|/dns/|POST|Create a new DNS record|@fqdn=hostname.example.com&value=192.168.1.1&type=A@|
23 1 Ohad Levy
|/dns/value|DELETE|remove value(ip or reverse) DNS record||
24
|_.TFTP |
25 10 Paul Kelly
|/tftp/00:11:22:33:44:55|POST|creates pxelinux configuration file for host with MAC address 00:11:22:33:44:55|@{"syslinux_config":string}@. Implicit variant of "syslinux"|
26
|/tftp/<variant>/00:11:22:33:44:55|POST|creates pxeconfig configuration file for host with MAC address 00:11:22:33:44:55|@{"pxeconfig":string}@. Variant can be "syslinux" or "pxegrub"|
27
|/tftp/00:11:22:33:44:55|DELETE|remove pxelinux configuration file for host with MAC address 00:11:22:33:44:55|Implicit variant of "syslinux"|
28
|/tftp/<variant>/00:11:22:33:44:55|DELETE|remove pxeconfig configuration file for host with MAC address 00:11:22:33:44:55|. Variant can be "syslinux" or "pxegrub"|
29
|/tftp/create_default|POST|creates a default pxelinux configuration file|@{"syslinux_config":string}@. Implicit variant of "syslinux" |
30
|/tftp/<variant>/create_default|POST|creates a default pxeconfig configuration file|@{"pxeconfig":string}@. Variant can be "syslinux" or "pxegrub"|
31 5 Frank Sweetser
|/tftp/fetch_boot_file|POST|creates a default pxelinux configuration file|@{"prefix":string, "path":string}@|
32 8 Ohad Levy
|/tftp/serverName|GET|fetches the TFTP server name to be used within a dhcp record||
33 1 Ohad Levy
|_.PUPPET CA |
34
|/puppet/ca|GET| list of all puppet certificates ||
35 7 Ohad Levy
|/puppet/ca/certname|POST| Sign pending certificate request ||
36
|/puppet/ca/certname|DELETE| Remove (clean) and revoke a certificate ||
37 1 Ohad Levy
|/puppet/ca/autosign|GET| list of all puppet autosign entires ||
38
|/puppet/ca/autosign/certname|POST| Add certname to Puppet autosign ||
39
|/puppet/ca/autosign/certname|DELETE| Remove certname from Puppet autosign ||
40
|_.PUPPET |
41 5 Frank Sweetser
|/puppet/run|POST| Trigger puppet run / kick|@["hostA", "hostB"]@|
42 12 Ohad Levy
|/puppet/environments |GET| list of all puppet environment names||
43
|/puppet/environments/production> |GET| show puppet production environment name and module paths||
44 13 Ohad Levy
|/puppet/environments/production/classes |GET| return a hash of puppet classes in the production environment|Puppet class parameters is supported from 1.1|
45 15 Corey Osman
|_.BMC |
46 16 Corey Osman
|/bmc/providers|GET|Get a list of supported BMC providers||
47
|/bmc/providers/installed|GET|Get a list of installed BMC providers||
48
|/bmc/:host|GET|returns host operations||
49
|/bmc/:host/chassis|GET|returns chassis operations||
50 19 Daniel Lobato Garcia
|/bmc/:host/chassis/power/:action|GET|Gets the power status, does not change power, leave action blank for list of available actions||
51 18 Corey Osman
|/bmc/:host/lan/:action|GET|Get bmc lan details, leave action blank for list of available actions||
52 1 Ohad Levy
|/bmc/:host/chassis/identify/:action|GET|gets chassis identify status, leave action blank for list of available actions||
53
|/bmc/:host/chassis/config/:function|GET|Get chassis config details, supports bootdevices, leave function blank for list of available functions||
54
|/bmc/:host/chassis/power/:action|PUT|Control the power of the bmc device, leave action blank for list of available functions| valid actions: on, off, cycle, soft|
55
|/bmc/:host/chassis/config/:function/:action|PUT|Set config of bios, currently supports bootdevice|valid actions: pxe, cdrom, bios, disk   valid options: reboot, persistent|
56 16 Corey Osman
|/bmc/:host/chassis/identify/:action|PUT|controls the chassis identify light, leave action blank for available actions| actions: on, off|
57 20 Stephen Benjamin
|_.REALM |
58
| /realm/:realm | POST | Creates/Updates new realm entry. "Userclass" is an arbitrary data field.  Used by FreeIPA provider for automembership, and foreman passes the host group title. | @hostname=host.example.com&userclass=webservers@ |
59
| /realm/:realm | POST | Recreate realm entry (revokes keytab, etc) | @hostname=host.example.com&userclass=webservers&rebuild=true@ |
60
| /realm/:realm/:hostname | DELETE | Deletes new realm entry ||
61 36 Lukas Zapletal
|_.LOGS |
62
| /logs/ | GET | Returns proxy log buffer (last N log records) | @{"info": {}, "logs": [{ "timestamp": 1455783010.8100047, "level": "ERROR", "message": "...", "backtrace": "..." }]}@ |
63 1 Ohad Levy
64
Please raise a new issue if you need additional API's
65 4 Frank Sweetser
66
h2. Manually Calling the API
67
68
The API can be manually tested out using curl.  GET types can be retrieved like any other URL.  This one, for example, will return the HTML formatted page with the list of features enabled on the proxy.
69
70 1 Ohad Levy
<pre>
71
curl http://localhost:8443/features
72
</pre>
73
74 14 Michael Coulter
The results can also be returned as JSON if you set an appropriate Accept header.
75
76
<pre>
77
curl -H "Accept: application/json" http://localhost:8443/features
78
</pre>
79
80 1 Ohad Levy
POST URLs, used to create objects or trigger actions, need to have the parameters passed in via the -d argument.  This curl command line will trigger a puppetrun on server.example.com.
81
<pre>
82
curl -d 'nodes=server.example.com' http://localhost:8443/puppet/run
83 11 Michael Coulter
</pre>
84
85
This curl command line will add an A record for server.example.com with ip address of 10.1.2.5.
86
<pre>
87
curl -d 'fqdn=servers.example.com&value=10.1.2.5&type=A' http://localhost:8443/dns/
88 5 Frank Sweetser
</pre>
89
90 22 Johan Sunnerstig
This curl command line will remove the A record added above.
91
<pre>
92
curl -XDELETE http://localhost:8443/dns/servers.example.com
93
</pre>
94
95 5 Frank Sweetser
Multiple post options may be specified by repeating the -d argument.
96
<pre>
97
curl -d 'prefix=boot/CentOS-5-x86_64' -d 'path=http://yourlocalmirrorhere/pub/centos/5/os/x86_64/images/pxeboot/vmlinuz'  http://localhost:8443/tftp/fetch_boot_file
98
</pre>
99
100
When you are creating an object, the identifier for the object is typically passed in as part of the URL, rather than as a POST value.  For example, this will create a PXE boot configuration file for a host with MAC address 00:11:22:33:44:55, and will just put "Hello World" as the contents of the file.  (A real world example would, of course, substitute a valid PXE boot configuration in the string.)
101
102
<pre>
103
curl -d 'syslinux_config=Hello World' http://localhost:8443/tftp/00:11:22:33:44:55
104
</pre>
105
106
In order to delete objects, you use the same URL as in the original creation, but pass it not POST values, and use the DELETE HTTP method instead of POST.  This will delete the PXE boot configuration file created above.
107
108
<pre>
109 1 Ohad Levy
curl -X DELETE http://localhost:8443/tftp/00:11:22:33:44:55
110
</pre>
111 16 Corey Osman
112
h2. BMC Controls 
113
114
Summary
115
The smart-proxy can now control BMC devices through the use of the IPMI protocol.  The smart proxy utilizes ipmitool and freeipmi to control your BMC devices through the network.  
116
117
h3. Prerequisites
118
119
In order to control the BMC device using the smart proxy you must perform the following actions:
120
121
1. Enable bmc support in the settings.yml file
122
2. Install rubyipmi gem, 
123
3. Install freeipmi, and/or ipmitool either from source or package
124
4. The bmc device must be setup on the network with login credentials
125
5. Smart proxy must be able to reach the bmc device through the network
126
127
h3. Using Parameters with the BMC API
128
129
1. When using the bmc api, you must send the credentials of the bmc device using Http Basic Authorization
130
2. If you wish to override the default bmc provider for a particular BMC device please specify in the http parameter (bmc_provider) Valid options are ipmitool and freeipmi
131
3. Some api calls have optional parameters, leaving the action blank on some api calls will return valid actions and options.
132
133 17 Corey Osman
h3. BMC Security
134 16 Corey Osman
135
Its important to note that at this time the bmc api does not encrypt your credentials.  Your credentials are sent in the clear to the smart proxy and then used on the command line to execute the local command.
136
In order to achieve some level of security it is important that your smart proxy use https.  Using https will ensure that your credentials are sent via the encrypted https channel.  Additionally, by default the bmc api 
137
will never expose your credentials to prying eyes via logs or process checks.  The local bmc commands will be run with the credentials placed in a random file which is deleted upon every call and cannot be opened
138
by any other user.
139 6 Brian Gupta
140 23 Corey Osman
h3. Examples
141
142
returns boolean if the power is off  (Note this only occurs when using GET
143
<pre>
144
curl -vks --data 'bmc_provider=freeipmi' 'http://127.0.0.1:8443/bmc/192.168.1.16/chassis/power/off' -X GET -u admin:password  => {"action":"off","result":true}
145
</pre>
146
147
returns status when the power is turned off  (Note this only occurs when using PUT)
148
<pre>
149 34 Alexander Charykov
curl -vks --cacert /var/lib/puppet/ssl/certs/ca.pem --cert /var/lib/puppet/ssl/certs/`hostname -f`.pem --key /var/lib/puppet/ssl/private_keys/`hostname -f`.pem \
150 35 Alexander Charykov
     --data 'bmc_provider=freeipmi' 'https://127.0.0.1:8443/bmc/192.168.1.16/chassis/power/off' -X PUT -u admin:password  => {"action":"off","result":"192.168.1.16: ok\n"}
151 23 Corey Osman
</pre>
152
153
if you can't remember the basic bmc api actions you just leave things blank and the proxy will try to help you out.
154
<pre>
155
curl -vks --data 'bmc_provider=freeipmi' 'http://127.0.0.1:8443/bmc/192.168.1.16/chassis' -X GET -u admin:password => {"actions":["power","identify","config"]}
156
</pre>
157
158 24 Corey Osman
h4. Troubleshooting
159 28 Corey Osman
160 27 Corey Osman
In these examples you will notice that I have turned off SSL which you should never do in a production environment, but this is a short lived development machine.
161 29 Corey Osman
If you have some weird BMC issue you can have a look at the log if your using the latest smart proxy >= 1.9.  Starting with Rubyipmi 0.9.0 it will now generate a log with all the commands and responses it runs.
162 24 Corey Osman
<pre>
163
curl -vks --data 'bmc_provider=freeipmi' 'http://127.0.0.1:8443/bmc/192.168.1.16/chassis/power/off' -X GET -u admin:password  => {"action":"off","result":true}
164
D, [2015-03-10T16:12:57.328430 #68510] DEBUG -- : /usr/local/sbin/ipmipower --hostname=192.168.1.16   --stat --config-file=/var/folders/h6/v6nv76td37s7vqj902_z59kh0000gn/T/20150310-68510-w3rw89
165
D, [2015-03-10T16:12:57.694174 #68510] DEBUG -- : "/usr/local/sbin/ipmipower --hostname=192.168.1.16   --stat --config-file=/var/folders/h6/v6nv76td37s7vqj902_z59kh0000gn/T/20150310-68510-w3rw89 --driver-type=LAN_2_0"
166
D, [2015-03-10T16:12:57.694256 #68510] DEBUG -- : 192.168.1.16: off
167
</pre>
168
169 27 Corey Osman
If you just want to test your connection to see if your BMC device works with the provided information you can now use one of the new API commands named "test".  What this is doing in the background is running a bmc info command and if that
170
command fails it returns false.  You can view the logs to see why it failed. In a later release we will detail what caused the test to fail.
171 24 Corey Osman
<pre>
172 27 Corey Osman
# good password
173
curl -vks --data 'bmc_provider=freeipmi' 'http://127.0.0.1:8443/bmc/192.168.1.16/test' -X GET -u admin:password
174
{"action":"test","result":true}
175
#  bad password
176
curl -vks --data 'bmc_provider=freeipmi' 'http://127.0.0.1:8443/bmc/192.168.1.16/test' -X GET -u admin:bad_password
177
{"action":"test","result":false}
178 30 Corey Osman
D, [2015-03-20T10:04:25.288696 #92467] DEBUG -- : /usr/local/sbin/bmc-info --hostname=192.168.1.16   --config-file=/var/folders/h6/v6nv76td37s7vqj902_z59kh0000gn/T/20150320-92467-1og0ucl
179
D, [2015-03-20T10:04:25.335628 #92467] DEBUG -- : "/usr/local/sbin/bmc-info --hostname=192.168.1.16   --config-file=/var/folders/h6/v6nv76td37s7vqj902_z59kh0000gn/T/20150320-92467-1og0ucl --driver-type=LAN_2_0"
180
D, [2015-03-20T10:04:25.335706 #92467] DEBUG -- : /usr/local/sbin/bmc-info: password invalid
181
182 24 Corey Osman
</pre>
183
184 31 Corey Osman
How to provide additional options in the body
185
<pre>
186 32 Corey Osman
curl -vks --header "Content-Type: application/json" -d '{"bmc_provider":"freeipmi", "options":{"driver":"lan20", "privilege":"USER"}}' 'http://127.0.0.1:8443/bmc/192.168.1.21/chassis/power/off' -X GET -u admin:password
187 31 Corey Osman
</pre>
188
189 6 Brian Gupta
[[Draft 2.0 version of DNS API]]
190 21 Stephen Benjamin
191
h3. Realm API
192
193
Draft design: http://projects.theforeman.org/projects/foreman/wiki/RealmJoinIntegration
194
195
h4. New Host
196
197
The FreeIPA returns the raw XMLRPC JSON when creating a host, however the only relevant key is "randompassword."  Any other Realm providers at a minimum should return an OTP for a new host.
198
199
Example full output from FreeIPA:
200
201
<pre>
202
{
203
  "dn": "fqdn=hostname.example.com,cn=computers,cn=accounts,dc=example,dc=com", 
204
  "fqdn": [
205
    "hostname.example.com" 
206
  ], 
207
  "has_keytab": false, 
208
  "has_password": true, 
209
  "ipauniqueid": [
210
    "5f5d467c-9fce-11e3-bcca-525400d17cb3" 
211
  ], 
212
  "managedby_host": [
213
    "hostname.example.com" 
214
  ], 
215
  "objectclass": [
216
    "ipaSshGroupOfPubKeys", 
217
    "ipaobject", 
218
    "ieee802device", 
219
    "nshost", 
220
    "top", 
221
    "ipaservice", 
222
    "pkiuser", 
223
    "ipahost", 
224
    "ipasshhost" 
225
  ], 
226
  "randompassword": "_i7@PhgpAnjn" 
227
}
228
</pre>
229
230
h4. Update Host
231
232
* "rebuild=true" is passed for any host being rebuilt in order to know whether to revoke any outstanding certificates, etc.  A new randompassword should be issued.
233
234
* Foreman also triggers an update if the "userclass" is being updated.  You should not return a new one-time password for this, only update the attribute (if desired) and return 200.  If nothing needs to be updated, you should return resposen 200 and this JSON
235
236
<pre>
237
{"message" => "nothing to do"}
238
</pre>
239
240
h4. Delete a host
241
242
The Smart Proxy will return 404 if not found, 400 for any other error.