IDeviceManager Interface

[This is preliminary documentation and is subject to change.]

Manager for devices

Namespace: Netadmin.Management.Inventory
Assembly: Netadmin.Management.Interfaces (in Netadmin.Management.Interfaces.dll) Version: release/9.0@131b654fe7332b0776120c2b44d96c6cac5ac9a2

Syntax

Copy

public interface IDeviceManager : IManager<IDevice>, 
	IUniqueName<IDevice>, IDetailsable<IDevice>, IUpdateable<IDevice>, 
	IDeletable<IDevice>, IDropdownableMultipleCompanies, IDropdownable, IFilterable<IDevice, IDeviceFilter>, 
	IFilterable<IPhysicalInterface, IPhysicalInterfaceFilter>, IDetailsableBatch<IDevice>, 
	IDetailsableBatch<ISlot>, IManager<ISlot>, IDetailsableBatch<IPhysicalInterface>, 
	IManager<IPhysicalInterface>, IUniqeueNames<IDevice>, IUniqueEntities<IDevice>, 
	ITop100ForCompany<IDevice>, ITop100ForCompany<IPhysicalInterface>

Public Interface IDeviceManager
	Inherits IManager(Of IDevice), IUniqueName(Of IDevice), 
	IDetailsable(Of IDevice), IUpdateable(Of IDevice), IDeletable(Of IDevice), 
	IDropdownableMultipleCompanies, IDropdownable, IFilterable(Of IDevice, IDeviceFilter), 
	IFilterable(Of IPhysicalInterface, IPhysicalInterfaceFilter), IDetailsableBatch(Of IDevice), 
	IDetailsableBatch(Of ISlot), IManager(Of ISlot), IDetailsableBatch(Of IPhysicalInterface), 
	IManager(Of IPhysicalInterface), IUniqeueNames(Of IDevice), IUniqueEntities(Of IDevice), 
	ITop100ForCompany(Of IDevice), ITop100ForCompany(Of IPhysicalInterface)

The IDeviceManager type exposes the following members.

Methods

