Class NetworkAdapter
- Namespace
- CENTREL.XIA.Configuration.Types
- Assembly
- CENTREL.XIA.Configuration.Types.dll
Represents a network adapter.
public class NetworkAdapter : GlobalSerializableClassicBase, IComparable<NetworkAdapter>- Inheritance
-
NetworkAdapter
- Implements
Constructors
NetworkAdapter()
Initializes a new instance of the CENTREL.XIA.Configuration.Types.NetworkAdapter class.
public NetworkAdapter()Properties
AdvancedProperties
Gets or sets the advanced properties for the network adapter. This is only available using Windows PowerShell.
public NetworkAdapterAdvancedProperties AdvancedProperties { get; set; }Property Value
Bindings
Gets or sets the bindings for this network adapter. This is only available using Windows PowerShell on Windows Server 2012 and above.
public NetworkAdapterBindings Bindings { get; set; }Property Value
ConfigManagerErrorCode
Gets or sets the configuration manager error code for this network adapter. An error code of 0 represents a working device.
public int ConfigManagerErrorCode { get; set; }Property Value
DefaultGateways
Gets or sets the IP addresses of the default gateway(s) assigned to this network adapter.
public SerializableStringCollection DefaultGateways { get; set; }Property Value
- SerializableStringCollection
DeviceName
Gets or sets the descriptive name of this network adapter - for example "Microsoft Loopback Adapter #2".
public string DeviceName { get; set; }Property Value
DhcpEnabled
Gets or sets whether this network adapter is configured to receive its IP configuration from a DHCP server.
public BooleanOption DhcpEnabled { get; set; }Property Value
DhcpServer
Gets or sets the IP address of the DHCP server that provided this network adapter with its configuration should this network adapter be DHCP enabled.
public string DhcpServer { get; set; }Property Value
DnsDomain
Gets or sets the DNS domain for which this network adapter is registered - for example "demonstration.int".
public string DnsDomain { get; set; }Property Value
DnsHostName
Gets or sets the DNS hostname for the computer on this adapter.
public string DnsHostName { get; set; }Property Value
DnsServers
Gets or sets the DNS servers that will be used for name resolution.
public SerializableStringCollection DnsServers { get; set; }Property Value
- SerializableStringCollection
DnsSuffixes
Gets or sets the DNS domain suffixes to be appended to the end of host names during name resolution.
public SerializableStringCollection DnsSuffixes { get; set; }Property Value
- SerializableStringCollection
DriverDate
Gets or sets the date of the driver used for this network adapter - for example "10-1-2002".
public string DriverDate { get; set; }Property Value
DriverVersion
Gets or sets the version of the driver used for this network adapter - for example "5.5.4.0".
public string DriverVersion { get; set; }Property Value
EnableLMHostsLookup
Gets or sets whether LM hosts lookup should be enabled for this adapter.
public BooleanOption EnableLMHostsLookup { get; set; }Property Value
FullDuplex
Gets or sets whether the network adapter is running in full duplex mode. This setting is only available when the information is read using PowerShell.
public BooleanOption FullDuplex { get; set; }Property Value
IPAddresses
Gets or sets the IP addresses assigned to this network adapter.
public SerializableIPAddressCollection IPAddresses { get; set; }Property Value
- SerializableIPAddressCollection
Index
Gets or sets the index of this interface.
public int Index { get; set; }Property Value
InterfaceGuid
Gets or sets the unique identifier of the interface in GUID format.
public string InterfaceGuid { get; set; }Property Value
InterfaceIdentifier
Gets the unique ID for this interface, used by the data comparer.
public string InterfaceIdentifier { get; }Property Value
Remarks
Multiple network connections of the same name are permitted when the device is hidden, and must be qualified with the device name and index.
InterfaceIndex
Gets or sets the index of this interface - this is used as the interface number in routing tables.
public int InterfaceIndex { get; set; }Property Value
IsBluetooth
Gets or sets whether the network adapter is a bluetooth adapter. This applies to Windows XP and above only.
public BooleanOption IsBluetooth { get; set; }Property Value
IsConnected
Gets or sets whether the network adapter is connected to a network at the time of the scan.
public BooleanOption IsConnected { get; set; }Property Value
IsDisabled
Gets or sets whether the network adapter is disabled.
public BooleanOption IsDisabled { get; set; }Property Value
IsHidden
Gets or sets whether the adapter is a hidden, pseudo adapter.
public BooleanOption IsHidden { get; set; }Property Value
IsIPEnabled
Gets or sets whether IPv4 or IPv6 is enabled on the network adapter.
public BooleanOption IsIPEnabled { get; set; }Property Value
IsPhysicalAdapter
Gets or sets whether the network adapter is a physical adapter as opposed to a virtual adapter.
public BooleanOption IsPhysicalAdapter { get; set; }Property Value
IsWireless
Gets or sets whether the network adapter is a wireless network adapter. This applies to Windows XP and above only.
public BooleanOption IsWireless { get; set; }Property Value
MacAddress
Gets or sets the media access control (MAC) address of the network adapter - for example "00-0C-29-0E-06-17".
public string MacAddress { get; set; }Property Value
NetBiosSetting
Gets or sets the NETBIOS configuration for this Adapter. This value is available from Windows 2003 onwards.
public NetworkAdapterNetBiosSetting NetBiosSetting { get; set; }Property Value
NetBiosSettingString
Gets the NetBIOS settings for this network adapter in a human readable format - for example "Enabled via DHCP".
public string NetBiosSettingString { get; set; }Property Value
NetworkCategory
Gets or sets the category of network.
public NetworkAdapterNetworkCategory NetworkCategory { get; set; }Property Value
NetworkCategoryString
Gets the category of network as a human readable string.
public string NetworkCategoryString { get; set; }Property Value
NetworkConnectionName
Gets or sets the name of the network connection - for example "Local Area Connection". For Windows 2000 and older, the device name is returned.
public string NetworkConnectionName { get; set; }Property Value
RegisterDns
Gets or sets whether this network adapter is configured for DNS registration (DDNS).
public BooleanOption RegisterDns { get; set; }Property Value
RegisterDnsSuffix
Gets or sets whether the IP addresses for this connection are registered in DNS under the computer's full DNS name.
public BooleanOption RegisterDnsSuffix { get; set; }Property Value
SpeedDuplex
Gets or sets the speed and duplex settings of this network card as a human readable string.
public string SpeedDuplex { get; set; }Property Value
Status
Gets a human readable version of the configuration manager error code.
public string Status { get; set; }Property Value
Remarks
An additional "D" character must be prepended to the error code as numerical only values cannot be used for resource value names.
WinsPrimaryServer
Gets or sets the IP address of the primary WINS server.
public string WinsPrimaryServer { get; set; }Property Value
WinsSecondaryServer
Gets or sets the IP address of the secondary WINS server.
public string WinsSecondaryServer { get; set; }Property Value
Methods
CompareTo(NetworkAdapter)
Compares two network adapters to allow sorting alphabetically by the network connection name, or device name.
public int CompareTo(NetworkAdapter other)Parameters
otherNetworkAdapterThe network adapter to compare to.
Returns
- int
The sort order of the two CENTREL.XIA.Configuration.Types.NetworkAdapter objects.
ToString()
Returns the network connection name, or device name if not available.
public override string ToString()Returns
- string
The network connection name, or device name if not available.