NetBeez Slackbot

NetBeez provides a custom Slackbot that can run tests and perform other tasks on Slack.

Setup

Navigate to your team's Slack homepage at <your_team>.slack.com/home.

 

Scroll down to Recently Added Applications and select Bots.

 

Select Add Configuration.

 

Enter a username in the text field (we like @netbeez), then select Add bot integration.

 

Find Integration Settings. In it is the API Token field. Copy the token to your clipboard.

 

Navigate to your Netbeez Dashboard (usually <your_domain>.netbeezcloud.net), then click NetBeez Settings () and choose Integrations from the sidebar.

Under Slack Integration, paste the token you just copied into the Bot Key field. Click Save.

 

Open the desktop Slack app or navigate to https://<your_team>.slack.com.

 

The bot should appear in the Slack sidebar within about five minutes.  Its username will be the one you assigned it.


To start working with your new bot, either Direct Message the bot or mention it in a post with the '@' prefix and say "Hi".

 

Commands & Syntax

The following tables display the bot's commands and network tests it can conduct.

Command
Result
hello/hi/hey "Hello. If you need some `help`, just ask!"
list agents Returns a list of agents
ping help Shows ping test request format and example
dns help Shows dns test request format and example
http help Shows http test request format and example
traceroute help Shows traceroute test request format and example
help Generic description of functionality. Explains that help can be called on specific command (ie. “ping help”).
ping <options> Start Ping test with options
dns <options> Start DNS test with options
http <options> Start HTTP test with options
traceroute <options> Start Traceroute test with options

 

Test
Syntax
Defaults
Ping ping <agent_id> <target> [<count>|<interval>|<timeout>] ping <agent_id> <target> 10 1 5
DNS dns <agent_id> <target> [<dns_server>|<count>|<interval>|<timeout>] dns <agent_id> <target> 8.8.8.8 10 1 5
HTTP http <agent_id> <target> [<count>|<interval>|<timeout>] http <agent_id> <target> 10 1 5
Traceroute traceroute <agent_id> <target> [<interval>|<hop_timeout>|<hop_max>|<hop_queries>] traceroute <agent_id> <target> 5 2 30 3

Explanation of Paramters

<agent_id> - The agent's unique ID.  Get agent IDs with the command list agents.

<target> - URL or IP address.

<dns_server> - The IP address of the DNS server.

<count> - The number of times the test runs.  The default is 10.

<interval> - The time between each test run, in seconds.  The default is 1 second for Ping, DNS, and HTTP tests and 5 seconds for Traceroute tests.

<timeout> - The amount of time before the test times out and returns a failed result, in seconds.  The default is 5 seconds.

<hop_timeout> - The number of failed hops before the test times out and returns a failed result.  The default is 2.

<hop_max> - The maximum number of hops the traceroute test will count.  The default is 30.

<hop_queries> - The number of queries per hop.  The default is 3.

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk