User::I...:System(3)

📦
version 4.00 · 9 versions
, in fedora 44

💖 User::I...:System(3) — User Contributed Perl Documentation 💖

okay bestie, sit down, we're talking about User::I...:System(3) from the User Contributed Perl Documentation section. it's giving perl, it's giving identity management, it's giving "yes i have a presence on that server actually". let's get into it 🫶

✨ NAME ✨

User::Identity::System — the physical system of a person. like, the actual box. the machine. her server. 💻✨

🌸 INHERITANCE 🌸

User::Identity::System
  is a User::Identity::Item

so yeah, it's a User::Identity::Item underneath. family tree moment 👑

🦋 SYNOPSIS 🦋

use User::Identity;
use User::Identity::System;
my $me   = User::Identity->new(...);
my $server = User::Identity::System->new(...);
$me->add(system => $server);

# Simpler

use User::Identity;
my $me   = User::Identity->new(...);
my $addr = $me->add(system => ...);

look at that second one. the Simpler version. lowkey the main character. you just add a system and the object builds itself for you. slay ✨

🌈 DESCRIPTION 🌈

so the User::Identity::System object holds the description of a user's presence on a system. that's the whole vibe. your person, on a machine, described. 💅

the systems get collected together by a User::Identity::Collection::Systems object — like a little friend group of servers, no cap.

⚠️ important bestie: nearly all methods can return undef. so check your returns. don't be out here assuming things. 😭

this extends DESCRIPTION in User::Identity::Item.

💅 METHODS 💅

extends METHODS in User::Identity::Item.

🎀 Constructors 🎀

extends Constructors in User::Identity::Item.

  • $class->new( [$name], %options ) — creates a shiny new system. you can pass a name as the first argument, or just drop it in the OPTION list. and if you don't give it a name at all? the organization gets used as the name instead. cute little fallback. 🙈

here's the full options table, verbatim, because facts are facts:

 -Option     --Defined in          --Default
  description  User::Identity::Item  undef
  hostname                           'localhost'
  location                           undef
  name         User::Identity::Item  <required>
  os                                 undef
  parent       User::Identity::Item  undef
  password                           undef
  username                           undef

and now the breakdown, one by one:

  • description => STRING — the description, obviously.
  • hostname => $name — the $name of the system we're describing. and listen, it is preferred to use full system names, not abbreviations. like, use "www.tux.aq" instead of just "www" so you don't get your wires crossed. full names only, we're not doing confusion today. 🚫
  • location => $nick|OBJECT — the $nick of a location that's defined for the same user. or you can just hand it a User::Identity::Location OBJECT directly. your call, bestie.
  • name => STRING — the name. yeah.
  • os => STRING — the name of the operating system running on the server. it is advised to use the same names Perl's $^O variable uses. go peek at the perlvar man-page for that variable, and perlport for all the possible values. iykyk 📖
  • parent => OBJECT — the parent object.
  • password => STRING — the password used to log in. and it must be un-encoded: directly usable.
🚨 BESTIE. LISTEN. be warned that storing un-encoded passwords is a high security list. that's the actual wording and it is NOT a drill. this is the dangerous part of the page. do not leave your plaintext passwords lying around like yesterday's iced coffee. 💀
  • username => STRING — the username used to log in to this host.

🌸 Attributes 🌸

extends Attributes in User::Identity::Item.

  • $obj->description() — inherited, see "Attributes" in User::Identity::Item.
  • $obj->hostname() — the hostname getter, that's it, that's the tweet.
  • $obj->location() — returns the object that describes which location this system relates to. the location can be used to find the name of the organization involved, or to create a signature. and if no location was specified? you get undef back. 🙈
  • $obj->name( [$newname] ) — inherited, see "Attributes" in User::Identity::Item.
  • $obj->os() — the OS.
  • $obj->password() — the password. (un-encoded, remember? we talked about this. 😭)
  • $obj->username() — the username.

🧚 Collections 🧚

extends Collections in User::Identity::Item.

  • $obj->add($collection, $role) — inherited, see "Collections" in User::Identity::Item.
  • $obj->addCollection( $object | <[$type], %options> ) — inherited, see "Collections" in User::Identity::Item.
  • $obj->collection($name) — inherited, see "Collections" in User::Identity::Item.
  • $obj->parent( [$parent] ) — inherited, see "Collections" in User::Identity::Item.
  • $obj->removeCollection($object|$name) — inherited, see "Collections" in User::Identity::Item.
  • $any->type() — inherited, see "Collections" in User::Identity::Item.
  • $obj->user() — inherited, see "Collections" in User::Identity::Item.

🔍 Searching 🔍

extends Searching in User::Identity::Item.

  • $obj->find($collection, $role) — inherited, see "Searching" in User::Identity::Item.

💀 DIAGNOSTICS 💀

the error messages, and what they're actually trying to tell you:

  • Error: cannot load collection module for $type ($class): $@ — either the $type you specified doesn't exist, or that module named $class is throwing compilation errors. and if the type named in the warning isn't a package name, then you gave a nickname that was never defined — maybe you forgot to require the package that defines that nickname. cast by addCollection().
  • Error: nvalid collection $name. — the collection with $name doesn't exist and can't be created. cast by add(). (yes, it really says nvalid. we don't fix, we report. 🫡)
  • Error: this $object is not a collection. — cast by addCollection().

👑 SEE ALSO 👑

this module is part of User-Identity version 4.00, built on December 12, 2025. website: http://perl.overmeer.net/CPAN/ 🌐

📜 LICENSE 📜

for contributors, see file ChangeLog.

this software is copyright (c) 2003-2025 by Mark Overmeer.

this is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. periodt. 💅

and that's the whole page, bestie!! 🎀 this one came out of perl v5.42.0, dated 2026-01-17, and it lives in the User::I...:System(3) slot in your manual. go forth and describe your servers responsibly — and for the love of everything, keep those passwords encoded. mwah 💖✨🦋

📦 where this page comes from