go-redfish/client

Go API client for client

Partial Redfish OAPI specification for a limited client

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 0.0.1
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sw "./client"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identifield by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost

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

Documentation For Models

• Boot
• BootSource
• BootSourceOverrideEnabled
• Collection
• ComputerSystem
• ComputerSystemActions
• ComputerSystemReset
• ConnectedVia
• CreateVirtualDiskRequestBody
• FirmwareInventory
• Health
• IdRef
• IndicatorLED
• InlineObject
• InsertMediaRequestBody
• Manager
• ManagerLinks
• ManagerType
• MemorySummary
• Message
• Payload
• PowerState
• ProcessorSummary
• RedfishError
• RedfishErrorError
• ResetRequestBody
• ResetType
• Root
• SimpleUpdateRequestBody
• SoftwareInventory
• State
• Status
• SystemLinks
• Task
• TaskState
• TransferMethod
• TransferProtocolType
• UpdateService
• UpdateServiceActions
• VirtualMedia
• VirtualMediaActions
• VirtualMediaActionsVirtualMediaEjectMedia
• VolumeType

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author