:orphan: .. index:: pair: group; CLI .. _doxid-group__tapi__tad__cli: CLI === .. toctree:: :hidden: enum_tapi_cli_csap_type.rst enum_tapi_cli_prompt_t.rst Overview ~~~~~~~~ Declarations of API for TAPI CLI. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // enums enum :ref:`tapi_cli_csap_type`; enum :ref:`tapi_cli_prompt_t`; // global variables const char*const :ref:`tapi_cli_csap_type_name`[]; const char*const :ref:`tapi_cli_redhat_cprompt_dflt`; const char*const :ref:`tapi_cli_debian_cprompt_dflt`; const char*const :ref:`tapi_cli_serial_lprompt_dflt`; const char*const :ref:`tapi_cli_serial_pprompt_dflt`; const char*const :ref:`tapi_cli_telnet_lprompt_dflt`; const char*const :ref:`tapi_cli_telnet_pprompt_dflt`; const char*const :ref:`tapi_cli_ssh_lprompt_dflt`; const char*const :ref:`tapi_cli_ssh_pprompt_dflt`; const char*const :ref:`tapi_cli_shell_lprompt_dflt`; const char*const :ref:`tapi_cli_shell_pprompt_dflt`; // global functions int :ref:`tapi_cli_csap_local_create`(const char* ta_name, int sid, const char* device, :ref:`tapi_cli_prompt_t` command_prompt_type, const char* command_prompt, :ref:`tapi_cli_prompt_t` login_prompt_type, const char* login_prompt, const char* login_name, :ref:`tapi_cli_prompt_t` password_prompt_type, const char* password_prompt, const char* password, :ref:`csap_handle_t`* cli_csap); int :ref:`tapi_cli_csap_remote_create`(const char* ta_name, int sid, int type, const char* host, int port, :ref:`tapi_cli_prompt_t` command_prompt_type, const char* command_prompt, :ref:`tapi_cli_prompt_t` login_prompt_type, const char* login_prompt, const char* login_name, :ref:`tapi_cli_prompt_t` password_prompt_type, const char* password_prompt, const char* password, :ref:`csap_handle_t`* cli_csap); int :ref:`tapi_cli_csap_shell_create`(const char* ta_name, int sid, const char* shell_args, :ref:`tapi_cli_prompt_t` command_prompt_type, const char* command_prompt, :ref:`tapi_cli_prompt_t` login_prompt_type, const char* login_prompt, const char* login_name, :ref:`tapi_cli_prompt_t` password_prompt_type, const char* password_prompt, const char* password, :ref:`csap_handle_t`* cli_csap); int :ref:`tapi_cli_csap_create`(const char* ta_name, int sid, const char* buf, :ref:`csap_handle_t`* cli_csap); int :ref:`tapi_cli_send`(const char* ta_name, int sid, :ref:`csap_handle_t` cli_csap, const char* command); int :ref:`tapi_cli_send_recv_with_prompts`(const char* ta_name, int sid, :ref:`csap_handle_t` cli_csap, const char* command, char** msg, unsigned int timeout, :ref:`tapi_cli_prompt_t` cmd_prompt_type, const char* cmd_prompt, :ref:`tapi_cli_prompt_t` passwd_prompt_type, const char* passwd_prompt); static int :ref:`tapi_cli_send_recv`(const char* ta_name, int sid, :ref:`csap_handle_t` cli_csap, const char* command, char** msg, unsigned int timeout); static int :ref:`tapi_cli_send_recv_with_prompt`(const char* ta_name, int sid, :ref:`csap_handle_t` cli_csap, const char* command, char** msg, unsigned int timeout, :ref:`tapi_cli_prompt_t` cmd_prompt_type, const char* cmd_prompt); // macros #define :ref:`TAPI_CLI_CSAP_CREATE_SERIAL`(ta_name, sid, device, user, pwd, cprompt, cli_csap) #define :ref:`TAPI_CLI_CSAP_CREATE_SHELL`(ta_name, sid, shell_args, cprompt, lprompt, user, pprompt, pwd, cli_csap) #define :ref:`TAPI_CLI_CSAP_CREATE_SSH`(ta_name, sid, host, user, pwd, cprompt, cli_csap) #define :ref:`TAPI_CLI_CSAP_CREATE_TELNET`(ta_name, sid, host, user, pwd, cprompt, cli_csap) #define :ref:`TAPI_CLI_SSH_PORT_DFLT` #define :ref:`TAPI_CLI_TELNET_PORT_DFLT` .. _details-group__tapi__tad__cli: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Declarations of API for TAPI CLI. Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Global Variables ---------------- .. index:: pair: variable; tapi_cli_csap_type_name .. _doxid-group__tapi__tad__cli_1gaec5ab2f64bd556366be18c131efe60ad: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char*const tapi_cli_csap_type_name[] CLI CSAP type names .. index:: pair: variable; tapi_cli_redhat_cprompt_dflt .. _doxid-group__tapi__tad__cli_1ga27f5896b64b7afcf3ccc5bc44f93e462: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char*const tapi_cli_redhat_cprompt_dflt Default command prompt on redhat is '[...]$ ' .. index:: pair: variable; tapi_cli_debian_cprompt_dflt .. _doxid-group__tapi__tad__cli_1ga5a34ee521eeac313b0f35c75a6ba454d: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char*const tapi_cli_debian_cprompt_dflt Default command prompt on debian is '...$ ' .. index:: pair: variable; tapi_cli_serial_lprompt_dflt .. _doxid-group__tapi__tad__cli_1gab11c452e81608bbe988b312cee18551c: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char*const tapi_cli_serial_lprompt_dflt Default login prompt for serial console is '[L\|l]ogin: ' .. index:: pair: variable; tapi_cli_serial_pprompt_dflt .. _doxid-group__tapi__tad__cli_1gae8edcb40d2e78e81cf95a2d3b1e34495: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char*const tapi_cli_serial_pprompt_dflt Default password prompt for serial console is '[P\|p]assword: ' .. index:: pair: variable; tapi_cli_telnet_lprompt_dflt .. _doxid-group__tapi__tad__cli_1ga6d8fa86c04fff5c826d1ae8e8a1f176c: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char*const tapi_cli_telnet_lprompt_dflt Default login prompt for telnet console is 'Login: ' .. index:: pair: variable; tapi_cli_telnet_pprompt_dflt .. _doxid-group__tapi__tad__cli_1gaa2ac20c8f51f929cded234d52b7d1f0f: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char*const tapi_cli_telnet_pprompt_dflt Default password prompt for telnet console is '[P\|p]assword: ' .. index:: pair: variable; tapi_cli_ssh_lprompt_dflt .. _doxid-group__tapi__tad__cli_1ga313151448559c7c266cf892994cd9474: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char*const tapi_cli_ssh_lprompt_dflt There is no default login prompt for ssh console .. index:: pair: variable; tapi_cli_ssh_pprompt_dflt .. _doxid-group__tapi__tad__cli_1ga2a7a3fe904b056ee977c23557b50d654: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char*const tapi_cli_ssh_pprompt_dflt Default password prompt for ssh console is '[P\|p]assword: ' .. index:: pair: variable; tapi_cli_shell_lprompt_dflt .. _doxid-group__tapi__tad__cli_1ga1e3dfe3f7f46336d68b249d3908abff5: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char*const tapi_cli_shell_lprompt_dflt Default login prompt for shell console is '[L\|l]ogin: ' .. index:: pair: variable; tapi_cli_shell_pprompt_dflt .. _doxid-group__tapi__tad__cli_1ga14e97c8530c425495af18d0c49e36420: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char*const tapi_cli_shell_pprompt_dflt Default password prompt for shell console is '[P\|p]assword: ' Global Functions ---------------- .. index:: pair: function; tapi_cli_csap_local_create .. _doxid-group__tapi__tad__cli_1gaf979e39925c60b613fedf3f4a3377da8: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cli_csap_local_create(const char* ta_name, int sid, const char* device, :ref:`tapi_cli_prompt_t` command_prompt_type, const char* command_prompt, :ref:`tapi_cli_prompt_t` login_prompt_type, const char* login_prompt, const char* login_name, :ref:`tapi_cli_prompt_t` password_prompt_type, const char* password_prompt, const char* password, :ref:`csap_handle_t`* cli_csap) Create common CLI CSAP on local device (using millicom). .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - sid - RCF session * - device - Local device name * - command_prompt_type - Expected command prompt type (plain or regular expression) * - command_prompt - Expected command prompt (when commands may be sent) * - login_prompt_type - Expected login prompt type (plain or regular expression) * - login_prompt - Expected login prompt (when login name may be sent) * - login_name - Login name to be sent if login prompt is detected * - password_prompt_type - Expected password prompt type (plain or regular expression) * - password_prompt - Expected password prompt (when password may be sent) * - password - Password to be sent if password prompt is detected * - cli_csap - Identifier of created CSAP (OUT) .. rubric:: Returns: 0 on success, otherwise standard or common TE error code. .. index:: pair: function; tapi_cli_csap_remote_create .. _doxid-group__tapi__tad__cli_1ga9f4d1993bde184982d4d0b568139a1fe: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cli_csap_remote_create(const char* ta_name, int sid, int type, const char* host, int port, :ref:`tapi_cli_prompt_t` command_prompt_type, const char* command_prompt, :ref:`tapi_cli_prompt_t` login_prompt_type, const char* login_prompt, const char* login_name, :ref:`tapi_cli_prompt_t` password_prompt_type, const char* password_prompt, const char* password, :ref:`csap_handle_t`* cli_csap) Create common CLI CSAP on remote connection (telnet or ssh). .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - sid - RCF session * - type - Remote connection type (telnet or ssh) * - host - Remote host name * - port - Remote port number * - command_prompt_type - Expected command prompt type (plain or regular expression) * - command_prompt - Expected command prompt (when commands may be sent) * - login_prompt_type - Expected login prompt type (plain or regular expression) * - login_prompt - Expected login prompt (when login name may be sent) * - login_name - Login name to be sent if login prompt is detected * - password_prompt_type - Expected password prompt type (plain or regular expression) * - password_prompt - Expected password prompt (when password may be sent) * - password - Password to be sent if password prompt is detected * - cli_csap - Identifier of created CSAP (OUT) .. rubric:: Returns: 0 on success, otherwise standard or common TE error code. .. index:: pair: function; tapi_cli_csap_shell_create .. _doxid-group__tapi__tad__cli_1gae1c7864757a4706cd4e2a90629f06543: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cli_csap_shell_create(const char* ta_name, int sid, const char* shell_args, :ref:`tapi_cli_prompt_t` command_prompt_type, const char* command_prompt, :ref:`tapi_cli_prompt_t` login_prompt_type, const char* login_prompt, const char* login_name, :ref:`tapi_cli_prompt_t` password_prompt_type, const char* password_prompt, const char* password, :ref:`csap_handle_t`* cli_csap) Create common CLI CSAP using shell. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - sid - RCF session * - shell_args - Arguments to shell interpreter * - command_prompt_type - Expected command prompt type (plain or regular expression) * - command_prompt - Expected command prompt (when commands may be sent) * - login_prompt_type - Expected login prompt type (plain or regular expression) * - login_prompt - Expected login prompt (when login name may be sent) * - login_name - Login name to be sent if login prompt is detected * - password_prompt_type - Expected password prompt type (plain or regular expression) * - password_prompt - Expected password prompt (when password may be sent) * - password - Password to be sent if password prompt is detected * - cli_csap - Identifier of created CSAP (OUT) .. rubric:: Returns: 0 on success, otherwise standard or common TE error code. .. index:: pair: function; tapi_cli_csap_create .. _doxid-group__tapi__tad__cli_1ga5aa704da16ef8c48b20826eb32e0ca91: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cli_csap_create(const char* ta_name, int sid, const char* buf, :ref:`csap_handle_t`* cli_csap) Create common CLI CSAP. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name; * - sid - RCF session; * - buf - CLI CSAP initialisation string. * - cli_csap - Identifier of created CSAP (OUT). .. rubric:: Returns: zero on success, otherwise standard or common TE error code. .. index:: pair: function; tapi_cli_send .. _doxid-group__tapi__tad__cli_1gaa83d113dc17189c380ee3c25bd0c5486: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cli_send(const char* ta_name, int sid, :ref:`csap_handle_t` cli_csap, const char* command) Sends CLI command according specified template from the CSAP. This function is blocking, returns after all commands are sent and CSAP operation finished. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name * - sid - RCF session identifier * - cli_csap - CSAP handle * - command - Command string to be sent to CLI session .. rubric:: Returns: zero on success, otherwise standard or common TE error code. .. index:: pair: function; tapi_cli_send_recv_with_prompts .. _doxid-group__tapi__tad__cli_1gaadd0ee3b561dbaece90ca30d7d047239: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cli_send_recv_with_prompts(const char* ta_name, int sid, :ref:`csap_handle_t` cli_csap, const char* command, char** msg, unsigned int timeout, :ref:`tapi_cli_prompt_t` cmd_prompt_type, const char* cmd_prompt, :ref:`tapi_cli_prompt_t` passwd_prompt_type, const char* passwd_prompt) Send specified command to the CSAP's CLI session and receive response. This function is blocking, returns after all commands are sent and response is received or timeout ocured. The function allows to specify prompts to be used for this operation. If necessary to update login prompt, login name or password for a particular command, please update this function adding new parameters. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name; * - sid - RCF session identifier; * - cli_csap - CSAP handle; * - command - Command to send; * - msg - Returned CLI response to command (memory for the response is allocated inside this routine); * - timeout - CLI response timeout in seconds; * - cmd_prompt_type - Type of command prompt; * - cmd_prompt - Command prompt to use for command run; * - passwd_prompt_type - Type of password prompt; * - passwd_prompt - Password prompt value (NULL to use default); .. rubric:: Returns: zero on success, otherwise standard or common TE error code. .. index:: pair: function; tapi_cli_send_recv .. _doxid-group__tapi__tad__cli_1gae0a7fec740a7a360072f7b88fc468282: .. ref-code-block:: cpp :class: doxyrest-title-code-block static int tapi_cli_send_recv(const char* ta_name, int sid, :ref:`csap_handle_t` cli_csap, const char* command, char** msg, unsigned int timeout) Send specified command to the CSAP's CLI session and receive response. This function is blocking, returns after all commands are sent and response is received or timeout ocured. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name; * - sid - RCF session identifier; * - cli_csap - CSAP handle; * - command - Command to send; * - msg - Returned CLI response to command (memory for the response is allocated inside this routine); * - timeout - CLI response timeout in seconds; .. rubric:: Returns: zero on success, otherwise standard or common TE error code. .. index:: pair: function; tapi_cli_send_recv_with_prompt .. _doxid-group__tapi__tad__cli_1ga94349b2e5098232a4931fab6c8912501: .. ref-code-block:: cpp :class: doxyrest-title-code-block static int tapi_cli_send_recv_with_prompt(const char* ta_name, int sid, :ref:`csap_handle_t` cli_csap, const char* command, char** msg, unsigned int timeout, :ref:`tapi_cli_prompt_t` cmd_prompt_type, const char* cmd_prompt) Send specified command to the CSAP's CLI session and receive response. The function allows to specify command prompt value to use while analyzing the response (suitable when switching between command views). .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test Agent name; * - sid - RCF session identifier; * - cli_csap - CSAP handle; * - command - Command to send; * - msg - Returned CLI response to command (memory for the response is allocated inside this routine); * - timeout - CLI response timeout in seconds; * - cmd_prompt_type - Type of command prompt; * - cmd_prompt - Command prompt to use for command run. .. rubric:: Returns: zero on success, otherwise standard or common TE error code. Macros ------ .. index:: pair: define; TAPI_CLI_CSAP_CREATE_SERIAL .. _doxid-group__tapi__tad__cli_1ga85ad6d90486ebcec227d0a3c92e9fba8: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_CLI_CSAP_CREATE_SERIAL(ta_name, sid, device, user, pwd, cprompt, cli_csap) Macro around :ref:`tapi_cli_csap_local_create() ` .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test agent name * - sid - RCF session id * - device - local device name * - user - Login name to be sent if login prompt is detected * - pwd - Password to be sent if password prompt is detected * - cprompt - Expected command prompt (when commands may be sent) * - cli_csap - Identifier of created CSAP .. index:: pair: define; TAPI_CLI_CSAP_CREATE_SHELL .. _doxid-group__tapi__tad__cli_1ga810a0329ef2f1feb1fa8f49ecc54fd18: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_CLI_CSAP_CREATE_SHELL(ta_name, sid, shell_args, cprompt, lprompt, user, pprompt, pwd, cli_csap) Macro around :ref:`tapi_cli_csap_shell_create() ` when connection type is ``TAPI_CLI_CSAP_TYPE_SHELL`` .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test agent name * - sid - RCF session id * - shell_args - Shell arguments * - user - Login name to be sent if login prompt is detected * - pwd - Password to be sent if password prompt is detected * - cprompt - Expected command prompt (when commands may be sent) * - cli_csap - Identifier of created ``CSAP`` .. index:: pair: define; TAPI_CLI_CSAP_CREATE_SSH .. _doxid-group__tapi__tad__cli_1ga8e3873e7bb7530d23785e359977dacdb: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_CLI_CSAP_CREATE_SSH(ta_name, sid, host, user, pwd, cprompt, cli_csap) Macro around :ref:`tapi_cli_csap_remote_create() ` when connection type is ``TAPI_CLI_CSAP_TYPE_SSH`` .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test agent name * - sid - RCF session id * - host - Remote host name * - user - Login name to be sent if login prompt is detected * - pwd - Password to be sent if password prompt is detected * - cprompt - Expected command prompt (when commands may be sent) * - cli_csap - Identifier of created ``CSAP`` .. index:: pair: define; TAPI_CLI_CSAP_CREATE_TELNET .. _doxid-group__tapi__tad__cli_1ga3e2e96c01011f5b33fec83d4a282910d: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_CLI_CSAP_CREATE_TELNET(ta_name, sid, host, user, pwd, cprompt, cli_csap) Macro around :ref:`tapi_cli_csap_remote_create() ` when connection type is ``TAPI_CLI_CSAP_TYPE_TELNET`` .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta_name - Test agent name * - sid - RCF session id * - host - Remote host name * - user - Login name to be sent if login prompt is detected * - pwd - Password to be sent if password prompt is detected * - cprompt - Expected command prompt (when commands may be sent) * - cli_csap - Identifier of created ``CSAP`` .. index:: pair: define; TAPI_CLI_SSH_PORT_DFLT .. _doxid-group__tapi__tad__cli_1ga4828d7e0955b14d40b7315a4c8ca1b76: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_CLI_SSH_PORT_DFLT Default ssh port is 22 .. index:: pair: define; TAPI_CLI_TELNET_PORT_DFLT .. _doxid-group__tapi__tad__cli_1gaa40f5b3a3eba1ad5fbbac7ec15622ee1: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_CLI_TELNET_PORT_DFLT Default telnet port is 23