airship/go-redfish
Code Issues Proposed changes
go-redfish/client/docs/DefaultApi.md
Manoj 924b41cc22 Support for Additional Redfish APIs 
Added support for the following APIs

FirmwareInventoryDownloadImage
FirmwareInventory
GetTask
UpdateService
UpdateServiceSimpleUpdate

RAID Creation Support

Also updated Makefile to add an additional  docker based target
to assist in code generation.

Change-Id: I716153fe254c7fefc6893ac76e4fa190a24029a8
2020-04-24 18:08:47 +00:00

16 KiB
Raw Blame History

\DefaultApi

All URIs are relative to http://localhost

Method HTTP request Description
CreateVirtualDisk Post /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageControllerId}/Volumes
DeleteVirtualdisk Delete /redfish/v1/Systems/{ComputerSystemId}/Storage/Volumes/{StorageId}
EjectVirtualMedia Post /redfish/v1/Managers/{managerId}/VirtualMedia/{virtualMediaId}/Actions/VirtualMedia.EjectMedia
FirmwareInventory Get /redfish/v1/UpdateService/FirmwareInventory
FirmwareInventoryDownloadImage Post /redfish/v1/UpdateService/FirmwareInventory
GetManager Get /redfish/v1/Managers/{managerId}
GetManagerVirtualMedia Get /redfish/v1/Managers/{managerId}/VirtualMedia/{virtualMediaId}
GetRoot Get /redfish/v1
GetSystem Get /redfish/v1/Systems/{systemId}
GetTask Get /redfish/v1/TaskService/Tasks/{taskId}
GetVolumes Get /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageControllerId}/Volumes
InsertVirtualMedia Post /redfish/v1/Managers/{managerId}/VirtualMedia/{virtualMediaId}/Actions/VirtualMedia.InsertMedia
ListManagerVirtualMedia Get /redfish/v1/Managers/{managerId}/VirtualMedia
ListManagers Get /redfish/v1/Managers
ListSystems Get /redfish/v1/Systems
ResetSystem Post /redfish/v1/Systems/{ComputerSystemId}/Actions/ComputerSystem.Reset
SetSystem Patch /redfish/v1/Systems/{systemId}
UpdateService Get /redfish/v1/UpdateService
UpdateServiceSimpleUpdate Post /redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate

CreateVirtualDisk

RedfishError CreateVirtualDisk(ctx, computerSystemId, storageControllerId, createVirtualDiskRequestBody)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
computerSystemId string System ID
storageControllerId string Storage Controller ID
createVirtualDiskRequestBody CreateVirtualDiskRequestBody

Return type

RedfishError

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteVirtualdisk

DeleteVirtualdisk(ctx, computerSystemId, storageId)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
computerSystemId string System ID
storageId string Storage ID

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EjectVirtualMedia

RedfishError EjectVirtualMedia(ctx, managerId, virtualMediaId, body)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
managerId string ID of resource
virtualMediaId string ID of resource
body map[string]interface{}

Return type

RedfishError

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FirmwareInventory

Collection FirmwareInventory(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

Collection

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FirmwareInventoryDownloadImage

RedfishError FirmwareInventoryDownloadImage(ctx, optional)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *FirmwareInventoryDownloadImageOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a FirmwareInventoryDownloadImageOpts struct

Name Type Description Notes
softwareImage *optional.Interface of os.File***optional.os.File

Return type

RedfishError

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/formdata
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetManager

Manager GetManager(ctx, managerId)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
managerId string ID of resource

Return type

Manager

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetManagerVirtualMedia

VirtualMedia GetManagerVirtualMedia(ctx, managerId, virtualMediaId)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
managerId string ID of resource
virtualMediaId string ID of resource

Return type

VirtualMedia

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRoot

Root GetRoot(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

Root

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSystem

ComputerSystem GetSystem(ctx, systemId)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
systemId string ID of resource

Return type

ComputerSystem

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTask

Task GetTask(ctx, taskId)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
taskId string Task ID

Return type

Task

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetVolumes

Collection GetVolumes(ctx, computerSystemId, storageControllerId)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
computerSystemId string System ID
storageControllerId string Storage Controller ID

Return type

Collection

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

InsertVirtualMedia

RedfishError InsertVirtualMedia(ctx, managerId, virtualMediaId, insertMediaRequestBody)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
managerId string ID of resource
virtualMediaId string ID of resource
insertMediaRequestBody InsertMediaRequestBody

Return type

RedfishError

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListManagerVirtualMedia

Collection ListManagerVirtualMedia(ctx, managerId)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
managerId string ID of resource

Return type

Collection

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListManagers

Collection ListManagers(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

Collection

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListSystems

Collection ListSystems(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

Collection

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ResetSystem

RedfishError ResetSystem(ctx, computerSystemId, resetRequestBody)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
computerSystemId string
resetRequestBody ResetRequestBody

Return type

RedfishError

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetSystem

ComputerSystem SetSystem(ctx, systemId, computerSystem)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
systemId string ID of resource
computerSystem ComputerSystem

Return type

ComputerSystem

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateService

UpdateService UpdateService(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

UpdateService

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateServiceSimpleUpdate

RedfishError UpdateServiceSimpleUpdate(ctx, simpleUpdateRequestBody)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
simpleUpdateRequestBody SimpleUpdateRequestBody

Return type

RedfishError

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]