DHCP-Assigned Platform Management Parameters Specification PICMG HPM.3 R1.0 November 22, 2012

Transcription

1 HPM.3 DHCP-Assigned Platform Management Parameters Specification PICMG HPM.3 R1.0 November 22, 2012

2 Copyright 2012, PCI Industrial Computer Manufacturers Group. The attention of adopters is directed to the possibility that compliance with or adoption of PICMG specifications may require use of an invention covered by patent rights. PICMG shall not be responsible for identifying patents for which a license may be required by any PICMG specification or for conducting legal inquiries into the legal validity or scope of those patents that are brought to its attention. PICMG specifications are prospective and advisory only. Prospective users are responsible for protecting themselves against liability for infringement of patents. NOTICE: The information contained in this document is subject to change without notice. The material in this document details a PICMG specification in accordance with the license and notices set forth on this page. This document does not represent a commitment to implement any portion of this specification in any company's products. WHILE THE INFORMATION IN THIS PUBLICATION IS BELIEVED TO BE ACCURATE, PICMG MAKES NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH REGARD TO THIS MATERIAL INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF TITLE OR OWNERSHIP, IMPLIED WARRANTY OF MERCHANTABILITY OR WARRANTY OF FITNESS FOR PARTICULAR PURPOSE OR USE. In no event shall PICMG be liable for errors contained herein or for indirect, incidental, special, consequential, reliance or cover damages, including loss of profits, revenue, data or use, incurred by any user or any third party. Compliance with this specification does not absolve manufacturers of equipment from the requirements of safety and regulatory agencies (UL, CSA, FCC, IEC, etc.). IMPORTANT NOTICE: This document includes references to specifications, standards or other material not created by PICMG. Such referenced materials will typically have been created by organizations that operate under IPR policies with terms that vary widely, and under process controls with varying degrees of strictness and efficacy. PICMG has not made any enquiry into the nature or effectiveness of any such policies, processes or controls, and therefore ANY USE OF REFERENCED MATERIALS IS ENTIRELY AT THE RISK OF THE USER. Users should therefore make such investigations regarding referenced materials, and the organizations that have created them, as they deem appropriate. PICMG, CompactPCI, AdvancedTCA, AdvancedTCA 300,ATCA, ATCA 300, AdvancedMC, CompactPCI Express, COM Express, SHB Express, and the PICMG, CompactPCI, AdvancedTCA, µtca and ATCA logos are registered trademarks, and Micro- TCA, xtca, IRTM and the IRTM logo are trademarks of the PCI Industrial Computer Manufacturers Group. All other brand or product names may be trademarks or registered trademarks of their respective holders. ii PICMG HPM.3 R1.0, DHCP-Assigned Platform Management Parameters, November 22, 2012

3 Contents 1 Introduction Overview of the DHCP mechanism DHCP security Special word usage Conformance Reference specifications HPM.3 Specification contributors Name and logo usage Intellectual property Necessary claims Unnecessary claims Third party disclosures Overall caveats Glossary Revision history DHCP parameters for xtca Hardware Platform Management controllers IPM Controller DHCP interaction IPM Controller HPM.3 Discovery Determining DHCP Proxy and DHCP Client roles Standard DHCPv4 options HPM.3 DHCP Client ID IPMI LAN Channel Index assignment Shelf Type identification Slot location record definition for AdvancedTCA Slot location record definition for MicroTCA LAN Configuration Parameter support DHCP LAN Configuration Parameters request DHCP LAN Configuration Parameters response Standard DHCP option and LAN Configuration Parameter duplication or conflict Read-only parameter handling Propagating supplementary DHCP options from the DHCP Proxy to an IPM Controller Configuring retrieval of network parameters via DHCP Preventing IP address conflicts HPM.3 PICMG FRU Information records HPM.3 commands PICMG HPM.3 R1.0 22, DHCP-Assigned Platform Management Parameters, November 22, 2012 iii

4 A Examples A.1 Shelf Manager Client ID A.2 IPM Controller Client ID A.2.1 Front Board IPM Controller Client ID A.2.2 AMC MMC Client ID A.3 DHCP LAN Configuration Parameter examples A.3.1 LAN Configuration Parameters request A.3.2 LAN Configuration Parameters response A.4 DHCP server configuration examples A.4.1 Linux ISC DHCP server A.4.2 Solaris DHCP server A.4.3 Shelf DHCP Configuration record A.4.4 AMC Carrier DHCP Configuration record Figures Figure 1-1 Example xtca frame, showing instances of the geographic location approach defined by HPM Tables Table 1-1 Special terms... 8 Table 2-1 Get HPM.x Capabilities command Table 2-2 Get IP Address Source command Table 2-3 Useful IPM Controller DHCPv4 options Table 2-4 HPM.3 DHCP Client ID Table 2-5 HPM.3 DHCP Unique Identifier (DUID) Table 2-6 Recommended IPMI LAN Channel Index values for ATCA Front Boards Table 2-7 Recommended IPMI LAN Channel Index values for dedicated ATCA Shelf Managers Table 2-8 Recommended IPMI LAN Channel Index values for AMC Modules Table 2-9 Recommended IPMI LAN Channel Index values for MCH Modules Table 2-10 Format of Shelf type one-byte field Table 2-11 Slot location record for AdvancedTCA Table 2-12 Slot location record for MicroTCA Table 2-13 LAN Configuration Parameters Table 2-14 HPM.3 DHCP LAN Configuration Parameters request Table 2-15 HPM.3 DHCP LAN Configuration Parameters response Table 2-16 HPM.3 DHCP LAN Configuration Parameter sub-option format Table 2-17 HPM.3 LAN Configuration Parameters Table 2-18 HPM.3 DHCP Configuration record Table 2-19 DHCP Configuration Entry Table 2-20 HPM.3 AMC Carrier DHCP Configuration record iv PICMG HPM.3 R1.0, DHCP-Assigned Platform Management Parameters, November 22, 2012

