Lantronix 900-691-R manual Take Status Action, Appendix B WebAPI

Page 101

Appendix B: WebAPI

optionalBoolNeedSecret: To retrieve the original value for hidden configuration, set this to "true".

CURL example:

curl -u admin:PASSWORD http://172.19.100.125/export/config -X POST curl -u admin:PASSWORD http://172.19.100.125/export/config -X POST -d "optionalGroupList=Interface:wlan0"

Javascript example: myXmlhttprequest.open(

"POST",

"/export/config", true

);

request.send(

"optionalGroupList= Interface:wlan0"

);

Take Status Action

An HTTP POST request can be sent to the device to take a status action.

Protocol: HTTP

Method: Post

URL: http://<hostname>/action/status

Parameters:

group: Required. The status group where action is defined.

optionalGroupInstance: Optional instance of status group.

optionalItem: Optional item of status group where action is defined.

optionalItemInstance: Optional instance of status item.

action: Required. The action to be taken.

CURL example:

curl -u admin:PASSWORD http://172.19.100.125/action/status -X POST -d "group=Interface&optionalGroupInstance=wlan0&action=Renew"

Javascript example: myXmlhttprequest.open(

"POST",

"/action/status", true

);

request.send(

" group=Interface&optionalGroupInstance=wlan0&action=Renew "

);

xPico® Wi-Fi® Embedded Device Server User Guide

101

