251 lines
5.2 KiB
C
251 lines
5.2 KiB
C
|
|
/*
|
|
******************************************************************************
|
|
* HEADER FILE
|
|
*
|
|
* Document no: @(#) $Name: VXWORKS_ITER40_2019102207 $ $RCSfile: ipmippm_cli.h,v $ $Revision: 1.2 $
|
|
* $Source: /home/interpeak/CVSRoot/ipmippm/include/ipmippm_cli.h,v $
|
|
* $Author: jhorteli $ $Date: 2009-04-23 15:19:27 $
|
|
* $State: Exp $ $Locker: $
|
|
*
|
|
* INTERPEAK_COPYRIGHT_STRING
|
|
* Design and implementation by Joel Hortelius <joel.hortelius@interpeak.se>
|
|
******************************************************************************
|
|
*/
|
|
#ifndef IPMIPPM_CLI_H
|
|
#define IPMIPPM_CLI_H
|
|
|
|
/*
|
|
****************************************************************************
|
|
* 1 DESCRIPTION
|
|
****************************************************************************
|
|
*/
|
|
|
|
/*
|
|
****************************************************************************
|
|
* 2 CONFIGURATION
|
|
****************************************************************************
|
|
*/
|
|
|
|
/*
|
|
****************************************************************************
|
|
* 3 INCLUDE FILES
|
|
****************************************************************************
|
|
*/
|
|
|
|
#include <private/ipmip4_cli.h>
|
|
#include <private/ipmipmn_api_cli.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*
|
|
****************************************************************************
|
|
* 4 DEFINES
|
|
****************************************************************************
|
|
*/
|
|
|
|
|
|
/*
|
|
****************************************************************************
|
|
* 5 TYPES
|
|
****************************************************************************
|
|
*/
|
|
struct Ipmip_attr;
|
|
struct Ipmip_lladdr;
|
|
|
|
/*
|
|
****************************************************************************
|
|
* 6 FUNCTIONS
|
|
****************************************************************************
|
|
*/
|
|
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* ipmippm_cli_connect - ipmippm_cli_connect
|
|
*
|
|
* Connect to the foreign agent daemon.
|
|
*
|
|
* Parameters:
|
|
* \is
|
|
* \i daemon_info
|
|
* Will be filled in by the function
|
|
* \ie
|
|
*
|
|
* RETURNS: IP_TRUE on success
|
|
*
|
|
* ERRNO:
|
|
*
|
|
*/
|
|
IP_PUBLIC Ip_bool ipmippm_cli_connect
|
|
(
|
|
Ipmip_cli_daemon_t *daemon_info
|
|
);
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* ipmippm_cli_node_get - ipmippm_cli_node_get
|
|
*
|
|
* Retrieve information on a specific node
|
|
*
|
|
* Parameters:
|
|
* \is
|
|
* \i dameon
|
|
* Connection to the daemon
|
|
* \i req
|
|
* Request to use.
|
|
* \ie
|
|
*
|
|
* RETURNS: The RTA containing the node's attributes if found, or IP_NULL.
|
|
*
|
|
* ERRNO:
|
|
*
|
|
*/
|
|
IP_PUBLIC struct Ipmip_attr *ipmippm_cli_node_get
|
|
(
|
|
Ipmip_cli_daemon_t *daemon,
|
|
Ipmip_cli_daemon_req_t *req,
|
|
Ip_u32 handle
|
|
);
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* ipmippm_cli_node_delete - ipmippm_cli_node_delete
|
|
*
|
|
* Delete a specific node
|
|
*
|
|
* Parameters:
|
|
* \is
|
|
* \i dameon
|
|
* Connection to the daemon
|
|
* \i req
|
|
* Request to use.
|
|
* \ie
|
|
*
|
|
* RETURNS: No return value
|
|
*
|
|
* ERRNO:
|
|
*
|
|
*/
|
|
IP_PUBLIC void ipmippm_cli_node_delete
|
|
(
|
|
Ipmip_cli_daemon_t *daemon,
|
|
Ip_u32 handle
|
|
);
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* ipmippm_cli_request_set_handle - ipmippm_cli_request_set_handle
|
|
*
|
|
* Set an handle identifier in the request
|
|
*
|
|
* Parameters:
|
|
* \is
|
|
* \i req
|
|
* Daemon request structure
|
|
* \i handle
|
|
* The handle
|
|
* \ie
|
|
*
|
|
* RETURNS: No return value
|
|
*
|
|
* ERRNO:
|
|
*
|
|
*/
|
|
IP_PUBLIC void ipmippm_cli_request_set_handle
|
|
(
|
|
Ipmip_cli_daemon_req_t *req,
|
|
Ip_u32 handle
|
|
);
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* ipmippm_cli_node_get_handle - ipmippm_cli_node_get_handle
|
|
*
|
|
* Returns the handle setting of the node
|
|
*
|
|
* Parameters:
|
|
* \is
|
|
* \i node
|
|
* rta containing the node attributes
|
|
* \ie
|
|
*
|
|
* RETURNS: The handle or zero if not found
|
|
*
|
|
* ERRNO:
|
|
*
|
|
*/
|
|
IP_PUBLIC Ip_u32 ipmippm_cli_node_get_handle
|
|
(
|
|
struct Ipmip_attr *node
|
|
);
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* ipmippm_cli_handle_next - ipmippm_cli_handle_next
|
|
*
|
|
* Return the next handle
|
|
*
|
|
* Parameters:
|
|
* \is
|
|
* \i iter
|
|
* Iterator
|
|
* \ie
|
|
*
|
|
* RETURNS: The next handle or 0
|
|
*
|
|
* ERRNO:
|
|
*
|
|
*/
|
|
IP_PUBLIC Ip_u32 ipmippm_cli_handle_next
|
|
(
|
|
Ipmip_attr_iter_t *iter
|
|
);
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* ipmippm_cli_node_list - ipmippm_cli_node_list
|
|
*
|
|
* List all nodes matching the specified search criteries
|
|
*
|
|
* Parameters:
|
|
* \is
|
|
* \i dameon
|
|
* Connection to the IPMIPFA daemon
|
|
* \i req
|
|
* Request to use.
|
|
* \i nai
|
|
* NAI to look for, or IP_NULL
|
|
* \i hoa
|
|
* Home Address to look for
|
|
* \ie
|
|
*
|
|
* RETURNS: IPCOM_SUCCESS if the request was successful
|
|
*
|
|
* ERRNO:
|
|
*
|
|
*/
|
|
IP_PUBLIC int ipmippm_cli_node_list
|
|
(
|
|
Ipmip_cli_daemon_t *daemon,
|
|
Ipmip_cli_daemon_req_t *req,
|
|
const char *nai,
|
|
Ip_u32 hoa
|
|
);
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|
|
|
|
/*
|
|
****************************************************************************
|
|
* END OF FILE
|
|
****************************************************************************
|
|
*/
|