Name	Description
IDevice	AddDevice(IDevice, Int64)	Adds a device
void	AttachDeviceAsExpansion(Int64, ISlot)	Attaches an existing device in a slot
void	Delete(Int64)	Deletes an entity with a specific Id (Inherited from IDeletableT.)
void	DetachDeviceToStandalone(Int64)	Returns a previously attached device back to stand alone
IDevice	Details(Int64)	Get details for entity with specified Id (Inherited from IDetailsableT.)
IReadOnlyDictionaryTKey, TValue, T: Int64	DetailsAny(IEnumerableInt64)	Attempts to get details on multiple ids. If an id is not found, it will not be included in the returned dictionary (Inherited from IDetailsableBatchT.)
void	ExchangePhysicalInterfaces(IInterfaceExchangeConfiguration)	Obsolete. Performs interface exchange
IPaginationT	Filter(TFilterDtoInterface, PaginationRequestTDToInterface)	Searches for entities using a filter and returnes a pagination based on the supplied request (Inherited from IFilterableTDToInterface, TFilterDtoInterface.)
IReadOnlyDictionaryTKey, TValue, T: String	GetAnyByNames(IEnumerableString)	Attempts to get enties by their names (Inherited from IUniqeueNamesT.)
IEnumerableT, T: IDevice	GetAttachableDevices(Int64)	Retrieves devices that can be attached to a slot
IEnumerableT, T: String	GetAuthenticationNames	Returns the names of used authentication parameters
IEnumerableT, T: IExchangeablePhysicalInterface	GetDestinationExchangeablePhysicalInterfaces(Int64)	Obsolete. Get destination interfaces
IEnumerableT, T: IExchangeablePhysicalInterface	GetDestinationExchangeablePhysicalInterfaces(Int64, Boolean, Boolean)	Obsolete. Get destination interfaces
IEnumerableT, T: IDeviceAuthenticationInformation	GetDeviceAuthenticationInformation(Int64)	Retrieves authentication information stored for a device
IDevice	GetDeviceInstalledInSlot(Int64)	Retrieves the device, if any, that is installed in a slot
IEnumerableT, T: String	GetDuplicateNames(IEnumerableKeyValuePairInt64, String)	Checks for duplicates for ids and names (Inherited from IUniqeueNamesT.)
IEnumerableT	GetDuplicates(IEnumerableT)	Returns duplicate entities. (Inherited from IUniqueEntitiesT.)
IEnumerableT, T: IInterfaceCalculationPlugin	GetInterfaceCalculationPlugins	Retrieves available interface calculation plugins
IEnumerableT, T: IAssembly	GetInterfaceExchangeAssemblies	Obsolete. Retrieves available assemblies for interface exchange
IEnumerableT, T: INameable	GetNames(IEnumerableInt64)	Retrieves names for specified ids (Inherited from IDropdownable.)
IPhysicalInterface	GetPhysicalInterface(Int64)	Retrieves details of a physical interface
IPhysicalInterface	GetPhysicalInterfaceForAddress(Int64)	Get the physical interface that is associated with specified address
IReadOnlyDictionaryTKey, TValue, T: Int64	GetPhysicalInterfaceForAddresses(IEnumerableInt64)	Retrieves the physical interfaces that are associated with specified address ids. Addresses that does not have a physical interface will not be included in the result
IEnumerableT, T: INameable	GetPhysicalInterfaceNames(IEnumerableInt64)	Retrieves the names of specified physical interfaces
IEnumerableT, T: IPhysicalInterface	GetPhysicalInterfaces(Int64, Boolean)	Retrieves physical interfaces on a device
IReadOnlyDictionaryTKey, TValue, T: Int64	GetPhysicalInterfacesForAddresses(IEnumerableInt64)	Obsolete. Retrieves the physical interfaces that are associated with specified address ids. Addresses that does not have a physical interface will not be included in the result
IEnumerableT, T: IPhysicalInterface	GetPhysicalInterfacesForAddressid(Int64)	Obsolete. Get the physical interface that is associated with specified address
IEnumerableT, T: IPhysicalInterface	GetPhysicalInterfacesForDevices(IEnumerableInt64)	Retrieves all physical interfaces for specific device ids
IEnumerableT, T: IPhysicalInterface	GetPhysicalInterfacesForRootDevices(IEnumerableInt64)	Retrieves all physical interfaces for specific root device ids
IPhysicalLayout	GetPhysicalLayout(Int64)	Retrieves the physical layout of a device
IEnumerableT, T: IDeviceDefinition	GetPossibleExpansionTransformations(Int64)	Gets device definitions that a specific device can be transformed into
Int64	GetRootDevice(Int64)	Retrieves the root device id when using slots. If a root device id is given it will be returned.
ISlot	GetSlot(Int64)	Retrieves details of a slot
IEnumerableT, T: ISlot	GetSlots(Int64)	Retrieves slot instances for a specific device
IEnumerableT, T: ISlot	GetSlotsForDevices(IEnumerableInt64)	Retrieves all slot instances for specific device ids
IEnumerableT, T: IExchangeablePhysicalInterface	GetSourceExchangeablePhysicalInterfaces(Int64)	Obsolete. Get source interfaces
IPaginationT, T: IDevice	GetStandAloneDevices(PaginationRequestIDevice, Int64)	Retrieves stand alone devices for a specific company
IReadOnlyDictionaryTKey, TValue, T: String	GetTop100(ExpressionFuncT, String, String, IEnumerableInt64)	Retrieves the first 100 matches of the search string. For each string, a maximum of 100 ids are returned. Please see the interface for the manager for documentation on supported properties and additional information (Inherited from ITop100ForCompanyT.)
IEnumerableT	GetUniqueByEntity(IEnumerableT)	Attempts to get entities by what makes them unique. If a match is found the entity is loaded and returned (Inherited from IUniqueEntitiesT.)
void	InstallExpansionCard(Int64, ISlot)	Installs an expansion card type device definition into a slot
Boolean	IsNameUnique(T)	Checks if the name of a dto is unique (Inherited from IUniqueNameT.)
Boolean	IsPhysicalInterfaceAvailableForExchange(Int64, Int64)	Obsolete. Checks if itnerface is avable for exchange
Boolean	IsPhysicalInterfaceAvailableForExchange(Int64, Int64, Boolean, Boolean)	Obsolete. Checks if itnerface is avable for exchange
IEnumerableT, T: INameable	ListTop100ByName(Int64, String)	Lists the first 100 results starting with a partialname in an undefined order. (Inherited from IDropdownable.)
IEnumerableT, T: INameable	ListTop100ByName(IEnumerableInt64, String)	Lists the first 100 results starting with a partialname in an undefined order. (Inherited from IDropdownableMultipleCompanies.)
void	RecalculatePortAndSlotNamesAndNumbers(Int64)	Performs a re-calculation of interface number, names and option 82 values on a device and all devices installed/attached to it
void	SetAddressOnPhysicalInterface(Int64, NullableInt64)	Sets the address id of a physical interface
void	TransformExpansion(Int64, Int64)	Transforms an existing installed expansion into a different one while keeping existing device, physical interface, and slot ids intact
void	UninstallExpansionCard(ISlot)	Uninstalls an expansion card
void	Update(T)	Updates an entity with new values. (Inherited from IUpdateableT.)
void	UpdateDeviceAuthenticationInformation(Int64, IEnumerableIDeviceAuthenticationInformation)	Updates authentication information for device. Entries not included will be removed
void	UpdatePhysicalInterface(IPhysicalInterface)	Updates a physical interface

