Version information
Start using this module
Add this module to your Puppetfile:
mod 'mcanevet-freebox', '0.0.1'Learn more about managing modules with a PuppetfileDocumentation
Freebox OS module
WARNING: Work In Progress.
Overview
The Freebox OS module allows you to easily manage the Freebox Server settings in Puppet via the FreeboxOS Gateway API.
Pre-requirement
First, you have to obtain an app_token. This procedure can only be initiated from the local network, and the user must have access to the Freebox front panel to grant access to the app.
require 'freebox_api'
FreeboxApi::Freebox.new.authorize({
:app_id => 'fr.freebox.puppet',
:app_name => 'Freebox Puppet',
:app_version => '0.0.1',
:device_name => 'puppetmaster.example.com')
})['app_token']
or
curl -X POST http://mafreebox.free.fr/api/v1/login/authorize -H "Content-Type: application/json" -d '{"app_id" : "fr.freebox.puppet", "app_name" : "Freebox Puppet", "app_version" : "0.0.1", "puppetmaster.example.com"}'
Then got to your Freebox OS interface (http://mafreebox.free.fr) to allow Freebox Puppet application to update Freebox settings (in "Paramètres de la Freebox" > "Gestion des accès" > "Applications").
Usage
Create a node definition for every freebox to manage
node 'mafreebox.free.fr' {
class { 'freebox':
app_token => 'dyNYgfK0Ya6FWGqq83sBHa7TwzWo+pg4fDFUJHShcjVYzTfaRrZzm93p7OTAfH/0',
}
}
node 'mafreebox.example.com' {
class { 'freebox':
app_token => 'dyNYgfK0Ya6FWGqq83sBHa7TwzWo+pg4fDFUJHShcjVYzTfaRrZzm93p7OTAfH/0',
}
}
Then include the class of the module you want to manage:
include ::freebox::configuration::connection
include ::freebox::configuration::connection::ipv6
include ::freebox::configuration::lan
...
I you want to remove all unmanaged resources for a certain type of resource you can do it like this:
resources { 'freebox_static_lease': purge => true, }
Run puppet
With a puppetmaster
export FACTER_operatingsystem=FreeboxOS
export FACTER_clientcert=mafreebox.free.fr
puppet agent -t --certname=$FACTER_clientcert
export FACTER_clientcert=mafreebox.example.com
puppet agent -t --certname=$FACTER_clientcert
or in standalone mode
export FACTER_operatingsystem=FreeboxOS
export FACTER_clientcert=mafreebox.free.fr
puppet apply --certname=$FACTER_clientcert
export FACTER_clientcert=mafreebox.example.com
puppet apply --certname=$FACTER_clientcert
Overriding operatingsystem and setting clientcert fact is required so that other facts are overridden (like ipaddress).
Reference
Classes:
- freebox
- freebox::configuration::connection
- freebox::configuration::connection::ipv6
- freebox::configuration::lan
- freebox::configuration::dhcp
- freebox::configuration::ftp
- freebox::configuration::nat::dmz
Resources:
- freebox_ddns_client
- freebox_static_lease
- [freebox_lan_host] (#resource-freeboxlanhost)
###Class: freebox This class is used to set the main settings for this module, to be used by the other classes and defined resources.
For example, if you want to override the default app_id you could use the following combination:
class { 'freebox':
app_token => 'dyNYgfK0Ya6FWGqq83sBHa7TwzWo+pg4fDFUJHShcjVYzTfaRrZzm93p7OTAfH/0',
app_id => 'fr.freebox.puppetconf',
}
That would make the app_token(mandatory) and app_id default for all classes and defined resources in this module.
####app_token
The app_token to use (see above to generate one).
####app_id
Override the default app_id (generated app_token must match the app_id). Defaults to fr.freebox.puppet.
####app_name
Override the default app_name. Defaults to Freebox Puppet.
####app_version
Override the app version.
####device_name
Override the device name. Defaults to $::hostname.
###Class: freebox::configuration::connection This class is used to configure the Freebox IPv4 connection.
####ping
Should the Freebox respond to external ping requests.
####remote_access
Enable/disable HTTP remote access.
####remote_access_port
Port number to use for remote HTTP access.
####wol
Enable/disable Wake-on-lan proxy.
####adblock
Is ads blocking feature enabled.
####allow_token_request
If false, user has disabled new token request. New apps can’t request a new token. Apps that already have a token are still allowed.
####ddns_client
A hash containing DynDNS client configuration.
###Class: freebox::configuration::connection::ipv6 This class is used to configure the Freebox IPv6 connection.
####enabled
is IPv6 enabled.
####delegations
list of IPv6 delegations.
###Class: freebox::configuration::lan This class is used to modify the Freebox Server network configuration.
####ip
Freebox Server IPv4 address.
####server_name
Freebox Server name.
####name_dns
Freebox Server DNS name.
####name_mdns
Freebox Server mDNS name.
####name_netbios
Freebox Server netbios name.
####type
The valid LAN modes are:
router: The Freebox acts as a network router.
bridge: The Freebox acts as a network bridge.
NOTE: in bridge mode, most of Freebox services are disabled. It is recommended to use the router mode.
###Class: freebox::configuration::dhcp This class is used to configure the DHCP server of the Freebox Server.
####always_broadcast
Always broadcast DHCP responses.
####dns
List of dns servers to include in DHCP reply.
####enabled
Enable/Disable the DHCP server.
####gateway
Gateway IP address.
####ip_range_end
DHCP range end IP.
####ip_range_start
DHCP range start IP.
####netmask
Gateway subnet netmask.
####sticky_assign
Always assign the same IP to a given host.
####leases
Hash containing leases to declare.
###Class: freebox::configuration::ftp This class is used to configure the FTP server of the Freebox Server.
####enabled
is the FTP server enabled.
####allow_anonymous
can anonymous user log in.
####allow_anonymous_write
can anonymous user write data.
####password
user password.
###Class: freebox::configuration::nat::dmz This class is used to configure the DMZ of the Freebox Server.
####ip
dmz host IP.
####enabled
is dmz enabled.
###Resource: freebox_ddns_client This resource is used to configure a DynDNS client.
####name
The name of the dynamic DNS provider. Right now the supported dynamic dns providers are:
- ovh
- dyndns
- noip
####enabled
Is this provider enabled.
####hostname
dns name to use to register.
####password
password to use to register.
####user
username to use to register.
###Resource: freebox_static_lease This resource is used to declare a DHCP static lease.
####ip
IPv4 to assign to the host.
####mac
Host mac address. Defaults to name.
####comment
an optional comment.
###Resource: freebox_lan_host This resource is used to modify host information.
####primary_name
Host primary name.
####host_type
When possible, the Freebox will try to guess the host_type, but you can manually override this to the correct value.
Possible values are:
| source | Description |
|---|---|
| workstation | Workstation |
| laptop | Laptop |
| smartphone | Smartphone |
| tablet | Tablet |
| printer | Printer |
| vg_console | Video game console |
| television | TV |
| nas | Nas |
| ip_camera | IP Camera |
| ip_phone | IP Phone |
| freebox_player | Freebox Player |
| freebox_hd | Freebox Server |
| networking_device | Networking device |
| multimedia_device | Multimedia device |
| other | Other |
####persistent
If true the host is always shown even if it has not been active since the Freebox startup.
Types in this module release
Dependencies
- puppetlabs/inifile (1.x)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.