Skip to content
Back

IDeviceInfo

Interface in Oadm.Sdk.Devices · Oadm.Sdk.dll

Read-only view of a managed device, as exposed to plugins.

public interface IDeviceInfo

Guide: Devices and VAPIX

Properties

Section titled “Properties”

Address

Section titled “Address”
string Address { get; }

The address OADM reaches the device at: an IP address or a DNS name, with a port when it is not the default.

Apis

Section titled “Apis”
IReadOnlyList<DeviceApi> Apis { get; }

VAPIX APIs and versions from the last full refresh; empty until known. See DeviceApiExtensions.

Category

Section titled “Category”
DeviceCategory Category { get; }

Kind of Axis device, mapped from basicdeviceinfo ProdType. Unknown until read.

CertNotAfterUtc

Section titled “CertNotAfterUtc”
DateTime? CertNotAfterUtc { get; }

Default implementation

End of validity (UTC) of the device HTTPS certificate; null for HTTP-only devices or when not checked yet.

CertTrustName

Section titled “CertTrustName”
string? CertTrustName { get; }

Default implementation

Chain trust of the HTTPS certificate as shown in the device grid: “Trusted”, “SelfSigned”, “Untrusted” or “Expired”; null when unknown or HTTP only. Filled by the server.

CredentialUserName

Section titled “CredentialUserName”
string? CredentialUserName { get; }

Default implementation

User name of the credentials OADM stores for this device (never the password), null when none are stored or not known (client side). Plugins that manage users must never remove or demote it. Filled by the server for task execution, queries and CanRun.

DhcpEnabled

Section titled “DhcpEnabled”
bool? DhcpEnabled { get; }

Default implementation

The device gets its IPv4 address from DHCP (param Network.BootProto); null when not known. Filled by the server.

Dot1xEnabled

Section titled “Dot1xEnabled”
bool? Dot1xEnabled { get; }

Default implementation

IEEE 802.1X is enabled on the wired interface (param Network.Interface.I0.dot1x.Enabled); null when not known. Filled by the server.

FirmwareVersion

Section titled “FirmwareVersion”
string? FirmwareVersion { get; }

The AXIS OS version (“12.11.77”); null until the device was read.

HasVideo

Section titled “HasVideo”
bool HasVideo { get; }

The device produces video (camera, encoder, video intercom). Use it in CanRun, e.g. for snapshots.

HostName

Section titled “HostName”
string? HostName { get; }

The verified DNS name or the host name the device was added with; null when none is known.

HttpsEnabled

Section titled “HttpsEnabled”
bool? HttpsEnabled { get; }

Default implementation

HTTPS is enabled on the device (param HTTPS.Enabled); null when not known. Filled by the server.

Id

Section titled “Id”
Guid Id { get; }

OADM’s id of the device: the key of every call and of a plugin’s own data.

Model

Section titled “Model”
string? Model { get; }

The product number (“P3265-V”); null until the device was read.

Serial

Section titled “Serial”
string Serial { get; }

The serial number, which is the MAC address: upper case hex without separators (“B8A44F631339”).

Status

Section titled “Status”
DeviceStatus Status { get; }

The status from the last poll (every 60 s by default). Check it before sending anything: see DeviceMessages.Refusal.

Tags

Section titled “Tags”
IReadOnlyList<string> Tags { get; }

Default implementation

The device’s tags (names, sorted, case-insensitive distinct), e.g. “Building A”, “PTZ”; empty when none. Tags are set by the user in the Devices page (Tags dialog); colors are not part of the SDK. Filled on server and client.

Used by

Section titled “Used by”