SolidFire Python SDK

https://solidfire-sdk-python.readthedocs.io/en/latest/
Admin
SolidFire Python SDK is a Python library that provides programmatic access to SolidFire storage...
Tokens:69,829
Snippets:187
Trust Score:8.3
Update:8 months ago
Show doc for...
Tokens:
Raw
### SolidFire SDK - Attributes and Methods

Source: https://solidfire-sdk-python.readthedocs.io/en/latest/genindex

This section details various attributes and methods available within the SolidFire Python SDK, categorized by their starting letter.

```APIDOC
## SolidFire SDK - Attributes and Methods

### Description
This section details various attributes and methods available within the SolidFire Python SDK, categorized by their starting letter.

### Attributes:

*   **unaligned_reads** (solidfire.models.ClusterStats, solidfire.models.VirtualVolumeStats, solidfire.models.VolumeStats)
*   **unaligned_writes** (solidfire.models.ClusterStats, solidfire.models.VirtualVolumeStats, solidfire.models.VolumeStats)
*   **unhealthy_reason** (solidfire.models.SnapMirrorRelationship)
*   **unique_blocks** (solidfire.models.ClusterCapacity)
*   **unique_blocks_used_space** (solidfire.models.ClusterCapacity)
*   **unique_id** (solidfire.models.ClusterInfo)
*   **up_and_running** (solidfire.models.NetworkConfig, solidfire.models.NetworkConfigParams, solidfire.models.PhysicalAdapter)
*   **url** (solidfire.models.StartBulkVolumeReadResult, solidfire.models.StartBulkVolumeWriteResult, solidfire.models.SupportBundleDetails, solidfire.models.UpdateBulkVolumeStatusResult)
*   **usable_capacity** (solidfire.models.Drive, solidfire.models.DriveInfo)
*   **used_capacity** (solidfire.models.DriveStats)
*   **used_memory** (solidfire.models.DriveStats, solidfire.models.NodeStatsInfo)
*   **used_metadata_space** (solidfire.models.ClusterCapacity)
*   **used_metadata_space_in_snapshots** (solidfire.models.ClusterCapacity)
*   **used_space** (solidfire.models.ClusterCapacity)
*   **user_dn** (solidfire.models.TestLdapAuthenticationResult)
*   **user_dntemplate** (solidfire.models.EnableLdapAuthenticationRequest, solidfire.models.LdapConfiguration)
*   **user_search_base_dn** (solidfire.models.EnableLdapAuthenticationRequest, solidfire.models.LdapConfiguration)
*   **user_search_filter** (solidfire.models.EnableLdapAuthenticationRequest, solidfire.models.LdapConfiguration)
*   **username** (solidfire.models.Account, solidfire.models.AddAccountRequest, solidfire.models.AddClusterAdminRequest, solidfire.models.AddIdpClusterAdminRequest, solidfire.models.AddLdapClusterAdminRequest, solidfire.models.AuthSessionInfo, solidfire.models.ClusterAdmin, solidfire.models.CreateClusterRequest, solidfire.models.CreateSnapMirrorEndpointRequest, solidfire.models.DeleteAuthSessionsByUsernameRequest, solidfire.models.GetAccountByNameRequest, solidfire.models.ListAuthSessionsByUsernameRequest, solidfire.models.ModifyAccountRequest, solidfire.models.ModifySnapMirrorEndpointRequest, solidfire.models.SnapMirrorEndpoint, solidfire.models.TestLdapAuthenticationRequest)
*   **usm_users** (solidfire.models.GetSnmpACLResult, solidfire.models.GetSnmpInfoResult, solidfire.models.SetSnmpACLRequest, solidfire.models.SetSnmpInfoRequest)
*   **utilities** (solidfire.models.ListUtilitiesResult)
*   **uuid** (solidfire.models.ClusterInfo, solidfire.models.DriveConfigInfo, solidfire.models.DriveHardware, solidfire.models.DriveHardwareInfo, solidfire.models.Node, solidfire.models.PendingNode)

### Methods:

*   **update_bulk_volume_status()** (solidfire.Element)
*   **update_idp_configuration()** (solidfire.Element)
*   **update_snap_mirror_relationship()** (solidfire.Element)

### Classes:

*   **UpdateBulkVolumeStatusRequest** (solidfire.models)
*   **UpdateBulkVolumeStatusResult** (solidfire.models)
*   **UpdateIdpConfigurationRequest** (solidfire.models)
*   **UpdateIdpConfigurationResult** (solidfire.models)
*   **UpdateSnapMirrorRelationshipRequest** (solidfire.models)
*   **UpdateSnapMirrorRelationshipResult** (solidfire.models)

```

--------------------------------

### SolidFire SDK Python - Attributes and Methods

Source: https://solidfire-sdk-python.readthedocs.io/en/latest/genindex

This section details various attributes and methods available within the SolidFire SDK for Python, categorized by their starting letter 'T'. It includes attributes for network sessions, utilization, tasks, and network configurations, as well as methods for testing connectivity and authentication. It also lists various request and result classes related to these tests.

