SolidFire.Element.Api Namespace

AbortSnapMirrorRelationshipRequest The SolidFire Element OS web UI uses the AbortSnapMirrorRelationship method to stop SnapMirror transfers that have started but are not yet complete.

AbortSnapMirrorRelationshipResult

Account The object containing information about an account. This object only includes "configured" information about the account, not any runtime or usage information.

AddAccountRequest You can use AddAccount to add a new account to the system. You can create new volumes under the new account. The CHAP settings you specify for the account apply to all volumes owned by the account.

AddAccountResult

AddClusterAdminRequest You can use AddClusterAdmin to add a new cluster admin account. A cluster ddmin can manage the cluster using the API and management tools. Cluster admins are completely separate and unrelated to standard tenant accounts. Each cluster admin can be restricted to a subset of the API. NetApp recommends using multiple cluster admin accounts for different users and applications. You should give each cluster admin the minimal permissions necessary; this reduces the potential impact of credential compromise. You must accept the End User License Agreement (EULA) by setting the acceptEula parameter to true to add a cluster administrator account to the system.

AddClusterAdminResult

AddDrivesRequest AddDrives enables you 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 is asynchronous and returns immediately. However, it can take some time for the data in the cluster to be rebalanced using the newly added drives. As the new drives are syncing on the system, you can use the ListSyncJobs method to see how the drives are being rebalanced and the progress of adding the new drive. You can also use the GetAsyncResult method to query the method's returned asyncHandle.

AddDrivesResult

AddedNode

AddIdpClusterAdminRequest Adds a cluster administrator user authenticated by a third party Identity Provider (IdP). IdP cluster admin accounts are configured based on SAML attribute-value information provided within the IdP's SAML assertion associated with the user. If a user successfully authenticates with the IdP and has SAML attribute statements within the SAML assertion matching multiple IdP cluster admin accounts, the user will have the combined access level of those matching IdP cluster admin accounts.

AddInitiatorsToVolumeAccessGroupRequest AddInitiatorsToVolumeAccessGroup enables you to add initiators to a specified volume access group.

AddKeyServerToProviderKmipRequest Adds (assigns) the specified KMIP (Key Management Interoperability Protocol) Key Server to the specified Key Provider. This will result in contacting the server to verify it's functional, as well as to synchronize keys in the event that there are multiple key servers assigned to the provider. This synchronization may result in conflicts which could cause this to fail. If the specified KMIP Key Server is already assigned to the specified Key Provider, this is a no-op and no error will be returned. The assignment can be removed (unassigned) using RemoveKeyServerFromProviderKmip.

AddKeyServerToProviderKmipResult There is no additional data returned as the add is considered successful as long as there is no error.

AddLdapClusterAdminRequest AddLdapClusterAdmin enables you to add a new LDAP cluster administrator user. An LDAP cluster administrator can manage the cluster via the API and management tools. LDAP cluster admin accounts are completely separate and unrelated to standard tenant accounts. You can also use this method to add an LDAP group that has been defined in Active Directory. The access level that is given to the group is passed to the individual users in the LDAP group.

AddLdapClusterAdminResult

AddNodesRequest AddNodes enables you to add one or more new nodes to a cluster. When a node that is not configured starts up for the first time, you are prompted to configure the node. After you configure the node, it is registered as a "pending node" with the cluster. Note: It might take several seconds after adding a new node for it to start up and register its drives as available.

AddNodesResult

AddressBlock Unique Range of IP addresses to include in the virtual network.

AddressBlockParams Unique Range of IP addresses to include in the virtual network.

AddVirtualNetworkRequest You can use the AddVirtualNetwork method to add a new virtual network to a cluster configuration. When you add a virtual network, an interface for each node is created and each interface will require a virtual network IP address. The number of IP addresses you specify as a parameter for this API method must be equal to or greater than the number of nodes in the cluster. The system bulk provisions virtual network addresses and assigns them to individual nodes automatically. You do not need to assign virtual network addresses to nodes manually. Note: You can use AddVirtualNetwork only to create a new virtual network. If you want to make changes to an existing virtual network, use ModifyVirtualNetwork. Note: Virtual network parameters must be unique to each virtual network when setting the namespace parameter to false.

AddVirtualNetworkResult

AddVolumesToVolumeAccessGroupRequest AddVolumesToVolumeAccessGroup enables you to add volumes to a specified volume access group.

CreateScheduleRequest

GetScheduleResult

ListSchedulesResult

ModifyScheduleRequest

ApiModifyScheduleResult

Schedule is an object containing information about each schedule created to autonomously make a snapshot of a volume. The return object includes information for all schedules. If scheduleID is used to identify a specific schedule then only information for that scheduleID is returned. Schedules information is returned with the API method, see ListSchedules on the SolidFire API guide page 245.

ScheduleInfo

Weekday

AsyncHandle

AsyncHandleResult

AuthConfigType This type indicates the configuration data which will be accessed or modified by the element auth container.

AuthMethod This type qualifies a ClusterAdmin with its authentication method.

AuthSessionInfo Contains a information about an auth session.

BackupTarget The object containing information about a backup target.

BinAssignmentProperties

BlockSizeHistogram

BreakSnapMirrorRelationshipRequest The SolidFire Element OS web UI uses the BreakSnapMirrorRelationship method to break a SnapMirror relationship. When a SnapMirror relationship is broken, the destination volume is made read-write and independent, and can then diverge from the source. You can reestablish the relationship with the ResyncSnapMirrorRelationship API method. This method requires the ONTAP cluster to be available.

BreakSnapMirrorRelationshipResult

BreakSnapMirrorVolumeRequest The SolidFire Element OS web UI uses the BreakSnapMirrorVolume method to break the SnapMirror relationship between an ONTAP source container and SolidFire target volume. Breaking a SolidFire SnapMirror volume is useful if an ONTAP system becomes unavailable while replicating data to a SolidFire volume. This feature enables a storage administrator to take control of a SolidFire SnapMirror volume, break its relationship with the remote ONTAP system, and revert the volume to a previous snapshot.

BreakSnapMirrorVolumeResult

BulkVolumeJob

CancelCloneRequest CancelClone enables you to stop an ongoing CloneVolume or CopyVolume process. When you cancel a group clone operation, the system completes and removes the operation's associated asyncHandle.

CancelCloneResult

CancelGroupCloneRequest CancelGroupClone enables you to stop an ongoing CloneMultipleVolumes process occurring on a group of volumes. When you cancel a group clone operation, the system completes and removes the operation's associated asyncHandle.

CancelGroupCloneResult

This class is used for the CHAP secret properties, TargetSecret and InitiatorSecret
in the AddAccountRequest, ModifyAccountRequest, and Account classes.
Call .ToString() or the .Secret property to get the string value of a previously set CHAP secret.
When setting a CHAP secret you can either call the static method CHAPSecret.AutoGenerate()
which will instruct the API to regenerate a new CHAP secret or
you can set it directly using the Secret property.
Example:
var targetSecret = CHAPSecret.AutoGenerate(); // will tell the API to auto generate a new CHAP secret
var targetSecret = new CHAPSecret("thenewsecretvalue"); // or
var targetSecret = new CHAPSecret() { Secret = "thenewsecretvalue"}; // will assign the secret.
To discover the value of the CHAPSecret from this object:
var secret = targetSecret.ToString(); // or
var secret = targetSecret.Secret;

CheckProposedClusterRequest CheckProposedCluster validates that creating a cluster from a given set of nodes is likely to succeed. Any problems with the proposed cluster are returned as errors with a human-readable description and unique error code.

CheckProposedNodeAdditionsRequest CheckProposedNodeAdditions validates that adding a node (or nodes) to an existing cluster is likely to succeed. Any problems with the proposed new cluster are returned as errors with a human-readable description and unique error code.

CheckProposedResult

ClearClusterFaultsRequest You can use the ClearClusterFaults method to clear information about both current and previously detected faults. Both resolved and unresolved faults can be cleared.

ClearClusterFaultsResult

CloneMultipleVolumeParams

CloneMultipleVolumesRequest CloneMultipleVolumes enables you to create a clone of a group of specified volumes. You can assign a consistent set of characteristics to a group of multiple volumes when they are cloned together. Before using groupSnapshotID to clone the volumes in a group snapshot, you must create the group snapshot by using the CreateGroupSnapshot API method or the Element OS Web UI. 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.

CloneMultipleVolumesResult

CloneVolumeRequest CloneVolume enables you to create a copy of a volume. This method is asynchronous and might take a variable amount of time to complete. The cloning process begins immediately when you make the CloneVolume request and is representative of the state of the volume when the API method is issued. You can use the GetAsyncResult method to determine when the cloning process is complete and the new volume is available for connections. You can use ListSyncJobs to see the progress of creating the clone. Note: The initial attributes and QoS settings for the volume are inherited from the volume being cloned. You can change these settings with ModifyVolume. Note: Cloned volumes do not inherit volume access group memberships from the source volume.

CloneVolumeResult

ClusterAdmin

ClusterCapacity High level capacity measurements for the entire cluster.

ClusterConfig Cluster Config object returns information the node uses to communicate with the cluster.

ClusterFaultInfo

ClusterHardwareInfo

ClusterInfo Cluster Info object returns information the node uses to communicate with the cluster.

ClusterInterfacePreference

