Property:boxname.lua (restapi)

---

BoxMatrix >> Webinterface >> boxname.lua (restapi)

@ BoxMatrix   -   IRC-Chat   -   Translate: de es fr it nl pl

News

Selectors

Models

Accessories

Components

Environment

Config

Commands

System

Webif

Software

Develop

Lexicon

Community

Project

Media

---

UI-Structure

UI-Modules

HTML-Files

XML-Files

REST-API

Lua-Scripts

Javascript

Browser

SSI-Files

SSI-Directives

HTML-Text

Event-Text

Help-Pages

CSS-Files

Graphics

Research

---

Name-Collision - multiple objects in this wiki use the name boxname.lua! boxname.lua (luascr) TODO boxname.lua (restapi) TODO

---

RESTAPI-Script

RESTAPI-Script:	boxname.lua (restapi)   -   type Script	Wiki	Freetz	IPPF	whmf	AVM	Web
Location:	Webinterface >> RESTAPI-Scripts   -   Origin: AVM
Path:	Release: /usr/rest_api/plugins/misc Lab+Rel: /usr/rest_api/plugins/misc
Properties:	Size: 3.4k   -   Firmware: 7.90 - 8.00
Function:	REST-API Misc-Plugin for the FRITZ!Box-Name

Goto:   Functions  -  Dependencies   -   Model-Matrix   -   SMW-Browser

Details

boxname.lua is the REST-API Misc-Plugin for the FRITZ!Box-Name.

It is conditionally called by misc.lua, like all Misc-Plugins in /usr/rest_api/plugins/misc/*.lua.

It gets or sets the boxname. Supported functions in fw 8.00:

GET /api/v0/misc/boxname               # get the boxname
PUT /api/v0/misc/boxname               # set the boxmame from http body

The GET method acquires the name from:

• box:settings/hostname

The PUT method validates the new name and sets:

• box:settings/hostname
• ctlusb:settings/fritznas_share
• ctlusb:settings/samba-server-string
• wlan:settings/ssid*
• wlan:settings/guest_ssid
• mediasrv:settings/name
• emailnotify:settings/from_alias

REST-API:

• Lexicon: REST, API, SCGI
• Commands: scgi_server
• Ports: Port-8187-tcp
• UI-Mods: webui
• API-Root: api.lua
• Includes: api_generic.lua, rest_config.lua, security.lua, espresso.lua, rest_api_const.lua, response.lua, error.lua
• Includes: avmluamessages.lua, uimod.lua, api_generic_filter.lua, resource.lua, datatype.lua, plugin_common.lua
• Modules: storagenasrights_rest.lua, webusb_rest.lua
• Modules: calllog_rest.lua, faxjournal_rest.lua, phonebook_rest.lua, smarthome_rest.lua, boxnotify_rest.lua
• Develop: obl_fboxname.lua, dev_debug.lua, landevice.lua, query_tree.lua, fake_modules.lua, obl.lua
• Common: array.lua, common.lua, func.lua, math.lua, string.lua, table.lua, typecheck.lua, validcheck.lua
• Plugins: configflags.lua, eventlog.lua, info.lua, monitor.lua, phonebook.lua, smarthome.lua, timermix.lua
• Misc-Plugins: misc.lua, boxname.lua, configuration.lua, handsets.lua, update_status.lua, wan_status.lua
• Setup-Plugins: setup.lua

Functions

The function names of scripts often help to understand function blocks (and show gaps in the docs). fw 8.00 functions:

$ grep -e '^function' -e '^local function' /usr/rest_api/plugins/misc/boxname.lua

# get boxname response
function boxname.get_boxname(params)

# validate a new boxname
local function validateName(body)

# put new boxname 
function boxname.put_boxname(params) 

Dependencies

Daily updated index of all dependencies of this script. Last update: GMT.
A * in the Mod column marks info from Supportdata-Probes, which will always stay incomplete.
If an Object includes itself then this is a file with the same name but another Path and the dependencies are merged.

Relation	Typ	Object	Mod	Firmware	Info	Origin
Accesses	uimod	box	75	6.35 - 8.00	Global box settings	AVM
Accesses	uimod	connections	44	7.39 - 8.00	TODO	AVM
Accesses	uimod	ctlusb	75	6.35 - 8.00	USB-Host related config	AVM
Accesses	uimod	emailnotify	75	6.35 - 7.90	Push-Mail settings	AVM
Accesses	uimod	mediasrv (uimod)	75	6.35 - 8.00	UPnP-AV mediaserver	AVM
Accesses	uimod	plc (uimod)	51	7.19 - 8.00	Settings of all Powerline devices	AVM
Accesses	uimod	rext	75	6.35 - 8.00	Range extender (Repeater)	AVM
Accesses	uimod	wlan (uimod)	75	6.35 - 8.00	WLAN configuration	AVM
Requires	rest	array.lua	25	7.90 - 8.00	REST-API common collection of array-functions	AVM
Requires	rest	config.lua (restapi)	25	7.90 - 8.00	TODO	AVM
Requires	rest	mesh.lua	25	7.90 - 8.00	TODO	AVM
Requires	rest	response.lua	25	7.90 - 8.00	REST-API Response API	AVM
Requires	rest	rest_api_const.lua	25	7.90 - 8.00	REST-API Const Tables	AVM
Requires	rest	saveset.lua	25	7.90 - 8.00	TODO	AVM
Requires	rest	uimod.lua (restapi)	25	7.90 - 8.00	REST-API UI-Modules API	AVM
Requires	rest	validcheck.lua	25	7.90 - 8.00	REST-API common validation helper functions	AVM
Requires	rest	wifi.lua (restapi)	25	7.90 - 8.00	TODO	AVM
Required by	rest	misc.lua	25	7.90 - 8.00	REST-API Plugin for dispatching Misc-Plugins	AVM
18 dependencies for this script

Model-Matrix

Daily updated index of the presence, path and size of this script for each model. Last update: GMT.
Showing all models using this script. Click any column header (click-wait-click) to sort the list by the respective data.
The (main/scrpn/boot/arm/prx/atom/rtl) label in the Model column shows which CPU is meant for Multi-Linux models.
Note that this list is merged from Firmware-Probes of all known AVM firmware for a model, including Recovery.exe and Labor-Files.

Model	Firmware	Path	Size/Bytes
FRITZ!Box 4040	7.90 - 8.00	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 4050	7.90	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 4060	7.90	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 5530 Fiber (main)	8.00	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 5590 Fiber (main)	7.90 - 8.00	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 5590 Fiber (prx)	7.90 - 8.00	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 6591 Cable (arm)	8.00	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 6591 Cable (atom)	7.90 - 8.00	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 6660 Cable (arm)	7.90 - 8.00	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 6660 Cable (atom)	7.90 - 8.00	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 6670 Cable (arm)	7.90	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 6670 Cable (atom)	7.90	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 6690 Cable (arm)	7.90	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 6690 Cable (atom)	7.90	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 6850 LTE	7.90	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 6850 5G	7.90	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 7510	7.90 - 8.00	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 7520	8.00	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 7520 v2 (main)	7.90 - 8.00	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 7530	7.90 - 8.00	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 7530 AX	8.00	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 7583 VDSL (main)	8.00	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 7590 (main)	7.90 - 8.00	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 7590 AX (main)	8.00	/usr/rest_api/plugins/misc	3.4k
FRITZ!Box 7690	7.90	/usr/rest_api/plugins/misc	3.4k
25 models use this script

SMW-Browser

Property:boxname.lua (restapi)

Information is currently being retrieved from the backend.