```APIDOC
## SolidFire SDK Python - Attributes and Methods

### Description
This section details various attributes and methods available within the SolidFire SDK for Python, categorized by their starting letter 'T'. It includes attributes for network sessions, utilization, tasks, and network configurations, as well as methods for testing connectivity and authentication. It also lists various request and result classes related to these tests.

### Attributes
- **target_ip** (solidfire.models.ISCSISession attribute)
- **target_name** (solidfire.models.ISCSISession attribute)
- **target_port_name** (solidfire.models.ISCSISession attribute)
- **target_secret** (solidfire.models.Account attribute, solidfire.models.AddAccountRequest attribute, solidfire.models.CreateInitiator attribute, solidfire.models.CreateStorageContainerRequest attribute, solidfire.models.Initiator attribute, solidfire.models.ModifyAccountRequest attribute, solidfire.models.ModifyInitiator attribute, solidfire.models.ModifyStorageContainerRequest attribute, solidfire.models.StorageContainer attribute)
- **target_utilization_percentages** (solidfire.models.VolumeQoSHistograms attribute)
- **target_wwpn** (solidfire.models.FibreChannelSession attribute)
- **tasks** (solidfire.models.ListVirtualVolumeTasksResult attribute)
- **team0** (solidfire.models.Network attribute)
- **team1** (solidfire.models.Network attribute)
- **tests** (solidfire.models.ListTestsResult attribute)
- **thin_provisioning** (solidfire.models.GetEfficiencyResult attribute, solidfire.models.GetStorageContainerEfficiencyResult attribute, solidfire.models.GetVolumeEfficiencyResult attribute)
- **throttle** (solidfire.models.VirtualVolumeStats attribute, solidfire.models.VolumeStats attribute)
- **throttle_percentages** (solidfire.models.VolumeQoSHistograms attribute)
- **time_of_publish** (solidfire.models.EventInfo attribute)
- **time_of_report** (solidfire.models.EventInfo attribute)
- **time_published** (solidfire.models.BinAssignmentProperties attribute)
- **time_remaining** (solidfire.models.DisableClusterSshResult attribute, solidfire.models.EnableClusterSshResult attribute, solidfire.models.GetClusterSshInfoResult attribute)
- **timeout** (solidfire.models.EnableBmcColdResetRequest attribute, solidfire.models.EnableMaintenanceModeRequest attribute, solidfire.models.LoginSessionInfo attribute, solidfire.models.SetLoginSessionInfoRequest attribute, solidfire.models.TestAddressAvailabilityRequest attribute)
- **timeout_sec** (solidfire.models.CreateSupportBundleRequest attribute, solidfire.models.SupportBundleDetails attribute)
- **timestamp** (solidfire.models.ClusterCapacity attribute, solidfire.models.ClusterStats attribute, solidfire.models.DriveStats attribute, solidfire.models.GetEfficiencyResult attribute, solidfire.models.GetStorageContainerEfficiencyResult attribute, solidfire.models.GetVolumeEfficiencyResult attribute, solidfire.models.NodeStatsInfo attribute, solidfire.models.VirtualVolumeStats attribute, solidfire.models.VolumeQoSHistograms attribute, solidfire.models.VolumeStats attribute)
- **tls_ciphers** (solidfire.models.GetClusterStructureResult attribute, solidfire.models.SetClusterStructureRequest attribute)
- **to_be_deleted** (solidfire.apiactual.ApiSchedule attribute, solidfire.models.Schedule attribute)

### Methods
- **test_address_availability()** (solidfire.Element method)
- **test_connect_ensemble()** (solidfire.Element method)
- **test_connect_mvip()** (solidfire.Element method)
- **test_connect_svip()** (solidfire.Element method)
- **test_drives()** (solidfire.Element method)
- **test_key_provider_kmip()** (solidfire.Element method)
- **test_key_server_kmip()** (solidfire.Element method)
- **test_ldap_authentication()** (solidfire.Element method)
- **test_ping()** (solidfire.Element method)
- **timeout()** (solidfire.common.CurlDispatcher method, solidfire.common.ServiceBase method)
- **to_api_schedule()** (solidfire.adaptor.schedule_adaptor.ScheduleAdaptor static method)
- **to_api_schedule_info()** (solidfire.adaptor.schedule_adaptor.ScheduleAdaptor static method)

### Classes
- **TestAddressAvailabilityRequest** (class in solidfire.models)
- **TestAddressAvailabilityResult** (class in solidfire.models)
- **TestConnectEnsembleDetails** (class in solidfire.models)
- **TestConnectEnsembleRequest** (class in solidfire.models)
- **TestConnectEnsembleResult** (class in solidfire.models)
- **TestConnectMvipDetails** (class in solidfire.models)
- **TestConnectMvipRequest** (class in solidfire.models)
- **TestConnectMvipResult** (class in solidfire.models)
- **TestConnectSvipDetails** (class in solidfire.models)
- **TestConnectSvipRequest** (class in solidfire.models)
- **TestConnectSvipResult** (class in solidfire.models)
- **TestDrivesRequest** (class in solidfire.models)
- **TestDrivesResult** (class in solidfire.models)
- **TestKeyProviderKmipRequest** (class in solidfire.models)
- **TestKeyProviderKmipResult** (class in solidfire.models)
- **TestKeyServerKmipRequest** (class in solidfire.models)
- **TestKeyServerKmipResult** (class in solidfire.models)
- **TestLdapAuthenticationRequest** (class in solidfire.models)
- **TestLdapAuthenticationResult** (class in solidfire.models)
- **TestPingRequest** (class in solidfire.models)
- **TestPingResult** (class in solidfire.models)

```

--------------------------------

### Initialize SolidFire ServiceBase Connection

Source: https://solidfire-sdk-python.readthedocs.io/en/latest/solidfire.common

Demonstrates how to initialize a connection to an Element OS instance using the `ServiceBase` class. This involves providing management IP, username, password, and optionally API version, SSL verification status, and an HTTP dispatcher.

```python
from solidfire.common import ServiceBase

# Initialize connection with minimal parameters
service = ServiceBase(mvip='192.168.1.100', username='admin', password='password')

# Initialize connection with specific API version and SSL verification disabled
service_custom = ServiceBase(mvip='192.168.1.100', username='admin', password='password', api_version=8.3, verify_ssl=False)
```

--------------------------------

### SolidFire Models Attributes

Source: https://solidfire-sdk-python.readthedocs.io/en/latest/genindex

This section lists various attributes found within the solidfire.models module, categorized by their starting letter.

