com.solidfire.element.api.SolidFireElementIF Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of solidfire-sdk-java Show documentation
Show all versions of solidfire-sdk-java Show documentation
Library for interfacing with the Public and Incubating SolidFire Element API.
/*
* Copyright © 2014-2016 NetApp, Inc. 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.
*/
/*
* DO NOT EDIT THIS CODE BY HAND! It has been generated with jsvcgen.
*/
package com.solidfire.element.api;
import com.solidfire.core.annotation.*;
import com.solidfire.core.javautil.Optional;
/**
* The API for controlling a SolidFire cluster.
**/
public interface SolidFireElementIF {
/**
* Returns details about an account, given its AccountID.
**/
@Since("1")
@ConnectionType("Cluster")
public GetAccountResult getAccountByID(final GetAccountByIDRequest request);
/**
* Returns details about an account, given its AccountID.
**/
@Since("1")
@ConnectionType("Cluster")
public GetAccountResult getAccountByID(
Long accountID
);
/**
* Returns details about an account, given its Username.
**/
@Since("1")
@ConnectionType("Cluster")
public GetAccountResult getAccountByName(final GetAccountByNameRequest request);
/**
* Returns details about an account, given its Username.
**/
@Since("1")
@ConnectionType("Cluster")
public GetAccountResult getAccountByName(
String username
);
/**
* GetAccountEfficiency is used to retrieve information about a volume account. Only the account given as a parameter in this API method is used to compute the capacity.
**/
@Since("6")
@ConnectionType("Cluster")
public GetEfficiencyResult getAccountEfficiency(final GetAccountEfficiencyRequest request);
/**
* GetAccountEfficiency is used to retrieve information about a volume account. Only the account given as a parameter in this API method is used to compute the capacity.
**/
@Since("6")
@ConnectionType("Cluster")
public GetEfficiencyResult getAccountEfficiency(
Long accountID
);
/**
* Returns the entire list of accounts, with optional paging support.
**/
@Since("1")
@ConnectionType("Cluster")
public ListAccountsResult listAccounts(final ListAccountsRequest request);
/**
* Returns the entire list of accounts, with optional paging support.
**/
@Since("1")
@ConnectionType("Cluster")
public ListAccountsResult listAccounts(
Optional startAccountID
,
Optional limit
);
/**
* Used to modify an existing account.
* When locking an account, any existing connections from that account are immediately terminated.
* When changing CHAP settings, any existing connections continue to be active,
* and the new CHAP values are only used on subsequent connection or reconnection.
**/
@Since("1")
@ConnectionType("Cluster")
public ModifyAccountResult modifyAccount(final ModifyAccountRequest request);
/**
* Used to modify an existing account.
* When locking an account, any existing connections from that account are immediately terminated.
* When changing CHAP settings, any existing connections continue to be active,
* and the new CHAP values are only used on subsequent connection or reconnection.
**/
@Since("1")
@ConnectionType("Cluster")
public ModifyAccountResult modifyAccount(
Long accountID
,
Optional username
,
Optional status
,
Optional initiatorSecret
,
Optional targetSecret
,
Optional> attributes
);
/**
* Used to remove an existing account.
* All Volumes must be deleted and purged on the account before it can be removed.
* If volumes on the account are still pending deletion, RemoveAccount cannot be used until DeleteVolume to delete and purge the volumes.
**/
@Since("1")
@ConnectionType("Cluster")
public RemoveAccountResult removeAccount(final RemoveAccountRequest request);
/**
* Used to remove an existing account.
* All Volumes must be deleted and purged on the account before it can be removed.
* If volumes on the account are still pending deletion, RemoveAccount cannot be used until DeleteVolume to delete and purge the volumes.
**/
@Since("1")
@ConnectionType("Cluster")
public RemoveAccountResult removeAccount(
Long accountID
);
/**
* Used to add a new account to the system.
* New volumes can be created under the new account.
* The CHAP settings specified for the account applies to all volumes owned by the account.
**/
@Since("1")
@ConnectionType("Cluster")
public AddAccountResult addAccount(final AddAccountRequest request);
/**
* Used to add a new account to the system.
* New volumes can be created under the new account.
* The CHAP settings specified for the account applies to all volumes owned by the account.
**/
@Since("1")
@ConnectionType("Cluster")
public AddAccountResult addAccount(
String username
,
Optional initiatorSecret
,
Optional targetSecret
,
Optional> attributes
);
/**
* CreateBackupTarget allows you to create and store backup target information so that you do not need to re-enter it each time a backup is created.
**/
@Since("6")
@ConnectionType("Cluster")
public CreateBackupTargetResult createBackupTarget(final CreateBackupTargetRequest request);
/**
* CreateBackupTarget allows you to create and store backup target information so that you do not need to re-enter it each time a backup is created.
**/
@Since("6")
@ConnectionType("Cluster")
public CreateBackupTargetResult createBackupTarget(
String name
,
Optional> attributes
);
/**
* GetBackupTarget allows you to return information about a specific backup target that has been created.
**/
@Since("6")
@ConnectionType("Cluster")
public GetBackupTargetResult getBackupTarget(final GetBackupTargetRequest request);
/**
* GetBackupTarget allows you to return information about a specific backup target that has been created.
**/
@Since("6")
@ConnectionType("Cluster")
public GetBackupTargetResult getBackupTarget(
Long backupTargetID
);
/**
* You can use ListBackupTargets to retrieve information about all backup targets that have been created.
**/
@Since("6")
@ConnectionType("Cluster")
public ListBackupTargetsResult listBackupTargets();
/**
* ModifyBackupTarget is used to change attributes of a backup target.
**/
@Since("6")
@ConnectionType("Cluster")
public ModifyBackupTargetResult modifyBackupTarget(final ModifyBackupTargetRequest request);
/**
* ModifyBackupTarget is used to change attributes of a backup target.
**/
@Since("6")
@ConnectionType("Cluster")
public ModifyBackupTargetResult modifyBackupTarget(
Long backupTargetID
,
Optional name
,
Optional> attributes
);
/**
* RemoveBackupTarget allows you to delete backup targets.
**/
@Since("6")
@ConnectionType("Cluster")
public RemoveBackupTargetResult removeBackupTarget(final RemoveBackupTargetRequest request);
/**
* RemoveBackupTarget allows you to delete backup targets.
**/
@Since("6")
@ConnectionType("Cluster")
public RemoveBackupTargetResult removeBackupTarget(
Long backupTargetID
);
/**
* ModifyClusterFullThreshold is used to change the level at which an event is generated when the storage cluster approaches the capacity utilization requested. The number entered in this setting is used to indicate the number of node failures the system is required to recover from. For example, on a 10 node cluster, if you want to be alerted when the system cannot recover from 3 nodes failures, enter the value of "3". When this number is reached, a message alert is sent to the Event Log in the Cluster Management Console.
**/
@Since("1")
@ConnectionType("Cluster")
public ModifyClusterFullThresholdResult modifyClusterFullThreshold(final ModifyClusterFullThresholdRequest request);
/**
* ModifyClusterFullThreshold is used to change the level at which an event is generated when the storage cluster approaches the capacity utilization requested. The number entered in this setting is used to indicate the number of node failures the system is required to recover from. For example, on a 10 node cluster, if you want to be alerted when the system cannot recover from 3 nodes failures, enter the value of "3". When this number is reached, a message alert is sent to the Event Log in the Cluster Management Console.
**/
@Since("1")
@ConnectionType("Cluster")
public ModifyClusterFullThresholdResult modifyClusterFullThreshold(
Optional stage2AwareThreshold
,
Optional stage3BlockThresholdPercent
,
Optional maxMetadataOverProvisionFactor
);
/**
* RemoveClusterAdmin is used to remove a Cluster Admin. The "admin" Cluster Admin cannot be removed.
**/
@Since("1")
@ConnectionType("Cluster")
public RemoveClusterAdminResult removeClusterAdmin(final RemoveClusterAdminRequest request);
/**
* RemoveClusterAdmin is used to remove a Cluster Admin. The "admin" Cluster Admin cannot be removed.
**/
@Since("1")
@ConnectionType("Cluster")
public RemoveClusterAdminResult removeClusterAdmin(
Long clusterAdminID
);
/**
* SetNtpInfo is used to configure the NTP on cluster nodes. The values set with this interface apply to all nodes in the cluster. The nodes can only be configured as a server where a host is selected to administrate the networking and/or a broadcast client where each host sends each message to each peer.
**/
@Since("1")
@ConnectionType("Cluster")
public SetNtpInfoResult setNtpInfo(final SetNtpInfoRequest request);
/**
* SetNtpInfo is used to configure the NTP on cluster nodes. The values set with this interface apply to all nodes in the cluster. The nodes can only be configured as a server where a host is selected to administrate the networking and/or a broadcast client where each host sends each message to each peer.
**/
@Since("1")
@ConnectionType("Cluster")
public SetNtpInfoResult setNtpInfo(
String[] servers
,
Optional broadcastclient
);
/**
* SetSnmpACL is used to configure SNMP access permissions on the cluster nodes. The values set with this interface apply to all nodes in the cluster, and the values that are passed replace, in whole, all values set in any previous call to SetSnmpACL. Also note that the values set with this interface replace all "network" or "usmUsers" values set with the older SetSnmpInfo.
**/
@Since("8")
@ConnectionType("Cluster")
public SetSnmpACLResult setSnmpACL(final SetSnmpACLRequest request);
/**
* SetSnmpACL is used to configure SNMP access permissions on the cluster nodes. The values set with this interface apply to all nodes in the cluster, and the values that are passed replace, in whole, all values set in any previous call to SetSnmpACL. Also note that the values set with this interface replace all "network" or "usmUsers" values set with the older SetSnmpInfo.
**/
@Since("8")
@ConnectionType("Cluster")
public SetSnmpACLResult setSnmpACL(
SnmpNetwork[] networks
,
SnmpV3UsmUser[] usmUsers
);
/**
* SetSnmpTrapInfo is used to enable and disable the generation of SolidFire SNMP notifications (traps) and to specify the set of network host computers that are to receive the notifications. The values passed with each SetSnmpTrapInfo method replaces all values set in any previous method to SetSnmpTrapInfo.
**/
@Since("5")
@ConnectionType("Cluster")
public SetSnmpTrapInfoResult setSnmpTrapInfo(final SetSnmpTrapInfoRequest request);
/**
* SetSnmpTrapInfo is used to enable and disable the generation of SolidFire SNMP notifications (traps) and to specify the set of network host computers that are to receive the notifications. The values passed with each SetSnmpTrapInfo method replaces all values set in any previous method to SetSnmpTrapInfo.
**/
@Since("5")
@ConnectionType("Cluster")
public SetSnmpTrapInfoResult setSnmpTrapInfo(
SnmpTrapRecipient[] trapRecipients
,
Boolean clusterFaultTrapsEnabled
,
Boolean clusterFaultResolvedTrapsEnabled
,
Boolean clusterEventTrapsEnabled
);
/**
* SnmpSendTestTraps enables you to test SNMP functionality for a cluster. This method instructs the cluster to send test SNMP traps to the currently configured SNMP manager.
**/
@Since("6")
@ConnectionType("Cluster")
public SnmpSendTestTrapsResult snmpSendTestTraps();
/**
* AddClusterAdmin adds a new Cluster Admin. A Cluster Admin can be used to manage the cluster via the API and management tools. Cluster Admins are completely separate and unrelated to standard tenant accounts.
*
* Each Cluster Admin can be restricted to a sub-set of the API. SolidFire recommends using multiple Cluster Admins for different users and applications. Each Cluster Admin should be given the minimal permissions necessary to reduce the potential impact of credential compromise.
**/
@Since("1")
@ConnectionType("Cluster")
public AddClusterAdminResult addClusterAdmin(final AddClusterAdminRequest request);
/**
* AddClusterAdmin adds a new Cluster Admin. A Cluster Admin can be used to manage the cluster via the API and management tools. Cluster Admins are completely separate and unrelated to standard tenant accounts.
*
* Each Cluster Admin can be restricted to a sub-set of the API. SolidFire recommends using multiple Cluster Admins for different users and applications. Each Cluster Admin should be given the minimal permissions necessary to reduce the potential impact of credential compromise.
**/
@Since("1")
@ConnectionType("Cluster")
public AddClusterAdminResult addClusterAdmin(
String username
,
String password
,
String[] access
,
Optional acceptEula
,
Optional> attributes
);
/**
* ClearClusterFaults is used to clear information about both current faults that are resolved as well as faults that were previously detected and resolved can be cleared.
**/
@Since("1")
@ConnectionType("Cluster")
public ClearClusterFaultsResult clearClusterFaults(final ClearClusterFaultsRequest request);
/**
* ClearClusterFaults is used to clear information about both current faults that are resolved as well as faults that were previously detected and resolved can be cleared.
**/
@Since("1")
@ConnectionType("Cluster")
public ClearClusterFaultsResult clearClusterFaults(
Optional faultTypes
);
/**
* The CreateCluster method is used to initialize the node in a cluster that has ownership of the "mvip" and "svip" addresses. Each new cluster is initialized using the MIP of the first node in the cluster. This method also automatically adds all the nodes being configured into the cluster. The method is used only once each time a new cluster is initialized.
*
* Note: You need to log into the node that is used as the master node for the cluster. Once logged in, run the GetBootstrapConfig method on the node to get the IP addresses for the rest of the nodes that you want to include in the cluster. Then run the CreateCluster method.
**/
@Since("7.0")
@ConnectionType("Both")
public CreateClusterResult createCluster(final CreateClusterRequest request);
/**
* The CreateCluster method is used to initialize the node in a cluster that has ownership of the "mvip" and "svip" addresses. Each new cluster is initialized using the MIP of the first node in the cluster. This method also automatically adds all the nodes being configured into the cluster. The method is used only once each time a new cluster is initialized.
*
* Note: You need to log into the node that is used as the master node for the cluster. Once logged in, run the GetBootstrapConfig method on the node to get the IP addresses for the rest of the nodes that you want to include in the cluster. Then run the CreateCluster method.
**/
@Since("7.0")
@ConnectionType("Both")
public CreateClusterResult createCluster(
Optional acceptEula
,
String mvip
,
String svip
,
Long repCount
,
String username
,
String password
,
String[] nodes
,
Optional> attributes
);
/**
* The GetClusterConfig API method is used to return information about the cluster configuration this node uses to communicate with the cluster it is a part of.
*
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("5")
@ConnectionType("Node")
public GetClusterConfigResult getClusterConfig();
/**
* GetSnmpState is used to return the current state of the SNMP feature.
*
* Note: GetSnmpState is new for Element OS 8. Please use this method and SetSnmpACL to migrate your SNMP functionality in the future.
**/
@Since("8")
@ConnectionType("Cluster")
public GetSnmpStateResult getSnmpState();
/**
* The SetClusterConfig API method is used to set the configuration this node uses to communicate with the cluster it is associated with. To see the states in which these objects can be modified see Cluster Object on page 109. To display the current cluster interface settings for a node, run the GetClusterConfig API method.
*
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("5")
@ConnectionType("Node")
public SetClusterConfigResult setClusterConfig(final SetClusterConfigRequest request);
/**
* The SetClusterConfig API method is used to set the configuration this node uses to communicate with the cluster it is associated with. To see the states in which these objects can be modified see Cluster Object on page 109. To display the current cluster interface settings for a node, run the GetClusterConfig API method.
*
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("5")
@ConnectionType("Node")
public SetClusterConfigResult setClusterConfig(
ClusterConfig cluster
);
/**
* SetSnmpInfo is used to configure SNMP v2 and v3 on the cluster nodes. The values set with this interface apply to all nodes in the cluster, and the values that are passed replace, in whole, all values set in any previous call to SetSnmpInfo.
*
* Note: EnableSnmp and SetSnmpACL methods can be used to accomplish the same results as SetSnmpInfo. SetSnmpInfo will no longer be available after the Element 8 release. Please use EnableSnmp and SetSnmpACL in the future.
**/
@Since("1")
@ConnectionType("Cluster")
public SetSnmpInfoResult setSnmpInfo(final SetSnmpInfoRequest request);
/**
* SetSnmpInfo is used to configure SNMP v2 and v3 on the cluster nodes. The values set with this interface apply to all nodes in the cluster, and the values that are passed replace, in whole, all values set in any previous call to SetSnmpInfo.
*
* Note: EnableSnmp and SetSnmpACL methods can be used to accomplish the same results as SetSnmpInfo. SetSnmpInfo will no longer be available after the Element 8 release. Please use EnableSnmp and SetSnmpACL in the future.
**/
@Since("1")
@ConnectionType("Cluster")
public SetSnmpInfoResult setSnmpInfo(
Optional networks
,
Optional enabled
,
Optional snmpV3Enabled
,
Optional usmUsers
);
/**
* CreateSupportBundle is used to create a support bundle file under the node's directory. When the bundle has been successfully created, the bundle is stored on the node as a tar.gz file.
**/
@Since("8")
@ConnectionType("Node")
public CreateSupportBundleResult createSupportBundle(final CreateSupportBundleRequest request);
/**
* CreateSupportBundle is used to create a support bundle file under the node's directory. When the bundle has been successfully created, the bundle is stored on the node as a tar.gz file.
**/
@Since("8")
@ConnectionType("Node")
public CreateSupportBundleResult createSupportBundle(
Optional bundleName
,
Optional extraArgs
,
Optional timeoutSec
);
/**
* DeleteAllSupportBundles is used to delete all support bundles generated with the CreateSupportBundle API method.
**/
@Since("8")
@ConnectionType("Node")
public DeleteAllSupportBundlesResult deleteAllSupportBundles();
/**
* The DisableEncryptionAtRest method enables you to remove the encryption that was previously applied to the cluster using the EnableEncryptionAtRest method.
* This disable method is asynchronous and returns a response before encryption is disabled.
* You can use the GetClusterInfo method to poll the system to see when the process has completed.
**/
@Since("5")
@ConnectionType("Cluster")
public DisableEncryptionAtRestResult disableEncryptionAtRest();
/**
* DisableSnmp is used to disable SNMP on the cluster nodes.
**/
@Since("8")
@ConnectionType("Cluster")
public DisableSnmpResult disableSnmp();
/**
* EnableSnmp is used to enable SNMP on the cluster nodes. The values set with this interface apply to all nodes in the cluster, and the values that are passed replace, in whole, all values set in any previous call to EnableSnmp.
**/
@Since("8")
@ConnectionType("Cluster")
public EnableSnmpResult enableSnmp(final EnableSnmpRequest request);
/**
* EnableSnmp is used to enable SNMP on the cluster nodes. The values set with this interface apply to all nodes in the cluster, and the values that are passed replace, in whole, all values set in any previous call to EnableSnmp.
**/
@Since("8")
@ConnectionType("Cluster")
public EnableSnmpResult enableSnmp(
Boolean snmpV3Enabled
);
/**
* Retrieves the current version of the API and a list of all supported versions.
**/
@Since("1.0")
@ConnectionType("Both")
public GetAPIResult getAPI();
/**
* Return the high-level capacity measurements for an entire cluster.
* The fields returned from this method can be used to calculate the efficiency rates that are displayed in the Element User Interface.
**/
@Since("1")
@ConnectionType("Cluster")
public GetClusterCapacityResult getClusterCapacity();
/**
* GetClusterFullThreshold is used to view the stages set for cluster fullness levels. All levels are returned when this method is entered.
**/
@Since("1")
@ConnectionType("Cluster")
public GetClusterFullThresholdResult getClusterFullThreshold();
/**
* Return configuration information about the cluster.
**/
@Since("1")
@ConnectionType("Cluster")
public GetClusterInfoResult getClusterInfo();
/**
* GetClusterMasterNodeID is used to return the ID of the node that can perform cluster-wide administration tasks and holds the storage virtual IP (SVIP) and management virtual IP (MVIP).
**/
@Since("1")
@ConnectionType("Cluster")
public GetClusterMasterNodeIDResult getClusterMasterNodeID();
/**
* The GetClusterState method is used to indicate if a node is part of a cluster or not. The three states are:
Available: Node has not been configured with a cluster name.
Pending: Node is pending for a specific named cluster and can be added.
Active: Node is active and a member of a cluster and may not be added to another cluster.
**/
@Since("5")
@ConnectionType("Cluster")
public GetClusterStateResult getClusterState(final GetClusterStateRequest request);
/**
* The GetClusterState method is used to indicate if a node is part of a cluster or not. The three states are:
Available: Node has not been configured with a cluster name.
Pending: Node is pending for a specific named cluster and can be added.
Active: Node is active and a member of a cluster and may not be added to another cluster.
**/
@Since("5")
@ConnectionType("Cluster")
public GetClusterStateResult getClusterState(
Boolean force
);
/**
* GetClusterStats is used to return high-level activity measurements for the cluster. Values returned are cumulative from the creation of the cluster.
**/
@Since("1")
@ConnectionType("Cluster")
public GetClusterStatsResult getClusterStats();
/**
* Return information about the Element software version running on each node in the cluster.
* Information about the nodes that are currently in the process of upgrading software is also returned.
**/
@Since("1")
@ConnectionType("Cluster")
public GetClusterVersionInfoResult getClusterVersionInfo();
/**
* GetCurrentClusterAdmin returns information for the current primary cluster administrator. The primary Cluster Admin was ncreated when the cluster was created.
**/
@Since("6")
@ConnectionType("Cluster")
public GetCurrentClusterAdminResult getCurrentClusterAdmin();
/**
* GetLimits enables you to retrieve the limit values set by the API. These values might change between releases of Element, but do not change without an update to the system. Knowing the limit values set by the API can be useful when writing API scripts for user-facing tools.NOTE: The GetLimits method returns the limits for the current software version regardless of the API endpoint version used to pass the method.
**/
@Since("1")
@ConnectionType("Cluster")
public GetLimitsResult getLimits();
/**
* GetNtpInfo is used to return the current network time protocol (NTP) configuration information.
**/
@Since("1")
@ConnectionType("Cluster")
public GetNtpInfoResult getNtpInfo();
/**
* GetSnmpACL is used to return the current SNMP access permissions on the cluster nodes.
**/
@Since("8")
@ConnectionType("Cluster")
public GetSnmpACLResult getSnmpACL();
/**
* GetSnmpTrapInfo is used to return current SNMP trap configuration information.
**/
@Since("5")
@ConnectionType("Cluster")
public GetSnmpTrapInfoResult getSnmpTrapInfo();
/**
**/
@Since("5")
@ConnectionType("Node")
public GetSystemStatusResult getSystemStatus();
/**
* ListClusterAdmins returns the list of all cluster administrators for the cluster. There can be several cluster administrators that have different levels of permissions. There can be only one primary cluster administrator in the system. The primary Cluster Admin is the administrator that was created when the cluster was created. LDAP administrators can also be created when setting up an LDAP system on the cluster.
**/
@Since("1")
@ConnectionType("Cluster")
public ListClusterAdminsResult listClusterAdmins();
/**
* ListEvents returns events detected on the cluster, sorted from oldest to newest.
**/
@Since("1")
@ConnectionType("Cluster")
public ListEventsResult listEvents(final ListEventsRequest request);
/**
* ListEvents returns events detected on the cluster, sorted from oldest to newest.
**/
@Since("1")
@ConnectionType("Cluster")
public ListEventsResult listEvents(
Optional maxEvents
,
Optional startEventID
,
Optional endEventID
,
Optional eventQueueType
);
/**
* ListSyncJobs is used to return information about synchronization jobs that are running on a SolidFire cluster. Synchronization jobs that are returned with this method are, "slice," "clone" and "remote."
**/
@Since("1")
@ConnectionType("Cluster")
public ListSyncJobsResult listSyncJobs();
/**
* ModifyClusterAdmin is used to change the settings for a Cluster Admin or LDAP Cluster Admin. Access for the administrator Cluster Admin account cannot be changed.
**/
@Since("1")
@ConnectionType("Cluster")
public ModifyClusterAdminResult modifyClusterAdmin(final ModifyClusterAdminRequest request);
/**
* ModifyClusterAdmin is used to change the settings for a Cluster Admin or LDAP Cluster Admin. Access for the administrator Cluster Admin account cannot be changed.
**/
@Since("1")
@ConnectionType("Cluster")
public ModifyClusterAdminResult modifyClusterAdmin(
Long clusterAdminID
,
Optional password
,
Optional access
,
Optional> attributes
);
/**
* The EnableEncryptionAtRest method is used to enable the Advanced Encryption Standard (AES) 256-bit encryption at rest on the cluster so that the cluster can manage the encryption key used for the drives on each node. This feature is not enabled by default. Enabling this operation allows the cluster to automatically manage encryption keys internally for the drives on each node in the cluster. Nodes do not store the keys to unlock drives and the keys are never passed over the network. Two nodes participating in a cluster are required to access the key to disable encryption on a drive. The encryption management does not affect performance or efficiency on the cluster. If an encryption-enabled drive or node is removed from the cluster with the API, all data is secure erased and any data left on the drive cannot be read or accessed.
* Enabling or disabling encryption should be performed when the cluster is running and in a healthy state. Encryption can be enabled or disabled at your discretion and can be performed as often as you need.
* Note: This process is asynchronous and returns a response before encryption is enabled. The GetClusterInfo method can be used to poll the system to see when the process has completed.
**/
@Since("5")
@ConnectionType("Cluster")
public EnableEncryptionAtRestResult enableEncryptionAtRest();
/**
* GetSnmpInfo is used to return the current simple network management protocol (SNMP) configuration information.
*
* Note: GetSnmpInfo will be available for Element OS 8 and prior releases. It will be deprecated after Element OS 8. There are two new SNMP API methods that you should migrate over to. They are GetSnmpState and GetSnmpACL. Please see details in this document for their descriptions and usage.
**/
@Since("1")
@ConnectionType("Cluster")
public GetSnmpInfoResult getSnmpInfo();
/**
* ListClusterFaults is used to retrieve information about any faults detected on the cluster.
* With this method, both current and resolved faults can be retrieved. The system caches faults every 30 seconds.
**/
@Since("1")
@ConnectionType("Cluster")
public ListClusterFaultsResult listClusterFaults(final ListClusterFaultsRequest request);
/**
* ListClusterFaults is used to retrieve information about any faults detected on the cluster.
* With this method, both current and resolved faults can be retrieved. The system caches faults every 30 seconds.
**/
@Since("1")
@ConnectionType("Cluster")
public ListClusterFaultsResult listClusterFaults(
Optional exceptions
,
Optional bestPractices
,
Optional update
,
Optional faultTypes
);
/**
* GetDriveHardwareInfo returns all the hardware info for the given drive. This generally includes manufacturers, vendors, versions, and other associated hardware identification information.
**/
@Since("1")
@ConnectionType("Cluster")
public GetDriveHardwareInfoResult getDriveHardwareInfo(final GetDriveHardwareInfoRequest request);
/**
* GetDriveHardwareInfo returns all the hardware info for the given drive. This generally includes manufacturers, vendors, versions, and other associated hardware identification information.
**/
@Since("1")
@ConnectionType("Cluster")
public GetDriveHardwareInfoResult getDriveHardwareInfo(
Long driveID
);
/**
* GetDriveStats return high-level activity measurements for a single drive. Values are cumulative from the addition of the drive to the cluster. Some values are specific to Block Drives. Statistical data may not be returned for both block and metadata drives when running this method.
* For more information on which drive type returns which data, see Response Example (Block Drive) and Response Example (Volume Metadata Drive) in the SolidFire API guide.
**/
@Since("1")
@ConnectionType("Cluster")
public GetDriveStatsResult getDriveStats(final GetDriveStatsRequest request);
/**
* GetDriveStats return high-level activity measurements for a single drive. Values are cumulative from the addition of the drive to the cluster. Some values are specific to Block Drives. Statistical data may not be returned for both block and metadata drives when running this method.
* For more information on which drive type returns which data, see Response Example (Block Drive) and Response Example (Volume Metadata Drive) in the SolidFire API guide.
**/
@Since("1")
@ConnectionType("Cluster")
public GetDriveStatsResult getDriveStats(
Long driveID
);
/**
* ListDriveHardware returns all the drives connected to a node. Use this method on the cluster to return drive hardware information for all the drives on all nodes.
**/
@Since("7")
@ConnectionType("Cluster")
public ListDriveHardwareResult listDriveHardware(final ListDriveHardwareRequest request);
/**
* ListDriveHardware returns all the drives connected to a node. Use this method on the cluster to return drive hardware information for all the drives on all nodes.
**/
@Since("7")
@ConnectionType("Cluster")
public ListDriveHardwareResult listDriveHardware(
Boolean force
);
/**
* ListDrives allows you to retrieve the list of the drives that exist in the cluster's active nodes.
* This method returns drives that have been added as volume metadata or block drives as well as drives that have not been added and are available.
**/
@Since("1")
@ConnectionType("Cluster")
public ListDrivesResult listDrives();
/**
* AddDrives is used to add one or more available drives to the cluster enabling the drives to host a portion of the cluster's data.
* When you add a node to the cluster or install new drives in an existing node, the new drives are marked as "available" and must be added via AddDrives before they can be utilized.
* Use the "ListDrives" method to display drives that are "available" to be added.
* When you add multiple drives, it is more efficient to add them in a single "AddDrives" method call rather than multiple individual methods with a single drive each.
* This reduces the amount of data balancing that must occur to stabilize the storage load on the cluster.
*
* When you add a drive, the system automatically determines the "type" of drive it should be.
*
* The method returns immediately. However, it may take some time for the data in the cluster to be rebalanced using the newly added drives.
* As the new drive(s) are syncing on the system, you can use the "ListSyncJobs" method to see how the drive(s) are being rebalanced and the progress of adding the new drive.
**/
@Since("1")
@ConnectionType("Cluster")
public AddDrivesResult addDrives(final AddDrivesRequest request);
/**
* AddDrives is used to add one or more available drives to the cluster enabling the drives to host a portion of the cluster's data.
* When you add a node to the cluster or install new drives in an existing node, the new drives are marked as "available" and must be added via AddDrives before they can be utilized.
* Use the "ListDrives" method to display drives that are "available" to be added.
* When you add multiple drives, it is more efficient to add them in a single "AddDrives" method call rather than multiple individual methods with a single drive each.
* This reduces the amount of data balancing that must occur to stabilize the storage load on the cluster.
*
* When you add a drive, the system automatically determines the "type" of drive it should be.
*
* The method returns immediately. However, it may take some time for the data in the cluster to be rebalanced using the newly added drives.
* As the new drive(s) are syncing on the system, you can use the "ListSyncJobs" method to see how the drive(s) are being rebalanced and the progress of adding the new drive.
**/
@Since("1")
@ConnectionType("Cluster")
public AddDrivesResult addDrives(
NewDrive[] drives
);
/**
* GetDriveConfig is used to display drive information for expected slice and block drive counts as well as the number of slices and block drives that are currently connected to the node.
*
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("2")
@ConnectionType("Node")
public GetDriveConfigResult getDriveConfig();
/**
* You can use RemoveDrives to proactively remove drives that are part of the cluster.
* You may want to use this method when reducing cluster capacity or preparing to replace drives nearing the end of their service life.
* Any data on the drives is removed and migrated to other drives in the cluster before the drive is removed from the cluster. This is an asynchronous method.
* Depending on the total capacity of the drives being removed, it may take several minutes to migrate all of the data.
* Use the "GetAsyncResult" method to check the status of the remove operation.
*
* When removing multiple drives, use a single "RemoveDrives" method call rather than multiple individual methods with a single drive each.
* This reduces the amount of data balancing that must occur to even stabilize the storage load on the cluster.
*
* You can also remove drives with a "failed" status using "RemoveDrives".
* When you remove a drive with a "failed" status it is not returned to an "available" or "active" status.
* The drive is unavailable for use in the cluster.
*
* Use the "ListDrives" method to obtain the driveIDs for the drives you want to remove.
**/
@Since("1")
@ConnectionType("Cluster")
public AsyncHandleResult removeDrives(final RemoveDrivesRequest request);
/**
* You can use RemoveDrives to proactively remove drives that are part of the cluster.
* You may want to use this method when reducing cluster capacity or preparing to replace drives nearing the end of their service life.
* Any data on the drives is removed and migrated to other drives in the cluster before the drive is removed from the cluster. This is an asynchronous method.
* Depending on the total capacity of the drives being removed, it may take several minutes to migrate all of the data.
* Use the "GetAsyncResult" method to check the status of the remove operation.
*
* When removing multiple drives, use a single "RemoveDrives" method call rather than multiple individual methods with a single drive each.
* This reduces the amount of data balancing that must occur to even stabilize the storage load on the cluster.
*
* You can also remove drives with a "failed" status using "RemoveDrives".
* When you remove a drive with a "failed" status it is not returned to an "available" or "active" status.
* The drive is unavailable for use in the cluster.
*
* Use the "ListDrives" method to obtain the driveIDs for the drives you want to remove.
**/
@Since("1")
@ConnectionType("Cluster")
public AsyncHandleResult removeDrives(
Long[] drives
);
/**
* ResetDrives is used to pro-actively initialize drives and remove all data currently residing on the drive. The drive can then be reused in an existing node or used in an upgraded SolidFire node. This method requires the force=true parameter to be included in the method call.
*
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("6")
@ConnectionType("Node")
public ResetDrivesResult resetDrives(final ResetDrivesRequest request);
/**
* ResetDrives is used to pro-actively initialize drives and remove all data currently residing on the drive. The drive can then be reused in an existing node or used in an upgraded SolidFire node. This method requires the force=true parameter to be included in the method call.
*
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("6")
@ConnectionType("Node")
public ResetDrivesResult resetDrives(
String drives
,
Boolean force
);
/**
* SecureEraseDrives is used to remove any residual data from drives that have a status of "available." For example, when replacing a drive at its end-of-life that contained sensitive data.
* It uses a Security Erase Unit command to write a predetermined pattern to the drive and resets the encryption key on the drive. The method may take up to two minutes to complete, so it is an asynchronous method.
* The GetAsyncResult method can be used to check on the status of the secure erase operation.
*
* Use the "ListDrives" method to obtain the driveIDs for the drives you want to secure erase.
**/
@Since("5")
@ConnectionType("Cluster")
public AsyncHandleResult secureEraseDrives(final SecureEraseDrivesRequest request);
/**
* SecureEraseDrives is used to remove any residual data from drives that have a status of "available." For example, when replacing a drive at its end-of-life that contained sensitive data.
* It uses a Security Erase Unit command to write a predetermined pattern to the drive and resets the encryption key on the drive. The method may take up to two minutes to complete, so it is an asynchronous method.
* The GetAsyncResult method can be used to check on the status of the secure erase operation.
*
* Use the "ListDrives" method to obtain the driveIDs for the drives you want to secure erase.
**/
@Since("5")
@ConnectionType("Cluster")
public AsyncHandleResult secureEraseDrives(
Long[] drives
);
/**
* The TestDrives API method is used to run a hardware validation on all the drives on the node. Hardware failures on the drives are detected if present and they are reported in the results of the validation tests.
*
* Note: This test takes approximately 10 minutes.
*
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("5")
@ConnectionType("Node")
public TestDrivesResult testDrives(final TestDrivesRequest request);
/**
* The TestDrives API method is used to run a hardware validation on all the drives on the node. Hardware failures on the drives are detected if present and they are reported in the results of the validation tests.
*
* Note: This test takes approximately 10 minutes.
*
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("5")
@ConnectionType("Node")
public TestDrivesResult testDrives(
Optional minutes
);
/**
* You can use the GetClusterHardwareInfo method to retrieve the hardware status and information for all Fibre Channel nodes, iSCSI nodes and drives in the cluster. This generally includes manufacturers, vendors, versions, and other associated hardware identification information.
**/
@Since("1")
@ConnectionType("Cluster")
public GetClusterHardwareInfoResult getClusterHardwareInfo(final GetClusterHardwareInfoRequest request);
/**
* You can use the GetClusterHardwareInfo method to retrieve the hardware status and information for all Fibre Channel nodes, iSCSI nodes and drives in the cluster. This generally includes manufacturers, vendors, versions, and other associated hardware identification information.
**/
@Since("1")
@ConnectionType("Cluster")
public GetClusterHardwareInfoResult getClusterHardwareInfo(
Optional type
);
/**
* GetHardwareConfig enables you to display the hardware configuration information for a node. NOTE: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("5")
@ConnectionType("Node")
public GetHardwareConfigResult getHardwareConfig();
/**
* GetNodeHardwareInfo is used to return all the hardware info and status for the node specified. This generally includes manufacturers, vendors, versions, and other associated hardware identification information.
**/
@Since("1")
@ConnectionType("Cluster")
public GetNodeHardwareInfoResult getNodeHardwareInfo(final GetNodeHardwareInfoRequest request);
/**
* GetNodeHardwareInfo is used to return all the hardware info and status for the node specified. This generally includes manufacturers, vendors, versions, and other associated hardware identification information.
**/
@Since("1")
@ConnectionType("Cluster")
public GetNodeHardwareInfoResult getNodeHardwareInfo(
Long nodeID
);
/**
* GetNvramInfo allows you to retrieve information from each node about the NVRAM card.
**/
@Since("5")
@ConnectionType("Node")
public GetNvramInfoResult getNvramInfo();
/**
* CreateInitiators enables you to create multiple new initiator IQNs or World Wide Port Names (WWPNs) and optionally assign them aliases and attributes. When you use CreateInitiators to create new initiators, you can also add them to volume access groups.
* If CreateInitiators fails to create one of the initiators provided in the parameter, the method returns an error and does not create any initiators (no partial completion is possible).
**/
@Since("9")
@ConnectionType("Cluster")
public CreateInitiatorsResult createInitiators(final CreateInitiatorsRequest request);
/**
* CreateInitiators enables you to create multiple new initiator IQNs or World Wide Port Names (WWPNs) and optionally assign them aliases and attributes. When you use CreateInitiators to create new initiators, you can also add them to volume access groups.
* If CreateInitiators fails to create one of the initiators provided in the parameter, the method returns an error and does not create any initiators (no partial completion is possible).
**/
@Since("9")
@ConnectionType("Cluster")
public CreateInitiatorsResult createInitiators(
CreateInitiator[] initiators
);
/**
* DeleteInitiators enables you to delete one or more initiators from the system (and from any associated volumes or volume access groups).
* If DeleteInitiators fails to delete one of the initiators provided in the parameter, the system returns an error and does not delete any initiators (no partial completion is possible).
**/
@Since("9")
@ConnectionType("Cluster")
public DeleteInitiatorsResult deleteInitiators(final DeleteInitiatorsRequest request);
/**
* DeleteInitiators enables you to delete one or more initiators from the system (and from any associated volumes or volume access groups).
* If DeleteInitiators fails to delete one of the initiators provided in the parameter, the system returns an error and does not delete any initiators (no partial completion is possible).
**/
@Since("9")
@ConnectionType("Cluster")
public DeleteInitiatorsResult deleteInitiators(
Long[] initiators
);
/**
* ListInitiators enables you to list initiator IQNs or World Wide Port Names (WWPNs).
**/
@Since("9")
@ConnectionType("Cluster")
public ListInitiatorsResult listInitiators(final ListInitiatorsRequest request);
/**
* ListInitiators enables you to list initiator IQNs or World Wide Port Names (WWPNs).
**/
@Since("9")
@ConnectionType("Cluster")
public ListInitiatorsResult listInitiators(
Optional startInitiatorID
,
Optional limit
,
Optional initiators
);
/**
* ModifyInitiators enables you to change the attributes of an existing initiator. You cannot change the name of an existing initiator. If you need to change the name of an initiator, delete the existing initiator with DeleteInitiators and create a new one with CreateInitiators.
* If ModifyInitiators fails to change one of the initiators provided in the parameter, the method returns an error and does not create any initiators (no partial completion is possible).
**/
@Since("9")
@ConnectionType("Cluster")
public ModifyInitiatorsResult modifyInitiators(final ModifyInitiatorsRequest request);
/**
* ModifyInitiators enables you to change the attributes of an existing initiator. You cannot change the name of an existing initiator. If you need to change the name of an initiator, delete the existing initiator with DeleteInitiators and create a new one with CreateInitiators.
* If ModifyInitiators fails to change one of the initiators provided in the parameter, the method returns an error and does not create any initiators (no partial completion is possible).
**/
@Since("9")
@ConnectionType("Cluster")
public ModifyInitiatorsResult modifyInitiators(
ModifyInitiator[] initiators
);
/**
* The DisableLdapAuthentication method is used disable LDAP authentication and remove all LDAP configuration settings. This call will not remove any configured cluster admin accounts (user or group). However, those cluster admin accounts will no longer be able to log in.
**/
@Since("7")
@ConnectionType("Cluster")
public DisableLdapAuthenticationResult disableLdapAuthentication();
/**
* The GetLdapConfiguration is used to get the LDAP configuration currently active on the cluster.
**/
@Since("7")
@ConnectionType("Cluster")
public GetLdapConfigurationResult getLdapConfiguration();
/**
* The TestLdapAuthentication is used to verify the currently enabled LDAP authentication configuration settings are correct. If the configuration settings are correct, the API call returns a list of the groups the tested user is a member of.
**/
@Since("7")
@ConnectionType("Cluster")
public TestLdapAuthenticationResult testLdapAuthentication(final TestLdapAuthenticationRequest request);
/**
* The TestLdapAuthentication is used to verify the currently enabled LDAP authentication configuration settings are correct. If the configuration settings are correct, the API call returns a list of the groups the tested user is a member of.
**/
@Since("7")
@ConnectionType("Cluster")
public TestLdapAuthenticationResult testLdapAuthentication(
String username
,
String password
,
Optional ldapConfiguration
);
/**
* AddLdapClusterAdmin is used to add a new LDAP Cluster Admin. An LDAP Cluster Admin can be used to manage the cluster via the API and management tools. LDAP Cluster Admins are completely separate and unrelated to standard tenant accounts.
*
* An LDAP group that has been defined in Active Directory can also be added using this API method. The access level that is given to the group will be passed to the individual users in the LDAP group.
**/
@Since("8")
@ConnectionType("Cluster")
public AddLdapClusterAdminResult addLdapClusterAdmin(final AddLdapClusterAdminRequest request);
/**
* AddLdapClusterAdmin is used to add a new LDAP Cluster Admin. An LDAP Cluster Admin can be used to manage the cluster via the API and management tools. LDAP Cluster Admins are completely separate and unrelated to standard tenant accounts.
*
* An LDAP group that has been defined in Active Directory can also be added using this API method. The access level that is given to the group will be passed to the individual users in the LDAP group.
**/
@Since("8")
@ConnectionType("Cluster")
public AddLdapClusterAdminResult addLdapClusterAdmin(
String username
,
String[] access
,
Optional acceptEula
,
Optional> attributes
);
/**
* The EnableLdapAuthentication method is used to configure an LDAP server connection to use for LDAP authentication to a SolidFire cluster. Users that are members on the LDAP server can then log in to a SolidFire storage system using their LDAP authentication userid and password.
**/
@Since("7")
@ConnectionType("Cluster")
public EnableLdapAuthenticationResult enableLdapAuthentication(final EnableLdapAuthenticationRequest request);
/**
* The EnableLdapAuthentication method is used to configure an LDAP server connection to use for LDAP authentication to a SolidFire cluster. Users that are members on the LDAP server can then log in to a SolidFire storage system using their LDAP authentication userid and password.
**/
@Since("7")
@ConnectionType("Cluster")
public EnableLdapAuthenticationResult enableLdapAuthentication(
Optional authType
,
Optional groupSearchBaseDN
,
Optional groupSearchCustomFilter
,
Optional groupSearchType
,
Optional searchBindDN
,
Optional searchBindPassword
,
String[] serverURIs
,
Optional userDNTemplate
,
Optional userSearchBaseDN
,
Optional userSearchFilter
);
/**
* GetLoginSessionInfo is used to return the period of time a log in authentication is valid for both log in shells and the TUI.
**/
@Since("7")
@ConnectionType("Cluster")
public GetLoginSessionInfoResult getLoginSessionInfo();
/**
* GetRemoteLoggingHosts is used to retrieve the current list of log servers.
**/
@Since("1")
@ConnectionType("Cluster")
public GetRemoteLoggingHostsResult getRemoteLoggingHosts();
/**
* SetLoginSessionInfo is used to set the period of time a log in authentication is valid. After the log in period elapses without activity on the system the authentication will expire. New log in credentials will be required for continued access to the cluster once the timeout period has elapsed.
**/
@Since("7")
@ConnectionType("Cluster")
public SetLoginSessionInfoResult setLoginSessionInfo(final SetLoginSessionInfoRequest request);
/**
* SetLoginSessionInfo is used to set the period of time a log in authentication is valid. After the log in period elapses without activity on the system the authentication will expire. New log in credentials will be required for continued access to the cluster once the timeout period has elapsed.
**/
@Since("7")
@ConnectionType("Cluster")
public SetLoginSessionInfoResult setLoginSessionInfo(
String timeout
);
/**
* RemoteLoggingHosts is used to configure remote logging from the nodes in the storage cluster to a centralized log server or servers. Remote logging is performed over TCP using the default port 514. This API does not add to the existing logging hosts. Rather, it replaces what currently exists with new values specified by this API method. You can use the GetRemoteLoggingHosts to determine what the current logging hosts are and then use the SetRemoteLoggingHosts to set the desired list of current and new logging hosts.
**/
@Since("1")
@ConnectionType("Cluster")
public SetRemoteLoggingHostsResult setRemoteLoggingHosts(final SetRemoteLoggingHostsRequest request);
/**
* RemoteLoggingHosts is used to configure remote logging from the nodes in the storage cluster to a centralized log server or servers. Remote logging is performed over TCP using the default port 514. This API does not add to the existing logging hosts. Rather, it replaces what currently exists with new values specified by this API method. You can use the GetRemoteLoggingHosts to determine what the current logging hosts are and then use the SetRemoteLoggingHosts to set the desired list of current and new logging hosts.
**/
@Since("1")
@ConnectionType("Cluster")
public SetRemoteLoggingHostsResult setRemoteLoggingHosts(
LoggingServer[] remoteHosts
);
/**
* The ListFibreChannelPortInfo is used to return information about the Fibre Channel ports. The API method is intended for use on individual nodes; userid and password is required for access to individual Fibre Channel nodes.
**/
@Since("8")
@ConnectionType("Cluster")
public ListFibreChannelPortInfoResult listFibreChannelPortInfo();
/**
* The ListFibreChannelSessions is used to return information about the active Fibre Channel sessions on a cluster.
**/
@Since("7")
@ConnectionType("Cluster")
public ListFibreChannelSessionsResult listFibreChannelSessions();
/**
* ListISCSISessions is used to return iSCSI connection information for volumes in the cluster.
**/
@Since("1")
@ConnectionType("Cluster")
public ListISCSISessionsResult listISCSISessions();
/**
* The ListNetworkInterfaces API method is used to return information about each network interface on a node. The API method is intended for use on individual nodes.
**/
@Since("7")
@ConnectionType("Node")
public ListNetworkInterfacesResult listNetworkInterfaces();
/**
* The ListNodeFibreChannelPortInfo is used to return information about the Fibre Channel ports. The API method is intended for use on individual nodes; userid and password is required for access to individual Fibre Channel nodes.
**/
@Since("7")
@ConnectionType("Node")
public ListNodeFibreChannelPortInfoResult listNodeFibreChannelPortInfo();
/**
* GetNodeStats is used to return the high-level activity measurements for a single node.
**/
@Since("1")
@ConnectionType("Cluster")
public GetNodeStatsResult getNodeStats(final GetNodeStatsRequest request);
/**
* GetNodeStats is used to return the high-level activity measurements for a single node.
**/
@Since("1")
@ConnectionType("Cluster")
public GetNodeStatsResult getNodeStats(
Long nodeID
);
/**
* GetOrigin enables you to retrieve the origination certificate for where the node was built.NOTE: The GetOrigin method may return "null" if there is no origination certification.
**/
@Since("9")
@ConnectionType("Cluster")
public GetOriginResult getOrigin(final GetOriginRequest request);
/**
* GetOrigin enables you to retrieve the origination certificate for where the node was built.NOTE: The GetOrigin method may return "null" if there is no origination certification.
**/
@Since("9")
@ConnectionType("Cluster")
public GetOriginResult getOrigin(
Boolean force
);
/**
* ListActiveNodes returns the list of currently active nodes that are in the cluster.
**/
@Since("1")
@ConnectionType("Cluster")
public ListActiveNodesResult listActiveNodes();
/**
* ListAllNodes enables you to retrieve a list of active and pending nodes in the cluster.
**/
@Since("1")
@ConnectionType("Cluster")
public ListAllNodesResult listAllNodes();
/**
* ListNodeStats is used to return the high-level activity measurements for all nodes in a cluster.
**/
@Since("6")
@ConnectionType("Cluster")
public ListNodeStatsResult listNodeStats();
/**
* ListPendingActiveNodes returns the list of nodes in the cluster that are currently in the PendingActive state, between the pending and active states. These are nodes that are currently being returned to the factory image.
**/
@Since("9")
@ConnectionType("Cluster")
public ListPendingActiveNodesResult listPendingActiveNodes();
/**
* Gets the list of pending nodes.
* Pending nodes are running and configured to join the cluster, but have not been added via the AddNodes method.
**/
@Since("1")
@ConnectionType("Cluster")
public ListPendingNodesResult listPendingNodes();
/**
* GetBootstrapConfig returns the cluster name and node name from the bootstrap configuration file. This API method should be performed on an individual node before it has been configured into a cluster. The resulting information from this method is used in the Cluster Configuration UI when the cluster is eventually created.
**/
@Since("2")
@ConnectionType("Both")
public GetBootstrapConfigResult getBootstrapConfig();
/**
* AddNodes is used to add one or more new nodes to the cluster. When a node is not configured and starts up for the first time you are prompted to configure the node. Once a node is configured it is registered as a "pending node" with the cluster.
*
* Adding a node to a cluster that has been set up for virtual networking will require a sufficient number of virtual storage IP addresses to allocate a virtual IP to the new node. If there are no virtual IP addresses available for the new node, the AddNode operation will not complete successfully. Use the "ModifyVirtualNetwork" method to add more storage IP addresses to your virtual network.
*
* The software version on each node in a cluster must be compatible. Run the "ListAllNodes" API to see what versions of software are currently running on the cluster nodes. For an explanation of software version compatibility, see "Node Versioning and Compatibility" in the Element API guide.
*
* Once a node has been added, the drives on the node are made available and can then be added via the "AddDrives" method to increase the storage capacity of the cluster.
*
* Note: It may take several seconds after adding a new Node for it to start up and register the drives as being available.
**/
@Since("1")
@ConnectionType("Cluster")
public AddNodesResult addNodes(final AddNodesRequest request);
/**
* AddNodes is used to add one or more new nodes to the cluster. When a node is not configured and starts up for the first time you are prompted to configure the node. Once a node is configured it is registered as a "pending node" with the cluster.
*
* Adding a node to a cluster that has been set up for virtual networking will require a sufficient number of virtual storage IP addresses to allocate a virtual IP to the new node. If there are no virtual IP addresses available for the new node, the AddNode operation will not complete successfully. Use the "ModifyVirtualNetwork" method to add more storage IP addresses to your virtual network.
*
* The software version on each node in a cluster must be compatible. Run the "ListAllNodes" API to see what versions of software are currently running on the cluster nodes. For an explanation of software version compatibility, see "Node Versioning and Compatibility" in the Element API guide.
*
* Once a node has been added, the drives on the node are made available and can then be added via the "AddDrives" method to increase the storage capacity of the cluster.
*
* Note: It may take several seconds after adding a new Node for it to start up and register the drives as being available.
**/
@Since("1")
@ConnectionType("Cluster")
public AddNodesResult addNodes(
Long[] pendingNodes
);
/**
* The GetConfig API method is used to retrieve all the configuration information for the node. This one API method includes the same information available in both "GetClusterConfig" and "GetNetworkConfig" methods.
*
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("5")
@ConnectionType("Node")
public GetConfigResult getConfig();
/**
* The GetNetworkConfig API method is used to display the network configuration information for a node.
*
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("5")
@ConnectionType("Node")
public GetNetworkConfigResult getNetworkConfig();
/**
* GetPendingOperation is used to detect an operation on a node that is currently in progress. This method can also be used to report back when an operation has completed.
*
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("5")
@ConnectionType("Node")
public GetPendingOperationResult getPendingOperation();
/**
* RemoveNodes is used to remove one or more nodes that should no longer participate in the cluster. Before removing a node, all drives it contains must first be removed with "RemoveDrives" method. A node cannot be removed until the RemoveDrives process has completed and all data has been migrated away from the node.
*
* Once removed, a node registers itself as a pending node and can be added again, or shut down which removes it from the "Pending Node" list.
**/
@Since("1")
@ConnectionType("Cluster")
public RemoveNodesResult removeNodes(final RemoveNodesRequest request);
/**
* RemoveNodes is used to remove one or more nodes that should no longer participate in the cluster. Before removing a node, all drives it contains must first be removed with "RemoveDrives" method. A node cannot be removed until the RemoveDrives process has completed and all data has been migrated away from the node.
*
* Once removed, a node registers itself as a pending node and can be added again, or shut down which removes it from the "Pending Node" list.
**/
@Since("1")
@ConnectionType("Cluster")
public RemoveNodesResult removeNodes(
Long[] nodes
);
/**
* The SetConfig API method is used to set all the configuration information for the node. This includes the same information available via calls to SetClusterConfig and SetNetworkConfig in one API method.
*
* Warning! Changing the 'bond-mode' on a node can cause a temporary loss of network connectivity. Caution should be taken when using this method.
*
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("5")
@ConnectionType("Node")
public SetConfigResult setConfig(final SetConfigRequest request);
/**
* The SetConfig API method is used to set all the configuration information for the node. This includes the same information available via calls to SetClusterConfig and SetNetworkConfig in one API method.
*
* Warning! Changing the 'bond-mode' on a node can cause a temporary loss of network connectivity. Caution should be taken when using this method.
*
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("5")
@ConnectionType("Node")
public SetConfigResult setConfig(
Config config
);
/**
* The "SetNetworkConfig" method is used to set the network configuration for a node. To see the states in which these objects can be modified, see "Network Object for 1G and 10G Interfaces" on page 109 of the Element API. To display the current network settings for a node, run the "GetNetworkConfig" method.
*
* WARNING! Changing the "bond-mode" on a node can cause a temporary loss of network connectivity. Caution should be taken when using this method.
*
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("5")
@ConnectionType("Node")
public SetNetworkConfigResult setNetworkConfig(final SetNetworkConfigRequest request);
/**
* The "SetNetworkConfig" method is used to set the network configuration for a node. To see the states in which these objects can be modified, see "Network Object for 1G and 10G Interfaces" on page 109 of the Element API. To display the current network settings for a node, run the "GetNetworkConfig" method.
*
* WARNING! Changing the "bond-mode" on a node can cause a temporary loss of network connectivity. Caution should be taken when using this method.
*
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("5")
@ConnectionType("Node")
public SetNetworkConfigResult setNetworkConfig(
Network network
);
/**
* The CompleteClusterPairing method is the second step in the cluster pairing process.
* Use this method with the encoded key received from the "StartClusterPairing" API method to complete the cluster pairing process.
**/
@Since("6")
@ConnectionType("Cluster")
public CompleteClusterPairingResult completeClusterPairing(final CompleteClusterPairingRequest request);
/**
* The CompleteClusterPairing method is the second step in the cluster pairing process.
* Use this method with the encoded key received from the "StartClusterPairing" API method to complete the cluster pairing process.
**/
@Since("6")
@ConnectionType("Cluster")
public CompleteClusterPairingResult completeClusterPairing(
String clusterPairingKey
);
/**
* CompleteVolumePairing is used to complete the pairing of two volumes.
**/
@Since("6")
@ConnectionType("Cluster")
public CompleteVolumePairingResult completeVolumePairing(final CompleteVolumePairingRequest request);
/**
* CompleteVolumePairing is used to complete the pairing of two volumes.
**/
@Since("6")
@ConnectionType("Cluster")
public CompleteVolumePairingResult completeVolumePairing(
String volumePairingKey
,
Long volumeID
);
/**
* ListActivePairedVolumes is used to list all of the active volumes paired with a volume.
* Volumes listed in the return for this method include volumes with active and pending pairings.
**/
@Since("6")
@ConnectionType("Cluster")
public ListActivePairedVolumesResult listActivePairedVolumes();
/**
* ListClusterPairs is used to list all of the clusters a cluster is paired with.
* This method returns information about active and pending cluster pairings, such as statistics about the current pairing as well as the connectivity and latency (in milliseconds) of the cluster pairing.
**/
@Since("6")
@ConnectionType("Cluster")
public ListClusterPairsResult listClusterPairs();
/**
* RemoveVolumePair is used to remove the remote pairing between two volumes.
* When the volume pairing information is removed, data is no longer replicated to or from the volume.
* This method should be run on both the source and target volumes that are paired together.
**/
@Since("6")
@ConnectionType("Cluster")
public RemoveVolumePairResult removeVolumePair(final RemoveVolumePairRequest request);
/**
* RemoveVolumePair is used to remove the remote pairing between two volumes.
* When the volume pairing information is removed, data is no longer replicated to or from the volume.
* This method should be run on both the source and target volumes that are paired together.
**/
@Since("6")
@ConnectionType("Cluster")
public RemoveVolumePairResult removeVolumePair(
Long volumeID
);
/**
* StartClusterPairing is used to create an encoded key from a cluster that is used to pair with another cluster.
* The key created from this API method is used in the "CompleteClusterPairing" API method to establish a cluster pairing.
* You can pair a cluster with a maximum of four other SolidFire clusters.
**/
@Since("6")
@ConnectionType("Cluster")
public StartClusterPairingResult startClusterPairing();
/**
* ModifyVolumePair is used to pause or restart replication between a pair of volumes.
**/
@Since("6")
@ConnectionType("Cluster")
public ModifyVolumePairResult modifyVolumePair(final ModifyVolumePairRequest request);
/**
* ModifyVolumePair is used to pause or restart replication between a pair of volumes.
**/
@Since("6")
@ConnectionType("Cluster")
public ModifyVolumePairResult modifyVolumePair(
Long volumeID
,
Optional pausedManual
,
Optional mode
);
/**
* You can use the RemoveClusterPair method to close the open connections between two paired clusters.
* Note: Before you remove a cluster pair, you must first remove all volume pairing to the clusters with the "RemoveVolumePair" API method.
**/
@Since("6")
@ConnectionType("Cluster")
public RemoveClusterPairResult removeClusterPair(final RemoveClusterPairRequest request);
/**
* You can use the RemoveClusterPair method to close the open connections between two paired clusters.
* Note: Before you remove a cluster pair, you must first remove all volume pairing to the clusters with the "RemoveVolumePair" API method.
**/
@Since("6")
@ConnectionType("Cluster")
public RemoveClusterPairResult removeClusterPair(
Long clusterPairID
);
/**
* StartVolumePairing is used to create an encoded key from a volume that is used to pair with another volume.
* The key that this method creates is used in the "CompleteVolumePairing" API method to establish a volume pairing.
**/
@Since("6")
@ConnectionType("Cluster")
public StartVolumePairingResult startVolumePairing(final StartVolumePairingRequest request);
/**
* StartVolumePairing is used to create an encoded key from a volume that is used to pair with another volume.
* The key that this method creates is used in the "CompleteVolumePairing" API method to establish a volume pairing.
**/
@Since("6")
@ConnectionType("Cluster")
public StartVolumePairingResult startVolumePairing(
Long volumeID
,
Optional mode
);
/**
* Gets protocol endpoints in the system
* If protocolEndpointIDs isn't specified all protocol endpoints
* are returned. Else the supplied protocolEndpointIDs are.
**/
@Since("9")
@ConnectionType("Cluster")
public ListProtocolEndpointsResult listProtocolEndpoints(final ListProtocolEndpointsRequest request);
/**
* Gets protocol endpoints in the system
* If protocolEndpointIDs isn't specified all protocol endpoints
* are returned. Else the supplied protocolEndpointIDs are.
**/
@Since("9")
@ConnectionType("Cluster")
public ListProtocolEndpointsResult listProtocolEndpoints(
Optional protocolEndpointIDs
);
/**
* Allows you to reset a node to the SolidFire factory settings. All data will be deleted from the node when you call this method. A node participating in a cluster cannot be reset.
**/
@Since("5")
@ConnectionType("Cluster")
public ResetNodeResult resetNode(final ResetNodeRequest request);
/**
* Allows you to reset a node to the SolidFire factory settings. All data will be deleted from the node when you call this method. A node participating in a cluster cannot be reset.
**/
@Since("5")
@ConnectionType("Cluster")
public ResetNodeResult resetNode(
String build
,
Boolean force
,
String option
);
/**
* The RestartNetworking API method is used to restart the networking services on a node.WARNING! This method restarts all networking services on a node, causing temporary loss of networking connectivity. Exercise caution when using this method.
**/
@Since("5")
@ConnectionType("Node")
public java.util.Map restartNetworking(final RestartNetworkingRequest request);
/**
* The RestartNetworking API method is used to restart the networking services on a node.WARNING! This method restarts all networking services on a node, causing temporary loss of networking connectivity. Exercise caution when using this method.
**/
@Since("5")
@ConnectionType("Node")
public java.util.Map restartNetworking(
Boolean force
);
/**
* The RestartServices API method is used to restart the Element services on a node.Caution: This method causes temporary node services interruption. Exercise caution when using this method.
**/
@Since("5")
@ConnectionType("Node")
public java.util.Map restartServices(final RestartServicesRequest request);
/**
* The RestartServices API method is used to restart the Element services on a node.Caution: This method causes temporary node services interruption. Exercise caution when using this method.
**/
@Since("5")
@ConnectionType("Node")
public java.util.Map restartServices(
Boolean force
,
Optional service
,
Optional action
);
/**
* The Shutdown API method enables you to restart or shutdown a node that has not yet been added to a cluster. To use this method, login in to the MIP for the pending node and enter the "shutdown" method with either the "restart" or "halt" options in the following table.
**/
@Since("1")
@ConnectionType("Cluster")
public ShutdownResult shutdown(final ShutdownRequest request);
/**
* The Shutdown API method enables you to restart or shutdown a node that has not yet been added to a cluster. To use this method, login in to the MIP for the pending node and enter the "shutdown" method with either the "restart" or "halt" options in the following table.
**/
@Since("1")
@ConnectionType("Cluster")
public ShutdownResult shutdown(
Long[] nodes
,
Optional option
);
/**
* List the services in the cluster.
**/
@Since("1")
@ConnectionType("Cluster")
public ListServicesResult listServices();
/**
* DeleteSnapshot is used to delete a snapshot.
* A snapshot that is currently the "active" snapshot cannot be deleted.
* You must rollback and make another snapshot "active" before the current snapshot can be deleted.
* To rollback a snapshot, use RollbackToSnapshot.
**/
@Since("6")
@ConnectionType("Cluster")
public DeleteSnapshotResult deleteSnapshot(final DeleteSnapshotRequest request);
/**
* DeleteSnapshot is used to delete a snapshot.
* A snapshot that is currently the "active" snapshot cannot be deleted.
* You must rollback and make another snapshot "active" before the current snapshot can be deleted.
* To rollback a snapshot, use RollbackToSnapshot.
**/
@Since("6")
@ConnectionType("Cluster")
public DeleteSnapshotResult deleteSnapshot(
Long snapshotID
);
/**
* GetSchedule is used to return information about a scheduled snapshot that has been created. You can see information about a specified schedule if there are many snapshot schedules in the system. You can include more than one schedule with this method by specifying additional scheduleIDs to the parameter.
**/
@Since("8")
@ConnectionType("Cluster")
public GetScheduleResult getSchedule(final GetScheduleRequest request);
/**
* GetSchedule is used to return information about a scheduled snapshot that has been created. You can see information about a specified schedule if there are many snapshot schedules in the system. You can include more than one schedule with this method by specifying additional scheduleIDs to the parameter.
**/
@Since("8")
@ConnectionType("Cluster")
public GetScheduleResult getSchedule(
Long scheduleID
);
/**
* ListGroupSnapshots is used to return information about all group snapshots that have been created.
**/
@Since("7")
@ConnectionType("Cluster")
public ListGroupSnapshotsResult listGroupSnapshots(final ListGroupSnapshotsRequest request);
/**
* ListGroupSnapshots is used to return information about all group snapshots that have been created.
**/
@Since("7")
@ConnectionType("Cluster")
public ListGroupSnapshotsResult listGroupSnapshots(
Optional volumeID
);
/**
* ListSchedule is used to return information about all scheduled snapshots that have been created.
**/
@Since("8")
@ConnectionType("Cluster")
public ListSchedulesResult listSchedules();
/**
* ListSnapshots is used to return the attributes of each snapshot taken on the volume.
**/
@Since("6")
@ConnectionType("Cluster")
public ListSnapshotsResult listSnapshots(final ListSnapshotsRequest request);
/**
* ListSnapshots is used to return the attributes of each snapshot taken on the volume.
**/
@Since("6")
@ConnectionType("Cluster")
public ListSnapshotsResult listSnapshots(
Optional volumeID
);
/**
* CreateGroupSnapshot is used to create a point-in-time copy of a group of volumes.
* The snapshot created can then be used later as a backup or rollback to ensure the data on the group of volumes is consistent for the point in time in which the snapshot was created.
*
* Note: Creating a group snapshot is allowed if cluster fullness is at stage 2 or 3.
* Snapshots are not created when cluster fullness is at stage 4 or 5.
**/
@Since("7")
@ConnectionType("Cluster")
public CreateGroupSnapshotResult createGroupSnapshot(final CreateGroupSnapshotRequest request);
/**
* CreateGroupSnapshot is used to create a point-in-time copy of a group of volumes.
* The snapshot created can then be used later as a backup or rollback to ensure the data on the group of volumes is consistent for the point in time in which the snapshot was created.
*
* Note: Creating a group snapshot is allowed if cluster fullness is at stage 2 or 3.
* Snapshots are not created when cluster fullness is at stage 4 or 5.
**/
@Since("7")
@ConnectionType("Cluster")
public CreateGroupSnapshotResult createGroupSnapshot(
Long[] volumes
,
Optional name
,
Optional enableRemoteReplication
,
Optional retention
,
Optional> attributes
);
/**
* CreateSchedule is used to create a schedule that will autonomously make a snapshot of a volume at a defined interval.
*
* The snapshot created can be used later as a backup or rollback to ensure the data on a volume or group of volumes is consistent for the point in time in which the snapshot was created.
*
* Note: Creating a snapshot is allowed if cluster fullness is at stage 2 or 3. Snapshots are not created when cluster fullness is at stage 4 or 5.
**/
@Since("8")
@ConnectionType("Cluster")
public CreateScheduleResult createSchedule(final CreateScheduleRequest request);
/**
* CreateSchedule is used to create a schedule that will autonomously make a snapshot of a volume at a defined interval.
*
* The snapshot created can be used later as a backup or rollback to ensure the data on a volume or group of volumes is consistent for the point in time in which the snapshot was created.
*
* Note: Creating a snapshot is allowed if cluster fullness is at stage 2 or 3. Snapshots are not created when cluster fullness is at stage 4 or 5.
**/
@Since("8")
@ConnectionType("Cluster")
public CreateScheduleResult createSchedule(
Schedule schedule
);
/**
* CreateSnapshot is used to create a point-in-time copy of a volume.
* A snapshot can be created from any volume or from an existing snapshot.
*
* Note: Creating a snapshot is allowed if cluster fullness is at stage 2 or 3.
* Snapshots are not created when cluster fullness is at stage 4 or 5.
**/
@Since("6")
@ConnectionType("Cluster")
public CreateSnapshotResult createSnapshot(final CreateSnapshotRequest request);
/**
* CreateSnapshot is used to create a point-in-time copy of a volume.
* A snapshot can be created from any volume or from an existing snapshot.
*
* Note: Creating a snapshot is allowed if cluster fullness is at stage 2 or 3.
* Snapshots are not created when cluster fullness is at stage 4 or 5.
**/
@Since("6")
@ConnectionType("Cluster")
public CreateSnapshotResult createSnapshot(
Long volumeID
,
Optional snapshotID
,
Optional name
,
Optional enableRemoteReplication
,
Optional retention
,
Optional> attributes
);
/**
* DeleteGroupSnapshot is used to delete a group snapshot.
* The saveMembers parameter can be used to preserve all the snapshots that
* were made for the volumes in the group but the group association will be removed.
**/
@Since("7")
@ConnectionType("Cluster")
public DeleteGroupSnapshotResult deleteGroupSnapshot(final DeleteGroupSnapshotRequest request);
/**
* DeleteGroupSnapshot is used to delete a group snapshot.
* The saveMembers parameter can be used to preserve all the snapshots that
* were made for the volumes in the group but the group association will be removed.
**/
@Since("7")
@ConnectionType("Cluster")
public DeleteGroupSnapshotResult deleteGroupSnapshot(
Long groupSnapshotID
,
Boolean saveMembers
);
/**
* ModifyGroupSnapshot is used to change the attributes currently assigned to a group snapshot.
**/
@Since("8")
@ConnectionType("Cluster")
public ModifyGroupSnapshotResult modifyGroupSnapshot(final ModifyGroupSnapshotRequest request);
/**
* ModifyGroupSnapshot is used to change the attributes currently assigned to a group snapshot.
**/
@Since("8")
@ConnectionType("Cluster")
public ModifyGroupSnapshotResult modifyGroupSnapshot(
Long groupSnapshotID
,
Optional expirationTime
,
Optional enableRemoteReplication
);
/**
* ModifySchedule is used to change the intervals at which a scheduled snapshot occurs. This allows for adjustment to the snapshot frequency and retention.
**/
@Since("8")
@ConnectionType("Cluster")
public ModifyScheduleResult modifySchedule(final ModifyScheduleRequest request);
/**
* ModifySchedule is used to change the intervals at which a scheduled snapshot occurs. This allows for adjustment to the snapshot frequency and retention.
**/
@Since("8")
@ConnectionType("Cluster")
public ModifyScheduleResult modifySchedule(
Schedule schedule
);
/**
* ModifySnapshot is used to change the attributes currently assigned to a snapshot.
* Use this API method to enable the snapshots created on the Read/Write (source) volume to be remotely replicated to a target SolidFire storage system.
**/
@Since("8")
@ConnectionType("Cluster")
public ModifySnapshotResult modifySnapshot(final ModifySnapshotRequest request);
/**
* ModifySnapshot is used to change the attributes currently assigned to a snapshot.
* Use this API method to enable the snapshots created on the Read/Write (source) volume to be remotely replicated to a target SolidFire storage system.
**/
@Since("8")
@ConnectionType("Cluster")
public ModifySnapshotResult modifySnapshot(
Long snapshotID
,
Optional expirationTime
,
Optional enableRemoteReplication
);
/**
* RollbackToGroupSnapshot is used to roll back each individual volume in a snapshot group to a copy of their individual snapshots.
*
* Note: Creating a snapshot is allowed if cluster fullness is at stage 2 or 3.
* Snapshots are not created when cluster fullness is at stage 4 or 5.
**/
@Since("7")
@ConnectionType("Cluster")
public CreateGroupSnapshotResult rollbackToGroupSnapshot(final RollbackToGroupSnapshotRequest request);
/**
* RollbackToGroupSnapshot is used to roll back each individual volume in a snapshot group to a copy of their individual snapshots.
*
* Note: Creating a snapshot is allowed if cluster fullness is at stage 2 or 3.
* Snapshots are not created when cluster fullness is at stage 4 or 5.
**/
@Since("7")
@ConnectionType("Cluster")
public CreateGroupSnapshotResult rollbackToGroupSnapshot(
Long groupSnapshotID
,
Boolean saveCurrentState
,
Optional name
,
Optional> attributes
);
/**
* RollbackToSnapshot is used to make an existing snapshot the "active" volume image. This method creates a new
* snapshot from an existing snapshot. The new snapshot becomes "active" and the existing snapshot is preserved until
* it is manually deleted. The previously "active" snapshot is deleted unless the parameter saveCurrentState is set with
* a value of "true."
* Note: Creating a snapshot is allowed if cluster fullness is at stage 2 or 3.
* Snapshots are not created when cluster fullness is at stage 4 or 5.
**/
@Since("6")
@ConnectionType("Cluster")
public CreateSnapshotResult rollbackToSnapshot(final RollbackToSnapshotRequest request);
/**
* RollbackToSnapshot is used to make an existing snapshot the "active" volume image. This method creates a new
* snapshot from an existing snapshot. The new snapshot becomes "active" and the existing snapshot is preserved until
* it is manually deleted. The previously "active" snapshot is deleted unless the parameter saveCurrentState is set with
* a value of "true."
* Note: Creating a snapshot is allowed if cluster fullness is at stage 2 or 3.
* Snapshots are not created when cluster fullness is at stage 4 or 5.
**/
@Since("6")
@ConnectionType("Cluster")
public CreateSnapshotResult rollbackToSnapshot(
Long volumeID
,
Long snapshotID
,
Boolean saveCurrentState
,
Optional name
,
Optional> attributes
);
/**
* The GetCompleteStats API method is used by SolidFire engineering to troubleshoot new features. The data returned from GetCompleteStats is not documented, changes frequently, and is not guaranteed to be accurate. It is not recommended to ever use GetCompleteStats for collecting performance data or any other management integration with a SolidFire cluster.
* The data returned from GetCompleteStats changes frequently, and is not guaranteed to accurately show performance from the system. It is not recommended to ever use GetCompleteStats for collecting performance data or any other management integration with a SolidFire cluster.
**/
@Since("1")
@ConnectionType("Cluster")
public Object getCompleteStats();
/**
* GetHardwareInfo allows you to return hardware information and status for a single node. This generally includes manufacturers, vendors, versions, drives, and other associated hardware identification information.
**/
@Since("9")
@ConnectionType("Node")
public GetHardwareInfoResult getHardwareInfo();
/**
* The GetRawStats call is used by SolidFire engineering to troubleshoot new features. The data returned from GetRawStats is not documented, it changes frequently, and is not guaranteed to be accurate. It is not recommended to ever use GetRawStats for collecting performance data or any other management integration with a SolidFire cluster.
* The data returned from GetRawStats changes frequently, and is not guaranteed to accurately show performance from the system. It is not recommended to ever use GetRawStats for collecting performance data or any other management integration with a SolidFire cluster.
**/
@Since("1")
@ConnectionType("Cluster")
public Object getRawStats();
/**
* ListDriveStats enables you to retrieve high-level activity measurements for multiple drives in the cluster. By default, this method returns statistics for all drives in the cluster, and these measurements are cumulative from the addition of the drive to the cluster. Some values this method returns are specific to block drives, and some are specific to metadata drives. For more information on what data each drive type returns, see the response examples for the GetDriveStats method.
**/
@Since("9")
@ConnectionType("Cluster")
public ListDriveStatsResult listDriveStats(final ListDriveStatsRequest request);
/**
* ListDriveStats enables you to retrieve high-level activity measurements for multiple drives in the cluster. By default, this method returns statistics for all drives in the cluster, and these measurements are cumulative from the addition of the drive to the cluster. Some values this method returns are specific to block drives, and some are specific to metadata drives. For more information on what data each drive type returns, see the response examples for the GetDriveStats method.
**/
@Since("9")
@ConnectionType("Cluster")
public ListDriveStatsResult listDriveStats(
Optional drives
);
/**
**/
@Since("7")
@ConnectionType("Cluster")
public ListVolumeStatsResult listVolumeStats(final ListVolumeStatsRequest request);
/**
**/
@Since("7")
@ConnectionType("Cluster")
public ListVolumeStatsResult listVolumeStats(
Optional volumeIDs
);
/**
* ListVolumeStatsByVirtualVolume enables you to list statistics for volumes, sorted by virtual volumes.
**/
@Since("9")
@ConnectionType("Cluster")
public ListVolumeStatsByVirtualVolumeResult listVolumeStatsByVirtualVolume(final ListVolumeStatsByVirtualVolumeRequest request);
/**
* ListVolumeStatsByVirtualVolume enables you to list statistics for volumes, sorted by virtual volumes.
**/
@Since("9")
@ConnectionType("Cluster")
public ListVolumeStatsByVirtualVolumeResult listVolumeStatsByVirtualVolume(
Optional virtualVolumeIDs
);
/**
* Creates a new VVols storage container.
**/
@Since("9")
@ConnectionType("Cluster")
public CreateStorageContainerResult createStorageContainer(final CreateStorageContainerRequest request);
/**
* Creates a new VVols storage container.
**/
@Since("9")
@ConnectionType("Cluster")
public CreateStorageContainerResult createStorageContainer(
String name
,
Optional initiatorSecret
,
Optional targetSecret
);
/**
* Deletes a storage container from the system.
**/
@Since("9")
@ConnectionType("Cluster")
public DeleteStorageContainerResult deleteStorageContainers(final DeleteStorageContainersRequest request);
/**
* Deletes a storage container from the system.
**/
@Since("9")
@ConnectionType("Cluster")
public DeleteStorageContainerResult deleteStorageContainers(
java.util.UUID[] storageContainerIDs
);
/**
* GetStorageContainerEfficiency enables you to retrieve efficiency information about a virtual volume storage container.
**/
@Since("9")
@ConnectionType("Cluster")
public GetStorageContainerEfficiencyResult getStorageContainerEfficiency(final GetStorageContainerEfficiencyRequest request);
/**
* GetStorageContainerEfficiency enables you to retrieve efficiency information about a virtual volume storage container.
**/
@Since("9")
@ConnectionType("Cluster")
public GetStorageContainerEfficiencyResult getStorageContainerEfficiency(
java.util.UUID storageContainerID
);
/**
* Gets information for all storage containers currently in the system.
**/
@Since("9")
@ConnectionType("Cluster")
public ListStorageContainersResult listStorageContainers(final ListStorageContainersRequest request);
/**
* Gets information for all storage containers currently in the system.
**/
@Since("9")
@ConnectionType("Cluster")
public ListStorageContainersResult listStorageContainers(
Optional storageContainerIDs
);
/**
* Modifies an existing storage container.
**/
@Since("9")
@ConnectionType("Cluster")
public ModifyStorageContainerResult modifyStorageContainer(final ModifyStorageContainerRequest request);
/**
* Modifies an existing storage container.
**/
@Since("9")
@ConnectionType("Cluster")
public ModifyStorageContainerResult modifyStorageContainer(
java.util.UUID storageContainerID
,
Optional initiatorSecret
,
Optional targetSecret
);
/**
* The ListTests API method is used to return the tests that are available to run on a node.
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("5")
@ConnectionType("Node")
public ListTestsResult listTests();
/**
* The ListUtilities API method is used to return the tests that are available to run on a node.
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("5")
@ConnectionType("Node")
public ListUtilitiesResult listUtilities();
/**
* The TestConnectEnsemble API method is used to verify connectivity with a sepcified database ensemble. By default it uses the ensemble for the cluster the node is associated with. Alternatively you can provide a different ensemble to test connectivity with.
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("5")
@ConnectionType("Node")
public TestConnectEnsembleResult testConnectEnsemble(final TestConnectEnsembleRequest request);
/**
* The TestConnectEnsemble API method is used to verify connectivity with a sepcified database ensemble. By default it uses the ensemble for the cluster the node is associated with. Alternatively you can provide a different ensemble to test connectivity with.
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("5")
@ConnectionType("Node")
public TestConnectEnsembleResult testConnectEnsemble(
Optional ensemble
);
/**
* The TestConnectMvip API method is used to test the management connection to the cluster. The test pings the MVIP and executes a simple API method to verify connectivity.
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("5")
@ConnectionType("Node")
public TestConnectMvipResult testConnectMvip(final TestConnectMvipRequest request);
/**
* The TestConnectMvip API method is used to test the management connection to the cluster. The test pings the MVIP and executes a simple API method to verify connectivity.
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("5")
@ConnectionType("Node")
public TestConnectMvipResult testConnectMvip(
Optional mvip
);
/**
* The TestConnectSvip API method is used to test the storage connection to the cluster. The test pings the SVIP using ICMP packets and when successful connects as an iSCSI initiator.
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("5")
@ConnectionType("Node")
public TestConnectSvipResult testConnectSvip(final TestConnectSvipRequest request);
/**
* The TestConnectSvip API method is used to test the storage connection to the cluster. The test pings the SVIP using ICMP packets and when successful connects as an iSCSI initiator.
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("5")
@ConnectionType("Node")
public TestConnectSvipResult testConnectSvip(
Optional svip
);
/**
* The TestPing API method is used to validate the connection to all nodes in the cluster on both 1G and 10G interfaces using ICMP packets. The test uses the appropriate MTU sizes for each packet based on the MTU settings in the network configuration.
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("5")
@ConnectionType("Node")
public TestPingResult testPing(final TestPingRequest request);
/**
* The TestPing API method is used to validate the connection to all nodes in the cluster on both 1G and 10G interfaces using ICMP packets. The test uses the appropriate MTU sizes for each packet based on the MTU settings in the network configuration.
* Note: This method is available only through the per-node API endpoint 5.0 or later.
**/
@Since("5")
@ConnectionType("Node")
public TestPingResult testPing(
Optional attempts
,
Optional hosts
,
Optional totalTimeoutSec
,
Optional packetSize
,
Optional pingTimeoutMsec
);
/**
* ListVirtualNetworks is used to get a list of all the configured virtual networks for the cluster. This method can be used to verify the virtual network settings in the cluster.
*
* This method does not require any parameters to be passed. But, one or more VirtualNetworkIDs or VirtualNetworkTags can be passed in order to filter the results.
**/
@Since("7")
@ConnectionType("Cluster")
public ListVirtualNetworksResult listVirtualNetworks(final ListVirtualNetworksRequest request);
/**
* ListVirtualNetworks is used to get a list of all the configured virtual networks for the cluster. This method can be used to verify the virtual network settings in the cluster.
*
* This method does not require any parameters to be passed. But, one or more VirtualNetworkIDs or VirtualNetworkTags can be passed in order to filter the results.
**/
@Since("7")
@ConnectionType("Cluster")
public ListVirtualNetworksResult listVirtualNetworks(
Optional virtualNetworkID
,
Optional virtualNetworkTag
,
Optional virtualNetworkIDs
,
Optional virtualNetworkTags
);
/**
* AddVirtualNetwork is used to add a new virtual network to a cluster configuration. When a virtual network is added, an interface for each node is created and each will require a virtual network IP address. The number of IP addresses specified as a parameter for this API method must be equal to or greater than the number of nodes in the cluster. Virtual network addresses are bulk provisioned by SolidFire and assigned to individual nodes automatically. Virtual network addresses do not need to be assigned to nodes manually.
*
* Note: The AddVirtualNetwork method is used only to create a new virtual network. If you want to make changes to a virtual network, please use the ModifyVirtualNetwork method.
**/
@Since("7")
@ConnectionType("Cluster")
public AddVirtualNetworkResult addVirtualNetwork(final AddVirtualNetworkRequest request);
/**
* AddVirtualNetwork is used to add a new virtual network to a cluster configuration. When a virtual network is added, an interface for each node is created and each will require a virtual network IP address. The number of IP addresses specified as a parameter for this API method must be equal to or greater than the number of nodes in the cluster. Virtual network addresses are bulk provisioned by SolidFire and assigned to individual nodes automatically. Virtual network addresses do not need to be assigned to nodes manually.
*
* Note: The AddVirtualNetwork method is used only to create a new virtual network. If you want to make changes to a virtual network, please use the ModifyVirtualNetwork method.
**/
@Since("7")
@ConnectionType("Cluster")
public AddVirtualNetworkResult addVirtualNetwork(
Long virtualNetworkTag
,
String name
,
AddressBlock[] addressBlocks
,
String netmask
,
String svip
,
Optional gateway
,
Optional namespace
,
Optional> attributes
);
/**
* ModifyVirtualNetwork is used to change various attributes of a VirtualNetwork object. This method can be used to add or remove address blocks, change the netmask IP, or modify the name or description of the virtual network.
*
* Note: This method requires either the VirtualNetworkID or the VirtualNetworkTag as a parameter, but not both.
**/
@Since("7")
@ConnectionType("Cluster")
public AddVirtualNetworkResult modifyVirtualNetwork(final ModifyVirtualNetworkRequest request);
/**
* ModifyVirtualNetwork is used to change various attributes of a VirtualNetwork object. This method can be used to add or remove address blocks, change the netmask IP, or modify the name or description of the virtual network.
*
* Note: This method requires either the VirtualNetworkID or the VirtualNetworkTag as a parameter, but not both.
**/
@Since("7")
@ConnectionType("Cluster")
public AddVirtualNetworkResult modifyVirtualNetwork(
Optional virtualNetworkID
,
Optional virtualNetworkTag
,
Optional name
,
Optional addressBlocks
,
Optional netmask
,
Optional svip
,
Optional gateway
,
Optional namespace
,
Optional> attributes
);
/**
* RemoveVirtualNetwork is used to remove a previously added virtual network.
*
* Note: This method requires either the VirtualNetworkID of the VirtualNetworkTag as a parameter, but not both.
**/
@Since("7")
@ConnectionType("Cluster")
public RemoveVirtualNetworkResult removeVirtualNetwork(final RemoveVirtualNetworkRequest request);
/**
* RemoveVirtualNetwork is used to remove a previously added virtual network.
*
* Note: This method requires either the VirtualNetworkID of the VirtualNetworkTag as a parameter, but not both.
**/
@Since("7")
@ConnectionType("Cluster")
public RemoveVirtualNetworkResult removeVirtualNetwork(
Optional virtualNetworkID
,
Optional virtualNetworkTag
);
/**
* EnableFeature allows you to enable cluster features that are disabled by default.
**/
@Since("9")
@ConnectionType("Cluster")
public EnableFeatureResult enableFeature(final EnableFeatureRequest request);
/**
* EnableFeature allows you to enable cluster features that are disabled by default.
**/
@Since("9")
@ConnectionType("Cluster")
public EnableFeatureResult enableFeature(
String feature
);
/**
* GetFeatureStatus allows you to retrieve the status of a cluster feature.
**/
@Since("9")
@ConnectionType("Cluster")
public GetFeatureStatusResult getFeatureStatus(final GetFeatureStatusRequest request);
/**
* GetFeatureStatus allows you to retrieve the status of a cluster feature.
**/
@Since("9")
@ConnectionType("Cluster")
public GetFeatureStatusResult getFeatureStatus(
Optional feature
);
/**
* Enables retrieval of the number of virtual volumes currently in the system.
**/
@Since("9")
@ConnectionType("Cluster")
public GetVirtualVolumeCountResult getVirtualVolumeCount();
/**
* ListVirtualVolumeBindings returns a list of VVol bindings.
**/
@Since("9")
@ConnectionType("Cluster")
public ListVirtualVolumeBindingsResult listVirtualVolumeBindings(final ListVirtualVolumeBindingsRequest request);
/**
* ListVirtualVolumeBindings returns a list of VVol bindings.
**/
@Since("9")
@ConnectionType("Cluster")
public ListVirtualVolumeBindingsResult listVirtualVolumeBindings(
Optional virtualVolumeBindingIDs
);
/**
* ListVirtualVolumeHosts returns a list of known ESX hosts.
**/
@Since("9")
@ConnectionType("Cluster")
public ListVirtualVolumeHostsResult listVirtualVolumeHosts(final ListVirtualVolumeHostsRequest request);
/**
* ListVirtualVolumeHosts returns a list of known ESX hosts.
**/
@Since("9")
@ConnectionType("Cluster")
public ListVirtualVolumeHostsResult listVirtualVolumeHosts(
Optional virtualVolumeHostIDs
);
/**
* ListVirtualVolumeTasks returns a list of VVol Async Tasks.
**/
@Since("9")
@ConnectionType("Cluster")
public ListVirtualVolumeTasksResult listVirtualVolumeTasks(final ListVirtualVolumeTasksRequest request);
/**
* ListVirtualVolumeTasks returns a list of VVol Async Tasks.
**/
@Since("9")
@ConnectionType("Cluster")
public ListVirtualVolumeTasksResult listVirtualVolumeTasks(
Optional virtualVolumeTaskIDs
);
/**
* ListVirtualVolumes enables you to list the virtual volumes currently in the system. You can use this method to list all virtual volumes, or only list a subset.
**/
@Since("9")
@ConnectionType("Cluster")
public ListVirtualVolumesResult listVirtualVolumes(final ListVirtualVolumesRequest request);
/**
* ListVirtualVolumes enables you to list the virtual volumes currently in the system. You can use this method to list all virtual volumes, or only list a subset.
**/
@Since("9")
@ConnectionType("Cluster")
public ListVirtualVolumesResult listVirtualVolumes(
Optional details
,
Optional limit
,
Optional recursive
,
Optional startVirtualVolumeID
,
Optional virtualVolumeIDs
);
/**
* Cancels a currently running clone operation. This method does not return anything.
**/
@Since("9")
@ConnectionType("Cluster")
public CancelCloneResult cancelClone(final CancelCloneRequest request);
/**
* Cancels a currently running clone operation. This method does not return anything.
**/
@Since("9")
@ConnectionType("Cluster")
public CancelCloneResult cancelClone(
Long cloneID
);
/**
* CancelGroupClone enables you to stop an ongoing CloneMultipleVolumes process for a group of clones. When you cancel a group clone operation, the system completes and removes the operation's associated asyncHandle. This method does not return anything.
**/
@Since("9")
@ConnectionType("Cluster")
public CancelGroupCloneResult cancelGroupClone(final CancelGroupCloneRequest request);
/**
* CancelGroupClone enables you to stop an ongoing CloneMultipleVolumes process for a group of clones. When you cancel a group clone operation, the system completes and removes the operation's associated asyncHandle. This method does not return anything.
**/
@Since("9")
@ConnectionType("Cluster")
public CancelGroupCloneResult cancelGroupClone(
Long groupCloneID
);
/**
* Copies one volume to another.
**/
@Since("9")
@ConnectionType("Cluster")
public CopyVolumeResult copyVolume(final CopyVolumeRequest request);
/**
* Copies one volume to another.
**/
@Since("9")
@ConnectionType("Cluster")
public CopyVolumeResult copyVolume(
Long volumeID
,
Long dstVolumeID
,
Optional snapshotID
);
/**
* DeleteVolumes marks multiple (up to 500) active volumes for deletion. Once marked, the volumes are purged (permanently deleted) after the cleanup interval elapses.The cleanup interval can be set in the SetClusterSettings method. For more information on using this method, see SetClusterSettings on page 1. After making a request to delete volumes, any active iSCSI connections to the volumes are immediately terminated and no further connections are allowed while the volumes are in this state. A marked volume is not returned in target discovery requests. Any snapshots of a volume that has been marked for deletion are not affected. Snapshots are kept until the volume is purged from the system. If a volume is marked for deletion and has a bulk volume read or bulk volume write operation in progress, the bulk volume read or write operation is stopped. If the volumes you delete are paired with a volume, replication between the paired volumes is suspended and no data is transferred to them or from them while in a deleted state. The remote volumes the deleted volumes were paired with enter into a PausedMisconfigured state and data is no longer sent to them or from the deleted volumes. Until the deleted volumes are purged, they can be restored and data transfers resume. If the deleted volumes are purged from the system, the volumes they were paired with enter into a StoppedMisconfigured state and the volume pairing status is removed. The purged volumes become permanently unavailable.
**/
@Since("9")
@ConnectionType("Cluster")
public DeleteVolumesResult deleteVolumes(final DeleteVolumesRequest request);
/**
* DeleteVolumes marks multiple (up to 500) active volumes for deletion. Once marked, the volumes are purged (permanently deleted) after the cleanup interval elapses.The cleanup interval can be set in the SetClusterSettings method. For more information on using this method, see SetClusterSettings on page 1. After making a request to delete volumes, any active iSCSI connections to the volumes are immediately terminated and no further connections are allowed while the volumes are in this state. A marked volume is not returned in target discovery requests. Any snapshots of a volume that has been marked for deletion are not affected. Snapshots are kept until the volume is purged from the system. If a volume is marked for deletion and has a bulk volume read or bulk volume write operation in progress, the bulk volume read or write operation is stopped. If the volumes you delete are paired with a volume, replication between the paired volumes is suspended and no data is transferred to them or from them while in a deleted state. The remote volumes the deleted volumes were paired with enter into a PausedMisconfigured state and data is no longer sent to them or from the deleted volumes. Until the deleted volumes are purged, they can be restored and data transfers resume. If the deleted volumes are purged from the system, the volumes they were paired with enter into a StoppedMisconfigured state and the volume pairing status is removed. The purged volumes become permanently unavailable.
**/
@Since("9")
@ConnectionType("Cluster")
public DeleteVolumesResult deleteVolumes(
Optional accountIDs
,
Optional volumeAccessGroupIDs
,
Optional volumeIDs
);
/**
* GetDefaultQoS is used to retrieve the default QoS values that are set for a volume if QoS is not supplied.
**/
@Since("1")
@ConnectionType("Cluster")
public VolumeQOS getDefaultQoS();
/**
* GetVolumeCount enables you to retrieve the number of volumes currently in the system.
**/
@Since("9")
@ConnectionType("Cluster")
public GetVolumeCountResult getVolumeCount();
/**
* GetVolumeEfficiency is used to retrieve information about a volume.
* Only the volume given as a parameter in this API method is used to compute the capacity.
**/
@Since("6")
@ConnectionType("Cluster")
public GetVolumeEfficiencyResult getVolumeEfficiency(final GetVolumeEfficiencyRequest request);
/**
* GetVolumeEfficiency is used to retrieve information about a volume.
* Only the volume given as a parameter in this API method is used to compute the capacity.
**/
@Since("6")
@ConnectionType("Cluster")
public GetVolumeEfficiencyResult getVolumeEfficiency(
Long volumeID
);
/**
* GetVolumeStats is used to retrieve high-level activity measurements for a single volume.
* Values are cumulative from the creation of the volume.
**/
@Since("1")
@ConnectionType("Cluster")
public GetVolumeStatsResult getVolumeStats(final GetVolumeStatsRequest request);
/**
* GetVolumeStats is used to retrieve high-level activity measurements for a single volume.
* Values are cumulative from the creation of the volume.
**/
@Since("1")
@ConnectionType("Cluster")
public GetVolumeStatsResult getVolumeStats(
Long volumeID
);
/**
* ListActiveVolumes is used to return the list of active volumes currently in the system.
* The list of volumes is returned sorted in VolumeID order and can be returned in multiple parts (pages).
**/
@Since("1")
@ConnectionType("Cluster")
public ListActiveVolumesResult listActiveVolumes(final ListActiveVolumesRequest request);
/**
* ListActiveVolumes is used to return the list of active volumes currently in the system.
* The list of volumes is returned sorted in VolumeID order and can be returned in multiple parts (pages).
**/
@Since("1")
@ConnectionType("Cluster")
public ListActiveVolumesResult listActiveVolumes(
Optional startVolumeID
,
Optional limit
);
/**
* You can use ListAsyncResults to list the results of all currently running and completed asynchronous methods on the system. Querying asynchronous results with ListAsyncResults does not cause completed asyncHandles to expire; you can use GetAsyncResult to query any of the asyncHandles returned by ListAsyncResults.
**/
@Since("9")
@ConnectionType("Cluster")
public ListAsyncResultsResult listAsyncResults(final ListAsyncResultsRequest request);
/**
* You can use ListAsyncResults to list the results of all currently running and completed asynchronous methods on the system. Querying asynchronous results with ListAsyncResults does not cause completed asyncHandles to expire; you can use GetAsyncResult to query any of the asyncHandles returned by ListAsyncResults.
**/
@Since("9")
@ConnectionType("Cluster")
public ListAsyncResultsResult listAsyncResults(
Optional asyncResultTypes
);
/**
* ListBulkVolumeJobs is used to return information about each bulk volume read or write operation that is occurring in the system.
**/
@Since("6")
@ConnectionType("Cluster")
public ListBulkVolumeJobsResult listBulkVolumeJobs();
/**
* ListDeletedVolumes is used to return the entire list of volumes that have been marked for deletion and is purged from the system.
**/
@Since("1")
@ConnectionType("Cluster")
public ListDeletedVolumesResult listDeletedVolumes();
/**
* ListVolumeStatsByAccount returns high-level activity measurements for every account.
* Values are summed from all the volumes owned by the account.
**/
@Since("1")
@ConnectionType("Cluster")
public ListVolumeStatsByAccountResult listVolumeStatsByAccount();
/**
* ListVolumeStatsByVolume returns high-level activity measurements for every volume, by volume.
* Values are cumulative from the creation of the volume.
**/
@Since("1")
@ConnectionType("Cluster")
public ListVolumeStatsByVolumeResult listVolumeStatsByVolume();
/**
* ListVolumeStatsByVolumeAccessGroup is used to get total activity measurements for all of the volumes that are a member of the specified volume access group(s).
**/
@Since("5")
@ConnectionType("Cluster")
public ListVolumeStatsByVolumeAccessGroupResult listVolumeStatsByVolumeAccessGroup(final ListVolumeStatsByVolumeAccessGroupRequest request);
/**
* ListVolumeStatsByVolumeAccessGroup is used to get total activity measurements for all of the volumes that are a member of the specified volume access group(s).
**/
@Since("5")
@ConnectionType("Cluster")
public ListVolumeStatsByVolumeAccessGroupResult listVolumeStatsByVolumeAccessGroup(
Optional volumeAccessGroups
);
/**
* The ListVolumes method is used to return a list of volumes that are in a cluster.
* You can specify the volumes you want to return in the list by using the available parameters.
**/
@Since("8")
@ConnectionType("Cluster")
public ListVolumesResult listVolumes(final ListVolumesRequest request);
/**
* The ListVolumes method is used to return a list of volumes that are in a cluster.
* You can specify the volumes you want to return in the list by using the available parameters.
**/
@Since("8")
@ConnectionType("Cluster")
public ListVolumesResult listVolumes(
Optional startVolumeID
,
Optional limit
,
Optional volumeStatus
,
Optional accounts
,
Optional isPaired
,
Optional volumeIDs
);
/**
* ListVolumesForAccount returns the list of active AND (pending) deleted volumes for an account.
**/
@Since("1")
@ConnectionType("Cluster")
public ListVolumesForAccountResult listVolumesForAccount(final ListVolumesForAccountRequest request);
/**
* ListVolumesForAccount returns the list of active AND (pending) deleted volumes for an account.
**/
@Since("1")
@ConnectionType("Cluster")
public ListVolumesForAccountResult listVolumesForAccount(
Long accountID
,
Optional startVolumeID
,
Optional limit
);
/**
* ModifyVolumes allows you to configure up to 500 existing volumes at one time. Changes take place immediately. If ModifyVolumes fails to modify any of the specified volumes, none of the specified volumes are changed.If you do not specify QoS values when you modify volumes, the QoS values for each volume remain unchanged. You can retrieve default QoS values for a newly created volume by running the GetDefaultQoS method.When you need to increase the size of volumes that are being replicated, do so in the following order to prevent replication errors:Increase the size of the "Replication Target" volume.Increase the size of the source or "Read / Write" volume. recommends that both the target and source volumes be the same size.NOTE: If you change access status to locked or replicationTarget all existing iSCSI connections are terminated.
**/
@Since("9")
@ConnectionType("Cluster")
public ModifyVolumesResult modifyVolumes(final ModifyVolumesRequest request);
/**
* ModifyVolumes allows you to configure up to 500 existing volumes at one time. Changes take place immediately. If ModifyVolumes fails to modify any of the specified volumes, none of the specified volumes are changed.If you do not specify QoS values when you modify volumes, the QoS values for each volume remain unchanged. You can retrieve default QoS values for a newly created volume by running the GetDefaultQoS method.When you need to increase the size of volumes that are being replicated, do so in the following order to prevent replication errors:Increase the size of the "Replication Target" volume.Increase the size of the source or "Read / Write" volume. recommends that both the target and source volumes be the same size.NOTE: If you change access status to locked or replicationTarget all existing iSCSI connections are terminated.
**/
@Since("9")
@ConnectionType("Cluster")
public ModifyVolumesResult modifyVolumes(
Long[] volumeIDs
,
Optional accountID
,
Optional access
,
Optional qos
,
Optional totalSize
,
Optional> attributes
);
/**
* PurgeDeletedVolume immediately and permanently purges a volume which has been deleted.
* A volume must be deleted using DeleteVolume before it can be purged.
* Volumes are purged automatically after a period of time, so usage of this method is not typically required.
**/
@Since("1")
@ConnectionType("Cluster")
public PurgeDeletedVolumeResult purgeDeletedVolume(final PurgeDeletedVolumeRequest request);
/**
* PurgeDeletedVolume immediately and permanently purges a volume which has been deleted.
* A volume must be deleted using DeleteVolume before it can be purged.
* Volumes are purged automatically after a period of time, so usage of this method is not typically required.
**/
@Since("1")
@ConnectionType("Cluster")
public PurgeDeletedVolumeResult purgeDeletedVolume(
Long volumeID
);
/**
* PurgeDeletedVolumes immediately and permanently purges volumes that have been deleted; you can use this method to purge up to 500 volumes at one time. You must delete volumes using DeleteVolumes before they can be purged. Volumes are purged by the system automatically after a period of time, so usage of this method is not typically required.
**/
@Since("9")
@ConnectionType("Cluster")
public PurgeDeletedVolumesResult purgeDeletedVolumes(final PurgeDeletedVolumesRequest request);
/**
* PurgeDeletedVolumes immediately and permanently purges volumes that have been deleted; you can use this method to purge up to 500 volumes at one time. You must delete volumes using DeleteVolumes before they can be purged. Volumes are purged by the system automatically after a period of time, so usage of this method is not typically required.
**/
@Since("9")
@ConnectionType("Cluster")
public PurgeDeletedVolumesResult purgeDeletedVolumes(
Optional volumeIDs
,
Optional accountIDs
,
Optional volumeAccessGroupIDs
);
/**
* RestoreDeletedVolume marks a deleted volume as active again.
* This action makes the volume immediately available for iSCSI connection.
**/
@Since("1")
@ConnectionType("Cluster")
public RestoreDeletedVolumeResult restoreDeletedVolume(final RestoreDeletedVolumeRequest request);
/**
* RestoreDeletedVolume marks a deleted volume as active again.
* This action makes the volume immediately available for iSCSI connection.
**/
@Since("1")
@ConnectionType("Cluster")
public RestoreDeletedVolumeResult restoreDeletedVolume(
Long volumeID
);
/**
* SetDefaultQoS enables you to configure the default Quality of Service (QoS) values (measured in inputs and outputs per second, or IOPS) for all volumes not yet created.
**/
@Since("9")
@ConnectionType("Cluster")
public SetDefaultQoSResult setDefaultQoS(final SetDefaultQoSRequest request);
/**
* SetDefaultQoS enables you to configure the default Quality of Service (QoS) values (measured in inputs and outputs per second, or IOPS) for all volumes not yet created.
**/
@Since("9")
@ConnectionType("Cluster")
public SetDefaultQoSResult setDefaultQoS(
Optional minIOPS
,
Optional maxIOPS
,
Optional burstIOPS
);
/**
* CloneMultipleVolumes is used to create a clone of a group of specified volumes. A consistent set of characteristics can be assigned to a group of multiple volume when they are cloned together.
* If groupSnapshotID is going to be used to clone the volumes in a group snapshot, the group snapshot must be created first using the CreateGroupSnapshot API method or the SolidFire Element WebUI. Using groupSnapshotID is optional when cloning multiple volumes.
*
* Note: Cloning multiple volumes is allowed if cluster fullness is at stage 2 or 3. Clones are not created when cluster fullness is at stage 4 or 5.
**/
@Since("7")
@ConnectionType("Cluster")
public CloneMultipleVolumesResult cloneMultipleVolumes(final CloneMultipleVolumesRequest request);
/**
* CloneMultipleVolumes is used to create a clone of a group of specified volumes. A consistent set of characteristics can be assigned to a group of multiple volume when they are cloned together.
* If groupSnapshotID is going to be used to clone the volumes in a group snapshot, the group snapshot must be created first using the CreateGroupSnapshot API method or the SolidFire Element WebUI. Using groupSnapshotID is optional when cloning multiple volumes.
*
* Note: Cloning multiple volumes is allowed if cluster fullness is at stage 2 or 3. Clones are not created when cluster fullness is at stage 4 or 5.
**/
@Since("7")
@ConnectionType("Cluster")
public CloneMultipleVolumesResult cloneMultipleVolumes(
CloneMultipleVolumeParams[] volumes
,
Optional access
,
Optional groupSnapshotID
,
Optional newAccountID
);
/**
* CloneVolume is used to create a copy of the volume.
* This method is asynchronous and may take a variable amount of time to complete.
* The cloning process begins immediately when the CloneVolume request is made and is representative of the state of the volume when the API method is issued.
* GetAsyncResults can be used to determine when the cloning process is complete and the new volume is available for connections.
* ListSyncJobs can be used to see the progress of creating the clone.
*
* Note: The initial attributes and quality of service settings for the volume are inherited from the volume being cloned.
* If different settings are required, they can be changed via ModifyVolume.
*
* Note: Cloned volumes do not inherit volume access group memberships from the source volume.
**/
@Since("1")
@ConnectionType("Cluster")
public CloneVolumeResult cloneVolume(final CloneVolumeRequest request);
/**
* CloneVolume is used to create a copy of the volume.
* This method is asynchronous and may take a variable amount of time to complete.
* The cloning process begins immediately when the CloneVolume request is made and is representative of the state of the volume when the API method is issued.
* GetAsyncResults can be used to determine when the cloning process is complete and the new volume is available for connections.
* ListSyncJobs can be used to see the progress of creating the clone.
*
* Note: The initial attributes and quality of service settings for the volume are inherited from the volume being cloned.
* If different settings are required, they can be changed via ModifyVolume.
*
* Note: Cloned volumes do not inherit volume access group memberships from the source volume.
**/
@Since("1")
@ConnectionType("Cluster")
public CloneVolumeResult cloneVolume(
Long volumeID
,
String name
,
Optional newAccountID
,
Optional newSize
,
Optional access
,
Optional snapshotID
,
Optional> attributes
);
/**
* CreateVolume is used to create a new (empty) volume on the cluster.
* When the volume is created successfully it is available for connection via iSCSI.
**/
@Since("1")
@ConnectionType("Cluster")
public CreateVolumeResult createVolume(final CreateVolumeRequest request);
/**
* CreateVolume is used to create a new (empty) volume on the cluster.
* When the volume is created successfully it is available for connection via iSCSI.
**/
@Since("1")
@ConnectionType("Cluster")
public CreateVolumeResult createVolume(
String name
,
Long accountID
,
Long totalSize
,
Boolean enable512e
,
Optional qos
,
Optional> attributes
);
/**
* DeleteVolume marks an active volume for deletion.
* It is purged (permanently deleted) after the cleanup interval elapses.
* After making a request to delete a volume, any active iSCSI connections to the volume is immediately terminated and no further connections are allowed while the volume is in this state.
* It is not returned in target discovery requests.
*
* Any snapshots of a volume that has been marked to delete are not affected.
* Snapshots are kept until the volume is purged from the system.
*
* If a volume is marked for deletion, and it has a bulk volume read or bulk volume write operation in progress, the bulk volume operation is stopped.
*
* If the volume you delete is paired with a volume, replication between the paired volumes is suspended and no data is transferred to it or from it while in a deleted state.
* The remote volume the deleted volume was paired with enters into a PausedMisconfigured state and data is no longer sent to it or from the deleted volume.
* Until the deleted volume is purged, it can be restored and data transfers resumes.
* If the deleted volume gets purged from the system, the volume it was paired with enters into a StoppedMisconfigured state and the volume pairing status is removed.
* The purged volume becomes permanently unavailable.
**/
@Since("1")
@ConnectionType("Cluster")
public DeleteVolumeResult deleteVolume(final DeleteVolumeRequest request);
/**
* DeleteVolume marks an active volume for deletion.
* It is purged (permanently deleted) after the cleanup interval elapses.
* After making a request to delete a volume, any active iSCSI connections to the volume is immediately terminated and no further connections are allowed while the volume is in this state.
* It is not returned in target discovery requests.
*
* Any snapshots of a volume that has been marked to delete are not affected.
* Snapshots are kept until the volume is purged from the system.
*
* If a volume is marked for deletion, and it has a bulk volume read or bulk volume write operation in progress, the bulk volume operation is stopped.
*
* If the volume you delete is paired with a volume, replication between the paired volumes is suspended and no data is transferred to it or from it while in a deleted state.
* The remote volume the deleted volume was paired with enters into a PausedMisconfigured state and data is no longer sent to it or from the deleted volume.
* Until the deleted volume is purged, it can be restored and data transfers resumes.
* If the deleted volume gets purged from the system, the volume it was paired with enters into a StoppedMisconfigured state and the volume pairing status is removed.
* The purged volume becomes permanently unavailable.
**/
@Since("1")
@ConnectionType("Cluster")
public DeleteVolumeResult deleteVolume(
Long volumeID
);
/**
* Used to retrieve the result of asynchronous method calls.
* Some method calls are long running and do not complete when the initial response is sent.
* To obtain the result of the method call, polling with GetAsyncResult is required.
*
* GetAsyncResult returns the overall status of the operation (in progress, completed, or error) in a standard fashion,
* but the actual data returned for the operation depends on the original method call and the return data is documented with each method.
*
* The result for a completed asynchronous method call can only be retrieved once.
* Once the final result has been returned, later attempts returns an error.
**/
@Since("1")
@ConnectionType("Cluster")
public GetAsyncResultResult getAsyncResult(final GetAsyncResultRequest request);
/**
* Used to retrieve the result of asynchronous method calls.
* Some method calls are long running and do not complete when the initial response is sent.
* To obtain the result of the method call, polling with GetAsyncResult is required.
*
* GetAsyncResult returns the overall status of the operation (in progress, completed, or error) in a standard fashion,
* but the actual data returned for the operation depends on the original method call and the return data is documented with each method.
*
* The result for a completed asynchronous method call can only be retrieved once.
* Once the final result has been returned, later attempts returns an error.
**/
@Since("1")
@ConnectionType("Cluster")
public GetAsyncResultResult getAsyncResult(
Long asyncHandle
);
/**
* ModifyVolume is used to modify settings on an existing volume.
* Modifications can be made to one volume at a time and changes take place immediately.
* If an optional parameter is left unspecified, the value will not be changed.
*
* Extending the size of a volume that is being replicated should be done in an order.
* The target (Replication Target) volume should first be increased in size, then the source (Read/Write) volume can be resized.
* It is recommended that both the target and the source volumes be the same size.
*
* Note: If you change access status to locked or target all existing iSCSI connections are terminated.
**/
@Since("1")
@ConnectionType("Cluster")
public ModifyVolumeResult modifyVolume(final ModifyVolumeRequest request);
/**
* ModifyVolume is used to modify settings on an existing volume.
* Modifications can be made to one volume at a time and changes take place immediately.
* If an optional parameter is left unspecified, the value will not be changed.
*
* Extending the size of a volume that is being replicated should be done in an order.
* The target (Replication Target) volume should first be increased in size, then the source (Read/Write) volume can be resized.
* It is recommended that both the target and the source volumes be the same size.
*
* Note: If you change access status to locked or target all existing iSCSI connections are terminated.
**/
@Since("1")
@ConnectionType("Cluster")
public ModifyVolumeResult modifyVolume(
Long volumeID
,
Optional accountID
,
Optional access
,
Optional qos
,
Optional totalSize
,
Optional> attributes
);
/**
* StartBulkVolumeRead allows you to initialize a bulk volume read session on a specified volume.
* Only two bulk volume processes can run simultaneously on a volume.
* When you initialize the session, data is read from a SolidFire storage volume for the purposes of storing the data on an external backup source.
* The external data is accessed by a web server running on a SolidFire node.
* Communications and server interaction information for external data access is passed by a script running on the SolidFire storage system.
*
* At the start of a bulk volume read operation, a snapshot of the volume is made and the snapshot is deleted when the read has completed.
* You can also read a snapshot of the volume by entering the ID of the snapshot as a parameter.
* Reading a previous snapshot does not create a new snapshot of the volume, nor does the previous snapshot be deleted when the read completes.
*
* Note: This process creates a new snapshot if the ID of an existing snapshot is not provided.
* Snapshots can be created if cluster fullness is at stage 2 or 3.
* Snapshots are not created when cluster fullness is at stage 4 or 5.
**/
@Since("6")
@ConnectionType("Cluster")
public StartBulkVolumeReadResult startBulkVolumeRead(final StartBulkVolumeReadRequest request);
/**
* StartBulkVolumeRead allows you to initialize a bulk volume read session on a specified volume.
* Only two bulk volume processes can run simultaneously on a volume.
* When you initialize the session, data is read from a SolidFire storage volume for the purposes of storing the data on an external backup source.
* The external data is accessed by a web server running on a SolidFire node.
* Communications and server interaction information for external data access is passed by a script running on the SolidFire storage system.
*
* At the start of a bulk volume read operation, a snapshot of the volume is made and the snapshot is deleted when the read has completed.
* You can also read a snapshot of the volume by entering the ID of the snapshot as a parameter.
* Reading a previous snapshot does not create a new snapshot of the volume, nor does the previous snapshot be deleted when the read completes.
*
* Note: This process creates a new snapshot if the ID of an existing snapshot is not provided.
* Snapshots can be created if cluster fullness is at stage 2 or 3.
* Snapshots are not created when cluster fullness is at stage 4 or 5.
**/
@Since("6")
@ConnectionType("Cluster")
public StartBulkVolumeReadResult startBulkVolumeRead(
Long volumeID
,
String format
,
Optional snapshotID
,
Optional script
,
Optional © 2015 - 2025 Weber Informatics LLC | Privacy Policy