Helpers

class ingenialink.get_adapters_addresses.AdapterFamily(value)

An enumeration.

class ingenialink.get_adapters_addresses.CyAdapter(Alignment: int, Length: int, IfIndex: int, AdapterName: str, FirstUnicastAddress: list[CyFirstUnicastAddress], FirstAnycastAddress: list[CyFirstAnycastMulticastAddress], FirstMulticastAddress: list[CyFirstAnycastMulticastAddress], FirstDnsServerAddress: list[CyFirstAnyServerAddress], DnsSuffix: str, Description: str, FriendlyName: str, PhysicalAddress: str, PhysicalAddressLength: int, Flags: int, DdnsEnabled: int, RegisterAdapterSuffix: int, Dhcpv4Enabled: int, ReceiveOnly: int, NoMulticast: int, Ipv6OtherStatefulConfig: int, NetbiosOverTcpipEnabled: int, Ipv4Enabled: int, Ipv6Enabled: int, Ipv6ManagedAddressConfigurationSupported: int, Mtu: int, IfType: int, OperStatus: int, Ipv6IfIndex: int, ZoneIndices: str, FirstPrefix: list[CyFirstPrefix], TransmitLinkSpeed: int, ReceiveLinkSpeed: int, FirstWinsServerAddress: list[CyFirstAnyServerAddress], FirstGatewayAddress: list[CyFirstAnyServerAddress], Ipv4Metric: int, Ipv6Metric: int, Luid: int, Dhcpv4Server: CySocketAddress, CompartmentId: int, NetworkGuid: str, ConnectionType: int, TunnelType: int, Dhcpv6Server: CySocketAddress, Dhcpv6ClientDuid: str, Dhcpv6ClientDuidLength: int, Dhcpv6Iaid: int, FirstDnsSuffix: list[CyFirstDnsSuffix])
AdapterName

unicode

Type:

AdapterName

Alignment

int

Type:

Alignment

CompartmentId

int

Type:

CompartmentId

ConnectionType

int

Type:

ConnectionType

DdnsEnabled

int

Type:

DdnsEnabled

Description

unicode

Type:

Description

Dhcpv4Enabled

int

Type:

Dhcpv4Enabled

Dhcpv4Server

ingenialink.get_adapters_addresses.CySocketAddress

Type:

Dhcpv4Server

Dhcpv6ClientDuid

unicode

Type:

Dhcpv6ClientDuid

Dhcpv6ClientDuidLength

int

Type:

Dhcpv6ClientDuidLength

Dhcpv6Iaid

int

Type:

Dhcpv6Iaid

Dhcpv6Server

ingenialink.get_adapters_addresses.CySocketAddress

Type:

Dhcpv6Server

DnsSuffix

unicode

Type:

DnsSuffix

FirstAnycastAddress

list

Type:

FirstAnycastAddress

FirstDnsServerAddress

list

Type:

FirstDnsServerAddress

FirstDnsSuffix

list

Type:

FirstDnsSuffix

FirstGatewayAddress

list

Type:

FirstGatewayAddress

FirstMulticastAddress

list

Type:

FirstMulticastAddress

FirstPrefix

list

Type:

FirstPrefix

FirstUnicastAddress

list

Type:

FirstUnicastAddress

FirstWinsServerAddress

list

Type:

FirstWinsServerAddress

Flags

int

Type:

Flags

FriendlyName

unicode

Type:

FriendlyName

IfIndex

int

Type:

IfIndex

IfType

int

Type:

IfType

Ipv4Enabled

int

Type:

Ipv4Enabled

Ipv4Metric

int

Type:

Ipv4Metric

Ipv6Enabled

int

Type:

Ipv6Enabled

Ipv6IfIndex

int

Type:

Ipv6IfIndex

Ipv6ManagedAddressConfigurationSupported

int

Type:

Ipv6ManagedAddressConfigurationSupported

Ipv6Metric

int

Type:

Ipv6Metric

Ipv6OtherStatefulConfig

int

Type:

Ipv6OtherStatefulConfig

Length

int