5 Table 2-21 AMC Carrier DHCP Configuration Entries Table 3-1 HPM.3 PICMG FRU Information records Table 4-1 Command number assignments and requirements Table A-1 Shelf Manager Client ID example Table A-2 Front Board Client ID example Table A-3 AMC MMC Client ID example Table A-4 HPM.3 DHCP LAN Configuration Parameters request Table A-5 Sample DHCP Set LAN Configuration Parameter command response values Table A-6 HPM.3 DHCP LAN Configuration Parameters response Table A-7 HPM.3 DHCP Configuration record example Table A-8 HPM.3 AMC Carrier DHCP Configuration record example PICMG HPM.3 R1.0 22, DHCP-Assigned Platform Management Parameters, November 22, 2012 v

6

7 Section 1 1 Introduction 1 The purpose of this specification is to define the format used to request and receive configuration information from a Dynamic Host Configuration Protocol (DHCP) server. This allows an xtca device to request and receive information automatically, on demand. 2 The use of DHCP for configuration can greatly simplify the management of an xtca environment, eliminating the potential need to manually configure dozens of devices per ATCA or MicroTCA Shelf. 3 In this specification, an IPM Controller identifies itself for configuration purposes by a geographic location, in a way that is independent of the IPM Controller s implementation or the identity of the Board or Module (generically, a FRU) into which it is integrated. If the FRU containing the IPM Controller is replaced by another in the same Shelf location, the new FRU gets the same identification and therefore the same configuration information assigned. 4 Throughout this specification, the term Intelligent Platform Management Controller (IPM Controller) is intended to cover the following xtca management controllers: PICMG 3.0 Shelf Manager PICMG 3.0 IPM Controller AMC.0 Carrier IPM Controller AMC.0 Module Management Controller (MMC) MTCA.0 Shelf Manager MTCA.0 Carrier Manager MTCA.0 MicroTCA Carrier Management Controller (MCMC) MTCA.0 Enhanced Module Management Controller (EMMC) PICMG HPM.3 R1.0, DHCP-Assigned Platform Management Parameters, November 22,

8 Section 1 Figure 1-1Example xtca frame, showing instances of the geographic location approach defined by HPM.3 5 Figure 1-1 shows an xtca frame containing three example Shelves: two ATCA Shelves and one MicroTCA Shelf. As an introduction to the kinds of geographic location identifiers (called Client IDs by DHCP) defined by this specification, the figure is annotated to show some example locations approximately as they could be specified. Each Shelf is identified by a Shelf address, an arbitrary ASCII string up to twenty characters long. In the example, a Shelf is identified by an aisle number, a frame number within that aisle and a Shelf number within that frame. As long as the Shelf addresses are unique within a given DHCP naming domain, the Shelf address strings can be defined by any approach that fits the provisioning conventions of the end customer. Each Shelf is also identified as either an ATCA or a MicroTCA Shelf. In the figure, this information appears vertically to the right of each Shelf. ATCA Boards, specifically the IPM Controllers or Carrier IPMCs implemented on them, are located within a Shelf by the Board s Physical Slot Number (7 in the example for a non-carrier Board). AMC Modules in an ATCA Carrier, specifically the MMCs implemented on them, are located by the Carrier Physical Slot Number plus a Module position in the Carrier. In the example, the AMC Modules in ATCA Carrier Boards are in Board 2, AMC Bay B1 and Board 14, AMC Bay B2, respectively. Management controllers on MicroTCA Modules are located by shelf level or absolute Tier Number and Slot Number coordinates. In the example, the highlighted MCH and AMC Modules are located at [Tier, Slot] coordinates [1,1] and [3,4] respectively. Additional aspects of location identifiers for MicroTCA Modules are covered later in the specification and more background on this topic is provided in sections 2 and 3 of the MTCA.0 specification. Absolute [Tier, Slot] coordinates uniquely and geographically designate a Module position anywhere in a MicroTCA shelf, which can include up to 16 MicroTCA Carriers. Shelf Managers can be located by physical instance, identifying the physical FRU on which they are implemented. Alternatively, the logical Shelf Manager can be referenced. A logical Shelf Manager represents a Shelf and is independent of the particular physical Shelf Manager instance that is playing the role of active Shelf Manager at a given time. 2 PICMG HPM.3 R1.0, DHCP-Assigned Platform Management Parameters, November 22, 2012

9 Section 1 6 The complete location identifier for an xtca management controller, as defined by this specification, includes the Shelf address and type, plus the geographic location of the FRU on which the controller is implemented. 1.1 Overview of the DHCP mechanism 7 The Dynamic Host Configuration Protocol (DHCP) is used to provide configuration information to requesting clients automatically, on demand by the client. 8 The DHCP Client passes its Ethernet MAC address or another identifier (a Client ID) to the DHCP server, which returns configuration data to the requesting client. The Client ID passed is usually based on easily obtained hardware-related parameters, and is used when using the Ethernet MAC address is not practical. 9 The DHCP server may return one option, or a set of multiple options, depending on how the server was configured. 10 Multiple requests of a DHCP server can be made for the same client interface, possibly at different times during its configuration process, and may use different Client IDs with different requests. 1.2 DHCP security 11 DHCP provides an authentication and message integrity mechanism, as described in RFC This mechanism is not prescribed in this document, but nothing in this document precludes its use. 1.3 Special word usage 13 In this specification, the following key words (in bold text) will be used: may should shall indicates flexibility of choice with no implied preference. indicates flexibility of choice with a strongly preferred implementation. The use of should not (in bold text) indicates flexibility of choice with a strong preference that the choice or implementation be avoided. indicates a mandatory requirement. Designers shall implement such mandatory requirements to ensure interchangeability and to claim conformance with this specification. The use of shall not (in bold text) indicates an action or implementation that is prohibited. Note: When not in bold text, the words may, should, and shall are being used in the traditional sense; that is, they do not adhere to the strict meanings described above. 14 This document uses requirements numbering as a way to find and reference HPM.3 requirements. Each requirement is numbered using the format REQ X.YY where X is the top level section where the requirement is located, YY denotes the requirement number and is a running sequence for each top level section. PICMG HPM.3 R1.0, DHCP-Assigned Platform Management Parameters, November 22,