```APIDOC
## SolidFire Models Attributes

### Description
This documentation outlines attributes available within the `solidfire.models` module, organized alphabetically.

### Method
N/A (This is a reference guide, not an API endpoint)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (N/A)
N/A

#### Response Example
N/A

## Attributes starting with 'F'

*   `failed` (solidfire.models.ShutdownResult attribute)
*   `failed_die_count` (solidfire.models.DriveStats attribute)
*   `family` (solidfire.models.NetworkConfig attribute)
    *   (solidfire.models.NetworkConfigParams attribute)
*   `fault_types` (solidfire.models.ClearClusterFaultsRequest attribute)
    *   (solidfire.models.ListClusterFaultsRequest attribute)
*   `faults` (solidfire.models.ListClusterFaultsResult attribute)
*   `feature` (solidfire.models.EnableFeatureRequest attribute)
    *   (solidfire.models.FeatureObject attribute)
    *   (solidfire.models.GetFeatureStatusRequest attribute)
*   `FeatureObject` (class in solidfire.models)
*   `features` (solidfire.models.GetClusterStructureResult attribute)
    *   (solidfire.models.GetFeatureStatusResult attribute)
    *   (solidfire.models.SetClusterStructureRequest attribute)
*   `fibre_channel_port_info` (solidfire.models.ListFibreChannelPortInfoResult attribute)
*   `fibre_channel_ports` (solidfire.models.FibreChannelPortList attribute)
    *   (solidfire.models.ListNodeFibreChannelPortInfoResult attribute)
*   `fibre_channel_target_port_group` (solidfire.models.Node attribute)
*   `fibre_channel_volume_access_max` (solidfire.models.GetLimitsResult attribute)
*   `FibreChannelPortInfo` (class in solidfire.models)
*   `FibreChannelPortInfoResult` (class in solidfire.models)
*   `FibreChannelPortList` (class in solidfire.models)
*   `FibreChannelSession` (class in solidfire.models)
*   `fifo_size` (solidfire.models.CreateVolumeRequest attribute)
    *   (solidfire.models.ModifyVolumeRequest attribute)
    *   (solidfire.models.ModifyVolumesRequest attribute)
    *   (solidfire.models.Volume attribute)
*   `files` (solidfire.models.SupportBundleDetails attribute)
*   `final_timeout` (solidfire.models.AuthSessionInfo attribute)
*   `fips_drive_configuration` (solidfire.models.ClusterConfig attribute)
*   `fips_drives` (solidfire.models.FipsNodeReportType attribute)
    *   (solidfire.models.GetNodeFipsDrivesReportResult attribute)
*   `FipsDrivesStatusType` (class in solidfire.models)
*   `FipsErrorNodeReportErrorType` (class in solidfire.models)
*   `FipsErrorNodeReportType` (class in solidfire.models)
*   `FipsNodeReportType` (class in solidfire.models)
*   `firmware` (solidfire.models.FibreChannelPortInfo attribute)
*   `first_time_startup` (solidfire.models.Service attribute)
*   `force` (solidfire.models.ControlPowerRequest attribute)
    *   (solidfire.models.GetClusterStateRequest attribute)
    *   (solidfire.models.GetNvramInfoRequest attribute)
    *   (solidfire.models.GetPatchInfoRequest attribute)
    *   (solidfire.models.ListDriveHardwareRequest attribute)
    *   (solidfire.models.ResetDrivesRequest attribute)
    *   (solidfire.models.ResetNodeRequest attribute)
    *   (solidfire.models.RestartNetworkingRequest attribute)
    *   (solidfire.models.RestartServicesRequest attribute)
    *   (solidfire.models.TestDrivesRequest attribute)
*   `force_with_unresolved_faults` (solidfire.models.EnableMaintenanceModeRequest attribute)
*   `format` (solidfire.models.BulkVolumeJob attribute)
    *   (solidfire.models.StartBulkVolumeReadRequest attribute)
    *   (solidfire.models.StartBulkVolumeWriteRequest attribute)
*   `Frequency` (class in solidfire.models)
*   `frequency` (solidfire.models.Schedule attribute)
*   `fullness` (solidfire.models.GetClusterFullThresholdResult attribute)
    *   (solidfire.models.ModifyClusterFullThresholdResult attribute)

```

--------------------------------

### SolidFire SDK Python - Backup and Key Server Management

Source: https://solidfire-sdk-python.readthedocs.io/en/latest/genindex

This section details operations for managing backup targets and KMIP key servers.

```APIDOC
## Backup and Key Server Management

### Description
Manages backup targets for data protection and configures KMIP (Key Management Interoperability Protocol) key servers for encryption key management.

### Method
POST

### Endpoint
/api/element/removeBackupTarget

### Parameters
#### Request Body
- **backupTargetId** (integer) - Required - The ID of the backup target to remove.

### Request Example
```json
{
  "backupTargetId": 1
}
```

### Response
#### Success Response (200)
- **status** (string) - The status of the operation.
- **message** (string) - A message indicating the result.

#### Response Example
```json
{
  "status": "Success",
  "message": "Backup target 1 removed."
}
```

### Method
POST

### Endpoint
/api/element/removeKeyServerFromProviderKmip

### Parameters
#### Request Body
- **providerName** (string) - Required - The name of the KMIP provider.
- **keyServerId** (integer) - Required - The ID of the key server to remove.

### Request Example
```json
{
  "providerName": "MyKmipProvider",
  "keyServerId": 1
}
```

### Response
#### Success Response (200)
- **status** (string) - The status of the operation.
- **message** (string) - A message indicating the result.

#### Response Example
```json
{
  "status": "Success",
  "message": "Key server 1 removed from KMIP provider 'MyKmipProvider'."
}
```
```

--------------------------------

### SolidFire SDK Python - Attributes and Classes

Source: https://solidfire-sdk-python.readthedocs.io/en/latest/genindex

This section lists various attributes and classes available within the SolidFire SDK Python library, categorized by their starting letter.

