Get an allconfig Report
Get an allconfig Report

Get an allconfig Report

You can request an allconfig report using JSON, and it will return all settings with characteristics.
To get all SGDs and their values along with various other information including defaults:
{}{"allconfig":null}
For the
"allconfig"
response, it will start with
{"allconfig":{
and end with
}}
If you do an
allconfig
, you can get the setting attributes for all settings as follows:
{"allconfig": {"ip.port":{"value":"6101","type":"integer","range":"0- 65535","clone":true, "archive":true,"access":"RW"}, "ip.port_alternate":{"value":"9100","type":"integer","range":"0-65535","clone":true, "archive":true,"access":"RW"}, "ip.sgd_json_port":{"value":"9200","type":"integer","range":"0- 65535","clone":true, "archive":true,"access":"RW"}, another setting, ... the last setting}}
where:
  • "value"
    indicates the current value stored in the setting.
  • "type"
    indicates the type of value. Possible values are integer, enum, bool, string, double, ipv4-address, ipv6- address.
  • "range"
    indicates the range of a setting. For strings this is the range of the string length. For enums it is the possible enum values.
  • "clone"
    indicates if it is safe to store this setting and apply it to another link-os printer.
  • "archive"
    indicates if is safe to store this setting and apply it to same link-os printer at a later time.
  • "access"
    indicates if the setting is RW (read/write), R (read-only), or W (write-only).
If you do an
allconfig
, you can get the setting attributes for all settings as follows:
{}{"allconfig":null}
For the values used above it returns these entries:
"device.friendly_name":{"value":"XXQLJ120900310","type":"string","range": "0-17","clone":false,"archive":true,"access":"RW"}, "device.company_contact":{"value":"123-555-1212","type":"string","range": "0-128","clone":true,"archive":true,"access":"RW"}, "device.location":{"value":"my desk","type":"string","range":" 0-128","clone":true,"archive":true,"access":"RW"},