diff --git a/README.md b/README.md index 91eda41..b3a1bcb 100644 --- a/README.md +++ b/README.md @@ -11,33 +11,35 @@ Information from Meraki Dashboard API (https://api.meraki.com/api/v0). For full required arguments: -k API_KEY, --api-key API_KEY API key obtained from Meraki Dashboard admin account + -d {switch,ap}, --device {switch,ap} Device type to be queried (Wireless AP or Switch) + -t {license,uplink,port,latency,ssid,failconn,connassoc,connauth,conndhcp,conndns,connsucc,clients}, --type {license,uplink,port,latency,ssid,failconn,connassoc,connauth,conndhcp,conndns,connsucc,clients} -=EXPLANATION & USAGE=- - I. All devices - license: Expiration of Meraki device license - -t license -o - uplink: Status of Meraki device connection to the cloud - -t uplink -n -s - - II. Switch Options - port: Get status on an individual switchport - -t port -s -p - - III. AP Options - latency: Latency stats over the past hour per AP - -t latency -n -s - ssid: Status of configured SSID(s) - -t ssid -n -w <#> - failconn: Number of failed connections over the past hour - -t failconn -n - connassoc, connauth, conndhcp, conndns, connsucc: Connection stats per AP over the past hour at different stages - -t [connassoc, connauth, conndhcp, conndns, connsucc] -n -s - clients: Number of connected clients per AP within the past 2 hours - -t clients -s + I. All devices + license: Expiration of Meraki device license + -t license -o + uplink: Status of Meraki device connection to the cloud + -t uplink -n -s + + II. Switch Options + port: Get status on an individual switchport + -t port -s -p + + III. AP Options + latency: Latency stats over the past hour per AP + -t latency -n -s + ssid: Status of configured SSID(s) + -t ssid -n -w <#> + failconn: Number of failed connections over the past hour + -t failconn -n + connassoc, connauth, conndhcp, conndns, connsucc: Connection stats per AP over the past hour at different stages + -t [connassoc, connauth, conndhcp, conndns, connsucc] -n -s + clients: Number of connected clients per AP within the past 2 hours + -t clients -s supplemental arguments: -o ORGID, --orgid ORGID