unix_telnet(3)

unix_telnet(3erl)          Erlang Module Definition          unix_telnet(3erl)

NAME
       unix_telnet - Callback module for ct_telnet, for connecting to a Telnet
           server on a UNIX host.

DESCRIPTION
       Callback  module  for ct_telnet, for connecting to a Telnet server on a
       UNIX host.

       It requires the following entry in the configuration file:

        {unix,[{telnet,HostNameOrIpAddress},
               {port,PortNum},                 % optional
               {username,UserName},
               {password,Password},
               {keep_alive,Bool}]}.            % optional

       To communicate through Telnet to the host specified by  HostNameOrIpAd-
       dress,   use   the  interface  functions  in  ct_telnet,  for  example,
       open(Name) and cmd(Name,Cmd).

       Name is the name you allocated to the Unix host in your require  state-
       ment, for example:

        suite() -> [{require,Name,{unix,[telnet]}}].

       or

        ct:require(Name,{unix,[telnet]}).

       The  "keep  alive" activity (that is, that Common Test sends NOP to the
       server every 10 seconds if the connection is idle) can  be  enabled  or
       disabled  for  one  particular  connection as described here. It can be
       disabled for all connections using telnet_settings (see ct_telnet).

       The {port,PortNum} tuple is optional and  if  omitted,  default  Telnet
       port  23  is used. Also the keep_alive tuple is optional, and the value
       defauls to true (enabled).

EXPORTS
       connect(ConnName, Ip, Port, Timeout, KeepAlive, TCPNoDelay,  Extra)  ->
       {ok, Handle} | {error, Reason}

              Types:

                 ConnName = target_name()
                 Ip = string() | {integer(), integer(), integer(), integer()}
                 Port = integer()
                 Timeout = integer()
                 KeepAlive = bool()
                 TCPNoDelay = bool()
                 Extra = target_name() | {Username, Password}
                 Username = string()
                 Password = string()
                 Handle = handle()
                 Reason = term()

              Callback for ct_telnet.erl.

              Setup Telnet connection to a Unix host.

              For target_name(), see ct. For handle(), see ct_telnet.

       get_prompt_regexp() -> PromptRegexp

              Types:

                 PromptRegexp = prompt_regexp()

              Callback for ct_telnet.erl.

              Returns  a  suitable  regexp  string matching common prompts for
              users on Unix hosts.

              For prompt_regexp(), see ct_telnet.

SEE ALSO
       ct, ct_telnet

Ericsson AB                    common_test 1.19              unix_telnet(3erl)