179 lines
7.8 KiB
Markdown
179 lines
7.8 KiB
Markdown
# Go API client for client
|
|
|
|
Partial Redfish OAPI specification for a limited client
|
|
|
|
## Overview
|
|
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) 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:
|
|
|
|
```shell
|
|
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:
|
|
|
|
```golang
|
|
import sw "./client"
|
|
```
|
|
|
|
To use a proxy, set the environment variable `HTTP_PROXY`:
|
|
|
|
```golang
|
|
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`.
|
|
|
|
```golang
|
|
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`.
|
|
|
|
```golang
|
|
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**](docs/DefaultApi.md#createvirtualdisk) | **Post** /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageControllerId}/Volumes |
|
|
*DefaultApi* | [**DeleteVirtualdisk**](docs/DefaultApi.md#deletevirtualdisk) | **Delete** /redfish/v1/Systems/{ComputerSystemId}/Storage/Volumes/{StorageId} |
|
|
*DefaultApi* | [**EjectVirtualMedia**](docs/DefaultApi.md#ejectvirtualmedia) | **Post** /redfish/v1/Managers/{managerId}/VirtualMedia/{virtualMediaId}/Actions/VirtualMedia.EjectMedia |
|
|
*DefaultApi* | [**FirmwareInventory**](docs/DefaultApi.md#firmwareinventory) | **Get** /redfish/v1/UpdateService/FirmwareInventory |
|
|
*DefaultApi* | [**FirmwareInventoryDownloadImage**](docs/DefaultApi.md#firmwareinventorydownloadimage) | **Post** /redfish/v1/UpdateService/FirmwareInventory |
|
|
*DefaultApi* | [**GetManager**](docs/DefaultApi.md#getmanager) | **Get** /redfish/v1/Managers/{managerId} |
|
|
*DefaultApi* | [**GetManagerVirtualMedia**](docs/DefaultApi.md#getmanagervirtualmedia) | **Get** /redfish/v1/Managers/{managerId}/VirtualMedia/{virtualMediaId} |
|
|
*DefaultApi* | [**GetRoot**](docs/DefaultApi.md#getroot) | **Get** /redfish/v1 |
|
|
*DefaultApi* | [**GetSoftwareInventory**](docs/DefaultApi.md#getsoftwareinventory) | **Get** /redfish/v1/UpdateService/FirmwareInventory/{softwareId} |
|
|
*DefaultApi* | [**GetSystem**](docs/DefaultApi.md#getsystem) | **Get** /redfish/v1/Systems/{systemId} |
|
|
*DefaultApi* | [**GetTask**](docs/DefaultApi.md#gettask) | **Get** /redfish/v1/TaskService/Tasks/{taskId} |
|
|
*DefaultApi* | [**GetTaskList**](docs/DefaultApi.md#gettasklist) | **Get** /redfish/v1/TaskService/Tasks |
|
|
*DefaultApi* | [**GetVolumes**](docs/DefaultApi.md#getvolumes) | **Get** /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageControllerId}/Volumes |
|
|
*DefaultApi* | [**InsertVirtualMedia**](docs/DefaultApi.md#insertvirtualmedia) | **Post** /redfish/v1/Managers/{managerId}/VirtualMedia/{virtualMediaId}/Actions/VirtualMedia.InsertMedia |
|
|
*DefaultApi* | [**ListManagerVirtualMedia**](docs/DefaultApi.md#listmanagervirtualmedia) | **Get** /redfish/v1/Managers/{managerId}/VirtualMedia |
|
|
*DefaultApi* | [**ListManagers**](docs/DefaultApi.md#listmanagers) | **Get** /redfish/v1/Managers |
|
|
*DefaultApi* | [**ListSystems**](docs/DefaultApi.md#listsystems) | **Get** /redfish/v1/Systems |
|
|
*DefaultApi* | [**ResetIdrac**](docs/DefaultApi.md#resetidrac) | **Post** /redfish/v1/Managers/iDRAC.Embedded.1/Actions/Manager.Reset |
|
|
*DefaultApi* | [**ResetSystem**](docs/DefaultApi.md#resetsystem) | **Post** /redfish/v1/Systems/{ComputerSystemId}/Actions/ComputerSystem.Reset |
|
|
*DefaultApi* | [**SetSystem**](docs/DefaultApi.md#setsystem) | **Patch** /redfish/v1/Systems/{systemId} |
|
|
*DefaultApi* | [**UpdateService**](docs/DefaultApi.md#updateservice) | **Get** /redfish/v1/UpdateService |
|
|
*DefaultApi* | [**UpdateServiceSimpleUpdate**](docs/DefaultApi.md#updateservicesimpleupdate) | **Post** /redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate |
|
|
|
|
|
|
## Documentation For Models
|
|
|
|
- [Boot](docs/Boot.md)
|
|
- [BootSource](docs/BootSource.md)
|
|
- [BootSourceOverrideEnabled](docs/BootSourceOverrideEnabled.md)
|
|
- [Collection](docs/Collection.md)
|
|
- [ComputerSystem](docs/ComputerSystem.md)
|
|
- [ComputerSystemActions](docs/ComputerSystemActions.md)
|
|
- [ComputerSystemReset](docs/ComputerSystemReset.md)
|
|
- [ConnectedVia](docs/ConnectedVia.md)
|
|
- [CreateVirtualDiskRequestBody](docs/CreateVirtualDiskRequestBody.md)
|
|
- [FirmwareInventory](docs/FirmwareInventory.md)
|
|
- [Health](docs/Health.md)
|
|
- [IDRACResetRequestBody](docs/IDRACResetRequestBody.md)
|
|
- [IDRACResetType](docs/IDRACResetType.md)
|
|
- [IdRef](docs/IdRef.md)
|
|
- [IndicatorLED](docs/IndicatorLED.md)
|
|
- [InlineObject](docs/InlineObject.md)
|
|
- [InsertMediaRequestBody](docs/InsertMediaRequestBody.md)
|
|
- [Manager](docs/Manager.md)
|
|
- [ManagerLinks](docs/ManagerLinks.md)
|
|
- [ManagerType](docs/ManagerType.md)
|
|
- [MemorySummary](docs/MemorySummary.md)
|
|
- [Message](docs/Message.md)
|
|
- [Payload](docs/Payload.md)
|
|
- [PowerState](docs/PowerState.md)
|
|
- [ProcessorSummary](docs/ProcessorSummary.md)
|
|
- [RedfishError](docs/RedfishError.md)
|
|
- [RedfishErrorError](docs/RedfishErrorError.md)
|
|
- [ResetRequestBody](docs/ResetRequestBody.md)
|
|
- [ResetType](docs/ResetType.md)
|
|
- [Root](docs/Root.md)
|
|
- [SimpleUpdateRequestBody](docs/SimpleUpdateRequestBody.md)
|
|
- [SoftwareInventory](docs/SoftwareInventory.md)
|
|
- [State](docs/State.md)
|
|
- [Status](docs/Status.md)
|
|
- [SystemLinks](docs/SystemLinks.md)
|
|
- [Task](docs/Task.md)
|
|
- [TaskState](docs/TaskState.md)
|
|
- [TransferMethod](docs/TransferMethod.md)
|
|
- [TransferProtocolType](docs/TransferProtocolType.md)
|
|
- [UpdateService](docs/UpdateService.md)
|
|
- [UpdateServiceActions](docs/UpdateServiceActions.md)
|
|
- [VirtualMedia](docs/VirtualMedia.md)
|
|
- [VirtualMediaActions](docs/VirtualMediaActions.md)
|
|
- [VirtualMediaActionsVirtualMediaEjectMedia](docs/VirtualMediaActionsVirtualMediaEjectMedia.md)
|
|
- [VolumeType](docs/VolumeType.md)
|
|
|
|
|
|
## 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
|
|
|
|
|
|
|