1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
# This is referred from Redfish standard schema.
# https://redfish.dmtf.org/schemas/Endpoint.v1_3_0.json
import logging
from sushy.resources import base
from sushy.resources import common
from sushy.resources import constants as res_cons
from sushy.resources.fabric import constants as fab_cons
from sushy.resources import ipaddresses
from sushy import utils
LOG = logging.getLogger(__name__)
class IPv4AddressField(base.CompositeField):
address = base.Field('Address')
"""This is the IPv4 Address."""
gateway = base.Field('Gateway')
"""This is the IPv4 gateway for this address."""
subnet_mask = base.Field('SubnetMask')
"""This is the IPv4 Subnet mask."""
address_origin = base.MappedField('AddressOrigin',
ipaddresses.IPv4AddressOrigin)
"""This indicates how the address was determined."""
class IPv6AddressField(base.CompositeField):
address = base.Field('Address')
"""This is the IPv6 Address."""
prefix_length = base.Field('PrefixLength', adapter=utils.int_or_none)
"""This is the IPv6 Address Prefix Length."""
address_origin = base.MappedField('AddressOrigin',
ipaddresses.IPv6AddressOrigin)
"""This indicates how the address was determined."""
address_state = base.MappedField('AddressState', ipaddresses.AddressState)
"""The current state of this address as defined in RFC 4862."""
class IPTransportDetailsListField(base.ListField):
"""IP transport details
This array contains details for each IP transport supported by this
endpoint. The array structure can be used to model multiple IP addresses
for this endpoint.
"""
port = base.Field('Port', adapter=utils.int_or_none)
"""The UDP or TCP port number used by the Endpoint."""
transport_protocol = base.MappedField('TransportProtocol',
res_cons.Protocol)
"""The protocol used by the connection entity."""
ipv4_address = IPv4AddressField('IPv4Address')
"""The IPv4 address object."""
ipv6_address = IPv6AddressField('IPv6Address')
"""The IPv6 address object."""
class PciIdField(base.CompositeField):
device_id = base.Field('DeviceId')
"""The Device ID of this PCIe function."""
subsystem_id = base.Field('SubsystemId')
"""The Subsystem ID of this PCIefunction."""
subsystem_vendor_id = base.Field('SubsystemVendorId')
"""The Subsystem Vendor ID of thisPCIe function."""
vendor_id = base.Field('VendorId')
"""The Vendor ID of this PCIe function."""
class ConnectedEntitiesListField(base.ListField):
"""All the entities connected to this endpoint."""
pci_class_code = base.Field('PciClassCode')
"""The Class Code, Subclass code, and Programming Interface code of
this PCIe function."""
pci_function_number = base.Field('PciFunctionNumber',
adapter=utils.int_or_none)
"""The PCI ID of the connected entity."""
entity_pci_id = PciIdField('EntityPciId')
"""The PCI ID of the connected entity."""
identifiers = common.IdentifiersListField('Identifiers', default=[])
"""Identifiers for the remote entity."""
entity_role = base.MappedField('EntityRole', fab_cons.EntityRole)
"""The role of the connected entity."""
entity_type = base.MappedField('EntityType', fab_cons.EntityType)
"""The type of the connected entity."""
class Endpoint(base.ResourceBase):
"""This class represents a fabric endpoint.
It represents the properties of an entity that sends or receives protocol
defined messages over a transport.
"""
identity = base.Field('Id', required=True)
"""Identifier for the endpoint"""
name = base.Field('Name', required=True)
"""The endpoint name"""
description = base.Field('Description')
"""The endpoint description"""
status = common.StatusField('Status')
"""The endpoint status"""
host_reservation_memory_bytes = base.Field('HostReservationMemoryBytes',
adapter=utils.int_or_none)
"""The amount of memory in Bytes that the Host should allocate to connect
to this endpoint.
"""
endpoint_protocol = base.MappedField('EndpointProtocol', res_cons.Protocol)
"""The protocol supported by this endpoint."""
pci_id = PciIdField('PciId')
"""The PCI ID of the endpoint."""
IP_transport_details = IPTransportDetailsListField('IPTransportDetails')
"""This array contains details for each IP transport supported by this
endpoint. The array structure can be used to model multiple IP addresses
for this endpoint."""
connected_entities = ConnectedEntitiesListField('ConnectedEntities')
"""All entities connected to this endpoint."""
class EndpointCollection(base.ResourceCollectionBase):
"""Represents a collection of endpoints associated with the fabric."""
@property
def _resource_type(self):
return Endpoint
|
