sushy.resources.system.network package¶

Submodules¶

sushy.resources.system.network.adapter module¶

class sushy.resources.system.network.adapter.NetworkAdapter(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)¶

Bases: sushy.resources.base.ResourceBase

description = <sushy.resources.base.Field object>¶

Human-readable description of the resource

identity = <sushy.resources.base.Field object>¶

The network adapter identity string

manufacturer = <sushy.resources.base.Field object>¶

The manufacturer of this network adapter

model = <sushy.resources.base.Field object>¶

The model of this network adapter

name = <sushy.resources.base.Field object>¶

The name of the network adapter

property network_device_functions¶

Property to reference NetworkDeviceFunctionCollection instance

It is set once when the first time it is queried. On refresh, this property is marked as stale (greedy-refresh not done). Here the actual refresh of the sub-resource happens, if stale.

property network_ports¶

Property to reference NetworkPortCollection instance

It is set once when the first time it is queried. On refresh, this property is marked as stale (greedy-refresh not done). Here the actual refresh of the sub-resource happens, if stale.

part_number = <sushy.resources.base.Field object>¶

The part number of the network adapter

serial_number = <sushy.resources.base.Field object>¶

The serial number of the network adapter

status = <sushy.resources.common.StatusField object>¶

The status

class sushy.resources.system.network.adapter.NetworkAdapterCollection(connector, path, redfish_version=None, registries=None, root=None)¶

Bases: sushy.resources.base.ResourceCollectionBase

sushy.resources.system.network.constants module¶

class sushy.resources.system.network.constants.FlowControl(value)¶

Bases: enum.Enum

An enumeration.

NONE = 'None'¶

No IEEE 802.3x flow control is enabled on this port.

RX = 'RX'¶

The link partner can initiate IEEE 802.3x flow control.

TX = 'TX'¶

This station can initiate IEEE 802.3x flow control.

TX_RX = 'TX_RX'¶

This station or the link partner can initiate IEEE 802.3x flow control.

class sushy.resources.system.network.constants.IPAddressType(value)¶

Bases: enum.Enum

An enumeration.

IPV4 = 'IPv4'¶

IPv4 addressing is used for all IP-fields in this object.

IPV6 = 'IPv6'¶

IPv6 addressing is used for all IP-fields in this object.

class sushy.resources.system.network.constants.LinkStatus(value)¶

Bases: enum.Enum

An enumeration.

DOWN = 'Down'¶

The port is enabled but link is down.

STARTING = 'Starting'¶

This link on this interface is starting. A physical link has been established, but the port is not able to transfer data.

TRAINING = 'Training'¶

This physical link on this interface is training.

UP = 'Up'¶

The port is enabled and link is good (up).

class sushy.resources.system.network.constants.NetworkAuthenticationMethod(value)¶

Bases: enum.Enum

An enumeration.

CHAP = 'CHAP'¶

iSCSI Challenge Handshake Authentication Protocol (CHAP) authentication is used.

MUTUAL_CHAP = 'MutualCHAP'¶

iSCSI Mutual Challenge Handshake Authentication Protocol (CHAP) authentication is used.

NONE = 'None'¶

No iSCSI authentication is used.

class sushy.resources.system.network.constants.NetworkBootMode(value)¶

Bases: enum.Enum

An enumeration.

DISABLED = 'Disabled'¶

Do not indicate to UEFI/BIOS that this device is bootable.

FIBRE_CHANNEL = 'FibreChannel'¶

Boot this device by using the embedded Fibre Channel support and configuration. Only applicable if the NetDevFuncType is FibreChannel.

FIBRE_CHANNEL_OVER_ETHERNET = 'FibreChannelOverEthernet'¶

Boot this device by using the embedded Fibre Channel over Ethernet (FCoE) boot support and configuration. Only applicable if the NetDevFuncType is FibreChannelOverEthernet.

PXE = 'PXE'¶

Boot this device by using the embedded PXE support. Only applicable if the NetDevFuncType is Ethernet or InfiniBand.

SCSI = 'iSCSI'¶

Boot this device by using the embedded iSCSI boot support and configuration. Only applicable if the NetDevFuncType is iSCSI or Ethernet.

class sushy.resources.system.network.constants.NetworkDeviceTechnology(value)¶

Bases: enum.Enum

An enumeration.

DISABLED = 'Disabled'¶

Neither enumerated nor visible to the operating system.

ETHERNET = 'Ethernet'¶

Appears to the operating system as an Ethernet device.

FIBRE_CHANNEL = 'FibreChannel'¶

Appears to the operating system as a Fibre Channel device.

FIBRE_CHANNEL_OVER_ETHERNET = 'FibreChannelOverEthernet'¶

Appears to the operating system as an FCoE device.

INFINI_BAND = 'InfiniBand'¶

Appears to the operating system as an InfiniBand device.

iSCSI = 'iSCSI'¶

Appears to the operating system as an iSCSI device.

sushy.resources.system.network.device_function module¶

class sushy.resources.system.network.device_function.BootTargetsField(*args, **kwargs)¶

Bases: sushy.resources.base.ListField

lun_id = <sushy.resources.base.Field object>¶

The logical unit number (LUN) ID from which to boot on the device

priority = <sushy.resources.base.Field object>¶

The relative priority for this entry in the boot targets array.

wwpn = <sushy.resources.base.Field object>¶

The World Wide Port Name (WWPN) from which to boot.

class sushy.resources.system.network.device_function.EthernetField(*args, **kwargs)¶

Bases: sushy.resources.base.CompositeField

mac_address = <sushy.resources.base.Field object>¶

The currently configured MAC address of the resource

mtu_size = <sushy.resources.base.Field object>¶

The Maximum Transmission Unit (MTU) configured for this resource