10 Section Conformance 15 Statements of compliance with this specification take the form specified in the PICMG Policies and Procedures for Specification Development: This product complies with PICMG HPM.3 Revision Products making this simple claim of compliance must provide, at a minimum, all features defined in numbered requirements (REQ X.YY) listed in this specification as being mandatory by using the keyword shall in the body of the requirement. Such products must not include any feature prohibited by the use of the keyword shall not in the numbered requirements contained in the specification. Such products may also provide recommended features associated with the keyword should, preferentially not provide the features associated with the keywords should not, and permitted features associated with the keyword may contained within the numbered requirements. 17 A simple claim of compliance with a subsidiary specification indicates the presence of all features defined as being mandatory by the use of the keyword shall, and absence of any features defined as being prohibited by the keywords shall not in the body of that specification. 1.5 Reference specifications 18 The following publications are used in conjunction with this specification. All documents can be obtained from the respective organizations. AdvancedTCA Base Specification (PICMG 3.0 R3.0), March 24, Advanced Mezzanine Card Base Specification (AMC.0 R2.0), November 15, 2006, Dynamic Host Configuration Protocol (DHCP) and Bootstrap Protocol (BOOTP) Parameters, Internet Assigned Numbers Authority, IPMI Intelligent Platform Management Bus Communications Protocol Specification V1.0 Document Revision 1.0, November 15, 1999, IPMI Intelligent Platform Management Interface Specification, v1.5. Document Revision 1.1, February 20, 2002, IPMI Intelligent Platform Management Interface Specification Second Generation, v2.0. Document Revision 1.0, February 12, 2004 (June 12, 2009 markup), MicroTCA Base Specification (MTCA.0 R1.0), HPM.1 Hardware Platform Management IPM Controller Firmware Upgrade Specification (HPM.1), R1.0, May 4, 2007, HPM.2 LAN-Attached IPM Controller Specification, R1.0 (HPM.2), August, 2012, PICMG Policies and Procedures for Specification Development, Revision 2.0, September 14, RFC 2131 Dynamic Host Configuration Protocol, March 1997, IETF, 4 PICMG HPM.3 R1.0, DHCP-Assigned Platform Management Parameters, November 22, 2012

