Go API client for sdk

MetalSoft REST API documentation

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: 2.0
Package version: 7.0.0
Generator version: 7.10.0
Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://www.metalsoft.io/contact

Installation

Install the following dependencies:

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

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

import sdk "github.com/metalsoft-io/metalcloud-sdk-go"

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 sdk.ContextServerIndex of type int.

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

Templated Server URL

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

ctx := context.WithValue(context.Background(), sdk.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 identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sdk.ContextOperationServerIndices and sdk.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sdk.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sdk.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
AIAPI	GenerateEliResponse	Post /api/v2/ai/generate	Request from AI a response for the given input
AccountAPI	ArchiveAccount	Post /api/v2/accounts/{accountId}/actions/archive	Archive account
AccountAPI	CreateAccount	Post /api/v2/accounts	Create account
AccountAPI	GetAccount	Get /api/v2/accounts/{accountId}	Get account by id
AccountAPI	GetAccountLimits	Get /api/v2/accounts/{accountId}/limits	Get account limits
AccountAPI	GetAccountUsers	Get /api/v2/accounts/{accountId}/users	Get users for account
AccountAPI	GetAccounts	Get /api/v2/accounts	Get all accounts
AccountAPI	UnarchiveAccount	Post /api/v2/accounts/{accountId}/actions/unarchive	Unarchive account
AccountAPI	UpdateAccount	Patch /api/v2/accounts/{accountId}	Update account
AccountAPI	UpdateAccountLimits	Patch /api/v2/accounts/{accountId}/limits	Update account limits
AuthenticationAPI	Login	Post /api/v2/login	User login
AuthenticationAPI	Logout	Post /api/v2/logout	Logout user
BucketAPI	CreateInfrastructureBucket	Post /api/v2/infrastructures/{infrastructureId}/buckets	Creates a Bucket
BucketAPI	DeleteBucket	Delete /api/v2/infrastructures/{infrastructureId}/buckets/{bucketId}	Deletes a Bucket
BucketAPI	GetBucket	Get /api/v2/buckets/{bucketId}	Get Bucket information
BucketAPI	GetBucketCredentials	Get /api/v2/infrastructures/{infrastructureId}/buckets/{bucketId}/credentials	Get Bucket credentials
BucketAPI	GetInfrastructureBucket	Get /api/v2/infrastructures/{infrastructureId}/buckets/{bucketId}	Get Bucket information
BucketAPI	GetInfrastructureBuckets	Get /api/v2/infrastructures/{infrastructureId}/buckets	Get all Buckets
BucketAPI	UpdateBucket	Patch /api/v2/infrastructures/{infrastructureId}/buckets/{bucketId}/config	Updates Bucket information
ConfigurationAPI	GetConfiguration	Get /api/v2/config	Get configuration
ConfigurationAPI	PatchConfiguration	Patch /api/v2/config/{filter}	Partially update configuration
ConfigurationAPI	PutConfiguration	Put /api/v2/config/{filter}	Update configuration
DriveAPI	GetDrive	Get /api/v2/drives/{driveId}	Get Drive information
DriveAPI	GetInfrastructureDrive	Get /api/v2/infrastructures/{infrastructureId}/drives/{driveId}	Get Drive information
DriveAPI	GetInfrastructureDrives	Get /api/v2/infrastructures/{infrastructureId}/drives	Get all Drives on the infrastructure
DriveGroupAPI	GetInfrastructureDriveGroup	Get /api/v2/infrastructures/{infrastructureId}/drive-groups/{driveGroupId}	Get DriveGroup information
DriveGroupAPI	GetInfrastructureDriveGroups	Get /api/v2/infrastructures/{infrastructureId}/drive-groups	Get all Drive Groups on the infrastructure
ExtensionAPI	ArchiveExtension	Post /api/v2/extensions/{extensionId}/actions/archive	Archive published extension
ExtensionAPI	CreateExtension	Post /api/v2/extensions	Create extension
ExtensionAPI	GetExtension	Get /api/v2/extensions/{extensionId}	Get details for an extension
ExtensionAPI	GetExtensions	Get /api/v2/extensions	Get a list of available extensions
ExtensionAPI	PublishExtension	Post /api/v2/extensions/{extensionId}/actions/publish	Publish draft extension
ExtensionAPI	UpdateExtension	Patch /api/v2/extensions/{extensionId}	Update extension
ExtensionInstanceAPI	CreateExtensionInstance	Post /api/v2/infrastructures/{infrastructureId}/extension-instances	Add extension instance to an infrastructure
ExtensionInstanceAPI	DeleteExtensionInstance	Delete /api/v2/extension-instances/{extensionInstanceId}	Delete extension instance
ExtensionInstanceAPI	GetExtensionInstance	Get /api/v2/extension-instances/{extensionInstanceId}	Get extension instance details
ExtensionInstanceAPI	GetExtensionInstances	Get /api/v2/extension-instances	Get extension instances list
ExtensionInstanceAPI	UpdateExtensionInstance	Patch /api/v2/extension-instances/{extensionInstanceId}	Update extension instance configuration
FileShareAPI	CreateInfrastructureFileShare	Post /api/v2/infrastructures/{infrastructureId}/file-shares	Creates a File Share
FileShareAPI	DeleteFileShare	Delete /api/v2/infrastructures/{infrastructureId}/file-shares/{fileShareId}	Deletes a File Share
FileShareAPI	GetFileShare	Get /api/v2/file-shares/{fileShareId}	Get File Share information
FileShareAPI	GetFileShareHosts	Get /api/v2/infrastructures/{infrastructureId}/file-shares/{fileShareId}/hosts	Get the Hosts of File Share
FileShareAPI	GetInfrastructureFileShare	Get /api/v2/infrastructures/{infrastructureId}/file-shares/{fileShareId}	Get File Share information
FileShareAPI	GetInfrastructureFileShares	Get /api/v2/infrastructures/{infrastructureId}/file-shares	Get all File Shares
FileShareAPI	UpdateFileShare	Patch /api/v2/infrastructures/{infrastructureId}/file-shares/{fileShareId}	Updates File Share information
FileShareAPI	UpdateFileShareInstanceArrayHostsBulk	Post /api/v2/infrastructures/{infrastructureId}/file-shares/{fileShareId}/actions/modify-instance-array-hosts-bulk	Updates Instance Array Hosts on the File Share
FirmwareBaselineAPI	CreateFirmwareBaseline	Post /api/v2/firmware/baseline	Create a new firmware baseline
FirmwareBaselineAPI	DeleteFirmwareBaseline	Delete /api/v2/firmware/baseline/{firmwareBaselineId}	Delete Firmware Baseline
FirmwareBaselineAPI	GetFirmwareBaseline	Get /api/v2/firmware/baseline/{firmwareBaselineId}	Get Firmware Baseline
FirmwareBaselineAPI	GetFirmwareBaselines	Get /api/v2/firmware/baseline	Get Firmware Baselines
FirmwareBaselineAPI	UpdateFirmwareBaseline	Put /api/v2/firmware/baseline/{firmwareBaselineId}	Update Firmware Baseline
FirmwareBaselineSearchAPI	SearchFirmwareBaselines	Post /api/v2/firmware/search/baseline	Search Firmware Baselines
FirmwareBinaryAPI	CreateFirmwareBinary	Post /api/v2/firmware/binary	Create a new firmware binary
FirmwareBinaryAPI	DeleteFirmwareBinary	Delete /api/v2/firmware/binary/{firmwareBinaryId}	Delete Firmware Binary
FirmwareBinaryAPI	GetFirmwareBinaries	Get /api/v2/firmware/binary	Get Firmware Binaries
FirmwareBinaryAPI	GetFirmwareBinary	Get /api/v2/firmware/binary/{firmwareBinaryId}	Get Firmware Binary
FirmwareBinaryAPI	UpdateFirmwareBinary	Put /api/v2/firmware/binary/{firmwareBinaryId}	Update Firmware Binary
FirmwareCatalogAPI	CreateFirmwareCatalogs	Post /api/v2/firmware/catalog	Create Firmware Catalog
FirmwareCatalogAPI	DeleteFirmwareCatalog	Delete /api/v2/firmware/catalog/{firmwareCatalogId}	Delete Firmware Catalog
FirmwareCatalogAPI	GetFirmwareCatalog	Get /api/v2/firmware/catalog/{firmwareCatalogId}	Get Firmware Catalog
FirmwareCatalogAPI	GetFirmwareCatalogs	Get /api/v2/firmware/catalog	Get Firmware Catalogs
FirmwareCatalogAPI	UpdateFirmwareCatalog	Put /api/v2/firmware/catalog/{firmwareCatalogId}	Update Firmware Catalog
FirmwarePolicyAPI	ApplyFirmwarePoliciesWithInstanceArrays	Post /api/v2/firmware/policies/actions/apply-with-instance-arrays	Applies all Firmware Policies linked to instance arrays
FirmwarePolicyAPI	ApplyFirmwarePoliciesWithoutInstanceArrays	Post /api/v2/firmware/policies/actions/apply-without-instance-arrays	Applies all Firmware Policies not linked to instance arrays
FirmwarePolicyAPI	CreateFirmwarePolicy	Post /api/v2/firmware/policies	Creates a Firmware Policy
FirmwarePolicyAPI	DeleteFirmwarePolicy	Delete /api/v2/firmware/policies/{firmwarePolicyId}	Deletes a Firmware Policy
FirmwarePolicyAPI	GenerateFirmwarePolicyAudit	Post /api/v2/firmware/policies/{firmwarePolicyId}/actions/generate-audit	Returns the server components ids that match this policy
FirmwarePolicyAPI	GetFirmwarePolicies	Get /api/v2/firmware/policies	Get a list of Firmware Policies
FirmwarePolicyAPI	GetFirmwarePolicyInfo	Get /api/v2/firmware/policies/{firmwarePolicyId}	Get Firmware Policy information
FirmwarePolicyAPI	GetGlobalFirmwareConfiguration	Get /api/v2/firmware/configuration	Get Global Firmware Configuration
FirmwarePolicyAPI	UpdateFirmwarePolicy	Patch /api/v2/firmware/policies/{firmwarePolicyId}	Updates a Firmware Policy
FirmwarePolicyAPI	UpdateGlobalFirmwareConfiguration	Patch /api/v2/firmware/configuration	Updates Global Firmware Policy Configuration
InfrastructureAPI	CreateInfrastructure	Post /api/v2/infrastructures	Creates a new infrastructure
InfrastructureAPI	DeployInfrastructure	Post /api/v2/infrastructures/{infrastructureId}/actions/deploy	Deploys the specified infrastructure
InfrastructureAPI	GetInfrastructure	Get /api/v2/infrastructures/{infrastructureId}	Retrieves the specified infrastructure
InfrastructureAPI	GetInfrastructures	Get /api/v2/infrastructures	Get all infrastructures
InfrastructureAPI	RevertInfrastructure	Post /api/v2/infrastructures/{infrastructureId}/actions/revert	Reverts the specified infrastructure
JobAPI	GetJob	Get /api/v2/jobs/{jobId}	Get Job information
JobAPI	GetJobExceptions	Get /api/v2/jobs/{jobId}/exceptions	Get a list of Job Exceptions
JobAPI	GetJobFromArchive	Get /api/v2/jobs/archive/{jobId}	Get Job from archive information
JobAPI	GetJobGroup	Get /api/v2/job-groups/{jobGroupId}	Get Job Group information
JobAPI	GetJobGroupStatistics	Get /api/v2/job-groups/{jobGroupId}/statistics	Get Job Group statistics
JobAPI	GetJobGroups	Get /api/v2/job-groups	Get a list of Job Groups
JobAPI	GetJobs	Get /api/v2/jobs	Get a list of Jobs
JobAPI	GetJobsFromArchive	Get /api/v2/jobs/archive	Get a list of Jobs from archive
JobAPI	GetJobsStatistics	Get /api/v2/jobs/statistics	Get Jobs statistics
JobAPI	IssueCommandForJob	Post /api/v2/jobs/{jobId}/actions/issue-command	Issues a command for a job that changes the operational state of the job
JobAPI	RetryJob	Post /api/v2/jobs/{jobId}/actions/retry	Retries a job
JobAPI	SkipJob	Post /api/v2/jobs/{jobId}/actions/skip	Skips a job
NetworkAPI	CreateInfrastructureNetwork	Post /api/v2/infrastructures/{infrastructureId}/networks	Creates a new LAN network on the infrastructure
NetworkAPI	DeleteInfrastructureNetwork	Delete /api/v2/infrastructures/{infrastructureId}/networks/{networkId}	Deletes a network from the infrastructure
NetworkAPI	GetInfrastructureNetwork	Get /api/v2/infrastructures/{infrastructureId}/networks/{networkId}	Gets the specified network from the infrastructure
NetworkAPI	GetInfrastructureNetworks	Get /api/v2/infrastructures/{infrastructureId}/networks	Retrieves all networks on the infrastructure
NetworkDeviceAPI	AddNetworkDeviceDefaults	Post /api/v2/network-devices/defaults	Add network device defaults
NetworkDeviceAPI	ChangeNetworkDeviceStatus	Patch /api/v2/network-devices/{networkDeviceId}/actions/change-status	Change status of a network device
NetworkDeviceAPI	DiscoverNetworkDevice	Post /api/v2/network-devices/{networkDeviceId}/discover	Discover network device interfaces, hardware and software configuration
NetworkDeviceAPI	EnableNetworkDeviceSyslog	Post /api/v2/network-devices/{networkDeviceId}/actions/syslog-subscribe	Enables remote syslog for a network device
NetworkDeviceAPI	GetNetworkDevice	Get /api/v2/network-devices/{networkDeviceId}	Get Network Device
NetworkDeviceAPI	GetNetworkDeviceDefaults	Get /api/v2/network-devices/defaults/{datacenterName}	Get network device defaults for a datacenter
NetworkDeviceAPI	GetNetworkDevicePorts	Get /api/v2/network-devices/{networkDeviceId}/ports	Get all ports for network device
NetworkDeviceAPI	GetNetworkDevices	Get /api/v2/network-devices	Get paginated Network Devices
NetworkDeviceAPI	NetworkDeviceControllerAddTagsToNetworkDevice	Post /api/v2/network-devices/network-devices/{networkDeviceId}/tags	Add tags to Network Device
NetworkDeviceAPI	NetworkDeviceControllerCreateNetworkDevice	Post /api/v2/network-devices	Create Network Device
NetworkDeviceAPI	NetworkDeviceControllerDecommissionNetworkDevice	Delete /api/v2/network-devices/{networkDeviceId}/decommission	Decommission network device
NetworkDeviceAPI	NetworkDeviceControllerDeleteNetworkDevice	Delete /api/v2/network-devices/{networkDeviceId}	Delete Network Device
NetworkDeviceAPI	NetworkDeviceControllerGetIscsiBootServers	Get /api/v2/network-devices/{networkDeviceId}/iscsi-boot-servers	Returns information about servers which are setup to boot from iSCSI block devices. This is useful in the event of a switch device reboot
NetworkDeviceAPI	NetworkDeviceControllerGetNetworkDeviceStatistics	Get /api/v2/network-devices/statistics	Get Network Device Statistics
NetworkDeviceAPI	NetworkDeviceControllerGetTagsForNetworkDevice	Get /api/v2/network-devices/network-devices/{networkDeviceId}/tags	Get tags for Network Device
NetworkDeviceAPI	NetworkDeviceControllerRemoveTagsFromNetworkDevice	Patch /api/v2/network-devices/network-devices/{networkDeviceId}/tags	Clear tags from Network Device
NetworkDeviceAPI	NetworkDeviceControllerReplaceNetworkDevice	Post /api/v2/network-devices/{networkDeviceId}/replace	Replace network device
NetworkDeviceAPI	NetworkDeviceControllerUpdateNetworkDevice	Patch /api/v2/network-devices/{networkDeviceId}	Update Network Device
NetworkDeviceAPI	NetworkDeviceControllerUpdateTagsForNetworkDevice	Put /api/v2/network-devices/network-devices/{networkDeviceId}/tags	Update tags for Network Device
NetworkDeviceAPI	ReProvisionNetworkEquipment	Post /api/v2/network-devices/re-provision	Re-provision network equipment
NetworkDeviceAPI	RemoveNetworkDeviceDefaults	Delete /api/v2/network-devices/defaults	Remove network device defaults
NetworkDeviceAPI	ResetNetworkDevice	Post /api/v2/network-devices/{networkDeviceId}/actions/reset	Resets a network device to default state
NetworkDeviceAPI	SetNetworkDevicePortStatus	Post /api/v2/network-devices/{networkDeviceId}/actions/set-port-status	Set port status
NetworkFabricsAPI	CreateNetworkFabric	Post /api/v2/network-fabrics	Create a new network fabric
NetworkFabricsAPI	DeleteNetworkFabric	Delete /api/v2/network-fabrics/{networkFabricId}	Delete a network fabric
NetworkFabricsAPI	GetNetworkFabricById	Get /api/v2/network-fabrics/{networkFabricId}	Get a network fabric by ID
NetworkFabricsAPI	GetNetworkFabrics	Get /api/v2/network-fabrics	Get all network fabrics
NetworkFabricsAPI	UpdateNetworkFabric	Put /api/v2/network-fabrics/{networkFabricId}	Update a network fabric
OSTemplateAPI	CreateOSTemplate	Post /api/v2/os-templates	Create OS template
OSTemplateAPI	DeleteOSTemplate	Delete /api/v2/os-templates/{osTemplateId}	Delete OS template
OSTemplateAPI	GetOSTemplate	Get /api/v2/os-templates/{osTemplateId}	Get details for an OS template
OSTemplateAPI	GetOSTemplates	Get /api/v2/os-templates	Get a list of available OS templates
OSTemplateAPI	UpdateOSTemplate	Put /api/v2/os-templates/{osTemplateId}	Update OS template
ResourcePoolAPI	AddResourcePoolUser	Post /api/v2/resource-pools/user/{userId}/pool/{resourcePoolId}	Add a user to a Resource Pool
ResourcePoolAPI	AddServerToResourcePool	Put /api/v2/resource-pools/{resourcePoolId}/server/{serverId}	Add a server to a Resource Pool
ResourcePoolAPI	AddSubnetPoolToResourcePool	Put /api/v2/resource-pools/{resourcePoolId}/subnet-pool/{subnetPoolId}	Add a subnet pool to a resource pool
ResourcePoolAPI	CreateResourcePool	Post /api/v2/resource-pools	Creates a Resource Pool
ResourcePoolAPI	DeleteResourcePool	Delete /api/v2/resource-pools/{resourcePoolId}	Deletes a Resource Pool
ResourcePoolAPI	GetResourcePool	Get /api/v2/resource-pools/{resourcePoolId}	Get Resource Pool information
ResourcePoolAPI	GetResourcePoolServers	Get /api/v2/resource-pools/{resourcePoolId}/servers	Get all servers that are part of a Resource Pool
ResourcePoolAPI	GetResourcePoolSubnetPools	Get /api/v2/resource-pools/{resourcePoolId}/subnet-pools	Get all subnet pools that are part of a resource pool
ResourcePoolAPI	GetResourcePoolUsers	Get /api/v2/resource-pools/{resourcePoolId}/users	Get all users that have access to a Resource Pool
ResourcePoolAPI	GetResourcePools	Get /api/v2/resource-pools	Get all Resource Pools
ResourcePoolAPI	GetUserResourcePools	Get /api/v2/resource-pools/user/{userId}	Get all Resource Pools that a user has access to
ResourcePoolAPI	RemoveResourcePoolUser	Delete /api/v2/resource-pools/user/{userId}/pool/{resourcePoolId}	Remove a user from a Resource Pool
ResourcePoolAPI	RemoveServerFromResourcePool	Delete /api/v2/resource-pools/{resourcePoolId}/server/{serverId}	Remove a server from a Resource Pool
ResourcePoolAPI	RemoveSubnetPoolFromResourcePool	Delete /api/v2/resource-pools/{resourcePoolId}/subnet-pool/{subnetPoolId}	Remove a subnet from a resource pool
ResourcePoolAPI	UpdateResourcePool	Put /api/v2/resource-pools/{resourcePoolId}	Updates Resource Pool information
SecurityAPI	GetProviders	Get /api/v2/authentication/providers	Get available authentication providers
SecurityAPI	UpdateProvider	Patch /api/v2/authentication/providers/{name}	Updates authentication provider
ServerAPI	DecommissionServer	Post /api/v2/servers/{serverId}/actions/decommission	Decommissions a Server
ServerAPI	DeleteServer	Delete /api/v2/servers/{serverId}	Deletes a Server
ServerAPI	EnableServerSyslog	Post /api/v2/servers/{serverId}/actions/syslog-subscribe	Enables remote syslog for a server
ServerAPI	GetServerCapabilities	Get /api/v2/servers/{serverId}/capabilities	Get Server capabilities
ServerAPI	GetServerCredentials	Get /api/v2/servers/{serverId}/credentials	Get Server credentials
ServerAPI	GetServerInfo	Get /api/v2/servers/{serverId}	Get Server information
ServerAPI	GetServerPowerStatus	Post /api/v2/servers/{serverId}/actions/get-power	Gets the power state of a server
ServerAPI	GetServerRemoteConsoleInfo	Get /api/v2/servers/{serverId}/remote-console-info	Get Remote Console information
ServerAPI	GetServerVNCInfo	Get /api/v2/servers/{serverId}/vnc-info	Get VNC information
ServerAPI	GetServers	Get /api/v2/servers	Get a list of Servers
ServerAPI	GetServersStatistics	Get /api/v2/servers/statistics	Get Servers statistics
ServerAPI	ReRegisterServer	Post /api/v2/servers/{serverId}/actions/re-register	Re-register a server
ServerAPI	RegisterServer	Post /api/v2/servers	Initialize server registration
ServerAPI	ResetServerToFactoryDefaults	Post /api/v2/servers/{serverId}/actions/factory-reset	Resets a server to factory defaults
ServerAPI	SetServerPowerState	Post /api/v2/servers/{serverId}/actions/set-power	Sets the power state of a server
ServerAPI	UpdateServer	Patch /api/v2/servers/{serverId}	Updates the server information
ServerAPI	UpdateServerEnableSnmp	Post /api/v2/servers/{serverId}/actions/enable-snmp	Enables SNMP on a Server
ServerAPI	UpdateServerIpmiCredentials	Post /api/v2/servers/{serverId}/actions/update-ipmi-credentials	Update Server ipmi credentials
ServerCleanupPolicyAPI	CreateServerCleanupPolicy	Post /api/v2/servers/cleanup-policies	Creates a Server Cleanup Policy
ServerCleanupPolicyAPI	DeleteServerCleanupPolicy	Delete /api/v2/servers/cleanup-policies/{serverCleanupPolicyId}	Deletes a Server Cleanup Policy
ServerCleanupPolicyAPI	GetServerCleanupPolicies	Get /api/v2/servers/cleanup-policies	Get a list of Server Cleanup Policies
ServerCleanupPolicyAPI	GetServerCleanupPolicyInfo	Get /api/v2/servers/cleanup-policies/{serverCleanupPolicyId}	Get Server Cleanup Policy information
ServerCleanupPolicyAPI	UpdateServerCleanupPolicy	Patch /api/v2/servers/cleanup-policies/{serverCleanupPolicyId}	Updates a Server Cleanup Policy
ServerDefaultCredentialsAPI	CreateServerDefaultCredentials	Post /api/v2/servers/default-credentials	Creates a Server Default Credentials
ServerDefaultCredentialsAPI	DeleteServerDefaultCredentials	Delete /api/v2/servers/default-credentials/{serverDefaultCredentialsId}	Deletes a Server Default Credentials
ServerDefaultCredentialsAPI	GetServerDefaultCredentialsCredentials	Get /api/v2/servers/default-credentials/{serverDefaultCredentialsId}/credentials	Get Server Default Credentials unencrypted
ServerDefaultCredentialsAPI	GetServerDefaultCredentialsInfo	Get /api/v2/servers/default-credentials/{serverDefaultCredentialsId}	Get Server Default Credentials information
ServerDefaultCredentialsAPI	GetServersDefaultCredentials	Get /api/v2/servers/default-credentials	Get a list of Server Default Credentials
ServerDefaultCredentialsAPI	UpdateServerDefaultCredentials	Patch /api/v2/servers/default-credentials/{serverDefaultCredentialsId}	Updates a Server Default Credentials
ServerFirmwareAPI	FetchAndUpdateServerFirmwareAvailableVersions	Post /api/v2/servers/{serverId}/firmware/actions/fetch-and-update-available-versions	Fetches and updates the available firmware versions for the specified Server
ServerFirmwareAPI	GenerateServersFirmwareUpgradeAudit	Post /api/v2/servers/firmware/actions/generate-upgrade-audit	Generates a Firmware Upgrade Audit for the specified Servers
ServerFirmwareAPI	GetServerComponentInfo	Get /api/v2/servers/{serverId}/firmware/components/{componentId}	Get Server component information
ServerFirmwareAPI	GetServerComponents	Get /api/v2/servers/{serverId}/firmware/components	Get a list of Server Components
ServerFirmwareAPI	GetServerFirmwareInventory	Post /api/v2/servers/{serverId}/firmware/inventory	Retrieves server firmware inventory from redfish
ServerFirmwareAPI	ScheduleServerFirmwareUpgrade	Post /api/v2/servers/{serverId}/firmware/actions/schedule-upgrade	Schedules a firmware upgrade for the specified Server
ServerFirmwareAPI	UpdateServerComponent	Patch /api/v2/servers/{serverId}/firmware/components/{componentId}	Updates a Server Component
ServerFirmwareAPI	UpdateServerFirmwareInfo	Post /api/v2/servers/{serverId}/firmware/actions/update-info	Updates the firmware information of the Server Components
ServerFirmwareAPI	UpgradeFirmwareOfServer	Post /api/v2/servers/{serverId}/firmware/actions/upgrade	Upgrades the firmware of all updatable components on Server
ServerFirmwareAPI	UpgradeFirmwareOfServerComponent	Post /api/v2/servers/{serverId}/firmware/components/{serverComponentId}/actions/upgrade	Upgrades the firmware of the specified component on Server
ServerFirmwareAPI	UpgradeFirmwareOfServersBatch	Post /api/v2/servers/firmware/actions/batch-upgrade	Upgrades the firmware of all updatable components on the specified Servers
ServerInstanceAPI	ApplyProfileToServerInstance	Post /api/v2/server-instances/{serverInstanceId}/actions/apply-profile	Apply the Server Instance Profile configuration to the Server Instance
ServerInstanceAPI	CreateServerInstance	Post /api/v2/infrastructures/{infrastructureId}/server-instances	Add Server Instance to an infrastructure
ServerInstanceAPI	DeleteServerInstance	Delete /api/v2/server-instances/{serverInstanceId}	Delete Server Instance
ServerInstanceAPI	GetInfrastructureServerInstances	Get /api/v2/infrastructures/{infrastructureId}/server-instances	List Server Instances for an infrastructure
ServerInstanceAPI	GetServerInstance	Get /api/v2/server-instances/{serverInstanceId}	Get Server Instance details
ServerInstanceAPI	GetServerInstanceConfig	Get /api/v2/server-instances/{serverInstanceId}/config	Get Server Instance config details
ServerInstanceAPI	GetServerInstanceInterface	Get /api/v2/server-instances/{serverInstanceId}/interfaces/{interfaceId}	Get Server Instance Interface details
ServerInstanceAPI	GetServerInstanceInterfaces	Get /api/v2/server-instances/{serverInstanceId}/interfaces	Get Server Instance Interfaces
ServerInstanceAPI	GetServerInstances	Get /api/v2/server-instances	List Server Instances
ServerInstanceAPI	GetServerInstancesCredentials	Get /api/v2/server-instances/{serverInstanceId}/credentials	Get Server Instance credentials
ServerInstanceAPI	ResetServerInstance	Post /api/v2/server-instances/{serverInstanceId}/actions/reset	Reset a deployed server
ServerInstanceAPI	UpdateServerInstance	Patch /api/v2/server-instances/{serverInstanceId}/config	Update Server Instance configuration
ServerInstanceAPI	UpdateServerInstancesInterface	Patch /api/v2/server-instances/{serverInstanceId}/interfaces/{interfaceId}/config	Update Server Instance Interfaces
ServerInstanceGroupAPI	ApplyProfileToServerInstanceGroup	Post /api/v2/server-instance-groups/{serverInstanceGroupId}/actions/apply-profile/{serverInstanceProfileId}	Apply the Server profile configuration to all the Server Instances in the group
ServerInstanceGroupAPI	CreateServerInstanceGroup	Post /api/v2/infrastructures/{infrastructureId}/server-instance-groups	Add a Server Instance Group to an infrastructure. By default it will not have any instance.
ServerInstanceGroupAPI	DeleteServerInstanceGroup	Delete /api/v2/server-instance-groups/{serverInstanceGroupId}	Delete Server Instance Group. Will not take effect if there are instances in this group.
ServerInstanceGroupAPI	GetInfrastructureServerInstanceGroups	Get /api/v2/infrastructures/{infrastructureId}/server-instance-groups	List Server Instance Groups for an infrastructure
ServerInstanceGroupAPI	GetServerInstanceGroup	Get /api/v2/server-instance-groups/{serverInstanceGroupId}	Get Server Instance Groups details
ServerInstanceGroupAPI	GetServerInstanceGroupConfig	Get /api/v2/server-instance-groups/{serverInstanceGroupId}/config	Get Server Instance Group config details
ServerInstanceGroupAPI	GetServerInstanceGroupInterface	Get /api/v2/server-instance-groups/{serverInstanceGroupId}/interfaces/{interfaceId}	Get Server Instance Group Interface details
ServerInstanceGroupAPI	GetServerInstanceGroupInterfaces	Get /api/v2/server-instance-groups/{serverInstanceGroupId}/interfaces	Get Server Instance Group Interfaces
ServerInstanceGroupAPI	UpdateServerInstanceGroup	Patch /api/v2/server-instance-groups/{serverInstanceGroupId}/config	Update an Server Instance Group configuration
ServerInstanceProfileAPI	CreateServerInstanceProfile	Post /api/v2/server-instance-profiles	Create Server Instance Profile
ServerInstanceProfileAPI	DeleteServerInstanceProfile	Delete /api/v2/server-instance-profiles/{serverInstanceProfileId}	Delete Server Instance Profile
ServerInstanceProfileAPI	GetServerInstanceProfile	Get /api/v2/server-instance-profiles/{serverInstanceProfileId}	Get Server Instance Profile details
ServerInstanceProfileAPI	GetServerInstanceProfiles	Get /api/v2/server-instance-profiles	List all Server Instance Profiles
ServerInstanceProfileAPI	UpdateServerInstanceProfile	Patch /api/v2/server-instance-profiles/{serverInstanceProfileId}	Update Server Instance Profile
ServerTypeAPI	CreateServerType	Post /api/v2/server-types	Creates a Server Type
ServerTypeAPI	DeleteServerType	Delete /api/v2/server-types/{serverTypeId}	Deletes a Server Type
ServerTypeAPI	GetServerTypeInfo	Get /api/v2/server-types/{serverTypeId}	Get Server Type information
ServerTypeAPI	GetServerTypes	Get /api/v2/server-types	Get a list of Server Types
ServerTypeAPI	GetServerTypesStatisticsBatch	Post /api/v2/server-types/statistics	Get Server Type statistics batch
ServerTypeAPI	RemoveUnusedServerTypes	Post /api/v2/server-types/actions/clean-unused	Deletes unused server types
ServerTypeAPI	UpdateServerType	Patch /api/v2/server-types/{serverTypeId}	Updates a Server Type
SharedDriveAPI	GetInfrastructureSharedDrive	Get /api/v2/infrastructures/{infrastructureId}/shared-drives/{sharedDriveId}	Get Shared Drive information
SharedDriveAPI	GetInfrastructureSharedDrives	Get /api/v2/infrastructures/{infrastructureId}/shared-drives	Get all Shared Drives on the infrastructure
SharedDriveAPI	GetSharedDrive	Get /api/v2/shared-drives/{sharedDriveId}	Get Shared Drive information
SharedDriveAPI	GetSharedDriveHosts	Get /api/v2/infrastructures/{infrastructureId}/shared-drives/{sharedDriveId}/hosts	Get the Hosts of Shared Drive
SharedDriveAPI	UpdateSharedDriveInstanceArrayHostsBulk	Post /api/v2/infrastructures/{infrastructureId}/shared-drives/{sharedDriveId}/actions/modify-instance-array-hosts-bulk	Updates Instance Array Hosts on the Shared Drive
SiteAPI	CreateSite	Post /api/v2/sites	Creates a Site
SiteAPI	DecommissionSite	Post /api/v2/sites/{siteId}/actions/decommission	Decommissions a Site
SiteAPI	GetAgents	Get /api/v2/sites/{siteId}/controllers	Get a list of agents for a site
SiteAPI	GetSite	Get /api/v2/sites/{siteId}	Get Site information
SiteAPI	GetSiteConfig	Get /api/v2/sites/{siteId}/config	Get Site Config information
SiteAPI	GetSites	Get /api/v2/sites	Get a list of Sites
SiteAPI	GetSitesStatistics	Get /api/v2/sites/statistics	Get Sites statistics
SiteAPI	UpdateSite	Patch /api/v2/sites/{siteId}	Updates a Site
SiteAPI	UpdateSiteConfig	Patch /api/v2/sites/{siteId}/config	Updates a Site Config
StorageAPI	CreateStorage	Post /api/v2/storages	Creates a Storage
StorageAPI	CreateStorageNetworkDeviceConfiguration	Post /api/v2/storages/{storageId}/network-device-configurations	Creates a Storage Network Device Configuration
StorageAPI	DeleteStorage	Delete /api/v2/storages/{storageId}	Deletes a Storage
StorageAPI	DeleteStorageNetworkDeviceConfiguration	Delete /api/v2/storages/{storageId}/network-device-configurations/{storageNetworkDeviceConfigurationId}	Deletes a Storage Network Device Configuration
StorageAPI	ExecuteStorageAction	Post /api/v2/storages/{storageId}/actions/update-cache	Execute a Storage action
StorageAPI	GetStorage	Get /api/v2/storages/{storageId}	Retrieves a Storage
StorageAPI	GetStorageBuckets	Get /api/v2/storages/{storageId}/buckets	Get all Buckets linked to the specified storage
StorageAPI	GetStorageDrives	Get /api/v2/storages/{storageId}/drives	Get all Drives linked to the specified storage
StorageAPI	GetStorageFileShares	Get /api/v2/storages/{storageId}/file-shares	Get all File Shares linked to the specified storage
StorageAPI	GetStorageIscsiBootServers	Get /api/v2/storages/{storageId}/iscsi-boot-servers	Returns information about servers which are setup to boot from iSCSI block devices
StorageAPI	GetStorageNetworkDeviceConfigurations	Get /api/v2/storages/{storageId}/network-device-configurations	Retrieves Storage Network Device Configurations
StorageAPI	GetStorageSharedDrives	Get /api/v2/storages/{storageId}/shared-drives	Get all Shared Drives linked to the specified storage
StorageAPI	GetStorageStatistics	Get /api/v2/storages/statistics	Get Storages statistics
StorageAPI	GetStorages	Get /api/v2/storages	Get a list of Storages
StorageAPI	UpdateStorage	Patch /api/v2/storages/{storageId}	Updates a Storage
StorageAPI	UpdateStorageNetworkDeviceConfiguration	Patch /api/v2/storages/{storageId}/network-device-configurations/{storageNetworkDeviceConfigurationId}	Updates a Storage Network Device Configuration
SystemAPI	GetVersion	Get /api/v2/version	Get MetalSoft system version
TemplateAssetAPI	CreateTemplateAsset	Post /api/v2/template-assets	Create template asset
TemplateAssetAPI	DeleteTemplateAsset	Delete /api/v2/template-assets/{templateAssetId}	Delete template asset
TemplateAssetAPI	GetTemplateAsset	Get /api/v2/template-assets/{templateAssetId}	Get details for an template asset
TemplateAssetAPI	GetTemplateAssets	Get /api/v2/template-assets	Get a list of available template assets
TemplateAssetAPI	UpdateTemplateAsset	Put /api/v2/template-assets/{templateAssetId}	Update template asset
UserAPI	ArchiveUser	Post /api/v2/users/{userId}/actions/archive	Archive user
UserAPI	ChangeUserAccount	Post /api/v2/users/{userId}/actions/change-account	Change account for user
UserAPI	CreateUser	Post /api/v2/users	Creates a user
UserAPI	GetUser	Get /api/v2/users/{userId}	Get user
UserAPI	GetUserLimits	Get /api/v2/users/{userId}/limits	Get user limits
UserAPI	GetUsers	Get /api/v2/users	Get users
UserAPI	UnarchiveUser	Post /api/v2/users/{userId}/actions/unarchive	Unarchive user
UserAPI	UpdateUser	Patch /api/v2/users/{userId}	Update user
UserAPI	UpdateUserLimits	Patch /api/v2/users/{userId}/limits	Update user limits
VMAPI	GetVM	Get /api/v2/vms/{vmId}	Retrieves the VM information
VMAPI	GetVMPowerStatus	Get /api/v2/vms/{vmId}/power-status	Retrieves the power status of the VM
VMAPI	GetVMRemoteConsoleInfo	Get /api/v2/vms/{vmId}/remote-console-info	Get Remote Console information
VMAPI	RebootVM	Post /api/v2/vms/{vmId}/reboot	Reboots the VM
VMAPI	ShutdownVM	Post /api/v2/vms/{vmId}/shutdown	Shuts down the VM
VMAPI	StartVM	Post /api/v2/vms/{vmId}/start	Starts the VM
VMAPI	UpdateVM	Patch /api/v2/vms/{vmId}	Updates VM information
VMInstanceAPI	ApplyVMTypeOnVMInstance	Post /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId}/actions/apply-type/{vmTypeId}	Applies a VM Type to a VM Instance
VMInstanceAPI	CreateVMInstance	Post /api/v2/infrastructures/{infrastructureId}/vm-instances	Creates a VM Instance
VMInstanceAPI	DeleteVMInstance	Delete /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId}	Deletes a VM Instance
VMInstanceAPI	GetVMInstance	Get /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId}	Get VM Instance information
VMInstanceAPI	GetVMInstancePowerStatus	Get /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId}/power-status	Retrieves the power status of the VM Instance
VMInstanceAPI	RebootVMInstance	Post /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId}/reboot	Reboots the VM Instance
VMInstanceAPI	ShutdownVMInstance	Post /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId}/shutdown	Shuts down the VM Instance
VMInstanceAPI	StartVMInstance	Post /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId}/start	Starts the VM Instance
VMInstanceAPI	UpdateVMInstance	Patch /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId}	Updates VM Instance information
VMInstanceGroupAPI	ApplyVMTypeOnVMInstanceGroup	Post /api/v2/infrastructures/{infrastructureId}/vm-instance-groups/{vmInstanceGroupId}/actions/apply-type/{vmTypeId}	Applies a VM Type to a VM Instance Group
VMInstanceGroupAPI	CreateVMInstanceGroup	Post /api/v2/infrastructures/{infrastructureId}/vm-instance-groups	Creates a VM Instance Group
VMInstanceGroupAPI	CreateVMInterfaceOnVMInstanceGroup	Post /api/v2/infrastructures/{infrastructureId}/vm-instance-groups/{vmInstanceGroupId}/interfaces	Creates a new Virtual Interface for the VM Instance Group
VMInstanceGroupAPI	DeleteVMInstanceGroup	Delete /api/v2/infrastructures/{infrastructureId}/vm-instance-groups/{vmInstanceGroupId}	Deletes a VM Instance Group
VMInstanceGroupAPI	GetVMInstanceGroup	Get /api/v2/infrastructures/{infrastructureId}/vm-instance-groups/{vmInstanceGroupId}	Get VM Instance Group information
VMInstanceGroupAPI	GetVMInstanceGroupVMInstances	Get /api/v2/infrastructures/{infrastructureId}/vm-instance-groups/{vmInstanceGroupId}/vm-instances	Get the VM Instances of VM Instance Group
VMInstanceGroupAPI	GetVMInstanceGroups	Get /api/v2/infrastructures/{infrastructureId}/vm-instance-groups	Get all VM Instance Groups
VMInstanceGroupAPI	UpdateNetworkProfileOnVMInstanceGroupNetwork	Patch /api/v2/infrastructures/{infrastructureId}/vm-instance-groups/{vmInstanceGroupId}/network/{networkId}	Applies the given Network Profile to the specified VM Instance Group Network
VMInstanceGroupAPI	UpdateVMInstanceGroup	Patch /api/v2/infrastructures/{infrastructureId}/vm-instance-groups/{vmInstanceGroupId}	Updates VM Instance Group information
VMPoolAPI	CreateVMPool	Post /api/v2/vm-pools	Creates a VM Pool
VMPoolAPI	DeleteVMPool	Delete /api/v2/vm-pools/{vmPoolId}	Deletes a VM Pool
VMPoolAPI	GetVMPool	Get /api/v2/vm-pools/{vmPoolId}	Get VM Pool information
VMPoolAPI	GetVMPoolClusterHost	Get /api/v2/vm-pools/{vmPoolId}/cluster-hosts/{vmPoolClusterHostId}	Retrieves a VM Cluster Host
VMPoolAPI	GetVMPoolClusterHostInterface	Get /api/v2/vm-pools/{vmPoolId}/cluster-hosts/{vmPoolClusterHostId}/interfaces/{vmPoolClusterHostInterfaceId}	Retrieves a VM Cluster Host Interface
VMPoolAPI	GetVMPoolClusterHostInterfaces	Get /api/v2/vm-pools/{vmPoolId}/cluster-hosts/{vmPoolClusterHostId}/interfaces	Retrieves a list of VM Cluster Host Interfaces
VMPoolAPI	GetVMPoolClusterHostVMs	Get /api/v2/vm-pools/{vmPoolId}/cluster-hosts/{vmPoolClusterHostId}/vms	Retrieves a list of VM Cluster Host VMs
VMPoolAPI	GetVMPoolClusterHosts	Get /api/v2/vm-pools/{vmPoolId}/cluster-hosts	Get list of VM Cluster Hosts linked to the VM Pool
VMPoolAPI	GetVMPoolVMs	Get /api/v2/vm-pools/{vmPoolId}/vms	Returns all VMs linked to the VM Pool
VMPoolAPI	GetVMPools	Get /api/v2/vm-pools	Get all VM Pools
VMPoolAPI	UpdateVMPool	Patch /api/v2/vm-pools/{vmPoolId}	Updates VM Pool information
VMPoolAPI	UpdateVMPoolClusterHostInterface	Patch /api/v2/vm-pools/{vmPoolId}/cluster-hosts/{vmPoolClusterHostId}/interfaces/{vmPoolClusterHostInterfaceId}	Updates a VM Cluster Host Interface
VMTypeAPI	CreateVMType	Post /api/v2/vm-types	Creates a VM Type
VMTypeAPI	DeleteVMType	Delete /api/v2/vm-types/{vmTypeId}	Deletes a VM Type
VMTypeAPI	GetVMType	Get /api/v2/vm-types/{vmTypeId}	Get VM Type information
VMTypeAPI	GetVMTypes	Get /api/v2/vm-types	Get all VM Types
VMTypeAPI	GetVMsByVMType	Get /api/v2/vm-types/{vmTypeId}/vms	Returns all VMs linked to the VM Type
VMTypeAPI	UpdateVMType	Patch /api/v2/vm-types/{vmTypeId}	Updates VM Type information

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

apiKey

Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), sdk.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)

JWT

Type: HTTP Bearer token authentication