permanent_mac_address = <sushy.resources.base.Field object>¶

The permanent MAC address assigned to this resource

vlan = <sushy.resources.system.network.device_function.VLANField object>¶

The VLAN for this interface

class sushy.resources.system.network.device_function.FibreChannelField(*args, **kwargs)¶

Bases: sushy.resources.base.CompositeField

boot_targets = <sushy.resources.system.network.device_function.BootTargetsField object>¶

An array of Fibre Channel boot targets configured for this resource.

class sushy.resources.system.network.device_function.ISCSIBootField(*args, **kwargs)¶

Bases: sushy.resources.base.CompositeField

authentication_method = <sushy.resources.base.MappedField object>¶

The configured capability of this network device function.

initiator_default_gateway = <sushy.resources.base.Field object>¶

The IPv6 or IPv4 iSCSI boot default gateway.

initiator_ip_address = <sushy.resources.base.Field object>¶

The IPv6 or IPv4 address of the iSCSI initiator.

initiator_netmask = <sushy.resources.base.Field object>¶

The IPv6 or IPv4 netmask of the iSCSI boot initiator.

ip_address_type = <sushy.resources.base.MappedField object>¶

The type of IP address being populated IP address fields.

primary_dns = <sushy.resources.base.Field object>¶

The IPv6 or IPv4 address of the primary DNS server.

primary_lun = <sushy.resources.base.Field object>¶

The logical unit number (LUN) for the primary iSCSI boot target.

primary_target_ip_address = <sushy.resources.base.Field object>¶

The IPv4 or IPv6 address for the primary iSCSI boot target.

primary_target_tcp_port = <sushy.resources.base.Field object>¶

The TCP port for the primary iSCSI boot target.

primary_vlan_enabled = <sushy.resources.base.Field object>¶

An indication of whether the primary VLAN is enabled.

primary_vlan_id = <sushy.resources.base.Field object>¶

The 802.1q VLAN ID to use for iSCSI boot from the primary target.

secondary_dns = <sushy.resources.base.Field object>¶

The IPv6 or IPv4 address of the secondary DNS server.

secondary_lun = <sushy.resources.base.Field object>¶

The logical unit number (LUN) for the secondary iSCSI boot target.

secondary_target_ip_address = <sushy.resources.base.Field object>¶

The IPv4 or IPv6 address for the secondary iSCSI boot target.

secondary_target_tcp_port = <sushy.resources.base.Field object>¶

The TCP port for the secondary iSCSI boot target.

secondary_vlan_enabled = <sushy.resources.base.Field object>¶

An indication of whether the secondary VLAN is enabled.

secondary_vlan_id = <sushy.resources.base.Field object>¶

The 802.1q VLAN ID to use for iSCSI boot from the secondary target.

class sushy.resources.system.network.device_function.NetworkDeviceFunction(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)¶

Bases: sushy.resources.base.ResourceBase

property assignable_physical_ports¶

An array of physical ports to which this resource may be assigned.

Network ports to which this network device function may be assigned.

Raises

MissingAttributeError if ‘@odata.id’ field is missing.

Returns

A list of NetworkPort instances

capabilities = <sushy.resources.base.MappedListField object>¶

An array of capabilities for this network device function.

description = <sushy.resources.base.Field object>¶

The network device function description

ethernet = <sushy.resources.system.network.device_function.EthernetField object>¶

The Ethernet capabilities, status, and configuration values.

fibre_channel = <sushy.resources.system.network.device_function.FibreChannelField object>¶

The Fibre Channel capabilities, status, and configuration values.

identity = <sushy.resources.base.Field object>¶

Identifier for the network device function

iscsi_boot = <sushy.resources.system.network.device_function.ISCSIBootField object>¶

The iSCSI boot capabilities, status, and configuration for a network device function.

max_virtual_functions = <sushy.resources.base.Field object>¶

The number of virtual functions that are available for this network device function.

name = <sushy.resources.base.Field object>¶

The network device function name

status = <sushy.resources.common.StatusField object>¶

The status of the resource

type = <sushy.resources.base.MappedField object>¶

The configured capability of this network device function.

class sushy.resources.system.network.device_function.NetworkDeviceFunctionCollection(connector, path, redfish_version=None, registries=None, root=None)¶

Bases: sushy.resources.base.ResourceCollectionBase

class sushy.resources.system.network.device_function.VLANField(*args, **kwargs)¶

Bases: sushy.resources.base.CompositeField

vlan_enabled = <sushy.resources.base.Field object>¶

vlan_id = <sushy.resources.base.Field object>¶

sushy.resources.system.network.port module¶

class sushy.resources.system.network.port.NetworkPort(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)¶

Bases: sushy.resources.base.ResourceBase

associated_network_addresses = <sushy.resources.base.Field object>¶

The array of configured network addresses that are associated.

current_link_speed_mbps = <sushy.resources.base.Field object>¶

The network port current link speed.

description = <sushy.resources.base.Field object>¶

The network port description

flow_control_configuration = <sushy.resources.base.MappedField object>¶

The locally configured 802.3x flow control setting.

flow_control_status = <sushy.resources.base.MappedField object>¶

The 802.3x flow control behavior negotiated with the link partner

identity = <sushy.resources.base.Field object>¶

The network port identity

link_status = <sushy.resources.base.MappedField object>¶

The link status of the network port.

name = <sushy.resources.base.Field object>¶

The network port name

physical_port_number = <sushy.resources.base.Field object>¶

The physical port number label for this port.

status = <sushy.resources.common.StatusField object>¶

The network port status

class sushy.resources.system.network.port.NetworkPortCollection(connector, path, redfish_version=None, registries=None, root=None)¶

Bases: sushy.resources.base.ResourceCollectionBase

Module contents¶