11 Section 1 RFC 2132 DHCP Options and BOOTP Vendor Extensions, March 1997, IETF, RFC 3004 The User Class Option for DHCP, November 2000, IETF, RFC 3118 Authentication for DHCP Messages, June 2001, IETF, RFC 3315 DHCP for IPv6, July 2003, IETF, RFC 3396 Encoding Long Options in the Dynamic Host Configuration Protocol (DHCPv4), November 2002, IETF, RFC 3925 Vendor-Identifying Vendor Options for Dynamic Host Configuration Protocol version 4, October 2004, IETF, RFC 4361 Node-specific Identifiers for DHCPv4, February 2006, IETF, RFC 5859 TFTP Server Address Option for DHCPv4, June 2010, HPM.3 Specification contributors 19 The following companies met the criteria as active members of the HPM.x subcommittee at the time of this writing. Alcatel-Lucent Cisco Systems Comtel Electronics Kontron Pigeon Point Systems Samway Electronic SRL Simonson Technology Services ZNYX Networks 1.7 Name and logo usage 20 The PCI Industrial Computer Manufacturers Group policies regarding the use of its logos and trademarks are as follows: 21 Permission to use the PICMG organization logo is automatically granted to designated PICMG members only as stipulated on the most recent Membership Privileges document (available at during the period of time for which their membership dues are paid. Non-members must not use the PICMG organization logo. 22 The PICMG organization logo must be printed in black or color, as shown in the files available for download from the members side of the Web site. The center bar of the logo containing the phrase PICMG is set horizontally and the aspect ratio of the entire logo must be maintained, but the size may be varied. Nothing may be added or deleted from the PICMG logo. 23 Manufacturers distributors and sales representatives may use PICMG trademarked and registered logos and trademarks (but not the PICMG organization logo) in promoting products sold under the name of the manufacturer. The use of these logos and trademarks is a privilege granted by the PICMG organization to companies who have purchased the relevant specifications (or acquired them as a member benefit), and who believe their products comply with these specifications. Use of the logos and trademarks by either members or non-members implies such compliance. PICMG may revoke permission to use logos if they are misused. PICMG HPM.3 R1.0, DHCP-Assigned Platform Management Parameters, November 22,

12 Section 1 All trademarked and registered logos and trademarks must carry the or symbols as appropriate and must be attributed to PICMG. The logos may be found on the members side of the website Non-members may fill out the logo request form therein. 24 The PICMG name and logo are registered trademarks of PICMG. Registered trademarks must be followed by the symbol, and the following statement must appear in all published literature and advertising material in which the logo appears: The PICMG name and logo are registered trademarks of the PCI Industrial Computer Manufacturers Group. 1.8 Intellectual property 25 The Consortium draws attention to the fact that it is claimed that compliance with this specification might involve the use of a patent claim(s) (Intellectual Property - IPR ). The Consortium takes no position concerning the evidence, validity, or scope of this IPR. 26 Under the PICMG Intellectual Property Rights Policy adopted by the Executive Membership September 16, 2011, the license grants of Necessary Claims made in connection with this specification apply only to the Compliant Portion of an implementation. As a result they apply only to the required (as designated by the keyword shall ) or recommended (as designated by the keyword should ) elements of a specification that are within the bounds of the Statement of Work under which the Specification was developed. 27 The holder of this IPR has assured the Consortium that it is willing to license or sublicense all such IPR to those licensees (Members and non-members alike) desiring to implement this specification. The statement of the holder of this IPR to such effect has been filed with the Consortium. 28 Attention is also drawn to the possibility that some of the elements of this specification might be the subject of IPR other than those identified below. The Consortium is not responsible for identifying any or all such IPR. 29 No representation is made as to the availability of any license rights for use of any IPR inherent in this specification for any purpose other than to implement this specification. 30 This specification conforms to the current PICMG Intellectual Property Rights Policy and the Policies and Procedures for Specification Development and does not contain any known intellectual property that is not available for licensing under Reasonable and Non-discriminatory terms. In the course of Membership Review the following disclosures were made: Necessary claims 31 Alcatel-Lucent has been issued US Patent 8,055,772 System for Effecting Communication Among a Plurality of Devices and Method for Assigning Addresses Therefor and has asserted Necessary Claims therein, relative to HPM.3 and specifically to compliance with the following aspects of the specification: REQ 2.27 and REQ 2.30, plus Table 2-4 and Table Alcatel-Lucent has delivered an IPR Submission assuring that they will license the claims under standard RAND terms while retaining their royalty rights. 33 In addition, this specification requires implementations of the Intelligent Platform Management Interface and Intelligent Platform Management Bus specifications. The IPMI Promoters (Dell, HP, Intel Corporation 6 PICMG HPM.3 R1.0, DHCP-Assigned Platform Management Parameters, November 22, 2012

13 Section 1 and NEC Corporation) require that implementers of either of these specifications sign the IPMI Adopters Agreement. Please refer to for details Unnecessary claims 34 No disclosures in this category have been made Third party disclosures 35 US Patent 7,395,323 System and Method for Providing Network Address Information in a Server System. This patent could relate to the HPM.3 facilities for assigning network addresses via IPMI commands. 36 US Patent Application Modular Server Architecture with High-Availability Management Capability ; abandoned. Includes conceptual similarities to facilities defined in this specification. Potentially provides useful insights into the intellectual property landscape for this specification. 37 US Patent Application System and Method for DHCP Client-ID Generation ; abandoned. Conceptually similar to facilities defined in this specification. Potentially provides useful insights into the intellectual property landscape for this specification. 38 US Patent 7,103,040 Method and Apparatus for Identifying a Node for Data Communication Using its Geographical Location. Relates to DHCP-based IP address assignment based on physical geographic locations (e.g., lattitude and longitude) Overall caveats 39 Refer to PICMG IPR Policies and Procedures and the company owner of the patent for terms and conditions of usage. 40 PICMG makes no judgment as to the validity of these claims or the licensing terms offered by the claimants. 41 THIS SPECIFICATION IS BEING OFFERED WITHOUT ANY WARRANTY WHATSOEVER, AND IN PARTICULAR, ANY WARRANTY OF NON-INFRINGEMENT IS EXPRESSLY DISCLAIMED. ANY USE OF THIS SPECIFICATION IS MADE ENTIRELY AT THE IMPLEMENTER'S OWN RISK, AND NEITHER THE CONSORTIUM, NOR ANY OF ITS MEMBERS OR SUBMITTERS, HAVE ANY LIABILITY WHATSOEVER TO ANY IMPLEMENTER OR THIRD PARTY FOR ANY DAMAGES OF ANY NATURE WHATSOEVER, DIRECTLY OR INDIRECTLY, ARISING FROM THE USE OF THIS SPECIFICATION. 42 Compliance with this specification does not absolve manufacturers of equipment from the requirements of safety and regulatory agencies (UL, CSA, FCC, IEC, etc.). 1.9 Glossary 43 The special terms in Table 1-1 are used throughout this specification. PICMG HPM.3 R1.0, DHCP-Assigned Platform Management Parameters, November 22,

14 Section 1 Table 1-1 Special terms Term Definition AMC ARP ATCA Base Interface BMC Board Carrier IPMC Carrier Manager Client ID DHCP DHCP Client DHCP Proxy DHCPv4 DHCPv6 Advanced Mezzanine Card or AdvancedMC. This refers to the Modules defined in the AMC.0 specification. Address Resolution Protocol. This protocol is used to determine the MAC address that corresponds to an IP address. See RFC0826 for a formal definition. Advanced Telecom Computing Architecture. This is governed by the PICMG 3.0 specification. In ATCA systems, the Base Interface consists of 10/100/1000BASE-T Ethernet interfaces routed over the backplane. Baseboard Management Controller. This is an IPMI term that corresponds to the term IPM Controller in the HPM.3 domain. Refers to an ATCA Front Board or Rear Transition Module (RTM). Carrier IPM Controller. This refers to the IPM Controller on an ATCA Carrier Board. A Carrier Manager is a logical function in a MicroTCA system that handles responsibilities similar an ATCA Carrier Board s Carrier IPMC. The Carrier Manager also handles some of the responsibilities of an ATCA Shelf Manager. See MTCA.0 for a formal definition. The HPM.3 client identifier string Dynamic Host Configuration Protocol The entity that is directly contacting the DHCP server. An intermediary agent (Shelf Manager or System Manager) that can make DHCP requests on behalf of an IPM Controller that is unable or not allowed to make these requests directly Dynamic Host Configuration Protocol for IPv4 Dynamic Host Configuration Protocol for IPv6 DUID DHCP Unique Identifier (RFC 3315) EMMC Fabric Interface FRU Gratuitous ARP Enhanced Module Management Controller. Used on MicroTCA Cooling Units, Power Module, and OEM Modules. In ATCA systems, the Fabric Interface consists of protocol-agnostic differential pairs routed over the backplane. In the context of this specification, the Fabric Interface is typically assumed to use Ethernet protocols. Field Replaceable Unit. Gratuitous ARP messages are sent to inform network switches and Network 8 PICMG HPM.3 R1.0, DHCP-Assigned Platform Management Parameters, November 22, 2012

15 Section 1 Clients that an IP address is now associated with a new MAC address. HPM Hub Board Hardware Platform Management. An ATCA Board that provides Ethernet switching for the Base Interface and optionally a fabric switch for the Fabric Interface. In the context of this specification, the Fabric Interface switch is typically assumed to be an Ethernet switch. IAID Identity Association Unique Identifier (RFC 3315) IANA IOL IP IPM Controller (IPMC) IPMB IPMB-0 IPMI IPMI Channel IPMI LAN Channel IRTM LAN LAN Configuration Parameter MAC MCMC Module Network Client Internet Assigned Numbers Authority IPMI-Over-LAN Internet Protocol As used in this specification, includes all xtca-defined board/module management controllers. Intelligent Platform Management Bus The redundant pair of IPMBs (A and B) that connect the Shelf Manager and the Front Boards (in ATCA), or the MicroTCA Carrier Hub, Power Modules and Cooling Units (in MicroTCA) Intelligent Platform Management Interface A logical communication channel defined in the IPMI specification and used for exchanges of IPMI messages. Includes both sessionless channels (such as IPMB or the Payload Interface) and session-oriented channels (such as IPMI LAN Channels). A session-oriented IPMI Channel that connects an IPM Controller to a LAN. Intelligent Rear Transition Module. IRTMs are ATCA Rear Transition Modules that include an MMC and conform to the IRTM.0 specification. Local Area Network. An IPMI- or OEM-defined parameter associated with the IPMI-defined LAN Interface, set and retrieved via the Get/Set LAN Configuration Parameters command and including OEM parameters. Media Access Controller. This is part of a network controller. MTCA.0 MicroTCA Carrier Management Controller Typically refers to AMCs, but can also refer to IRTMs and MicroTCA Power Modules (PMs), Cooling Units (CUs), OEM Modules, and MicroTCA Carrier Hubs (MCHs). A Network Client is any application that connects to IPMCs using the LAN attach mechanisms defined in the HPM.2 specification and leveraged here in HPM.3. PICMG HPM.3 R1.0, DHCP-Assigned Platform Management Parameters, November 22,

16 Section 1 OEM Payload RMCP RMCP+ Shelf Shelf Manager SOL System Manager xtca Original Equipment Manufacturer. The primary function that a FRU provides. This includes all the hardware on the FRU except that associated with management. It might also include the firmware, operating system and application software running on the Payload hardware. Remote Management Control Protocol. This protocol is defined in the IPMI v1.5 specification for communicating with an IPMC over LAN. Remote Management Control Protocol Plus. This protocol is defined in the IPMI v2.0 specification for communicating with an IPMC over LAN. A Shelf consists of the Subrack, Backplane and other physical infrastructure supporting FRUs; sometimes also includes installed FRUs, as well, such as Front Boards, Modules, cooling devices, rear transition modules, power supplies, etc. Also historically known as a chassis. In ATCA systems, the Shelf Manager is the entity responsible for managing the power, cooling, and interconnects (with Electronic Keying). In MicroTCA systems, the Shelf Manager is the entity that aggregates a set of MicroTCA Carriers into a single logical Shelf. A Shelf Manager provides an interface to a System Manager. Serial-Over-LAN. Serial over LAN (SoL) uses LAN for (payload and IPM Controller) serial console traffic to avoid routing serial cables to boards A level of management functionality above the Shelf Manager charged with the management of an entire System, whatever that means in a specific implementation. In the context of this specification, also includes Network Clients, in general. Umbrella term covering AdvancedTCA, AdvancedMC and MicroTCA Revision history Date Revision Changes November 22, 2012 Revision 1.0 Initial release 10 PICMG HPM.3 R1.0, DHCP-Assigned Platform Management Parameters, November 22, 2012

17 2 DHCP parameters for xtca Hardware Platform Management controllers 44 As noted in section 1, the term IPM Controller is intended in this specification to cover all the xtca management controller types. 45 The term DHCP Client refers to the entity that is directly contacting the DHCP server. An IPM Controller that issues DHCP requests is a DHCP client. Additionally, a DHCP server proxy is a DHCP client. 2.1 IPM Controller DHCP interaction 46 In an environment with a large number of IPM Controllers, manually providing configuration information to these controllers, such as network addresses, can become a time-consuming task. In a large environment, this can become unmanageable, and a serious constraint on hardware provisioning. 47 DHCP is a standard way of providing such information to network-aware components. This specification extends the use of DHCP to IPM Controllers, either directly or operating as a proxy for another entity without usable direct network access. 48 Network-related configuration information is provided to an IPM Controller by using the Set LAN Configuration Parameters command. This specification shows how this data can be obtained from a DHCP server. 49 DHCP has the ability to provide arbitrary vendor-specific information. This facility is used to provide PICMG-specific xtca configuration information without precluding the ability to support other vendorspecific data. 50 The parameters used by the Set LAN Configuration Parameters command are referred to as LAN Configuration Parameters in this document. This applies to both the defined standard and vendor-specific items that may be provided using the Set LAN Configuration Parameters command, including any HPM.2 OEM parameters that may be useful. 51 The focus of this specification is on the use of DHCPv4 in general and DHCPv4 options in particular. Support for DHCPv6 is postponed until a later revision of this specification; no support for DHCPv6 is provided by the current version. Since options in DHCPv6 have a different and incompatible format compared to DHCPv4, all definitions of DHCP options and their usage in this specifications apply to DHCPv4 and not to DHCPv6. Requirements REQ 2.1 REQ 2.2 All xtca IPM Controllers, including PICMG 3.0 IPM Controllers, AMC.0 Carrier IPMCs and MMCs, MTCA.0 EMMCs and MCMCs, as well as IPM Controllers located with Shelf Managers, shall comply with the requirements of this specification. All xtca IPM Controllers that claim compliance with HPM.3 shall also be compliant with HPM IPM Controller HPM.3 Discovery 52 Discovery of HPM.3 capabilities on an IPM Controller is performed by sending the command Get HPM.x Capabilities (with the field HPM.x Identifier equal to 03h) to the target IPM Controller. This command is specifically designed to discover whether an IPM Controller supports extensions defined in some HPM.x PICMG HPM.3 R1.0, DHCP-Assigned Platform Management Parameters, November 22,

18 specification. (At the time of this writing, the only other HPM.x specification in this category is HPM.2.) This command is defined in the Table 2-1 below. 53 An IPM Controller that does not support any HPM.x extensions that make use of this command does not recognize this command and responds with the Completion Code C1h ( Invalid Command ). An IPM Controller that supports HPM.3 extensions and receives the Get HPM.x Capabilities command with the field HPM.x Identifier identifying HPM.x extensions that it does not support, responds with the Completion Code CCh ( Invalid Data Field in Request ). 54 An IPM Controller that supports HPM.3 extensions recognizes this command and reports its HPM.3-related capabilities in the response. 55 If the target IPM Controller supports this revision of the HPM.3 specification, it reports 01h in the HPM.3 Revision Identifier field of the Get HPM.x Capabilities response. 56 In addition, the target IPM Controller reports the corresponding first parameter number and the revision number of the parameter block in the Get HPM.x Capabilities response. See section 2.7 for more information. Table 2-1 Get HPM.x Capabilities command Byte Data field Request data 1 PICMG Identifier. Indicates that this is a PICMG-defined group extension command. A value of 00h is used. 2 HPM.x Identifier. Identifies the HPM.x specification; capabilities are requested in the context of the identified specification. A value of 03h is used to query for HPM.3 capabilities. Response data 1 Completion Code 2 PICMG Identifier. Indicates that this is a PICMG-defined group extension command. A value of 00h is used. 3 HPM.x Identifier. This field is copied verbatim from the request. A value of 03h is used in a response that contains HPM.3 capabilities. 4 HPM.3 Revision Identifier. Use 01h for this specification. 5 HPM.3 OEM LAN Parameters Start Location. (OEM range C0h-FFh). This is the number of the first HPM.3 OEM LAN Configuration parameter. See section 2.7 for more information 6 HPM.3 OEM LAN Parameters Blocks Revision Number. This number is 01h for this specification. Requirements REQ 2.3 REQ 2.4 REQ 2.5 An IPM Controller that supports HPM.3 extensions shall properly recognize and respond to the Get HPM.x Capabilities command with the field HPM.x Identifier set to 03h, as defined in Table 2-1. An IPM Controller that supports HPM.3 extensions and receives the Get HPM.x Capabilities command with the field HPM.x Identifier identifying HPM.x extensions that it does not support shall respond with the Completion Code CCh ( Invalid Data Field in Request ). An IPM Controller shall use revision number 01h as the value of the HPM.3 Revision Identifier field in the response to the command Get HPM.x Capabilities. 12 PICMG HPM.3 R1.0, DHCP-Assigned Platform Management Parameters, November 22, 2012

19 2.3 Determining DHCP Proxy and DHCP Client roles 57 An IPM Controller might be able to make DHCP requests directly (thereby acting as a DHCP Client); alternatively, DHCP requests could be made on behalf of the IPM Controller by a DHCP Proxy. In the latter case, DHCP requests are made by a DHCP Proxy on behalf of the IPM Controller, with the DHCP results applied to the IPM Controller using the Set LAN Configuration Parameters command. 58 If an IPM Controller has the ability to make direct DHCP requests, it must not do so unless explicitly authorized. This avoids the problem of a race condition between a System Manager or Shelf Manager trying to set parameter values, and the IPM Controller itself setting them from DHCP data. This restriction allows the parameter source to be deterministic. 59 Authorization for an IPM Controller to use DHCP comes from the the Shelf Manager in the form of the IPMI command Set LAN Configuration Parameters that sets parameter 4 (IP address source) to a certain value. Setting it to the value of 2 (obtained from DHCP) allows the IPM Controller to use DHCP directly; setting it to the value of 4 (other address assignment protocol) instructs the IPM Controller that direct use of DHCP is not allowed and that the System Manager or the Shelf Manager will operate as a DHCP Proxy for the IPM Controller. The Shelf Manager chooses the value of the parameter IP address source based on the contents of the HPM.3 DHCP Configuration record in the Shelf FRU Information or the AMC Carrier DHCP Configuration record in the Carrier FRU Information. See section 2.8 for the details of these configuration mechanisms. 60 If an HPM.3 compliant FRU is used in a non-hpm.3 Shelf or with a non-hpm.3 Shelf Manager, the IP address source parameter will not be set by the Shelf Manager. For this reason, a DHCP capable IPM Controller must have an alternative method of determining whether it is allowed to issue a DHCP request directly or must wait for a DHCP Proxy to configure its LAN Configuration Parameters. The Get IP Address Source command can be used to query the Shelf Manager for the IP Address Source parameter value. An (E)MMC can issue a Get Address Info (Site Type/Site Number) command to its Carrier IPMC to determine the Carrier IPMC s IPMB-0 address and Carrier Number, if applicable. 61 Finally, if an HPM.3 compliant IPM Controller receives a Get IP Address Source response from the Shelf Manager that indicates that IP Address Source = 0 or if the Shelf Manager doesn t recognize that command, the IPM Controller implements its use of the IP address source LAN Configuration Parameter consistent with the IPMI specification, since that case is outside the scope of the HPM.3 specification. Table 2-2 Get IP Address Source command Byte Data field Request data 1 PICMG Identifier. Indicates that this is a PICMG-defined group extension command. A value of 00h is used. 2 IPMB Address. Indicates the IPMB address of the primary FRU on the IPMB connecting the primary FRU to the Shelf Manager. For ATCA: IPMB-0 address For MicroTCA: 80h + (Carrier Number * 2) (3) Subsidiary FRU Identifier Type. Required for subsidiary FRUs, otherwise optional. 0 = None 1 = IPMB-L address of subsidiary MMC-represented FRU 2 = IPMB-0 address of subsidiary EMMC-represented FRU 3 = FRU Device ID of subsidiary FRU All other values are reserved. (4) Subsidiary FRU Identifier. Identifies a specific subsidiary FRU among those PICMG HPM.3 R1.0, DHCP-Assigned Platform Management Parameters, November 22,

20 Response data 1 Completion Code represented by the IPM Controller indicated by IPMB Address. This field is required if byte 3 is included. Write as 0 if byte 3 = None (0). 2 PICMG Identifier. Indicates that this is a PICMG-defined group extension command. A value of 00h is used. 3 IP Address Source. Indicates an IP address source LAN Configuration Parameter value for the specified FRU, based on configuration arrangements defined in section = Not configured for HPM.3 2 = DHCP assigned 4 = DHCP Proxy assigned All other values are reserved. Requirements REQ 2.6 A DHCP Proxy shall be capable of retrieving any standard DHCPv4 options on behalf of IPM Controllers in a Shelf that it manages. REQ 2.7 A DHCP Proxy shall apply retrieved options to the relevant IPM Controllers using the Set LAN Configuration Parameters command. REQ 2.8 Alternatively, an IPM Controller may retrieve any standard DHCPv4 options directly from a DHCP server. REQ 2.9 The determination of which IPM Controller configuration approach IPM Controller direct request or DHCP Proxy request is used should be made by the Shelf configuration option(s) defined in section 2.8. REQ 2.10 Shelf Managers shall support the Get IP Address Source command as defined in Table 2-2. REQ 2.11 Shelf Managers shall respond with Completion Code = D5h ( Not Supported In Present State ) to the Get IP Address Source command if the Shelf Manager has not completed determining the DHCP configuration for the specified FRU. REQ 2.12 Shelf Managers shall respond to Get IP Address Source commands with Completion Code = 00h ( Command Completed Normally ) and IP Address Source = 00h if either the DHCP configuration as defined in section 2.8 for the requesting FRU is set to not use HPM.3 or the Shelf FRU Information does not include the DHCP Configuration record as defined in section 2.8. REQ 2.13 A DHCP-capable IPM Controller shall only make direct DHCPv4 requests if the Shelf Manager either: a) sets the IPM Controller s LAN Configuration Parameter 4 (IP address source) to a value of 2 (obtained from DHCP) or b) responds to a Get IP Address Source command, requesting the IP address source for the IPM Controller, with Completion Code = 00h and the IP Address Source response field equal to 2. REQ 2.14 When a DHCP-capable IPM Controller performs direct DHCP requests, it shall assign all of the LAN Configuration parameters associated with a channel, including IP address source, as an atomic transaction with respect to the Set In Progress parameter for that channel. REQ 2.15 If the Shelf Manager responds to a Get IP Address Source command requesting the IP address source for an IPM Controller with either: a) Completion Code = 00h and the IP Address Source response field equal to 0, or b) Completion Code = C1h ( Invalid Command ), the IPM Controller issuing that Get IP Address Source command shall, as an exception to REQ 2.13, implement the use of its LAN Configuration Parameter 4 (IP address source) in accordance with the IPMI specification. 14 PICMG HPM.3 R1.0, DHCP-Assigned Platform Management Parameters, November 22, 2012

