Class MsftNetConnectionProfile

java.lang.Object
io.github.eggy03.ferrumx.windows.entity.network.MsftNetConnectionProfile
@ShallowImmutable public class MsftNetConnectionProfile extends Object
Immutable representation of a connection profile for a particular network adapter on a Windows system.

Fields correspond to properties retrieved from the MSFT_NetConnectionProfile class in the root/StandardCimv2 namespace.

Usage example

MsftNetConnectionProfile profile = MsftNetConnectionProfile.builder()
    .interfaceIndex(1)
    .networkCategory(0)
    .ipv4Connectivity(4)
    .ipv6Connectivity(1)
    .build();

// Create a modified copy
MsftNetConnectionProfile updated = profile.toBuilder()
    .networkCategory(1)
    .build();

See MsftNetAdapter, for network adapter information.

See MsftDnsClientServerAddress, for information regarding the connected DNS servers of a network adapter.

See MsftNetIpAddress, for IP address configuration information of a network adapter.

Since:
3.0.0
See Also:

  • Field Details

    • interfaceIndex

      @SerializedName("InterfaceIndex") @Nullable @Nullable Long interfaceIndex
      The interface index of the network interface on which the profile is connected.

    • interfaceAlias

      @SerializedName("InterfaceAlias") @Nullable @Nullable String interfaceAlias
      The name of the network interface on which the profile is connected.

      Example: "Ethernet0"

    • networkCategory

      @SerializedName("NetworkCategory") @Nullable @Nullable Long networkCategory
      The network category of the connected profile.

      Data type: uint32

      Access type: Read-only

      Possible values:

      • 0 - Public
      • 1 - Private
      • 2 - DomainAuthenticated

    • domainAuthenticationKind

      @SerializedName("DomainAuthenticationKind") @Nullable @Nullable Long domainAuthenticationKind
      Indicates the domain authentication kind associated with the profile.

      WARNING: No existing documentation found about this field

    • ipv4Connectivity

      @SerializedName("IPv4Connectivity") @Nullable @Nullable Long ipv4Connectivity
      The IPv4 connectivity status of the connected profile.

      Possible values:

      • 0 - Disconnected
      • 1 - NoTraffic
      • 2 - Subnet
      • 3 - LocalNetwork
      • 4 - Internet

    • ipv6Connectivity

      @SerializedName("IPv6Connectivity") @Nullable @Nullable Long ipv6Connectivity
      The IPv6 connectivity status of the connected profile.

      Possible values:

      • 0 - Disconnected
      • 1 - NoTraffic
      • 2 - Subnet
      • 3 - LocalNetwork
      • 4 - Internet

  • Constructor Details

    • MsftNetConnectionProfile

      public MsftNetConnectionProfile()

  • Method Details

    • toString

      @NotNull public @NotNull String toString()
      Retrieves the entity in a JSON pretty-print formatted string
      Overrides:
      toString in class Object
      Returns:
      the String value of the object in JSON pretty-print format