add examples to readme

This commit is contained in:
Jack Robison 2018-10-08 17:57:45 -04:00
parent 79fb296a6e
commit 4e44eacaff
No known key found for this signature in database
GPG key ID: DF25C68FE0239BB2

View file

@ -24,7 +24,28 @@ aioupnp [-h] [--debug_logging=<debug_logging>] [--interface=<interface>]
add_port_mapping | delete_port_mapping | get_external_ip | get_next_mapping | get_port_mapping_by_index | get_redirects | get_soap_commands | get_specific_port_mapping | m_search
### Examples
To get the external ip address from the UPnP gateway
aioupnp get_external_ip
To list the active port mappings on the gateway
aioupnp get_redirects
To debug the default gateway
aioupnp --debug_logging=1 m_search
To debug a gateway on a non default network interface
aioupnp --interface=vmnet1 --debug_logging=1 m_search
To debug a gateway on a non default network interface that isn't the router
aioupnp --interface=vmnet1 --gateway_address=192.168.1.106 --debug_logging=1 m_search
## License
This project is MIT licensed. For the full license, see [LICENSE](LICENSE).