21 REQ 2.16 REQ 2.17 REQ 2.18 REQ 2.19 REQ 2.20 REQ 2.21 REQ 2.22 REQ 2.23 If the Shelf Manager responds to a Get IP Address Source command with Completion Code = D5h ( Not Supported In Present State ), an IPM Controller shall periodically reissue the command until the Shelf Manager either a) sets the IPM Controller s LAN Configuration Parameter 4 (IP address source), or b) responds to a Get IP Address Source command with a Completion Code value other than D5h ( Not Supported In Present State ). An IPM Controller that receives a Get IP Address Source command response with Completion Code = 0 and response field IP Address Source = 2 or 4 shall, as an atomic transaction with respect to the Set In Progress parameter, 1) set its LAN Configuration Parameter 4 (IP address source) to the IP Address Source value from that Get IP Address Source response, and 2) if, and only if, the new IP address source value is different from the old IP address source value, set its LAN Configuration Parameter 3 (IP address) to If the Shelf Manager sets LAN Configuration Parameter 4 (IP address source) to a value of 4 (other address assignment protocol), the DHCP Proxy shall provide DHCP-obtained configuration information on behalf of that IPM Controller, in lieu of direct DHCPv4 requests by the IPM Controller. If the IPM Controller is not DHCP-capable, or for some other reasons chooses not to perform DHCP configuration, a Set LAN Configuration Parameters parameter 4 (IP address source) value of 2 shall be rejected by the IPM Controller with a return code of 0xC9 ( Parameter Value Out of Range ). The DHCP Proxy may override any IPM Controller DHCP-obtained settings at any time. The format and usage for DHCPv4 options shall be as defined in the RFC that specifies the option. A DHCP Client, whether acting on its own behalf or as a DHCP Proxy, shall follow all IP address lease rules as specified by RFC 2131 and subsequent applicable RFCs. A DHCP Proxy that needs to cause an IPM Controller to stop using its current IP address shall send the IPM Controller a Set LAN Configuration Parameters command with the IP address parameter set to Standard DHCPv4 options 62 Some standard DHCPv4 options that can be useful to IPM Controllers are listed in Table 2-3 Useful IPM Controller DHCPv4 options below. Table 2-3 Useful IPM Controller DHCPv4 options Parameter Number Where Defined Boot File name 67 RFC 2132 Client Identifier 61 RFC 4361 Default gateway address list 3 RFC 2132 DNS Server address list 6 RFC 2132 Domain name 15 RFC 2132 PICMG HPM.3 R1.0, DHCP-Assigned Platform Management Parameters, November 22,