ClusterStats

ClusterVersionInfo Version information for a node in the cluster.

CompleteClusterPairingRequest You can use the CompleteClusterPairing method with the encoded key received from the StartClusterPairing method to complete the cluster pairing process. The CompleteClusterPairing method is the second step in the cluster pairing process.

CompleteClusterPairingResult

CompleteVolumePairingRequest You can use the CompleteVolumePairing method to complete the pairing of two volumes.

CompleteVolumePairingResult

Config

ConfigParams

ControlPowerRequest ControlPower can be used to reboot or halt a node.

ControlPowerResult

CopyVolumeRequest CopyVolume enables you to overwrite the data contents of an existing volume with the data contents of another volume (or snapshot). Attributes of the destination volume such as IQN, QoS settings, size, account, and volume access group membership are not changed. The destination volume must already exist and must be the same size as the source volume. NetApp strongly recommends that clients unmount the destination volume before the CopyVolume operation begins. If the destination volume is modified during the copy operation, the changes will be lost. This method is asynchronous and may take a variable amount of time to complete. You can use the GetAsyncResult method to determine when the process has finished, and ListSyncJobs to see the progress of the copy.

CopyVolumeResult

CreateBackupTargetRequest CreateBackupTarget enables you to create and store backup target information so that you do not need to re-enter it each time a backup is created.

CreateBackupTargetResult

CreateClusterInterfacePreferenceRequest Creates a new cluster preference and stores it on the storage cluster. The ClusterInterfacePreference related APIs can be used by internal interfaces to the storage cluster such as HCI and UI to store arbitrary information in the cluster. Since the API calls in the UI are visible to customers, these APIs are made public.

CreateClusterInterfacePreferenceResult

CreateClusterRequest The CreateCluster method enables you to initialize the node in a cluster that has ownership of the "mvip" and "svip" addresses. Each new cluster is initialized using the management IP (MIP) of the first node in the cluster. This method also automatically adds all the nodes being configured into the cluster. You only need to use this method once each time a new cluster is initialized. Note: You need to log in to the node that is used as the master node for the cluster. After you log 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.

CreateClusterResult

CreateGroupSnapshotRequest CreateGroupSnapshot enables you to create a point-in-time copy of a group of volumes. You can use this snapshot later as a backup or rollback to ensure the data on the group of volumes is consistent for the point in time that you created the snapshot. 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.

CreateGroupSnapshotResult

CreateIdpConfigurationRequest Create a potential trust relationship for authentication using a third party Identity Provider (IdP) for the cluster. A SAML Service Provider certificate is required for IdP communication, which will be generated as necessary.

CreateIdpConfigurationResult

CreateInitiator Object containing characteristics of each new initiator to be created.

CreateInitiatorsRequest 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).

CreateInitiatorsResult

CreateKeyProviderKmipRequest Creates a KMIP (Key Management Interoperability Protocol) Key Provider with the specified name. A Key Provider defines a mechanism and location to retrieve authentication keys. A KMIP Key Provider represents a collection of one or more KMIP Key Servers. A newly created KMIP Key Provider will not have any KMIP Key Servers assigned to it. To create a KMIP Key Server see CreateKeyServerKmip and to assign it to a provider created via this method see AddKeyServerToProviderKmip.

CreateKeyProviderKmipResult

CreateKeyServerKmipRequest Creates a KMIP (Key Management Interoperability Protocol) Key Server with the specified attributes. The server will not be contacted as part of this operation so it need not exist or be configured prior. For clustered Key Server configurations, the hostnames or IP Addresses, of all server nodes, must be provided in the kmipKeyServerHostnames parameter.

CreateKeyServerKmipResult

CreatePublicPrivateKeyPairRequest Creates SSL public and private keys. These keys can be used to generate Certificate Sign Requests. There can be only one key pair in use for the cluster. To replace the existing keys, make sure that they are not being used by any providers before invoking this API.

CreatePublicPrivateKeyPairResult There is no additional data returned as the creation of keys is considered successful as long as there is no error.

CreateQoSPolicyRequest You can use the CreateQoSPolicy method to create a QoSPolicy object that you can later apply to a volume upon creation or modification. A QoS policy has a unique ID, a name, and QoS settings.

CreateQoSPolicyResult

CreateScheduleRequest CreateSchedule enables you to schedule an automatic snapshot of a volume at a defined interval. You can use the created snapshot 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. If you schedule a snapshot to run at a time period that is not divisible by 5 minutes, the snapshot runs at the next time period that is divisible by 5 minutes. For example, if you schedule a snapshot to run at 12:42:00 UTC, it runs at 12:45:00 UTC. Note: You can create snapshots if cluster fullness is at stage 1, 2 or 3. You cannot create snapshots after cluster fullness reaches stage 4 or 5.

CreateScheduleResult

CreateSnapMirrorEndpointRequest The SolidFire Element OS web UI uses the CreateSnapMirrorEndpoint method to create a relationship with a remote SnapMirror endpoint.

CreateSnapMirrorEndpointResult

CreateSnapMirrorEndpointUnmanagedRequest The SolidFire system uses the CreateSnapMirrorEndpointUnmanaged method to enable remote, unmanaged SnapMirror endpoints to communicate with a SolidFire cluster. Unmanaged endpoints cannot be administered using the SolidFire SnapMirror APIs. They must be managed with ONTAP management software or APIs.

CreateSnapMirrorEndpointUnmanagedResult

CreateSnapMirrorRelationshipRequest The SolidFire Element OS web UI uses the CreateSnapMirrorRelationship method to create a SnapMirror extended data protection relationship between a source and destination endpoint.

CreateSnapMirrorRelationshipResult

CreateSnapMirrorVolumeRequest The SolidFire Element OS web UI uses the CreateSnapMirrorVolume method to create a volume on the remote ONTAP system.

CreateSnapshotRequest CreateSnapshot enables you to create a point-in-time copy of a volume. You can create a snapshot from any volume or from an existing snapshot. If you do not provide a SnapshotID with this API method, a snapshot is created from the volume's active branch. If the volume from which the snapshot is created is being replicated to a remote cluster, the snapshot can also be replicated to the same target. Use the enableRemoteReplication parameter to enable snapshot replication. 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.

CreateSnapshotResult

CreateStorageContainerRequest CreateStorageContainer enables you to create a Virtual Volume (VVol) storage container. Storage containers are associated with a SolidFire storage system account, and are used for reporting and resource allocation. Storage containers can only be associated with virtual volumes. You need at least one storage container to use the Virtual Volumes feature.

CreateStorageContainerResult

CreateSupportBundleRequest CreateSupportBundle enables you to create a support bundle file under the node's directory. After creation, the bundle is stored on the node as a tar.gz file.

CreateSupportBundleResult

CreateVolumeAccessGroupRequest You can use CreateVolumeAccessGroup to create a new volume access group. When you create the volume access group, you need to give it a name, and you can optionally enter initiators and volumes. After you create the group, you can add volumes and initiator IQNs. Any initiator IQN that you add to the volume access group is able to access any volume in the group without CHAP authentication.

CreateVolumeAccessGroupResult

CreateVolumeRequest CreateVolume enables you to create a new (empty) volume on the cluster. As soon as the volume creation is complete, the volume is available for connection via iSCSI.

CreateVolumeResult

CryptoKeyType Type of the Encryption Key.

DayOfWeek DayOfWeek is an object that contains information about the day of the week for a Schedule

DeleteAllSupportBundlesResult

DeleteAuthSessionRequest Deletes an individual auth session If the calling user is not in the ClusterAdmins / Administrator AccessGroup, only auth session belonging to the calling user can be deleted.

DeleteAuthSessionResult Return value from DeleteAuthSession.

DeleteAuthSessionsByClusterAdminRequest Deletes all auth sessions associated with the specified ClusterAdminID. If the specified ClusterAdminID maps to a group of users, all auth sessions for all members of that group will be deleted. To see the list of sessions that could be deleted, use ListAuthSessionsByClusterAdmin with the same parameter.

DeleteAuthSessionsByUsernameRequest Deletes all auth sessions for the given user. A caller not in AccessGroup ClusterAdmins / Administrator may only delete their own sessions. A caller with ClusterAdmins / Administrator privileges may delete sessions belonging to any user. To see the list of sessions that could be deleted, use ListAuthSessionsByUsername with the same parameters.

DeleteAuthSessionsResult Returns a list of AuthSessionInfos for those auth sessions deleted.

DeleteClusterInterfacePreferenceRequest Deletes an existing cluster interface preference.

DeleteClusterInterfacePreferenceResult

DeleteGroupSnapshotRequest DeleteGroupSnapshot enables you to delete a group snapshot. You can use the saveMembers parameter to preserve all the snapshots that were made for the volumes in the group, but the group association is removed.

DeleteGroupSnapshotResult

DeleteIdpConfigurationRequest Delete an existing configuration with a third party Identity Provider (IdP) for the cluster. Deleting the last IdP Configuration will remove the SAML Service Provider certificate from the cluster.

DeleteIdpConfigurationResult

DeleteInitiatorsRequest 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).

DeleteInitiatorsResult

DeleteKeyProviderKmipRequest Delete the specified inactive Key Provider.

DeleteKeyProviderKmipResult There is no additional data returned as the delete is considered successful as long as there is no error.

