Struct UnifiClient 

pub struct UnifiClient { /* private fields */ }

Implementations

impl UnifiClient

pub fn new(host: &str, api_key: &str) -> Result<Self, ApiError>

pub fn new_with_options( host: &str, api_key: &str, options: ClientOptions, ) -> Result<Self, ApiError>

pub fn clone_http(&self) -> Client

pub fn base_url(&self) -> &str

pub async fn list_clients(&mut self) -> Result<Vec<Client>, ApiError>

pub async fn get_client_detail( &self, mac: &str, ) -> Result<LegacyClient, ApiError>

pub async fn set_fixed_ip( &self, mac: &str, ip: &str, name: Option<&str>, ) -> Result<(), ApiError>

pub async fn block_client(&self, mac: &str) -> Result<(), ApiError>

pub async fn unblock_client(&self, mac: &str) -> Result<(), ApiError>

pub async fn kick_client(&self, mac: &str) -> Result<(), ApiError>

pub async fn list_devices(&mut self) -> Result<Vec<Device>, ApiError>

pub async fn get_device_detail( &self, mac: &str, ) -> Result<LegacyDevice, ApiError>

pub async fn restart_device(&self, mac: &str) -> Result<(), ApiError>

pub async fn power_cycle_port( &self, mac: &str, port_idx: u32, ) -> Result<(), ApiError>

Power-cycle a single PoE port. mac is the switch’s MAC, not the attached device’s.

pub async fn upgrade_device(&self, mac: &str) -> Result<(), ApiError>

pub async fn locate_device( &self, mac: &str, enable: bool, ) -> Result<(), ApiError>

pub async fn list_networks(&mut self) -> Result<Vec<Network>, ApiError>

pub async fn list_events(&self, limit: usize) -> Result<Vec<Event>, ApiError>

pub async fn get_device_ports( &self, mac: &str, ) -> Result<DeviceWithPorts, ApiError>

pub async fn list_all_device_ports( &self, ) -> Result<Vec<DeviceWithPorts>, ApiError>

Every device that reports a port table, in one request. /stat/device already returns all devices with their port tables, so the unfiltered listing costs no more than the filtered one.

pub async fn list_clients_legacy(&self) -> Result<Vec<LegacyClient>, ApiError>

pub async fn get_legacy_devices(&self) -> Result<Vec<LegacyDevice>, ApiError>

pub async fn list_protect_cameras(&self) -> Result<Vec<ProtectCamera>, ApiError>

List all cameras from the Protect Integration API.

pub async fn get_protect_camera( &self, id: &str, ) -> Result<ProtectCamera, ApiError>

Get a single camera by ID from the Protect Integration API.

pub async fn get_rtsps_streams( &self, camera_id: &str, ) -> Result<RtspsStreams, ApiError>

Get existing RTSPS stream URLs for a camera.

pub async fn create_rtsps_streams( &self, camera_id: &str, qualities: &[String], ) -> Result<RtspsStreams, ApiError>

Create new RTSPS streams for a camera at the specified quality levels.

pub async fn delete_rtsps_streams( &self, camera_id: &str, qualities: &[String], ) -> Result<(), ApiError>

Delete RTSPS streams for a camera at the specified quality levels.

pub async fn resolve_camera_id( &self, id_or_name: &str, ) -> Result<String, ApiError>

Resolve a camera identifier (ID or name) to a camera ID. If the input is a 24-char hex string, treats it as an ID. Otherwise, searches by name (case-insensitive).

A name that fits more than one camera is an error rather than a choice made silently: the caller may be about to delete that camera’s streams, and picking whichever the controller happened to list first would act on a different camera than the one the user was asked to confirm.

pub async fn get_health(&self) -> Result<Vec<HealthSubsystem>, ApiError>

pub async fn get_sysinfo(&self) -> Result<SysInfo, ApiError>

pub async fn get_host_system(&self) -> Result<HostSystem, ApiError>