22 Host name 12 RFC 2132 Log server 7 RFC 2132 Subnet mask 1 RFC 2132 TFTP server address 150 RFC 5859 Timeserver addresses 4 RFC 2132 Vendor Class Identifier 60 RFC 3925 Vendor-Specific Information 43 RFC 3925 Requirements REQ 2.24 REQ 2.25 REQ 2.26 Shelf Managers and IPM Controllers may implement any standard DHCP parameters (including those listed in Table 2-3 Useful IPM Controller DHCPv4 options) applicable to its operation. These parameters are specified in the IANA Dynamic Host Configuration Protocol (DHCP) and Bootstrap Protocol (BOOTP) Parameters registry. An IPM Controller may use any DHCP mechanism to obtain standard DHCP information. If an IPM Controller receives its IP address from a DHCP Proxy, it should use the mechanism described in section 2.7 to obtain other DHCP parameters. 2.5 HPM.3 DHCP Client ID 63 The format of the HPM.3 Client ID is shown in Table 2-4 HPM.3 DHCP Client ID. Table 2-4 HPM.3 DHCP Client ID Field Length Format Content Header 1 Binary 61 (3Dh) Data Length 1 Binary Length of remaining content (44, 2Ch) Type 1 Binary 255 (FFh) IAID 4 Binary DUID 39 Binary IPMI LAN Channel Index with range 0 through Ah and all other values reserved; see section DHCP Unique Identifier. See Table 2-5 HPM.3 DHCP Unique Identifier (DUID) 16 PICMG HPM.3 R1.0, DHCP-Assigned Platform Management Parameters, November 22, 2012