```APIDOC
## SolidFire SDK Python - Attributes and Classes

### Description
This section provides a detailed listing of attributes and classes found within the SolidFire SDK Python library. The information is organized alphabetically for easy reference.

### Parameters
This section details various attributes and classes, including their type and the context in which they appear (e.g., specific attribute of a class or a class definition).

#### Attributes

- **package_name** (solidfire.models.SoftwareVersionInfo attribute)
- **packet_size** (solidfire.models.TestPingRequest attribute)
- **parameters** (solidfire.models.InvokeSFApiRequest attribute)
- **params** (solidfire.common.ApiParameterVersionError attribute)
- **parent_metadata** (solidfire.models.VirtualVolumeTask attribute)
- **parent_total_size** (solidfire.models.VirtualVolumeTask attribute)
- **parent_used_size** (solidfire.models.VirtualVolumeTask attribute)
- **parent_virtual_volume_id** (solidfire.models.VirtualVolumeInfo attribute)
- **passphrase** (solidfire.models.SnmpV3UsmUser attribute)
- **password** (solidfire.models.AddClusterAdminRequest attribute, solidfire.models.CreateClusterRequest attribute, solidfire.models.CreateSnapMirrorEndpointRequest attribute, solidfire.models.ModifyClusterAdminRequest attribute, solidfire.models.ModifySnapMirrorEndpointRequest attribute, solidfire.models.SnmpV3UsmUser attribute, solidfire.models.TestLdapAuthenticationRequest attribute)
- **patches** (solidfire.models.GetPatchInfoResult attribute)
- **path** (solidfire.models.DriveConfigInfo attribute, solidfire.models.DriveHardware attribute, solidfire.models.SnapMirrorLunInfo attribute)
- **path_link** (solidfire.models.DriveConfigInfo attribute, solidfire.models.DriveHardware attribute)
- **pause_limit** (solidfire.models.ModifyVolumePairRequest attribute, solidfire.models.RemoteReplication attribute)
- **paused** (solidfire.apiactual.ApiSchedule attribute, solidfire.models.Schedule attribute, solidfire.models.ScheduleObject attribute)
- **paused_manual** (solidfire.models.ModifyVolumePairRequest attribute)
- **pci_slot** (solidfire.models.FibreChannelPortInfo attribute)
- **peak_active_sessions** (solidfire.models.ClusterCapacity attribute)
- **peak_iops** (solidfire.models.ClusterCapacity attribute)
- **pending** (solidfire.models.PendingOperation attribute)
- **pending_active_node_id** (solidfire.models.PendingActiveNode attribute)
- **pending_active_nodes** (solidfire.models.ListAllNodesResult attribute, solidfire.models.ListPendingActiveNodesResult attribute)
- **pending_node_id** (solidfire.models.AddedNode attribute, solidfire.models.ClusterConfig attribute, solidfire.models.NodeWaitingToJoin attribute, solidfire.models.PendingActiveNode attribute, solidfire.models.PendingNode attribute)
- **pending_nodes** (solidfire.models.AddNodesRequest attribute, solidfire.models.ListAllNodesResult attribute, solidfire.models.ListPendingNodesResult attribute)
- **pending_operation** (solidfire.models.GetPendingOperationResult attribute)
- **pending_version** (solidfire.models.SoftwareVersionInfo attribute)
- **per_minute_primary_swap_limit** (solidfire.models.EnableMaintenanceModeRequest attribute)
- **percent_complete** (solidfire.models.BulkVolumeJob attribute, solidfire.models.SyncJob attribute, solidfire.models.UpdateBulkVolumeStatusRequest attribute)
- **percent_used_capacity** (solidfire.models.SnapMirrorAggregate attribute)
- **physical** (solidfire.models.NetworkConfig attribute, solidfire.models.NetworkConfigParams attribute)
- **ping_bytes** (solidfire.models.TestConnectMvipDetails attribute, solidfire.models.TestConnectSvipDetails attribute)
- **ping_timeout_msec** (solidfire.models.TestPingRequest attribute)
- **platform_config_version** (solidfire.models.Platform attribute)
- **platform_info** (solidfire.models.AddedNode attribute, solidfire.models.Node attribute, solidfire.models.PendingActiveNode attribute, solidfire.models.PendingNode attribute)
- **policy_name** (solidfire.models.CreateSnapMirrorRelationshipRequest attribute, solidfire.models.ModifySnapMirrorRelationshipRequest attribute, solidfire.models.SnapMirrorPolicy attribute, solidfire.models.SnapMirrorRelationship attribute)
- **policy_rules** (solidfire.models.SnapMirrorPolicy attribute)
- **policy_type** (solidfire.models.SnapMirrorPolicy attribute, solidfire.models.SnapMirrorRelationship attribute)
- **port** (solidfire.models.LoggingServer attribute, solidfire.models.SnmpTrapRecipient attribute)
- **power_on_hours** (solidfire.models.DriveHardware attribute, solidfire.models.DriveStats attribute)
- **preference** (solidfire.models.GetClusterInterfacePreferenceResult attribute)
- **preferences** (solidfire.models.ListClusterInterfacePreferencesResult attribute)
- **preserve** (solidfire.models.BreakSnapMirrorVolumeRequest attribute)
- **previous_protection_scheme** (solidfire.models.Volume attribute)
- **primary** (solidfire.models.MetadataHosts attribute)

#### Classes

- **PairedCluster** (class in solidfire.models)
- **PendingActiveNode** (class in solidfire.models)
- **PendingNode** (class in solidfire.models)
- **PendingOperation** (class in solidfire.models)
- **PhysicalAdapter** (class in solidfire.models)
- **Platform** (class in solidfire.models)

### Methods

- **post()** (solidfire.common.CurlDispatcher method)

### Request Example
```json
{
  "example": "No request examples available for this section."
}
```

### Response
#### Success Response (200)
- **example** (string) - No specific success response details provided for this general reference section.

#### Response Example
```json
{
  "example": "No response examples available for this section."
}
```
```