Type:

Length

Luid

int

Type:

Luid

Mtu

int

Type:

Mtu

NetbiosOverTcpipEnabled

int

Type:

NetbiosOverTcpipEnabled

NetworkGuid

unicode

Type:

NetworkGuid

NoMulticast

int

Type:

NoMulticast

OperStatus

int

Type:

OperStatus

PhysicalAddress

unicode

Type:

PhysicalAddress

PhysicalAddressLength

int

Type:

PhysicalAddressLength

ReceiveLinkSpeed

int

Type:

ReceiveLinkSpeed

ReceiveOnly

int

Type:

ReceiveOnly

RegisterAdapterSuffix

int

Type:

RegisterAdapterSuffix

TransmitLinkSpeed

int

Type:

TransmitLinkSpeed

TunnelType

int

Type:

TunnelType

ZoneIndices

unicode

Type:

ZoneIndices

class ingenialink.get_adapters_addresses.CyFirstAnyServerAddress(Alignment: int, Length: int, Reserved: int, Address: CySocketAddress)
Address

ingenialink.get_adapters_addresses.CySocketAddress

Type:

Address

Alignment

int

Type:

Alignment

Length

int

Type:

Length

Reserved

int

Type:

Reserved

class ingenialink.get_adapters_addresses.CyFirstAnycastMulticastAddress(Alignment: int, Length: int, Flags: int, Address: CySocketAddress)
Address

ingenialink.get_adapters_addresses.CySocketAddress

Type:

Address

Alignment

int

Type:

Alignment

Flags

int

Type:

Flags

Length

int

Type:

Length

class ingenialink.get_adapters_addresses.CyFirstDnsSuffix(String: list[str])
String

list

Type:

String

class ingenialink.get_adapters_addresses.CyFirstPrefix(Alignment: int, Length: int, Flags: int, Address: CySocketAddress, PrefixLength: int)
Address

ingenialink.get_adapters_addresses.CySocketAddress

Type:

Address

Alignment

int

Type:

Alignment

Flags

int

Type:

Flags

Length

int

Type:

Length

PrefixLength

int

Type:

PrefixLength

class ingenialink.get_adapters_addresses.CyFirstUnicastAddress(Alignment: int, Length: int, Flags: int, Address: CySocketAddress, PrefixOrigin: int, SuffixOrigin: int, DadState: int, ValidLifetime: int, PreferredLifetime: int, LeaseLifetime: int, OnLinkPrefixLength: int)
Address

ingenialink.get_adapters_addresses.CySocketAddress

Type:

Address

Alignment

int

Type:

Alignment

DadState

int

Type:

DadState

Flags

int

Type:

Flags

LeaseLifetime

int

Type:

LeaseLifetime

Length

int

Type:

Length

OnLinkPrefixLength

int

Type:

OnLinkPrefixLength

PreferredLifetime

int

Type:

PreferredLifetime

PrefixOrigin

int

Type:

PrefixOrigin

SuffixOrigin

int

Type:

SuffixOrigin

ValidLifetime

int

Type:

ValidLifetime

class ingenialink.get_adapters_addresses.CySocketAddress(lpSockaddr: CylpSockaddr, iSockaddrLength: int)
iSockaddrLength

int

Type:

iSockaddrLength

lpSockaddr

ingenialink.get_adapters_addresses.CylpSockaddr

Type:

lpSockaddr

class ingenialink.get_adapters_addresses.CylpSockaddr(sa_family: int | None, sa_data: bytes | None)
sa_data

object

Type:

sa_data

sa_family

object

Type:

sa_family

class ingenialink.get_adapters_addresses.ScanFlags(value)

An enumeration.

ingenialink.get_adapters_addresses.get_adapters_addresses(adapter_families: list[AdapterFamily] | AdapterFamily = AdapterFamily.UNSPEC, scan_flags: list[ScanFlags] | ScanFlags = ScanFlags.INCLUDE_PREFIX) list[CyAdapter]

Retrieves the addresses associated with the adapters on the local Windows computer.

Returns:

adapters on the local computer.