1LIBNUTCLIENT_MISC(3)              NUT Manual              LIBNUTCLIENT_MISC(3)
2
3
4

NAME

6       libnutclient_misc, nutclient_authenticate, nutclient_logout,
7       nutclient_device_login, nutclient_get_device_num_logins,
8       nutclient_device_master, nutclient_device_forced_shutdown -
9       Miscellaneous functions in Network UPS Tools high-level client access
10       library
11

SYNOPSIS

13       #include <nutclient.h>
14
15       typedef void* NUTCLIENT_t;
16
17       void nutclient_authenticate(
18               NUTCLIENT_t client,
19               const char* login, const char* passwd);
20
21       void nutclient_logout(NUTCLIENT_t client);
22
23       void nutclient_device_login(NUTCLIENT_t client, const char* dev);
24
25       int nutclient_get_device_num_logins(NUTCLIENT_t client, const char* dev);
26
27       void nutclient_device_primary(NUTCLIENT_t client, const char* dev);
28       /* OBSOLETED name: */
29       void nutclient_device_master(NUTCLIENT_t client, const char* dev);
30
31       void nutclient_device_forced_shutdown(NUTCLIENT_t client, const char* dev);
32

DESCRIPTION

34       The nutclient_authenticate() function authenticates the user.
35
36       •   login is the user name.
37
38       •   passwd is the user password.
39
40       The nutclient_logout() function disconnects gracefully from the server.
41
42       The nutclient_device_login() function logs the fact that a system is
43       drawing power from this UPS.
44
45       The nutclient_get_device_num_logins() function retrieves the number of
46       clients which have been logged for this device.
47
48       The nutclient_device_master() and nutclient_device_primary() (note: the
49       former is obsoleted since NUT v2.8.0 in favor of the latter) functions
50       make sure that primary-mode functions like FSD are available if
51       necessary.
52
53       The nutclient_device_forced_shutdown() function sets the "forced
54       shutdown" flag on the device.
55
56       dev is the device name.
57

SEE ALSO

59       libnutclient(3)
60
61
62
63Network UPS Tools 2.8.0           04/26/2022              LIBNUTCLIENT_MISC(3)
Impressum