--------------------------------

### SolidFire SDK Python - Adaptor Methods

Source: https://solidfire-sdk-python.readthedocs.io/en/latest/genindex

Documentation for the `invoke_sfapi()` static method within the `solidfire.adaptor.ElementServiceAdaptor` class.

```APIDOC
## POST /invoke_sfapi

### Description
This method is used to invoke SFAPI requests. It's a static method within the ElementServiceAdaptor class.

### Method
POST

### Endpoint
/invoke_sfapi

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
- **element_method** (string) - Required - The SFAPI method to invoke.
- **params** (dict) - Optional - Parameters for the SFAPI method.

### Request Example
```json
{
  "element_method": "GetVolumeList",
  "params": {}
}
```

### Response
#### Success Response (200)
- **result** (dict) - The result of the SFAPI call.
- **id** (string) - The request ID.

#### Response Example
```json
{
  "result": {
    "count": 1,
    "volumes": [
      {
        "volumeID": 1,
        "name": "test_volume",
        "totalSize": 10737418240,
        "usedSize": 0,
        "creationTime": "2023-10-27T10:00:00Z"
      }
    ]
  },
  "id": "request_123"
}
```
```

--------------------------------

### Snapshot Creation Parameters

Source: https://solidfire-sdk-python.readthedocs.io/en/latest/solidfire.apiactual

This section details the parameters used for creating snapshots, including volume IDs, snapshot names, and retention policies.

```APIDOC
## Snapshot Creation

### Description
This endpoint allows for the creation of snapshots for specified volumes. You can include individual volumes or a group of volumes in a snapshot, assign a name, and configure remote replication and retention policies.

### Method
POST

### Endpoint
/snapshot

### Parameters
#### Query Parameters
- **volume_id** (int) - Optional - The ID of the volume to be included in the snapshot.
- **volumes** (int[]) - Required - A list of volume IDs to be included in the group snapshot.
- **name** (str) - Optional - The snapshot name to be used.
- **enable_remote_replication** (bool) - Optional - Indicates if the snapshot should be included in remote replication.
- **retention** (str) - Optional - The amount of time the snapshot will be retained in HH:mm:ss format.

### Request Example
```json
{
  "volumes": [1, 2, 3],
  "name": "my_snapshot",
  "enable_remote_replication": true,
  "retention": "24:00:00"
}
```

### Response
#### Success Response (200)
- **snapshot_id** (int) - The ID of the created snapshot.
- **status** (str) - The status of the snapshot creation.

#### Response Example
```json
{
  "snapshot_id": 12345,
  "status": "success"
}
```
```

--------------------------------

### Get DataObject Properties

Source: https://solidfire-sdk-python.readthedocs.io/en/latest/_modules/solidfire/common/model

The get_properties method exposes the type properties for a DataObject. It returns a dictionary containing property names and their associated type information.

```python
    def get_properties(self):
        """
        Exposes the type properties for a Data Object.

        :return: the dictionary of property names and thier type information.
        :rtype: dict
        """
        return self._properties
```

--------------------------------

### System Management

Source: https://solidfire-sdk-python.readthedocs.io/en/latest/genindex

Methods for managing system-level configurations, updates, and status.

```APIDOC
## System Management

### Description
Methods related to overall system management, including configuration, updates, and status checks.

### Methods
- **get_bootstrap_config()**
  - Retrieves the bootstrap configuration settings.
- **get_config()**
  - Fetches the general system configuration.
- **get_current_cluster_admin()**
  - Gets the currently logged-in cluster administrator.
- **get_default_qos()**
  - Retrieves the default Quality of Service (QoS) settings.
- **get_drive_config()**
  - Fetches the configuration for storage drives.
- **get_drive_hardware_info()**
  - Retrieves hardware information for storage drives.
- **get_drive_stats()**
  - Gets performance statistics for storage drives.
- **get_feature_status()**
  - Retrieves the status of various system features.
- **get_hardware_config()**
  - Fetches the hardware configuration of the system.
- **get_hardware_info()**
  - Retrieves general hardware information.
- **get_license_key()**
  - Gets the currently installed license key.
- **get_limits()**
  - Retrieves system-defined limits and constraints.
- **get_ntp_info()**
  - Fetches Network Time Protocol (NTP) server information.
- **get_nvram_info()**
  - Retrieves information from the Non-Volatile Random-Access Memory (NVRAM).
- **get_ontap_version_info()**
  - Gets version information for ONTAP software.
- **get_origin()**
  - Retrieves the origin information for the system.
- **get_patch_info()**
  - Fetches information about installed software patches.
- **get_pending_operation()**
  - Retrieves details about any pending system operations.
- **get_remote_logging_hosts()**
  - Gets the configured remote logging hosts.
- **get_snmp_acl()**
  - Retrieves the SNMP Access Control List (ACL).
- **get_snmp_info()**
  - Fetches general SNMP configuration information.
- **get_snmp_state()**
  - Gets the current state of the SNMP service.
- **get_snmp_trap_info()**
  - Retrieves information about SNMP traps.
- **get_system_status()**
  - Fetches the overall status of the system.
```

--------------------------------

### SolidFire SDK - C Methods and Attributes

Source: https://solidfire-sdk-python.readthedocs.io/en/latest/genindex

This section details methods and attributes starting with 'C' in the SolidFire Python SDK, including those related to BMC, node statistics, cloning operations, and cluster checks.