23 64 The format of the DUID (DHCP Unique Identifier) is shown in Table 2-5 HPM.3 DHCP Unique Identifier (DUID). Requirements in the applicable RFCs (primarily RFC 4361) for DUIDs must be respected in HPM.3 DUIDs. Table 2-5 HPM.3 DHCP Unique Identifier (DUID) Field Length Format Content DUID format 2 Binary DUID-EN identifier (2) DUID header part 1 4 Binary PICMG IANA ID (12634, 315Ah) DUID header part 2 5 ASCII Text HPM.3 identifier (48504D2E33h) DUID header part 3 2 ASCII HPM.3 DUID version ( -1, 2D31h) Shelf address type/length 1 Binary Shelf address 20 Binary Shelf Address Type/Length Byte field from the Shelf FRU Information (AdvancedTCA Address Table or MicroTCA Shelf Information record) Shelf Address field from the Shelf FRU Information (AdvancedTCA Address Table or MicroTCA Shelf Information record) Shelf type 1 Binary See section Slot location 4 Binary See section for ATCA Shelves and section for MicroTCA Shelves 65 The content of an xtca Shelf Address (with its corresponding Shelf Address Type/Length Byte) is typically specified when a Shelf is provisioned or re-provisioned. A non-null default value can be specified by the Shelf vendor. The Shelf address and Shelf address type/length fields in the DUID are taken directly from the Shelf FRU Information without change. Unused bytes of this field (bytes beyond the Shelf address length) are filled with zeros. 66 Correct operation of DHCP requires that Client IDs be unique within their network segment (to avoid assigning the same IP address to distinct entities in the same segment). When the Shelf type field and Slot location record are populated according to this specification, the combination is unique within a Shelf. Overall uniqueness of an HPM.3 DUID is primarily determined by the Shelf address and Shelf address type/length fields. If these fields are configured with geographic data (for instance, identifying the floor, row, rack and rack position of a Shelf), sufficient uniqueness to allow correct DHCP operation must be ensured. Alternatively, these fields can be configured with data that identifies a specific Shelf instance, such as product identifier and serial number. In this latter case, only the Board or Module location within such a Shelf is geographically identified, but global uniqueness is assured. 67 When deploying Shelves using HPM.3 mechanisms for network address or parameter assignment, care must be taken to provision the Shelf FRU Information Shelf Address and Shelf Address Type/Length Byte fields PICMG HPM.3 R1.0, DHCP-Assigned Platform Management Parameters, November 22,

