Access control

The API methods available vary based on the type of access you set.

accounts

The following methods are available to the accounts access type:

AddAccount GetAccountByID
ModifyAccount GetAccountByName
ListAccounts GetAccountEfficiency
RemoveAccount

administrator

All methods are available to the administrator access type.

clusterAdmin

The following methods are available to the cluster admin access type:

AddClusterAdmin ListBackupTargets
AddInitiatorsToVolumeAccessGroup ListBulkVolumeJobs
AddLdapClusterAdmin ListClusterAdmins
AddVirtualNetwork ListClusterPairs
AddVirtualNetwork ListNodeFibreChannelPortInfo
AddVolumetoVolumeAccessGroup ListBackupTargets
CloneMultipleVolumes ListDriveHardware
CompleteClusterPairing ListFibreChannelSessions
CompleteVolumePairing ListFibreChannelPortInfo
CreateBackupTarget ListGroupSnapshots
CreateSchedule ListActivePairedVolumes
CreateSnapshot ModifyBackupTarget
CreateSupportBundle ModifyClusterAdmin
CreateClusterSupportBundle ModifyGroupSnapshot
CreateGroupSnapshot ModifyClusterFullThreshold
CreateVolumeAccessGroup ModifyVolumeAccessGroup
DeleteAllSupportBundles ModifyVolumeAccessGroupLunAssignments
DeleteSnapshot ModifyVolumePair
DeleteGroupSnapshot ModifyVirtualNetwork
DeleteVolumeAccessGroup RemoveClusterAdmin
DisableEncryptionAtRest RemoveVolumePair
DisableLdapAuthentication RemoveVirtualNetwork
DisableSnmp RemoveVolumesFromVolumeAccessGroup
EnableEncryptionAtRest RemoveInitiatorsFromVolumeAccessGroup
EnableLdapAuthentication RollbackToSnapshot
EnableSnmp RollbackToGroupSnapshot
GetBackupTarget SetLoginSessionInfo
GetClusterFullThreshold SetNtpInfo
GetClusterMasterNodeID SetSnmpACL
GetHardwareConfig SetSnmpInfo
GetLdapConfiguration SetSnmpTrapInfo
GetLoginSessionInfo SetRemoteLoggingHosts
GetNtpInfo Shutdown
GetNvramInfo StartBulkVolumeRead
GetRawStats StartBulkVolumeWrite
GetSnmpACL StartClusterPairing
GetVolumeAccessGroupEfficiency StartVolumePairing
GetVolumeAccessLunAssignments TestLdapAuthentication
GetVirtualNetwork  

drives

The following methods are available to the drives access type:

ListDrives RemoveDrives
AddDrives SecureEraseDrives

nodes

The following methods are available to the nodes access type:

AddNodes ListPendingNodes
ListActiveNodes RemoveNodes

read

The following methods are available to the read access type:

GetAccountByID ListCloneJobs
GetAccountByName ListDeletedVolumes
GetAsyncResult ListDriveHardware
GetClusterCapacity ListDrives
GetDefaultQoS ListEvents
GetDriveStats ListISCSISessions
GetSoftwareUpgrade ListPendingNodes
GetVolumeStats ListSyncJobs
ListAccounts ListVolumeAccessGroups
ListActiveNodes ListVolumeStatsByAccount
ListActiveNodes ListVolumeStatsByVolume
ListActiveVolumes ListVolumeStatsByVolumeAccessGroup
ListAllNodes ListVolumesForAccount
ListBackupTargets

reporting

The following methods are available to the reporting access type:

ClearClusterFaults GetVolumeEfficiency
GetAccountEfficiency GetVolumeStats
GetClusterCapacity ListCloneJobs
GetClusterHardwareInfo ListClusterFaults
GetClusterInfo ListClusterPairs
GetClusterMasterNodeID ListDriveHardware
GetClusterStats ListEvents
GetDriveHardwareInfo ListISCSISessions
GetDriveStats ListSchedules
GetNetworkConfig ListServices
GetNodeHardwareInfo ListSyncJobs
GetNodeStats ListVirtualNetworks
GetSnmpInfo ListVolumeStatsByAccount
GetSnmpTrapInfo ListVolumeStatsByVolume
GetVolumeAccessGroupEfficiency ListVolumeStatsByVolumeAccessGroup

repositories

The ListAllNodes method is available to the repositories access type.

volumes

The following methods are available to the volumes access type:

CreateVolume DeleteVolume ModifyBackupTarget
CloneVolume DeleteVolumePairing ModifyVolumes
CloneMultipleVolumes GetBackupTarget ModifyVolumePair
CreateBackupTarget GetDefaultQoS PurgeDeletedVolume
CreateSnapshot ListActiveVolumes RemoveBackupTarget
CreateGroupSnapshot ListBackupTarget RemoveVolumePair
CompleteVolumePairing ListGroupSnapshots RestoreDeletedVolume
CloneMultipleVolumes ListVolumesForAccount RollbackToGroupSnapshot
DeleteGroupSnapshot ListDeletedVolumes RollbackToSnapshot
DeleteSnapshot ListGroupSnapshots StartBulkVolumeRead
StartBulkVolumeWrite StartVolumePairing UpdateBulkVolumeStatus

write

The following methods are available to the write access type:

AddDrives RemoveNodes
AddNodes RemoveAccount
AddAccount RemoveVolumesFromVolumeAccessGroup
AddVolumeToVolumeAccessGroup RemoveInitiatorsFromVolumeAccessGroup
AddInitiatorsToVolumeAccessGroup DeleteVolumeAccessGroup
CreateVolumeAccessGroup DeleteVolume
ModifyVolumeAccessGroup RestoreDeletedVolume
ModifyAccount PurgeDeletedVolume
CreateVolume ModifyVolume
CloneVolume GetAsyncResult
RemoveDrives