```APIDOC
## C Methods and Attributes

### Description
This section details methods and attributes starting with 'C' in the SolidFire Python SDK, including those related to BMC, node statistics, cloning operations, and cluster checks.

### Methods and Attributes

*   **c_bmc_reset_duration_minutes** (solidfire.models.DisableBmcColdResetResult attribute)
    *   (solidfire.models.EnableBmcColdResetResult attribute)
*   **c_bytes_in** (solidfire.models.NodeStatsInfo attribute)
*   **c_bytes_out** (solidfire.models.NodeStatsInfo attribute)
*   **cancel_clone()** (solidfire.Element method)
    *   Description: Cancels an existing clone operation.
    *   Method: POST
    *   Endpoint: /_internal/cancelClone
    *   Request Body:
        *   **cloneId** (long) - Required - The ID of the clone to cancel.
    *   Response:
        *   Success Response (200):
            *   **result** (CancelCloneResult) - Details of the cancellation operation.
*   **cancel_group_clone()** (solidfire.Element method)
    *   Description: Cancels an existing group clone operation.
    *   Method: POST
    *   Endpoint: /_internal/cancelGroupClone
    *   Request Body:
        *   **groupCloneId** (long) - Required - The ID of the group clone to cancel.
    *   Response:
        *   Success Response (200):
            *   **result** (CancelGroupCloneResult) - Details of the cancellation operation.
*   **CancelCloneRequest** (class in solidfire.models)
*   **CancelCloneResult** (class in solidfire.models)
*   **CancelGroupCloneRequest** (class in solidfire.models)
*   **CancelGroupCloneResult** (class in solidfire.models)
*   **cancelled** (solidfire.models.VirtualVolumeTask attribute)
*   **canonical_name** (solidfire.models.DriveConfigInfo attribute)
    *   (solidfire.models.DriveHardware attribute)
*   **capacity** (solidfire.models.Drive attribute)
    *   (solidfire.models.DriveInfo attribute)
*   **category** (solidfire.models.ProtectionSchemeInfo attribute)
*   **certificate** (solidfire.models.GetNodeSSLCertificateResult attribute)
    *   (solidfire.models.GetSSLCertificateResult attribute)
    *   (solidfire.models.SetNodeSSLCertificateRequest attribute)
    *   (solidfire.models.SetSSLCertificateRequest attribute)
*   **chap_algorithm** (solidfire.models.ISCSIAuthentication attribute)
*   **chap_username** (solidfire.models.CreateInitiator attribute)
    *   (solidfire.models.ISCSIAuthentication attribute)
    *   (solidfire.models.Initiator attribute)
    *   (solidfire.models.ModifyInitiator attribute)
*   **CHAPSecret** (class in solidfire.models)
*   **chassis_name** (solidfire.models.Node attribute)
    *   (solidfire.models.PendingNode attribute)
*   **chassis_slot** (solidfire.models.DriveInfo attribute)
*   **chassis_type** (solidfire.models.GetIpmiConfigRequest attribute)
    *   (solidfire.models.NodeWaitingToJoin attribute)
    *   (solidfire.models.Platform attribute)
*   **check_proposed_cluster()** (solidfire.Element method)
    *   Description: Checks if a proposed cluster configuration is valid.
    *   Method: POST
    *   Endpoint: /_internal/checkProposedCluster
    *   Request Body:
        *   **request** (CheckProposedClusterRequest) - Required - The proposed cluster configuration.
    *   Response:
        *   Success Response (200):
            *   **result** (CheckProposedResult) - The result of the cluster configuration check.
*   **check_proposed_node_additions()** (solidfire.Element method)
    *   Description: Checks if proposed node additions are valid.
    *   Method: POST
    *   Endpoint: /_internal/checkProposedNodeAdditions
    *   Request Body:
        *   **request** (CheckProposedNodeAdditionsRequest) - Required - The proposed node additions.
    *   Response:
        *   Success Response (200):
            *   **result** (CheckProposedResult) - The result of the node addition check.
*   **CheckProposedClusterRequest** (class in solidfire.models)
*   **CheckProposedNodeAdditionsRequest** (class in solidfire.models)
*   **CheckProposedResult** (class in solidfire.models)
*   **checksum** (solidfire.models.CreateSnapshotResult attribute)
    *   (solidfire.models.GroupSnapshotMembers attribute)
    *   (solidfire.models.RollbackToSnapshotResult attribute)
    *   (solidfire.models.Snapshot attribute)
*   **children** (solidfire.models.VirtualVolumeInfo attribute)
*   **cidr** (solidfire.models.SnmpNetwork attribute)
*   **cip** (solidfire.models.AddedNode attribute)
    *   (solidfire.models.Node attribute)
    *   (solidfire.models.NodeWaitingToJoin attribute)
    *   (solidfire.models.PendingActiveNode attribute)
    *   (solidfire.models.PendingNode attribute)
*   **cipi** (solidfire.models.ClusterConfig attribute)
    *   (solidfire.models.Node attribute)
    *   (solidfire.models.PendingNode attribute)
*   **clear_checkpoint** (solidfire.models.AbortSnapMirrorRelationshipRequest attribute)
*   **clear_cluster_faults()** (solidfire.Element method)
    *   Description: Clears all faults from the cluster.
    *   Method: POST
    *   Endpoint: /_internal/clearClusterFaults
    *   Request Body:
        *   **request** (ClearClusterFaultsRequest) - Required - Request object for clearing cluster faults.
    *   Response:
        *   Success Response (200):
            *   **result** (ClearClusterFaultsResult) - Details of the cleared faults.
*   **ClearClusterFaultsRequest** (class in solidfire.models)
*   **ClearClusterFaultsResult** (class in solidfire.models)
*   **client_apimajor_version** (solidfire.models.OntapVersionInfo attribute)
*   **client_apiminor_version** (solidfire.models.OntapVersionInfo attribute)
*   **client_certificate_sign_request** (solidfire.models.GetClientCertificateSignRequestResult attribute)
*   **client_queue_depth** (solidfire.models.ClusterStats attribute)
    *   (solidfire.models.VirtualVolumeStats attribute)
    *   (solidfire.models.VolumeStats attribute)
*   **clone_id** (solidfire.models.CancelCloneRequest attribute)
    *   (solidfire.models.CloneVolumeResult attribute)
    *   (solidfire.models.CopyVolumeResult attribute)
    *   (solidfire.models.SyncJob attribute)
*   **clone_jobs_per_volume_max** (solidfire.models.GetLimitsResult attribute)
*   **clone_multiple_volumes()** (solidfire.Element method)
    *   Description: Clones multiple volumes simultaneously.
    *   Method: POST
    *   Endpoint: /_internal/cloneMultipleVolumes
    *   Request Body:
        *   **request** (CloneMultipleVolumesRequest) - Required - Parameters for cloning multiple volumes.
    *   Response:
        *   Success Response (200):
            *   **result** (CloneMultipleVolumesResult) - Details of the multiple volume cloning operation.
*   **clone_virtual_volume_id** (solidfire.models.VirtualVolumeTask attribute)
*   **clone_volume()** (solidfire.Element method)
    *   Description: Clones a single volume.
    *   Method: POST
    *   Endpoint: /_internal/cloneVolume
    *   Request Body:
        *   **request** (CloneVolumeRequest) - Required - Parameters for cloning a volume.
    *   Response:
        *   Success Response (200):
            *   **result** (CloneVolumeResult) - Details of the volume cloning operation.
*   **CloneMultipleVolumeParams** (class in solidfire.models)
*   **CloneMultipleVolumesRequest** (class in solidfire.models)
*   **CloneMultipleVolumesResult** (class in solidfire.models)
*   **CloneVolumeRequest** (class in solidfire.models)
*   **CloneVolumeResult** (class in solidfire.models)
*   **cluster** (solidfire.models.ClusterConfig attribute)
    *   (solidfire.models.Config attribute)
    *   (solidfire.models.ConfigParams attribute)
    *   (solidfire.models.GetClusterConfigResult attribute)
    *   (solidfire.models.GetClusterStateResult attribute)
    *   (solidfire.models.NodeStateInfo attribute)
    *   (solidfire.models.SetClusterConfigRequest attribute)
    *   (solidfire.models.SetClusterConfigResult attribute)
*   **cluster_admin** (solidfire.models.GetCurrentClusterAdminResult attribute)
*   **cluster_admin_account_max** (solidfire.models.GetLimitsResult attribute)
*   **cluster_admin_id** (solidfire.models.AddClusterAdminResult attribute)
    *   (solidfire.models.AddLdapClusterAdminResult attribute)
    *   (solidfire.models.ClusterAdmin attribute)

```

