owup(1)
| owup(1) | General Commands Manual | owup(1) |
NAME
owup - Client application to query the server for uptime information
SYNOPSIS
owup [options] servhost
DESCRIPTION
owup is a command line client application used to fetch uptime information from the server. The owampd greeting message provides uptime information. This can be useful information for clients that run long-duration test and for monitoring purposes.
servhost can be specified using rfc2396 and rfc2732 syntax for both host and port specification:
- node:port
-
IPv4 syntax where node is either a DNS name or a numeric host address string consisting of a dotted decimal IPv4 address. The port is an optional port specifier to contact servers running on a non-default port and can be left off in most cases. This syntax also works for IPv6 addresses specified using DNS names. - [node]:port
- IPv6 syntax where node is specified using a numeric IPv6 host address string. The []'s are required only if the optional port port specifier is used.
OPTIONS
- -h
-
Print a usage message and exit.
- Default:
- Unset.
Connection/Authentication Options:
- -4
-
Forces the client to use IPv4 addresses only.
- Default:
- Unset. Client will use IPv4 or IPv6 address, but tries IPv6 first.
- -6
-
Forces the client to use IPv6 addresses only.
- Default:
- Unset. Client will use IPv4 or IPv6 address, but tries IPv6 first.
- -A authmode
-
Specify the authentication modes the client is willing to use for communication. authmode should be set as a character string with any or all of the characters "AEO". The modes are:
- A
- [A]uthenticated. This mode encrypts the control connection and digitally signs part of each test packet.
- E
- [E]ncrypted. This mode encrypts the control connection and encrypts each test packet in full.
- O
- [O]pen. No encryption of any kind is done.
The client can specify all the modes with which it is willing to communicate. The most strict mode that both the OWAMP server and the OWAMP client are willing to use will be selected. Authenticated and Encrypted modes require a "shared secret" in the form of a pass-phrase that is used to generate the AES and HMAC-SHA1 session keys.
- Default:
- "AEO".
- -k pfsfile
-
Use the pass-phrase in pfsfile for username to derive the symmetric AES key used for encryption. username must have a valid entry in pfsfile. pfsfile can be generated as described in the pfstore(1) manual page.
- Default:
- Unset. (If the -u option was specified without the -k, the user will be prompted for a passphrase.)
- -S srcaddr
-
Bind the local address of the client socket to srcaddr. srcaddr can be specified using a DNS name or using standard textual notations for the IP addresses. (IPv6 addresses are of course supported.)
- Default:
- Unspecified (wild-card address selection).
- -B interface
-
Bind the client sockets to the network interface interface with SO_BINDTODEVICE.
- Default:
- Unspecified (sockets not bound to a particular interface).
- -Z
-
Do not specify sender and receiver IP addresses for tests packets when creating a TWAMP session. This allows the UDP test packets to pass through some types of NAT. This option is not available for OWAMP.
- Default:
- Unspecified (addresses for test packets are defined by the client).
- -u username
-
Specify the username that identifies the shared secret (pass-phrase) used to derive the AES and HMAC-SHA1 session keys for authenticated and encrypted modes. If the -k option is specified, the pass-phrase is retrieved from the pfsfile, otherwise the user is prompted for a pass-phrase.
- Default:
- Unset.
EXAMPLES
owup somehost.com
- Contact host somehost.com. Fetch the uptime information and display it.
SEE ALSO
owampd(8), owping(1), owstats(1), aespasswd(1) and the http://e2epi.internet2.edu/owamp/ web site.
ACKNOWLEDGMENTS
This material is based in part on work supported by the National Science Foundation (NSF) under Grant No. ANI-0314723. Any opinions, findings and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the NSF.
| $Date$ |