Documentation
¶
Overview ¶
Copyright © 2020 Dell Inc. or its subsidiaries. All Rights Reserved.
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 ¶
- Constants
- type AddExistingStorageGroupParam
- type AddNewStorageGroupParam
- type AddSpecificVolumeParam
- type AddTagsParam
- type AddVolumeParam
- type AllVolumeParam
- type CreateStorageGroupParam
- type EditCompressionParam
- type EditStorageGroupActionParam
- type EditStorageGroupSLOParam
- type EditStorageGroupSRPParam
- type EditStorageGroupWorkloadParam
- type ExpandStorageGroupParam
- type ExpandVolumesParam
- type MergeStorageGroupParam
- type MoveVolumeToStorageGroupParam
- type RemoteSymmSGInfoParam
- type RemoveStorageGroupParam
- type RemoveTagsParam
- type RemoveVolumeParam
- type RenameStorageGroupParam
- type SLOBasedStorageGroupParam
- type SetHostIOLimitsParam
- type SpecificVolumeParam
- type SplitChildStorageGroupParam
- type SplitStorageGroupVolumesParam
- type TagManagementParam
- type UpdateStorageGroupPayload
- type VolumeAttributeType
- type VolumeIdentifierType
Constants ¶
const ( CapacityUnitTb = "TB" CapacityUnitGb = "GB" CapacityUnitMb = "MB" CapacityUnitCyl = "CYL" )
constants of storage units
const ExecutionOptionAsynchronous = "ASYNCHRONOUS"
ExecutionOptionAsynchronous : execute tasks asynchronously
const ExecutionOptionSynchronous = "SYNCHRONOUS"
ExecutionOptionSynchronous : execute tasks synchronously
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddExistingStorageGroupParam ¶
type AddExistingStorageGroupParam struct { StorageGroupIDs []string `json:"storageGroupId,omitempty"` EnableComplianceAlerts bool `json:"enableComplianceAlerts,omitempty"` }
AddExistingStorageGroupParam contains SG ids and compliance alert flag
type AddNewStorageGroupParam ¶
type AddNewStorageGroupParam struct { SRPID string `json:"srpId,omitempty"` SLOBasedStorageGroupParam []SLOBasedStorageGroupParam `json:"sloBasedStorageGroupParam,omitempty"` Emulation string `json:"emulation,omitempty"` EnableComplianceAlerts bool `json:"enableComplianceAlerts,omitempty"` }
AddNewStorageGroupParam contains parameters required to add a new storage group
type AddSpecificVolumeParam ¶
type AddSpecificVolumeParam struct { VolumeIDs []string `json:"volumeId,omitempty"` RemoteSymmSGInfoParam RemoteSymmSGInfoParam `json:"remoteSymmSGInfoParam,omitempty"` }
AddSpecificVolumeParam holds volume ids
type AddTagsParam ¶
type AddTagsParam struct {
TagName []string `json:"tag_name,omitempty"`
}
AddTagsParam holds array of tags to be added
type AddVolumeParam ¶
type AddVolumeParam struct { Emulation string `json:"emulation,omitempty"` CreateNewVolumes bool `json:"create_new_volumes,omitempty"` VolumeAttributes []VolumeAttributeType `json:"volumeAttributes,omitempty"` EnableMobilityID string `json:"enable_mobility_id,omitempty"` RemoteSymmSGInfoParam RemoteSymmSGInfoParam `json:"remoteSymmSGInfoParam,omitempty"` }
AddVolumeParam holds number volumes to add and related param for 9.1
type AllVolumeParam ¶
type AllVolumeParam struct { VolumeAttribute VolumeAttributeType `json:"volumeAttribute,omitempty"` RDFGroupNumber int `json:"rdfGroupNumber,omitempty"` }
AllVolumeParam contains volume attributes and RDF group number
type CreateStorageGroupParam ¶
type CreateStorageGroupParam struct { StorageGroupID string `json:"storageGroupId,omitempty"` CreateEmptyStorageGroup bool `json:"create_empty_storage_group,omitempty"` SRPID string `json:"srpId,omitempty"` SLOBasedStorageGroupParam []SLOBasedStorageGroupParam `json:"sloBasedStorageGroupParam,omitempty"` Emulation string `json:"emulation,omitempty"` ExecutionOption string `json:"executionOption,omitempty"` }
CreateStorageGroupParam : Payload for creating Storage Group
type EditCompressionParam ¶
type EditCompressionParam struct {
Compression bool `json:"compression,omitempty"`
}
EditCompressionParam hold param to edit compression attribute with an SG
type EditStorageGroupActionParam ¶
type EditStorageGroupActionParam struct { MergeStorageGroupParam *MergeStorageGroupParam `json:"mergeStorageGroupParam,omitempty"` SplitStorageGroupVolumesParam *SplitStorageGroupVolumesParam `json:"splitStorageGroupVolumesParam,omitempty"` SplitChildStorageGroupParam *SplitChildStorageGroupParam `json:"splitChildStorageGroupParam,omitempty"` MoveVolumeToStorageGroupParam *MoveVolumeToStorageGroupParam `json:"moveVolumeToStorageGroupParam,omitempty"` EditCompressionParam *EditCompressionParam `json:"editCompressionParam,omitempty"` SetHostIOLimitsParam *SetHostIOLimitsParam `json:"setHostIOLimitsParam,omitempty"` RemoveVolumeParam *RemoveVolumeParam `json:"removeVolumeParam,omitempty"` ExpandStorageGroupParam *ExpandStorageGroupParam `json:"expandStorageGroupParam,omitempty"` EditStorageGroupWorkloadParam *EditStorageGroupWorkloadParam `json:"editStorageGroupWorkloadParam,omitempty"` EditStorageGroupSLOParam *EditStorageGroupSLOParam `json:"editStorageGroupSLOParam,omitempty"` EditStorageGroupSRPParam *EditStorageGroupSRPParam `json:"editStorageGroupSRPParam,omitempty"` RemoveStorageGroupParam *RemoveStorageGroupParam `json:"removeStorageGroupParam,omitempty"` RenameStorageGroupParam *RenameStorageGroupParam `json:"renameStorageGroupParam,omitempty"` }
EditStorageGroupActionParam holds parameters to modify an SG
type EditStorageGroupSLOParam ¶
type EditStorageGroupSLOParam struct {
SLOID string `json:"sloId,omitempty"`
}
EditStorageGroupSLOParam hold param to change SLOs
type EditStorageGroupSRPParam ¶
type EditStorageGroupSRPParam struct {
SRPID string `json:"srpId,omitempty"`
}
EditStorageGroupSRPParam holds param to change SRPs
type EditStorageGroupWorkloadParam ¶
type EditStorageGroupWorkloadParam struct {
WorkloadSelection string `json:"workloadSelection,omitempty,omitempty"`
}
EditStorageGroupWorkloadParam holds selected work load
type ExpandStorageGroupParam ¶
type ExpandStorageGroupParam struct { AddExistingStorageGroupParam *AddExistingStorageGroupParam `json:"addExistingStorageGroupParam,omitempty"` AddNewStorageGroupParam *AddNewStorageGroupParam `json:"addNewStorageGroupParam,omitempty"` ExpandVolumesPar1Gam *ExpandVolumesParam `json:"expandVolumesParam,omitempty"` AddSpecificVolumeParam *AddSpecificVolumeParam `json:"addSpecificVolumeParam,omitempty"` AddVolumeParam *AddVolumeParam `json:"addVolumeParam,omitempty"` }
ExpandStorageGroupParam holds params related to expanding size of an SG
type ExpandVolumesParam ¶
type ExpandVolumesParam struct { SpecificVolumeParam []SpecificVolumeParam `json:"specificVolumeParam,omitempty"` AllVolumeParam AllVolumeParam `json:"allVolumeParam,omitempty"` }
ExpandVolumesParam holds parameters to expand volumes
type MergeStorageGroupParam ¶
type MergeStorageGroupParam struct {
StorageGroupID string `json:"storageGroupId,omitempty"`
}
MergeStorageGroupParam : Payloads for updating Storage Group
type MoveVolumeToStorageGroupParam ¶
type MoveVolumeToStorageGroupParam struct { VolumeIDs []string `json:"volumeId,omitempty"` StorageGroupID string `json:"storageGroupId,omitempty"` Force bool `json:"force,omitempty"` }
MoveVolumeToStorageGroupParam stores parameters to move volumes to SG
type RemoteSymmSGInfoParam ¶
type RemoteSymmSGInfoParam struct { RemoteSymmetrix1ID string `json:"remote_symmetrix_1_id,omitempty"` RemoteSymmetrix1SGs []string `json:"remote_symmetrix_1_sgs,omitempty"` RemoteSymmetrix2ID string `json:"remote_symmetrix_2_id,omitempty"` RemoteSymmetrix2SGs []string `json:"remote_symmetrix_2_sgs,omitempty"` Force bool `json:"force,omitempty"` }
RemoteSymmSGInfoParam have info abput remote symmetrix Id's and storage groups
type RemoveStorageGroupParam ¶
type RemoveStorageGroupParam struct { StorageGroupIDs []string `json:"storageGroupId,omitempty"` Force bool `json:"force,omitempty"` }
RemoveStorageGroupParam holds parameters to remove an SG
type RemoveTagsParam ¶
type RemoveTagsParam struct {
TagName []string `json:"tag_name,omitempty"`
}
RemoveTagsParam holds array of tags to be removed
type RemoveVolumeParam ¶
type RemoveVolumeParam struct { VolumeIDs []string `json:"volumeId,omitempty"` RemoteSymmSGInfoParam RemoteSymmSGInfoParam `json:"remoteSymmSGInfoParam,omitempty"` }
RemoveVolumeParam holds volume ids to remove from SG
type RenameStorageGroupParam ¶
type RenameStorageGroupParam struct {
NewStorageGroupName string `json:"new_storage_Group_name,omitempty"`
}
RenameStorageGroupParam holds new name of a storage group
type SLOBasedStorageGroupParam ¶
type SLOBasedStorageGroupParam struct { CustomCascadedStorageGroupID string `json:"custom_cascaded_storageGroupId,omitempty"` SLOID string `json:"sloId,omitempty"` WorkloadSelection string `json:"workloadSelection,omitempty"` VolumeAttributes []VolumeAttributeType `json:"volumeAttributes,omitempty"` AllocateCapacityForEachVol bool `json:"allocate_capacity_for_each_vol,omitempty"` PersistPrealloctedCapacityThroughReclaimOrCopy bool `json:"persist_preallocated_capacity_through_reclaim_or_copy,omitempty"` NoCompression bool `json:"noCompression,omitempty"` EnableMobilityID string `json:"enable_mobility_id,omitempty"` SetHostIOLimitsParam *SetHostIOLimitsParam `json:"setHostIOLimitsParam,omitempty"` }
SLOBasedStorageGroupParam holds parameters related to an SG and SLO
type SetHostIOLimitsParam ¶
type SetHostIOLimitsParam struct { HostIOLimitMBSec string `json:"host_io_limit_mb_sec,omitempty"` HostIOLimitIOSec string `json:"host_io_limit_io_sec,omitempty"` DynamicDistribution string `json:"dynamicDistribution,omitempty"` }
SetHostIOLimitsParam holds param to set host IO limit
type SpecificVolumeParam ¶
type SpecificVolumeParam struct { VolumeIDs []string `json:"volumeId,omitempty"` VolumeAttribute VolumeAttributeType `json:"volumeAttribute,omitempty"` RDFGroupNumber int `json:"rdfGroupNumber,omitempty"` }
SpecificVolumeParam holds volume ids, volume attributes and RDF group num
type SplitChildStorageGroupParam ¶
type SplitChildStorageGroupParam struct { StorageGroupID string `json:"storageGroupId,omitempty"` MaskingViewID string `json:"maskingViewId,omitempty"` }
SplitChildStorageGroupParam holds param to split child SG
type SplitStorageGroupVolumesParam ¶
type SplitStorageGroupVolumesParam struct { VolumeIDs []string `json:"volumeId,omitempty"` StorageGroupID string `json:"storageGroupId,omitempty"` MaskingViewID string `json:"maskingViewId,omitempty"` }
SplitStorageGroupVolumesParam holds parameters to split
type TagManagementParam ¶
type TagManagementParam struct { RemoveTagsParam *RemoveTagsParam `json:"removeTagsParam,omitempty"` AddTagsParam *AddTagsParam `json:"addTagsParam,omitempty"` }
TagManagementParam holds parameters to remove or add tags
type UpdateStorageGroupPayload ¶
type UpdateStorageGroupPayload struct { EditStorageGroupActionParam EditStorageGroupActionParam `json:"editStorageGroupActionParam"` // ExecutionOption "SYNCHRONOUS" or "ASYNCHRONOUS" ExecutionOption string `json:"executionOption"` }
UpdateStorageGroupPayload : updates SG rest paylod
type VolumeAttributeType ¶
type VolumeAttributeType struct { NumberOfVolumes int `json:"num_of_vols,omitempty"` VolumeIdentifier *VolumeIdentifierType `json:"volumeIdentifier,omitempty"` CapacityUnit string `json:"capacityUnit"` // CAPACITY_UNIT_{TB,GB,MB,CYL} VolumeSize string `json:"volume_size"` }
VolumeAttributeType : volume attributes for 9.1
type VolumeIdentifierType ¶
type VolumeIdentifierType struct { VolumeIdentifierChoice string `json:"volumeIdentifierChoice,omitempty"` IdentifierName string `json:"identifier_name,omitempty"` AppendNumber string `json:"append_number,omitempty"` }
VolumeIdentifierType : volume identifier