The rsd_lib.resources.v2_3.fabric.endpoint
Module¶
- class rsd_lib.resources.v2_3.fabric.endpoint.AuthenticationField(*args, **kwargs)¶
Bases:
CompositeField
- password = <sushy.resources.base.Field object>¶
- username = <sushy.resources.base.Field object>¶
- class rsd_lib.resources.v2_3.fabric.endpoint.ConnectedEntitiesField(*args, **kwargs)¶
Bases:
ListField
- entity_link = <sushy.resources.base.Field object>¶
- entity_role = <sushy.resources.base.Field object>¶
- entity_type = <sushy.resources.base.Field object>¶
- class rsd_lib.resources.v2_3.fabric.endpoint.Endpoint(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)¶
Bases:
ResourceBase
- connected_entities = <rsd_lib.resources.v2_3.fabric.endpoint.ConnectedEntitiesField object>¶
Entities connected to endpoint
- description = <sushy.resources.base.Field object>¶
The endpoint description
- identifiers = <rsd_lib.resources.v2_3.fabric.endpoint.IdentifiersField object>¶
Identifiers for endpoint
- identity = <sushy.resources.base.Field object>¶
The endpoint identity string
- ip_transport_details = <rsd_lib.resources.v2_3.fabric.endpoint.IPTransportDetailsField object>¶
IP transport details info of this endpoint
- links = <rsd_lib.resources.v2_3.fabric.endpoint.LinksField object>¶
These links to related components of this endpoint
- name = <sushy.resources.base.Field object>¶
The endpoint name
- oem = <rsd_lib.resources.v2_3.fabric.endpoint.OemField object>¶
The OEM additional info of this endpoint
- protocol = <sushy.resources.base.Field object>¶
Protocol for endpoint (i.e. PCIe)
- status = <rsd_lib.common.StatusField object>¶
The endpoint status
- update_authentication(username=None, password=None)¶
Update endpoint authentication
- Parameters:
username – an endpoint username used to authenticate it on the other side of a communication channel
password – an endpoint password
- Raises:
BadRequestError if at least one param isn’t specified
- class rsd_lib.resources.v2_3.fabric.endpoint.EndpointCollection(connector, path, redfish_version=None, registries=None, root=None)¶
Bases:
ResourceCollectionBase
- create_endpoint(identifiers, connected_entities, protocol=None, ip_transport_details=None, interface=None, authentication=None)¶
Create a new endpoint
- Parameters:
identifiers – provides iQN or NQN of created entity
connected_entities – provides information about entities connected to the endpoint
protocol – the protocol used by the endpoint
ip_transport_details – the transport used for accessing the endpoint
interface – the interface that should be used for the endpoint connectivity
authentication – authentication data for target-initiator authentication. Currently supported only for the iSCSI protocol.
- Returns:
The uri of the new endpoint
- class rsd_lib.resources.v2_3.fabric.endpoint.IPTransportDetailsField(*args, **kwargs)¶
Bases:
ListField
- ipv4_address = <sushy.resources.base.Field object>¶
- ipv6_address = <sushy.resources.base.Field object>¶
- port = <sushy.resources.base.Field object>¶
- transport_protocol = <sushy.resources.base.Field object>¶
- class rsd_lib.resources.v2_3.fabric.endpoint.IdentifiersField(*args, **kwargs)¶
Bases:
ListField
- name = <sushy.resources.base.Field object>¶
- name_format = <sushy.resources.base.Field object>¶