--------------------------------

### Get Schedule - Python

Source: https://solidfire-sdk-python.readthedocs.io/en/latest/_modules/solidfire/adaptor/schedule_adaptor

Retrieves a schedule using the SolidFire API. This method is intended for internal use by the Element class. It converts the API response schedule object to a custom Schedule object.

```python
from solidfire.apiactual import ApiSchedule, ApiScheduleInfo, ApiWeekday, \
    ApiGetScheduleResult, ApiListSchedulesResult, ApiModifyScheduleResult
from solidfire.custom.models import Weekday, DaysOfMonthFrequency, \
    DaysOfWeekFrequency, TimeIntervalFrequency
from solidfire.models import Schedule, Frequency, ScheduleInfo, GetScheduleResult, ListSchedulesResult, \
    CreateScheduleResult, ModifyScheduleResult
import logging


LOG = logging.getLogger('solidfire.Element')


class ScheduleAdaptor:
    """
    This class contains the implementation of the schedule specific adaptor
    calls for simplifying Snapshot Scheduling.
    """


    @staticmethod
    def get_schedule(element, params, since, deprecated):
        """
        Calls to this static method should ONLY originate from the
        get_schedule method in the Element class. DO NOT CALL THIS directly.
        Documentation here is intentionally brief.
        """
        api_result = element.send_request("GetSchedule",
                                          ApiGetScheduleResult, params,
                                          since, deprecated)

        return GetScheduleResult(schedule=ScheduleAdaptor.to_schedule(api_result.schedule))
```

--------------------------------

### SolidFire SDK Python - System Status and Configuration

Source: https://solidfire-sdk-python.readthedocs.io/en/latest/genindex

This section covers retrieving system status information and configuring network settings.

```APIDOC
## System Status and Configuration

### Description
Provides access to system-wide status information and allows for the configuration of network-related settings.

### Method
GET

### Endpoint
/api/element/getSystemStatus

### Response
#### Success Response (200)
- **rebootRequired** (boolean) - Indicates if a reboot is required for the system.

#### Response Example
```json
{
  "rebootRequired": false
}
```

### Method
POST

### Endpoint
/api/element/setRemoteLoggingHosts

### Parameters
#### Request Body
- **remoteLoggingHosts** (array of objects) - Required - A list of remote logging host configurations.
  - **hostName** (string) - Required - The hostname or IP address of the logging host.
  - **port** (integer) - Required - The port number for logging.
  - **protocol** (string) - Required - The protocol to use (e.g., "UDP", "TCP").

### Request Example
```json
{
  "remoteLoggingHosts": [
    {
      "hostName": "logserver.example.com",
      "port": 514,
      "protocol": "UDP"
    }
  ]
}
```

### Response
#### Success Response (200)
- **status** (string) - The status of the operation.
- **message** (string) - A message indicating the result.

#### Response Example
```json
{
  "status": "Success",
  "message": "Remote logging hosts configured successfully."
}
```
```

--------------------------------

### ServiceBase Constructor

Source: https://solidfire-sdk-python.readthedocs.io/en/latest/solidfire.common

Initializes a connection to an instance of Element OS. This class is the base type for API services and handles request sending, encoding, and decoding.

```APIDOC
## ServiceBase Constructor

### Description
Initializes a connection to an instance of Element OS. This class is the base type for API services and handles request sending, encoding, and decoding.

### Method
`__init__`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Constructor Parameters
- **mvip** (str) - Required - the management IP (IP or hostname)
- **username** (str) - Required - username use to connect to the Element OS instance.
- **password** (str) - Required - authentication for username
- **api_version** (float) - Optional - specific version of Element OS to connect. Defaults to 8.0
- **verify_ssl** (bool) - Optional - disable to avoid ssl connection errors especially when using an IP instead of a hostname. Defaults to True
- **dispatcher** - Optional - a prebuilt or custom http dispatcher

### Request Example
```python
from solidfire.common import ServiceBase

