HostNic#

class HostNic(name=None, host_description=None, mac_address=None, ipv4_addresses=None, ipv6_addresses=None, interface_status=None, is_dhcp_enabled=None, link_speed_in_kbps=None, mtu_in_bytes=None, node_uuid=None, discovery_protocol=None, switch_device_id=None, switch_port_id=None, switch_vendor_info=None, switch_vlan_id=None, switch_management_ip=None, switch_mac_address=None, attached_switch_interface_list=None, rx_ring_size_in_bytes=None, tx_ring_size_in_bytes=None, ext_id=None, links=None, tenant_id=None, *args, **kwargs)#

Bases: ExternalizableAbstractModel

Host NIC details.

Parameters:

  • name (max=64 chars) – (name) Name of the host NIC.

  • host_description – (host_description) Host description.

  • mac_address – (mac_address) Host Mac address.

  • ipv4_addresses – (ipv4_addresses) List of IPv4 addresses associated with the NIC entity for the network connection.

  • ipv6_addresses – (ipv6_addresses) List of IPv6 addresses associated with the NIC entity for the network connection.

  • interface_status – (interface_status) Operational status of the interface to the port associated with the NIC entity.

  • is_dhcp_enabled – (is_dhcp_enabled) Status of DHCP protocol.

  • link_speed_in_kbps – (link_speed_in_kbps) Link speed in Kbps.

  • mtu_in_bytes – (mtu_in_bytes) Maximum transmission unit in bytes.

  • node_uuid – (node_uuid) UUID of the host.

  • discovery_protocol – (discovery_protocol) Network discovery protocol (either LLDP or None).

  • switch_device_id – (switch_device_id) Switch device Id learned through the discovery protocol.

  • switch_port_id – (switch_port_id) Switch port Id learned through the discovery protocol.

  • switch_vendor_info – (switch_vendor_info) Switch vendor information learned through the discovery protocol.

  • switch_vlan_id – (switch_vlan_id) Switch VLAN Id learned through the discovery protocol.

  • switch_management_ip – (switch_management_ip)

  • switch_mac_address – (switch_mac_address) Switch Mac address

  • attached_switch_interface_list – (attached_switch_interface_list) List of network switch interfaces attached to the host NIC.

  • rx_ring_size_in_bytes – (rx_ring_size_in_bytes) Size of configured buffer (in bytes) to the port associated with NIC, storing the network packets received through the port.

  • tx_ring_size_in_bytes – (tx_ring_size_in_bytes) Size of configured buffer (in bytes) to the port associated with NIC, storing the network packets that would be transmitted through the port.

property attached_switch_interface_list#

List of network switch interfaces attached to the host NIC.

Type:

list[ NetworkSwitchInterface ]

property discovery_protocol#

Network discovery protocol (either LLDP or None).

Type:

str

property host_description#

Host description.

Type:

str

property interface_status#

Operational status of the interface to the port associated with the NIC entity.

Type:

str

property ipv4_addresses#

List of IPv4 addresses associated with the NIC entity for the network connection.

Type:

list[ IPAddress ]

property ipv6_addresses#

List of IPv6 addresses associated with the NIC entity for the network connection.

Type:

list[ IPAddress ]

property is_dhcp_enabled#

Status of DHCP protocol.

Type:

bool

Link speed in Kbps.

Type:

int

property mac_address#

Host Mac address.

Type:

str

property mtu_in_bytes#

Maximum transmission unit in bytes.

Type:

int

property name#

Name of the host NIC.

Type:

str

property node_uuid#

UUID of the host.

Type:

str

property rx_ring_size_in_bytes#

Size of configured buffer (in bytes) to the port associated with NIC, storing the network packets received through the port.

Type:

int

property switch_device_id#

Switch device Id learned through the discovery protocol.

Type:

str

property switch_mac_address#

Switch Mac address

Type:

str

property switch_management_ip#
Type:

IPAddress

property switch_port_id#

Switch port Id learned through the discovery protocol.

Type:

str

property switch_vendor_info#

Switch vendor information learned through the discovery protocol.

Type:

str

property switch_vlan_id#

Switch VLAN Id learned through the discovery protocol.

Type:

str

to_dict()#

Returns the model properties as a dictionary

to_str()#

Returns the string representation of the model

property tx_ring_size_in_bytes#

Size of configured buffer (in bytes) to the port associated with NIC, storing the network packets that would be transmitted through the port.

Type:

int