Top

Extension Methods

Name	Description
IDevice	DetailsAllIDevice(Int64)	Overloaded. IDetailsableBatchT (Defined by DetailsableBatchExtensions.)
IReadOnlyDictionaryTKey, TValue, T: Int64	DetailsAllIDevice(IEnumerableInt64)	Overloaded. IDetailsableBatchT (Defined by DetailsableBatchExtensions.)
ISlot	DetailsAllISlot(Int64)	Overloaded. (Defined by DetailsableBatchExtensions.)
IReadOnlyDictionaryTKey, TValue, T: Int64	DetailsAllISlot(IEnumerableInt64)	Overloaded. (Defined by DetailsableBatchExtensions.)
IPhysicalInterface	DetailsAllIPhysicalInterface(Int64)	Overloaded. (Defined by DetailsableBatchExtensions.)
IReadOnlyDictionaryTKey, TValue, T: Int64	DetailsAllIPhysicalInterface(IEnumerableInt64)	Overloaded. (Defined by DetailsableBatchExtensions.)
IDevice	DetailsAnyIDevice(Int64)	Overloaded. IDetailsableBatchT Returns details of entity with id 'id', or null if not found Thrown if any id zero or less. (Defined by DetailsableBatchExtensions.)
ISlot	DetailsAnyISlot(Int64)	Overloaded. (Defined by DetailsableBatchExtensions.)
IPhysicalInterface	DetailsAnyIPhysicalInterface(Int64)	Overloaded. (Defined by DetailsableBatchExtensions.)
IReadOnlyDictionaryTKey, TValue, T: String	GetAnyByNamesIDevice(String)	IUniqeueNamesT (Defined by UniqueNamesExtensions.)

Top

Remarks

Supported Device Top100 properties: * Name * Description * Hostname * ManagementAddress * ReferenceName * SerialNumber Supported Interface Top100 properties * Name * Option82 * FQPN * Identifier * Panel

Reference

Netadmin.Management.Inventory Namespace