maestro-shell

README

maestro-shell

An interactive shell for controlling maestro locally on deviceOS

Commands

log delete

Delete a maestro log filter.

Example

> log delete target=/var/log/maestro/maestro.log levels=info

[DEBUG] opt=target, arg=/var/log/maestro/maestro.log
[DEBUG] opt=levels, arg=info
Log Sending: {"Target":"/var/log/maestro/maestro.log","Levels":"info","Tag":"","Pre":"","Post":"","PostFmtPreMsg":""}
[DEBUG] http resp:&{Status:200 OK StatusCode:200 Proto:HTTP/1.1 ProtoMajor:1 ProtoMinor:1 Header:map[Content-Length:[0] Date:[Thu, 27 Feb 2020 21:10:30 GMT]] Body:{} ContentLength:0 TransferEncoding:[] Close:false Uncompressed:false Trailer:map[] Request:0xc000148300 TLS:<nil>}
[DEBUG] log delete:200 OK <nil>
[OK] 200 OK

log get

Get a list of the log filter targets.

Example

> log get
[OK] Log Recieved.
[0]: {
    Format: {
        Time: ""
        Level: ""
        Tag: ""
        Origin: ""
    }
    Filters: [][0]: {
            Target: "default"
            Levels: ""
            Tag: ""
            Pre: ""
            Post: ""
            PostFmtPreMsg: ""
        }

    Rotate: {
        MaxFiles: 0.000000
        RotateOnStart: false
        MaxFileSize: 0.000000
        MaxTotalSize: 0.000000
    }
    Name: "default"
    FormatLevel: ""
    FormatOrigin: ""
    FormatPreMsg: ""
    TTY: ""
    FormatPre: ""
    FormatTime: ""
    FormatPost: ""
    File: ""
    ExampleFileOpts: {
        Mode: 0.000000
        Flags: 0.000000
        Max_files: 0.000000
        Max_file_size: 0.000000
        Max_total_size: 0.000000
        Rotate_on_start: false
    }
    Delim: ""
    FormatTag: ""
    Flag_json_escape_strings: false
}
[1]: {
    TTY: ""
    Delim: ""
    FormatTag: ""
    FormatOrigin: ""
    File: "/var/log/maestro/maestro.log"
    FormatTime: ""
    FormatPost: ""
    FormatPreMsg: ""
    Format: {
        Time: ""
        Level: ""
        Tag: ""
        Origin: ""
    }
    Filters: [][0]: {
            PostFmtPreMsg: ""
            Target: "/var/log/maestro/maestro.log"
            Levels: "warn"
            Tag: ""
            Pre: ""
            Post: ""
        }

        [1]: {
            Target: "/var/log/maestro/maestro.log"
            Levels: "error"
            Tag: ""
            Pre: ""
            Post: ""
            PostFmtPreMsg: ""
        }

    Rotate: {
        MaxFiles: 0.000000
        RotateOnStart: false
        MaxFileSize: 0.000000
        MaxTotalSize: 0.000000
    }
    ExampleFileOpts: {
        Max_files: 0.000000
        Max_file_size: 0.000000
        Max_total_size: 0.000000
        Rotate_on_start: false
        Mode: 0.000000
        Flags: 0.000000
    }
    FormatPre: ""
    FormatLevel: ""
    Flag_json_escape_strings: false
    Name: "/var/log/maestro/maestro.log"
}

log set

Set a log filter target.

NOTE: This function will not update an existing filter. You currently need to log delete an existing filter then call log set to add it back with changes.

Example

> log set target=/var/log/maestro/maestro.log levels=info

[DEBUG] opt=target, arg=/var/log/maestro/maestro.log
[DEBUG] opt=levels, arg=info
Log Sending: {"Target":"/var/log/maestro/maestro.log","Levels":"info","Tag":"","Pre":"","Post":"","PostFmtPreMsg":""}
[DEBUG] http resp:&{Status:200 OK StatusCode:200 Proto:HTTP/1.1 ProtoMajor:1 ProtoMinor:1 Header:map[Content-Length:[0] Date:[Thu, 27 Feb 2020 21:10:01 GMT]] Body:{} ContentLength:0 TransferEncoding:[] Close:false Uncompressed:false Trailer:map[] Request:0xc000148100 TLS:<nil>}
[DEBUG] log set:200 OK <nil>
[OK] 200 OK

net events

Opens a connection to maestro and continually waits for network events, printing them out as they occur

Usage: net events

Example

> net events
[OK]

> [event(network)] JSON:
[0]: {
    data: {
        data: {
            type: "interface-state-down"
            interface: {
                id: "enxf4f951f22db3"
                index: 10.000000
                address: ""
                addressV6: ""
                linkstate: "LOWER_DOWN"
            }
        }
    }
}

> [event(network)] JSON:
[0]: {
    data: {
        data: {
            type: "interface-state-up"
            interface: {
                id: "enxf4f951f22db3"
                index: 10.000000
                address: "10.10.102.218"
                addressV6: ""
                linkstate: "LOWER_UP"
            }
        }
    }
}

net get-interfaces

Dumps information on all managed interfaces.

Usage: net get-interfaces

Example

> net get-interfaces
[OK] interfaces:
[0]: {
    StoredIfconfig: {
        replace_addr: ""
        down: false
        aux: false
        nameserver_overrides: ""
        test_echo_route_out: ""
        hw_addr: ""
        wifi: null
        test_https_route_out: ""
        alias_ipv4: null
        clear_addresses: false
        fallback_default_gateway: ""
        existing: ""
        ipv4_bcast: ""
. . .

net config-interface

Configures a single existing managed interface.

Usage: net config-interface <opt1>=<arg1> <opt2>=<arg2> ...

Example 1

> net config-interface ifname=eth1 dhcpv4enabled=false ipv4addr=192.168.1.1 ipv4mask=24 clearaddresses=true
[OK] 200 OK

Example 2

> net config-interface ifname=wwan0 type=lte dhcpv4enabled=true apn=stream.co.uk serial=/dev/ttyACM3
[OK] 200 OK

Example 3

> net config-interface ifname=wlan0 type=wifi dhcpv4enabled=true clearaddresses=true wifissid=ssid wifipassword=password
[OK] 200 OK

net add-dns

Add a DNS server to your gateway.

Usage: net add-dns <dns-ip>

Example

> net add-dns 8.8.8.8
[OK] 200 OK

net delete-dns

Delete a DNS server from your gateway.

Usage: net delete-dns <dns-ip>

Example

> net delete-dns 8.8.8.4
[OK] 200 OK

net get-dns

Get the DNS servers used by your gateway for name resolution.

Usage: net get-dns

Example

> net get-dns
targets:
[0]: "8.8.8.8"[1]: "8.8.8.4"

Developing Maestro-Shell

Compiling

1. Since Maestro-Shell is the front end for Maestro you need to first follow all the current build instruction to build Maestro.
2. Once that environment is setup you need to call vagrant ssh to get into the build system from the Maestro folder.
3. After you logged into vagrant: cd $MAESTRO_SRC/../maestro-shell
4. To do the pre-build step run: ./build-deps.sh
5. When that is done to build Maestro-Shell run go build
6. You have built the system

Testing

1. Open two separate vagarant ssh shells from the Maestro folder on your main system.
2. In the 1st shell run sudo maestro to start the Maestro instance you will be sending commands to.
3. From the 2nd shell cd $MAESTRO_SRC/../maestro-shell
4. In that folder run sudo maestro-shell.sh
5. You are now ready to send commands from Maestro-Shell to Maestro