222. Proxy

Proxy data

222.1. Summary of Module Globals

List of Global Functions

  • Export - Dump the Routing settings to a map, for autoinstallation use.

  • GetEnvironment - Function returns an environment usable for curl. The proxy user/password are read from /root/.curlrc.

  • GetModified - Function which returns if the settings were modified

  • Import - Get all settings from a map. When called by <name>_auto (preparing autoinstallation data) the map may be empty.

  • RunTestProxy - Runs tests of the HTTP and FTP proxy

  • SetModified - Function sets internal variable, which indicates, that any settings were modified, to "true"

  • Summary - Create proxy summary

  • Write - Write routing settings and apply changes

List of Global Variables

222.2. Global Functions

222.2.1. Export

Dump the Routing settings to a map, for autoinstallation use.

Return value

  • map - autoinstallation settings

222.2.2. GetEnvironment

Function returns an environment usable for curl. The proxy user/password are read from /root/.curlrc.

Return value

  • map <string, string>

222.2.3. GetModified

Function which returns if the settings were modified

Return value

  • boolean - settings were modified

222.2.4. Import

Get all settings from a map. When called by <name>_auto (preparing autoinstallation data) the map may be empty.

Function parameters

  • map settings

Return value

  • boolean - true if success

222.2.5. RunTestProxy

Runs tests of the HTTP and FTP proxy

Function parameters

  • string http_proxy

  • string https_proxy

  • string ftp_proxy

  • string proxy_user

  • string proxy_password

Return value

  • map <string, map <string, any> > - with results of the test

return = $[
	"HTTP" : $[
		"exit" : _exit_code,
		"stdout" : _stdout,
		"stderr" : _stderr,
	],
	"HTTPS" : $[
		"exit" : _exit_code,
		"stdout" : _stdout,
		"stderr" : _stderr,
	],
	"FTP" : $[
		"exit" : _exit_code,
		"stdout" : _stdout,
		"stderr" : _stderr,
	],
 ]

222.2.6. SetModified

Function sets internal variable, which indicates, that any settings were modified, to "true"

Return value

  • void

222.2.7. Summary

Create proxy summary

Return value

  • string - summary text

222.2.8. Write

Write routing settings and apply changes

Return value

  • boolean - true if success

222.3. Global Variables

222.3.1. modified

Data was modified?

222.4. Module Requirements

222.4.1. Module Imports

  • Progress
  • Summary

222.4.2. Module Includes

  • network/routines.ycp
  • network/runtime.ycp