From a2edca0ffbce33d1e20a199990c8292faeea49bb Mon Sep 17 00:00:00 2001 From: Andreas Fritzler Date: Wed, 30 Oct 2024 14:59:35 +0100 Subject: [PATCH] Update API reference docs (#157) --- docs/api-reference/api.md | 85 ++++++++++++++++++++++----------------- 1 file changed, 49 insertions(+), 36 deletions(-) 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: -

Access -

-

-(Appears on:BMCSpec) -

-
-

Access defines inline network access configuration for the BMC.

-
- - - - - - - - - - - - - -
FieldDescription
-address
- -string - -		 -

Address is the IP or hostname used for accessing the BMC.

-

BIOSSettings

@@ -138,14 +109,14 @@ This reference is typically used to locate the BMC endpoint within the cluster.< access
- -Access + +InlineEndpoint (Optional) -

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.

@@ -427,14 +398,14 @@ This reference is typically used to locate the BMC endpoint within the cluster.< access
- -Access + +InlineEndpoint (Optional) -

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.

@@ -900,7 +871,7 @@ IP

IP

-(Appears on:BMCStatus, EndpointSpec, NetworkInterface) +(Appears on:BMCStatus, EndpointSpec, InlineEndpoint, NetworkInterface)

IP is an IP address.

@@ -984,6 +955,48 @@ determined.

+

InlineEndpoint +

+

+(Appears on:BMCSpec) +

+
+

InlineEndpoint defines inline network access configuration for the BMC.

+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+macAddress
+ +string + +		 +

MACAddress is the MAC address of the endpoint.

+
+ip
+ + +IP + + +		 +

IP is the IP address of the BMC.

+

NetworkInterface