Interfaces

This is a list of IDL-defined interfaces and data structures by module:

[detail level 123]

►Nauth	Local and Remote Authentication Management
CAuthManager	Authentication manager interface
►CClientCertAuthManager	Configuration interface
CCACertInfo	Information about a single CA certificate
CClientCertAuthSettings
COcspSettings
►CLdapManager	LDAP server configuration interface
CServerSettings	Server settings
CPolicy	Authentication policy
►CRadiusManager	RADIUS server configuration interface
CServerSettings	Server settings
►Nbulkcfg	Bulk Configuration
►CBulkConfiguration	Bulk Configuration Interface
CFilter	This structure defines a filter
CFilterProfile	Filter profiles are named collections of filters
CRestoredEvent	Event: Bulk configuration restored (also used for restoring config backup)
CSavedEvent	Event: Bulk configuration saved (also used for saving config backup)
CSettings	Settings
CSettingsChangedEvent	Event: Bulk configuration settings changed
►Nbulkrpc	Bulk RPC
►CBulkRequest	Bulk Request Interface
CRequest	JSON-RPC Request
CResponse	JSON-RPC Response
CRequest	JSON-RPC Request (old format)
CResponse	JSON-RPC Response (old format)
►Ncert	TLS Certificate Management
►CServerSSLCert	TLS certificate management interface
CCertInfo	Certificate information
CCommonAttributes	Certificate issuer or subject attributes
CInfo	Certificate manager information
CKeyInfo	Public key information
CReqInfo	Certificate signing request information
►Ndatetime	Device Date and Time Configuration
►CDateTime	Date and time configuration methods
CCfg	Device date and time configuration
CClockChangedEvent	Event that is sent when the device time is changed
CConfigurationChangedEvent	Event that is sent when the configuration changes
CNtpCfg	Static NTP server configuration
CZoneCfg	Time zone configuration
CZoneInfo	Time zone information (see also ZoneCfg)
►Ndevsettings	Device Settings
►CSmtp	SMTP settings interface
CConfiguration	SMTP server configuration
CTestResult	Result of SMTP configuration test
►CSnmp	SNMP agent settings interface
CConfiguration	SNMP agent configuration
CConfigurationChangedEvent
►CZeroconf	Zero-config service settings interface
CSettings	Zero-configservice settings
CSettingsChangedEvent
►Ndiag	Diagnostics
►CDiagLogSettings	Diagnostic log settings
CLogLevelEntry	An entry containing a context name and its associated context
►Nevent	Event interface
►CChannel	Event Channel
CEventSelect	Structure to select an Event *
►CEngine	There is a single event engine instance reachable by a well known reference
CAction	An action is a tuple of 'id' (unique within the scope of this event engine), 'name' which is unique as well and used by the GUI as user readable identificator, 'isSystem' which denotes the action as system action, 'type' which defines what it is, and an argument vector that vary depending on type and which is passed to the action
CCondition	Condition is a logical combination of multiple events
CEventDesc	An event descriptor
CRule	A Rule binds an action to a condition
CEvent	Event has a type: a STATE event indicates that a boolean state has been changed, i.e
CKeyValue	Helper that is used wherever key/value pairs are required
CService	Event Service
CUserEvent	This UserEvent may be used as base valueobject for all concrete events that are triggered because of user interaction
►Nfirmware	Firmware Management
CCimFirmwareUpdateStatus	CimFirmware update status interface
►CFirmware	Firmware management methods
CInfo	Firmware information
CFirmwareUpdateCompletedEvent	Event: Firmware updated successfully
CFirmwareUpdateEvent	Event: Firmware update base event
CFirmwareUpdateFailedEvent	Event: Firmware update failed
CFirmwareUpdateStartedEvent	Event: Firmware update started
CFirmwareUpdateStatus	Firmware update status interface
CFirmwareValidationFailedEvent	Event: Firmware validation failed
CImageInfo	Firmware image information
CImageStatus	Image upload/download status
CSystemShutdownEvent	Event: System shutdown started
CSystemStartupEvent	Event: System startup finished
CUpdateHistoryEntry	Firmware update history entry TODO: implement CR# 45668 on next interface change add comment field based on firmware tag "char tag[64];" to improve firmware update history entries without rootfs images
CUpdateStatus	Firmware update status
►Nfitness	Fitness Daemon
►CFitness	Fitness Daemon interface
CDataEntry	An entry in the reliability database
CErrorLogEntry	An entry in the reliability error log
►CHardwareHealth
CFailure	Hardware Failure
CFailureStatusChangedEvent	Event that is send when the hardware failure status changes
►Nidl	Basic IDL definitions
CEvent	Common base for all events
►Njsonrpc	Raritan JSON-RPC
CNameService	RPC Object Name Service
►Nlogging	Device Logging
CDebugLog	Device debug log interface
CEventLog	Device event log interface
CEventLogClearedEvent	Event log cleared event
CLogChunk	A log chunk
CLogEntry	A log entry
CLogInfo	General log info
►Nluaservice	Lua-Service
CEnvironment	The struct represents two kinds of information:
CManager	There is a single manager instance
CScriptOptions	Some script options
CScriptState	A structure that descripts the state of a script
►Nnet	Network Configuration
CCommonInfo	Common info
CCommonInfoChangedEvent	Event that is send when common network info has changed
CCommonSettings	Common settings
CDiagnostics	Diagnostics interface
CDnsInfo	DNS info
CDnsSettings	DNS settings
CEapAuthSettings	EAP authentication settings
CEthernetFailoverEvent	Event that is sent when a failover between ethernet ports takes place
CEthInfo	Ethernet interface info
CEthInfoChangedEvent	Event that is send when ethernet interface specific network info has changed
CEthLinkMode	Ethernet link mode
CEthSettings	Ethernet interface settings
CInfo	Network info
CInterfaceInfo	Interface specific info
CInterfaceInfoChangedEvent	Event that is send when common interface specific network info has changed
CInterfaceIpSettings	Interface specific IP settings
CInterfaceIPv4Info	Interface specific IPv4 info
CInterfaceIPv6Info	Interface specific IPv6 info
CInterfaceSettings	Interface specific settings
CIpAddrCidr	IPv4/IPv6 address and prefix len
CIpRoute	IPv4/IPv6 route
CIpRoutingSettings	IP protocol specific routing settings
CLinkStateChangedEvent	Event that is send when the operational state of an interface changed
CNet	Network configuration interface
CPortForwardingExpansionUnitPresenceStateChangedEvent	Event that is send when the presence state of a downstream port forwarding expansion unit changes
CPortForwardingInfo	Port forwarding info
CPortForwardingPrimaryUnitAddrInfo	Port forwarding primary unit address info for an interface
CPortForwardingProtocolMapping	Mapping from application protocol id to name and transport protocol
CPortForwardingSettings	Port forwarding settings
CRoutingInfo	Routing info
CRoutingSettings	Routing settings
CServices	Network services configuration interface
CServiceSettings	Network service settings
CSettings	Network settings
CWlanInfo	WLAN interface info
CWlanInfoChangedEvent	Event that is send when WLAN interface specific network info has changed
CWlanSettings	WLAN interface settings
►Nproduction	Methods used during production
CProduction	Methods used during production
►Nradm	Radm Model
►CAccessPort
CAssociatedOutletsChangedEvent	Event: The outlet association has changed
CStatus
CStatusChangedEvent	Event: The port status have changed
►CAutoScan
CNfsStatusChangedEvent	Event: NFS server status has changed
CSettings
CSettingsChangedEvent	Event: Settings have changed
►CBasePort
CMetadata
CNameChangedEvent	Event: Port name has changed
►CDevice
CMetadata
CNameChangedEvent	Event: The device name has changed
CStateChangedEvent	Event: The device state has changed
CDsamDevice
►CDsamDeviceManager
CDeviceAttachedEvent	Event: A DSAM device was connected
CDeviceChangedEvent	Event: Connected DSAM devices list has changed
CDeviceRemovedEvent	Event: A DSAM device was disconnected
CKeywordMappingChangedEvent	Event: The keyword mapping was changed
CUpdateHistoryEntry	DSAM firmware update history entry
►CKeySetManager
CKeySet	Structure representing a key set (a named group of keyboard key codes)
CKeySetsChangedEvent	Event: List of configured key sets has changed
►CKvmChannel
CAttachedKvmPortChangedEvent
CKvmSwitchEvent
CMetadata
CVideoResolutionChangedEvent
►CKvmDevice
CCustomEdidDataChangedEvent	Event: Custom EDID data changed
CCustomEdidLimits
CEdidData	EDID data for a given resolution
CTemperatureChangedEvent	Event: Device temperature has changed
CTemperatureReading	Device temperature reading
CUsbProfile	An uploaded USB profile
CUsbProfileAddedEvent	Event: A USB profile was added
CUsbProfileDeletedEvent	Event: A USB profile was deleted
CUsbProfilesChangedEvent	Event: The list of available USB profiles changed
►CKvmManager
CCimFirmwareInfo
CCimFirmwareUpdateCompletedEvent	Event: CIM firmware updated successfully
CCimFirmwareUpdateEvent	Event: Firmware update base event
CCimFirmwareUpdateStartedEvent	Event: CIM firmware update started
CCimUpdateHistoryEntry
CKvmAccessFlags
CKvmAccessModeChangedEvent	Event: Access mode flags have changed
CKvmSecuritySettingsChangedEvent	Event: The KVM security settings have changed
CSecuritySettings
CVirtualMediaShare	Data structure for a preconfigured virtual media ISO file on an SMB share
CVirtualMediaSharesChangedEvent	Event: The list of configured virtual media shares has changed
►CKvmPort
CActiveUsbProfileChangedEvent	Event: Active USB profile has changed
CCapabilities
CCapabilitiesChangedEvent	Event: The port capabilities have changed
CCimInfo	Information about a CIM connected to a port
CCimInfoChangedEvent	Event: The port ciminfo have changed
CCimPortSettings	Settings for CIM-based ports
CDigitalPortSettings	Settings for digital (non-CIM) ports
CGroupInfo	Information about group membership of this port
CGroupInfoChangedEvent	Event: The port group has changed
CIntelligentMouseSettings
CMultiMonitorGroupInfo	Information about group membership in case this port is part of a multi-monitor group
CSettings
CSettingsChangedEvent	Event: The port settings have changed
CUsbSettings	USB settings for devices without usbProfiles capability
►CLocalMonitor
CMetadata
CStatus
CStatusChangeEvent	Event: Status has changed
►CLocalPort	Interface for local user interface
CSettings	Local port settings
CSettingsChangedEvent	Event: Local port settings have changed
►COutletPort
CAssociatedAccessPortChangedEvent	Event: The associated port has changed
CPowerOperationEvent	Event: A power operation was started
CPowerStateChangedEvent	Event: The outlet power state has changed
►CPortGroup
CGroupConfig	Configuration object for a plain port group
CMetadata	Group meta data
CMultiMonitorConfig	Configuration object for a multi-monitor group
CSettings
CSettingsChangedEvent	Event: Group settings have been changed
►CPortGroupManager
CPortGroupCreatedEvent	Event: A port group was created
CPortGroupDeletedEvent	Event: A port group was deleted
CPortGroupListChangedEvent	Event: The group list has changed (group was added or removed)
►CPowerDevice
CSettings
CSettingsChangedEvent	Event: Device settings have changed
►CPowerDeviceManager
CPowerDeviceAddedEvent	Event: A power device was added
CPowerDeviceChangedEvent	Event: A power device was added or removed
CPowerDeviceRemovedEvent	Event: A power device was removed
CSettings
CSettingsChangedEvent	Event: Manager settings changed
►CPowerSupply
CMetaData
CSettings
CSettingsChangedEvent	Event: Power Supply settings has changed
CStatusChangedEvent	Event: PowerSupply status has changed
►CSerialAccessPort
CDetectedInterfaceTypeChangedEvent	Event: The detected type has changed
CExitCommandItem
CSettings
CSettingsChangedEvent	Event: The port settings have changed
►CTerminalBlock	TerminalBlock interface
CSettings
CSettingsChangedEvent	Event: The terminal block settings have changed
CStatus	Terminal Block Status including input and output
CStatusChangedEvent	Event: The terminal block status have changed
CUsbProfileSettings
CVideoResolution
CVirtualMediaChannel
►Nrawcfg	Raw Configuration
►CRawConfiguration	Raw Configuration Interface
CRawConfigDownloadedEvent	Event: Raw configuration downloaded
CRawConfigUpdatedEvent	Event: Raw configuration updated
►Nrdm	Rdm Model
►CRdm
CManagementStoppedEvent	Event: CC-SG management was stopped
CSettings	CC-SG management settings
CSettingsChangedEvent	Event: CC-SG management settings have changed
CState	CC-SG management state
CStateChangedEvent	Event: CC-SG management state has changed
►Nres_mon	Resource Monitor interface
CEntry	ResMon Entry
CResMon	ResMon interface
►Nsecurity	Security Configuration
CBlockSettings	User blocking settings
CFipsSettings	FIPS settings
CFrontPanelPrivilegesChanged	Front panel privileges have been changed
CIpFw	IP packet filter configuration
CIpfwRule	IP packet filter rule
CPasswordSettings	Password settings
CPasswordSettingsChanged	This Event is emitted after any of the password-settings has been changed
CRestrictedServiceAgreement	Restricted Service Agreement settings
CRestrictedServiceAgreementChanged	Event: The RestrictedServiceAgreement has changed
CRoleAccessControl	Role-based access control settings
CRoleAccessRule	Role-based access rule
CSecurity	Security configuration interface
CSSHHostKey	SSH host keys
CSSHKeyFingerprint	Fingerprints of SSH host key
CSSHSettings	SSH authentication settings
CTpmInfo	Information about an installed Secure Element
►Nserial	Serial Ports
►CAnalogModem	Interface for communication with an analog modem attached to a serial port
CCallEndedEvent	An event that's emitted when a dial-in call was hung up
CCallReceivedEvent	An event that's emitted when a dial-in call was answered
CDialInEvent	Dial-in event
CSettings
►CGsmModem	Interface for communication with a GSM modem attached to a serial port
CInformation	Structure holding information about the modem and the SIM card
CSettings	Structure for holding settings of the GSM modem and its SIM card
CSimPinUpdatedEvent	Sim pin updated event
CSimSecurityStatusChangedEvent	Sim card security status changed event
CPortDispatcher	Top-level interface of the serial port manager
►CSerialPort	Interface describing a physical serial port and the devices which can be attached to it
CMetaData	(Static) meta data containing port properties
CModemAddedEvent	Event emitted when a modem is connected
CModemEvent	Event emitted when the modem connection state changes
CModemRemovedEvent	Event emitted when a modem is disconnected
CSettings	Port settings
CState	Structure holding information about the current state of the port
►Nsession	Session Management
CHistoryEntry	Session history entry
CSession	Session information
►CSessionManager	Session manager interface
CSessionClosedEvent	Event: Session was closed
CSessionCreatedEvent	Event: Session was created
►Nsys	Low-Level system access methods
CSystem	System access methods
►Nusb	USB Ports
►CUsb	USB interface
CSettings	USB interface settings
CSettingsChangedEvent	Event: Settings have changed
CUsbDevice	USB device information
►Nusermgmt	User Management
CAccount	Account information
CAccountAdded	This event is emitted after a new account with the provided username was added
CAccountChanged	This event is emitted if the settings of an account as defined in usermgmt::UserInfo have changed
CAccountEvent	Base type of all account event
CAccountRemoved	This event is emitted after the account with the provided username has been removed
CAccountRenamed	This event is emitted after an account has been renamed
CAuxInfo	Auxiliary user information
CPasswordChanged	This event is emitted after the password for an account was changed
CPreferences	User preferences
►CRole	Role management interface
CInfo	Role information
CPrivilege	A granted privilege
CRestriction	A restriction
CRoleAdded
CRoleChanged
CRoleEvent	Base type of all account event
►CRoleManager	Role manager interface
CArgumentDesc	Privilege Argument Description
CInfo	Full role manager information
CPrivilegeDesc	Privilege Description
CRestrictionDesc	Restriction Description
CRoleAccount	Role information
CRoleRemoved
CSnmpV3Settings	SNMPv3 settings
CUser	User interface
CUserCapabilities	User Capabilities Describe if certain operations can be performed for user
CUserInfo	User information
CUserManager	User manager interface