LIBNUTCLIENT_MISC(3)

πŸ’– LIBNUTCLIENT_MISC β€” bestie, it's the misc page ✨

okay so this is libnutclient_misc from the NUT Manual β€” aka the Network UPS Tools high-level client access library, and this particular page is the grab-bag of Miscellaneous functions. lowkey iconic. let's go 🫢


✨ NAME ✨

libnutclient_misc, nutclient_authenticate, nutclient_logout, nutclient_device_login, nutclient_get_device_num_logins, nutclient_device_master, nutclient_device_forced_shutdown β€” literally all the miscellaneous functions chilling in the Network UPS Tools high-level client access library πŸ’…


🌸 SYNOPSIS 🌸

no cap, here's the whole cast:

#include <nutclient.h>

typedef void* NUTCLIENT_t;

void nutclient_authenticate(
        NUTCLIENT_t client,
        const char* login, const char* passwd);

void nutclient_logout(NUTCLIENT_t client);

void nutclient_device_login(NUTCLIENT_t client, const char* dev);

int nutclient_get_device_num_logins(NUTCLIENT_t client, const char* dev);

void nutclient_device_primary(NUTCLIENT_t client, const char* dev);
/* OBSOLETED name: */
void nutclient_device_master(NUTCLIENT_t client, const char* dev);

void nutclient_device_forced_shutdown(NUTCLIENT_t client, const char* dev);

πŸ¦‹ DESCRIPTION πŸ¦‹

okay so here's the tea on each one of these besties:

  • the nutclient_authenticate() function authenticates the user. that's it, that's the job πŸ’…
    • login is the user name.
    • passwd is the user password.
  • the nutclient_logout() function disconnects gracefully from the server. no dramatic exits, we're leaving politely πŸŽ€
  • the nutclient_device_login() function logs the fact that a system is drawing power from this UPS. like, noting it down, fr fr ⚑
  • the nutclient_get_device_num_logins() function retrieves the number of clients which have been logged for this device. it's giving census energy πŸ“‹
  • the nutclient_device_master() and nutclient_device_primary() functions make sure that primary-mode functions like FSD are available if necessary.
🚨 note: the former (nutclient_device_master) is obsoleted since NUT v2.8.0 in favor of the latter (nutclient_device_primary). so like… use the new one, bestie. the old name is still around but it's giving ✨ nostalgia ✨ not ✨ recommendation ✨
  • the nutclient_device_forced_shutdown() function sets the "forced shutdown" (FSD) flag on the device. dramatic? yes. necessary? sometimes πŸ”₯

🌈 Common arguments 🌈

  • dev is the device name.

πŸ‘‘ SEE ALSO πŸ‘‘

libnutclient(3) β€” go read that one too, iykyk 🧚


and that's the whole page, periodt. sending you off with the vibe check: Network UPS Tools 2.8.5, dated 10/07/2026 πŸ’–βœ¨πŸŽ€πŸ¦‹πŸŒΈπŸ’…πŸ«Ά

πŸ“¦ where this page comes from