diff --git a/docs/api-reference/api.md b/docs/api-reference/api.md index 702177f..1c84105 100644 --- a/docs/api-reference/api.md +++ b/docs/api-reference/api.md @@ -10,35 +10,6 @@ Resource Types:
-(Appears on:BMCSpec) -
-Access defines inline network access configuration for the BMC.
-Field | -Description | -
---|---|
-address - -string - - |
-
- Address is the IP or hostname used for accessing the BMC. - |
-
@@ -138,14 +109,14 @@ This reference is typically used to locate the BMC endpoint within the cluster.<
access
Access allows inline configuration of network access details for the BMC. +
Endpoint allows inline configuration of network access details for the BMC. Use this field if access settings like address are to be configured directly within the BMC resource.
access
Access allows inline configuration of network access details for the BMC. +
Endpoint allows inline configuration of network access details for the BMC. Use this field if access settings like address are to be configured directly within the BMC resource.
-(Appears on:BMCStatus, EndpointSpec, NetworkInterface) +(Appears on:BMCStatus, EndpointSpec, InlineEndpoint, NetworkInterface)
IP is an IP address.
@@ -984,6 +955,48 @@ determined. ++(Appears on:BMCSpec) +
+InlineEndpoint defines inline network access configuration for the BMC.
+Field | +Description | +
---|---|
+macAddress + +string + + |
+
+ MACAddress is the MAC address of the endpoint. + |
+
+ip + + +IP + + + |
+
+ IP is the IP address of the BMC. + |
+