DeleteKeyServerKmipRequest Delete the specified KMIP (Key Management Interoperability Protocol) Key Server. A KMIP Key Server can be deleted unless it's the last one assigned to its provider, and that provider is active (providing keys which are currently in use).

DeleteKeyServerKmipResult There is no additional data returned as the delete is considered successful as long as there is no error.

DeleteQoSPolicyRequest You can use the DeleteQoSPolicy method to delete a QoS policy from the system. The QoS settings for all volumes created of modified with this policy are unaffected.

DeleteQoSPolicyResult

DeleteSnapMirrorEndpointsRequest The SolidFire Element OS web UI uses DeleteSnapMirrorEndpoints to delete one or more SnapMirror endpoints from the system.

DeleteSnapMirrorEndpointsResult

DeleteSnapMirrorRelationshipsRequest The SolidFire Element OS web UI uses the DeleteSnapMirrorRelationships method to remove one or more SnapMirror relationships between a source and destination endpoint.

DeleteSnapMirrorRelationshipsResult

DeleteSnapshotRequest DeleteSnapshot enables you 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. For more details on rolling back snapshots, see RollbackToSnapshot.

DeleteSnapshotResult

DeleteStorageContainerResult

DeleteStorageContainersRequest DeleteStorageContainers enables you to remove up to 2000 Virtual Volume (VVol) storage containers from the system at one time. The storage containers you remove must not contain any VVols.

DeleteVolumeAccessGroupRequest DeleteVolumeAccessGroup enables you to delete a volume access group.

DeleteVolumeAccessGroupResult

DeleteVolumeRequest DeleteVolume marks an active volume for deletion. When marked, the volume is purged (permanently deleted) after the cleanup interval elapses. After making a request to delete a volume, any active iSCSI connections to the volume are immediately terminated and no further connections are allowed while the volume is 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 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 that 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 resume. 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.

DeleteVolumeResult

DeleteVolumesRequest 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.

DeleteVolumesResult

DetailedService

DisableBmcColdResetResult DisableBmcColdResetResult returns the time between reset intervals. The interval should always be 0 after the command completes.

DisableClusterSshResult

DisableEncryptionAtRestResult

DisableIdpAuthenticationResult

DisableLdapAuthenticationResult

DisableMaintenanceModeRequest Take a node out of maintenance mode. This should be called after maintenance is complete and the node is online.

DisableSnmpResult

DisableSshResult

Drive

DriveConfigInfo

DriveEncryptionCapabilityType This specifies a drive's encryption capability.

DriveHardware

DriveHardwareInfo

DriveInfo

DrivesConfigInfo

DrivesHardware

DriveStats

EnableBmcColdResetRequest EnableBmcColdReset enables a background task that periodically resets the Baseboard Management Controller (BMC) for all nodes in the cluster.

EnableBmcColdResetResult EnableBmcColdReset returns the time between reset intervals.

EnableClusterSshRequest Enables SSH on all nodes in the cluster. Overwrites previous duration.

EnableClusterSshResult

EnableEncryptionAtRestRequest Initiate the process of setting a password on self-encrypting drives (SEDs) within the cluster. This feature is not enabled by default but can be toggled on and off as needed. If a password is set on a SED which is removed from the cluster, the password will remain set and the drive is not secure erased. Data can be secure erased using the SecureEraseDrives API method. Note: This does not affect performance or efficiency. If no parameters are specified, the password will be generated internally and at random (the only option for endpoints prior to 12.0). This generated password will be distributed across the nodes using Shamir's Secret Sharing Algorithm such that at least two nodes are required to reconstruct the password. The complete password to unlock the drives is not stored on any single node and is never sent across the network in its entirety. This protects against the theft of any number of drives or a single node. If a keyProviderID is specified then the password will be generated/retrieved as appropriate per the type of provider. Commonly this would be via a KMIP (Key Management Interoperability Protocol) Key Server in the case of a KMIP Key Provider (see CreateKeyProviderKmip). After this operation the specified provider will be considered 'active' and will not be able to be deleted until DisableEncryptionAtRest is called.

EnableEncryptionAtRestResult

EnableFeatureRequest You can use EnableFeature to enable cluster features that are disabled by default.

EnableFeatureResult

EnableIdpAuthenticationRequest Enable support for authentication using a third party Identity Provider (IdP) for the cluster. Once IdP authentication is enabled, cluster and Ldap admins will no longer be able to access the cluster via supported UIs and any active authenticated sessions will be invalidated/logged out. Only third party IdP authenticated users will be able to access the cluster via the supported UIs.

EnableIdpAuthenticationResult

EnableLdapAuthenticationRequest The EnableLdapAuthentication method enables you to configure an LDAP directory connection to use for LDAP authentication to a cluster. Users that are members of the LDAP directory can then log in to the storage system using their LDAP credentials.

EnableLdapAuthenticationResult

EnableMaintenanceModeRequest Prepare a node for maintenance. Maintenance includes anything that will require the node to be powered-off or restarted.

EnableSnmpRequest EnableSnmp enables you to enable SNMP on cluster nodes. When you enable SNMP, the action applies to all nodes in the cluster, and the values that are passed replace, in whole, all values set in any previous call to EnableSnmp.

EnableSnmpResult

EnableSshResult

EncryptionKeyInfo Information of a key managed by the Key Service.

EventInfo

FeatureObject

FibreChannelPortInfo Fibre Channel Node Port Info object returns information about all Fibre Channel ports on a node, or for one node in the cluster. The same information is returned for all ports or port information for one node. This information is returned with the API method ListNodeFibreChannelPortInfo (in the SolidFire API Guide).

FibreChannelPortInfoResult Used to return information about the Fibre Channel ports.

FibreChannelPortList List of all Fibre Channel ports.

FibreChannelSession FibreChannelSession contains information about each Fibre Channel session that is visible to the cluster and what target ports it is visible on.

FipsDrivesStatusType This specifies a node's FIPS 140-2 compliance status.

FipsErrorNodeReportErrorType

FipsErrorNodeReportType Error description about why a node failed to gather FIPS information.

FipsNodeReportType FIPS related information for a node.

GetAccountByIDRequest GetAccountByID enables you to return details about a specific account, given its accountID.

GetAccountByNameRequest GetAccountByName enables you to retrieve details about a specific account, given its username.

GetAccountEfficiencyRequest GetAccountEfficiency enables you to retrieve efficiency statistics about a volume account. This method returns efficiency information only for the account you specify as a parameter.

GetAccountResult

GetActiveTlsCiphersResult

GetAPIResult

GetAsyncResultRequest You can use GetAsyncResult to retrieve the result of asynchronous method calls. Some method calls require some time to run, and might not be finished when the system sends the initial response. To obtain the status or result of the method call, use GetAsyncResult to poll the asyncHandle value returned by the method. 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.

GetBackupTargetRequest GetBackupTarget enables you to return information about a specific backup target that you have created.

GetBackupTargetResult

GetBinAssignmentPropertiesResult

GetBootstrapConfigResult

GetClientCertificateSignRequestResult

GetClusterCapacityResult

GetClusterConfigResult

GetClusterFullThresholdResult

GetClusterHardwareInfoRequest 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 details about manufacturers, vendors, versions, and other associated hardware identification information.

GetClusterHardwareInfoResult

GetClusterInfoResult

GetClusterInterfacePreferenceRequest Retrieves an existing cluster interface preference.

GetClusterInterfacePreferenceResult

GetClusterMasterNodeIDResult

GetClusterSshInfoResult

GetClusterStateRequest The GetClusterState API method enables you 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 an active member of a cluster and may not be added to another cluster. Note: This method is available only through the per-node API endpoint 5.0 or later.

GetClusterStateResult

GetClusterStatsResult

GetClusterStructureResult

GetClusterVersionInfoResult

GetConfigResult

GetCurrentClusterAdminResult

GetDriveConfigResult

GetDriveHardwareInfoRequest GetDriveHardwareInfo returns all the hardware information for the given drive. This generally includes details about manufacturers, vendors, versions, and other associated hardware identification information.

GetDriveHardwareInfoResult

GetDriveStatsRequest GetDriveStats returns 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. You might not obtain statistical data for both block and metadata drives when you run this method.

GetDriveStatsResult

GetEfficiencyResult

GetEncryptionAtRestInfoResult

GetFeatureStatusRequest GetFeatureStatus enables you to retrieve the status of a cluster feature.

GetFeatureStatusResult

GetFipsReportResult An array of objects, one from each node in the cluster, indicating FIPS information.

GetHardwareConfigResult

GetHardwareInfoResult

GetIdpAuthenticationStateResult Return information regarding the state of authentication using third party Identity Providers

GetIpmiConfigNodesResult

GetIpmiConfigRequest GetIpmiConfig enables you to retrieve hardware sensor information from sensors that are in your node.

GetIpmiConfigResult

GetIpmiInfoResult

GetKeyProviderKmipRequest Returns the specified KMIP (Key Management Interoperability Protocol) Key Provider object.

GetKeyProviderKmipResult

GetKeyServerKmipRequest Returns the specified KMIP (Key Management Interoperability Protocol) Key Server object.

GetKeyServerKmipResult

GetLdapConfigurationResult

GetLicenseKeyResult

GetLimitsResult Limits for the cluster

GetLldpConfigResult This result represents the current LLDP configuration state

GetLoginBannerResult

GetLoginSessionInfoResult

GetNetworkConfigResult

GetNodeActiveTlsCiphersResult

GetNodeFipsDrivesReportResult This specifies a node's FIPS 140-2 drive capability status

GetNodeHardwareInfoRequest GetNodeHardwareInfo enables you to return all the hardware information and status for the node specified. This generally includes details about manufacturers, vendors, versions, and other associated hardware identification information.

GetNodeHardwareInfoResult

GetNodeSSLCertificateResult

GetNodeStatsRequest GetNodeStats enables you to retrieve the high-level activity measurements for a single node.

GetNodeStatsResult

GetNodeSupportedTlsCiphersResult

GetNtpInfoResult

GetNvramInfoRequest GetNvramInfo enables you to retrieve information from each node about the NVRAM card.

GetNvramInfoResult

GetOntapVersionInfoRequest The SolidFire Element OS web UI uses GetOntapVersionInfo to get information about API version support from the ONTAP cluster in a SnapMirror relationship.

GetOntapVersionInfoResult

GetOriginNode

GetOriginNodeResult

GetOriginResult

GetPatchInfoRequest GetPatchInfo enables you to display the details of D-patch information for the given node.

GetPatchInfoResult

GetPendingOperationResult

GetProtectionDomainLayoutResult

GetProtectionSchemesResult

GetQoSPolicyRequest You can use the GetQoSPolicy method to get details about a specific QoSPolicy from the system.

GetQoSPolicyResult

GetRemoteLoggingHostsResult

GetScheduleRequest You can use the GetSchedule method to retrieve information about a scheduled snapshot. You can see information about a specific schedule if there are many snapshot schedules in the system. You also retrieve information about more than one schedule with this method by specifying additional scheduleIDs in the parameter.

GetScheduleResult

GetSnapMirrorClusterIdentityRequest The SolidFire Element OS web UI uses GetSnapMirrorClusterIdentity to get identity information about the ONTAP cluster.

GetSnapMirrorClusterIdentityResult

GetSnmpACLResult

GetSnmpInfoResult

GetSnmpStateResult

GetSnmpTrapInfoResult

GetSoftwareEncryptionAtRestInfoResult Software Encryption-At-Rest (SEAR) Info object returns information the cluster uses to encrypt data at rest.

GetSshInfoResult

GetSSLCertificateResult

GetStorageContainerEfficiencyRequest GetStorageContainerEfficiency enables you to retrieve efficiency information about a virtual volume storage container.

GetStorageContainerEfficiencyResult

GetSupportedTlsCiphersResult

GetSystemStatusResult

GetVirtualVolumeCountResult

GetVolumeAccessGroupEfficiencyRequest GetVolumeAccessGroupEfficiency enables you to retrieve efficiency information about a volume access group. Only the volume access group you provide as the parameter in this API method is used to compute the capacity.

GetVolumeAccessGroupLunAssignmentsRequest The GetVolumeAccessGroupLunAssignments method enables you to retrieve details on LUN mappings of a specified volume access group.

GetVolumeAccessGroupLunAssignmentsResult

GetVolumeCountResult

GetVolumeEfficiencyRequest GetVolumeEfficiency enables you to retrieve information about a volume. Only the volume you give as a parameter in this API method is used to compute the capacity.

GetVolumeEfficiencyResult

GetVolumeStatsRequest GetVolumeStats enables you to retrieve high-level activity measurements for a single volume. Values are cumulative from the creation of the volume.

GetVolumeStatsResult

GroupCloneVolumeMember Represents the relationship between the source Volume and cloned Volume IDs.

GroupSnapshot Group Snapshot object represents a point-in-time copy of a group of volumes.

GroupSnapshotMembers List of checksum, volumeIDs and snapshotIDs for each member of the group.

GroupSnapshotRemoteStatus

IdpConfigInfo Configuration and integration details regarding a third party Identity Provider (IdP).

InitializeSnapMirrorRelationshipRequest The SolidFire Element OS web UI uses the InitializeSnapMirrorRelationship method to initialize the destination volume in a SnapMirror relationship by performing an initial baseline transfer between clusters.

InitializeSnapMirrorRelationshipResult

Initiator Object containing the characteristics of an iSCSI or Fibre Channel initiator.

InvokeSFApiRequest This will invoke any API method supported by the SolidFire API for the version and port the connection is using. Returns a nested hashtable of key/value pairs that contain the result of the invoked method.

IpmiInfo

ISCSIAuthentication Object containing the authentication information for an iSCSI session.

ISCSISession Information about an iSCSI session.

KeyProviderKmip A Key Provider describes both a mechanism and a location for retrieving authentication keys for use with cluster features such as Encryption At Rest. Some Key Providers may imply that there can only be one Key Provider of that type, while others may allow multiple Key Providers of the same type but retrieving authentication keys from different locations for different purposes. A KMIP (Key Management Interoperability Protocol) Key Provider can represent a single KMIP server, a logical cluster of KMIP servers which should be kept in sync, or an actual cluster which we treat as a single server. There can be multiple KMIP Key Providers but they must contain mutually-exclusive sets of servers. Key UUID's will only be considered as unique within a Key Provider so there could be collisions (and resulting errors) otherwise.

KeyServerKmip A KMIP (Key Management Interoperability Protocol) Key Server describes a location for retrieving authentication keys for use with cluster features such as Encryption At Rest.

LdapConfiguration LDAP Configuration object returns information about the LDAP configuration on SolidFire storage. LDAP information is returned with the API method GetLdapConfiguration.

ListAccountsRequest ListAccounts returns the entire list of accounts, with optional paging support.

ListAccountsResult

ListActiveNodesResult

ListActivePairedVolumesRequest ListActivePairedVolumes enables you to list all the active volumes paired with a volume. This method returns information about volumes with active and pending pairings.

ListActivePairedVolumesResult

ListActiveVolumesRequest ListActiveVolumes enables you 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).

ListActiveVolumesResult

ListAllNodesResult

ListAsyncResultsRequest 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.

ListAsyncResultsResult

ListAuthSessionsByClusterAdminRequest List all auth sessions associated with the specified ClusterAdminID. If the specified ClusterAdminID maps to a group of users, all auth sessions for all members of that group will be listed.

ListAuthSessionsByUsernameRequest Lists all auth sessions for the given user. A caller not in AccessGroup ClusterAdmins / Administrator privileges may only list their own sessions. A caller with ClusterAdmins / Administrator privileges may list sessions belonging to any user.

ListAuthSessionsResult Returns a list of AuthSessionInfos.

ListBackupTargetsResult

ListBulkVolumeJobsResult

ListClusterAdminsResult

ListClusterFaultsRequest ListClusterFaults enables you to retrieve information about any faults detected on the cluster. With this method, you can retrieve both current faults as well as faults that have been resolved. The system caches faults every 30 seconds.

ListClusterFaultsResult

ListClusterInterfacePreferencesResult

ListClusterPairsResult

ListDeletedVolumesRequest ListDeletedVolumes enables you to retrieve the list of volumes that have been marked for deletion and purged from the system.

ListDeletedVolumesResult

ListDriveHardwareRequest ListDriveHardware returns all the drives connected to a node. Use this method on individual nodes to return drive hardware information or use this method on the cluster master node MVIP to see information for all the drives on all nodes. Note: The "securitySupported": true line of the method response does not imply that the drives are capable of encryption; only that the security status can be queried. If you have a node type with a model number ending in "-NE", commands to enable security features on these drives will fail. See the EnableEncryptionAtRest method for more information.

ListDriveHardwareResult

ListDrivesResult

ListDriveStatsRequest 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.

ListDriveStatsResult

ListEventsRequest ListEvents returns events detected on the cluster, sorted from oldest to newest.

ListEventsResult

ListFibreChannelPortInfoResult ListFibreChannelPortInfoResult is used to return information about the Fibre Channel ports.

ListFibreChannelSessionsResult Used to return information about the Fibre Channel sessions.

ListGroupSnapshotsRequest ListGroupSnapshots enables you to get information about all group snapshots that have been created.

ListGroupSnapshotsResult

ListIdpConfigurationsRequest List configurations for third party Identity Provider(s) (IdP), optionally providing either enabledOnly flag to retrieve the currently enabled IdP configuration, or an IdP metadata UUID or IdP name to query a specific IdP configuration information.

ListIdpConfigurationsResult

ListInitiatorsRequest ListInitiators enables you to list initiator IQNs or World Wide Port Names (WWPNs).

ListInitiatorsResult

ListISCSISessionsResult

ListKeyProvidersKmipRequest Returns the list of KMIP (Key Management Interoperability Protocol) Key Providers which have been created via CreateKeyProviderKmip. The list can optionally be filtered by specifying additional parameters.

ListKeyProvidersKmipResult

ListKeyServersKmipRequest Returns the list of KMIP (Key Management Interoperability Protocol) Key Servers which have been created via CreateKeyServerKmip. The list can optionally be filtered by specifying additional parameters.

ListKeyServersKmipResult

ListNetworkInterfacesResult

ListNetworkInterfaceStatsResult

ListNodeFibreChannelPortInfoResult List of fibre channel port info results grouped by node.

ListNodeStatsResult

ListPendingActiveNodesResult

ListPendingNodesResult

ListProtectionDomainLevelsResult

ListProtocolEndpointsRequest ListProtocolEndpoints enables you to retrieve information about all protocol endpoints in the cluster. Protocol endpoints govern access to their associated virtual volume storage containers.

ListProtocolEndpointsResult

ListQoSPoliciesResult

ListSchedulesResult

ListServicesResult

ListSnapMirrorAggregatesRequest The SolidFire Element OS web UI uses the ListSnapMirrorAggregates method to list all SnapMirror aggregates that are available on the remote ONTAP system. An aggregate describes a set of physical storage resources.

ListSnapMirrorAggregatesResult

ListSnapMirrorEndpointsRequest The SolidFire Element OS web UI uses the ListSnapMirrorEndpoints method to list all SnapMirror endpoints that the SolidFire cluster is communicating with.

ListSnapMirrorEndpointsResult

ListSnapMirrorLunsRequest The SolidFire Element OS web UI uses the ListSnapMirrorLuns method to list the LUN information for the SnapMirror relationship from the remote ONTAP cluster.

ListSnapMirrorLunsResult

ListSnapMirrorNetworkInterfacesRequest The SolidFire Element OS web UI uses the ListSnapMirrorNetworkInterfaces method to list all available SnapMirror interfaces on a remote ONTAP system

ListSnapMirrorNetworkInterfacesResult

ListSnapMirrorNodesRequest The SolidFire Element OS web UI uses the ListSnapMirrorNodes method to get a list of nodes in a remote ONTAP cluster.

ListSnapMirrorNodesResult

ListSnapMirrorPoliciesRequest The SolidFire Element OS web UI uses the ListSnapMirrorPolicies method to list all SnapMirror policies on a remote ONTAP system.

ListSnapMirrorPoliciesResult

ListSnapMirrorRelationshipsRequest The SolidFire Element OS web UI uses the ListSnapMirrorRelationships method to list one or all SnapMirror relationships on a SolidFire cluster

ListSnapMirrorRelationshipsResult

ListSnapMirrorSchedulesRequest The SolidFire Element OS web UI uses the ListSnapMirrorSchedules method to get a list of schedules that are available on a remote ONTAP cluster.

ListSnapMirrorSchedulesResult

ListSnapMirrorVolumesRequest The SolidFire Element OS web UI uses the ListSnapMirrorVolumes method to list all SnapMirror volumes available on a remote ONTAP system.

ListSnapMirrorVolumesResult

ListSnapMirrorVserversRequest The SolidFire Element OS web UI uses the ListSnapMirrorVservers method to list all SnapMirror Vservers available on a remote ONTAP system.

ListSnapMirrorVserversResult

ListSnapshotsRequest ListSnapshots enables you to return the attributes of each snapshot taken on the volume. Information about snapshots that reside on the target cluster is displayed on the source cluster when this method is called from the source cluster.

ListSnapshotsResult

ListStorageContainersRequest ListStorageContainers enables you to retrieve information about all virtual volume storage containers known to the system.

ListStorageContainersResult

ListSyncJobsResult

ListTestsResult

ListUtilitiesResult

ListVirtualNetworksRequest ListVirtualNetworks enables you to list all configured virtual networks for the cluster. You can use this method to verify the virtual network settings in the cluster. There are no required parameters for this method. However, to filter the results, you can pass one or more VirtualNetworkID or VirtualNetworkTag values.

ListVirtualNetworksResult

ListVirtualVolumeBindingsRequest ListVirtualVolumeBindings returns a list of all virtual volumes in the cluster that are bound to protocol endpoints.

ListVirtualVolumeBindingsResult

ListVirtualVolumeHostsRequest ListVirtualVolumeHosts returns a list of all virtual volume hosts known to the cluster. A virtual volume host is a VMware ESX host that has initiated a session with the VASA API provider.

ListVirtualVolumeHostsResult

ListVirtualVolumesRequest 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.

ListVirtualVolumesResult

ListVirtualVolumeTasksRequest ListVirtualVolumeTasks returns a list of virtual volume tasks in the system.

ListVirtualVolumeTasksResult

ListVolumeAccessGroupsRequest ListVolumeAccessGroups enables you to return information about the volume access groups that are currently in the system.

ListVolumeAccessGroupsResult

ListVolumeQoSHistogramsRequest ListVolumeQoSHistograms returns histograms detailing volume performance relative to QOS settings. It may take up to 5 seconds for newly created volumes to have accurate histogram data available.

ListVolumeQoSHistogramsResult

ListVolumesForAccountRequest ListVolumesForAccount returns the list of active and (pending) deleted volumes for an account.

ListVolumesForAccountResult

ListVolumesRequest The ListVolumes method enables you to retrieve 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.

ListVolumesResult

ListVolumeStatsByAccountRequest ListVolumeStatsByAccount returns high-level activity measurements for every account. Values are summed from all the volumes owned by the account.

ListVolumeStatsByAccountResult

ListVolumeStatsByVirtualVolumeRequest ListVolumeStatsByVirtualVolume enables you to list volume statistics for any volumes in the system that are associated with virtual volumes. Statistics are cumulative from the creation of the volume.

ListVolumeStatsByVirtualVolumeResult

ListVolumeStatsByVolumeAccessGroupRequest ListVolumeStatsByVolumeAccessGroup enables you to get total activity measurements for all of the volumes that are a member of the specified volume access group(s).

ListVolumeStatsByVolumeAccessGroupResult

ListVolumeStatsByVolumeRequest ListVolumeStatsByVolume returns high-level activity measurements for every volume, by volume. Values are cumulative from the creation of the volume.

ListVolumeStatsByVolumeResult

ListVolumeStatsRequest ListVolumeStats returns high-level activity measurements for a single volume, list of volumes, or all volumes (if you omit the volumeIDs parameter). Measurement values are cumulative from the creation of the volume.

ListVolumeStatsResult

LldpConfig LLDP configuration items

LoggingServer

LoginBanner

LoginSessionInfo

LunAssignment VolumeID and Lun assignment.

MaintenanceMode Which mode a node is in when it is having maintenenace peformed.

MaintenanceModeResult

MetadataHosts The volume services on which the volume metadata resides.

ModifyAccountRequest ModifyAccount enables you to modify an existing account. When you lock an account, any existing connections from that account are immediately terminated. When you change an account's CHAP settings, any existing connections remain active, and the new CHAP settings are used on subsequent connections or reconnections. To clear an account's attributes, specify {} for the attributes parameter.

ModifyAccountResult

ModifyBackupTargetRequest ModifyBackupTarget enables you to change attributes of a backup target.

ModifyBackupTargetResult

ModifyClusterAdminRequest You can use ModifyClusterAdmin to change the settings for a cluster admin, LDAP cluster admin, or third party Identity Provider (IdP) cluster admin. You cannot change access for the administrator cluster admin account.

ModifyClusterAdminResult

ModifyClusterFullThresholdRequest You can use ModifyClusterFullThreshold to change the level at which the system generates an event when the storage cluster approaches a certain capacity utilization. You can use the threshold settings to indicate the acceptable amount of utilized block storage or metadata storage before the system generates a warning. For example, if you want to be alerted when the system reaches 3% below the "Error" level block storage utilization, enter a value of "3" for the stage3BlockThresholdPercent parameter. If this level is reached, the system sends an alert to the Event Log in the Cluster Management Console.

ModifyClusterFullThresholdResult

ModifyClusterInterfacePreferenceRequest Modifies an existing cluster interface preference.

ModifyClusterInterfacePreferenceResult

ModifyGroupSnapshotRequest ModifyGroupSnapshot enables you to change the attributes of a group of snapshots. You can also use this method to enable snapshots created on the Read/Write (source) volume to be remotely replicated to a target SolidFire storage system.

ModifyGroupSnapshotResult

ModifyInitiator Object containing characteristics of each initiator to modify.

ModifyInitiatorsRequest ModifyInitiators enables you to change the attributes of one or more existing initiators. You cannot change the name of an existing initiator. If you need to change the name of an initiator, delete it first 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 modify any initiators (no partial completion is possible).

ModifyInitiatorsResult

ModifyKeyServerKmipRequest Modifies a KMIP (Key Management Interoperability Protocol) Key Server to the specified attributes. The only required parameter is the keyServerID. A request which contains only the keyServerID will be a no-op and no error will be returned. Any other parameters which are specified will replace the existing values on the KMIP Key Server with the specified keyServerID. Because this server might be part of an active provider this will result in contacting the server to verify it's functional. Multiple hostnames or IP addresses must only be provided to the kmipKeyServerHostnames parameter if the key servers are in a clustered configuration.

ModifyKeyServerKmipResult

ModifyQoSPolicyRequest You can use the ModifyQoSPolicy method to modify an existing QoSPolicy on the system.

ModifyQoSPolicyResult

ModifyScheduleRequest ModifySchedule enables you to change the intervals at which a scheduled snapshot occurs. This allows for adjustment to the snapshot frequency and retention.

ModifyScheduleResult

ModifySnapMirrorEndpointRequest The SolidFire Element OS web UI uses the ModifySnapMirrorEndpoint method to change the name and management attributes for a SnapMirror endpoint.

ModifySnapMirrorEndpointResult

ModifySnapMirrorEndpointUnmanagedRequest The SolidFire Element OS web UI uses the ModifySnapMirrorEndpoint method to change the name and management attributes for a SnapMirror endpoint.

ModifySnapMirrorEndpointUnmanagedResult

ModifySnapMirrorRelationshipRequest You can use ModifySnapMirrorRelationship to change the intervals at which a scheduled snapshot occurs. You can also delete or pause a schedule by using this method.

ModifySnapMirrorRelationshipResult

ModifySnapshotRequest ModifySnapshot enables you to change the attributes currently assigned to a snapshot. You can use this method to enable snapshots created on the Read/Write (source) volume to be remotely replicated to a target SolidFire storage system.

ModifySnapshotResult

ModifyStorageContainerRequest ModifyStorageContainer enables you to make changes to an existing virtual volume storage container.

ModifyStorageContainerResult

ModifyVirtualNetworkRequest You can use ModifyVirtualNetwork to change the attributes of an existing virtual network. This method enables you to add or remove address blocks, change the netmask, or modify the name or description of the virtual network. You can also use it to enable or disable namespaces, as well as add or remove a gateway if namespaces are enabled on the virtual network. Note: This method requires either the VirtualNetworkID or the VirtualNetworkTag as a parameter, but not both. Caution: Enabling or disabling the Routable Storage VLANs functionality for an existing virtual network by changing the "namespace" parameter disrupts any traffic handled by the virtual network. NetApp strongly recommends changing the "namespace" parameter only during a scheduled maintenance window.

ModifyVolumeAccessGroupLunAssignmentsRequest The ModifyVolumeAccessGroupLunAssignments method enables you to define custom LUN assignments for specific volumes. This method changes only LUN values set on the lunAssignments parameter in the volume access group. All other LUN assignments remain unchanged. LUN assignment values must be unique for volumes in a volume access group. You cannot define duplicate LUN values within a volume access group. However, you can use the same LUN values again in different volume access groups. Note: Correct LUN values are 0 through 16383. The system generates an exception if you pass a LUN value outside of this range. None of the specified LUN assignments are modified if there is an exception. Caution: If you change a LUN assignment for a volume with active I/O, the I/O can be disrupted. You might need to change the server configuration before changing volume LUN assignments.

ModifyVolumeAccessGroupLunAssignmentsResult

ModifyVolumeAccessGroupRequest You can use ModifyVolumeAccessGroup to update initiators and add or remove volumes from a volume access group. If a specified initiator or volume is a duplicate of what currently exists, the volume access group is left as-is. If you do not specify a value for volumes or initiators, the current list of initiators and volumes is not changed.

ModifyVolumeAccessGroupResult

ModifyVolumePairRequest ModifyVolumePair enables you to pause or restart replication between a pair of volumes.

ModifyVolumePairResult

ModifyVolumeRequest ModifyVolume enables you to modify settings on an existing volume. You can make modifications to one volume at a time and changes take place immediately. If you do not specify QoS values when you modify a volume, they remain the same as before the modification. You can retrieve default QoS values for a newly created volume by running the GetDefaultQoS method. When you need to increase the size of a volume that is being replicated, do so in the following order to prevent replication errors: 1. Increase the size of the "Replication Target" volume. 2. Increase the size of the source or "Read / Write" volume. Both the target and source volumes must be of the same size. Note: If you change the "access" status to locked or target, all existing iSCSI connections are terminated.

ModifyVolumeResult

ModifyVolumesRequest 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. Both the target and source volumes must be of the same size. NOTE: If you change access status to locked or replicationTarget all existing iSCSI connections are terminated.

ModifyVolumesResult

Network

NetworkConfig

NetworkConfigParams

NetworkInterface

NetworkInterfaceStats Statistics for a network interface.

NetworkParams

NewDrive

Node A node refers to an individual machine in a cluster. Each active node hosts a master service, which is responsible for managing any drives or other services for that node. After a node becomes active, any drives associated with the node will become available for addition to the cluster.

NodeDriveHardware

NodeProtectionDomains Identifies a Node and Protection Domains associated with it.

NodeSshInfo

NodeStateInfo

NodeStateResult

NodeStatsInfo

NodeStatsNodes

NodeWaitingToJoin

NvramInfo

OntapVersionInfo The ontapVersionInfo object contains information about the API version of the ONTAP cluster in a SnapMirror relationship. The SolidFire Element OS web UI uses the GetOntapVersionInfo API methods to get this information.

Origin

PairedCluster

PendingActiveNode A pending active node refers to a pending node that is in the process of joining a cluster as an active node. When the node becomes active, any drives associated with the node will become available for addition to the cluster.

PendingNode A "pending node" is a node that has not yet joined the cluster. Pending nodes can be added to a cluster using the AddNode method.

PendingOperation

PhysicalAdapter

Platform

ProposedClusterError

ProposedNodeErrorCode This specifies error code for a proposed node addition.

ProtectionDomain A ProtectionDomain is the Name and Type of a ProtectionDomain.

ProtectionDomainLevel A Protection Domain Level indicates the cluster's current Tolerance and Resiliency from the perspective of a specific Protection Domain Type.

ProtectionDomainResiliency ProtectionDomainResiliency indicates whether or not the cluster can automatically heal itself from one or more failures of its associated ProtectionDomainType. For the purposes of this method, a cluster is considered healed when Tolerance is restored at a Node level, which means it can continue reading and writing data through the failure of any single Node.

ProtectionDomainServiceReplicaBudget

ProtectionDomainTolerance ProtectionDomainTolerance is the ability of the cluster to continue reading and writing data through one or more ProtectionDomain failures of the associated ProtectionDomainType.

ProtectionDomainType A Protection Domain is a set of one or more components whose simultaneous failure is protected from causing data unavailability or loss. This specifies one of the types of Protection Domains recognized by this cluster.

ProtectionScheme The method of protecting data on the cluster

ProtectionSchemeCategory The category of the protection scheme.

ProtectionSchemeInfo

ProtectionSchemeResiliency ProtectionSchemeResiliency indicates whether or not, for a specific Protection Scheme, the cluster can automatically heal itself from one or more failures of its associated ProtectionDomainType. For the purposes of this method, a cluster is considered healed when Tolerance is restored at a Node level, which means it can continue reading and writing data through the failure of any single Node.

ProtectionSchemeTolerance ProtectionSchemeTolerance is how many simultaneous failures, for a specific Protection Scheme, can be sustained through which the cluster can continue to read and write data.

ProtectionSchemeVisibility The public visibility of the protection scheme.

ProtocolEndpoint

PurgeDeletedVolumeRequest PurgeDeletedVolume immediately and permanently purges a volume that has been deleted. You must delete a volume 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.

PurgeDeletedVolumeResult

PurgeDeletedVolumesRequest 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.

PurgeDeletedVolumesResult

QoS Quality of Service (QoS) values are used on SolidFire volumes to provision performance expectations. Minimum, maximum and burst QoS values can be set within the ranges specified in the QoS table below. Volumes created without specified QoS values are created with the Default values listed below. Default values can be found by running the GetDefaultQoS method. minIOPS Min: 100/50 (v7.0/v8.0), Default: 100, Max: 15,000 maxIOPS Min: 100/50 (v7.0/v8.0), Default: 15,000, Max: 100,000 burstIOPS Min: 100/50 (v7.0/v8.0), Default: 15,000, Max: 100,000

QoSPolicy The QoSPolicy object contains information about a QoS policy on the cluster.

QuiesceSnapMirrorRelationshipRequest The SolidFire Element OS web UI uses the QuiesceSnapMirrorRelationship method to disable future data transfers for a SnapMirror relationship. If a transfer is in progress, the relationship status becomes "quiescing" until the transfer is complete. If the current transfer is aborted, it will not restart. You can reenable data transfers for the relationship using the ResumeSnapMirrorRelationship API method.

QuiesceSnapMirrorRelationshipResult

QuintileHistogram

RekeySoftwareEncryptionAtRestMasterKeyRequest Rekey the Software Encryption At Rest Master Key used to encrypt the DEKs (Data Encryption Keys).

RekeySoftwareEncryptionAtRestMasterKeyResult

RemoteClusterSnapshotStatus Status of the remote snapshot on the target cluster as seen on the source cluster

RemoteReplication Details on the volume replication.

RemoveAccountRequest RemoveAccount enables you to remove an existing account. You must delete and purge all volumes associated with the account using DeleteVolume before you can remove the account. If volumes on the account are still pending deletion, you cannot use RemoveAccount to remove the account.

RemoveAccountResult

RemoveBackupTargetRequest RemoveBackupTarget allows you to delete backup targets.

RemoveBackupTargetResult

RemoveClusterAdminRequest One can use this API to remove a local cluster admin, an LDAP cluster admin, or a third party Identity Provider (IdP) cluster admin. One cannot remove the administrator cluster admin account. When an IdP Admin is removed that has authenticated sessions associated with a third party Identity Provider (IdP), those sessions will either logout or possibly experience a loss of access rights within their current session. The access rights loss will depend on whether the removed IdP cluster admin matched one of multiple IdP cluster admins from a given user's SAML Attributes and the remaining set of matching IdP cluster admins results in a reduced set of aggregate access rights. Other cluster admin user types will be logged out upon their cluster admin removal.

RemoveClusterAdminResult

RemoveClusterPairRequest 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.

RemoveClusterPairResult

RemoveDrivesRequest You can use RemoveDrives to proactively remove drives that are part of the cluster. You might 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 might 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.

RemoveInitiatorsFromVolumeAccessGroupRequest RemoveInitiatorsFromVolumeAccessGroup enables you to remove initiators from a specified volume access group.

RemoveKeyServerFromProviderKmipRequest Remove (unassign) the specified KMIP (Key Management Interoperability Protocol) Key Server from the provider it was assigned to via AddKeyServerToProviderKmip (if any). A KMIP Key Server can be unassigned from its provider unless it's the last one and that provider is active (providing keys which are currently in use). If the specified KMIP Key Server is not assigned to a provider, this is a no-op and no error will be returned.

RemoveKeyServerFromProviderKmipResult There is no additional data returned as the remove is considered successful as long as there is no error.

RemoveNodesRequest RemoveNodes can be used to remove one or more nodes from the cluster. Before removing a node, you must remove all drives from the node using the RemoveDrives method. You cannot remove a node until the RemoveDrives process has completed and all data has been migrated off of the node's drives. After removing a node, the removed node registers itself as a pending node. You can add the pending node again or shut it down (shutting the node down removes it from the Pending Node list). RemoveNodes can fail with xEnsembleInvalidSize if removing the nodes would violate ensemble size restrictions. RemoveNodes can fail with xEnsembleQuorumLoss if removing the nodes would cause a loss of quorum. RemoveNodes can fail with xEnsembleToleranceChange if there are enabled data protection schemes that can tolerate multiple node failures and removing the nodes would decrease the ensemble's node failure tolerance. The optional ignoreEnsembleToleranceChange parameter can be set true to disable the ensemble tolerance check.

RemoveNodesResult

RemoveNodeSSLCertificateResult

RemoveSSLCertificateResult

RemoveVirtualNetworkRequest RemoveVirtualNetwork enables you to remove a previously added virtual network. Note: This method requires either the virtualNetworkID or the virtualNetworkTag as a parameter, but not both.

RemoveVirtualNetworkResult

RemoveVolumePairRequest RemoveVolumePair enables you to remove the remote pairing between two volumes. Use this method on both the source and target volumes that are paired together. When you remove the volume pairing information, data is no longer replicated to or from the volume.

RemoveVolumePairResult

RemoveVolumesFromVolumeAccessGroupRequest The RemoveVolumeFromVolumeAccessGroup method enables you to remove volumes from a volume access group.

ResetDriveDetails

ResetDrivesDetails

ResetDrivesRequest ResetDrives enables you to proactively initialize drives and remove all data currently residing on a drive. The drive can then be reused in an existing node or used in an upgraded node. This method requires the force parameter to be included in the method call.

ResetDrivesResult

ResetNodeDetails

ResetNodeRequest The ResetNode API method enables you to reset a node to the factory settings. All data, packages (software upgrades, and so on), configurations, and log files are deleted from the node when you call this method. However, network settings for the node are preserved during this operation. Nodes that are participating in a cluster cannot be reset to the factory settings. The ResetNode API can only be used on nodes that are in an "Available" state. It cannot be used on nodes that are "Active" in a cluster, or in a "Pending" state. Caution: This method clears any data that is on the node. Exercise caution when using this method. Note: This method is available only through the per-node API endpoint 5.0 or later.

ResetNodeResult

ResetNodeSupplementalTlsCiphersResult

ResetSupplementalTlsCiphersResult

RestartNetworkingRequest The RestartNetworking API method enables you 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. Note: This method is available only through the per-node API endpoint 5.0 or later.

RestartServicesRequest The RestartServices API method enables you to restart the services on a node. Caution: This method causes temporary node services interruption. Exercise caution when using this method. Note: This method is available only through the per-node API endpoint 5.0 or later.

RestoreDeletedVolumeRequest RestoreDeletedVolume marks a deleted volume as active again. This action makes the volume immediately available for iSCSI connection.

RestoreDeletedVolumeResult

ResumeSnapMirrorRelationshipRequest The SolidFire Element OS web UI uses the ResumeSnapMirrorRelationship method to enable future transfers for a quiesced SnapMirror relationship.

ResumeSnapMirrorRelationshipResult

ResyncSnapMirrorRelationshipRequest The SolidFire Element OS web UI uses the ResyncSnapMirrorRelationship method to establish or reestablish a mirror relationship between a source and destination endpoint. When you resync a relationship, the system removes snapshots on the destination volume that are newer than the common snapshot copy, and then mounts the destination volume as a data protection volume with the common snapshot copy as the exported snapshot copy.

ResyncSnapMirrorRelationshipResult

RollbackToGroupSnapshotRequest RollbackToGroupSnapshot enables you to roll back all individual volumes in a snapshot group to each volume's individual snapshot. Note: Rolling back to a group snapshot creates a temporary snapshot of each volume within the group snapshot. Snapshots are allowed if cluster fullness is at stage 2 or 3. Snapshots are not created when cluster fullness is at stage 4 or 5.

RollbackToGroupSnapshotResult

RollbackToSnapshotRequest RollbackToSnapshot enables you to make an existing snapshot of 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 you delete it. The previously "active" snapshot is deleted unless you set the parameter saveCurrentState to 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.

RollbackToSnapshotResult

RtfiInfo

Schedule Schedule is an object containing information about each schedule created to autonomously make a snapshot of a volume. The return object includes information for all schedules. If scheduleID is used to identify a specific schedule then only information for that scheduleID is returned. Schedules information is returned with the API method, see ListSchedules on the SolidFire API guide.

ScheduleInfo

ScheduleInfoObject

ScheduleObject ScheduleObject is an object containing information about each schedule created to autonomously make a snapshot of a volume. The return object includes information for all schedules. If scheduleID is used to identify a specific schedule then only information for that scheduleID is returned. Schedules information is returned with the API method, see ListSchedules on the SolidFire API guide.

SearRekeyMasterKeyState The state of a Software Encryption-At-Rest (SEAR) Rekey Master Key operation.

SecureEraseDrivesRequest SecureEraseDrives enables you to remove any residual data from drives that have a status of "available." You might want to use this method when replacing a drive nearing the end of its service life that contained sensitive data. This method uses a Security Erase Unit command to write a predetermined pattern to the drive and resets the encryption key on the drive. This asynchronous method might take up to two minutes to complete. You can use GetAsyncResult to check on the status of the secure erase operation. You can use the ListDrives method to obtain the driveIDs for the drives you want to secure erase.

Service

ServiceReplicaBudget

ServiceStrandedCapacity

SetClusterConfigRequest The SetClusterConfig API method enables you 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 Attributes. 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.

SetClusterConfigResult

SetClusterStructureRequest You can use the SetClusterStructure method to restore the storage cluster configuration information from a backup. When you call the method, pass the json result returned from the GetClusterStructure API containing the configuration information you want to restore.

SetClusterStructureResult

SetConfigRequest The SetConfig API method enables you 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. Note: This method is available only through the per-node API endpoint 5.0 or later. Caution: Changing the "bond-mode" on a node can cause a temporary loss of network connectivity. Exercise caution when using this method.

SetConfigResult

SetDefaultQoSRequest SetDefaultQoS enables you to configure the default Quality of Service (QoS) values (measured in inputs and outputs per second, or IOPS) for a volume. For more information about QoS in a SolidFire cluster, see the User Guide.

SetDefaultQoSResult

SetLicenseKeyRequest You can use the SetLicenseKey method to set the SerialNumber And OrderNumber for the cluster.

SetLicenseKeyResult

SetLldpConfigRequest Sets LLDP configuration options. If an option isn't set in the request, then it is unchanged from the previous value.

SetLoginBannerRequest You can use the SetLoginBanner method to set the active Terms of Use banner users see when they log on to the web interface.

SetLoginBannerResult

SetLoginSessionInfoRequest You can use SetLoginSessionInfo to set the period of time that a session's login authentication is valid. After the log in period elapses without activity on the system, the authentication expires. New login credentials are required for continued access to the cluster after the timeout period has elapsed.

SetLoginSessionInfoResult

SetNetworkConfigRequest The SetNetworkConfig API method enables you to set the network configuration for a node. To display the current network settings for a node, run the GetNetworkConfig API method. Note: This method is available only through the per-node API endpoint 5.0 or later. Changing the "bond-mode" on a node can cause a temporary loss of network connectivity. Exercise caution when using this method.

SetNetworkConfigResult

SetNodeSSLCertificateRequest You can use the SetNodeSSLCertificate method to set a user SSL certificate and private key for the management node.

SetNodeSSLCertificateResult

SetNodeSupplementalTlsCiphersRequest You can use the SetNodeSupplementalTlsCiphers method to specify the list of supplemental TLS ciphers for this node. You can use this command on management nodes.

SetNodeSupplementalTlsCiphersResult

SetNtpInfoRequest SetNtpInfo enables you to configure NTP on cluster nodes. The values you set with this interface apply to all nodes in the cluster. If an NTP broadcast server periodically broadcasts time information on your network, you can optionally configure nodes as broadcast clients. Note: NetApp recommends using NTP servers that are internal to your network, rather than the installation defaults.

SetNtpInfoResult

SetProtectionDomainLayoutRequest Used to assign Nodes to user-defined Protection Domains. This information must be provided for all Active Nodes in the cluster, and no information may be provided for Nodes that are not Active. All Nodes in a given Chassis must be assigned to the same user-defined Protection Domain. The same ProtectionDomainType must be supplied for all nodes. ProtectionDomainTypes that are not user-defined such as Node and Chassis, must not be included. If any of these are not true, the Custom Protection Domains will be ignored, and an appropriate error will be returned.

SetProtectionDomainLayoutResult

SetRemoteLoggingHostsRequest SetRemoteLoggingHosts enables you 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 GetRemoteLoggingHosts to determine what the current logging hosts are, and then use SetRemoteLoggingHosts to set the desired list of current and new logging hosts.

SetRemoteLoggingHostsResult

SetSnmpACLRequest SetSnmpACL enables you to configure SNMP access permissions on the cluster nodes. The values you 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.

SetSnmpACLResult

SetSnmpInfoRequest SetSnmpInfo enables you to configure SNMP version 2 and version 3 on cluster nodes. The values you 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: SetSnmpInfo is deprecated. Use the EnableSnmp and SetSnmpACL methods instead.

SetSnmpInfoResult

SetSnmpTrapInfoRequest You can use SetSnmpTrapInfo to enable and disable the generation of cluster SNMP notifications (traps) and to specify the set of network host computers that receive the notifications. The values you pass with each SetSnmpTrapInfo method call replace all values set in any previous call to SetSnmpTrapInfo.

SetSnmpTrapInfoResult

SetSSLCertificateRequest You can use the SetSSLCertificate method to set a user SSL certificate and a private key for the cluster.

SetSSLCertificateResult

SetSupplementalTlsCiphersRequest You can use the SetSupplementalTlsCiphers method to specify the list of supplemental TLS ciphers.

SetSupplementalTlsCiphersResult

ShutdownRequest 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, log in to the MIP for the pending node, and enter the "shutdown" method with either the "restart" or "halt" options.

ShutdownResult

Signature

SnapMirrorAggregate The snapMirrorAggregate object contains information about the available ONTAP aggregates, which are collections of disks made available to volumes as storage. You can get this information using the ListSnapMirrorAggregates API method.

SnapMirrorClusterIdentity The snapMirrorClusterIdentity object contains identification information about the remote ONTAP cluster in a SnapMirror relationship.

SnapMirrorEndpoint The snapMirrorEndpoint object contains information about the remote SnapMirror storage systems communicating with the SolidFire cluster. You can retrieve this information with the ListSnapMirrorEndpoints API method.

SnapMirrorJobScheduleCronInfo The snapMirrorJobScheduleCronInfo object contains information about a cron job schedule on the ONTAP system.

SnapMirrorLunInfo The snapMirrorLunInfo object contains information about the ONTAP LUN object.

SnapMirrorNetworkInterface The snapMirrorNetworkInterface object contains information about the intercluster Logical Interface (LIF) names.

SnapMirrorNode The snapMirrorNode object contains information about the nodes of the destination ONTAP cluster in a SnapMirror relationship.

SnapMirrorPolicy The snapMirrorPolicy object contains information about a SnapMirror policy that is stored on an ONTAP system.

SnapMirrorPolicyRule The snapMirrorPolicyRule object contains information about the rules in a SnapMirror policy.

SnapMirrorRelationship The snapMirrorRelationship object contains information about a SnapMirror relationship between a SolidFire volume and an ONTAP volume.

SnapMirrorVolume The snapMirrorVolume object contains information about an ONTAP volume.

SnapMirrorVolumeInfo The snapMirrorVolumeInfo object contains information about a volume location in a SnapMirror relationship, such as its name and type.

SnapMirrorVserver The snapMirrorVserver object contains information about the Storage Virtual Machines (or Vservers) at the destination ONTAP cluster.

SnapMirrorVserverAggregateInfo The snapMirrorVserverAggregateInfo object contains information about the available data Storage Virtual Machines (also called Vservers) at the destination ONTAP cluster.

Snapshot Snapshots is an object containing information about each snapshot made for a volume. The return object includes information for the active snapshot as well as each snapshot created for the volume.

SnapshotRemoteStatus

SnapshotReplication

SnmpNetwork The SNMP network object contains information about SNMP configuration for the cluster nodes. SNMP v3 is supported on SolidFire clusters.

SnmpSendTestTrapsResult

SnmpTrapRecipient Host that is to receive the traps generated by the cluster.

SnmpV3UsmUser The SNMP v3 usmUser object is used with the API method SetSnmpInfo to configure SNMP on the cluster.

SoftwareVersionInfo

The API for controlling a SolidFire cluster.

StartBulkVolumeReadRequest StartBulkVolumeRead enables 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 an SF-series node. Communications and server interaction information for external data access is passed by a script running on the 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 is complete. You can also read a snapshot of the volume by entering the ID of the snapshot as a parameter. When you read a previous snapshot, the system does not create a new snapshot of the volume or delete the previous snapshot 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.

StartBulkVolumeReadResult

StartBulkVolumeWriteRequest StartBulkVolumeWrite enables you to initialize a bulk volume write session on a specified volume. Only two bulk volume processes can run simultaneously on a volume. When you initialize the write session, data is written to a SolidFire storage volume from an external backup source. The external data is accessed by a web server running on an SF-series node. Communications and server interaction information for external data access is passed by a script running on the storage system.

StartBulkVolumeWriteResult

StartClusterPairingResult

StartVolumePairingRequest StartVolumePairing enables you 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.

StartVolumePairingResult

StorageContainer

SupportBundleDetails

SyncJob

TestAddressAvailabilityRequest You can use the TestAddressAvailability method to check to see if a certain IP address is inuse on an interface within the storage cluster.

TestAddressAvailabilityResult

TestConnectEnsembleDetails

TestConnectEnsembleRequest The TestConnectEnsemble API method enables you to verify connectivity with a specified database ensemble. By default, it uses the ensemble for the cluster that 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.

TestConnectEnsembleResult

TestConnectMvipDetails

TestConnectMvipRequest The TestConnectMvip API method enables you 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.

TestConnectMvipResult

TestConnectSvipDetails

TestConnectSvipRequest The TestConnectSvip API method enables you 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.

TestConnectSvipResult

TestDrivesRequest You can use the TestDrives API method to run a hardware validation on all drives on the node. This method detects hardware failures on the drives (if present) and reports them in the results of the validation tests. You can only use the TestDrives method on nodes that are not "active" in a cluster. Note: This test takes approximately 10 minutes. Note: This method is available only through the per-node API endpoint 5.0 or later.

TestDrivesResult

TestKeyProviderKmipRequest Test whether the specified Key Provider is functioning normally.

TestKeyProviderKmipResult There is no additional data returned as the test is considered successful as long as there is no error.

TestKeyServerKmipRequest Test whether the specified KMIP (Key Management Interoperability Protocol) Key Server is functioning normally.

TestKeyServerKmipResult There is no additional data returned as the test is considered successful as long as there is no error.

TestLdapAuthenticationRequest The TestLdapAuthentication method enables you to validate the currently enabled LDAP authentication settings. If the configuration is correct, the API call returns the group membership of the tested user.

TestLdapAuthenticationResult

TestPingRequest The TestPing API allows to test the reachability to IP address(s) using ICMP packets. Source address(v4 or v6), interface and vlan tag can be specified. If not Bond1G/10G network is used to reach the target address. 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.

TestPingResult

UpdateBulkVolumeStatusRequest You can use UpdateBulkVolumeStatus in a script to update the status of a bulk volume job that you started with the StartBulkVolumeRead or StartBulkVolumeWrite methods.

UpdateBulkVolumeStatusResult

UpdateIdpConfigurationRequest Update an existing configuration with a third party Identity Provider (IdP) for the cluster.

UpdateIdpConfigurationResult

UpdateSnapMirrorRelationshipRequest The SolidFire Element OS web UI uses the UpdateSnapMirrorRelationship method to make the destination volume in a SnapMirror relationship an up-to-date mirror of the source volume.

UpdateSnapMirrorRelationshipResult

VirtualNetwork

VirtualNetworkAddress

VirtualVolumeBinding

VirtualVolumeHost

VirtualVolumeInfo

VirtualVolumeStats Contains statistical data for an individual volume.

VirtualVolumeTask

Volume Volumes Info is an object containing information about a volume. The return objects only include "configured" information about the volume and not runtime or usage information. Information about paired volumes will also be returned.

VolumeAccess Describes host access for a volume.

VolumeAccessGroup A volume access group is a useful way of grouping volumes and initiators together for ease of management. Volume Access Group Limits: - A volume access group can contain up to sixty-four initiator IQNs. - An initiator can only beinteger to only one volume access group. - A volume access group can contain up to two thousand volumes. - Each volume access group can beinteger to a maximum of four other volume access groups.

VolumeAccessGroupLunAssignments VolumeAccessGroup ID and Lun to be assigned to all volumes within it.

VolumePair The Volume Pair Info is an object containing information about a volume that is paired on a remote cluster. If the volume is not paired, this object is null.

VolumeQOS Quality of Service (QoS) Result values are used on SolidFire volumes to provision performance expectations.

VolumeQoSHistograms Contains histograms showing a volume's utilization relative to its QOS settings. The histograms are created by sampling inside the QOS manager.

VolumeStats Contains statistical data for an individual volume.

This interface makes a common request object when calling add or modify for an account