Skip to content

GitLab

Commit 00f871ee authored by Vivek Kumar Dutta's avatar Vivek Kumar Dutta
Browse files
Options

uspd: Compress the long outputs in Readme

parent 51bacb9f
Pipeline #2290 passed with stages
        in 1 minute and 25 seconds
        Hide whitespace changes
        Inline Side-by-side
        Showing with 4 additions and 259 deletions
        README.md
        View file @ 00f871ee
        ......@@ -2,7 +2,8 @@
        `uspd` is a [TR-369/USP](https://usp.technology/) backend ubus daemon process to understand [USP syntax](https://usp.technology/specification/architecture/) defined in R-ARC.7 - R-ARC.12 and provide details.
        > Note: The command outputs shown in this readme are examples only, actual output may differ based on device and configuration.
        > Note 1: The command outputs shown in this readme are examples only, actual output may differ based on device and configuration.
        > Note 2: Long command outputs are compressed for better readability
        ## Project Components
        ......@@ -140,27 +141,6 @@ usp.Device.Ethernet.
        usp.Device.Firewall.
        usp.Device.Hosts.
        usp.Device.IP.
        usp.Device.InterfaceStack.
        usp.Device.LANConfigSecurity.
        usp.Device.ManagementServer.
        usp.Device.NAT.
        usp.Device.PPP.
        usp.Device.QoS.
        usp.Device.Routing.
        usp.Device.Security.
        usp.Device.Services.
        usp.Device.Time.
        usp.Device.UPnP.
        usp.Device.USB.
        usp.Device.UserInterface.
        usp.Device.Users.
        usp.Device.WiFi.
        usp.Device.X_IOPSYS_EU_Buttons.
        usp.Device.X_IOPSYS_EU_Dropbear.
        usp.Device.X_IOPSYS_EU_IGMP.
        usp.Device.X_IOPSYS_EU_MLD.
        usp.Device.X_IOPSYS_EU_OWSD.
        usp.Device.X_IOPSYS_EU_Syslog.
        usp.raw
        root@iopsys:~#
        ````
        ......@@ -244,24 +224,10 @@ root@iopsys:~# ubus call usp get '{"path":"Device.IP.Diagnostics.", "proto":"usp
        "IPv4PingSupported": true,
        "IPv4ServerSelectionDiagnosticsSupported": true,
        "IPv4TraceRouteSupported": true,
        "IPv4UDPEchoDiagnosticsSupported": true,
        "IPv4UploadDiagnosticsSupported": true,
        "IPv6DownloadDiagnosticsSupported": true,
        "IPv6PingSupported": true,
        "IPv6ServerSelectionDiagnosticsSupported": true,
        "IPv6TraceRouteSupported": true,
        "IPv6UDPEchoDiagnosticsSupported": true,
        "IPv6UploadDiagnosticsSupported": true,
        "UDPEchoConfig": {
        "BytesReceived": 0,
        "BytesResponded": 0,
        "EchoPlusEnabled": false,
        "EchoPlusSupported": false,
        "Enable": false,
        "Interface": "",
        "PacketsReceived": 0,
        "PacketsResponded": 0,
        "SourceIPAddress": "",
        "TimeFirstPacketReceived": "0",
        "TimeLastPacketReceived": "0",
        "UDPPort": 0
        ......@@ -277,23 +243,6 @@ root@iopsys:~# ubus call usp get '{"path":"Device.IP.Diagnostics.", "proto":"cwm
        "DSCP": 0,
        "DiagnosticsState": "None",
        "DownloadDiagnosticMaxConnections": 1,
        "DownloadTransports": "HTTP,FTP",
        "DownloadURL": "",
        "EOMTime": "0",
        "EnablePerConnectionResults": false,
        "EthernetPriority": 0,
        "Interface": "",
        "NumberOfConnections": 1,
        "PerConnectionResultNumberOfEntries": 0,
        "PeriodOfFullLoading": 0,
        "ProtocolVersion": "Any",
        "ROMTime": "0",
        "TCPOpenRequestTime": "0",
        "TCPOpenResponseTime": "0",
        "TestBytesReceived": 0,
        "TestBytesReceivedUnderFullLoading": 0,
        "TotalBytesReceived": 0,
        "TotalBytesReceivedUnderFullLoading": 0,
        "TotalBytesSent": 0,
        "TotalBytesSentUnderFullLoading": 0
        },
        ......@@ -302,15 +251,6 @@ root@iopsys:~# ubus call usp get '{"path":"Device.IP.Diagnostics.", "proto":"cwm
        "AverageResponseTimeDetailed": 0,
        "DSCP": 0,
        "DataBlockSize": 64,
        "DiagnosticsState": "None",
        "FailureCount": 0,
        "Host": "",
        "Interface": "",
        "MaximumResponseTime": 0,
        "MaximumResponseTimeDetailed": 0,
        "MinimumResponseTime": 0,
        "MinimumResponseTimeDetailed": 0,
        "NumberOfRepetitions": 3,
        "ProtocolVersion": "Any",
        "SuccessCount": 0,
        "Timeout": 1000
        ......@@ -318,97 +258,8 @@ root@iopsys:~# ubus call usp get '{"path":"Device.IP.Diagnostics.", "proto":"cwm
        "IPv4DownloadDiagnosticsSupported": true,
        "IPv4PingSupported": true,
        "IPv4ServerSelectionDiagnosticsSupported": true,
        "IPv4TraceRouteSupported": true,
        "IPv4UDPEchoDiagnosticsSupported": true,
        "IPv4UploadDiagnosticsSupported": true,
        "IPv6DownloadDiagnosticsSupported": true,
        "IPv6PingSupported": true,
        "IPv6ServerSelectionDiagnosticsSupported": true,
        "IPv6TraceRouteSupported": true,
        "IPv6UDPEchoDiagnosticsSupported": true,
        "IPv6UploadDiagnosticsSupported": true,
        "ServerSelectionDiagnostics": {
        "AverageResponseTime": 0,
        "DiagnosticsState": "None",
        "FastestHost": "",
        "HostList": "",
        "Interface": "",
        "MaximumResponseTime": 0,
        "MinimumResponseTime": 0,
        "NumberOfRepetitions": 3,
        "Port": 0,
        "Protocol": "ICMP",
        "ProtocolVersion": "Any",
        "Timeout": 1000
        },
        "TraceRoute": {
        "DSCP": 0,
        "DataBlockSize": 38,
        "DiagnosticsState": "None",
        "Host": "",
        "Interface": "",
        "MaxHopCount": 30,
        "NumberOfTries": 3,
        "ProtocolVersion": "Any",
        "ResponseTime": 0,
        "RouteHopsNumberOfEntries": 0,
        "Timeout": 5000
        },
        "UDPEchoConfig": {
        "BytesReceived": 0,
        "BytesResponded": 0,
        "EchoPlusEnabled": false,
        "EchoPlusSupported": false,
        "Enable": false,
        "Interface": "",
        "PacketsReceived": 0,
        "PacketsResponded": 0,
        "SourceIPAddress": "",
        "TimeFirstPacketReceived": "0",
        "TimeLastPacketReceived": "0",
        "UDPPort": 0
        },
        "UDPEchoDiagnostics": {
        "AverageResponseTime": 0,
        "DSCP": 0,
        "DataBlockSize": 24,
        "DiagnosticsState": "None",
        "FailureCount": 0,
        "Host": "",
        "InterTransmissionTime": 1000,
        "Interface": "",
        "MaximumResponseTime": 0,
        "MinimumResponseTime": 0,
        "NumberOfRepetitions": 1,
        "Port": 0,
        "ProtocolVersion": "Any",
        "SuccessCount": 0,
        "Timeout": 5000
        },
        "UploadDiagnostics": {
        "BOMTime": "0",
        "DSCP": 0,
        "DiagnosticsState": "None",
        "EOMTime": "0",
        "EnablePerConnectionResults": false,
        "EthernetPriority": 0,
        "Interface": "",
        "NumberOfConnections": 1,
        "PerConnectionResultNumberOfEntries": 0,
        "PeriodOfFullLoading": 0,
        "ProtocolVersion": "Any",
        "ROMTime": "0",
        "TCPOpenRequestTime": "0",
        "TCPOpenResponseTime": "0",
        "TestBytesSent": 0,
        "TestBytesSentUnderFullLoading": 0,
        "TestFileLength": 0,
        "TotalBytesReceived": 0,
        "TotalBytesReceivedUnderFullLoading": 0,
        "TotalBytesSent": 0,
        "TotalBytesSentUnderFullLoading": 0,
        "UploadTransports": "HTTP,FTP",
        "UploadURL": ""
        }
        }
        }
        ......@@ -473,82 +324,6 @@ root@iopsys:~# ubus call usp.raw get '{"path":"Device.Users."}'
        "type": "xsd:string"
        },
        {
        "parameter": "Device.Users.User.1.RemoteAccessCapable",
        "value": "1",
        "type": "xsd:boolean"
        },
        {
        "parameter": "Device.Users.User.1.Username",
        "value": "user",
        "type": "xsd:string"
        },
        {
        "parameter": "Device.Users.User.2.Alias",
        "value": "cpe-2",
        "type": "xsd:string"
        },
        {
        "parameter": "Device.Users.User.2.Enable",
        "value": "1",
        "type": "xsd:boolean"
        },
        {
        "parameter": "Device.Users.User.2.Language",
        "value": "",
        "type": "xsd:string"
        },
        {
        "parameter": "Device.Users.User.2.Password",
        "value": "",
        "type": "xsd:string"
        },
        {
        "parameter": "Device.Users.User.2.RemoteAccessCapable",
        "value": "1",
        "type": "xsd:boolean"
        },
        {
        "parameter": "Device.Users.User.2.Username",
        "value": "support",
        "type": "xsd:string"
        },
        {
        "parameter": "Device.Users.User.3.Alias",
        "value": "cpe-3",
        "type": "xsd:string"
        },
        {
        "parameter": "Device.Users.User.3.Enable",
        "value": "1",
        "type": "xsd:boolean"
        },
        {
        "parameter": "Device.Users.User.3.Language",
        "value": "",
        "type": "xsd:string"
        },
        {
        "parameter": "Device.Users.User.3.Password",
        "value": "",
        "type": "xsd:string"
        },
        {
        "parameter": "Device.Users.User.3.RemoteAccessCapable",
        "value": "1",
        "type": "xsd:boolean"
        },
        {
        "parameter": "Device.Users.User.3.Username",
        "value": "admin",
        "type": "xsd:string"
        },
        {
        "parameter": "Device.Users.UserNumberOfEntries",
        "value": "3",
        "type": "xsd:unsignedInt"
        }
        ]
        }
        ````
        - For more info on the `usp` ubus API see [link](./docs/api/usp.md#get)
        - For more info on the `usp.raw` ubus API see [link](./docs/api/usp.raw.md#get)
        ......@@ -707,31 +482,6 @@ root@iopsys:~# ubus call usp.raw operate '{"path":"Device.IP.Diagnostics.", "act
        "type": "xsd:unsignedInt"
        },
        {
        "parameter": "MaximumResponseTime",
        "value": "0",
        "type": "xsd:unsignedInt"
        },
        {
        "parameter": "MaximumResponseTimeDetailed",
        "value": "0",
        "type": "xsd:unsignedInt"
        },
        {
        "parameter": "MinimumResponseTime",
        "value": "9999",
        "type": "xsd:unsignedInt"
        },
        {
        "parameter": "MinimumResponseTimeDetailed",
        "value": "999999999",
        "type": "xsd:unsignedInt"
        },
        {
        "parameter": "SuccessCount",
        "value": "0",
        "type": "xsd:unsignedInt"
        }
        ]
        }
        ]
        }
        ......@@ -800,7 +550,6 @@ root@iopsys:~# ubus call usp instances '{"path":"Device.IP.Interface.", "proto":
        #### List Operate
        API to list all operate command objects
        > NOTE : Please note that the list_operate output is compressed, the actual output includes all registered operate commands
        ````bash
        root@iopsys:~# ubus call usp list_operate
        ......@@ -840,7 +589,6 @@ root@iopsys:~# ubus call usp list_operate
        #### Dump schema
        API to dump all registered schema paths,
        > NOTE : Please note that the dump_schema output is compressed, the actual output includes all registerd schema paths.
        ````bash
        {
        ......@@ -973,13 +721,10 @@ root@iopsys:~# ubus call usp get '{"path":"Device.Users.User.[Username=\"user\"]
        | Error Code | Meaning |
        |------------|--------------------------------------------------------------|
        | 7003 | Message failed due to an internal error. |
        | 7004 | Message failed due to invalid values in the request elements |
        | | and/or failure to update one or more parameters during Add |
        | | or Set requests. |
        | 7004 | Message failed due to invalid values in the request elements and/or failure to update one or more parameters during Add or Set requests. |
        | 7005 | Message failed due to memory or processing limitations. |
        | 7008 | Requested path was invalid or a reference was invalid. |
        | 7010 | Requested Path Name associated with this ParamError did not |
        | | match any instantiated parameters. |
        | 7010 | Requested Path Name associated with this ParamError did not match any instantiated parameters. |
        | 7011 | Unable to convert string value to correct data type. |
        | 7012 | Out of range or invalid enumeration. |
        | 7022 | Command failed to operate. |
        ......
        Markdown is supported
        0% or .
        You are about to add 0 people to the discussion. Proceed with caution.
        Finish editing this message first!
        Please register or to comment