v3

Documentation

Overview

Copyright (c) 2022 Dell Inc, or its subsidiaries.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright (c) 2022 Dell Inc, or its subsidiaries.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright (c) 2022 Dell Inc, or its subsidiaries.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• type ExportClientList
  • func IsIOInProgress(ctx context.Context, client api.Client) (resp *ExportClientList, err error)
• type IsiClusterConfig
  • func GetIsiClusterConfig(ctx context.Context, client api.Client) (clusterConfig *IsiClusterConfig, err error)
• type IsiDevice
• type IsiStatsResp
  • func GetIsiStats(ctx context.Context, client api.Client, keys []string) (resp *IsiStatsResp, err error)

Types

type ExportClientList

type ExportClientList struct {
	ClientsList []*isiClientList `json:"client"`
}

func IsIOInProgress

func IsIOInProgress(ctx context.Context,
	client api.Client) (resp *ExportClientList, err error)

IsIOInProgress returns the list of clients currently performing IO on the particular array

type IsiClusterConfig

type IsiClusterConfig struct {
	Description string       `json:"description"`
	Devices     []*IsiDevice `json:"devices"`
	GUID        string       `json:"guid"`
	JoinMode    string       `json:"join_mode"`
	LocalDevId  int64        `json:"local_devid"`
	LocalLnn    int64        `json:"local_lnn"`
	LocalSerial string       `json:"local_serial"`
	Name        string       `json:"name"`
}

IsiClusterConfig returns the configuration information of cluster. TODO add other variables refers to the request cluster/config

func GetIsiClusterConfig

func GetIsiClusterConfig(
	ctx context.Context,
	client api.Client) (clusterConfig *IsiClusterConfig, err error)

GetIsiClusterConfig queries the config information of OneFS cluster

type IsiDevice

type IsiDevice struct {
	DevId int64  `json:"devid"`
	GUID  string `json:"guid"`
	IsUp  bool   `json:"is_up"`
	Lnn   int64  `json:"lnn"`
}

IsiDevice refers to device information of a cluster

type IsiStatsResp

type IsiStatsResp struct {
	StatsList []*isiStats `json:"stats"`
}

IsiStatsResp PAPI stats response attributes JSON structure

func GetIsiStats

func GetIsiStats(
	ctx context.Context,
	client api.Client,
	keys []string) (resp *IsiStatsResp, err error)

GetIsiStats queries the attributes of a volume on the cluster