Octopussy::Device(3)

✨ Octopussy::Device ✨

okay bestie, sit down, hydrate, because this is the Octopussy Device module — it's the part of Octopussy that handles, you guessed it, devices. It lives in the Octopussy::Device namespace, it's Perl, and it's giving very organized, very slay 💅 (also hi, it's User Contributed Perl Documentation, so it's fan-made excellence, iykyk 🎀)

---

🌸 FUNCTIONS 🌸

every single one of these, in order, no skips, periodt.

🦋 New($conf)

Creates a new Device. baby's first device, literally ✨

🦋 Modify($conf_new)

Modifies the configuration of a Device. glow-up time 💖

🦋 Reload_Required($device)

Sets 'reload_required' to Device '$device'. like, the device needs a lil reload, okay? noted 📝

🦋 Remove($device)

Removes device '$device'. it's not you it's the config 😭

🦋 List()

Gets List of Devices. the whole roster, the whole squad 🫶

🦋 String_List

Returns Device List as a string like 'Device list: <device_list>'. so you can just, like, print it and go 🎀

🦋 Unknowns(@devices)

Returns list of Unknown Devices in @devices list. the ones that didn't show up to the group chat 🙈

🦋 Filename($device_name)

Gets the XML filename for the device '$device_name'. yes bestie, XML, it's giving 2000s but it works 💀

🦋 Configuration($device_name)

Gets the configuration for the device '$device_name'. one device, one config, iconic 👑

🦋 Configurations($sort)

Gets the configuration for all devices. everybody, all at once 🔥

🦋 Filtered_Configurations($type, $model, $sort)

Gets the configuration for devices filtered by DeviceType/Model. vibe check by type AND model, we're being ✨specific✨

🦋 Add_Service($device, $service)

Adds Service or Servicegroup '$service' to Device '$device'. bestie is getting a new service, we love to see it 💜

🦋 Remove_Service($device_name, $service_name)

Removes a service '$service_name' from device '$device_name'. and we're unsubscribing 💅

🦋 Update_Services_Rank($conf, $service, $direction, $rank, $old_rank)

Updates Services Rank. the leaderboard of services, fr fr 🏆

🦋 Move_Service($device, $service, $direction)

Moves Service '$service' into Device '$device' Services List in Direction Top, Bottom, Up or Down ('$direction'). so the only valid directions are Top, Bottom, Up or Down — don't get creative, bestie 🙈

🦋 Services(@devices)

Gets Service list (sorted by rank) from Device list '@devices'. ranked, sorted, main character ordering ✨

🦋 String_Services

Returns Service List as a string like 'Service list: <service_list>'. stringified and ready to serve 🍓

🦋 Services_Configurations($device, $sort)

Returns Services Configurations sorted by '$sort' field for Device '$device'. you pick the sort field, it does the work, we stan 😌

🦋 Services_Statistics($device)

the original page gives this one no description at all — just the signature. so like, no cap, that's all we know. we're not gonna make stuff up, bestie 💀

🦋 With_Service($service)

Returns List of Device which have Service '$service' in its Services List. who's got this service? we found them 👀

🦋 Types()

Returns Device Types List. all the flavors 🌈

🦋 Type_Configurations()

same situation as Services_Statistics — the original lists the name and nothing else. no description, no speculation, periodt ✋

🦋 Models($type)

Returns Device Models List. give it a '$type', get the models back, easy 🎀

🦋 Parse_Status($device)

Returns Parsing status of the Device '$device'. are we parsing or are we not, that's the question 💖

🦋 Parse_Pause($device)

Pauses Parsing for Device '$device'. hold up, brb 🫶

🦋 Parse_Start($device)

Starts Parsing for Device '$device'. and we're back, let's go 🔥

🦋 Parse_Stop($device)

Stops Parsing for Device '$device'. okay we're done here 💅

🦋 Set_Service_Option($device, $service, $option, $action)

Set Service Option (compression or statistics) to enable or disable. so the options in play are compression and statistics, and you're either enabling or disabling them — that's the whole deal ✨

🦋 Valid_Name($name)

Checks that '$name' is valid for a Device name. naming your device is a whole thing, so let this one vibe check it first 👑

---

💖 AUTHOR 💖

Sebastien Thebert <octo.devel@gmail.com> — thank you for your service, legend 🫶🌟

---

and that's the whole page, bestie! this was Octopussy::Device(3) from the perl v5.22.2 docs, dated 2016-05-04 🎀 go forth and configure your devices, you've got this 💜✨🦋