24 with appropriately unique values in order to ensure that HPM.3 mechanisms produce a unique DUID within the network segment. 68 It is desirable to log the Client ID used in an HPM.3 DHCP request, with other DHCP information, in the IPM Controller that issues the DHCP request for troubleshooting purposes. Requirements REQ 2.27 When an IPM Controller requests LAN Configuration Parameters from DHCP (see section 2.5), it shall use its Client ID as specified in Table 2-4, and not an Ethernet MAC address. REQ 2.28 The IPM Controller s Client ID shall be formatted in accordance with the requirements of RFC 4361, using DHCP code 61, except as otherwise specifically required in this specification. REQ 2.29 REQ 2.30 REQ 2.31 REQ 2.32 All fields shall be sent in network byte order. The DUID shall have the format shown in Table 2-5 HPM.3 DHCP Unique Identifier (DUID). The format is a DUID-EN, as described in RFC 3315 section 9.3. The Shelf address and Shelf address type/length fields shall be formatted as specified for the corresponding Shelf FRU Information fields in PICMG 3.0 or MTCA.0, for AdvancedTCA and MicroTCA Shelves, respectively. Unused bytes in the Shelf address field shall be filled with zeros IPMI LAN Channel Index assignment 69 The IPMI LAN Channel Index identifies the IPMI Channel being configured. This four byte field must be an integer in the range of 00h to 0Ah that uniquely identifies one of the IPMI LAN Channels that are implemented on an IPM Controller. IPMI Channel numbers are in the range 0 through Fh, but only numbers 1 to Bh can be used for IPMI LAN Channels. (See IPMI 2.0 section 6.3 for background on IPMI Channel numbers.) The mapping from IPMI LAN Channel Index values to IPMI Channel numbers is defined by the IPM Controller, but this specification provides recommendations on that mapping in order to maximize consistency between vendors. 70 The following tables provide recommended IPMI LAN Channel Index values for ATCA Front Boards, ATCA dedicated Shelf Managers, AMC Modules and MCH Modules. Some of these tables refer to sets of xtca-defined interfaces, such as the set of Base Interface Channels or the set of Fabric Interface Channels. For such sets, a reference to the first member of the set refers to the lowest numbered member of the set, as defined by the relevant specification. 71 To make it possible for a DHCP Proxy to create the Client ID for a specific LAN channel of a specific IPM Controller, the value of the IPMI LAN Channel Index is exposed as a read-only LAN configuration parameter for the corresponding channel. Table 2-6 Recommended IPMI LAN Channel Index values for ATCA Front Boards Value Usage 0 The corresponding IPMI LAN Channel has connectivity to the first Base Interface Channel supported by the Front Board. It might also have connectivity to additional interfaces. 18 PICMG HPM.3 R1.0, DHCP-Assigned Platform Management Parameters, November 22, 2012