.TH "kysdk.NetCard" 3 "Thu Sep 21 2023" "My Project" \" -*- nroff -*-
.ad l
.nh
.SH NAME
kysdk.NetCard \- Network card information class used to get network card list, check if a specified network card is in UP state, get the list of network cards currently in link up state, get the physical MAC address of a specified network card, get the first IPv4 address of a specified network card, get all IPv4 addresses of a specified network card, get the first IPv6 address of a specified network card, get all IPv6 addresses of a specified network card, get the wired/wireless type of a specified network card, and get the vendor name and device model of a specified network card

.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBkysdk\&.Base\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "def \fB__init__\fP (self)"
.br
.ti -1c
.RI "def \fBgetNetCardName\fP (self)"
.br
.RI "Get all network cards in the system"
.ti -1c
.RI "def \fBgetNetCardUp\fP (self, netcard_name)"
.br
.RI "Check if the specified network card is in UP state"
.ti -1c
.RI "def \fBgetNetCardUpcards\fP (self)"
.br
.RI "Get the list of network cards currently in link up state"
.ti -1c
.RI "def \fBgetNetCardPhymac\fP (self, netcard_name)"
.br
.RI "Get the physical MAC address of the specified network card"
.ti -1c
.RI "def \fBgetNetCardPrivateIPv4\fP (self, netcard_name)"
.br
.RI "Get the first IPv4 address of the specified network card"
.ti -1c
.RI "def \fBgetNetCardIPv4\fP (self, netcard_name)"
.br
.RI "Get all IPv4 addresses of the specified network card"
.ti -1c
.RI "def \fBgetNetCardPrivateIPv6\fP (self, netcard_name)"
.br
.RI "Get the first IPv6 address of the specified network card"
.ti -1c
.RI "def \fBgetNetCardType\fP (self, netcard_name)"
.br
.RI "Get the wired/wireless type of the specified network card"
.ti -1c
.RI "def \fBgetNetCardProduct\fP (self, netcard_name)"
.br
.RI "Get the vendor name and device model of the specified network card"
.ti -1c
.RI "def \fBgetNetCardIPv6\fP (self, netcard_name)"
.br
.RI "Get all IPv6 addresses of the specified network card"
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
Network card information class used to get network card list, check if a specified network card is in UP state, get the list of network cards currently in link up state, get the physical MAC address of a specified network card, get the first IPv4 address of a specified network card, get all IPv4 addresses of a specified network card, get the first IPv6 address of a specified network card, get all IPv6 addresses of a specified network card, get the wired/wireless type of a specified network card, and get the vendor name and device model of a specified network card

.SH "Member Function Documentation"
.PP 
.SS "def kysdk\&.NetCard\&.getNetCardIPv4 ( self,  netcard_name)"

.PP
Get all IPv4 addresses of the specified network card
.PP
\fBParameters\fP
.RS 4
\fInetcard_name\fP Network card name, such as eno1
.RE
.PP
\fBReturns\fP
.RS 4
List of IPv4 addresses
.RE
.PP

.PP
References kysdk\&.SessionBase\&.interface, and kysdk\&.Base\&.interface\&.
.SS "def kysdk\&.NetCard\&.getNetCardIPv6 ( self,  netcard_name)"

.PP
Get all IPv6 addresses of the specified network card
.PP
\fBParameters\fP
.RS 4
\fInetcard_name\fP Network card name, such as eno1
.RE
.PP
\fBReturns\fP
.RS 4
List of IPv6 addresses
.RE
.PP

.PP
References kysdk\&.SessionBase\&.interface, and kysdk\&.Base\&.interface\&.
.SS "def kysdk\&.NetCard\&.getNetCardName ( self)"

.PP
Get all network cards in the system
.PP
\fBReturns\fP
.RS 4
List of network card names
.RE
.PP

.PP
References kysdk\&.SessionBase\&.interface, and kysdk\&.Base\&.interface\&.
.SS "def kysdk\&.NetCard\&.getNetCardPhymac ( self,  netcard_name)"

.PP
Get the physical MAC address of the specified network card
.PP
\fBParameters\fP
.RS 4
\fInetcard_name\fP Network card name, such as eno1
.RE
.PP
\fBReturns\fP
.RS 4
Physical MAC address
.RE
.PP

.PP
References kysdk\&.SessionBase\&.interface, and kysdk\&.Base\&.interface\&.
.SS "def kysdk\&.NetCard\&.getNetCardPrivateIPv4 ( self,  netcard_name)"

.PP
Get the first IPv4 address of the specified network card
.PP
\fBParameters\fP
.RS 4
\fInetcard_name\fP Network card name, such as eno1
.RE
.PP
\fBReturns\fP
.RS 4
IPv4 address
.RE
.PP

.PP
References kysdk\&.SessionBase\&.interface, and kysdk\&.Base\&.interface\&.
.SS "def kysdk\&.NetCard\&.getNetCardPrivateIPv6 ( self,  netcard_name)"

.PP
Get the first IPv6 address of the specified network card
.PP
\fBParameters\fP
.RS 4
\fInetcard_name\fP Network card name, such as eno1
.RE
.PP
\fBReturns\fP
.RS 4
IPv6 address
.RE
.PP

.PP
References kysdk\&.SessionBase\&.interface, and kysdk\&.Base\&.interface\&.
.SS "def kysdk\&.NetCard\&.getNetCardProduct ( self,  netcard_name)"

.PP
Get the vendor name and device model of the specified network card
.PP
\fBParameters\fP
.RS 4
\fInetcard_name\fP Network card name, such as eno1
.RE
.PP
\fBReturns\fP
.RS 4
Vendor name and device model of the network card
.RE
.PP

.PP
References kysdk\&.SessionBase\&.interface, and kysdk\&.Base\&.interface\&.
.SS "def kysdk\&.NetCard\&.getNetCardType ( self,  netcard_name)"

.PP
Get the wired/wireless type of the specified network card
.PP
\fBParameters\fP
.RS 4
\fInetcard_name\fP Network card name, such as eno1
.RE
.PP
\fBReturns\fP
.RS 4
0 for wired, 1 for wireless
.RE
.PP

.PP
References kysdk\&.SessionBase\&.interface, and kysdk\&.Base\&.interface\&.
.SS "def kysdk\&.NetCard\&.getNetCardUp ( self,  netcard_name)"

.PP
Check if the specified network card is in UP state
.PP
\fBParameters\fP
.RS 4
\fInetcard_name\fP Network card name, such as eno1
.RE
.PP
\fBReturns\fP
.RS 4
1 if Up, 0 if Down
.RE
.PP

.PP
References kysdk\&.SessionBase\&.interface, and kysdk\&.Base\&.interface\&.
.SS "def kysdk\&.NetCard\&.getNetCardUpcards ( self)"

.PP
Get the list of network cards currently in link up state
.PP
\fBReturns\fP
.RS 4
List of network cards in link up state
.RE
.PP

.PP
References kysdk\&.SessionBase\&.interface, and kysdk\&.Base\&.interface\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for kysdk.py from the source code\&.