Image 101
Contents Embedded Device Server User Guide Intellectual Property WarrantyContacts DisclaimerTable of Contents Tunnel Settings Interface SettingsConfigurable Pin Manager Services SettingsAdvanced Settings Maintenance and Diagnostics SettingsBranding the xPico Wi-Fi Unit MonitorAppendix B WebAPI 100 Updating FirmwareAppendix C Technical Support 103 105Appendix E Binary to Hexadecimal Conversions 112 List of Figures XPico Wi-Fi Product LabelList of Tables XPico Wi-Fi Embedded Device Server User Guide Purpose and Audience Using This GuideSummary of Chapters Chapter DescriptionDocument Description Additional DocumentationIntroduction Key FeaturesProtocol Support Troubleshooting CapabilitiesProduct Information Label Configuration MethodsAddresses and Port Numbers XPico Wi-Fi Product Label Accessing Web Manager Configuration Using Web ManagerStatus StatusHelp Area Web Manager ComponentsNavigating Web Manager Web Manager Description See Web Manager PagesNetwork 1 Interface ap0 Configuration Network SettingsTo Configure Network 1 Interface Settings Network Interface SettingsNetwork 1 ap0 Link Settings Network 1 ap0 Link SettingsNetwork 1 ap0 Link Description Settings To View Network 1 Interface StatusTo View Network 1 Link Status To Configure Network 1 Link SettingsMode UptimeNetwork Interface Description Settings Network 2 wlan0 Interface ConfigurationTo Configure Network 2 Interface Settings Wlan Profiles Network 2 wlan0 Link StatusTo View Network 2 Interface Status To View Network 2 Link StatusTo Configure Wlan Profile Settings To Configure Wlan ProfilesWlan Profile Basic Settings Description Creating, Deleting or Enabling Wlan ProfilesWlan Profile Description Security Settings Wlan Profile Security SettingsWlan Profile Advanced Settings To Configure Wlan Quick ConnectWlan Profile Advanced Settings Description Wlan Quick ConnectWlan Quick Connect Wlan Quick Connect Description SettingsScan network Ssid Network Name linkLine Settings Interface SettingsLine Configuration Settings Line Settings DescriptionGap Timer To Configure Line SettingsTo View Line Status Xoff CharSPI Configuration Settings Serial Perpheral Interface SPI SettingsTo Configure SPI Settings To View SPI Status Line Settings Tunnel SettingsTo View Tunnel Serial Settings Tunnel Line SettingsTunnel Packing Mode Description Settings Packing ModeTunnel Packing Mode Settings Accept Mode To Configure Tunnel Packing Mode SettingsTunnel Accept Mode Settings Tunnel Accept Mode Description SettingsTo Configure Tunnel Accept Mode Settings Tunnel Connect Description Mode Settings Connect ModeTunnel Connect Mode Settings Disconnect Mode To Configure Tunnel Connect Mode SettingsTunnel Disconnect Mode Settings Tunnel Disconnect Description Mode SettingsTo Configure Tunnel Disconnect Mode Settings Modem Emulation SettingsModem Emulation Settings StatisticsCommand Description Tunnel SettingsModem Emulation Commands and Descriptions ATZ Configurable Pin Status Configurable Pin ManagerCurrent Configurable Pins CP StatusActive in Role RolesCPM Role Current Description Configuration To Configure CPM SettingsRole Configuration Http Settings Services SettingsTo Configure Http Settings and Access Control Http SettingsTo View Http Status File System Settings Maintenance and Diagnostics SettingsFile System Statistics File DisplayDevice Management Settings Device SettingsFile Manipulation To Transfer or Modify File System FilesAdmin User Settings Admin UserTo Configure Admin User on the Device To View Hardware Status Diagnostics SettingsTo View IP Socket Status To View Buffer Pool StatusXML Import and XML Export Advanced SettingsTo Import or Export XML Configuration Modem Emulation Settings Description Performance SettingsPerformance Settings To Configure Performance Monitor Explorer Settings Monitor SettingsExplorer Settings Description MonitorDisplay Rule NumberMonitor Initialization Settings ConfigurationMonitor Control Settings Initialization Description SettingsMonitor Filter Settings Monitor Poll SettingsPoll Settings Description DelayMonitor Data Settings To Configure MonitorData Settings Description Selector NumberInitialization Example Data Capture on a Serial DeviceMonitor Polling 1 Polling10 Monitor Filtering 1 Filtering12 Monitor Data Mining 1 Data MiningPresenting Data Capture on SPI Web Manager Customization Branding the xPico Wi-Fi UnitChanging the Presentation Path FormatOther Overridable Files Obtaining Firmware Loading New Firmware through Web Manager Updating FirmwareUpdating Firmware Conventions Appendix a Command ReferenceXML Architecture and Device Control Convention DescriptionBoot to CLI Configuration Using Serial PortSerial Command Mode Navigating the CLI Hierarchy Using Keyboard Shortcuts and CLITable A-1 Keyboard Shortcuts Key Combination DescriptionUnderstanding the CLI Level Hierarchy Configuration Using XMLAppendix a Command Reference Figure A-3 DTD for XCRs XML Configuration Record Document Type DefinitionDeclaration Quick Tour of XML SyntaxElement Start and End Tags Element AttributesFigure A-5 XML Example Record, Group, Item, and Value TagsConfiggroup CPM XML for xPicoWi-Fi Embedded Device ServerConfiggroup Access Point Configitem State Configgroup Http ServerConfigitem Port Configitem Inactivity TimeoutConfigitem Dhcp Client Configgroup InterfaceConfigitem Access Control Configgroup Line Configitem Protocol Configitem NameConfigitem Baud Rate Configitem ParityConfiggroup Performance Configitem Maximum Time Powered Down Configgroup SPIConfigitem Wkup Pin Power Up Configitem Time Powered UpConfiggroup Users Configitem Instance Configgroup Wlan ProfileConfigitem Password Configitem BasicConfiggroup XML Import Control Configgroup Modem Emulation Configgroup Monitor Initialization Value Length Configgroup Monitor ControlValue Timeout Configitem Delay Configgroup Monitor PollConfigitem Rule Configgroup Monitor FilterConfiggroup Tunnel Accept Configgroup Monitor DataConfigitem Selector Configitem Local PortConfigitem Flush Start Character Configitem Start CharacterConfigitem Flush Line Configitem Block LineConfigitem Block Network Configgroup Tunnel LineConfigitem Prompt for Password Configitem DTRValue Address Configgroup Tunnel ConnectConfigitem Host Configitem Reconnect Time Configitem ConnectionsValue Port Value ProtocolConfigitem Stop Character Configgroup Tunnel DisconnectConfigitem Flush Stop Character Configitem Modem ControlConfigitem Send Character Configgroup Tunnel PackingConfigitem Trailing Character Export Status Group Export Configuration GroupAppendix B WebAPI Appendix B WebAPI Take Status ActionCurl example configuration as part of command Import Configuration GroupNorth America Appendix C Technical SupportEurope, Middle East, Africa Emea Japan Asia / Pacific ApacLatin America & Caribbean Online Appendix D Compliance Country SpecificationTable D-1 Country Certifications Table D-2 Country Transmitter IDsTable D-4 Europe EU Declaration of Conformity Table D-3 SafetyRadiation Exposure Statement Federal Communication Commission Interference StatementEnd Product Labeling Industry Canada StatementManual Information To the End User Déclaration dexposition aux radiationsPlaque signalétique du produit final Antenna Requirement Manuel dinformation à lutilisateur finalTable D-5 Approved Antennas List Type Gain BrandRoHS Notice Manufacturers ContactConverting Binary to Hexadecimal Appendix E Binary to Hexadecimal ConversionsConversion Table Scientific CalculatorAppendix E Binary to Hexadecimal Conversions