service = ServiceBase(mvip='192.168.1.1', username='admin', password='password')
```

### Response
#### Success Response (200)
Returns a configured connection to an Element OS instance.

#### Response Example
```json
{
  "connection": "<connection_object>"
}
```
```

--------------------------------

### Schedule Management Adaptor Calls in Python

Source: https://solidfire-sdk-python.readthedocs.io/en/latest/_modules/solidfire/adaptor

Provides static methods for interacting with schedule-related operations (get, list, modify, create). These methods are intended to be called internally by the Element class and not directly. They delegate the actual calls to the ScheduleAdaptor.

```python
    @staticmethod
    def get_schedule(element, params, since, deprecated):
        """
        Calls to this static method should ONLY originate from the
        get_schedule method in the Element class. DO NOT CALL THIS directly.
        Documentation here is intentionally brief.
        """

        return ScheduleAdaptor.get_schedule(element, params,
                                            since, deprecated)


    @staticmethod
    def list_schedules(element, params, since, deprecated):
        """
        Calls to this static method should ONLY originate from the
        list_schedules method in the Element class. DO NOT CALL THIS directly.
        Documentation here is intentionally brief.
        """

        return ScheduleAdaptor.list_schedules(element, params,
                                              since, deprecated)


    @staticmethod
    def modify_schedule(element, params, since, deprecated):
        """
        Calls to this static method should ONLY originate from the
        modify_schedules method in the Element class. DO NOT CALL THIS
        directly. Documentation here is intentionally brief.
        """

        return ScheduleAdaptor.modify_schedule(element, params,
                                               since, deprecated)


    @staticmethod
    def create_schedule(element, params, since, deprecated):
        """
        Calls to this static method should ONLY originate from the
        create_schedules method in the Element class. DO NOT CALL THIS
        directly. Documentation here is intentionally brief.
        """

        return ScheduleAdaptor.create_schedule(element, params,
                                               since, deprecated)

```

--------------------------------

### System Configuration and Management Methods

Source: https://solidfire-sdk-python.readthedocs.io/en/latest/genindex

This section covers methods for disabling various system features and managing network configurations.

```APIDOC
## System Configuration and Management Methods

### Description
These methods allow for the disabling of specific system functionalities such as BMC cold reset, cluster SSH, encryption at rest, IDP/LDAP authentication, maintenance mode, SNMP, and SSH. It also includes attributes for configuring DNS nameservers and search domains.

### Method
- `disable_bmc_cold_reset()`
- `disable_cluster_ssh()`
- `disable_encryption_at_rest()`
- `disable_idp_authentication()`
- `disable_ldap_authentication()`
- `disable_maintenance_mode()`
- `disable_snmp()`
- `disable_ssh()`

### Endpoint
N/A (Methods)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
- **dns_nameservers** (solidfire.models.NetworkConfig attribute) - Optional - A list of DNS nameservers to configure.
- **dns_search** (solidfire.models.NetworkConfig attribute) - Optional - A list of DNS search domains to configure.

### Request Example
```python
# Example for disabling SSH
solidfire_element.disable_ssh()

# Example for setting DNS nameservers
network_config = solidfire.models.NetworkConfig(dns_nameservers=['8.8.8.8', '8.8.4.4'])
solidfire_element.set_network_configuration(network_config)
```

### Response
#### Success Response (200)
- **DisableBmcColdResetResult** (solidfire.models.DisableBmcColdResetResult) - Result of disabling BMC cold reset.
- **DisableClusterSshResult** (solidfire.models.DisableClusterSshResult) - Result of disabling cluster SSH.
- **DisableEncryptionAtRestResult** (solidfire.models.DisableEncryptionAtRestResult) - Result of disabling encryption at rest.
- **DisableIdpAuthenticationResult** (solidfire.models.DisableIdpAuthenticationResult) - Result of disabling IDP authentication.
- **DisableLdapAuthenticationResult** (solidfire.models.DisableLdapAuthenticationResult) - Result of disabling LDAP authentication.
- **DisableMaintenanceModeRequest** (solidfire.models.DisableMaintenanceModeRequest) - Request object for disabling maintenance mode.
- **DisableSnmpResult** (solidfire.models.DisableSnmpResult) - Result of disabling SNMP.
- **DisableSshResult** (solidfire.models.DisableSshResult) - Result of disabling SSH.

#### Response Example
```json
{
  "status": "success",
  "message": "SSH has been disabled."
}
```
```

--------------------------------

### Get Known Default Value for Property Type

Source: https://solidfire-sdk-python.readthedocs.io/en/latest/_modules/solidfire/common/model

The known_default method returns a default value based on the property's member type. It supports integers, floats, strings, and booleans, returning 0, 0.0, '', and False respectively. For other types, it returns None.

```python
    def known_default(self):
        """
        Helps convert a property to a default value.

        :return: a known default for a type.
        """
        if self._member_type is int:
            return 0
        elif self._member_type is float:
            return 0.0
        elif self._member_type is str:
            return ''
        elif self._member_type is bool:
            return False
        else:
            pass
```

--------------------------------

### SolidFire SDK Python - Utility Methods

Source: https://solidfire-sdk-python.readthedocs.io/en/latest/genindex

This section includes utility methods available in the SolidFire SDK, such as default value retrieval.

```APIDOC
## SolidFire SDK Python - Utility Methods

### Description
This section includes utility methods available in the SolidFire SDK, such as default value retrieval.

### Methods

- **known_default()** (solidfire.common.model.ModelProperty method)

```
Tokens:
Raw