netapp.santricity.models.symbol package¶

Submodules¶

netapp.santricity.models.symbol.abstract_vol_ref_list module¶

AbstractVolRefList.py

class netapp.santricity.models.symbol.abstract_vol_ref_list.AbstractVolRefList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

abstract_vol_ref¶

Gets the abstract_vol_ref of this AbstractVolRefList. The unique identification value of the volume that is accessed via the LUN value associated with this mapping definition.

Required/optional:
Returns:	The abstract_vol_ref of this AbstractVolRefList.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.access_volume module¶

AccessVolume.py

class netapp.santricity.models.symbol.access_volume.AccessVolume[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

access_volume_ref¶

Gets the access_volume_ref of this AccessVolume. The identifier value for this AccessVolume. Other objects may use this reference value to refer to the AccessVolume.

Required/optional:
Returns:	The access_volume_ref of this AccessVolume.
Return type:	str
	required

capacity¶

Gets the capacity of this AccessVolume. The (simulated) capacity of the AccessVolume maintained by the controller. Since there is essentially no true data storage capacity present for an AccessVolume, this value is used to determine the block addressing limit of the unit, which is an important aspect of the UTM command transfer protocol.

Required/optional:
Returns:	The capacity of this AccessVolume.
Return type:	int
	required

enabled¶

Gets the enabled of this AccessVolume. True if the access volume feature (and thus the UTM command transfer capability) is enabled, or false if it is disabled.

Required/optional:
Returns:	The enabled of this AccessVolume.
Return type:	bool
	required

reserved1¶

Gets the reserved1 of this AccessVolume.

Required/optional:
Returns:	The reserved1 of this AccessVolume.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_handle¶

Gets the volume_handle of this AccessVolume. An identifier value for the AccessVolume object. This will generally correspond to the logical unit number (LUN) that is used to access the volume for UTM protocol command transactions.

Required/optional:
Returns:	The volume_handle of this AccessVolume.
Return type:	int
	required

netapp.santricity.models.symbol.accessible_controller module¶

AccessibleController.py

class netapp.santricity.models.symbol.accessible_controller.AccessibleController[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

all_controllers¶

Gets the all_controllers of this AccessibleController. An array of SYMbol reference values for all of the controllers that are present in the storage array where this controller resides.

Required/optional:
Returns:	The all_controllers of this AccessibleController.
Return type:	list[str]
	required

sa_id¶

Gets the sa_id of this AccessibleController. The world-wide unique identifier of the storage array in which this controller resides.

Required/optional:
Returns:	The sa_id of this AccessibleController.
Return type:	SAIdentifier
	required

slot¶

Gets the slot of this AccessibleController. The slot within its tray where this controller resides.

Required/optional:
Returns:	The slot of this AccessibleController.
Return type:	int
	required

this_controller¶

Gets the this_controller of this AccessibleController. The SYMbol reference value that uniquely identifies this controller.

Required/optional:
Returns:	The this_controller of this AccessibleController.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray_id¶

Gets the tray_id of this AccessibleController. The ID value of the tray in which this controller resides.

Required/optional:
Returns:	The tray_id of this AccessibleController.
Return type:	int
	required

netapp.santricity.models.symbol.alarm module¶

Alarm.py

class netapp.santricity.models.symbol.alarm.Alarm[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

alarm_ref¶

Gets the alarm_ref of this Alarm. The reference for this physical alarm.

Required/optional:
Returns:	The alarm_ref of this Alarm.
Return type:	str
	required

is_manageable¶

Gets the is_manageable of this Alarm. True if the alarm is manageable using the setAlarm procedure.

Required/optional:
Returns:	The is_manageable of this Alarm.
Return type:	bool
	required

physical_location¶

Gets the physical_location of this Alarm. The location of the alarm. The parent reference in Location identifies the tray containing the alarm, and the position field is set to 1.

Required/optional:
Returns:	The physical_location of this Alarm.
Return type:	Location
	required

repair_policy¶

Gets the repair_policy of this Alarm. The repair policy for the alarm component.

Required/optional:
Returns:	The repair_policy of this Alarm.
Return type:	RepairPolicy
	required

rtr_attributes¶

Gets the rtr_attributes of this Alarm. The CRU type of the alarm plus its ready-to-remove attributes, which are based on the CRU type

Required/optional:
Returns:	The rtr_attributes of this Alarm.
Return type:	RTRAttributes
	required

status¶

Gets the status of this Alarm. The operational status of the alarm.

Required/optional:
Returns:	The status of this Alarm.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.alarm_update_descriptor module¶

AlarmUpdateDescriptor.py

class netapp.santricity.models.symbol.alarm_update_descriptor.AlarmUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

alarm_control¶

Gets the alarm_control of this AlarmUpdateDescriptor. Indicates the alarm control to activate on the specified alarm.

Required/optional:
Returns:	The alarm_control of this AlarmUpdateDescriptor.
Return type:	str
	required

alarm_ref¶

Gets the alarm_ref of this AlarmUpdateDescriptor. The reference that identifies the physical alarm to modify.

Required/optional:
Returns:	The alarm_ref of this AlarmUpdateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.application_awareness_bundle module¶

ApplicationAwarenessBundle.py

class netapp.santricity.models.symbol.application_awareness_bundle.ApplicationAwarenessBundle[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

key_value_tag¶

Gets the key_value_tag of this ApplicationAwarenessBundle. This is an array of elements that report the a key-value tag and its reference.

Required/optional:
Returns:	The key_value_tag of this ApplicationAwarenessBundle.
Return type:	list[KeyValueTag]
	required

key_value_tag_mapping¶

Gets the key_value_tag_mapping of this ApplicationAwarenessBundle. This element is an array of the mappings (using references) between a key-value tag and a volume.

Required/optional:
Returns:	The key_value_tag_mapping of this ApplicationAwarenessBundle.
Return type:	list[KeyValueTagMapping]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

workload¶

Gets the workload of this ApplicationAwarenessBundle. This is an array of elements that reports Workload references.

Required/optional:
Returns:	The workload of this ApplicationAwarenessBundle.
Return type:	list[Workload]
	required

workload_volume_mapping¶

Gets the workload_volume_mapping of this ApplicationAwarenessBundle. This is an array of elements that report the mapping between workloads and volumes.

Required/optional:
Returns:	The workload_volume_mapping of this ApplicationAwarenessBundle.
Return type:	list[WorkloadVolumeMapping]
	required

netapp.santricity.models.symbol.arvm_default_attributes module¶

ARVMDefaultAttributes.py

class netapp.santricity.models.symbol.arvm_default_attributes.ARVMDefaultAttributes[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

default_error_statistics_list_length¶

Gets the default_error_statistics_list_length of this ARVMDefaultAttributes. Recommended default sample list length limit to pass to getAsyncMirrorSyncStatistics for an ERROR statistics request (AsyncMirrorSyncStatisticsRequestDescriptor::sampleLimit field)

Required/optional:
Returns:	The default_error_statistics_list_length of this ARVMDefaultAttributes.
Return type:	int
	required

default_link_bandwidth_test_iterations¶

Gets the default_link_bandwidth_test_iterations of this ARVMDefaultAttributes. The default number of test iterations for a bandwidth test (specified in AsyncMirrorGroupConnectivityTestDescriptor when AsyncMirrorGroupConnectivityTestType is ASYNC_MIRROR_GROUP_LINK_BANDWIDTH_TEST).

Required/optional:
Returns:	The default_link_bandwidth_test_iterations of this ARVMDefaultAttributes.
Return type:	int
	required

default_link_latency_test_iterations¶

Gets the default_link_latency_test_iterations of this ARVMDefaultAttributes. The default number of test iterations for a link latency test (specified in AsyncMirrorGroupConnectivityTestDesscriptor when AsyncMirrorGroupConnectivityTestType is ASYNC_MIRROR_GROUP_LINK_LATENCY_TEST).

Required/optional:
Returns:	The default_link_latency_test_iterations of this ARVMDefaultAttributes.
Return type:	int
	required

default_longest_statistics_list_length¶

Gets the default_longest_statistics_list_length of this ARVMDefaultAttributes. Recommended default sample list length limit to pass to getAsyncMirrorSyncStatistics for a LONGEST statistics request (AsyncMirrorSyncStatisticsRequestDescriptor::sampleLimit field)

Required/optional:
Returns:	The default_longest_statistics_list_length of this ARVMDefaultAttributes.
Return type:	int
	required

default_recent_statistics_list_length¶

Gets the default_recent_statistics_list_length of this ARVMDefaultAttributes. Recommended default sample list length limit to pass to getAsyncMirrorSyncStatistics for a RECENT statistics request (AsyncMirrorSyncStatisticsRequestDescriptor::sampleLimit field)

Required/optional:
Returns:	The default_recent_statistics_list_length of this ARVMDefaultAttributes.
Return type:	int
	required

default_recovery_point_age_alert_threshold_in_minutes¶

Gets the default_recovery_point_age_alert_threshold_in_minutes of this ARVMDefaultAttributes. Default recovery point age alert threshold.

Required/optional:
Returns:	The default_recovery_point_age_alert_threshold_in_minutes of this ARVMDefaultAttributes.
Return type:	int
	required

default_repository_capacity_as_percent_of_mirrored_capacity¶

Gets the default_repository_capacity_as_percent_of_mirrored_capacity of this ARVMDefaultAttributes. Default repository capacity as a percentage of the mirror capacity..

Required/optional:
Returns:	The default_repository_capacity_as_percent_of_mirrored_capacity of this ARVMDefaultAttributes.
Return type:	int
	required

default_repository_utilization_warning_threshold¶

Gets the default_repository_utilization_warning_threshold of this ARVMDefaultAttributes. Default repository utilization warning threshold percentage.

Required/optional:
Returns:	The default_repository_utilization_warning_threshold of this ARVMDefaultAttributes.
Return type:	int
	required

default_sync_completion_time_alert_threshold_in_minutes¶

Gets the default_sync_completion_time_alert_threshold_in_minutes of this ARVMDefaultAttributes. Default sync completion time alert threshold.

Required/optional:
Returns:	The default_sync_completion_time_alert_threshold_in_minutes of this ARVMDefaultAttributes.
Return type:	int
	required

default_sync_interval_in_minutes¶

Gets the default_sync_interval_in_minutes of this ARVMDefaultAttributes. Default sync interval in minutes.

Required/optional:
Returns:	The default_sync_interval_in_minutes of this ARVMDefaultAttributes.
Return type:	int
	required

max_allowed_link_latency_in_microseconds¶

Gets the max_allowed_link_latency_in_microseconds of this ARVMDefaultAttributes. Indicates the max allowed link latency between two RVM arrays.

Required/optional:
Returns:	The max_allowed_link_latency_in_microseconds of this ARVMDefaultAttributes.
Return type:	int
	required

max_error_statistics_list_length¶

Gets the max_error_statistics_list_length of this ARVMDefaultAttributes. Maximum sample list length limit allowed in a call to getAsyncMirrorSyncStatistics for an ERROR statistics request (AsyncMirrorSyncStatisticsRequestDescriptor::sampleLimit field)

Required/optional:
Returns:	The max_error_statistics_list_length of this ARVMDefaultAttributes.
Return type:	int
	required

max_longest_statistics_list_length¶

Gets the max_longest_statistics_list_length of this ARVMDefaultAttributes. Maximum sample list length limit allowed in a call to getAsyncMirrorSyncStatistics for a LONGEST statistics request (AsyncMirrorSyncStatisticsRequestDescriptor::sampleLimit field)

Required/optional:
Returns:	The max_longest_statistics_list_length of this ARVMDefaultAttributes.
Return type:	int
	required

max_recent_statistics_list_length¶

Gets the max_recent_statistics_list_length of this ARVMDefaultAttributes. Maximum sample list length limit allowed in a call to getAsyncMirrorSyncStatistics for a RECENT statistics request (AsyncMirrorSyncStatisticsRequestDescriptor::sampleLimit field)

Required/optional:
Returns:	The max_recent_statistics_list_length of this ARVMDefaultAttributes.
Return type:	int
	required

max_repository_capacity_as_percent_of_mirrored_capacity¶

Gets the max_repository_capacity_as_percent_of_mirrored_capacity of this ARVMDefaultAttributes. Maximum repository capacity as a percentage of the mirror capacity..

Required/optional:
Returns:	The max_repository_capacity_as_percent_of_mirrored_capacity of this ARVMDefaultAttributes.
Return type:	int
	required

maximum_connectivity_test_timeout¶

Gets the maximum_connectivity_test_timeout of this ARVMDefaultAttributes. Maximum timeout (in seconds) allowed for AMG connectivity test (specified in AsyncMirrorGroupConnectivityTestDescriptor).

Required/optional:
Returns:	The maximum_connectivity_test_timeout of this ARVMDefaultAttributes.
Return type:	int
	required

maximum_link_bandwidth_test_iterations¶

Gets the maximum_link_bandwidth_test_iterations of this ARVMDefaultAttributes. Maximum number of test iterations allowed for bandwidth test (specified in AsyncMirrorGroupConnectivityTestDescriptor when AsyncMirrorGroupConnectivityTestType is ASYNC_MIRROR_GROUP_LINK_BANDWIDTH_TEST).

Required/optional:
Returns:	The maximum_link_bandwidth_test_iterations of this ARVMDefaultAttributes.
Return type:	int
	required

maximum_link_latency_test_iterations¶

Gets the maximum_link_latency_test_iterations of this ARVMDefaultAttributes. Maximum number of test iterations allowed for link latency test (specified in AsyncMirrorGroupConnectivityTestDescriptor when AsyncMirrorGroupConnectivityTestType is ASYNC_MIRROR_GROUP_LINK_LATENCY_TEST).

Required/optional:
Returns:	The maximum_link_latency_test_iterations of this ARVMDefaultAttributes.
Return type:	int
	required

minimum_repository_capacity_in_bytes¶

Gets the minimum_repository_capacity_in_bytes of this ARVMDefaultAttributes. The minimum repository size (in bytes) for a mirror repository.

Required/optional:
Returns:	The minimum_repository_capacity_in_bytes of this ARVMDefaultAttributes.
Return type:	int
	required

minimum_repository_capacity_in_hundredths_of_percent_of_mirrored_capacity¶

Gets the minimum_repository_capacity_in_hundredths_of_percent_of_mirrored_capacity of this ARVMDefaultAttributes. The minimum repository size as 1/100ths of a percent of mirror capacity.

Required/optional:
Returns:	The minimum_repository_capacity_in_hundredths_of_percent_of_mirrored_capacity of this ARVMDefaultAttributes.
Return type:	int
	required

minimum_sync_interval_in_minutes¶

Gets the minimum_sync_interval_in_minutes of this ARVMDefaultAttributes. Minimum sync interval in minutes.

Required/optional:
Returns:	The minimum_sync_interval_in_minutes of this ARVMDefaultAttributes.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.asup_status module¶

AsupStatus.py

class netapp.santricity.models.symbol.asup_status.AsupStatus[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

asup¶

Gets the asup of this AsupStatus.

Required/optional:
Returns:	The asup of this AsupStatus.
Return type:	bool
	optional

on_demand¶

Gets the on_demand of this AsupStatus.

Required/optional:
Returns:	The on_demand of this AsupStatus.
Return type:	bool
	optional

remote_diags¶

Gets the remote_diags of this AsupStatus.

Required/optional:
Returns:	The remote_diags of this AsupStatus.
Return type:	bool
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.asup_status_returned module¶

AsupStatusReturned.py

class netapp.santricity.models.symbol.asup_status_returned.AsupStatusReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

asup_status¶

Gets the asup_status of this AsupStatusReturned. This field is returned if the value of returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The asup_status of this AsupStatusReturned.
Return type:	AsupStatus
	optional

return_code¶

Gets the return_code of this AsupStatusReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this AsupStatusReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group module¶

AsyncMirrorGroup.py

class netapp.santricity.models.symbol.async_mirror_group.AsyncMirrorGroup[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

group_ref¶

Gets the group_ref of this AsyncMirrorGroup. The reference (key) for the mirror group.

Required/optional:
Returns:	The group_ref of this AsyncMirrorGroup.
Return type:	str
	required

group_state¶

Gets the group_state of this AsyncMirrorGroup. The Mirror Group State. This is determined primarily by the presence or lack of a recovery point.

Required/optional:
Returns:	The group_state of this AsyncMirrorGroup.
Return type:	str
	required

label¶

Gets the label of this AsyncMirrorGroup. The user assigned name for the mirror group.

Required/optional:
Returns:	The label of this AsyncMirrorGroup.
Return type:	str
	required

local_role¶

Gets the local_role of this AsyncMirrorGroup. The current role of this (local) array with respect to this mirror group.

Required/optional:
Returns:	The local_role of this AsyncMirrorGroup.
Return type:	str
	required

mirror_channel_remote_target¶

Gets the mirror_channel_remote_target of this AsyncMirrorGroup. The path to the remote array to be used by this AMG (a reference to the associated RemoteTarget).

Required/optional:
Returns:	The mirror_channel_remote_target of this AsyncMirrorGroup.
Return type:	str
	required

orphan_group¶

Gets the orphan_group of this AsyncMirrorGroup. If true, the mirror group is an orphan.

Required/optional:
Returns:	The orphan_group of this AsyncMirrorGroup.
Return type:	bool
	required

recovery_point_age_alert_threshold_minutes¶

Gets the recovery_point_age_alert_threshold_minutes of this AsyncMirrorGroup. The recovery point age objective (in minutes). The user is notified via needs-attention when the age of the last good recovery point exceeds this value. A value of ARVM_RECOVERY_POINT_AGE_THRESHOLD_NONE indicates no threshold is set.

Required/optional:
Returns:	The recovery_point_age_alert_threshold_minutes of this AsyncMirrorGroup.
Return type:	int
	required

remote_role¶

Gets the remote_role of this AsyncMirrorGroup. The current role of the peer (remote) array with respect to this mirror group.

Required/optional:
Returns:	The remote_role of this AsyncMirrorGroup.
Return type:	str
	required

repository_utilization_warn_threshold¶

Gets the repository_utilization_warn_threshold of this AsyncMirrorGroup. The repository utilization warning threshold (0-100 percent). A needs attention condition will be generated if the percent of the repository capacity currently utilized exceeds this threshold.

Required/optional:
Returns:	The repository_utilization_warn_threshold of this AsyncMirrorGroup.
Return type:	int
	required

role_change_progress¶

Gets the role_change_progress of this AsyncMirrorGroup. This field indicates the current state of the role change process. This may be an extended condition due to the data sync needed for an orderly role change or the recovery point rollback needed for a no-sync or forced role change.

Required/optional:
Returns:	The role_change_progress of this AsyncMirrorGroup.
Return type:	str
	required

sync_activity¶

Gets the sync_activity of this AsyncMirrorGroup. Current synchronization activity.

Required/optional:
Returns:	The sync_activity of this AsyncMirrorGroup.
Return type:	str
	required

sync_completion_time_alert_threshold_minutes¶

Gets the sync_completion_time_alert_threshold_minutes of this AsyncMirrorGroup. The threshold (in minutes) for notifying the user that periodic synchronization has taken too long to complete. A value of ARVM_SYNC_COMPLETION_TIME_THRESHOLD_NONE indicates no threshold is set.

Required/optional:
Returns:	The sync_completion_time_alert_threshold_minutes of this AsyncMirrorGroup.
Return type:	int
	required

sync_interval_minutes¶

Gets the sync_interval_minutes of this AsyncMirrorGroup. The time in minutes between starting points of periodic synchronization intervals. A value of ARVM_MANUAL_SYNC_INTERVAL indicates synchronization intervals are manually started by the user.

Required/optional:
Returns:	The sync_interval_minutes of this AsyncMirrorGroup.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

world_wide_name¶

Gets the world_wide_name of this AsyncMirrorGroup. The world wide name of the mirror group. This can be used to identify the AMG pair on both arrays. The AsyncMirrorGroupRef is not guaranteed to be unique across multiple arrays.

Required/optional:
Returns:	The world_wide_name of this AsyncMirrorGroup.
Return type:	str
	required

netapp.santricity.models.symbol.async_mirror_group_action_result module¶

AsyncMirrorGroupActionResult.py

class netapp.santricity.models.symbol.async_mirror_group_action_result.AsyncMirrorGroupActionResult[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

members_requiring_deletion¶

Gets the members_requiring_deletion of this AsyncMirrorGroupActionResult. If the value of returnCode is equal to RETCODE_ARVM_RECOVERY_POINT_DELETION_REQUIRED, a list of members that need to be deleted is returned.

Required/optional:
Returns:	The members_requiring_deletion of this AsyncMirrorGroupActionResult.
Return type:	AsyncMirrorGroupMemberRefList
	optional

return_code¶

Gets the return_code of this AsyncMirrorGroupActionResult. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this AsyncMirrorGroupActionResult.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_add_primary_member_descriptor module¶

AsyncMirrorGroupAddPrimaryMemberDescriptor.py

class netapp.santricity.models.symbol.async_mirror_group_add_primary_member_descriptor.AsyncMirrorGroupAddPrimaryMemberDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

group_ref¶

Gets the group_ref of this AsyncMirrorGroupAddPrimaryMemberDescriptor. The AMG to which the member will be added.

Required/optional:
Returns:	The group_ref of this AsyncMirrorGroupAddPrimaryMemberDescriptor.
Return type:	str
	required

local_volume¶

Gets the local_volume of this AsyncMirrorGroupAddPrimaryMemberDescriptor. The member local volume to add to the AMG.

Required/optional:
Returns:	The local_volume of this AsyncMirrorGroupAddPrimaryMemberDescriptor.
Return type:	str
	required

remote_password¶

Gets the remote_password of this AsyncMirrorGroupAddPrimaryMemberDescriptor. The password for remote array. This is required to make sure the SYMbol client has authenticated the users access privileges to both the primary and secondary array.

Required/optional:
Returns:	The remote_password of this AsyncMirrorGroupAddPrimaryMemberDescriptor.
Return type:	RemoteArrayAuthenticator
	required

repository_candidate¶

Gets the repository_candidate of this AsyncMirrorGroupAddPrimaryMemberDescriptor. The repository volume candidate for the mirror repository on the primary array.

Required/optional:
Returns:	The repository_candidate of this AsyncMirrorGroupAddPrimaryMemberDescriptor.
Return type:	ConcatVolumeCreationDescriptor
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_add_secondary_member_descriptor module¶

AsyncMirrorGroupAddSecondaryMemberDescriptor.py

class netapp.santricity.models.symbol.async_mirror_group_add_secondary_member_descriptor.AsyncMirrorGroupAddSecondaryMemberDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

incomplete_member_ref¶

Gets the incomplete_member_ref of this AsyncMirrorGroupAddSecondaryMemberDescriptor. The”incomplete member” to finish configuring (implies AMG).

Required/optional:
Returns:	The incomplete_member_ref of this AsyncMirrorGroupAddSecondaryMemberDescriptor.
Return type:	str
	required

local_volume¶

Gets the local_volume of this AsyncMirrorGroupAddSecondaryMemberDescriptor. The member volume to add to the AMG (the mirror secondary volume).

Required/optional:
Returns:	The local_volume of this AsyncMirrorGroupAddSecondaryMemberDescriptor.
Return type:	str
	required

repository_candidate¶

Gets the repository_candidate of this AsyncMirrorGroupAddSecondaryMemberDescriptor. The repository volume candidate for the mirror repository on the primary array.

Required/optional:
Returns:	The repository_candidate of this AsyncMirrorGroupAddSecondaryMemberDescriptor.
Return type:	ConcatVolumeCreationDescriptor
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_connectivity_test_descriptor module¶

AsyncMirrorGroupConnectivityTestDescriptor.py

class netapp.santricity.models.symbol.async_mirror_group_connectivity_test_descriptor.AsyncMirrorGroupConnectivityTestDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

group_ref¶

Gets the group_ref of this AsyncMirrorGroupConnectivityTestDescriptor. The Async Mirror Group on which the connectivity test is to be performed.

Required/optional:
Returns:	The group_ref of this AsyncMirrorGroupConnectivityTestDescriptor.
Return type:	str
	required

requested_test_type¶

Gets the requested_test_type of this AsyncMirrorGroupConnectivityTestDescriptor. Type of test to perform.

Required/optional:
Returns:	The requested_test_type of this AsyncMirrorGroupConnectivityTestDescriptor.
Return type:	str
	required

test_iterations¶

Gets the test_iterations of this AsyncMirrorGroupConnectivityTestDescriptor. Number of test iterations to run.

Required/optional:
Returns:	The test_iterations of this AsyncMirrorGroupConnectivityTestDescriptor.
Return type:	int
	required

timeout¶

Gets the timeout of this AsyncMirrorGroupConnectivityTestDescriptor. Timeout in seconds. For no timeout, this value should be set to ARVM_CONNECTIVITY_TEST_NO_TIMEOUT.

Required/optional:
Returns:	The timeout of this AsyncMirrorGroupConnectivityTestDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_connectivity_test_results module¶

AsyncMirrorGroupConnectivityTestResults.py

class netapp.santricity.models.symbol.async_mirror_group_connectivity_test_results.AsyncMirrorGroupConnectivityTestResults[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

bandwidth_test_results¶

Gets the bandwidth_test_results of this AsyncMirrorGroupConnectivityTestResults. This field is returned if the testType is equal to ASYNC_MIRROR_GROUP_LINK_BANDWIDTH_TEST.

Required/optional:
Returns:	The bandwidth_test_results of this AsyncMirrorGroupConnectivityTestResults.
Return type:	AsyncMirrorGroupLinkBandwidthTestResults
	optional

link_test_results¶

Gets the link_test_results of this AsyncMirrorGroupConnectivityTestResults. This field is returned if the testType is equal to ASYNC_MIRROR_GROUP_LINK_LATENCY_TEST.

Required/optional:
Returns:	The link_test_results of this AsyncMirrorGroupConnectivityTestResults.
Return type:	AsyncMirrorGroupLinkLatencyTestResults
	optional

test_type¶

Gets the test_type of this AsyncMirrorGroupConnectivityTestResults. Types of AMG connectivity tests.

Required/optional:
Returns:	The test_type of this AsyncMirrorGroupConnectivityTestResults.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_connectivity_test_results_returned module¶

AsyncMirrorGroupConnectivityTestResultsReturned.py

class netapp.santricity.models.symbol.async_mirror_group_connectivity_test_results_returned.AsyncMirrorGroupConnectivityTestResultsReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

mismatch_members¶

Gets the mismatch_members of this AsyncMirrorGroupConnectivityTestResultsReturned. A list of mismatched mirror group members is returned only if the ReturnCode equals RETCODE_ARVM_CONNECTIVITY_TEST_AMG_MEMBER_MISMATCH.

Required/optional:
Returns:	The mismatch_members of this AsyncMirrorGroupConnectivityTestResultsReturned.
Return type:	AsyncMirrorGroupMemberMismatchList
	optional

return_code¶

Gets the return_code of this AsyncMirrorGroupConnectivityTestResultsReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this AsyncMirrorGroupConnectivityTestResultsReturned.
Return type:	str
	required

test_results¶

Gets the test_results of this AsyncMirrorGroupConnectivityTestResultsReturned. Test results are returned only if the ReturnCode equals RETCODE_OK.

Required/optional:
Returns:	The test_results of this AsyncMirrorGroupConnectivityTestResultsReturned.
Return type:	AsyncMirrorGroupConnectivityTestResults
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_creation_descriptor module¶

AsyncMirrorGroupCreationDescriptor.py

class netapp.santricity.models.symbol.async_mirror_group_creation_descriptor.AsyncMirrorGroupCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

connection_descriptor¶

Gets the connection_descriptor of this AsyncMirrorGroupCreationDescriptor. A reference to an existing Remote Target or candidate information to create a new Remote Target.

Required/optional:
Returns:	The connection_descriptor of this AsyncMirrorGroupCreationDescriptor.
Return type:	AsyncMirrorGroupMirrorConnectionDescriptor
	required

group_label¶

Gets the group_label of this AsyncMirrorGroupCreationDescriptor. A user defined label for the new mirror group.

Required/optional:
Returns:	The group_label of this AsyncMirrorGroupCreationDescriptor.
Return type:	str
	required

recovery_point_age_alert_threshold_minutes¶

Gets the recovery_point_age_alert_threshold_minutes of this AsyncMirrorGroupCreationDescriptor. The recovery point age objective (in minutes). The user is notified via needs-attention when the age of the last good recovery point exceeds this value.

Required/optional:
Returns:	The recovery_point_age_alert_threshold_minutes of this AsyncMirrorGroupCreationDescriptor.
Return type:	int
	required

remote_password¶

Gets the remote_password of this AsyncMirrorGroupCreationDescriptor. The password for remote array. This is required to make sure the SYMbol client has authenticated the users access privileges to both the primary and secondary array.

Required/optional:
Returns:	The remote_password of this AsyncMirrorGroupCreationDescriptor.
Return type:	RemoteArrayAuthenticator
	required

repository_utilization_warn_threshold¶

Gets the repository_utilization_warn_threshold of this AsyncMirrorGroupCreationDescriptor. The repository utilization warning threshold (0-100 percent). A needs attention condition will be generated if the percent of repository capacity currently utilized exceeds this threshold.

Required/optional:
Returns:	The repository_utilization_warn_threshold of this AsyncMirrorGroupCreationDescriptor.
Return type:	int
	required

sync_completion_time_alert_threshold_minutes¶

Gets the sync_completion_time_alert_threshold_minutes of this AsyncMirrorGroupCreationDescriptor. The threshold (in minutes) for notifying the user that periodic synchronization has taken too long to complete.

Required/optional:
Returns:	The sync_completion_time_alert_threshold_minutes of this AsyncMirrorGroupCreationDescriptor.
Return type:	int
	required

sync_interval_minutes¶

Gets the sync_interval_minutes of this AsyncMirrorGroupCreationDescriptor. The synchronization interval (in minutes).

Required/optional:
Returns:	The sync_interval_minutes of this AsyncMirrorGroupCreationDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_deletion_descriptor module¶

AsyncMirrorGroupDeletionDescriptor.py

class netapp.santricity.models.symbol.async_mirror_group_deletion_descriptor.AsyncMirrorGroupDeletionDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

force¶

Gets the force of this AsyncMirrorGroupDeletionDescriptor. If true, indicates that the group deletion should be forced. This is necessary when trying to delete an orphaned AMG or delete an AMG when the remote is unreachable (for example, when the remote array was physically destroyed so the AMG deletion needs to be forced).

Required/optional:
Returns:	The force of this AsyncMirrorGroupDeletionDescriptor.
Return type:	bool
	required

group_ref¶

Gets the group_ref of this AsyncMirrorGroupDeletionDescriptor. The AMG to be deleted.

Required/optional:
Returns:	The group_ref of this AsyncMirrorGroupDeletionDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_fault_indication module¶

AsyncMirrorGroupFaultIndication.py

class netapp.santricity.models.symbol.async_mirror_group_fault_indication.AsyncMirrorGroupFaultIndication[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

fault_time¶

Gets the fault_time of this AsyncMirrorGroupFaultIndication. The last time at which the fault occurred represented in seconds since midnight GMT on January 1, 1970.

Required/optional:
Returns:	The fault_time of this AsyncMirrorGroupFaultIndication.
Return type:	int
	required

mirror_group¶

Gets the mirror_group of this AsyncMirrorGroupFaultIndication. The mirror group with the fault.

Required/optional:
Returns:	The mirror_group of this AsyncMirrorGroupFaultIndication.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_fault_indication_clear_descriptor module¶

AsyncMirrorGroupFaultIndicationClearDescriptor.py

class netapp.santricity.models.symbol.async_mirror_group_fault_indication_clear_descriptor.AsyncMirrorGroupFaultIndicationClearDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

indication¶

Gets the indication of this AsyncMirrorGroupFaultIndicationClearDescriptor. The type of indication to clear.

Required/optional:
Returns:	The indication of this AsyncMirrorGroupFaultIndicationClearDescriptor.
Return type:	str
	required

mirror_group¶

Gets the mirror_group of this AsyncMirrorGroupFaultIndicationClearDescriptor. The AMG with condition to be cleared / acknowledged.

Required/optional:
Returns:	The mirror_group of this AsyncMirrorGroupFaultIndicationClearDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_incomplete_member module¶

AsyncMirrorGroupIncompleteMember.py

class netapp.santricity.models.symbol.async_mirror_group_incomplete_member.AsyncMirrorGroupIncompleteMember[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

group_ref¶

Gets the group_ref of this AsyncMirrorGroupIncompleteMember. The associated Async Mirror Group.

Required/optional:
Returns:	The group_ref of this AsyncMirrorGroupIncompleteMember.
Return type:	str
	required

member_ref¶

Gets the member_ref of this AsyncMirrorGroupIncompleteMember. The reference (key) for the group member.

Required/optional:
Returns:	The member_ref of this AsyncMirrorGroupIncompleteMember.
Return type:	str
	required

orphan_incomplete_member¶

Gets the orphan_incomplete_member of this AsyncMirrorGroupIncompleteMember. If true, the incomplete member is an orphan.

Required/optional:
Returns:	The orphan_incomplete_member of this AsyncMirrorGroupIncompleteMember.
Return type:	bool
	required

primary_vol_capacity¶

Gets the primary_vol_capacity of this AsyncMirrorGroupIncompleteMember. Capacity of the primary (used to aid in selection of mirror secondary volume).

Required/optional:
Returns:	The primary_vol_capacity of this AsyncMirrorGroupIncompleteMember.
Return type:	int
	required

primary_vol_protection_type¶

Gets the primary_vol_protection_type of this AsyncMirrorGroupIncompleteMember. The protection type of the primary volume.

Required/optional:
Returns:	The primary_vol_protection_type of this AsyncMirrorGroupIncompleteMember.
Return type:	str
	required

primary_vol_raid_level¶

Gets the primary_vol_raid_level of this AsyncMirrorGroupIncompleteMember. RAID level of the primary volume.

Required/optional:
Returns:	The primary_vol_raid_level of this AsyncMirrorGroupIncompleteMember.
Return type:	str
	required

primary_vol_security_level¶

Gets the primary_vol_security_level of this AsyncMirrorGroupIncompleteMember. Refines the information in the securityType field to describe the set of drives.

Required/optional:
Returns:	The primary_vol_security_level of this AsyncMirrorGroupIncompleteMember.
Return type:	str
	required

primary_vol_security_type¶

Gets the primary_vol_security_type of this AsyncMirrorGroupIncompleteMember. Security type of the primary volume.

Required/optional:
Returns:	The primary_vol_security_type of this AsyncMirrorGroupIncompleteMember.
Return type:	str
	required

primary_vol_user_label¶

Gets the primary_vol_user_label of this AsyncMirrorGroupIncompleteMember. User label of the primary volume.

Required/optional:
Returns:	The primary_vol_user_label of this AsyncMirrorGroupIncompleteMember.
Return type:	str
	required

primary_vol_wwn¶

Gets the primary_vol_wwn of this AsyncMirrorGroupIncompleteMember. The WWN of the primary volume on the remote array.

Required/optional:
Returns:	The primary_vol_wwn of this AsyncMirrorGroupIncompleteMember.
Return type:	str
	required

primary_volume_parameters¶

Gets the primary_volume_parameters of this AsyncMirrorGroupIncompleteMember. The capacity provisioning parameters for the primary volume.

Required/optional:
Returns:	The primary_volume_parameters of this AsyncMirrorGroupIncompleteMember.
Return type:	VolumeTypeParameters
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_initial_sync_operation module¶

AsyncMirrorGroupInitialSyncOperation.py

class netapp.santricity.models.symbol.async_mirror_group_initial_sync_operation.AsyncMirrorGroupInitialSyncOperation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

group_percent_complete¶

Gets the group_percent_complete of this AsyncMirrorGroupInitialSyncOperation. Completion percentage for the operation. If the operation is not currently running this value will be equal to PERCENT_COMPLETE_OP_NOT_RUNNING.

Required/optional:
Returns:	The group_percent_complete of this AsyncMirrorGroupInitialSyncOperation.
Return type:	int
	required

group_ref¶

Gets the group_ref of this AsyncMirrorGroupInitialSyncOperation. A reference to the async mirror group..

Required/optional:
Returns:	The group_ref of this AsyncMirrorGroupInitialSyncOperation.
Return type:	str
	required

group_sync_bytes¶

Gets the group_sync_bytes of this AsyncMirrorGroupInitialSyncOperation. The amount of data that remains to be synchronized.

Required/optional:
Returns:	The group_sync_bytes of this AsyncMirrorGroupInitialSyncOperation.
Return type:	int
	required

group_time_to_completion¶

Gets the group_time_to_completion of this AsyncMirrorGroupInitialSyncOperation. The estimated time to completion in minutes. If the time is not known this value will be equal to TIME_TO_COMPLETION_UNKNOWN.

Required/optional:
Returns:	The group_time_to_completion of this AsyncMirrorGroupInitialSyncOperation.
Return type:	int
	required

member_progress¶

Gets the member_progress of this AsyncMirrorGroupInitialSyncOperation. A list of members still in initial sync and the respective progress of each.

Required/optional:
Returns:	The member_progress of this AsyncMirrorGroupInitialSyncOperation.
Return type:	list[AsyncMirrorGroupMemberInitialSyncOperation]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_link_bandwidth_test_results module¶

AsyncMirrorGroupLinkBandwidthTestResults.py

class netapp.santricity.models.symbol.async_mirror_group_link_bandwidth_test_results.AsyncMirrorGroupLinkBandwidthTestResults[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

avg_bandwidth_bits_per_second¶

Gets the avg_bandwidth_bits_per_second of this AsyncMirrorGroupLinkBandwidthTestResults. The average bandwidth measured in bits per second.

Required/optional:
Returns:	The avg_bandwidth_bits_per_second of this AsyncMirrorGroupLinkBandwidthTestResults.
Return type:	int
	required

latency_measures¶

Gets the latency_measures of this AsyncMirrorGroupLinkBandwidthTestResults. The bandwidth test also returns latency values since latency numbers are measured in order to factor them out of the bandwidth calculations.

Required/optional:
Returns:	The latency_measures of this AsyncMirrorGroupLinkBandwidthTestResults.
Return type:	AsyncMirrorGroupLinkLatencyTestResults
	required

max_bandwidth_bits_per_second¶

Gets the max_bandwidth_bits_per_second of this AsyncMirrorGroupLinkBandwidthTestResults. The maximum bandwidth measured in bits per second.

Required/optional:
Returns:	The max_bandwidth_bits_per_second of this AsyncMirrorGroupLinkBandwidthTestResults.
Return type:	int
	required

min_bandwidth_bits_per_second¶

Gets the min_bandwidth_bits_per_second of this AsyncMirrorGroupLinkBandwidthTestResults. The minimum bandwidth measured in bits per second.

Required/optional:
Returns:	The min_bandwidth_bits_per_second of this AsyncMirrorGroupLinkBandwidthTestResults.
Return type:	int
	required

negotiated_link_speed_bits_per_second¶

Gets the negotiated_link_speed_bits_per_second of this AsyncMirrorGroupLinkBandwidthTestResults. The negotiated link speed measured in bits per second.

Required/optional:
Returns:	The negotiated_link_speed_bits_per_second of this AsyncMirrorGroupLinkBandwidthTestResults.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_link_latency_test_results module¶

AsyncMirrorGroupLinkLatencyTestResults.py

class netapp.santricity.models.symbol.async_mirror_group_link_latency_test_results.AsyncMirrorGroupLinkLatencyTestResults[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

avg_latency_in_microseconds¶

Gets the avg_latency_in_microseconds of this AsyncMirrorGroupLinkLatencyTestResults. The average latency measured in microseconds.

Required/optional:
Returns:	The avg_latency_in_microseconds of this AsyncMirrorGroupLinkLatencyTestResults.
Return type:	int
	required

max_latency_in_microseconds¶

Gets the max_latency_in_microseconds of this AsyncMirrorGroupLinkLatencyTestResults. The maximum latency measured in microseconds.

Required/optional:
Returns:	The max_latency_in_microseconds of this AsyncMirrorGroupLinkLatencyTestResults.
Return type:	int
	required

min_latency_in_microseconds¶

Gets the min_latency_in_microseconds of this AsyncMirrorGroupLinkLatencyTestResults. The minimum latency measured in microseconds.

Required/optional:
Returns:	The min_latency_in_microseconds of this AsyncMirrorGroupLinkLatencyTestResults.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_member module¶

AsyncMirrorGroupMember.py

class netapp.santricity.models.symbol.async_mirror_group_member.AsyncMirrorGroupMember[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

id¶

Gets the id of this AsyncMirrorGroupMember.

Required/optional:
Returns:	The id of this AsyncMirrorGroupMember.
Return type:	str
	optional

last_recovery_point_time¶

Gets the last_recovery_point_time of this AsyncMirrorGroupMember. The timestamp, represented in seconds since midnight GMT on January 1, 1970, of the last recovery point PiT on secondary. If no recovery point image exists, the value of this field will be ARVM_NO_RECOVERY_POINT_TIMESTAMP.

Required/optional:
Returns:	The last_recovery_point_time of this AsyncMirrorGroupMember.
Return type:	int
	required

local_volume¶

Gets the local_volume of this AsyncMirrorGroupMember. The local volume for this mirror. This is the volume being mirrored if the AMG role is primary, otherwise this is the target of mirror synchronization.

Required/optional:
Returns:	The local_volume of this AsyncMirrorGroupMember.
Return type:	str
	required

member_ref¶

Gets the member_ref of this AsyncMirrorGroupMember. The reference (key) for the group member.

Required/optional:
Returns:	The member_ref of this AsyncMirrorGroupMember.
Return type:	str
	required

member_state¶

Gets the member_state of this AsyncMirrorGroupMember. The state of this mirror relationship (as known by this array).

Required/optional:
Returns:	The member_state of this AsyncMirrorGroupMember.
Return type:	str
	required

mirror_group¶

Gets the mirror_group of this AsyncMirrorGroupMember. The AMG with which this member is associated.

Required/optional:
Returns:	The mirror_group of this AsyncMirrorGroupMember.
Return type:	str
	required

mirrored_local_capacity¶

Gets the mirrored_local_capacity of this AsyncMirrorGroupMember. The current local volume capacity that is being mirrored. This will be less than the actual local volume capacity if we have not yet reached a point where the next PiT can be taken and delta-logs resized (and until that point the expanded local capacity will not be opened up to host writes).

Required/optional:
Returns:	The mirrored_local_capacity of this AsyncMirrorGroupMember.
Return type:	int
	required

over_utilization_warn_threshold¶

Gets the over_utilization_warn_threshold of this AsyncMirrorGroupMember. If true, the repository capacity utilized is over the warning threshold.

Required/optional:
Returns:	The over_utilization_warn_threshold of this AsyncMirrorGroupMember.
Return type:	bool
	required

remote_volume¶

Gets the remote_volume of this AsyncMirrorGroupMember. The remote volume. This is the target of mirror synchronization on the remote array if the AMG role is primary, otherwise this is the volume on the remote array that is being mirrored.

Required/optional:
Returns:	The remote_volume of this AsyncMirrorGroupMember.
Return type:	str
	required

repository_full¶

Gets the repository_full of this AsyncMirrorGroupMember. If true, the repository is full (100% of available capacity utilized).

Required/optional:
Returns:	The repository_full of this AsyncMirrorGroupMember.
Return type:	bool
	required

repository_volume¶

Gets the repository_volume of this AsyncMirrorGroupMember. The metadata volume (Copy-on-Write / DeltaLog Repository) for this mirror.

Required/optional:
Returns:	The repository_volume of this AsyncMirrorGroupMember.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_handle¶

Gets the volume_handle of this AsyncMirrorGroupMember. The SSID of the async mirror proxy.

Required/optional:
Returns:	The volume_handle of this AsyncMirrorGroupMember.
Return type:	int
	required

world_wide_name¶

Gets the world_wide_name of this AsyncMirrorGroupMember. The WWN of the async mirror proxy.

Required/optional:
Returns:	The world_wide_name of this AsyncMirrorGroupMember.
Return type:	str
	required

netapp.santricity.models.symbol.async_mirror_group_member_fault_indication module¶

AsyncMirrorGroupMemberFaultIndication.py

class netapp.santricity.models.symbol.async_mirror_group_member_fault_indication.AsyncMirrorGroupMemberFaultIndication[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

fault_time¶

Gets the fault_time of this AsyncMirrorGroupMemberFaultIndication. The last time at which the fault occurred represented in seconds since midnight GMT on January 1, 1970.

Required/optional:
Returns:	The fault_time of this AsyncMirrorGroupMemberFaultIndication.
Return type:	int
	required

mirror_member¶

Gets the mirror_member of this AsyncMirrorGroupMemberFaultIndication. The mirror group member with the fault.

Required/optional:
Returns:	The mirror_member of this AsyncMirrorGroupMemberFaultIndication.
Return type:	str
	required

percent_complete¶

Gets the percent_complete of this AsyncMirrorGroupMemberFaultIndication. The completion percentage for the operation running at the time of the fault. If no operation was running at the time of the fault, this value will be equal to PERCENT_COMPLETE_OP_NOT_RUNNING. If the percentage complete is unknown or not applicable to the particular fault, this value will be equal to PERCENT_COMPLETE_UNKNOWN.

Required/optional:
Returns:	The percent_complete of this AsyncMirrorGroupMemberFaultIndication.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_member_fault_indication_clear_descriptor module¶

AsyncMirrorGroupMemberFaultIndicationClearDescriptor.py

class netapp.santricity.models.symbol.async_mirror_group_member_fault_indication_clear_descriptor.AsyncMirrorGroupMemberFaultIndicationClearDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

indication¶

Gets the indication of this AsyncMirrorGroupMemberFaultIndicationClearDescriptor. The type of indication to clear.

Required/optional:
Returns:	The indication of this AsyncMirrorGroupMemberFaultIndicationClearDescriptor.
Return type:	str
	required

member¶

Gets the member of this AsyncMirrorGroupMemberFaultIndicationClearDescriptor. The AMG member with condition to be cleared / acknowledged.

Required/optional:
Returns:	The member of this AsyncMirrorGroupMemberFaultIndicationClearDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_member_initial_sync_operation module¶

AsyncMirrorGroupMemberInitialSyncOperation.py

class netapp.santricity.models.symbol.async_mirror_group_member_initial_sync_operation.AsyncMirrorGroupMemberInitialSyncOperation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

mirror_member_ref¶

Gets the mirror_member_ref of this AsyncMirrorGroupMemberInitialSyncOperation. A reference to the async mirror group.

Required/optional:
Returns:	The mirror_member_ref of this AsyncMirrorGroupMemberInitialSyncOperation.
Return type:	str
	required

percent_complete¶

Gets the percent_complete of this AsyncMirrorGroupMemberInitialSyncOperation. The completion percentage for the operation. If the operation is not currently running this value will be equal to PERCENT_COMPLETE_OP_NOT_RUNNING.

Required/optional:
Returns:	The percent_complete of this AsyncMirrorGroupMemberInitialSyncOperation.
Return type:	int
	required

sync_bytes¶

Gets the sync_bytes of this AsyncMirrorGroupMemberInitialSyncOperation. The amount of data that remains to be synchronized.

Required/optional:
Returns:	The sync_bytes of this AsyncMirrorGroupMemberInitialSyncOperation.
Return type:	int
	required

time_to_completion¶

Gets the time_to_completion of this AsyncMirrorGroupMemberInitialSyncOperation. The estimated time to completion in minutes. If the time is not known this value will be equal to TIME_TO_COMPLETION_UNKNOWN.

Required/optional:
Returns:	The time_to_completion of this AsyncMirrorGroupMemberInitialSyncOperation.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_member_mismatch_list module¶

AsyncMirrorGroupMemberMismatchList.py

class netapp.santricity.models.symbol.async_mirror_group_member_mismatch_list.AsyncMirrorGroupMemberMismatchList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

group_ref¶

Gets the group_ref of this AsyncMirrorGroupMemberMismatchList. The Async Mirror Group.

Required/optional:
Returns:	The group_ref of this AsyncMirrorGroupMemberMismatchList.
Return type:	str
	required

members_local_but_not_remote¶

Gets the members_local_but_not_remote of this AsyncMirrorGroupMemberMismatchList. A list of base volume labels for members that are present on the local array but not on the remote.

Required/optional:
Returns:	The members_local_but_not_remote of this AsyncMirrorGroupMemberMismatchList.
Return type:	list[str]
	required

members_remote_but_not_local¶

Gets the members_remote_but_not_local of this AsyncMirrorGroupMemberMismatchList. A list of base volume labels for members that are present on the remote array but not on the local.

Required/optional:
Returns:	The members_remote_but_not_local of this AsyncMirrorGroupMemberMismatchList.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_member_ref_list module¶

AsyncMirrorGroupMemberRefList.py

class netapp.santricity.models.symbol.async_mirror_group_member_ref_list.AsyncMirrorGroupMemberRefList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

mirror_ref¶

Gets the mirror_ref of this AsyncMirrorGroupMemberRefList. An array of AsyncMirrorGroupMember references.

Required/optional:
Returns:	The mirror_ref of this AsyncMirrorGroupMemberRefList.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_member_sync_progress module¶

AsyncMirrorGroupMemberSyncProgress.py

class netapp.santricity.models.symbol.async_mirror_group_member_sync_progress.AsyncMirrorGroupMemberSyncProgress[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

mirror_ref¶

Gets the mirror_ref of this AsyncMirrorGroupMemberSyncProgress. A reference to the async mirror member.

Required/optional:
Returns:	The mirror_ref of this AsyncMirrorGroupMemberSyncProgress.
Return type:	str
	required

percent_complete¶

Gets the percent_complete of this AsyncMirrorGroupMemberSyncProgress. The completion percentage for the operation. If the operation is not currently running this value will be equal to PERCENT_COMPLETE_OP_NOT_RUNNING.

Required/optional:
Returns:	The percent_complete of this AsyncMirrorGroupMemberSyncProgress.
Return type:	int
	required

sync_bytes¶

Gets the sync_bytes of this AsyncMirrorGroupMemberSyncProgress. The amount of data that remains to be synchronized in the current synchronization step.

Required/optional:
Returns:	The sync_bytes of this AsyncMirrorGroupMemberSyncProgress.
Return type:	int
	required

time_to_completion¶

Gets the time_to_completion of this AsyncMirrorGroupMemberSyncProgress. The estimated time to completion in minutes. If the time is not known this value will be equal to TIME_TO_COMPLETION_UNKNOWN.

Required/optional:
Returns:	The time_to_completion of this AsyncMirrorGroupMemberSyncProgress.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tracking_bytes¶

Gets the tracking_bytes of this AsyncMirrorGroupMemberSyncProgress. Amount of data (in bytes) marked as unsynchronized in the tracking delta log for this member.

Required/optional:
Returns:	The tracking_bytes of this AsyncMirrorGroupMemberSyncProgress.
Return type:	int
	required

netapp.santricity.models.symbol.async_mirror_group_mirror_connection_descriptor module¶

AsyncMirrorGroupMirrorConnectionDescriptor.py

class netapp.santricity.models.symbol.async_mirror_group_mirror_connection_descriptor.AsyncMirrorGroupMirrorConnectionDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

candidate_type¶

Gets the candidate_type of this AsyncMirrorGroupMirrorConnectionDescriptor. This enumeration lists the Async Mirror Group connection candidate types.

Required/optional:
Returns:	The candidate_type of this AsyncMirrorGroupMirrorConnectionDescriptor.
Return type:	str
	required

existing_remote_target¶

Gets the existing_remote_target of this AsyncMirrorGroupMirrorConnectionDescriptor. This field is present only if the value of candidateType is equal to ASYNC_MIRROR_CONNECTION_EXISTING_REMOTE_TARGET.

Required/optional:
Returns:	The existing_remote_target of this AsyncMirrorGroupMirrorConnectionDescriptor.
Return type:	str
	optional

new_remote_target¶

Gets the new_remote_target of this AsyncMirrorGroupMirrorConnectionDescriptor. This field is present only if the value of candidateType is equal to ASYNC_MIRROR_CONNECTION_NEW_REMOTE_TARGET

Required/optional:
Returns:	The new_remote_target of this AsyncMirrorGroupMirrorConnectionDescriptor.
Return type:	RemoteTargetCreationDescriptor
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_params_update_descriptor module¶

AsyncMirrorGroupParamsUpdateDescriptor.py

class netapp.santricity.models.symbol.async_mirror_group_params_update_descriptor.AsyncMirrorGroupParamsUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

group_label¶

Gets the group_label of this AsyncMirrorGroupParamsUpdateDescriptor. The user defined label for the mirror group.

Required/optional:
Returns:	The group_label of this AsyncMirrorGroupParamsUpdateDescriptor.
Return type:	str
	required

group_ref¶

Gets the group_ref of this AsyncMirrorGroupParamsUpdateDescriptor. A reference to the Async Mirror Group whose parameters are being updated.

Required/optional:
Returns:	The group_ref of this AsyncMirrorGroupParamsUpdateDescriptor.
Return type:	str
	required

recovery_point_age_alert_threshold_minutes¶

Gets the recovery_point_age_alert_threshold_minutes of this AsyncMirrorGroupParamsUpdateDescriptor. The recovery point age objective (in minutes). The user is notified via needs-attention when age of last good recovery point exceeds this value.

Required/optional:
Returns:	The recovery_point_age_alert_threshold_minutes of this AsyncMirrorGroupParamsUpdateDescriptor.
Return type:	int
	required

repository_utilization_warn_threshold¶

Gets the repository_utilization_warn_threshold of this AsyncMirrorGroupParamsUpdateDescriptor. The repository utilization warning threshold (0-100 percent). A needs attention condition will be generated if percent of repository capacity currently utilized exceeds this threshold.

Required/optional:
Returns:	The repository_utilization_warn_threshold of this AsyncMirrorGroupParamsUpdateDescriptor.
Return type:	int
	required

sync_completion_time_alert_threshold_minutes¶

Gets the sync_completion_time_alert_threshold_minutes of this AsyncMirrorGroupParamsUpdateDescriptor. The threshold (in minutes) for notifying the user that periodic synchronization has taken too long to complete.

Required/optional:
Returns:	The sync_completion_time_alert_threshold_minutes of this AsyncMirrorGroupParamsUpdateDescriptor.
Return type:	int
	required

sync_interval_minutes¶

Gets the sync_interval_minutes of this AsyncMirrorGroupParamsUpdateDescriptor. The synchronization interval (in minutes).

Required/optional:
Returns:	The sync_interval_minutes of this AsyncMirrorGroupParamsUpdateDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_recover_descriptor module¶

AsyncMirrorGroupRecoverDescriptor.py

class netapp.santricity.models.symbol.async_mirror_group_recover_descriptor.AsyncMirrorGroupRecoverDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

delete_recovery_point_if_necessary¶

Gets the delete_recovery_point_if_necessary of this AsyncMirrorGroupRecoverDescriptor. If true, deletion of recovery point will be allowed if necessary.

Required/optional:
Returns:	The delete_recovery_point_if_necessary of this AsyncMirrorGroupRecoverDescriptor.
Return type:	bool
	required

member_ref¶

Gets the member_ref of this AsyncMirrorGroupRecoverDescriptor. A reference to the asynchronous mirror group member.

Required/optional:
Returns:	The member_ref of this AsyncMirrorGroupRecoverDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_ref_list module¶

AsyncMirrorGroupRefList.py

class netapp.santricity.models.symbol.async_mirror_group_ref_list.AsyncMirrorGroupRefList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

group_ref¶

Gets the group_ref of this AsyncMirrorGroupRefList. An array of AsyncMirrorGroup references.

Required/optional:
Returns:	The group_ref of this AsyncMirrorGroupRefList.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_remove_member_descriptor module¶

AsyncMirrorGroupRemoveMemberDescriptor.py

class netapp.santricity.models.symbol.async_mirror_group_remove_member_descriptor.AsyncMirrorGroupRemoveMemberDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

force¶

Gets the force of this AsyncMirrorGroupRemoveMemberDescriptor. If true, the member removal should be forced. This is necessary when trying to remove an orphaned member or remove a member when the remote is unreachable (for example, when the remote array was physically destroyed so member deletion needs to be forced to allow for AMG deletion.

Required/optional:
Returns:	The force of this AsyncMirrorGroupRemoveMemberDescriptor.
Return type:	bool
	required

group_ref¶

Gets the group_ref of this AsyncMirrorGroupRemoveMemberDescriptor. The AMG from which the member is to be removed.

Required/optional:
Returns:	The group_ref of this AsyncMirrorGroupRemoveMemberDescriptor.
Return type:	str
	required

member_ref¶

Gets the member_ref of this AsyncMirrorGroupRemoveMemberDescriptor. The member to remove (must be a member of the mirror group specified above).

Required/optional:
Returns:	The member_ref of this AsyncMirrorGroupRemoveMemberDescriptor.
Return type:	str
	required

retain_repository_members¶

Gets the retain_repository_members of this AsyncMirrorGroupRemoveMemberDescriptor. If true, the REPOSITORY member volumes should be retained. If false, they will be deleted.

Required/optional:
Returns:	The retain_repository_members of this AsyncMirrorGroupRemoveMemberDescriptor.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_resume_descriptor module¶

AsyncMirrorGroupResumeDescriptor.py

class netapp.santricity.models.symbol.async_mirror_group_resume_descriptor.AsyncMirrorGroupResumeDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

delete_recovery_point_if_necessary¶

Gets the delete_recovery_point_if_necessary of this AsyncMirrorGroupResumeDescriptor. Flag indicating whether recovery point can be deleted on the secondary if necessary to achieve the synchronization. If true, and if the amount of unsynchronized data exceeds the CoW repository capacity on the secondary for any member volume, the last recovery point will be deleted and synchronization will continue. If false, the synchronization will be suspended if the amount of unsynchronized data exceeds the CoW Repository capacity on the secondary and the recovery point will be preserved.

Required/optional:
Returns:	The delete_recovery_point_if_necessary of this AsyncMirrorGroupResumeDescriptor.
Return type:	bool
	required

group_ref¶

Gets the group_ref of this AsyncMirrorGroupResumeDescriptor. The AMG on which synchronization is to be resumed.

Required/optional:
Returns:	The group_ref of this AsyncMirrorGroupResumeDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_role_change_cancel_descriptor module¶

AsyncMirrorGroupRoleChangeCancelDescriptor.py

class netapp.santricity.models.symbol.async_mirror_group_role_change_cancel_descriptor.AsyncMirrorGroupRoleChangeCancelDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

group_ref¶

Gets the group_ref of this AsyncMirrorGroupRoleChangeCancelDescriptor. The reference of the Async Mirror Group on which role change needs to be canceled.

Required/optional:
Returns:	The group_ref of this AsyncMirrorGroupRoleChangeCancelDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_role_change_descriptor module¶

AsyncMirrorGroupRoleChangeDescriptor.py

class netapp.santricity.models.symbol.async_mirror_group_role_change_descriptor.AsyncMirrorGroupRoleChangeDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

force¶

Gets the force of this AsyncMirrorGroupRoleChangeDescriptor. Force flag. If true, ignore if the remote array role change fails.

Required/optional:
Returns:	The force of this AsyncMirrorGroupRoleChangeDescriptor.
Return type:	bool
	required

group_ref¶

Gets the group_ref of this AsyncMirrorGroupRoleChangeDescriptor. The reference of the AMG on which the change is to be made.

Required/optional:
Returns:	The group_ref of this AsyncMirrorGroupRoleChangeDescriptor.
Return type:	str
	required

no_sync¶

Gets the no_sync of this AsyncMirrorGroupRoleChangeDescriptor. If true, changed data will not be synchronized before completing the role change. This will revert secondary (new primary) content to last recovery point.

Required/optional:
Returns:	The no_sync of this AsyncMirrorGroupRoleChangeDescriptor.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_role¶

Gets the to_role of this AsyncMirrorGroupRoleChangeDescriptor. The role for the local AMG.

Required/optional:
Returns:	The to_role of this AsyncMirrorGroupRoleChangeDescriptor.
Return type:	str
	required

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_suspend_descriptor module¶

AsyncMirrorGroupSuspendDescriptor.py

class netapp.santricity.models.symbol.async_mirror_group_suspend_descriptor.AsyncMirrorGroupSuspendDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

group_ref¶

Gets the group_ref of this AsyncMirrorGroupSuspendDescriptor. The AMG on which synchronization is to be suspended.

Required/optional:
Returns:	The group_ref of this AsyncMirrorGroupSuspendDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_sync_progress module¶

AsyncMirrorGroupSyncProgress.py

class netapp.santricity.models.symbol.async_mirror_group_sync_progress.AsyncMirrorGroupSyncProgress[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

group_percent_complete¶

Gets the group_percent_complete of this AsyncMirrorGroupSyncProgress. Completion percentage for the operation across the entire group. If synchronization is not currently running this value will be equal to PERCENT_COMPLETE_OP_NOT_RUNNING.

Required/optional:
Returns:	The group_percent_complete of this AsyncMirrorGroupSyncProgress.
Return type:	int
	required

group_ref¶

Gets the group_ref of this AsyncMirrorGroupSyncProgress. Reference to the async mirror group.

Required/optional:
Returns:	The group_ref of this AsyncMirrorGroupSyncProgress.
Return type:	str
	required

group_sync_bytes¶

Gets the group_sync_bytes of this AsyncMirrorGroupSyncProgress. Amount of data that needs to be synchronized for the entire group.

Required/optional:
Returns:	The group_sync_bytes of this AsyncMirrorGroupSyncProgress.
Return type:	int
	required

group_time_to_completion¶

Gets the group_time_to_completion of this AsyncMirrorGroupSyncProgress. Estimated time to completion in minutes for all members in the group that are undergoing synchronization. If the time is not known this value will be equal to TIME_TO_COMPLETION_UNKNOWN.

Required/optional:
Returns:	The group_time_to_completion of this AsyncMirrorGroupSyncProgress.
Return type:	int
	required

group_tracking_bytes¶

Gets the group_tracking_bytes of this AsyncMirrorGroupSyncProgress. The amount of data (in bytes) marked as unsynchronized in the tracking delta logs for the entire group.

Required/optional:
Returns:	The group_tracking_bytes of this AsyncMirrorGroupSyncProgress.
Return type:	int
	required

member_progress¶

Gets the member_progress of this AsyncMirrorGroupSyncProgress. List of progress information for each mirror group member.

Required/optional:
Returns:	The member_progress of this AsyncMirrorGroupSyncProgress.
Return type:	list[AsyncMirrorGroupMemberSyncProgress]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_sync_progress_list module¶

AsyncMirrorGroupSyncProgressList.py

class netapp.santricity.models.symbol.async_mirror_group_sync_progress_list.AsyncMirrorGroupSyncProgressList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

sync_progress¶

Gets the sync_progress of this AsyncMirrorGroupSyncProgressList. A variable-length array of AsyncMirrorGroupSyncProgress objects.

Required/optional:
Returns:	The sync_progress of this AsyncMirrorGroupSyncProgressList.
Return type:	list[AsyncMirrorGroupSyncProgress]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_sync_progress_list_returned module¶

AsyncMirrorGroupSyncProgressListReturned.py

class netapp.santricity.models.symbol.async_mirror_group_sync_progress_list_returned.AsyncMirrorGroupSyncProgressListReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

progress¶

Gets the progress of this AsyncMirrorGroupSyncProgressListReturned. This field is present only if the value of returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The progress of this AsyncMirrorGroupSyncProgressListReturned.
Return type:	AsyncMirrorGroupSyncProgressList
	optional

return_code¶

Gets the return_code of this AsyncMirrorGroupSyncProgressListReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this AsyncMirrorGroupSyncProgressListReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_group_synchronize_descriptor module¶

AsyncMirrorGroupSynchronizeDescriptor.py

class netapp.santricity.models.symbol.async_mirror_group_synchronize_descriptor.AsyncMirrorGroupSynchronizeDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

delete_recovery_point_if_necessary¶

Gets the delete_recovery_point_if_necessary of this AsyncMirrorGroupSynchronizeDescriptor. Flag indicating whether recovery point can be deleted on the secondary if necessary to achieve the synchronization. If true, and if the amount of unsynchronized data exceeds the CoW repository capacity on the secondary for any member volume, the last recovery point will be deleted and synchronization will continue. If false, the synchronization will be suspended if the amount of unsynchronized data exceeds the CoW Repository capacity on the secondary and the recovery point will be preserved.

Required/optional:
Returns:	The delete_recovery_point_if_necessary of this AsyncMirrorGroupSynchronizeDescriptor.
Return type:	bool
	required

group_ref¶

Gets the group_ref of this AsyncMirrorGroupSynchronizeDescriptor. The AMG to synchronize.

Required/optional:
Returns:	The group_ref of this AsyncMirrorGroupSynchronizeDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_primary_sync_statistics_sample module¶

AsyncMirrorPrimarySyncStatisticsSample.py

class netapp.santricity.models.symbol.async_mirror_primary_sync_statistics_sample.AsyncMirrorPrimarySyncStatisticsSample[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

completion_detail¶

Gets the completion_detail of this AsyncMirrorPrimarySyncStatisticsSample. Indication of whether synchronization failed or completed normally.

Required/optional:
Returns:	The completion_detail of this AsyncMirrorPrimarySyncStatisticsSample.
Return type:	AsyncMirrorSyncCompletionDetail
	required

cumulative_bytes_sent¶

Gets the cumulative_bytes_sent of this AsyncMirrorPrimarySyncStatisticsSample. The total bytes transferred during the time covered by this sample.

Required/optional:
Returns:	The cumulative_bytes_sent of this AsyncMirrorPrimarySyncStatisticsSample.
Return type:	int
	required

cumulative_io_time¶

Gets the cumulative_io_time of this AsyncMirrorPrimarySyncStatisticsSample. The total time spent sending data to the secondary for the duration of this sample (in microseconds). This is measured from the time each I/O is sent to the secondary until the response is received.

Required/optional:
Returns:	The cumulative_io_time of this AsyncMirrorPrimarySyncStatisticsSample.
Return type:	int
	required

highest_throughput_in_bytes_per_second¶

Gets the highest_throughput_in_bytes_per_second of this AsyncMirrorPrimarySyncStatisticsSample. The highest recorded throughput (in bytes/second) to the remote array for this mirror during this sample period.

Required/optional:
Returns:	The highest_throughput_in_bytes_per_second of this AsyncMirrorPrimarySyncStatisticsSample.
Return type:	int
	required

longest_response_time_bytes¶

Gets the longest_response_time_bytes of this AsyncMirrorPrimarySyncStatisticsSample. The number of bytes transferred on the longest request.

Required/optional:
Returns:	The longest_response_time_bytes of this AsyncMirrorPrimarySyncStatisticsSample.
Return type:	int
	required

longest_response_time_micro_seconds¶

Gets the longest_response_time_micro_seconds of this AsyncMirrorPrimarySyncStatisticsSample. The longest response time from the secondary array observed for one request during the time covered by this sample (in microseconds).

Required/optional:
Returns:	The longest_response_time_micro_seconds of this AsyncMirrorPrimarySyncStatisticsSample.
Return type:	int
	required

lowest_throughput_in_bytes_per_second¶

Gets the lowest_throughput_in_bytes_per_second of this AsyncMirrorPrimarySyncStatisticsSample. The lowest recorded throughput (in bytes/second) to the remote array for this mirror during this sample period.

Required/optional:
Returns:	The lowest_throughput_in_bytes_per_second of this AsyncMirrorPrimarySyncStatisticsSample.
Return type:	int
	required

member_state¶

Gets the member_state of this AsyncMirrorPrimarySyncStatisticsSample. Last known state of the mirror member as of the sample end time.

Required/optional:
Returns:	The member_state of this AsyncMirrorPrimarySyncStatisticsSample.
Return type:	str
	required

owner¶

Gets the owner of this AsyncMirrorPrimarySyncStatisticsSample. Owning controller for the duration of this sample.

Required/optional:
Returns:	The owner of this AsyncMirrorPrimarySyncStatisticsSample.
Return type:	str
	required

recovery_point_age_alert_threshold_minutes¶

Gets the recovery_point_age_alert_threshold_minutes of this AsyncMirrorPrimarySyncStatisticsSample. The recovery point age warning threshold as of the sample end time.

Required/optional:
Returns:	The recovery_point_age_alert_threshold_minutes of this AsyncMirrorPrimarySyncStatisticsSample.
Return type:	int
	required

recovery_point_age_minutes¶

Gets the recovery_point_age_minutes of this AsyncMirrorPrimarySyncStatisticsSample. The recovery point age (in minutes) as of the sample end time.

Required/optional:
Returns:	The recovery_point_age_minutes of this AsyncMirrorPrimarySyncStatisticsSample.
Return type:	int
	required

repository_utilization_percentage¶

Gets the repository_utilization_percentage of this AsyncMirrorPrimarySyncStatisticsSample. The repository utilization percentage as of the sample end time (0-100).

Required/optional:
Returns:	The repository_utilization_percentage of this AsyncMirrorPrimarySyncStatisticsSample.
Return type:	int
	required

repository_utilization_warn_threshold¶

Gets the repository_utilization_warn_threshold of this AsyncMirrorPrimarySyncStatisticsSample. The repository utilization warning threshold percentage as of the sample end time.

Required/optional:
Returns:	The repository_utilization_warn_threshold of this AsyncMirrorPrimarySyncStatisticsSample.
Return type:	int
	required

sample_end_time_seconds¶

Gets the sample_end_time_seconds of this AsyncMirrorPrimarySyncStatisticsSample. When this sample ended: synchronization completion time, or time of last update before disruption. Time is expressed in seconds since midnight January 1, 1970 GMT.

Required/optional:
Returns:	The sample_end_time_seconds of this AsyncMirrorPrimarySyncStatisticsSample.
Return type:	int
	required

sample_start_time_seconds¶

Gets the sample_start_time_seconds of this AsyncMirrorPrimarySyncStatisticsSample. When this sample started: > = synchronization start time. Time is expressed in seconds since midnight January 1, 1970 GMT.

Required/optional:
Returns:	The sample_start_time_seconds of this AsyncMirrorPrimarySyncStatisticsSample.
Return type:	int
	required

shortest_response_time_bytes¶

Gets the shortest_response_time_bytes of this AsyncMirrorPrimarySyncStatisticsSample. The number of bytes sent on shortest request.

Required/optional:
Returns:	The shortest_response_time_bytes of this AsyncMirrorPrimarySyncStatisticsSample.
Return type:	int
	required

shortest_response_time_micro_seconds¶

Gets the shortest_response_time_micro_seconds of this AsyncMirrorPrimarySyncStatisticsSample. The shortest response time from the secondary array observed for one request during the time covered by this sample (in microseconds).

Required/optional:
Returns:	The shortest_response_time_micro_seconds of this AsyncMirrorPrimarySyncStatisticsSample.
Return type:	int
	required

sync_completion_time_alert_threshold_minutes¶

Gets the sync_completion_time_alert_threshold_minutes of this AsyncMirrorPrimarySyncStatisticsSample. Configured time allowed for the synchronization as of the sample end time.

Required/optional:
Returns:	The sync_completion_time_alert_threshold_minutes of this AsyncMirrorPrimarySyncStatisticsSample.
Return type:	int
	required

sync_duration_minutes¶

Gets the sync_duration_minutes of this AsyncMirrorPrimarySyncStatisticsSample. Time spent thus far in the synchronization as of the sample end time.

Required/optional:
Returns:	The sync_duration_minutes of this AsyncMirrorPrimarySyncStatisticsSample.
Return type:	int
	required

sync_interval_minutes¶

Gets the sync_interval_minutes of this AsyncMirrorPrimarySyncStatisticsSample. Synchronization interval configured (in minutes), as of the sample end time.

Required/optional:
Returns:	The sync_interval_minutes of this AsyncMirrorPrimarySyncStatisticsSample.
Return type:	int
	required

sync_start_timestamp¶

Gets the sync_start_timestamp of this AsyncMirrorPrimarySyncStatisticsSample. The synchronization start timestamp represented in seconds since midnight GMT on January 1, 1970. This can be used to correlate statistics between the primary and secondary for the same interval (time recorded here is driven from the primary). This can also be used to correlate multiple samples for the same synchronization period.

Required/optional:
Returns:	The sync_start_timestamp of this AsyncMirrorPrimarySyncStatisticsSample.
Return type:	int
	required

sync_type¶

Gets the sync_type of this AsyncMirrorPrimarySyncStatisticsSample. The type of synchronization being performed during this sample period.

Required/optional:
Returns:	The sync_type of this AsyncMirrorPrimarySyncStatisticsSample.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

total_io_count¶

Gets the total_io_count of this AsyncMirrorPrimarySyncStatisticsSample. The total count of I/O requests to the secondary in this sample.

Required/optional:
Returns:	The total_io_count of this AsyncMirrorPrimarySyncStatisticsSample.
Return type:	int
	required

netapp.santricity.models.symbol.async_mirror_repository_utilization module¶

AsyncMirrorRepositoryUtilization.py

class netapp.santricity.models.symbol.async_mirror_repository_utilization.AsyncMirrorRepositoryUtilization[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

bytes_available¶

Gets the bytes_available of this AsyncMirrorRepositoryUtilization. The total number of bytes available for ongoing copy-on-write operations.

Required/optional:
Returns:	The bytes_available of this AsyncMirrorRepositoryUtilization.
Return type:	int
	required

delta_log_bytes¶

Gets the delta_log_bytes of this AsyncMirrorRepositoryUtilization. The total number of bytes used for the delta logs (bitmaps).

Required/optional:
Returns:	The delta_log_bytes of this AsyncMirrorRepositoryUtilization.
Return type:	int
	required

id¶

Gets the id of this AsyncMirrorRepositoryUtilization.

Required/optional:
Returns:	The id of this AsyncMirrorRepositoryUtilization.
Return type:	str
	optional

mirror_ref¶

Gets the mirror_ref of this AsyncMirrorRepositoryUtilization. The mirror group member for which this utilization information applies.

Required/optional:
Returns:	The mirror_ref of this AsyncMirrorRepositoryUtilization.
Return type:	str
	required

pit_data_bytes¶

Gets the pit_data_bytes of this AsyncMirrorRepositoryUtilization. The total number of bytes used in the repository for copy-on-write data and related metadata.

Required/optional:
Returns:	The pit_data_bytes of this AsyncMirrorRepositoryUtilization.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_repository_utilization_list module¶

AsyncMirrorRepositoryUtilizationList.py

class netapp.santricity.models.symbol.async_mirror_repository_utilization_list.AsyncMirrorRepositoryUtilizationList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

repository_utilization¶

Gets the repository_utilization of this AsyncMirrorRepositoryUtilizationList. A variable-length array of AsyncMirrorRepositoryUtilization objects.

Required/optional:
Returns:	The repository_utilization of this AsyncMirrorRepositoryUtilizationList.
Return type:	list[AsyncMirrorRepositoryUtilization]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_repository_utilization_list_returned module¶

AsyncMirrorRepositoryUtilizationListReturned.py

class netapp.santricity.models.symbol.async_mirror_repository_utilization_list_returned.AsyncMirrorRepositoryUtilizationListReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

return_code¶

Gets the return_code of this AsyncMirrorRepositoryUtilizationListReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this AsyncMirrorRepositoryUtilizationListReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

utilization¶

Gets the utilization of this AsyncMirrorRepositoryUtilizationListReturned. This field is present only if the value of returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The utilization of this AsyncMirrorRepositoryUtilizationListReturned.
Return type:	AsyncMirrorRepositoryUtilizationList
	optional

netapp.santricity.models.symbol.async_mirror_sync_completion_detail module¶

AsyncMirrorSyncCompletionDetail.py

class netapp.santricity.models.symbol.async_mirror_sync_completion_detail.AsyncMirrorSyncCompletionDetail[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

completion_type¶

Gets the completion_type of this AsyncMirrorSyncCompletionDetail. This enumeration is used to describe whether synchronization completed or failed during a specific synchronization sample period.

Required/optional:
Returns:	The completion_type of this AsyncMirrorSyncCompletionDetail.
Return type:	str
	required

termination_reason¶

Gets the termination_reason of this AsyncMirrorSyncCompletionDetail. This field is returned if the value of completionType is equal to ASYNC_MIRROR_SYNC_COMPLETION_TERMINATED.

Required/optional:
Returns:	The termination_reason of this AsyncMirrorSyncCompletionDetail.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_sync_statistics module¶

AsyncMirrorSyncStatistics.py

class netapp.santricity.models.symbol.async_mirror_sync_statistics.AsyncMirrorSyncStatistics[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

member_ref¶

Gets the member_ref of this AsyncMirrorSyncStatistics. The mirror group member for which these statistics apply.

Required/optional:
Returns:	The member_ref of this AsyncMirrorSyncStatistics.
Return type:	str
	required

sync_statistics_samples¶

Gets the sync_statistics_samples of this AsyncMirrorSyncStatistics. Statistics samples for this mirror pair (AsyncMirrorGroupMember).

Required/optional:
Returns:	The sync_statistics_samples of this AsyncMirrorSyncStatistics.
Return type:	list[AsyncMirrorSyncStatisticsSample]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_sync_statistics_list module¶

AsyncMirrorSyncStatisticsList.py

class netapp.santricity.models.symbol.async_mirror_sync_statistics_list.AsyncMirrorSyncStatisticsList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

sync_stats¶

Gets the sync_stats of this AsyncMirrorSyncStatisticsList. A list of AsyncMirrorSyncStatistics structures.

Required/optional:
Returns:	The sync_stats of this AsyncMirrorSyncStatisticsList.
Return type:	list[AsyncMirrorSyncStatistics]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_sync_statistics_list_returned module¶

AsyncMirrorSyncStatisticsListReturned.py

class netapp.santricity.models.symbol.async_mirror_sync_statistics_list_returned.AsyncMirrorSyncStatisticsListReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

return_code¶

Gets the return_code of this AsyncMirrorSyncStatisticsListReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this AsyncMirrorSyncStatisticsListReturned.
Return type:	str
	required

sync_stats¶

Gets the sync_stats of this AsyncMirrorSyncStatisticsListReturned. This field is returned if the value of returnCode is RETCODE_OK.

Required/optional:
Returns:	The sync_stats of this AsyncMirrorSyncStatisticsListReturned.
Return type:	AsyncMirrorSyncStatisticsList
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_sync_statistics_request_descriptor module¶

AsyncMirrorSyncStatisticsRequestDescriptor.py

class netapp.santricity.models.symbol.async_mirror_sync_statistics_request_descriptor.AsyncMirrorSyncStatisticsRequestDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

member_list¶

Gets the member_list of this AsyncMirrorSyncStatisticsRequestDescriptor. Members for which statistics should be returned.

Required/optional:
Returns:	The member_list of this AsyncMirrorSyncStatisticsRequestDescriptor.
Return type:	AsyncMirrorGroupMemberRefList
	required

sample_limit¶

Gets the sample_limit of this AsyncMirrorSyncStatisticsRequestDescriptor. Return statistics for the number of samples specified in this limit.

Required/optional:
Returns:	The sample_limit of this AsyncMirrorSyncStatisticsRequestDescriptor.
Return type:	int
	required

stats_request_type¶

Gets the stats_request_type of this AsyncMirrorSyncStatisticsRequestDescriptor. Request type: most recent, longest, errors.

Required/optional:
Returns:	The stats_request_type of this AsyncMirrorSyncStatisticsRequestDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_sync_statistics_reset_descriptor module¶

AsyncMirrorSyncStatisticsResetDescriptor.py

class netapp.santricity.models.symbol.async_mirror_sync_statistics_reset_descriptor.AsyncMirrorSyncStatisticsResetDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

member_list¶

Gets the member_list of this AsyncMirrorSyncStatisticsResetDescriptor. Members for which statistics should be reset.

Required/optional:
Returns:	The member_list of this AsyncMirrorSyncStatisticsResetDescriptor.
Return type:	AsyncMirrorGroupMemberRefList
	required

stats_request_type¶

Gets the stats_request_type of this AsyncMirrorSyncStatisticsResetDescriptor. Request type: most recent, longest, errors.

Required/optional:
Returns:	The stats_request_type of this AsyncMirrorSyncStatisticsResetDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.async_mirror_sync_statistics_sample module¶

AsyncMirrorSyncStatisticsSample.py

class netapp.santricity.models.symbol.async_mirror_sync_statistics_sample.AsyncMirrorSyncStatisticsSample[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

primary_sample¶

Gets the primary_sample of this AsyncMirrorSyncStatisticsSample. This field is returned if the value of sampleRole is equal to ASYNC_MIRROR_GROUP_ROLE_PRIMARY.

Required/optional:
Returns:	The primary_sample of this AsyncMirrorSyncStatisticsSample.
Return type:	AsyncMirrorPrimarySyncStatisticsSample
	optional

sample_role¶

Gets the sample_role of this AsyncMirrorSyncStatisticsSample. This enumeration is used to indicate mirror group roles.

Required/optional:
Returns:	The sample_role of this AsyncMirrorSyncStatisticsSample.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.auth_method_type_data module¶

AuthMethodTypeData.py

class netapp.santricity.models.symbol.auth_method_type_data.AuthMethodTypeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

auth_method¶

Gets the auth_method of this AuthMethodTypeData. This enumeration type identifies the available iSCSIauthentication methods. The supportedAuthMethods array in the FeatureParams structure will contain values from this enumeration identifying which iSCSI authentication methods are supported on the storage array.

Required/optional:
Returns:	The auth_method of this AuthMethodTypeData.
Return type:	str
	required

chap_secret¶

Gets the chap_secret of this AuthMethodTypeData. This field is present only if the authentication method is AUTH_METHOD_CHAP. If the field length indicator is zero, there is no associated secret; otherwise there is a secret and it may or may not be specified, depending on the usage context for this data type. If the client is using this structure to set a secret, the length indicator should be one and the secret should be filled in; if the client is using this structure to set an authentication method with no secret, the length indicator should be zero. If the array is reporting this data, it sets the length indicator according to whether or not there is a secret. (The actual secret is never reported by the array; instead it uses the ENCRYPT_UNSPECIFIED case of EncryptedPassword.) Finally, because CHAP secrets are, by definition, limited to the ASCII character set, the clear text submitted for encryption must be ASCII, not Unicode.

Required/optional:
Returns:	The chap_secret of this AuthMethodTypeData.
Return type:	list[EncryptedPassword]
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.authentication_bundle module¶

AuthenticationBundle.py

class netapp.santricity.models.symbol.authentication_bundle.AuthenticationBundle[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

auth_method_data¶

Gets the auth_method_data of this AuthenticationBundle. A variable-length array containing authentication methods and any associated data.

Required/optional:
Returns:	The auth_method_data of this AuthenticationBundle.
Return type:	list[AuthMethodTypeData]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.auto_config_candidate module¶

AutoConfigCandidate.py

class netapp.santricity.models.symbol.auto_config_candidate.AutoConfigCandidate[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

auto_config_summary¶

Gets the auto_config_summary of this AutoConfigCandidate. The resulting configuration summary.

Required/optional:
Returns:	The auto_config_summary of this AutoConfigCandidate.
Return type:	AutoConfigSummary
	required

auto_config_template¶

Gets the auto_config_template of this AutoConfigCandidate. The automatic configuration template.

Required/optional:
Returns:	The auto_config_template of this AutoConfigCandidate.
Return type:	AutoConfigTemplate
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.auto_config_candidate_list module¶

AutoConfigCandidateList.py

class netapp.santricity.models.symbol.auto_config_candidate_list.AutoConfigCandidateList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

auto_config_candidate¶

Gets the auto_config_candidate of this AutoConfigCandidateList. The automatic configuration candidate.

Required/optional:
Returns:	The auto_config_candidate of this AutoConfigCandidateList.
Return type:	list[AutoConfigCandidate]
	required

return_code¶

Gets the return_code of this AutoConfigCandidateList. The return code from the getAutoConfigCandidates API.

Required/optional:
Returns:	The return_code of this AutoConfigCandidateList.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.auto_config_summary module¶

AutoConfigSummary.py

class netapp.santricity.models.symbol.auto_config_summary.AutoConfigSummary[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

hot_spare_count¶

Gets the hot_spare_count of this AutoConfigSummary. The total number of hot spares.

Required/optional:
Returns:	The hot_spare_count of this AutoConfigSummary.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

total_volume_groups¶

Gets the total_volume_groups of this AutoConfigSummary. The total number of volume groups.

Required/optional:
Returns:	The total_volume_groups of this AutoConfigSummary.
Return type:	int
	required

unassigned_count¶

Gets the unassigned_count of this AutoConfigSummary. The total number of unassigned drives.

Required/optional:
Returns:	The unassigned_count of this AutoConfigSummary.
Return type:	int
	required

volume_group_summary¶

Gets the volume_group_summary of this AutoConfigSummary. The list of volume groups.

Required/optional:
Returns:	The volume_group_summary of this AutoConfigSummary.
Return type:	list[VolumeGroupSummary]
	required

netapp.santricity.models.symbol.auto_config_template module¶

AutoConfigTemplate.py

class netapp.santricity.models.symbol.auto_config_template.AutoConfigTemplate[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_media_type¶

Gets the drive_media_type of this AutoConfigTemplate. This field is set to the desired drive media type of the drive.

Required/optional:
Returns:	The drive_media_type of this AutoConfigTemplate.
Return type:	str
	required

number_hot_spares¶

Gets the number_hot_spares of this AutoConfigTemplate. The number of hot spares to assign.

Required/optional:
Returns:	The number_hot_spares of this AutoConfigTemplate.
Return type:	int
	required

number_unassigned_drives¶

Gets the number_unassigned_drives of this AutoConfigTemplate. The number of drives to leave unassigned.

Required/optional:
Returns:	The number_unassigned_drives of this AutoConfigTemplate.
Return type:	int
	required

only_protection_information_capable¶

Gets the only_protection_information_capable of this AutoConfigTemplate. If this field is set to true, only PI capable drives will be considered for volume candidates, otherwise both PI capable and non-PI capable drives will be considered.

Required/optional:
Returns:	The only_protection_information_capable of this AutoConfigTemplate.
Return type:	bool
	required

phy_drive_type¶

Gets the phy_drive_type of this AutoConfigTemplate. The physical drive type.

Required/optional:
Returns:	The phy_drive_type of this AutoConfigTemplate.
Return type:	str
	required

raid_level¶

Gets the raid_level of this AutoConfigTemplate. The RAID level of all the potential volumes.

Required/optional:
Returns:	The raid_level of this AutoConfigTemplate.
Return type:	str
	required

read_ahead¶

Gets the read_ahead of this AutoConfigTemplate. A true (non-zero) / false (zero) indicator of whether or not automatic cache read-ahead is enabled.

Required/optional:
Returns:	The read_ahead of this AutoConfigTemplate.
Return type:	int
	required

segment_size¶

Gets the segment_size of this AutoConfigTemplate. The segment size for all volumes.

Required/optional:
Returns:	The segment_size of this AutoConfigTemplate.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_group_security_level¶

Gets the volume_group_security_level of this AutoConfigTemplate. Refines the information in the securityType field to describe the set of drives.

Required/optional:
Returns:	The volume_group_security_level of this AutoConfigTemplate.
Return type:	str
	required

volume_group_security_type¶

Gets the volume_group_security_type of this AutoConfigTemplate. This field is used to specify the volume group security type.

Required/optional:
Returns:	The volume_group_security_type of this AutoConfigTemplate.
Return type:	str
	required

volume_group_width¶

Gets the volume_group_width of this AutoConfigTemplate. The width of the volume group in drives.

Required/optional:
Returns:	The volume_group_width of this AutoConfigTemplate.
Return type:	int
	required

volumes_per_group¶

Gets the volumes_per_group of this AutoConfigTemplate. The number of volumes per volume group.

Required/optional:
Returns:	The volumes_per_group of this AutoConfigTemplate.
Return type:	int
	required

netapp.santricity.models.symbol.auto_config_template_list module¶

AutoConfigTemplateList.py

class netapp.santricity.models.symbol.auto_config_template_list.AutoConfigTemplateList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

auto_config_template¶

Gets the auto_config_template of this AutoConfigTemplateList. A list of automatic configuration templates.

Required/optional:
Returns:	The auto_config_template of this AutoConfigTemplateList.
Return type:	list[AutoConfigTemplate]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.auto_load_balance_request_descriptor module¶

AutoLoadBalanceRequestDescriptor.py

class netapp.santricity.models.symbol.auto_load_balance_request_descriptor.AutoLoadBalanceRequestDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

action¶

Gets the action of this AutoLoadBalanceRequestDescriptor. This enumeration identifies an auto load balance action being requested by the client.

Required/optional:
Returns:	The action of this AutoLoadBalanceRequestDescriptor.
Return type:	str
	required

delay_seconds¶

Gets the delay_seconds of this AutoLoadBalanceRequestDescriptor. Amount of time to delay before performing load balance operation.

Required/optional:
Returns:	The delay_seconds of this AutoLoadBalanceRequestDescriptor.
Return type:	int
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.auto_load_balance_stats_log_retrieve_chunk_details module¶

AutoLoadBalanceStatsLogRetrieveChunkDetails.py

class netapp.santricity.models.symbol.auto_load_balance_stats_log_retrieve_chunk_details.AutoLoadBalanceStatsLogRetrieveChunkDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

auto_load_balance_stats_log_data¶

Gets the auto_load_balance_stats_log_data of this AutoLoadBalanceStatsLogRetrieveChunkDetails. Statistics log raw data to be returned.

Required/optional:
Returns:	The auto_load_balance_stats_log_data of this AutoLoadBalanceStatsLogRetrieveChunkDetails.
Return type:	str
	required

data_start_time¶

Gets the data_start_time of this AutoLoadBalanceStatsLogRetrieveChunkDetails. Start time of the log statistics being returned in seconds since midnight 1/1/1970.

Required/optional:
Returns:	The data_start_time of this AutoLoadBalanceStatsLogRetrieveChunkDetails.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.auto_load_balance_stats_log_retrieve_start_details module¶

AutoLoadBalanceStatsLogRetrieveStartDetails.py

class netapp.santricity.models.symbol.auto_load_balance_stats_log_retrieve_start_details.AutoLoadBalanceStatsLogRetrieveStartDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

data_type¶

Gets the data_type of this AutoLoadBalanceStatsLogRetrieveStartDetails. Type of Auto Load Balance stats log data to retrieve.

Required/optional:
Returns:	The data_type of this AutoLoadBalanceStatsLogRetrieveStartDetails.
Return type:	str
	required

log_start_time¶

Gets the log_start_time of this AutoLoadBalanceStatsLogRetrieveStartDetails. Earliest time (in seconds since midnight 1/1/1970) for which data is to be retrieved.

Required/optional:
Returns:	The log_start_time of this AutoLoadBalanceStatsLogRetrieveStartDetails.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.auto_load_balancing_control_descriptor module¶

AutoLoadBalancingControlDescriptor.py

class netapp.santricity.models.symbol.auto_load_balancing_control_descriptor.AutoLoadBalancingControlDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

enable_auto_load_balancing¶

Gets the enable_auto_load_balancing of this AutoLoadBalancingControlDescriptor. Enable or disable auto load balancing on this array

Required/optional:
Returns:	The enable_auto_load_balancing of this AutoLoadBalancingControlDescriptor.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.battery module¶

Battery.py

class netapp.santricity.models.symbol.battery.Battery[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

automatic_age_reset¶

Gets the automatic_age_reset of this Battery. This boolean field is set to true when the batteryCanExpire field in this structure is set to false and when the controller tracks the battery serial number.

Required/optional:
Returns:	The automatic_age_reset of this Battery.
Return type:	bool
	required

battery_age¶

Gets the battery_age of this Battery. Current battery age, in days.

Required/optional:
Returns:	The battery_age of this Battery.
Return type:	int
	required

battery_can_expire¶

Gets the battery_can_expire of this Battery. This boolean field is set to true when cache battery expired event notification is enabled.

Required/optional:
Returns:	The battery_can_expire of this Battery.
Return type:	bool
	required

battery_life_remaining¶

Gets the battery_life_remaining of this Battery. Days of battery life remaining. A value of -1 indicates that the battery life expiration age has been set to 0xFF in NVSRAM, disabling cache battery expiration event notification.

Required/optional:
Returns:	The battery_life_remaining of this Battery.
Return type:	int
	required

battery_ref¶

Gets the battery_ref of this Battery. The reference for this battery.

Required/optional:
Returns:	The battery_ref of this Battery.
Return type:	str
	required

battery_type_data¶

Gets the battery_type_data of this Battery. Used to determine the scope of the battery.

Required/optional:
Returns:	The battery_type_data of this Battery.
Return type:	BatteryTypeData
	required

fru_type¶

Gets the fru_type of this Battery. VPD field replaceable unit type.

Required/optional:
Returns:	The fru_type of this Battery.
Return type:	str
	required

id¶

Gets the id of this Battery.

Required/optional:
Returns:	The id of this Battery.
Return type:	str
	optional

learn_cycle_data¶

Gets the learn_cycle_data of this Battery. Contains details about the learn cycle for this battery

Required/optional:
Returns:	The learn_cycle_data of this Battery.
Return type:	SmartBatteryData
	required

manufacturer_date¶

Gets the manufacturer_date of this Battery. VPD manufacture date.

Required/optional:
Returns:	The manufacturer_date of this Battery.
Return type:	int
	required

physical_location¶

Gets the physical_location of this Battery. The physical location of the battery. The parent reference in Location identifies the CRU that physically houses the battery, and the position field is the parent-relative/like-component relative slot number of the battery, starting at one.

Required/optional:
Returns:	The physical_location of this Battery.
Return type:	Location
	required

repair_policy¶

Gets the repair_policy of this Battery. The repair policy for the battery component.

Required/optional:
Returns:	The repair_policy of this Battery.
Return type:	RepairPolicy
	required

reserved1¶

Gets the reserved1 of this Battery.

Required/optional:
Returns:	The reserved1 of this Battery.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this Battery.

Required/optional:
Returns:	The reserved2 of this Battery.
Return type:	str
	optional

rtr_attributes¶

Gets the rtr_attributes of this Battery. The CRU type of the battery plus its ready-to-remove attributes, which are based on the CRU type.

Required/optional:
Returns:	The rtr_attributes of this Battery.
Return type:	RTRAttributes
	required

status¶

Gets the status of this Battery. The operational status of the battery.

Required/optional:
Returns:	The status of this Battery.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

vendor_name¶

Gets the vendor_name of this Battery. VPD vendor name.

Required/optional:
Returns:	The vendor_name of this Battery.
Return type:	str
	required

vendor_pn¶

Gets the vendor_pn of this Battery. VPD part number.

Required/optional:
Returns:	The vendor_pn of this Battery.
Return type:	str
	required

vendor_sn¶

Gets the vendor_sn of this Battery. VPD serial number.

Required/optional:
Returns:	The vendor_sn of this Battery.
Return type:	str
	required

netapp.santricity.models.symbol.battery_pack_icc_failure module¶

BatteryPackICCFailure.py

class netapp.santricity.models.symbol.battery_pack_icc_failure.BatteryPackICCFailure[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

battery_pack_ref¶

Gets the battery_pack_ref of this BatteryPackICCFailure. This field is present for all battery pack failures except for a voltage regulator or charger failure. This field contains a reference to the battery pack that has failed.

Required/optional:
Returns:	The battery_pack_ref of this BatteryPackICCFailure.
Return type:	str
	required

controller_a_ref¶

Gets the controller_a_ref of this BatteryPackICCFailure. This field is present when the voltage regulator has failed in the battery pack associated with controller A.

Required/optional:
Returns:	The controller_a_ref of this BatteryPackICCFailure.
Return type:	str
	required

controller_b_ref¶

Gets the controller_b_ref of this BatteryPackICCFailure. This field is present when the voltage regulator has failed in the battery pack associated with controller B.

Required/optional:
Returns:	The controller_b_ref of this BatteryPackICCFailure.
Return type:	str
	required

support_crua_ref¶

Gets the support_crua_ref of this BatteryPackICCFailure. This field is present when the charger has failed in the battery pack associated with support CRU A.

Required/optional:
Returns:	The support_crua_ref of this BatteryPackICCFailure.
Return type:	str
	required

support_crub_ref¶

Gets the support_crub_ref of this BatteryPackICCFailure. This field is present when the charger has failed in the battery pack associated with support CRU B.

Required/optional:
Returns:	The support_crub_ref of this BatteryPackICCFailure.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.battery_params_update_descriptor module¶

BatteryParamsUpdateDescriptor.py

class netapp.santricity.models.symbol.battery_params_update_descriptor.BatteryParamsUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

component¶

Gets the component of this BatteryParamsUpdateDescriptor. Identifies the appropriate battery.

Required/optional:
Returns:	The component of this BatteryParamsUpdateDescriptor.
Return type:	str
	required

next_learn_cycle_time¶

Gets the next_learn_cycle_time of this BatteryParamsUpdateDescriptor. The new value to apply for the nextLearnCycleTime property in the BatteryParamsUpdateDescriptor structure. This value is expressed as seconds since midnight GMT, January 1, 1970. This field is only applicable if the smartBatteryTechnology Boolean in FeatureParams is set to true. The array will return an error if an attempt is made to set this time more than seven days later than the current scheduled time.

Required/optional:
Returns:	The next_learn_cycle_time of this BatteryParamsUpdateDescriptor.
Return type:	list[int]
	required

reset_battery_age¶

Gets the reset_battery_age of this BatteryParamsUpdateDescriptor. Resets the age of the specified cache battery

Required/optional:
Returns:	The reset_battery_age of this BatteryParamsUpdateDescriptor.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.battery_type_data module¶

BatteryTypeData.py

class netapp.santricity.models.symbol.battery_type_data.BatteryTypeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

battery_type¶

Gets the battery_type of this BatteryTypeData. This enumeration object is used to specify the battery configurations present on a controller.

Required/optional:
Returns:	The battery_type of this BatteryTypeData.
Return type:	str
	required

cru_parent_controller¶

Gets the cru_parent_controller of this BatteryTypeData. This field is present only if the batteryType value is equal to BATTERY_TYPE_DUAL_INDIVIDUAL_CRUS. It is a reference to the controller that the battery CRU is associated with.

Required/optional:
Returns:	The cru_parent_controller of this BatteryTypeData.
Return type:	str
	optional

parent_controller¶

Gets the parent_controller of this BatteryTypeData. This field is present only if the batteryType value is equal to BATTERY_TYPE_DUAL_INDIVIDUAL_FRUS. It is a reference to the the controller that the battery FRU is associated with.

Required/optional:
Returns:	The parent_controller of this BatteryTypeData.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.bundle_key module¶

BundleKey.py

class netapp.santricity.models.symbol.bundle_key.BundleKey[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

digest¶

Gets the digest of this BundleKey. A computed message digest that verifies the authenticity of this bundle key.

Required/optional:
Returns:	The digest of this BundleKey.
Return type:	str
	required

key_version¶

Gets the key_version of this BundleKey. An internal indication of the version of the bundle key.

Required/optional:
Returns:	The key_version of this BundleKey.
Return type:	int
	required

sa_id¶

Gets the sa_id of this BundleKey. This field contains a unique identifier maintained by SAFE for use by storage management software. Storage management software uses this data to enable SAFE features and perform Feature Bundle migration.

Required/optional:
Returns:	The sa_id of this BundleKey.
Return type:	SAIdentifier
	required

source_submodel_id¶

Gets the source_submodel_id of this BundleKey. The submodel identifier of current feature bundle.

Required/optional:
Returns:	The source_submodel_id of this BundleKey.
Return type:	str
	required

target_submodel_id¶

Gets the target_submodel_id of this BundleKey. The submodel identifier of feature bundle to migrate to.

Required/optional:
Returns:	The target_submodel_id of this BundleKey.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.bundled_feature module¶

BundledFeature.py

class netapp.santricity.models.symbol.bundled_feature.BundledFeature[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

feature_attribute¶

Gets the feature_attribute of this BundledFeature. This field is a variable-length array of FeatureAttribute instances representing the attributes that apply for this particular feature.

Required/optional:
Returns:	The feature_attribute of this BundledFeature.
Return type:	list[FeatureAttribute]
	required

feature_id¶

Gets the feature_id of this BundledFeature. This field indicate what feature this instance of BundledFeature represents.

Required/optional:
Returns:	The feature_id of this BundledFeature.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.cache_backup_device module¶

CacheBackupDevice.py

class netapp.santricity.models.symbol.cache_backup_device.CacheBackupDevice[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

backup_device_capacity¶

Gets the backup_device_capacity of this CacheBackupDevice. The capacity of backup device, expressed in megabytes.

Required/optional:
Returns:	The backup_device_capacity of this CacheBackupDevice.
Return type:	int
	required

backup_device_controller_slot¶

Gets the backup_device_controller_slot of this CacheBackupDevice. The number of the slot on the controller where the backup device resides. Cache backup device slots are numbered starting at one, independent of other types of slots (e.g., host board slots) on the controller. Note that this field is targeted for deletion in SYMbol rev. 85b.

Required/optional:
Returns:	The backup_device_controller_slot of this CacheBackupDevice.
Return type:	int
	required

backup_device_ref¶

Gets the backup_device_ref of this CacheBackupDevice. The SYMbol reference that identifies the instance of the device

Required/optional:
Returns:	The backup_device_ref of this CacheBackupDevice.
Return type:	str
	required

backup_device_status¶

Gets the backup_device_status of this CacheBackupDevice. The status of the backup device

Required/optional:
Returns:	The backup_device_status of this CacheBackupDevice.
Return type:	str
	required

backup_device_type¶

Gets the backup_device_type of this CacheBackupDevice. The type of the backup device ( e.g., USB flash drive).

Required/optional:
Returns:	The backup_device_type of this CacheBackupDevice.
Return type:	str
	required

backup_device_vpd¶

Gets the backup_device_vpd of this CacheBackupDevice. Vital product data for the backup device.

Required/optional:
Returns:	The backup_device_vpd of this CacheBackupDevice.
Return type:	CacheBackupDeviceVpd
	required

id¶

Gets the id of this CacheBackupDevice.

Required/optional:
Returns:	The id of this CacheBackupDevice.
Return type:	str
	optional

parent_controller¶

Gets the parent_controller of this CacheBackupDevice. A reference to the controller where the backup device resides. Note that this field is targeted for deletion in SYMbol rev. 85b.

Required/optional:
Returns:	The parent_controller of this CacheBackupDevice.
Return type:	str
	required

physical_location¶

Gets the physical_location of this CacheBackupDevice. The physical location of the cache backup device. The parent field of Location is set to the controller where the device physically resides, and the position field is the parent-relative/like-component-relative slot number of the device, starting at one.

Required/optional:
Returns:	The physical_location of this CacheBackupDevice.
Return type:	Location
	required

repair_policy¶

Gets the repair_policy of this CacheBackupDevice. The repair policy for the cache backup device component.

Required/optional:
Returns:	The repair_policy of this CacheBackupDevice.
Return type:	RepairPolicy
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.cache_backup_device_location module¶

CacheBackupDeviceLocation.py

class netapp.santricity.models.symbol.cache_backup_device_location.CacheBackupDeviceLocation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cache_backup_device_slot¶

Gets the cache_backup_device_slot of this CacheBackupDeviceLocation. The number of the slot on the controller in which the cache backup device resides.

Required/optional:
Returns:	The cache_backup_device_slot of this CacheBackupDeviceLocation.
Return type:	int
	required

controller_slot¶

Gets the controller_slot of this CacheBackupDeviceLocation. The slot number of the controller that houses the cache backup device.

Required/optional:
Returns:	The controller_slot of this CacheBackupDeviceLocation.
Return type:	int
	required

controller_tray¶

Gets the controller_tray of this CacheBackupDeviceLocation. The tray ID of the controller that houses the cache backup device.

Required/optional:
Returns:	The controller_tray of this CacheBackupDeviceLocation.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.cache_backup_device_vpd module¶

CacheBackupDeviceVpd.py

class netapp.santricity.models.symbol.cache_backup_device_vpd.CacheBackupDeviceVpd[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

manufacture_date¶

Gets the manufacture_date of this CacheBackupDeviceVpd. The date of manufacture of the device, represented in seconds since midnight GMT on January 1, 1970.

Required/optional:
Returns:	The manufacture_date of this CacheBackupDeviceVpd.
Return type:	int
	required

manufacturer¶

Gets the manufacturer of this CacheBackupDeviceVpd. The variable-length ASCII text string that identifies the device manufacturer..

Required/optional:
Returns:	The manufacturer of this CacheBackupDeviceVpd.
Return type:	str
	required

part_number¶

Gets the part_number of this CacheBackupDeviceVpd. The variable-length ASCII text string that identifies the device part number.

Required/optional:
Returns:	The part_number of this CacheBackupDeviceVpd.
Return type:	str
	required

product_id¶

Gets the product_id of this CacheBackupDeviceVpd. The variable-length ASCII text string that identifies the device by name.

Required/optional:
Returns:	The product_id of this CacheBackupDeviceVpd.
Return type:	str
	required

product_rev_level¶

Gets the product_rev_level of this CacheBackupDeviceVpd. The variable-length ASCII text string that identifies the device revision level.

Required/optional:
Returns:	The product_rev_level of this CacheBackupDeviceVpd.
Return type:	str
	required

serial_number¶

Gets the serial_number of this CacheBackupDeviceVpd. The variable-length ASCII text string that identifies the device serial number.

Required/optional:
Returns:	The serial_number of this CacheBackupDeviceVpd.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.cache_memory_dimm module¶

CacheMemoryDimm.py

class netapp.santricity.models.symbol.cache_memory_dimm.CacheMemoryDimm[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cache_memory_dimm_ref¶

Gets the cache_memory_dimm_ref of this CacheMemoryDimm. The SYMbol reference value that uniquely identifies an instance of a cache memory DIMM object.

Required/optional:
Returns:	The cache_memory_dimm_ref of this CacheMemoryDimm.
Return type:	str
	required

capacity_in_megabytes¶

Gets the capacity_in_megabytes of this CacheMemoryDimm. The capacity of the DIMM expressed in megabytes.

Required/optional:
Returns:	The capacity_in_megabytes of this CacheMemoryDimm.
Return type:	int
	required

manufacture_date¶

Gets the manufacture_date of this CacheMemoryDimm. The manufacture date of the DIMM

Required/optional:
Returns:	The manufacture_date of this CacheMemoryDimm.
Return type:	int
	required

manufacturer¶

Gets the manufacturer of this CacheMemoryDimm. The manufacturer part number of the DIMM.

Required/optional:
Returns:	The manufacturer of this CacheMemoryDimm.
Return type:	str
	required

manufacturer_part_number¶

Gets the manufacturer_part_number of this CacheMemoryDimm. The manufacturer part number of the DIMM.

Required/optional:
Returns:	The manufacturer_part_number of this CacheMemoryDimm.
Return type:	str
	required

oem_part_number¶

Gets the oem_part_number of this CacheMemoryDimm. The OEM part number of the DIMM.

Required/optional:
Returns:	The oem_part_number of this CacheMemoryDimm.
Return type:	str
	required

part_number¶

Gets the part_number of this CacheMemoryDimm. The LSI Logic part number of the DIMM.

Required/optional:
Returns:	The part_number of this CacheMemoryDimm.
Return type:	str
	required

physical_location¶

Gets the physical_location of this CacheMemoryDimm. The physical location of the cache memory DIMM. The parent reference in Location identifies the controller where the DIMM physically resides, and the position field is the parent-relative/like-component relative slot number of the DIMM, starting at 1.

Required/optional:
Returns:	The physical_location of this CacheMemoryDimm.
Return type:	Location
	required

repair_policy¶

Gets the repair_policy of this CacheMemoryDimm. The repair policy for the cache memory DIMM component.

Required/optional:
Returns:	The repair_policy of this CacheMemoryDimm.
Return type:	RepairPolicy
	required

revision_code¶

Gets the revision_code of this CacheMemoryDimm. The module revision code of the DIMM.

Required/optional:
Returns:	The revision_code of this CacheMemoryDimm.
Return type:	str
	required

serial_number¶

Gets the serial_number of this CacheMemoryDimm. The serial number of the DIMM.

Required/optional:
Returns:	The serial_number of this CacheMemoryDimm.
Return type:	str
	required

shared¶

Gets the shared of this CacheMemoryDimm. This field is set to true if the DIMM is shared between processor and cache. It is set to false if the DIMM is dedicated to the cache.

Required/optional:
Returns:	The shared of this CacheMemoryDimm.
Return type:	bool
	required

status¶

Gets the status of this CacheMemoryDimm. The operational status of the DIMM.

Required/optional:
Returns:	The status of this CacheMemoryDimm.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.cache_memory_dimm_location module¶

CacheMemoryDimmLocation.py

class netapp.santricity.models.symbol.cache_memory_dimm_location.CacheMemoryDimmLocation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cache_memory_dimm_controller_slot¶

Gets the cache_memory_dimm_controller_slot of this CacheMemoryDimmLocation. The number of the slot on the controller where the cache memory DIMM is installed. Cache memory DIMM slots are numbered starting at one, independent of other types of slots (e.g., cache backup device slots) on the controller.

Required/optional:
Returns:	The cache_memory_dimm_controller_slot of this CacheMemoryDimmLocation.
Return type:	int
	required

controller_slot¶

Gets the controller_slot of this CacheMemoryDimmLocation. The slot number of the controller where the DIMM is installed.

Required/optional:
Returns:	The controller_slot of this CacheMemoryDimmLocation.
Return type:	int
	required

controller_tray¶

Gets the controller_tray of this CacheMemoryDimmLocation. The tray ID of the controller where the DIMM is installed.

Required/optional:
Returns:	The controller_tray of this CacheMemoryDimmLocation.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.candidate_selection_type_data module¶

CandidateSelectionTypeData.py

class netapp.santricity.models.symbol.candidate_selection_type_data.CandidateSelectionTypeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

candidate_selection_type¶

Gets the candidate_selection_type of this CandidateSelectionTypeData. This enumeration object is used to specify the type of volume candidate that the client wishes to obtain in a getVolumeCandidates procedure call.

Required/optional:
Returns:	The candidate_selection_type of this CandidateSelectionTypeData.
Return type:	str
	required

drive_ref_list¶

Gets the drive_ref_list of this CandidateSelectionTypeData. This field is present only if the candidateSelectionType value is equal to CANDIDATE_SEL_MANUAL. It contains the reference values for the drives on which a new volume group (and volume) are to be created.

Required/optional:
Returns:	The drive_ref_list of this CandidateSelectionTypeData.
Return type:	DriveRefList
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.change_query_descriptor module¶

ChangeQueryDescriptor.py

class netapp.santricity.models.symbol.change_query_descriptor.ChangeQueryDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

last_known¶

Gets the last_known of this ChangeQueryDescriptor. The ChangeState object represents the client’s last known values of the configuration state of the array. The controller uses this information to determine if the client needs to be informed immediately of a change in state.

Required/optional:
Returns:	The last_known of this ChangeQueryDescriptor.
Return type:	ChangeState
	required

max_wait¶

Gets the max_wait of this ChangeQueryDescriptor. The maximum amount of time (in seconds) the controller can hold the request before responding to the client.

Required/optional:
Returns:	The max_wait of this ChangeQueryDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.change_state module¶

ChangeState.py

class netapp.santricity.models.symbol.change_state.ChangeState[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

config_generation¶

Gets the config_generation of this ChangeState. The configuration generation number associated with the storage array’s current state and configuration.

Required/optional:
Returns:	The config_generation of this ChangeState.
Return type:	int
	required

last_critical_mel_seq_number¶

Gets the last_critical_mel_seq_number of this ChangeState. The sequence number of the most recent MEL entry that was tagged as critical.

Required/optional:
Returns:	The last_critical_mel_seq_number of this ChangeState.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.channel_degraded_failure module¶

ChannelDegradedFailure.py

class netapp.santricity.models.symbol.channel_degraded_failure.ChannelDegradedFailure[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

degraded_channels¶

Gets the degraded_channels of this ChannelDegradedFailure. The degraded channels.

Required/optional:
Returns:	The degraded_channels of this ChannelDegradedFailure.
Return type:	list[int]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.channel_diag_data_pattern_type_data module¶

ChannelDiagDataPatternTypeData.py

class netapp.santricity.models.symbol.channel_diag_data_pattern_type_data.ChannelDiagDataPatternTypeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

pattern¶

Gets the pattern of this ChannelDiagDataPatternTypeData. A four-byte user-supplied data pattern. This field is valid only if type is equal to CHANNEL_DIAG_DATA_PATTERN_FIXED.

Required/optional:
Returns:	The pattern of this ChannelDiagDataPatternTypeData.
Return type:	int
	optional

random_number_seed¶

Gets the random_number_seed of this ChannelDiagDataPatternTypeData. A 32-bit value that is used as the seed for a pseudo-random sequence that is used to establish the data pattern. This field is valid only if type is equal to CHANNEL_DIAG_DATA_PATTERN_RANDOM.

Required/optional:
Returns:	The random_number_seed of this ChannelDiagDataPatternTypeData.
Return type:	int
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this ChannelDiagDataPatternTypeData. This enumeration data type identifies the types of data patterns that may be used in running the drive channel fault isolation diagnostics.

Required/optional:
Returns:	The type of this ChannelDiagDataPatternTypeData.
Return type:	str
	required

netapp.santricity.models.symbol.channel_diag_device module¶

ChannelDiagDevice.py

class netapp.santricity.models.symbol.channel_diag_device.ChannelDiagDevice[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller¶

Gets the controller of this ChannelDiagDevice. A reference to an instance of a Controller. This field is only valid if deviceType is equal to CHANNEL_DIAG_DEVICE_CONTROLLER.

Required/optional:
Returns:	The controller of this ChannelDiagDevice.
Return type:	str
	optional

device_type¶

Gets the device_type of this ChannelDiagDevice. This enumeration type identifies the types of channel devices on which drive channel fault isolation diagnostics can be run.

Required/optional:
Returns:	The device_type of this ChannelDiagDevice.
Return type:	str
	required

drive¶

Gets the drive of this ChannelDiagDevice. A reference to an instance of a Drive. This field is only valid if deviceType is equal to CHANNEL_DIAG_DEVICE_DRIVE.

Required/optional:
Returns:	The drive of this ChannelDiagDevice.
Return type:	str
	optional

esm¶

Gets the esm of this ChannelDiagDevice. A reference to an instance of an Esm. This field is only valid if deviceType is equal to CHANNEL_DIAG_DEVICE_ESM.

Required/optional:
Returns:	The esm of this ChannelDiagDevice.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.channel_diag_fc_dependent_results module¶

ChannelDiagFcDependentResults.py

class netapp.santricity.models.symbol.channel_diag_fc_dependent_results.ChannelDiagFcDependentResults[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

rls_data¶

Gets the rls_data of this ChannelDiagFcDependentResults. An array of fibre Channel Read Link Status data for the channel under test. Each element in the array represents a Fibre Channel device for which data is being reported. All fields within rlsData are set to meaningful values except the baselineTime field which is set to zero.

Required/optional:
Returns:	The rls_data of this ChannelDiagFcDependentResults.
Return type:	list[RLSData]
	required

soc_data¶

Gets the soc_data of this ChannelDiagFcDependentResults. An array of SOC diagnostic data for the channel under test. Each element of the array represents a SOC chip for which data is being reported. Within each element, port diagnostic data is included for just the ports on the channel under test. All fields of socData and its sub-structures are set to meaningful data except for collectionElapsedTime in SocDeviceData, which is set to zero.

Required/optional:
Returns:	The soc_data of this ChannelDiagFcDependentResults.
Return type:	list[SocData]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.channel_diag_interface_dep_results module¶

ChannelDiagInterfaceDepResults.py

class netapp.santricity.models.symbol.channel_diag_interface_dep_results.ChannelDiagInterfaceDepResults[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

fc_results¶

Gets the fc_results of this ChannelDiagInterfaceDepResults. A set of Fibre-Channel-specific drive channel diagnostic results. This field is present only if interfaceType is set to IO_IF_FC.

Required/optional:
Returns:	The fc_results of this ChannelDiagInterfaceDepResults.
Return type:	ChannelDiagFcDependentResults
	optional

interface_type¶

Gets the interface_type of this ChannelDiagInterfaceDepResults. This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller.

Required/optional:
Returns:	The interface_type of this ChannelDiagInterfaceDepResults.
Return type:	str
	required

sas_results¶

Gets the sas_results of this ChannelDiagInterfaceDepResults. A set of SAS-specific drive channel diagnostic results. This field is present only if interfaceType is set to IO_IF_SAS.

Required/optional:
Returns:	The sas_results of this ChannelDiagInterfaceDepResults.
Return type:	ChannelDiagSasDependentResults
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.channel_diag_results module¶

ChannelDiagResults.py

class netapp.santricity.models.symbol.channel_diag_results.ChannelDiagResults[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this ChannelDiagResults. This enumeration identifies the different types of drive channel fault isolation diagnostic tests.

Required/optional:
Returns:	The type of this ChannelDiagResults.
Return type:	str
	required

write_read_verify_data¶

Gets the write_read_verify_data of this ChannelDiagResults. The result data for the Write-Read-Verify channel diagnostic test as a variable-length array, one element per selected device. This field is only valid if type is equal to CHANNEL_DIAG_WRITE_READ_VERIFY.

Required/optional:
Returns:	The write_read_verify_data of this ChannelDiagResults.
Return type:	list[ChannelDiagWrRdVfyResults]
	optional

netapp.santricity.models.symbol.channel_diag_results_returned module¶

ChannelDiagResultsReturned.py

class netapp.santricity.models.symbol.channel_diag_results_returned.ChannelDiagResultsReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

diag_results¶

Gets the diag_results of this ChannelDiagResultsReturned. The results of the channel diagnostic test. This field does not contain valid data whenever the return code is equal to RETCODE_CHANNEL_DIAGS_RUNNING.

Required/optional:
Returns:	The diag_results of this ChannelDiagResultsReturned.
Return type:	ChannelDiagResults
	required

return_code¶

Gets the return_code of this ChannelDiagResultsReturned. The return code from the getChannelDiagnosticsResults procedure.

Required/optional:
Returns:	The return_code of this ChannelDiagResultsReturned.
Return type:	str
	required

test_end_time¶

Gets the test_end_time of this ChannelDiagResultsReturned. The time when the test sequence ended, represented in seconds since midnight GMT on January 1, 1970. If returnCode is equal to RETCODE_CHANNEL_DIAGS_RUNNING, this field is set to the time that was current when the getChannelDiagnosticsResults was processed.

Required/optional:
Returns:	The test_end_time of this ChannelDiagResultsReturned.
Return type:	int
	required

test_start_time¶

Gets the test_start_time of this ChannelDiagResultsReturned. The time when the test sequence started, represented in seconds since midnight GMT on January 1, 1970.

Required/optional:
Returns:	The test_start_time of this ChannelDiagResultsReturned.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.channel_diag_sas_dependent_results module¶

ChannelDiagSasDependentResults.py

class netapp.santricity.models.symbol.channel_diag_sas_dependent_results.ChannelDiagSasDependentResults[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

sas_data¶

Gets the sas_data of this ChannelDiagSasDependentResults. An array of SAS statistical data for the channel under test. Only data for SAS ports in the I/O path are included. All fields of the SasData structure contain meaningful data.

Required/optional:
Returns:	The sas_data of this ChannelDiagSasDependentResults.
Return type:	list[SasData]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.channel_diag_type_params module¶

ChannelDiagTypeParams.py

class netapp.santricity.models.symbol.channel_diag_type_params.ChannelDiagTypeParams[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this ChannelDiagTypeParams. This enumeration identifies the different types of drive channel fault isolation diagnostic tests.

Required/optional:
Returns:	The type of this ChannelDiagTypeParams.
Return type:	str
	required

write_read_verify_params¶

Gets the write_read_verify_params of this ChannelDiagTypeParams. The parameters for the Write-Read-Verify channel diagnostic test. This field is only valid if type is equal to CHANNEL_DIAG_WRITE_READ_VERIFY.

Required/optional:
Returns:	The write_read_verify_params of this ChannelDiagTypeParams.
Return type:	ChannelDiagWrRdVfyParams
	optional

netapp.santricity.models.symbol.channel_diag_wr_rd_vfy_params module¶

ChannelDiagWrRdVfyParams.py

class netapp.santricity.models.symbol.channel_diag_wr_rd_vfy_params.ChannelDiagWrRdVfyParams[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

data_pattern_option¶

Gets the data_pattern_option of this ChannelDiagWrRdVfyParams. The selected data pattern option.

Required/optional:
Returns:	The data_pattern_option of this ChannelDiagWrRdVfyParams.
Return type:	ChannelDiagDataPatternTypeData
	required

iterations_per_device¶

Gets the iterations_per_device of this ChannelDiagWrRdVfyParams. The number of test iterations to perform on a selected device.

Required/optional:
Returns:	The iterations_per_device of this ChannelDiagWrRdVfyParams.
Return type:	int
	required

maximum_errors_allowed¶

Gets the maximum_errors_allowed of this ChannelDiagWrRdVfyParams. The maximum number of errors that can be tolerated before canceling the test and proceeding on to the next selected device.

Required/optional:
Returns:	The maximum_errors_allowed of this ChannelDiagWrRdVfyParams.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.channel_diag_wr_rd_vfy_results module¶

ChannelDiagWrRdVfyResults.py

class netapp.santricity.models.symbol.channel_diag_wr_rd_vfy_results.ChannelDiagWrRdVfyResults[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

actual_time_interval¶

Gets the actual_time_interval of this ChannelDiagWrRdVfyResults. The number of seconds the diagnostic test actually ran.

Required/optional:
Returns:	The actual_time_interval of this ChannelDiagWrRdVfyResults.
Return type:	int
	required

average_elapsed_time_for_inbound_phases¶

Gets the average_elapsed_time_for_inbound_phases of this ChannelDiagWrRdVfyResults. The average elapsed command-processing time, in microseconds) for the inbound-data phases of all successful iterations.

Required/optional:
Returns:	The average_elapsed_time_for_inbound_phases of this ChannelDiagWrRdVfyResults.
Return type:	int
	required

average_elapsed_time_for_outbound_phases¶

Gets the average_elapsed_time_for_outbound_phases of this ChannelDiagWrRdVfyResults. The average elapsed command-processing time, in microseconds) for the outbound-data phases of all successful iterations.

Required/optional:
Returns:	The average_elapsed_time_for_outbound_phases of this ChannelDiagWrRdVfyResults.
Return type:	int
	required

channel_resets_detected¶

Gets the channel_resets_detected of this ChannelDiagWrRdVfyResults. The device on which the tests were performed.

Required/optional:
Returns:	The channel_resets_detected of this ChannelDiagWrRdVfyResults.
Return type:	int
	required

device¶

Gets the device of this ChannelDiagWrRdVfyResults. The device on which the channel diagnostic test was performed

Required/optional:
Returns:	The device of this ChannelDiagWrRdVfyResults.
Return type:	ChannelDiagDevice
	required

drive_channel¶

Gets the drive_channel of this ChannelDiagWrRdVfyResults. The number of the drive channel on which testing was performed.

Required/optional:
Returns:	The drive_channel of this ChannelDiagWrRdVfyResults.
Return type:	int
	required

interface_dependent_results¶

Gets the interface_dependent_results of this ChannelDiagWrRdVfyResults. A set of channel diagnostic test results that depend on the particular I/O interface technology of the tested channel.

Required/optional:
Returns:	The interface_dependent_results of this ChannelDiagWrRdVfyResults.
Return type:	ChannelDiagInterfaceDepResults
	required

iterations_attempted¶

Gets the iterations_attempted of this ChannelDiagWrRdVfyResults. The total number of iterations attempted

Required/optional:
Returns:	The iterations_attempted of this ChannelDiagWrRdVfyResults.
Return type:	int
	required

iterations_failed_with_inbound_misc_errors¶

Gets the iterations_failed_with_inbound_misc_errors of this ChannelDiagWrRdVfyResults. The number of iterations that failed due to other command failures (e.g., check conditions, aborted commands, channel-level resets, etc.) on inbound-data commands.

Required/optional:
Returns:	The iterations_failed_with_inbound_misc_errors of this ChannelDiagWrRdVfyResults.
Return type:	int
	required

iterations_failed_with_inbound_resets¶

Gets the iterations_failed_with_inbound_resets of this ChannelDiagWrRdVfyResults. The number of iterations that failed due to channel-level resets that occurred during inbound-data commands.

Required/optional:
Returns:	The iterations_failed_with_inbound_resets of this ChannelDiagWrRdVfyResults.
Return type:	int
	required

iterations_failed_with_inbound_timeouts¶

Gets the iterations_failed_with_inbound_timeouts of this ChannelDiagWrRdVfyResults. The number of iterations that failed due I/O timeouts on inbound-data commands.

Required/optional:
Returns:	The iterations_failed_with_inbound_timeouts of this ChannelDiagWrRdVfyResults.
Return type:	int
	required

iterations_failed_with_miscompares¶

Gets the iterations_failed_with_miscompares of this ChannelDiagWrRdVfyResults. The number of iterations that failed due to data miscompares.

Required/optional:
Returns:	The iterations_failed_with_miscompares of this ChannelDiagWrRdVfyResults.
Return type:	int
	required

iterations_failed_with_outbound_misc_errors¶

Gets the iterations_failed_with_outbound_misc_errors of this ChannelDiagWrRdVfyResults. The number of iterations that failed due to other command failures (e.g., check conditions, aborted commands, channel-level resets, etc.) on outbound data commands.

Required/optional:
Returns:	The iterations_failed_with_outbound_misc_errors of this ChannelDiagWrRdVfyResults.
Return type:	int
	required

iterations_failed_with_outbound_resets¶

Gets the iterations_failed_with_outbound_resets of this ChannelDiagWrRdVfyResults. The number of iterations that failed due to channel-level resets that occurred during outbound-data commands.

Required/optional:
Returns:	The iterations_failed_with_outbound_resets of this ChannelDiagWrRdVfyResults.
Return type:	int
	required

iterations_failed_with_outbound_timeouts¶

Gets the iterations_failed_with_outbound_timeouts of this ChannelDiagWrRdVfyResults. The number of iterations that failed due I/O timeouts on outbound-data commands.

Required/optional:
Returns:	The iterations_failed_with_outbound_timeouts of this ChannelDiagWrRdVfyResults.
Return type:	int
	required

iterations_failed_with_setup_errors¶

Gets the iterations_failed_with_setup_errors of this ChannelDiagWrRdVfyResults. The number of iterations that failed due to setup errors prior to starting the iteration.

Required/optional:
Returns:	The iterations_failed_with_setup_errors of this ChannelDiagWrRdVfyResults.
Return type:	int
	required

iterations_passed¶

Gets the iterations_passed of this ChannelDiagWrRdVfyResults. The number of iterations that completed successfully/

Required/optional:
Returns:	The iterations_passed of this ChannelDiagWrRdVfyResults.
Return type:	int
	required

status¶

Gets the status of this ChannelDiagWrRdVfyResults. A status code providing general information about the outcome of the diagnostic test.

Required/optional:
Returns:	The status of this ChannelDiagWrRdVfyResults.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

variance_in_elapsed_time_for_inbound_phases¶

Gets the variance_in_elapsed_time_for_inbound_phases of this ChannelDiagWrRdVfyResults. The statistical variance of the elapsed command-processing time for the inbound-data phases of all successful variations.

Required/optional:
Returns:	The variance_in_elapsed_time_for_inbound_phases of this ChannelDiagWrRdVfyResults.
Return type:	int
	required

variance_in_elapsed_time_for_outbound_phases¶

Gets the variance_in_elapsed_time_for_outbound_phases of this ChannelDiagWrRdVfyResults. The statistical variance of the elapsed command-processing time for the outbound-data phases of all successful variations.

Required/optional:
Returns:	The variance_in_elapsed_time_for_outbound_phases of this ChannelDiagWrRdVfyResults.
Return type:	int
	required

netapp.santricity.models.symbol.channel_diagnostic_descriptor module¶

ChannelDiagnosticDescriptor.py

class netapp.santricity.models.symbol.channel_diagnostic_descriptor.ChannelDiagnosticDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller¶

Gets the controller of this ChannelDiagnosticDescriptor. A reference indicating the controller that is to perform the test.

Required/optional:
Returns:	The controller of this ChannelDiagnosticDescriptor.
Return type:	str
	required

devices¶

Gets the devices of this ChannelDiagnosticDescriptor. A variable-length array of values, each value indicating a device on the referenced channel to be included in the test. To specify “all devices,” all that is needed is a single instance of ChannelDiagDevice with deviceType set to CHANNEL_DEVICE_ALL.

Required/optional:
Returns:	The devices of this ChannelDiagnosticDescriptor.
Return type:	list[ChannelDiagDevice]
	required

diag_params¶

Gets the diag_params of this ChannelDiagnosticDescriptor. A sub-structure indicating both the type of diagnostic test to perform and the associated test-type-dependent parameters.

Required/optional:
Returns:	The diag_params of this ChannelDiagnosticDescriptor.
Return type:	ChannelDiagTypeParams
	required

drive_channel¶

Gets the drive_channel of this ChannelDiagnosticDescriptor. The number of the drive channel to test.

Required/optional:
Returns:	The drive_channel of this ChannelDiagnosticDescriptor.
Return type:	int
	required

max_time_interval¶

Gets the max_time_interval of this ChannelDiagnosticDescriptor. The maximum number of seconds the test is allowed to run before it is forcibly terminated.

Required/optional:
Returns:	The max_time_interval of this ChannelDiagnosticDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.channel_failed_failure module¶

ChannelFailedFailure.py

class netapp.santricity.models.symbol.channel_failed_failure.ChannelFailedFailure[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

failed_channels¶

Gets the failed_channels of this ChannelFailedFailure. The failed channels.

Required/optional:
Returns:	The failed_channels of this ChannelFailedFailure.
Return type:	list[int]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.channel_location module¶

ChannelLocation.py

class netapp.santricity.models.symbol.channel_location.ChannelLocation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel_type¶

Gets the channel_type of this ChannelLocation. The channel type.

Required/optional:
Returns:	The channel_type of this ChannelLocation.
Return type:	str
	required

controller_slot¶

Gets the controller_slot of this ChannelLocation. Controller number 1 if in top slot. Controller number 2 if in bottom slot.

Required/optional:
Returns:	The controller_slot of this ChannelLocation.
Return type:	int
	required

index¶

Gets the index of this ChannelLocation. The channel location.

Required/optional:
Returns:	The index of this ChannelLocation.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.channel_port module¶

ChannelPort.py

class netapp.santricity.models.symbol.channel_port.ChannelPort[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this ChannelPort. The number of the associated channel.

Required/optional:
Returns:	The channel of this ChannelPort.
Return type:	int
	required

channel_type¶

Gets the channel_type of this ChannelPort. The type of the associated channel - either host-side or drive-side.

Required/optional:
Returns:	The channel_type of this ChannelPort.
Return type:	str
	required

id¶

Gets the id of this ChannelPort.

Required/optional:
Returns:	The id of this ChannelPort.
Return type:	str
	optional

is_trunk_active¶

Gets the is_trunk_active of this ChannelPort. This field is true if a trunk connection has been established and is being maintained on this controller or ESM channel port. This field is always false if the channel port is on a controller or ESM that does not have a Fibre Channel I/O interface type, or if the channel port is associated with a host-side channel.

Required/optional:
Returns:	The is_trunk_active of this ChannelPort.
Return type:	bool
	required

physical_location¶

Gets the physical_location of this ChannelPort. The physical location of the channel port. The parent reference in Location identifies the physical CRU where the port is located, and the position field is the parent-relative/like-port relative number of the port, starting at 1.

Required/optional:
Returns:	The physical_location of this ChannelPort.
Return type:	Location
	required

port_number¶

Gets the port_number of this ChannelPort. The identifying number assigned to this channel port. The range for port numbers is 1..n. If the port number cannot be determined, this field is set to zero.

Required/optional:
Returns:	The port_number of this ChannelPort.
Return type:	int
	required

port_parent¶

Gets the port_parent of this ChannelPort. The parent of the channel port object (minihub, controller, or ESM).

Required/optional:
Returns:	The port_parent of this ChannelPort.
Return type:	ChannelPortParent
	required

port_ref¶

Gets the port_ref of this ChannelPort. A reference to this channel port.

Required/optional:
Returns:	The port_ref of this ChannelPort.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.channel_port_pair module¶

ChannelPortPair.py

class netapp.santricity.models.symbol.channel_port_pair.ChannelPortPair[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

port1¶

Gets the port1 of this ChannelPortPair. First port of a pair cabled together.

Required/optional:
Returns:	The port1 of this ChannelPortPair.
Return type:	str
	required

port2¶

Gets the port2 of this ChannelPortPair. Second port of a pair cabled together.

Required/optional:
Returns:	The port2 of this ChannelPortPair.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.channel_port_parent module¶

ChannelPortParent.py

class netapp.santricity.models.symbol.channel_port_parent.ChannelPortParent[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_ref¶

Gets the controller_ref of this ChannelPortParent. This field is present only if the type field is equal to CHANNEL_PORT_PARENT_CONTROLLER.

Required/optional:
Returns:	The controller_ref of this ChannelPortParent.
Return type:	str
	optional

esm_ref¶

Gets the esm_ref of this ChannelPortParent. This field is present only if the type field is equal to CHANNEL_PORT_PARENT_ESM.

Required/optional:
Returns:	The esm_ref of this ChannelPortParent.
Return type:	str
	optional

hic_ref¶

Gets the hic_ref of this ChannelPortParent. This field is present only if the type field is equal to CHANNEL_PORT_PARENT_HIC.

Required/optional:
Returns:	The hic_ref of this ChannelPortParent.
Return type:	str
	optional

minihub_ref¶

Gets the minihub_ref of this ChannelPortParent. This field is present only if the type field is equal to CHANNEL_PORT_PARENT_MINIHUB.

Required/optional:
Returns:	The minihub_ref of this ChannelPortParent.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this ChannelPortParent. This enumeration object is used to specify the type of channel port parent.

Required/optional:
Returns:	The type of this ChannelPortParent.
Return type:	str
	required

netapp.santricity.models.symbol.channel_ports module¶

ChannelPorts.py

class netapp.santricity.models.symbol.channel_ports.ChannelPorts[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

manually_bypassed¶

Gets the manually_bypassed of this ChannelPorts. This is set to true if the port is bypassed.

Required/optional:
Returns:	The manually_bypassed of this ChannelPorts.
Return type:	bool
	required

port_number¶

Gets the port_number of this ChannelPorts. This is the ChannelPort port number, 1 based.

Required/optional:
Returns:	The port_number of this ChannelPorts.
Return type:	str
	required

speed_det_error¶

Gets the speed_det_error of this ChannelPorts. This is set to true only if speed detection has failed.

Required/optional:
Returns:	The speed_det_error of this ChannelPorts.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.chassis_idtlv module¶

ChassisIDTLV.py

class netapp.santricity.models.symbol.chassis_idtlv.ChassisIDTLV[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

chassis_id¶

Gets the chassis_id of this ChassisIDTLV. This field contains an octet string indicating the specific identifier for the chassis.

Required/optional:
Returns:	The chassis_id of this ChassisIDTLV.
Return type:	str
	required

subtype¶

Gets the subtype of this ChassisIDTLV. This field contains the ID for the subtype.

Required/optional:
Returns:	The subtype of this ChassisIDTLV.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.checked_pending_host module¶

CheckedPendingHost.py

class netapp.santricity.models.symbol.checked_pending_host.CheckedPendingHost[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

matched_pending_host¶

Gets the matched_pending_host of this CheckedPendingHost. This field is only present if type is PENDING_HOST_MATCHED. It contains data about a pending host and its relationship to a likely matching host in the configured topology.

Required/optional:
Returns:	The matched_pending_host of this CheckedPendingHost.
Return type:	MatchedPendingHost
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this CheckedPendingHost. This enumeration data type indicates whether a CheckedPendingHost matches or does not match a host in the configured topology.

Required/optional:
Returns:	The type of this CheckedPendingHost.
Return type:	str
	required

unmatched_pending_host¶

Gets the unmatched_pending_host of this CheckedPendingHost. This field is only present if type is PENDING_HOST_UNMATCHED. It contains data about a pending host that does not match any configured host and the relationship of that hosts ports to ports in the configured topology.

Required/optional:
Returns:	The unmatched_pending_host of this CheckedPendingHost.
Return type:	UnmatchedPendingHost
	optional

netapp.santricity.models.symbol.checked_pending_host_list module¶

CheckedPendingHostList.py

class netapp.santricity.models.symbol.checked_pending_host_list.CheckedPendingHostList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

value¶

Gets the value of this CheckedPendingHostList.

Required/optional:
Returns:	The value of this CheckedPendingHostList.
Return type:	list[CheckedPendingHost]
	optional

netapp.santricity.models.symbol.checked_pending_host_list_returned module¶

CheckedPendingHostListReturned.py

class netapp.santricity.models.symbol.checked_pending_host_list_returned.CheckedPendingHostListReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

checked_pending_host_list¶

Gets the checked_pending_host_list of this CheckedPendingHostListReturned. This field is valid only if the return code is RETCODE_OK. It is a variable-length list of CheckedPendingHost structures.

Required/optional:
Returns:	The checked_pending_host_list of this CheckedPendingHostListReturned.
Return type:	CheckedPendingHostList
	optional

return_code¶

Gets the return_code of this CheckedPendingHostListReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this CheckedPendingHostListReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.cluster module¶

Cluster.py

class netapp.santricity.models.symbol.cluster.Cluster[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cluster_ref¶

Gets the cluster_ref of this Cluster. The unique identification value for this object. Other objects may use this reference value to refer to the cluster.

Required/optional:
Returns:	The cluster_ref of this Cluster.
Return type:	str
	required

confirm_lun_mapping_creation¶

Gets the confirm_lun_mapping_creation of this Cluster. If true, indicates that creation of LUN-to-volume mappings should require careful confirmation from the end-user, since such a mapping will alter the volume access rights of other clusters, in addition to this one.

Required/optional:
Returns:	The confirm_lun_mapping_creation of this Cluster.
Return type:	bool
	required

id¶

Gets the id of this Cluster.

Required/optional:
Returns:	The id of this Cluster.
Return type:	str
	optional

is_sa_controlled¶

Gets the is_sa_controlled of this Cluster. If true, indicates that I/O accesses from this cluster are subject to the storage array’s default LUN-to-volume mappings. If false, indicates that I/O accesses from the cluster are subject to cluster-specific LUN-to-volume mappings.

Required/optional:
Returns:	The is_sa_controlled of this Cluster.
Return type:	bool
	required

label¶

Gets the label of this Cluster. The user-assigned, descriptive label string for the cluster.

Required/optional:
Returns:	The label of this Cluster.
Return type:	str
	required

name¶

Gets the name of this Cluster.

Required/optional:
Returns:	The name of this Cluster.
Return type:	str
	optional

protection_information_capable_access_method¶

Gets the protection_information_capable_access_method of this Cluster. This field is true if the host has a PI capable access method.

Required/optional:
Returns:	The protection_information_capable_access_method of this Cluster.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.cluster_performance_limitation_values module¶

ClusterPerformanceLimitationValues.py

class netapp.santricity.models.symbol.cluster_performance_limitation_values.ClusterPerformanceLimitationValues[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cluster_ref¶

Gets the cluster_ref of this ClusterPerformanceLimitationValues. This is a reference to the cluster for which the parameters apply.

Required/optional:
Returns:	The cluster_ref of this ClusterPerformanceLimitationValues.
Return type:	str
	required

iops_impacted_by_limitations_on_this_cluster¶

Gets the iops_impacted_by_limitations_on_this_cluster of this ClusterPerformanceLimitationValues. This is a count of the number of IOPs that have been impacted by the performance limitations set on this cluster.

Required/optional:
Returns:	The iops_impacted_by_limitations_on_this_cluster of this ClusterPerformanceLimitationValues.
Return type:	int
	required

max_iops_permitted_on_cluster¶

Gets the max_iops_permitted_on_cluster of this ClusterPerformanceLimitationValues. This is the maximum number of IOPs permitted on this cluster.

Required/optional:
Returns:	The max_iops_permitted_on_cluster of this ClusterPerformanceLimitationValues.
Return type:	int
	required

max_m_bs_permitted_on_cluster¶

Gets the max_m_bs_permitted_on_cluster of this ClusterPerformanceLimitationValues. This is the maximum number of MB per second permitted on this cluster.

Required/optional:
Returns:	The max_m_bs_permitted_on_cluster of this ClusterPerformanceLimitationValues.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.cluster_performance_limitation_values_descriptor module¶

ClusterPerformanceLimitationValuesDescriptor.py

class netapp.santricity.models.symbol.cluster_performance_limitation_values_descriptor.ClusterPerformanceLimitationValuesDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cluster_ref¶

Gets the cluster_ref of this ClusterPerformanceLimitationValuesDescriptor. This is the reference to the cluster for which the performance parameters apply.

Required/optional:
Returns:	The cluster_ref of this ClusterPerformanceLimitationValuesDescriptor.
Return type:	str
	required

max_iops_on_cluster¶

Gets the max_iops_on_cluster of this ClusterPerformanceLimitationValuesDescriptor. This is the maximum number of IOPs allowed for the cluster. The controller firmware will limit the number of IOPs for a cluster to this value. A value of CLUSTER_PERFORMANCE_LIMIT_DEFAULT_VALUE (0) means that no performance limitations have been placed on the cluster.

Required/optional:
Returns:	The max_iops_on_cluster of this ClusterPerformanceLimitationValuesDescriptor.
Return type:	int
	required

max_m_bs_on_cluster¶

Gets the max_m_bs_on_cluster of this ClusterPerformanceLimitationValuesDescriptor. This is the maximum number of MB per second that will be supported on the cluster. The controller firmware will limit the throughput for the cluster to this value. A value of CLUSTER_PERFORMANCE_LIMIT_DEFAULT_VALUE (0) means that no throughput limitations exist on the cluster.

Required/optional:
Returns:	The max_m_bs_on_cluster of this ClusterPerformanceLimitationValuesDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.cluster_performance_limitation_values_returned module¶

ClusterPerformanceLimitationValuesReturned.py

class netapp.santricity.models.symbol.cluster_performance_limitation_values_returned.ClusterPerformanceLimitationValuesReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cluster_performance_limitation_values¶

Gets the cluster_performance_limitation_values of this ClusterPerformanceLimitationValuesReturned. If the return code is RETCODE_OK, the cluster performance limitation values struct is also returned.

Required/optional:
Returns:	The cluster_performance_limitation_values of this ClusterPerformanceLimitationValuesReturned.
Return type:	ClusterPerformanceLimitationValues
	optional

return_code¶

Gets the return_code of this ClusterPerformanceLimitationValuesReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this ClusterPerformanceLimitationValuesReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.co_w_repository_analysis_request module¶

CoWRepositoryAnalysisRequest.py

class netapp.santricity.models.symbol.co_w_repository_analysis_request.CoWRepositoryAnalysisRequest[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

action¶

Gets the action of this CoWRepositoryAnalysisRequest. This enumeration defines the different action types to be used when requesting a CoW repository analysis.

Required/optional:
Returns:	The action of this CoWRepositoryAnalysisRequest.
Return type:	str
	required

associated_volume¶

Gets the associated_volume of this CoWRepositoryAnalysisRequest. If the action field equals REPOSITORY_ANALYSIS_TYPE_SPECIFIC_REPOSITORY, then an identifier for the associated volume is returned.

Required/optional:
Returns:	The associated_volume of this CoWRepositoryAnalysisRequest.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.co_w_repository_analysis_results module¶

CoWRepositoryAnalysisResults.py

class netapp.santricity.models.symbol.co_w_repository_analysis_results.CoWRepositoryAnalysisResults[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

analysis_result¶

Gets the analysis_result of this CoWRepositoryAnalysisResults. The result of the CoW repository analysis.

Required/optional:
Returns:	The analysis_result of this CoWRepositoryAnalysisResults.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.co_w_repository_analysis_results_returned module¶

CoWRepositoryAnalysisResultsReturned.py

class netapp.santricity.models.symbol.co_w_repository_analysis_results_returned.CoWRepositoryAnalysisResultsReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

result¶

Gets the result of this CoWRepositoryAnalysisResultsReturned. Analysis data is returned only if the ReturnCode equals RETCODE_OK.

Required/optional:
Returns:	The result of this CoWRepositoryAnalysisResultsReturned.
Return type:	CoWRepositoryAnalysisResults
	optional

return_code¶

Gets the return_code of this CoWRepositoryAnalysisResultsReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this CoWRepositoryAnalysisResultsReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.compatible_firmware module¶

CompatibleFirmware.py

class netapp.santricity.models.symbol.compatible_firmware.CompatibleFirmware[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

compatible¶

Gets the compatible of this CompatibleFirmware. A true value indicates that any firmware version that matches the one specified in this structure is compatible with the currently-installed storage array firmware. A false value indicates that matching firmware versions are NOT compatible.

Required/optional:
Returns:	The compatible of this CompatibleFirmware.
Return type:	bool
	required

fw_version¶

Gets the fw_version of this CompatibleFirmware. A firmware package version identifier, which may or may not contain bytes with a value of FW_VERSION_WILDCARD.

Required/optional:
Returns:	The fw_version of this CompatibleFirmware.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.component_bundle module¶

ComponentBundle.py

class netapp.santricity.models.symbol.component_bundle.ComponentBundle[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

alarm¶

Gets the alarm of this ComponentBundle. The alarm.

Required/optional:
Returns:	The alarm of this ComponentBundle.
Return type:	list[Alarm]
	required

battery¶

Gets the battery of this ComponentBundle. The battery component.

Required/optional:
Returns:	The battery of this ComponentBundle.
Return type:	list[Battery]
	required

cache_backup_device¶

Gets the cache_backup_device of this ComponentBundle. The cache backup devices.

Required/optional:
Returns:	The cache_backup_device of this ComponentBundle.
Return type:	list[CacheBackupDevice]
	required

cache_memory_dimm¶

Gets the cache_memory_dimm of this ComponentBundle. List of field replaceable cache memory DIMM modules.

Required/optional:
Returns:	The cache_memory_dimm of this ComponentBundle.
Return type:	list[CacheMemoryDimm]
	required

drawer¶

Gets the drawer of this ComponentBundle. List of drawers.

Required/optional:
Returns:	The drawer of this ComponentBundle.
Return type:	list[Drawer]
	required

esm¶

Gets the esm of this ComponentBundle. The ESM component.

Required/optional:
Returns:	The esm of this ComponentBundle.
Return type:	list[Esm]
	required

fan¶

Gets the fan of this ComponentBundle. The fan component.

Required/optional:
Returns:	The fan of this ComponentBundle.
Return type:	list[Fan]
	required

gbic¶

Gets the gbic of this ComponentBundle. The GBIC component.

Required/optional:
Returns:	The gbic of this ComponentBundle.
Return type:	list[Gbic]
	required

host_board¶

Gets the host_board of this ComponentBundle. The host board.

Required/optional:
Returns:	The host_board of this ComponentBundle.
Return type:	list[HostBoard]
	required

interconnect_cru¶

Gets the interconnect_cru of this ComponentBundle. The interconnect CRU.

Required/optional:
Returns:	The interconnect_cru of this ComponentBundle.
Return type:	list[InterconnectCRU]
	required

minihub¶

Gets the minihub of this ComponentBundle. The minihub component.

Required/optional:
Returns:	The minihub of this ComponentBundle.
Return type:	list[Minihub]
	required

power_supply¶

Gets the power_supply of this ComponentBundle. The power supply component.

Required/optional:
Returns:	The power_supply of this ComponentBundle.
Return type:	list[PowerSupply]
	required

processor_memory_dimm¶

Gets the processor_memory_dimm of this ComponentBundle. List of field replaceable processor memory DIMMs.

Required/optional:
Returns:	The processor_memory_dimm of this ComponentBundle.
Return type:	list[ProcessorMemoryDimm]
	required

sas_expander¶

Gets the sas_expander of this ComponentBundle. The SAS expanders.

Required/optional:
Returns:	The sas_expander of this ComponentBundle.
Return type:	list[SasExpander]
	required

sfp¶

Gets the sfp of this ComponentBundle. The SFP component.

Required/optional:
Returns:	The sfp of this ComponentBundle.
Return type:	list[Sfp]
	required

support_cru¶

Gets the support_cru of this ComponentBundle. The Support CRU.

Required/optional:
Returns:	The support_cru of this ComponentBundle.
Return type:	list[SupportCRU]
	required

thermal_sensor¶

Gets the thermal_sensor of this ComponentBundle. The thermal sensor component.

Required/optional:
Returns:	The thermal_sensor of this ComponentBundle.
Return type:	list[ThermalSensor]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

ups¶

Gets the ups of this ComponentBundle. The UPS component.

Required/optional:
Returns:	The ups of this ComponentBundle.
Return type:	list[Ups]
	required

netapp.santricity.models.symbol.component_location module¶

ComponentLocation.py

class netapp.santricity.models.symbol.component_location.ComponentLocation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

alarm_location¶

Gets the alarm_location of this ComponentLocation. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_ALARM.

Required/optional:
Returns:	The alarm_location of this ComponentLocation.
Return type:	TraySlot
	optional

async_mirror_group¶

Gets the async_mirror_group of this ComponentLocation. This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_ASYNC_MIRROR_GROUP.

Required/optional:
Returns:	The async_mirror_group of this ComponentLocation.
Return type:	str
	optional

battery_tray¶

Gets the battery_tray of this ComponentLocation. The tray ID of the tray containing the battery for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_BATTERY.

Required/optional:
Returns:	The battery_tray of this ComponentLocation.
Return type:	int
	optional

cache_backup_device_location¶

Gets the cache_backup_device_location of this ComponentLocation. This field is valid only when the eventComponentType value is equal toEVENT_COMP_TYPE_CACHE_BACKUP_DEVICE. It identifies the location of the cache backup device to which the event applies.

Required/optional:
Returns:	The cache_backup_device_location of this ComponentLocation.
Return type:	CacheBackupDeviceLocation
	optional

cache_memory_dimm_location¶

Gets the cache_memory_dimm_location of this ComponentLocation. This field is only valid when the eventComponentType value is equal to EVENT_COMP_TYPE_CACHE_MEM_DIMM. It identifies the location of the cache memory DIMM to which the event applies.

Required/optional:
Returns:	The cache_memory_dimm_location of this ComponentLocation.
Return type:	CacheMemoryDimmLocation
	optional

cg_label¶

Gets the cg_label of this ComponentLocation. This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_PIT_CONSISTENCY_GROUP.

Required/optional:
Returns:	The cg_label of this ComponentLocation.
Return type:	str
	optional

cg_pit_label¶

Gets the cg_pit_label of this ComponentLocation. This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_CGPIT. Note that events for CGPITs also include extended component location information beyond just the associated CG label (CGPITs themselves are identified by a combination of the label of the associated Consistency Group plus a sequence number).

Required/optional:
Returns:	The cg_pit_label of this ComponentLocation.
Return type:	str
	optional

cg_view_label¶

Gets the cg_view_label of this ComponentLocation. This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_CGVIEW.

Required/optional:
Returns:	The cg_view_label of this ComponentLocation.
Return type:	str
	optional

channel_loc¶

Gets the channel_loc of this ComponentLocation. The location of the channel. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_CHANNEL.

Required/optional:
Returns:	The channel_loc of this ComponentLocation.
Return type:	ChannelLocation
	optional

channel_port¶

Gets the channel_port of this ComponentLocation. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_CHANNEL_PORT.

Required/optional:
Returns:	The channel_port of this ComponentLocation.
Return type:	int
	optional

chip_loc¶

Gets the chip_loc of this ComponentLocation. The physical location of the controller that owns the chip for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_CHIP.

Required/optional:
Returns:	The chip_loc of this ComponentLocation.
Return type:	TraySlot
	optional

community_name_string¶

Gets the community_name_string of this ComponentLocation. This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_SNMP_COMMUNITY. The community name string can contain up to 31 characters.

Required/optional:
Returns:	The community_name_string of this ComponentLocation.
Return type:	str
	optional

component_relative_location¶

Gets the component_relative_location of this ComponentLocation. The component type and location are described in this field. This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_RELATIVE.

Required/optional:
Returns:	The component_relative_location of this ComponentLocation.
Return type:	ComponentRelativeLocation
	optional

controller_loc¶

Gets the controller_loc of this ComponentLocation. The physical location of the controller for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_CONTROLLER.

Required/optional:
Returns:	The controller_loc of this ComponentLocation.
Return type:	TraySlot
	optional

ctlr_sfp_location¶

Gets the ctlr_sfp_location of this ComponentLocation. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_CTLR_SFP.

Required/optional:
Returns:	The ctlr_sfp_location of this ComponentLocation.
Return type:	ControllerSfpLocation
	optional

destination_ip_address¶

Gets the destination_ip_address of this ComponentLocation. This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_SNMP_TRAP_DESTINATION. It contains an ASCII representation of the destination address (the maximum number of characters is 40 for IPV6, 15 characters for IPV4.

Required/optional:
Returns:	The destination_ip_address of this ComponentLocation.
Return type:	str
	optional

disk_pool¶

Gets the disk_pool of this ComponentLocation. This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_DISK_POOL.

Required/optional:
Returns:	The disk_pool of this ComponentLocation.
Return type:	int
	optional

drawer_location¶

Gets the drawer_location of this ComponentLocation. The physical location of the drawer for which the MEL event was generated. This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_DRAWER.

Required/optional:
Returns:	The drawer_location of this ComponentLocation.
Return type:	TraySlot
	optional

drive_loc¶

Gets the drive_loc of this ComponentLocation. The physical location of the drive for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_DRIVE.

Required/optional:
Returns:	The drive_loc of this ComponentLocation.
Return type:	TraySlot
	optional

enclosure_tray¶

Gets the enclosure_tray of this ComponentLocation. The tray ID of the tray for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_ENCLOSURE.

Required/optional:
Returns:	The enclosure_tray of this ComponentLocation.
Return type:	int
	optional

esm_tray¶

Gets the esm_tray of this ComponentLocation. The tray ID of the tray containing the ESM card for which the MEL entry was generated. This field is not used and is considered deprecated. Instead the ESM tray/slot location is given by the ExtendedComponentLocation field.

Required/optional:
Returns:	The esm_tray of this ComponentLocation.
Return type:	int
	optional

event_component_type¶

Gets the event_component_type of this ComponentLocation. This enumeration object is used to specify the different component types that can be associated with entries in the Major Event Log.

Required/optional:
Returns:	The event_component_type of this ComponentLocation.
Return type:	str
	required

fan_cru_location¶

Gets the fan_cru_location of this ComponentLocation. Location information for fan CRU.

Required/optional:
Returns:	The fan_cru_location of this ComponentLocation.
Return type:	TraySlot
	optional

fan_tray¶

Gets the fan_tray of this ComponentLocation. The tray ID of the tray containing the fan for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_FAN.

Required/optional:
Returns:	The fan_tray of this ComponentLocation.
Return type:	int
	optional

fc_target_location¶

Gets the fc_target_location of this ComponentLocation. This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_FC_TARGET. It contains location data that is an 8-byte binary SCSI name.

Required/optional:
Returns:	The fc_target_location of this ComponentLocation.
Return type:	FibreChannelTargetLocation
	optional

flash_cache_label¶

Gets the flash_cache_label of this ComponentLocation. This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_FLASH_CACHE. It identifies the flash cache device to which this event applies.

Required/optional:
Returns:	The flash_cache_label of this ComponentLocation.
Return type:	str
	optional

group_number¶

Gets the group_number of this ComponentLocation. The volume group sequence number of the volume group for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_VOLUME_GRP.

Required/optional:
Returns:	The group_number of this ComponentLocation.
Return type:	int
	optional

host_io_card_location¶

Gets the host_io_card_location of this ComponentLocation. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_HOST_IO_CARD. It identifies the location of the host I/O card to which the event applies.

Required/optional:
Returns:	The host_io_card_location of this ComponentLocation.
Return type:	HostIoCardLocation
	optional

host_location¶

Gets the host_location of this ComponentLocation. This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_HOST. It is the user-assigned label of the host for which the MEL entry is reporting a problem.

Required/optional:
Returns:	The host_location of this ComponentLocation.
Return type:	str
	optional

host_port_location¶

Gets the host_port_location of this ComponentLocation. This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_HOST_PORT. It identifies the host port to which the event applies.

Required/optional:
Returns:	The host_port_location of this ComponentLocation.
Return type:	HostPortLocation
	optional

initiator_location¶

Gets the initiator_location of this ComponentLocation. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_INITIATOR. It identifies the iSCSI initiator to which the event applies.

Required/optional:
Returns:	The initiator_location of this ComponentLocation.
Return type:	InitiatorLocation
	optional

interconnect_cru_location¶

Gets the interconnect_cru_location of this ComponentLocation. No information is returned

Required/optional:
Returns:	The interconnect_cru_location of this ComponentLocation.
Return type:	TraySlot
	optional

isns_server_location¶

Gets the isns_server_location of this ComponentLocation. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_ISNS_SERVER. It identifies the iSNS server to which the event applies.

Required/optional:
Returns:	The isns_server_location of this ComponentLocation.
Return type:	IsnsServerLocation
	optional

label¶

Gets the label of this ComponentLocation. The user-assigned label of the volume for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_VOLUME

Required/optional:
Returns:	The label of this ComponentLocation.
Return type:	str
	optional

minihub_loc¶

Gets the minihub_loc of this ComponentLocation. The location of the minihub. This filed is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_MINIHUB.

Required/optional:
Returns:	The minihub_loc of this ComponentLocation.
Return type:	MinihubLocation
	optional

pit_label¶

Gets the pit_label of this ComponentLocation. This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_PIT. Note that events for PITs also include extended component location information beyond just the associated PiT Group label (PITs themselves are identified by a combination of the label of the associated PiT Group plus a sequence number).

Required/optional:
Returns:	The pit_label of this ComponentLocation.
Return type:	str
	optional

port_cru_tray¶

Gets the port_cru_tray of this ComponentLocation. The tray ID of the tray containing the Fibre Channel port CRU for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_PORT_CRU. This field is deprecated.

Required/optional:
Returns:	The port_cru_tray of this ComponentLocation.
Return type:	int
	optional

power_supply_cru_location¶

Gets the power_supply_cru_location of this ComponentLocation. Power supply CRU location.

Required/optional:
Returns:	The power_supply_cru_location of this ComponentLocation.
Return type:	TraySlot
	optional

power_supply_tray¶

Gets the power_supply_tray of this ComponentLocation. The tray ID of the tray containing the power supply for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_POWER_SPLY.

Required/optional:
Returns:	The power_supply_tray of this ComponentLocation.
Return type:	int
	optional

schedule¶

Gets the schedule of this ComponentLocation. The user-assigned label of the schedule. This field is only valid when the eventComponentType field is equal to EVENT_COMP_TYPE_SCHEDULE.

Required/optional:
Returns:	The schedule of this ComponentLocation.
Return type:	str
	optional

sfp_location¶

Gets the sfp_location of this ComponentLocation. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_SFP_PORT.

Required/optional:
Returns:	The sfp_location of this ComponentLocation.
Return type:	TraySlot
	optional

soc_location¶

Gets the soc_location of this ComponentLocation. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_CTLR_SOC.

Required/optional:
Returns:	The soc_location of this ComponentLocation.
Return type:	SocLocation
	optional

support_cru_location¶

Gets the support_cru_location of this ComponentLocation. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_SUPPORT_CRU.

Required/optional:
Returns:	The support_cru_location of this ComponentLocation.
Return type:	TraySlot
	optional

target_location¶

Gets the target_location of this ComponentLocation. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_TARGET. It identifies the iSCSI target to which the event applies.

Required/optional:
Returns:	The target_location of this ComponentLocation.
Return type:	TargetLocation
	optional

temp_sensor_tray¶

Gets the temp_sensor_tray of this ComponentLocation. The tray ID of the tray containing the temperature sensor for which the MEL entry was generated. This field is valid only when the eventComponentType value is equal to EVENT_COMP_TYPE_TEMP_SENSOR.

Required/optional:
Returns:	The temp_sensor_tray of this ComponentLocation.
Return type:	int
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.component_relative_location module¶

ComponentRelativeLocation.py

class netapp.santricity.models.symbol.component_relative_location.ComponentRelativeLocation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

component_label¶

Gets the component_label of this ComponentRelativeLocation. Contains the label of the component.

Required/optional:
Returns:	The component_label of this ComponentRelativeLocation.
Return type:	str
	required

component_type¶

Gets the component_type of this ComponentRelativeLocation. The type of component.

Required/optional:
Returns:	The component_type of this ComponentRelativeLocation.
Return type:	str
	required

parent¶

Gets the parent of this ComponentRelativeLocation. This is an array containing additional parent-relative location information. The first element in the array will contain the parent’s component type and its relative position within it’s parent.

Required/optional:
Returns:	The parent of this ComponentRelativeLocation.
Return type:	list[ParentRelativeLocation]
	required

parent_size¶

Gets the parent_size of this ComponentRelativeLocation. The size of the parent array that follows.

Required/optional:
Returns:	The parent_size of this ComponentRelativeLocation.
Return type:	int
	required

relative_position¶

Gets the relative_position of this ComponentRelativeLocation. The relative position within the component’s parent.

Required/optional:
Returns:	The relative_position of this ComponentRelativeLocation.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray_id¶

Gets the tray_id of this ComponentRelativeLocation. The tray ID of the tray containing the component.

Required/optional:
Returns:	The tray_id of this ComponentRelativeLocation.
Return type:	int
	required

netapp.santricity.models.symbol.component_removal_data module¶

ComponentRemovalData.py

class netapp.santricity.models.symbol.component_removal_data.ComponentRemovalData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

removal_method¶

Gets the removal_method of this ComponentRemovalData. This enumeration defines the removal methods that apply to any component.

Required/optional:
Returns:	The removal_method of this ComponentRemovalData.
Return type:	str
	required

rtr_attributes¶

Gets the rtr_attributes of this ComponentRemovalData. This field holds the component’s ready-to-remove attributes. It is only present when the removalMethod is equal to COMP_RMV_METHOD_REMOVE_SELF.

Required/optional:
Returns:	The rtr_attributes of this ComponentRemovalData.
Return type:	RTRAttributeData
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.concat_volume module¶

ConcatVolume.py

class netapp.santricity.models.symbol.concat_volume.ConcatVolume[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

aggregate_capacity¶

Gets the aggregate_capacity of this ConcatVolume. The aggregate capacity in bytes of all member volumes.

Required/optional:
Returns:	The aggregate_capacity of this ConcatVolume.
Return type:	int
	required

allowed_operations¶

Gets the allowed_operations of this ConcatVolume. Operations allowed on the ConcatVolume. This can be used if ConcatVolume is ever exposed as a host-addressable volume to specify whether the volume is host-mappable or not (repository volumes would never be mappable).

Required/optional:
Returns:	The allowed_operations of this ConcatVolume.
Return type:	VolumePerms
	required

concat_vol_ref¶

Gets the concat_vol_ref of this ConcatVolume. A reference (key) for ConcatVolume.

Required/optional:
Returns:	The concat_vol_ref of this ConcatVolume.
Return type:	str
	required

id¶

Gets the id of this ConcatVolume.

Required/optional:
Returns:	The id of this ConcatVolume.
Return type:	str
	optional

media_scan_params¶

Gets the media_scan_params of this ConcatVolume. Media scan parameters.

Required/optional:
Returns:	The media_scan_params of this ConcatVolume.
Return type:	VolumeMediaScanParams
	required

member_count¶

Gets the member_count of this ConcatVolume. The number of actual storage volumes comprising this volume. Note that this is just for convenience, this information can be derived from member objects.

Required/optional:
Returns:	The member_count of this ConcatVolume.
Return type:	int
	required

status¶

Gets the status of this ConcatVolume. The status/state of the concatenated volume. This will be the worst status among the member volumes.

Required/optional:
Returns:	The status of this ConcatVolume.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_handle¶

Gets the volume_handle of this ConcatVolume. The volume ssid. This is provided primarily for debug purposes.

Required/optional:
Returns:	The volume_handle of this ConcatVolume.
Return type:	int
	required

netapp.santricity.models.symbol.concat_volume_candidate module¶

ConcatVolumeCandidate.py

class netapp.santricity.models.symbol.concat_volume_candidate.ConcatVolumeCandidate[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cand_type¶

Gets the cand_type of this ConcatVolumeCandidate. This enumeration is used to specify the Concatenated Volume candidate type.

Required/optional:
Returns:	The cand_type of this ConcatVolumeCandidate.
Return type:	str
	required

exist_vol_candidate¶

Gets the exist_vol_candidate of this ConcatVolumeCandidate. This field is present only if the ConcatVolumeCandidateType value is equal to CONCAT_VOL_CANDIDATE_TYPE_EXISTING_VOLS.

Required/optional:
Returns:	The exist_vol_candidate of this ConcatVolumeCandidate.
Return type:	ConcatVolumeExistingVolumeCandidate
	optional

expansion_descriptor¶

Gets the expansion_descriptor of this ConcatVolumeCandidate. This field is present only if the ConcatVolumeCandidateType value is equal to CONCAT_VOL_CANDIDATE_TYPE_EXPANSION.

Required/optional:
Returns:	The expansion_descriptor of this ConcatVolumeCandidate.
Return type:	ConcatVolumeDirectExpansionDescriptor
	optional

new_vol_candidate¶

Gets the new_vol_candidate of this ConcatVolumeCandidate. This field is present only if the ConcatVolumeCandidateType value is equal to CONCAT_VOL_CANDIDATE_TYPE_NEW_VOL.

Required/optional:
Returns:	The new_vol_candidate of this ConcatVolumeCandidate.
Return type:	ConcatVolumeNewVolumeCandidate
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.concat_volume_creation_descriptor module¶

ConcatVolumeCreationDescriptor.py

class netapp.santricity.models.symbol.concat_volume_creation_descriptor.ConcatVolumeCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

candidate¶

Gets the candidate of this ConcatVolumeCreationDescriptor. Candidate info necessary to create new storage volumes or add existing volumes.

Required/optional:
Returns:	The candidate of this ConcatVolumeCreationDescriptor.
Return type:	ConcatVolumeCandidate
	required

media_scan_params¶

Gets the media_scan_params of this ConcatVolumeCreationDescriptor. Media Scan parameters.

Required/optional:
Returns:	The media_scan_params of this ConcatVolumeCreationDescriptor.
Return type:	VolumeMediaScanParams
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.concat_volume_default_attributes module¶

ConcatVolumeDefaultAttributes.py

class netapp.santricity.models.symbol.concat_volume_default_attributes.ConcatVolumeDefaultAttributes[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

concat_volume_member_capacity_alignment_size_in_bytes¶

Gets the concat_volume_member_capacity_alignment_size_in_bytes of this ConcatVolumeDefaultAttributes. The capacity of a ConcatVolumeMember that will be utilized by the associated ConcatVolume will be the nearest multiple of this value that is less than or equal to the total ConcatVolumeMember capacity.

Required/optional:
Returns:	The concat_volume_member_capacity_alignment_size_in_bytes of this ConcatVolumeDefaultAttributes.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.concat_volume_direct_expansion_descriptor module¶

ConcatVolumeDirectExpansionDescriptor.py

class netapp.santricity.models.symbol.concat_volume_direct_expansion_descriptor.ConcatVolumeDirectExpansionDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

additional_capacity¶

Gets the additional_capacity of this ConcatVolumeDirectExpansionDescriptor. Additional capacity to add to the last member of the ConcatVolume.

Required/optional:
Returns:	The additional_capacity of this ConcatVolumeDirectExpansionDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.concat_volume_existing_volume_candidate module¶

ConcatVolumeExistingVolumeCandidate.py

class netapp.santricity.models.symbol.concat_volume_existing_volume_candidate.ConcatVolumeExistingVolumeCandidate[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

member_label¶

Gets the member_label of this ConcatVolumeExistingVolumeCandidate. A list of member volumes specified using volume labels. This field is present only if the value of refType is equal to CONCAT_VOL_MEMBER_REF_TYPE_LABEL.

Required/optional:
Returns:	The member_label of this ConcatVolumeExistingVolumeCandidate.
Return type:	list[str]
	optional

member_volume_ref¶

Gets the member_volume_ref of this ConcatVolumeExistingVolumeCandidate. A list of member volumes specified using volume references. This field is present only if the value of refType is equal to CONCAT_VOL_MEMBER_REF_TYPE_VOLREF.

Required/optional:
Returns:	The member_volume_ref of this ConcatVolumeExistingVolumeCandidate.
Return type:	list[str]
	optional

ref_type¶

Gets the ref_type of this ConcatVolumeExistingVolumeCandidate. This enumeration is used to specify the Concatenated Volume Member reference type.

Required/optional:
Returns:	The ref_type of this ConcatVolumeExistingVolumeCandidate.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.concat_volume_expansion_descriptor module¶

ConcatVolumeExpansionDescriptor.py

class netapp.santricity.models.symbol.concat_volume_expansion_descriptor.ConcatVolumeExpansionDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

concat_vol¶

Gets the concat_vol of this ConcatVolumeExpansionDescriptor. The ConcatVolume to expand.

Required/optional:
Returns:	The concat_vol of this ConcatVolumeExpansionDescriptor.
Return type:	str
	required

expand_candidate¶

Gets the expand_candidate of this ConcatVolumeExpansionDescriptor. The expansion candidate for the ConcatVolume (can be an existing volume, a volume to be created, or expand the last member).

Required/optional:
Returns:	The expand_candidate of this ConcatVolumeExpansionDescriptor.
Return type:	ConcatVolumeCandidate
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.concat_volume_member module¶

ConcatVolumeMember.py

class netapp.santricity.models.symbol.concat_volume_member.ConcatVolumeMember[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

concat_vol_ref¶

Gets the concat_vol_ref of this ConcatVolumeMember. A reference to the parent ConcatVolume.

Required/optional:
Returns:	The concat_vol_ref of this ConcatVolumeMember.
Return type:	str
	required

member_ref¶

Gets the member_ref of this ConcatVolumeMember. A reference (key) for ConcatVolumeMember.

Required/optional:
Returns:	The member_ref of this ConcatVolumeMember.
Return type:	str
	required

parent_index¶

Gets the parent_index of this ConcatVolumeMember. The index (order) of the member in the aggregated parent volume capacity.

Required/optional:
Returns:	The parent_index of this ConcatVolumeMember.
Return type:	int
	required

storage_volume_ref¶

Gets the storage_volume_ref of this ConcatVolumeMember. A reference to the member RAID volume providing storage capacity.

Required/optional:
Returns:	The storage_volume_ref of this ConcatVolumeMember.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.concat_volume_new_volume_candidate module¶

ConcatVolumeNewVolumeCandidate.py

class netapp.santricity.models.symbol.concat_volume_new_volume_candidate.ConcatVolumeNewVolumeCandidate[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

member_candidate¶

Gets the member_candidate of this ConcatVolumeNewVolumeCandidate. The candidate to be used to create the member volume.

Required/optional:
Returns:	The member_candidate of this ConcatVolumeNewVolumeCandidate.
Return type:	VolumeCandidate
	required

member_capacity¶

Gets the member_capacity of this ConcatVolumeNewVolumeCandidate. The capacity of the new volume to create, in bytes.

Required/optional:
Returns:	The member_capacity of this ConcatVolumeNewVolumeCandidate.
Return type:	int
	required

member_volume_group_label¶

Gets the member_volume_group_label of this ConcatVolumeNewVolumeCandidate. An optional volume group label if creating a new volume group.

Required/optional:
Returns:	The member_volume_group_label of this ConcatVolumeNewVolumeCandidate.
Return type:	str
	required

member_volume_label¶

Gets the member_volume_label of this ConcatVolumeNewVolumeCandidate. The label for the new member volume.

Required/optional:
Returns:	The member_volume_label of this ConcatVolumeNewVolumeCandidate.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.concat_volume_trim_descriptor module¶

ConcatVolumeTrimDescriptor.py

class netapp.santricity.models.symbol.concat_volume_trim_descriptor.ConcatVolumeTrimDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

concat_vol¶

Gets the concat_vol of this ConcatVolumeTrimDescriptor. The ConcatVolume to trim.

Required/optional:
Returns:	The concat_vol of this ConcatVolumeTrimDescriptor.
Return type:	str
	required

retain_repository_members¶

Gets the retain_repository_members of this ConcatVolumeTrimDescriptor. An indication of whether the member volumes removed should be deleted or retained.

Required/optional:
Returns:	The retain_repository_members of this ConcatVolumeTrimDescriptor.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

trim_count¶

Gets the trim_count of this ConcatVolumeTrimDescriptor. The number of members to remove (starting from the end). Must be less than or equal to the number of current members minus 1.

Required/optional:
Returns:	The trim_count of this ConcatVolumeTrimDescriptor.
Return type:	int
	required

netapp.santricity.models.symbol.consistency_group module¶

ConsistencyGroup.py

class netapp.santricity.models.symbol.consistency_group.ConsistencyGroup[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

group_ref¶

Gets the group_ref of this ConsistencyGroup. The consistency group reference.

Required/optional:
Returns:	The group_ref of this ConsistencyGroup.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.consistency_group_bundle module¶

ConsistencyGroupBundle.py

class netapp.santricity.models.symbol.consistency_group_bundle.ConsistencyGroupBundle[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

consistency_group¶

Gets the consistency_group of this ConsistencyGroupBundle. Bundle of information about the write order consistency group objects.

Required/optional:
Returns:	The consistency_group of this ConsistencyGroupBundle.
Return type:	list[ConsistencyGroup]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.controller module¶

Controller.py

class netapp.santricity.models.symbol.controller.Controller[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

active¶

Gets the active of this Controller. True if the controller is in active mode; false otherwise.

Required/optional:
Returns:	The active of this Controller.
Return type:	bool
	required

app_version¶

Gets the app_version of this Controller. The version identification string for the application code that is running on the controller.

Required/optional:
Returns:	The app_version of this Controller.
Return type:	str
	required

board_id¶

Gets the board_id of this Controller. The variable-length ASCII text string that represents the board identifier (i.e. board type) of the controller.

Required/optional:
Returns:	The board_id of this Controller.
Return type:	str
	required

board_submodel_id¶

Gets the board_submodel_id of this Controller. The board sub-model ID of the controller card

Required/optional:
Returns:	The board_submodel_id of this Controller.
Return type:	str
	required

boot_time¶

Gets the boot_time of this Controller. The timestamp value for the time at which the controller last booted. Note that this value may be different for the other controller in the storage array. This value is defined as the number of seconds since midnight GMT on January 1, 1970.

Required/optional:
Returns:	The boot_time of this Controller.
Return type:	int
	required

boot_version¶

Gets the boot_version of this Controller. The version identification string for the boot code that is running on the controller.

Required/optional:
Returns:	The boot_version of this Controller.
Return type:	str
	required

cache_memory_size¶

Gets the cache_memory_size of this Controller. The memory size, in MB, that will be used by the controller as cache memory.

Required/optional:
Returns:	The cache_memory_size of this Controller.
Return type:	int
	required

code_versions¶

Gets the code_versions of this Controller. Version descriptors for loaded code modules

Required/optional:
Returns:	The code_versions of this Controller.
Return type:	list[VersionDescriptor]
	required

controller_error_mode¶

Gets the controller_error_mode of this Controller. Indicates the error mode in which the controller is operating. A value of 0 indicates the controller is not operating in an error mode.

Required/optional:
Returns:	The controller_error_mode of this Controller.
Return type:	str
	required

controller_ref¶

Gets the controller_ref of this Controller. The identifier value for this controller. Other objects may use this reference value to refer to the controller.

Required/optional:
Returns:	The controller_ref of this Controller.
Return type:	str
	required

ctrl_ioc_dump_data¶

Gets the ctrl_ioc_dump_data of this Controller. This structure contains information regarding the state of an IOC data dump – if it needs to be retrieved, and the tag and timestamp of the dump.

Required/optional:
Returns:	The ctrl_ioc_dump_data of this Controller.
Return type:	CtrlIOCDumpData
	required

drive_interfaces¶

Gets the drive_interfaces of this Controller. An array containing one entry for each drive-side I/O interface that is present on the controller. A “drive interface” is the controller’s means of accessing the drive I/O channel. On the drive side, each channel is associated with two interfaces, one on each controller, giving each controller access to the same set of drive channels. Although this array is indexed starting at zero, drive channels can be numbered one through n, per storage array (not per controller).

Required/optional:
Returns:	The drive_interfaces of this Controller.
Return type:	list[IOInterfaceTypeData]
	required

flash_cache_memory_size¶

Gets the flash_cache_memory_size of this Controller. The total flash cache memory size (in GB) currently in use on the controller.

Required/optional:
Returns:	The flash_cache_memory_size of this Controller.
Return type:	int
	required

has_tray_identity_indicator¶

Gets the has_tray_identity_indicator of this Controller. The device contains 7-segment indicators used to display the Tray Identity.

Required/optional:
Returns:	The has_tray_identity_indicator of this Controller.
Return type:	bool
	required

host_board_id¶

Gets the host_board_id of this Controller. The board ID of the controller’s host card. This field is deprecated. The hostBoardId field in the HostBoard structure should be used instead.

Required/optional:
Returns:	The host_board_id of this Controller.
Return type:	str
	required

host_interfaces¶

Gets the host_interfaces of this Controller. An array containing one entry for each host-side I/O interface that is present on the controller. A “host interface” is the controller’s means of accessing the host I/O channel; each host interface has a one-to-one relationship to a host channel. Although this array is indexed starting at zero, host channels in SYMbol are numbered starting at one. Host channels are numbered one through n per controller, without regard to different channel I/O protocols. Note that an interface may be physically present, but disabled for the particular controller model - in such a case, the corresponding channel is skipped over in the channel numbering.

Required/optional:
Returns:	The host_interfaces of this Controller.
Return type:	list[IOInterfaceTypeData]
	required

id¶

Gets the id of this Controller.

Required/optional:
Returns:	The id of this Controller.
Return type:	str
	optional

inventory¶

Gets the inventory of this Controller. This array of structures is deprecated.

Required/optional:
Returns:	The inventory of this Controller.
Return type:	list[InventoryItem]
	required

locate_in_progress¶

Gets the locate_in_progress of this Controller. Indicates that a locate operation for the device is currently active. The device will show a visual indication to aid an operator in locating the tray.

Required/optional:
Returns:	The locate_in_progress of this Controller.
Return type:	bool
	required

manufacturer¶

Gets the manufacturer of this Controller. The variable-length ASCII text string that identifies the controller manufacturer.

Required/optional:
Returns:	The manufacturer of this Controller.
Return type:	str
	required

manufacturer_date¶

Gets the manufacturer_date of this Controller. The date of manufacture of the controller, represented in seconds since midnight GMT on January 1, 1970.

Required/optional:
Returns:	The manufacturer_date of this Controller.
Return type:	int
	required

model_name¶

Gets the model_name of this Controller. The model name associated with the controller. A model name is an identifier that is associated with each unique combination of base controller board and host interface card(s).

Required/optional:
Returns:	The model_name of this Controller.
Return type:	str
	required

net_interfaces¶

Gets the net_interfaces of this Controller. An array containing one entry for each network interface that is present on the controller.

Required/optional:
Returns:	The net_interfaces of this Controller.
Return type:	list[NetInterfaceTypeData]
	required

network_settings¶

Gets the network_settings of this Controller. A collection of network-related settings that apply to this controller.

Required/optional:
Returns:	The network_settings of this Controller.
Return type:	ControllerNetworkSettings
	required

oem_part_number¶

Gets the oem_part_number of this Controller. The OEM-specified part number of the controller canister

Required/optional:
Returns:	The oem_part_number of this Controller.
Return type:	str
	required

part_number¶

Gets the part_number of this Controller. The part number of the controller board itself.

Required/optional:
Returns:	The part_number of this Controller.
Return type:	str
	required

physical_cache_memory_size¶

Gets the physical_cache_memory_size of this Controller. The physical cache memory size in MB

Required/optional:
Returns:	The physical_cache_memory_size of this Controller.
Return type:	int
	required

physical_location¶

Gets the physical_location of this Controller. The physical location of the controller. The parent reference in Location identifies the tray that physically houses the controller, and the position field is the parent-relative/like-component relative slot number of the controller, starting at one.

Required/optional:
Returns:	The physical_location of this Controller.
Return type:	Location
	required

processor_memory_size¶

Gets the processor_memory_size of this Controller. The size of the controller’s CPU memory, in MB.

Required/optional:
Returns:	The processor_memory_size of this Controller.
Return type:	int
	required

product_id¶

Gets the product_id of this Controller. The variable-length ASCII text string that identifies the product by name, as assigned by the manufacturer.

Required/optional:
Returns:	The product_id of this Controller.
Return type:	str
	required

product_rev_level¶

Gets the product_rev_level of this Controller. The product revision level.

Required/optional:
Returns:	The product_rev_level of this Controller.
Return type:	str
	required

quiesced¶

Gets the quiesced of this Controller. True if the controller is quiesced.

Required/optional:
Returns:	The quiesced of this Controller.
Return type:	bool
	required

ready_to_remove¶

Gets the ready_to_remove of this Controller. This is set to True if the component is ready to remove (and the Ready To Remove LED is on). This field is deprecated. The rtrAttributes field should be used instead.

Required/optional:
Returns:	The ready_to_remove of this Controller.
Return type:	bool
	required

repair_policy¶

Gets the repair_policy of this Controller. The repair policy for the controller.

Required/optional:
Returns:	The repair_policy of this Controller.
Return type:	RepairPolicy
	required

reserved1¶

Gets the reserved1 of this Controller.

Required/optional:
Returns:	The reserved1 of this Controller.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this Controller.

Required/optional:
Returns:	The reserved2 of this Controller.
Return type:	str
	optional

rtr_attributes¶

Gets the rtr_attributes of this Controller. The CRU type of the controller plus its ready-to-remove attributes, which are based on the CRU type.

Required/optional:
Returns:	The rtr_attributes of this Controller.
Return type:	RTRAttributes
	required

serial_number¶

Gets the serial_number of this Controller. The variable-length ASCII text string for the serial number of the controller.

Required/optional:
Returns:	The serial_number of this Controller.
Return type:	str
	required

status¶

Gets the status of this Controller. An indication of the current status of the controller.

Required/optional:
Returns:	The status of this Controller.
Return type:	str
	required

submodel_supported¶

Gets the submodel_supported of this Controller. Set to true if the sub-model feature is supported

Required/optional:
Returns:	The submodel_supported of this Controller.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.controller_counter_group module¶

ControllerCounterGroup.py

class netapp.santricity.models.symbol.controller_counter_group.ControllerCounterGroup[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

base_time¶

Gets the base_time of this ControllerCounterGroup. Time the counters were last reset. Time is the number of seconds since midnight, January 1, 1970.

Required/optional:
Returns:	The base_time of this ControllerCounterGroup.
Return type:	int
	required

cache_hits_bytes_total¶

Gets the cache_hits_bytes_total of this ControllerCounterGroup. Total number of bytes that hit cache.

Required/optional:
Returns:	The cache_hits_bytes_total of this ControllerCounterGroup.
Return type:	int
	required

cache_hits_iops_total¶

Gets the cache_hits_iops_total of this ControllerCounterGroup. Total number of IO operations that hit cache.

Required/optional:
Returns:	The cache_hits_iops_total of this ControllerCounterGroup.
Return type:	int
	required

controller_ref¶

Gets the controller_ref of this ControllerCounterGroup. Controller that generated this group.

Required/optional:
Returns:	The controller_ref of this ControllerCounterGroup.
Return type:	str
	required

cpu_utilization_stats¶

Gets the cpu_utilization_stats of this ControllerCounterGroup. CPU utilization statistics structure.

Required/optional:
Returns:	The cpu_utilization_stats of this ControllerCounterGroup.
Return type:	list[CpuUtilizationStats]
	required

ddp_bytes_transferred¶

Gets the ddp_bytes_transferred of this ControllerCounterGroup. Bytes transferred that are categorized as DDP transfers.

Required/optional:
Returns:	The ddp_bytes_transferred of this ControllerCounterGroup.
Return type:	int
	required

full_stripe_writes_bytes¶

Gets the full_stripe_writes_bytes of this ControllerCounterGroup. Bytes written that are categorized as Full stripe writes.

Required/optional:
Returns:	The full_stripe_writes_bytes of this ControllerCounterGroup.
Return type:	int
	required

max_possible_bps_under_current_load¶

Gets the max_possible_bps_under_current_load of this ControllerCounterGroup. Theoretical maximum possible Bytes per second under current load.

Required/optional:
Returns:	The max_possible_bps_under_current_load of this ControllerCounterGroup.
Return type:	int
	required

max_possible_iops_under_current_load¶

Gets the max_possible_iops_under_current_load of this ControllerCounterGroup. Theoretical maximum possible IO per second under current load.

Required/optional:
Returns:	The max_possible_iops_under_current_load of this ControllerCounterGroup.
Return type:	int
	required

mirror_bytes_total¶

Gets the mirror_bytes_total of this ControllerCounterGroup. Total number of Bytes serviced by the controller that are characterized as cache mirroring related. If cache mirroring is disabled, this counter will not have any value.

Required/optional:
Returns:	The mirror_bytes_total of this ControllerCounterGroup.
Return type:	int
	required

mirror_iops_total¶

Gets the mirror_iops_total of this ControllerCounterGroup. Total number of IO operations serviced by the controller that are characterized as cache mirroring related. If cache mirroring is disabled, this counter will not have any value.

Required/optional:
Returns:	The mirror_iops_total of this ControllerCounterGroup.
Return type:	int
	required

observed_time¶

Gets the observed_time of this ControllerCounterGroup. End time for this collection as measured by the number of seconds since baseTime.

Required/optional:
Returns:	The observed_time of this ControllerCounterGroup.
Return type:	int
	required

raid0_bytes_transferred¶

Gets the raid0_bytes_transferred of this ControllerCounterGroup. Bytes transferred that are categorized as RAID 0 transfers.

Required/optional:
Returns:	The raid0_bytes_transferred of this ControllerCounterGroup.
Return type:	int
	required

raid1_bytes_transferred¶

Gets the raid1_bytes_transferred of this ControllerCounterGroup. Bytes transferred that are categorized as RAID 1 transfers.

Required/optional:
Returns:	The raid1_bytes_transferred of this ControllerCounterGroup.
Return type:	int
	required

raid5_bytes_transferred¶

Gets the raid5_bytes_transferred of this ControllerCounterGroup. Bytes transferred that are categorized as RAID 5 transfers.

Required/optional:
Returns:	The raid5_bytes_transferred of this ControllerCounterGroup.
Return type:	int
	required

raid6_bytes_transferred¶

Gets the raid6_bytes_transferred of this ControllerCounterGroup. Bytes transferred that are categorized as RAID 6 transfers.

Required/optional:
Returns:	The raid6_bytes_transferred of this ControllerCounterGroup.
Return type:	int
	required

random_bytes_total¶

Gets the random_bytes_total of this ControllerCounterGroup. Total number of Bytes that are categorized as random.

Required/optional:
Returns:	The random_bytes_total of this ControllerCounterGroup.
Return type:	int
	required

random_ios_total¶

Gets the random_ios_total of this ControllerCounterGroup. Total number of IOs that are categorized as random.

Required/optional:
Returns:	The random_ios_total of this ControllerCounterGroup.
Return type:	int
	required

read_bytes_total¶

Gets the read_bytes_total of this ControllerCounterGroup. Total number of Bytes read.

Required/optional:
Returns:	The read_bytes_total of this ControllerCounterGroup.
Return type:	int
	required

read_iops_total¶

Gets the read_iops_total of this ControllerCounterGroup. Total number of Read IO operations.

Required/optional:
Returns:	The read_iops_total of this ControllerCounterGroup.
Return type:	int
	required

start_time¶

Gets the start_time of this ControllerCounterGroup. Start time for this collection as measured by the number of seconds since baseTime.

Required/optional:
Returns:	The start_time of this ControllerCounterGroup.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

total_bytes_serviced¶

Gets the total_bytes_serviced of this ControllerCounterGroup. Total number of Bytes serviced by the controller.

Required/optional:
Returns:	The total_bytes_serviced of this ControllerCounterGroup.
Return type:	int
	required

total_iops_serviced¶

Gets the total_iops_serviced of this ControllerCounterGroup. Total number of IO operations serviced by the controller.

Required/optional:
Returns:	The total_iops_serviced of this ControllerCounterGroup.
Return type:	int
	required

write_bytes_total¶

Gets the write_bytes_total of this ControllerCounterGroup. Total number of Bytes written.

Required/optional:
Returns:	The write_bytes_total of this ControllerCounterGroup.
Return type:	int
	required

write_iops_total¶

Gets the write_iops_total of this ControllerCounterGroup. Total number of Write IO operations.

Required/optional:
Returns:	The write_iops_total of this ControllerCounterGroup.
Return type:	int
	required

netapp.santricity.models.symbol.controller_descriptor module¶

ControllerDescriptor.py

class netapp.santricity.models.symbol.controller_descriptor.ControllerDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_ref¶

Gets the controller_ref of this ControllerDescriptor. The reference value that uniquely identifies the controller within its own storage array.

Required/optional:
Returns:	The controller_ref of this ControllerDescriptor.
Return type:	str
	required

sa_id¶

Gets the sa_id of this ControllerDescriptor. The storage array identifier that uniquely identifies a particular storage array that contains the desired target controller.

Required/optional:
Returns:	The sa_id of this ControllerDescriptor.
Return type:	SAIdentifier
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.controller_dns_properties module¶

ControllerDNSProperties.py

class netapp.santricity.models.symbol.controller_dns_properties.ControllerDNSProperties[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

acquisition_properties¶

Gets the acquisition_properties of this ControllerDNSProperties. DNS server acquisition properties

Required/optional:
Returns:	The acquisition_properties of this ControllerDNSProperties.
Return type:	DnsAcquisitionDescriptor
	required

dhcp_acquired_dns_servers¶

Gets the dhcp_acquired_dns_servers of this ControllerDNSProperties. DNS servers provided by the DHCP responses. Will be non-empty only if at least one of the Controller’s network ports is set to acquire its address via DHCP and the DHCP response included one or more DNS servers to use. The presence of these servers does not imply their use. These DNS servers will only be used if the acquisition type is set to DHCP.

Required/optional:
Returns:	The dhcp_acquired_dns_servers of this ControllerDNSProperties.
Return type:	list[IpVxAddress]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.controller_gbic module¶

ControllerGBIC.py

class netapp.santricity.models.symbol.controller_gbic.ControllerGBIC[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this ControllerGBIC. The channel number that this GBIC is associated with.

Required/optional:
Returns:	The channel of this ControllerGBIC.
Return type:	int
	required

controller_gbic_type¶

Gets the controller_gbic_type of this ControllerGBIC. Interface (host/drive) to which the GBIC belongs.

Required/optional:
Returns:	The controller_gbic_type of this ControllerGBIC.
Return type:	str
	required

parent_controller¶

Gets the parent_controller of this ControllerGBIC. Information on the controller associated with the GBIC.

Required/optional:
Returns:	The parent_controller of this ControllerGBIC.
Return type:	str
	required

reserved1¶

Gets the reserved1 of this ControllerGBIC.

Required/optional:
Returns:	The reserved1 of this ControllerGBIC.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this ControllerGBIC.

Required/optional:
Returns:	The reserved2 of this ControllerGBIC.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.controller_host_io_interfaces_returned module¶

ControllerHostIoInterfacesReturned.py

class netapp.santricity.models.symbol.controller_host_io_interfaces_returned.ControllerHostIoInterfacesReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_host_io_interfaces¶

Gets the controller_host_io_interfaces of this ControllerHostIoInterfacesReturned. A variable-length array of IoInterface structures populated with the most-recent data for each controller host-side I/O interface. This field is only valid if the value of the discriminator returnCode is RETCODE_OK.

Required/optional:
Returns:	The controller_host_io_interfaces of this ControllerHostIoInterfacesReturned.
Return type:	list[IoInterface]
	optional

return_code¶

Gets the return_code of this ControllerHostIoInterfacesReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this ControllerHostIoInterfacesReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.controller_miswire_error module¶

ControllerMiswireError.py

class netapp.santricity.models.symbol.controller_miswire_error.ControllerMiswireError[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

port_ref_a¶

Gets the port_ref_a of this ControllerMiswireError. A reference to one of the drive channel ports involved in a controller miswire.

Required/optional:
Returns:	The port_ref_a of this ControllerMiswireError.
Return type:	str
	required

port_ref_b¶

Gets the port_ref_b of this ControllerMiswireError. A reference to one of the drive channel ports involved in a controller miswire.

Required/optional:
Returns:	The port_ref_b of this ControllerMiswireError.
Return type:	str
	required

port_refs¶

Gets the port_refs of this ControllerMiswireError. The two drive channel ports on one controller that are participating in the miswire condition.

Required/optional:
Returns:	The port_refs of this ControllerMiswireError.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.controller_network_settings module¶

ControllerNetworkSettings.py

class netapp.santricity.models.symbol.controller_network_settings.ControllerNetworkSettings[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

dns_properties¶

Gets the dns_properties of this ControllerNetworkSettings. DNS configuration information.

Required/optional:
Returns:	The dns_properties of this ControllerNetworkSettings.
Return type:	ControllerDNSProperties
	required

ipv4_default_router_address¶

Gets the ipv4_default_router_address of this ControllerNetworkSettings. The IPV4 static default router address for the controller (sometimes referred to as the “gateway address”).

Required/optional:
Returns:	The ipv4_default_router_address of this ControllerNetworkSettings.
Return type:	str
	required

ipv6_candidate_default_router_addresses¶

Gets the ipv6_candidate_default_router_addresses of this ControllerNetworkSettings. The set of IPV6 candidate default router addresses for the controller.

Required/optional:
Returns:	The ipv6_candidate_default_router_addresses of this ControllerNetworkSettings.
Return type:	list[IpV6AddressData]
	required

ipv6_default_router_address¶

Gets the ipv6_default_router_address of this ControllerNetworkSettings. The IPV6 static default router address and associated data for the controller.

Required/optional:
Returns:	The ipv6_default_router_address of this ControllerNetworkSettings.
Return type:	IpV6AddressData
	required

ntp_properties¶

Gets the ntp_properties of this ControllerNetworkSettings. NTP configuration information.

Required/optional:
Returns:	The ntp_properties of this ControllerNetworkSettings.
Return type:	ControllerNTPProperties
	required

remote_access_enabled¶

Gets the remote_access_enabled of this ControllerNetworkSettings. True if enabled for remote access

Required/optional:
Returns:	The remote_access_enabled of this ControllerNetworkSettings.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.controller_ntp_error_details module¶

ControllerNtpErrorDetails.py

class netapp.santricity.models.symbol.controller_ntp_error_details.ControllerNtpErrorDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

domain_name¶

Gets the domain_name of this ControllerNtpErrorDetails. The domain name of the NTP server

Required/optional:
Returns:	The domain_name of this ControllerNtpErrorDetails.
Return type:	str
	required

ntp_error_controller¶

Gets the ntp_error_controller of this ControllerNtpErrorDetails. The controller attempting to obtain an NTP time spec

Required/optional:
Returns:	The ntp_error_controller of this ControllerNtpErrorDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.controller_ntp_properties module¶

ControllerNTPProperties.py

class netapp.santricity.models.symbol.controller_ntp_properties.ControllerNTPProperties[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

acquisition_properties¶

Gets the acquisition_properties of this ControllerNTPProperties. NTP server acquisition properties

Required/optional:
Returns:	The acquisition_properties of this ControllerNTPProperties.
Return type:	NtpAcquisitionDescriptor
	required

dhcp_acquired_ntp_servers¶

Gets the dhcp_acquired_ntp_servers of this ControllerNTPProperties. NTP servers provided by the DHCP responses. Will be non-empty only if at least one of the Controller’s network ports is set to acquire its address via DHCP and the DHCP response included one or more NTP servers. The presence of these servers does not imply their use. These NTP servers will only be used if the NTP acquisition type is set to DHCP.

Required/optional:
Returns:	The dhcp_acquired_ntp_servers of this ControllerNTPProperties.
Return type:	list[IpVxAddress]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.controller_sfp module¶

ControllerSFP.py

class netapp.santricity.models.symbol.controller_sfp.ControllerSFP[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this ControllerSFP. The channel the SFP is associated with.

Required/optional:
Returns:	The channel of this ControllerSFP.
Return type:	int
	required

controller_sfp_type¶

Gets the controller_sfp_type of this ControllerSFP. The interface (host/drive) to which the SFP belongs.

Required/optional:
Returns:	The controller_sfp_type of this ControllerSFP.
Return type:	str
	required

parent_controller¶

Gets the parent_controller of this ControllerSFP. The controller to which the SFP belongs.

Required/optional:
Returns:	The parent_controller of this ControllerSFP.
Return type:	str
	required

reserved1¶

Gets the reserved1 of this ControllerSFP.

Required/optional:
Returns:	The reserved1 of this ControllerSFP.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this ControllerSFP.

Required/optional:
Returns:	The reserved2 of this ControllerSFP.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.controller_sfp_location module¶

ControllerSfpLocation.py

class netapp.santricity.models.symbol.controller_sfp_location.ControllerSfpLocation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this ControllerSfpLocation. The channel type.

Required/optional:
Returns:	The channel of this ControllerSfpLocation.
Return type:	int
	required

channel_type¶

Gets the channel_type of this ControllerSfpLocation. The channel type.

Required/optional:
Returns:	The channel_type of this ControllerSfpLocation.
Return type:	str
	required

controller_slot¶

Gets the controller_slot of this ControllerSfpLocation. The slot number of the controller, 1 or 2

Required/optional:
Returns:	The controller_slot of this ControllerSfpLocation.
Return type:	int
	required

sfp_port¶

Gets the sfp_port of this ControllerSfpLocation. The number of the SFP port on the channel, 1-based.

Required/optional:
Returns:	The sfp_port of this ControllerSfpLocation.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.controller_time module¶

ControllerTime.py

class netapp.santricity.models.symbol.controller_time.ControllerTime[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_a_time¶

Gets the controller_a_time of this ControllerTime. Time from controller A

Required/optional:
Returns:	The controller_a_time of this ControllerTime.
Return type:	int
	required

controller_b_time¶

Gets the controller_b_time of this ControllerTime. Time from controller B

Required/optional:
Returns:	The controller_b_time of this ControllerTime.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.controller_volume_list module¶

ControllerVolumeList.py

class netapp.santricity.models.symbol.controller_volume_list.ControllerVolumeList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_ref¶

Gets the controller_ref of this ControllerVolumeList. The controller.

Required/optional:
Returns:	The controller_ref of this ControllerVolumeList.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this ControllerVolumeList. The list of volumes.

Required/optional:
Returns:	The volume_ref of this ControllerVolumeList.
Return type:	list[str]
	required

netapp.santricity.models.symbol.controller_with_dirty_cache_details module¶

ControllerWithDirtyCacheDetails.py

class netapp.santricity.models.symbol.controller_with_dirty_cache_details.ControllerWithDirtyCacheDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_ref¶

Gets the controller_ref of this ControllerWithDirtyCacheDetails. This field contains the identification of the controller that fails to flush dirty cache data on failed volume(s) possibly due to offlined drives. The controller should not be replaced to avoid loss of data.

Required/optional:
Returns:	The controller_ref of this ControllerWithDirtyCacheDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.copy_then_replace_descriptor module¶

CopyThenReplaceDescriptor.py

class netapp.santricity.models.symbol.copy_then_replace_descriptor.CopyThenReplaceDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_to_replace¶

Gets the drive_to_replace of this CopyThenReplaceDescriptor. The drive to be replaced.

Required/optional:
Returns:	The drive_to_replace of this CopyThenReplaceDescriptor.
Return type:	str
	required

fail_after_evacuate¶

Gets the fail_after_evacuate of this CopyThenReplaceDescriptor. This flag indicates what the state of the source drive should be after the evacuation is complete. True means the source drive’s Availability state should be set to FAILED after successful evacuation; False means the state should not change.

Required/optional:
Returns:	The fail_after_evacuate of this CopyThenReplaceDescriptor.
Return type:	bool
	required

replacement_drive¶

Gets the replacement_drive of this CopyThenReplaceDescriptor. A reference to the replacement drive.

Required/optional:
Returns:	The replacement_drive of this CopyThenReplaceDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.counter_group module¶

CounterGroup.py

class netapp.santricity.models.symbol.counter_group.CounterGroup[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_counter_group¶

Gets the controller_counter_group of this CounterGroup. The ControllerCounterGroup tracks statistics at the controller level and are not specific to a volume, interface or drive. These fields include the CPU utilization, total numbers of reads, writes, and non-read/write commands, and cache mirroring statistics. The ObjectReference must be a ControllerRef.

Required/optional:
Returns:	The controller_counter_group of this CounterGroup.
Return type:	ControllerCounterGroup
	optional

drv_counter_group¶

Gets the drv_counter_group of this CounterGroup. Drive-related statistical counters. This field is only present if groupType is equal to COUNTER_GROUP_DRIVE.

Required/optional:
Returns:	The drv_counter_group of this CounterGroup.
Return type:	DriveCounterGroup
	optional

group_type¶

Gets the group_type of this CounterGroup. This enumeration type identifies the different types of counter group statistics that are provided by the controller firmware.

Required/optional:
Returns:	The group_type of this CounterGroup.
Return type:	str
	required

impl_counter_group¶

Gets the impl_counter_group of this CounterGroup. RAID-implementation-related statistical counters. This field is only present if groupType is equal to COUNTER_GROUP_IMPLEMENTATION.

Required/optional:
Returns:	The impl_counter_group of this CounterGroup.
Return type:	ImplementationCounterGroup
	optional

interface_counter_group¶

Gets the interface_counter_group of this CounterGroup. The InterfaceCounterGroup tracks statistics on a per channel level. This group reports the type of channel, its channel number, and the read, write and other operation counters. It also reports queue depth statistics.

Required/optional:
Returns:	The interface_counter_group of this CounterGroup.
Return type:	InterfaceCounterGroup
	optional

io_counter_group¶

Gets the io_counter_group of this CounterGroup. I/O-operation-related statistical counters. This field is only present if the groupType is equal to COUNTER_GROUP_IO

Required/optional:
Returns:	The io_counter_group of this CounterGroup.
Return type:	IoCounterGroup
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

vol_counter_group¶

Gets the vol_counter_group of this CounterGroup. Volume-related statistical counters. This field is only present if groupType is equal to COUNTER_GROUP_VOLUME.

Required/optional:
Returns:	The vol_counter_group of this CounterGroup.
Return type:	VolumeCounterGroup
	optional

netapp.santricity.models.symbol.cpu_utilization_stats module¶

CpuUtilizationStats.py

class netapp.santricity.models.symbol.cpu_utilization_stats.CpuUtilizationStats[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

max_cpu_utilization¶

Gets the max_cpu_utilization of this CpuUtilizationStats. Max utilization stats value from CPU.

Required/optional:
Returns:	The max_cpu_utilization of this CpuUtilizationStats.
Return type:	int
	required

ssq_cpu_utilization¶

Gets the ssq_cpu_utilization of this CpuUtilizationStats. Sum of squares of utilization stats values from CPU.

Required/optional:
Returns:	The ssq_cpu_utilization of this CpuUtilizationStats.
Return type:	int
	required

sum_cpu_utilization¶

Gets the sum_cpu_utilization of this CpuUtilizationStats. Sum of utilization stats values from CPU.

Required/optional:
Returns:	The sum_cpu_utilization of this CpuUtilizationStats.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ctrl_ioc_dump_data module¶

CtrlIOCDumpData.py

class netapp.santricity.models.symbol.ctrl_ioc_dump_data.CtrlIOCDumpData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ioc_dump_needs_retrieved¶

Gets the ioc_dump_needs_retrieved of this CtrlIOCDumpData. If true, an IOC Dump currently exists in controller memory and has not been retrieved.

Required/optional:
Returns:	The ioc_dump_needs_retrieved of this CtrlIOCDumpData.
Return type:	bool
	required

ioc_dump_tag¶

Gets the ioc_dump_tag of this CtrlIOCDumpData. The tag value of the IOC Dump currently in controller memory. Each dump has a unique tag value. A value of IOC_DUMP_NULL_TAG indicates there is no IOC Dump to retrieve.

Required/optional:
Returns:	The ioc_dump_tag of this CtrlIOCDumpData.
Return type:	int
	required

time_stamp¶

Gets the time_stamp of this CtrlIOCDumpData. The time that the dump was collected measured in seconds since midnight GMT on January 1, 1970.

Required/optional:
Returns:	The time_stamp of this CtrlIOCDumpData.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.cumulative_statistics_bundle module¶

CumulativeStatisticsBundle.py

class netapp.santricity.models.symbol.cumulative_statistics_bundle.CumulativeStatisticsBundle[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

are_more_stats_available¶

Gets the are_more_stats_available of this CumulativeStatisticsBundle. When True, indicates more stats data available beyond the specified observation time in controller memory.

Required/optional:
Returns:	The are_more_stats_available of this CumulativeStatisticsBundle.
Return type:	bool
	required

bundle_end_time¶

Gets the bundle_end_time of this CumulativeStatisticsBundle. The end time of the accrued samples within this stats bundle. Time is the number of seconds since bundleStartTime.

Required/optional:
Returns:	The bundle_end_time of this CumulativeStatisticsBundle.
Return type:	int
	required

bundle_start_time¶

Gets the bundle_start_time of this CumulativeStatisticsBundle. The end time of the accrued samples within this stats bundle. Time is the number of seconds since midnight, January 1, 1970.

Required/optional:
Returns:	The bundle_start_time of this CumulativeStatisticsBundle.
Return type:	int
	required

counter_group¶

Gets the counter_group of this CumulativeStatisticsBundle. An array of counter groups, one group per controller.

Required/optional:
Returns:	The counter_group of this CumulativeStatisticsBundle.
Return type:	list[CounterGroup]
	required

object_ref¶

Gets the object_ref of this CumulativeStatisticsBundle. A reference to the object to which the statistics bundle applies.

Required/optional:
Returns:	The object_ref of this CumulativeStatisticsBundle.
Return type:	ObjectReference
	required

observation_time¶

Gets the observation_time of this CumulativeStatisticsBundle. The time that the statistics bundle was retrieved. Time is the number of seconds since midnight, January 1, 1970.

Required/optional:
Returns:	The observation_time of this CumulativeStatisticsBundle.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.cumulative_statistics_bundle_list_returned module¶

CumulativeStatisticsBundleListReturned.py

class netapp.santricity.models.symbol.cumulative_statistics_bundle_list_returned.CumulativeStatisticsBundleListReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

return_code¶

Gets the return_code of this CumulativeStatisticsBundleListReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this CumulativeStatisticsBundleListReturned.
Return type:	str
	required

stat_bundle¶

Gets the stat_bundle of this CumulativeStatisticsBundleListReturned. A list of bundles of statistical data. This field is present only if the value of returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The stat_bundle of this CumulativeStatisticsBundleListReturned.
Return type:	list[CumulativeStatisticsBundle]
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.cumulative_statistics_bundle_returned module¶

CumulativeStatisticsBundleReturned.py

class netapp.santricity.models.symbol.cumulative_statistics_bundle_returned.CumulativeStatisticsBundleReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

return_code¶

Gets the return_code of this CumulativeStatisticsBundleReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this CumulativeStatisticsBundleReturned.
Return type:	str
	required

stat_bundle¶

Gets the stat_bundle of this CumulativeStatisticsBundleReturned. The requested bundle of statistical data. This field is only valid if returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The stat_bundle of this CumulativeStatisticsBundleReturned.
Return type:	CumulativeStatisticsBundle
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.cumulative_statistics_default_attributes module¶

CumulativeStatisticsDefaultAttributes.py

class netapp.santricity.models.symbol.cumulative_statistics_default_attributes.CumulativeStatisticsDefaultAttributes[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

high_resolution_period¶

Gets the high_resolution_period of this CumulativeStatisticsDefaultAttributes. Duration, in seconds, for high resolution statistics samples to be saved.

Required/optional:
Returns:	The high_resolution_period of this CumulativeStatisticsDefaultAttributes.
Return type:	int
	required

low_high_sampling_supported¶

Gets the low_high_sampling_supported of this CumulativeStatisticsDefaultAttributes. If true, the CFW supports the low and high resolution sampling.

Required/optional:
Returns:	The low_high_sampling_supported of this CumulativeStatisticsDefaultAttributes.
Return type:	bool
	required

low_resolution_period¶

Gets the low_resolution_period of this CumulativeStatisticsDefaultAttributes. Duration, in seconds, for low resolution statistics samples to be saved.

Required/optional:
Returns:	The low_resolution_period of this CumulativeStatisticsDefaultAttributes.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.cumulative_statistics_descriptor module¶

CumulativeStatisticsDescriptor.py

class netapp.santricity.models.symbol.cumulative_statistics_descriptor.CumulativeStatisticsDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

data_location¶

Gets the data_location of this CumulativeStatisticsDescriptor. Location of counter group data to be returned.

Required/optional:
Returns:	The data_location of this CumulativeStatisticsDescriptor.
Return type:	str
	required

group_type¶

Gets the group_type of this CumulativeStatisticsDescriptor. The type of counter group to be returned.

Required/optional:
Returns:	The group_type of this CumulativeStatisticsDescriptor.
Return type:	str
	required

object_ref¶

Gets the object_ref of this CumulativeStatisticsDescriptor. A reference to the storage array object (e.g., volume, drive, ets.) for which counters are to be returned.

Required/optional:
Returns:	The object_ref of this CumulativeStatisticsDescriptor.
Return type:	ObjectReference
	required

statistics_resolution¶

Gets the statistics_resolution of this CumulativeStatisticsDescriptor. Identifies if the resolution is low or high.

Required/optional:
Returns:	The statistics_resolution of this CumulativeStatisticsDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.cumulative_statistics_list_descriptor module¶

CumulativeStatisticsListDescriptor.py

class netapp.santricity.models.symbol.cumulative_statistics_list_descriptor.CumulativeStatisticsListDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

data_location¶

Gets the data_location of this CumulativeStatisticsListDescriptor. Location of counter group data to be returned.

Required/optional:
Returns:	The data_location of this CumulativeStatisticsListDescriptor.
Return type:	str
	required

group_type¶

Gets the group_type of this CumulativeStatisticsListDescriptor. The type of counter group to be returned.

Required/optional:
Returns:	The group_type of this CumulativeStatisticsListDescriptor.
Return type:	str
	required

object_ref¶

Gets the object_ref of this CumulativeStatisticsListDescriptor. A list of references to the storage array objects (e.g., volumes, drives, etc.) for which counters are to be returned.

Required/optional:
Returns:	The object_ref of this CumulativeStatisticsListDescriptor.
Return type:	list[ObjectReference]
	required

statistics_resolution¶

Gets the statistics_resolution of this CumulativeStatisticsListDescriptor. Identifies if low or high resolution.

Required/optional:
Returns:	The statistics_resolution of this CumulativeStatisticsListDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.daily_schedule module¶

DailySchedule.py

class netapp.santricity.models.symbol.daily_schedule.DailySchedule[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

every_n_minutes¶

Gets the every_n_minutes of this DailySchedule. Interval between schedules if timesPerDay is greater than 1.

Required/optional:
Returns:	The every_n_minutes of this DailySchedule.
Return type:	int
	required

time_of_day¶

Gets the time_of_day of this DailySchedule. The number of seconds after midnight local time for the first occurrence during the day.

Required/optional:
Returns:	The time_of_day of this DailySchedule.
Return type:	int
	required

times_per_day¶

Gets the times_per_day of this DailySchedule. The number of occurrences during the day based on everyNMinutes, including the first occurrence.

Required/optional:
Returns:	The times_per_day of this DailySchedule.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.database_metadata module¶

DatabaseMetadata.py

class netapp.santricity.models.symbol.database_metadata.DatabaseMetadata[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

meta_data_list¶

Gets the meta_data_list of this DatabaseMetadata. A list of specific database metadata.

Required/optional:
Returns:	The meta_data_list of this DatabaseMetadata.
Return type:	list[SpecificDatabaseMetadata]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.database_metadata_returned module¶

DatabaseMetadataReturned.py

class netapp.santricity.models.symbol.database_metadata_returned.DatabaseMetadataReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

database_data¶

Gets the database_data of this DatabaseMetadataReturned. Database metadata is returned only if the ReturnCode equals RETCODE_OK.

Required/optional:
Returns:	The database_data of this DatabaseMetadataReturned.
Return type:	DatabaseMetadata
	optional

return_code¶

Gets the return_code of this DatabaseMetadataReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this DatabaseMetadataReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.daylight_savings_time module¶

DaylightSavingsTime.py

class netapp.santricity.models.symbol.daylight_savings_time.DaylightSavingsTime[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

clock_mode¶

Gets the clock_mode of this DaylightSavingsTime. Reference for time.

Required/optional:
Returns:	The clock_mode of this DaylightSavingsTime.
Return type:	str
	required

day_of_month¶

Gets the day_of_month of this DaylightSavingsTime. Day of month: 0 to 31 (and negatives).

Required/optional:
Returns:	The day_of_month of this DaylightSavingsTime.
Return type:	int
	required

day_of_week¶

Gets the day_of_week of this DaylightSavingsTime. Day of week: 0 to 7 (and negatives).

Required/optional:
Returns:	The day_of_week of this DaylightSavingsTime.
Return type:	int
	required

month¶

Gets the month of this DaylightSavingsTime. Month value: 0 to 12 (and negatives).

Required/optional:
Returns:	The month of this DaylightSavingsTime.
Return type:	int
	required

time¶

Gets the time of this DaylightSavingsTime. Time of day for DST change measured as seconds past midnight.

Required/optional:
Returns:	The time of this DaylightSavingsTime.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.dbm_blk_restore_chunk_details module¶

DbmBlkRestoreChunkDetails.py

class netapp.santricity.models.symbol.dbm_blk_restore_chunk_details.DbmBlkRestoreChunkDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

block_data¶

Gets the block_data of this DbmBlkRestoreChunkDetails. An array of block data.

Required/optional:
Returns:	The block_data of this DbmBlkRestoreChunkDetails.
Return type:	str
	required

block_size¶

Gets the block_size of this DbmBlkRestoreChunkDetails. The size of each dbm block (sector).

Required/optional:
Returns:	The block_size of this DbmBlkRestoreChunkDetails.
Return type:	int
	required

chunk_crc¶

Gets the chunk_crc of this DbmBlkRestoreChunkDetails. CRC data.

Required/optional:
Returns:	The chunk_crc of this DbmBlkRestoreChunkDetails.
Return type:	int
	required

sstor_lba¶

Gets the sstor_lba of this DbmBlkRestoreChunkDetails. An array identifying the block addresses of the blocks whose data resides in the blockData array

Required/optional:
Returns:	The sstor_lba of this DbmBlkRestoreChunkDetails.
Return type:	list[int]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.dbm_blk_restore_start_details module¶

DbmBlkRestoreStartDetails.py

class netapp.santricity.models.symbol.dbm_blk_restore_start_details.DbmBlkRestoreStartDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

validator¶

Gets the validator of this DbmBlkRestoreStartDetails. Ensures the DBM image is valid for this array.

Required/optional:
Returns:	The validator of this DbmBlkRestoreStartDetails.
Return type:	str
	required

netapp.santricity.models.symbol.dbm_blk_retrieve_chunk_details module¶

DbmBlkRetrieveChunkDetails.py

class netapp.santricity.models.symbol.dbm_blk_retrieve_chunk_details.DbmBlkRetrieveChunkDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

block_consistency_check¶

Gets the block_consistency_check of this DbmBlkRetrieveChunkDetails. indicates whether the overall retrieval process is based on a DBM image containing one or more mirror consistency mismatches.

Required/optional:
Returns:	The block_consistency_check of this DbmBlkRetrieveChunkDetails.
Return type:	str
	required

block_data¶

Gets the block_data of this DbmBlkRetrieveChunkDetails. An array of block data.

Required/optional:
Returns:	The block_data of this DbmBlkRetrieveChunkDetails.
Return type:	str
	required

block_size¶

Gets the block_size of this DbmBlkRetrieveChunkDetails. The size of each DBM block (sector).

Required/optional:
Returns:	The block_size of this DbmBlkRetrieveChunkDetails.
Return type:	int
	required

chunk_crc¶

Gets the chunk_crc of this DbmBlkRetrieveChunkDetails. CRC data.

Required/optional:
Returns:	The chunk_crc of this DbmBlkRetrieveChunkDetails.
Return type:	int
	required

source_location¶

Gets the source_location of this DbmBlkRetrieveChunkDetails. Defines which storage device to read the image from. Repeated here to ensure all chunks were read from the same place.

Required/optional:
Returns:	The source_location of this DbmBlkRetrieveChunkDetails.
Return type:	str
	required

sstor_lba¶

Gets the sstor_lba of this DbmBlkRetrieveChunkDetails. An array identifying the block addresses of the blocks whose data resides in the blockData array

Required/optional:
Returns:	The sstor_lba of this DbmBlkRetrieveChunkDetails.
Return type:	list[int]
	required

structure_integrity_check¶

Gets the structure_integrity_check of this DbmBlkRetrieveChunkDetails. Indicates whether the overall image has a structural fault or if the integrity wasn’t checked prior to retrieval.

Required/optional:
Returns:	The structure_integrity_check of this DbmBlkRetrieveChunkDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.dbm_blk_retrieve_start_details module¶

DbmBlkRetrieveStartDetails.py

class netapp.santricity.models.symbol.dbm_blk_retrieve_start_details.DbmBlkRetrieveStartDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

omit_unallocated_blocks¶

Gets the omit_unallocated_blocks of this DbmBlkRetrieveStartDetails. When true, unallocated blocks are omitted from the retrieved data.

Required/optional:
Returns:	The omit_unallocated_blocks of this DbmBlkRetrieveStartDetails.
Return type:	bool
	required

skip_block_coherency_check¶

Gets the skip_block_coherency_check of this DbmBlkRetrieveStartDetails. When true, the block coherency check is not performed during the preparation phase of the data transfer.

Required/optional:
Returns:	The skip_block_coherency_check of this DbmBlkRetrieveStartDetails.
Return type:	bool
	required

skip_structure_integrity_check¶

Gets the skip_structure_integrity_check of this DbmBlkRetrieveStartDetails. When true, the structure integrity check is not performed during the preparation phase of the data transfer.

Required/optional:
Returns:	The skip_structure_integrity_check of this DbmBlkRetrieveStartDetails.
Return type:	bool
	required

source_location¶

Gets the source_location of this DbmBlkRetrieveStartDetails. Defines which storage device to read the image from.

Required/optional:
Returns:	The source_location of this DbmBlkRetrieveStartDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.dbm_check_retrieve_chunk_details module¶

DbmCheckRetrieveChunkDetails.py

class netapp.santricity.models.symbol.dbm_check_retrieve_chunk_details.DbmCheckRetrieveChunkDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

block_data¶

Gets the block_data of this DbmCheckRetrieveChunkDetails. An array of opaque data fields will be returned.

Required/optional:
Returns:	The block_data of this DbmCheckRetrieveChunkDetails.
Return type:	str
	required

source_location¶

Gets the source_location of this DbmCheckRetrieveChunkDetails. Specifies which storage device contains the image to be checked.

Required/optional:
Returns:	The source_location of this DbmCheckRetrieveChunkDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

validation_status¶

Gets the validation_status of this DbmCheckRetrieveChunkDetails. If the consistency check is successful, this field will be set to DBM_VALIDATION_OK, otherwise it will contain a specific failure code. The returnCode field in RawDataRetrieveResult will always be set to RETCODE_OK.

Required/optional:
Returns:	The validation_status of this DbmCheckRetrieveChunkDetails.
Return type:	str
	required

netapp.santricity.models.symbol.dbm_check_retrieve_start_details module¶

DbmCheckRetrieveStartDetails.py

class netapp.santricity.models.symbol.dbm_check_retrieve_start_details.DbmCheckRetrieveStartDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

perform_block_consistency_check¶

Gets the perform_block_consistency_check of this DbmCheckRetrieveStartDetails. When true, a block consistency check will be performed.

Required/optional:
Returns:	The perform_block_consistency_check of this DbmCheckRetrieveStartDetails.
Return type:	bool
	required

perform_client_consistency_check¶

Gets the perform_client_consistency_check of this DbmCheckRetrieveStartDetails. When true, a check of the record contents will be performed by the owner of the record type.

Required/optional:
Returns:	The perform_client_consistency_check of this DbmCheckRetrieveStartDetails.
Return type:	bool
	required

perform_logical_consistency_check¶

Gets the perform_logical_consistency_check of this DbmCheckRetrieveStartDetails. When true, a logical consistency check will be performed.

Required/optional:
Returns:	The perform_logical_consistency_check of this DbmCheckRetrieveStartDetails.
Return type:	bool
	required

source_location¶

Gets the source_location of this DbmCheckRetrieveStartDetails. Specifies which storage device contains the image to be checked.

Required/optional:
Returns:	The source_location of this DbmCheckRetrieveStartDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.dbm_rec_restore_chunk_details module¶

DbmRecRestoreChunkDetails.py

class netapp.santricity.models.symbol.dbm_rec_restore_chunk_details.DbmRecRestoreChunkDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

chunk_data¶

Gets the chunk_data of this DbmRecRestoreChunkDetails. The data chunk.

Required/optional:
Returns:	The chunk_data of this DbmRecRestoreChunkDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.dbm_rec_restore_start_details module¶

DbmRecRestoreStartDetails.py

class netapp.santricity.models.symbol.dbm_rec_restore_start_details.DbmRecRestoreStartDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

config_type¶

Gets the config_type of this DbmRecRestoreStartDetails. Which record type to restore.

Required/optional:
Returns:	The config_type of this DbmRecRestoreStartDetails.
Return type:	str
	required

skip_mismatch_check¶

Gets the skip_mismatch_check of this DbmRecRestoreStartDetails. If true, then skip any checks to certify that the image being restored from matches this array.

Required/optional:
Returns:	The skip_mismatch_check of this DbmRecRestoreStartDetails.
Return type:	bool
	required

source_location¶

Gets the source_location of this DbmRecRestoreStartDetails. The storage medium containing the restore source image.

Required/optional:
Returns:	The source_location of this DbmRecRestoreStartDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

total_image_size¶

Gets the total_image_size of this DbmRecRestoreStartDetails. Contains the size of the entire restore image.

Required/optional:
Returns:	The total_image_size of this DbmRecRestoreStartDetails.
Return type:	int
	required

validator¶

Gets the validator of this DbmRecRestoreStartDetails. A hash of the controller serial numbers.

Required/optional:
Returns:	The validator of this DbmRecRestoreStartDetails.
Return type:	str
	required

netapp.santricity.models.symbol.dbm_rec_retrieve_chunk_details module¶

DbmRecRetrieveChunkDetails.py

class netapp.santricity.models.symbol.dbm_rec_retrieve_chunk_details.DbmRecRetrieveChunkDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

chunk_data¶

Gets the chunk_data of this DbmRecRetrieveChunkDetails. The data chunk.

Required/optional:
Returns:	The chunk_data of this DbmRecRetrieveChunkDetails.
Return type:	str
	required

config_gen¶

Gets the config_gen of this DbmRecRetrieveChunkDetails. The value of the configuration gen number when the image was retrieved.

Required/optional:
Returns:	The config_gen of this DbmRecRetrieveChunkDetails.
Return type:	int
	required

config_type¶

Gets the config_type of this DbmRecRetrieveChunkDetails. Which record types to check.

Required/optional:
Returns:	The config_type of this DbmRecRetrieveChunkDetails.
Return type:	str
	required

source_location¶

Gets the source_location of this DbmRecRetrieveChunkDetails. Defines which storage device to read the image from. Repeated here to ensure all chunks were read from the same place.

Required/optional:
Returns:	The source_location of this DbmRecRetrieveChunkDetails.
Return type:	str
	required

structure_integrity_check¶

Gets the structure_integrity_check of this DbmRecRetrieveChunkDetails. Indicates whether the overall image has a structural fault or if the integrity wasn’t checked prior to retrieval.

Required/optional:
Returns:	The structure_integrity_check of this DbmRecRetrieveChunkDetails.
Return type:	str
	required

timestamp¶

Gets the timestamp of this DbmRecRetrieveChunkDetails. Indicates when the image was retrieved.

Required/optional:
Returns:	The timestamp of this DbmRecRetrieveChunkDetails.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

total_image_size¶

Gets the total_image_size of this DbmRecRetrieveChunkDetails. The size of the image that will be retrieved.

Required/optional:
Returns:	The total_image_size of this DbmRecRetrieveChunkDetails.
Return type:	int
	required

netapp.santricity.models.symbol.dbm_rec_retrieve_start_details module¶

DbmRecRetrieveStartDetails.py

class netapp.santricity.models.symbol.dbm_rec_retrieve_start_details.DbmRecRetrieveStartDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

config_type¶

Gets the config_type of this DbmRecRetrieveStartDetails. Defines which set of record types to read.

Required/optional:
Returns:	The config_type of this DbmRecRetrieveStartDetails.
Return type:	str
	required

skip_structure_integrity_check¶

Gets the skip_structure_integrity_check of this DbmRecRetrieveStartDetails. When true, the structure integrity check is skipped during the preparation phase of the data transfer.

Required/optional:
Returns:	The skip_structure_integrity_check of this DbmRecRetrieveStartDetails.
Return type:	bool
	required

source_location¶

Gets the source_location of this DbmRecRetrieveStartDetails. Defines which storage device to read the image from.

Required/optional:
Returns:	The source_location of this DbmRecRetrieveStartDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.dcbx_summary_data module¶

DCBXSummaryData.py

class netapp.santricity.models.symbol.dcbx_summary_data.DCBXSummaryData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

enabled¶

Gets the enabled of this DCBXSummaryData. This is the status of the given priority number.

Required/optional:
Returns:	The enabled of this DCBXSummaryData.
Return type:	bool
	required

link_bandwidth_percentage¶

Gets the link_bandwidth_percentage of this DCBXSummaryData. This object contains the percentage of the link band-width assigned to the given priority group ID.

Required/optional:
Returns:	The link_bandwidth_percentage of this DCBXSummaryData.
Return type:	int
	required

priority¶

Gets the priority of this DCBXSummaryData. This object contains a priority number (0 - TLV_MAX_PROTOCOL_ENTRIES) assigned to the given protocol type.

Required/optional:
Returns:	The priority of this DCBXSummaryData.
Return type:	int
	required

priority_group_id¶

Gets the priority_group_id of this DCBXSummaryData. This object contains a priority group ID assigned to the given priority number.

Required/optional:
Returns:	The priority_group_id of this DCBXSummaryData.
Return type:	int
	required

protocol_type¶

Gets the protocol_type of this DCBXSummaryData. This enumeration contains the known Ethernet Protocol types currently negotiated via DCBX.

Required/optional:
Returns:	The protocol_type of this DCBXSummaryData.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ddc_extent module¶

DdcExtent.py

class netapp.santricity.models.symbol.ddc_extent.DdcExtent[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

chunk_number¶

Gets the chunk_number of this DdcExtent. The number of the DDC chunk that the client wants to retrieve. The number of the first chunk is one.

Required/optional:
Returns:	The chunk_number of this DdcExtent.
Return type:	int
	required

controller_ref¶

Gets the controller_ref of this DdcExtent. A SYMbol reference identifying the controller that has the desired DDC log data.

Required/optional:
Returns:	The controller_ref of this DdcExtent.
Return type:	str
	required

ddc_tag¶

Gets the ddc_tag of this DdcExtent. The tag associated with the DDC data set being transferred.

Required/optional:
Returns:	The ddc_tag of this DdcExtent.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ddc_log_data module¶

DdcLogData.py

class netapp.santricity.models.symbol.ddc_log_data.DdcLogData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

last_chunk¶

Gets the last_chunk of this DdcLogData. True if this is the last chunk in the series.

Required/optional:
Returns:	The last_chunk of this DdcLogData.
Return type:	bool
	required

log_data¶

Gets the log_data of this DdcLogData. The DDC data for this chunk.

Required/optional:
Returns:	The log_data of this DdcLogData.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ddc_log_data_returned module¶

DdcLogDataReturned.py

class netapp.santricity.models.symbol.ddc_log_data_returned.DdcLogDataReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ddc_log_data¶

Gets the ddc_log_data of this DdcLogDataReturned. This field contains the returned log data. It is present only when the returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The ddc_log_data of this DdcLogDataReturned.
Return type:	DdcLogData
	optional

return_code¶

Gets the return_code of this DdcLogDataReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this DdcLogDataReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.debug_info module¶

DebugInfo.py

class netapp.santricity.models.symbol.debug_info.DebugInfo[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

debug_chunk_data¶

Gets the debug_chunk_data of this DebugInfo. An actual chunk of debug data.

Required/optional:
Returns:	The debug_chunk_data of this DebugInfo.
Return type:	str
	required

handle¶

Gets the handle of this DebugInfo. The handle representing the collection of debug information extents for a particular controller.

Required/optional:
Returns:	The handle of this DebugInfo.
Return type:	str
	required

next_chunk_to_retrieve¶

Gets the next_chunk_to_retrieve of this DebugInfo. The extent (chunk) to start with on next request.

Required/optional:
Returns:	The next_chunk_to_retrieve of this DebugInfo.
Return type:	int
	required

number_of_chunks¶

Gets the number_of_chunks of this DebugInfo. Number of extents in the collection.

Required/optional:
Returns:	The number_of_chunks of this DebugInfo.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.debug_info_extent module¶

DebugInfoExtent.py

class netapp.santricity.models.symbol.debug_info_extent.DebugInfoExtent[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

chunk_number¶

Gets the chunk_number of this DebugInfoExtent. The number of the “chunk” of debug information to return. Note that chunk number zero has special significance - see structure DebugInfo.

Required/optional:
Returns:	The chunk_number of this DebugInfoExtent.
Return type:	int
	required

controller¶

Gets the controller of this DebugInfoExtent. A reference to the controller from which the extent is requested.

Required/optional:
Returns:	The controller of this DebugInfoExtent.
Return type:	str
	required

handle¶

Gets the handle of this DebugInfoExtent. A controller-assigned identifier of a mutually-consistent collection of debug information extents. On the initial call (chunkNumber = 0), the handle is not significant.

Required/optional:
Returns:	The handle of this DebugInfoExtent.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.debug_info_returned module¶

DebugInfoReturned.py

class netapp.santricity.models.symbol.debug_info_returned.DebugInfoReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

debug_info¶

Gets the debug_info of this DebugInfoReturned. The returned debug information. This field is only valid when returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The debug_info of this DebugInfoReturned.
Return type:	DebugInfo
	optional

return_code¶

Gets the return_code of this DebugInfoReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this DebugInfoReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.degraded_path module¶

DegradedPath.py

class netapp.santricity.models.symbol.degraded_path.DegradedPath[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this DegradedPath. The channel reference.

Required/optional:
Returns:	The channel of this DegradedPath.
Return type:	int
	required

drives¶

Gets the drives of this DegradedPath. The drive reference.

Required/optional:
Returns:	The drives of this DegradedPath.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.discovery_response module¶

DiscoveryResponse.py

class netapp.santricity.models.symbol.discovery_response.DiscoveryResponse[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

agent_id¶

Gets the agent_id of this DiscoveryResponse. A global identifier of the responding agent. Note that this value will not be set if the response is from a direct network-attached RAID controller instead of an agent.

Required/optional:
Returns:	The agent_id of this DiscoveryResponse.
Return type:	str
	required

controllers¶

Gets the controllers of this DiscoveryResponse. This field contains a variable-length array of AccessibleController objects. There is one element for each controller that can be reached through the entity that is responding to the request.

Required/optional:
Returns:	The controllers of this DiscoveryResponse.
Return type:	list[AccessibleController]
	required

response_from_agent¶

Gets the response_from_agent of this DiscoveryResponse. A true value in this field indicates that the response was generated by a SYMbol agent; a false value indicates that the response is from a direct network-attached RAID controller.

Required/optional:
Returns:	The response_from_agent of this DiscoveryResponse.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.discrete_time_series module¶

DiscreteTimeSeries.py

class netapp.santricity.models.symbol.discrete_time_series.DiscreteTimeSeries[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_ref¶

Gets the controller_ref of this DiscreteTimeSeries. A reference to the controller that provided the statistics.

Required/optional:
Returns:	The controller_ref of this DiscreteTimeSeries.
Return type:	str
	required

series¶

Gets the series of this DiscreteTimeSeries. The array of observations.

Required/optional:
Returns:	The series of this DiscreteTimeSeries.
Return type:	list[int]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

wrap_count¶

Gets the wrap_count of this DiscreteTimeSeries. The number of times the controller memory buffer for holding the observations has wrapped before being retrieved by the client.

Required/optional:
Returns:	The wrap_count of this DiscreteTimeSeries.
Return type:	int
	required

netapp.santricity.models.symbol.discrete_time_series_bundle module¶

DiscreteTimeSeriesBundle.py

class netapp.santricity.models.symbol.discrete_time_series_bundle.DiscreteTimeSeriesBundle[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

dts¶

Gets the dts of this DiscreteTimeSeriesBundle. An array of discrete time series streams, one stream per controller.

Required/optional:
Returns:	The dts of this DiscreteTimeSeriesBundle.
Return type:	list[DiscreteTimeSeries]
	required

object_ref¶

Gets the object_ref of this DiscreteTimeSeriesBundle. A reference to the object to which the discrete time series applies.

Required/optional:
Returns:	The object_ref of this DiscreteTimeSeriesBundle.
Return type:	ObjectReference
	required

observation_time¶

Gets the observation_time of this DiscreteTimeSeriesBundle. The time that the discrete time series was retrieved. Time is the number of seconds since midnight, January 1, 1970.

Required/optional:
Returns:	The observation_time of this DiscreteTimeSeriesBundle.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.discrete_time_series_bundle_returned module¶

DiscreteTimeSeriesBundleReturned.py

class netapp.santricity.models.symbol.discrete_time_series_bundle_returned.DiscreteTimeSeriesBundleReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

dts_bundle¶

Gets the dts_bundle of this DiscreteTimeSeriesBundleReturned. The data comprising the discrete time series statistical streams. This field is only valid if returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The dts_bundle of this DiscreteTimeSeriesBundleReturned.
Return type:	DiscreteTimeSeriesBundle
	optional

return_code¶

Gets the return_code of this DiscreteTimeSeriesBundleReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this DiscreteTimeSeriesBundleReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.discrete_time_series_descriptor module¶

DiscreteTimeSeriesDescriptor.py

class netapp.santricity.models.symbol.discrete_time_series_descriptor.DiscreteTimeSeriesDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

duration¶

Gets the duration of this DiscreteTimeSeriesDescriptor. The amount of time, expressed in seconds, to spend recording observations. If the discrete time series is not retrieved by the client before the end of the duration, the stream wraps around, i.e., observations will be overwritten.

Required/optional:
Returns:	The duration of this DiscreteTimeSeriesDescriptor.
Return type:	int
	required

object_ref¶

Gets the object_ref of this DiscreteTimeSeriesDescriptor. A reference to the storage array object (e.g., volume, drive, ets.) to observe.

Required/optional:
Returns:	The object_ref of this DiscreteTimeSeriesDescriptor.
Return type:	ObjectReference
	required

stream_type¶

Gets the stream_type of this DiscreteTimeSeriesDescriptor. The type of statistic to observe in the activated stream.

Required/optional:
Returns:	The stream_type of this DiscreteTimeSeriesDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.disk_pool_creation_descriptor module¶

DiskPoolCreationDescriptor.py

class netapp.santricity.models.symbol.disk_pool_creation_descriptor.DiskPoolCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

background_operation_priority¶

Gets the background_operation_priority of this DiskPoolCreationDescriptor. Priority of other background operations (DVE,DCE,DCR, and IAF).

Required/optional:
Returns:	The background_operation_priority of this DiskPoolCreationDescriptor.
Return type:	str
	required

candidate¶

Gets the candidate of this DiskPoolCreationDescriptor. This field must contain a Volume candidate that was returned by getVolumeCandidates.

Required/optional:
Returns:	The candidate of this DiskPoolCreationDescriptor.
Return type:	VolumeCandidate
	required

critical_reconstruct_priority¶

Gets the critical_reconstruct_priority of this DiskPoolCreationDescriptor. Two failed drive reconstruction critical priority.

Required/optional:
Returns:	The critical_reconstruct_priority of this DiskPoolCreationDescriptor.
Return type:	str
	required

degraded_reconstruct_priority¶

Gets the degraded_reconstruct_priority of this DiskPoolCreationDescriptor. One failed drive degraded reconstruction priority.

Required/optional:
Returns:	The degraded_reconstruct_priority of this DiskPoolCreationDescriptor.
Return type:	str
	required

label¶

Gets the label of this DiskPoolCreationDescriptor. The label string for the new Volume Group.

Required/optional:
Returns:	The label of this DiskPoolCreationDescriptor.
Return type:	str
	required

pool_utilization_critical_threshold¶

Gets the pool_utilization_critical_threshold of this DiskPoolCreationDescriptor. The pool utilization critical threshold as a percentage of the total user configurable capacity. A MEL event is generated when the configured capacity exceeds the specified level of the configurable capacity.

Required/optional:
Returns:	The pool_utilization_critical_threshold of this DiskPoolCreationDescriptor.
Return type:	int
	required

pool_utilization_warning_threshold¶

Gets the pool_utilization_warning_threshold of this DiskPoolCreationDescriptor. The pool utilization warning capacity as a percentage of the total user configurable capacity. A MEL event is generated when the configured capacity exceeds the specified level of the configurable capacity.

Required/optional:
Returns:	The pool_utilization_warning_threshold of this DiskPoolCreationDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.disk_pool_data module¶

DiskPoolData.py

class netapp.santricity.models.symbol.disk_pool_data.DiskPoolData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

alloc_granularity¶

Gets the alloc_granularity of this DiskPoolData. The allocation granularity (in bytes) for volumes in a disk pool.

Required/optional:
Returns:	The alloc_granularity of this DiskPoolData.
Return type:	int
	required

background_operation_priority¶

Gets the background_operation_priority of this DiskPoolData. Priority of other background operations (DVE,DCE,DCR, and IAF).

Required/optional:
Returns:	The background_operation_priority of this DiskPoolData.
Return type:	str
	required

critical_reconstruct_priority¶

Gets the critical_reconstruct_priority of this DiskPoolData. Two failed drive reconstruction critical priority.

Required/optional:
Returns:	The critical_reconstruct_priority of this DiskPoolData.
Return type:	str
	required

degraded_reconstruct_priority¶

Gets the degraded_reconstruct_priority of this DiskPoolData. One failed drive degraded reconstruction priority.

Required/optional:
Returns:	The degraded_reconstruct_priority of this DiskPoolData.
Return type:	str
	required

pool_utilization_critical_threshold¶

Gets the pool_utilization_critical_threshold of this DiskPoolData. The pool utilization critical threshold as a percentage of the total user configurable capacity. A MEL event is generated when the configured capacity exceeds the specified level of the configurable capacity.

Required/optional:
Returns:	The pool_utilization_critical_threshold of this DiskPoolData.
Return type:	int
	required

pool_utilization_state¶

Gets the pool_utilization_state of this DiskPoolData. The Disk pool state set based on state of the threshold.

Required/optional:
Returns:	The pool_utilization_state of this DiskPoolData.
Return type:	str
	required

pool_utilization_warning_threshold¶

Gets the pool_utilization_warning_threshold of this DiskPoolData. The pool utilization warning threshold as a percentage of the total user configurable capacity. A MEL event is generated when the configured capacity exceeds the specified level of the configurable capacity.

Required/optional:
Returns:	The pool_utilization_warning_threshold of this DiskPoolData.
Return type:	int
	required

reconstruction_reserved_amt¶

Gets the reconstruction_reserved_amt of this DiskPoolData. The pool capacity reserved to hold rebuild data (in bytes). This value is calculated from the reconstructionReservedDriveCount.

Required/optional:
Returns:	The reconstruction_reserved_amt of this DiskPoolData.
Return type:	int
	required

reconstruction_reserved_drive_count¶

Gets the reconstruction_reserved_drive_count of this DiskPoolData. The number of drives reserved for reconstruction of failed drives.

Required/optional:
Returns:	The reconstruction_reserved_drive_count of this DiskPoolData.
Return type:	int
	required

reconstruction_reserved_drive_count_current¶

Gets the reconstruction_reserved_drive_count_current of this DiskPoolData. The reserved capacity that is currently available to hold rebuilt data (dynamic). If all of the reserved capacity is available, then this value will equal the reconstructionReservedDriveCount.

Required/optional:
Returns:	The reconstruction_reserved_drive_count_current of this DiskPoolData.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

unusable_capacity¶

Gets the unusable_capacity of this DiskPoolData. This value identifies how much capacity (in bytes) is being wasted due to a mix of drive sizes. This value will be zero as long as the pool consists of like drive sizes.

Required/optional:
Returns:	The unusable_capacity of this DiskPoolData.
Return type:	int
	required

netapp.santricity.models.symbol.disk_pool_default_attributes module¶

DiskPoolDefaultAttributes.py

class netapp.santricity.models.symbol.disk_pool_default_attributes.DiskPoolDefaultAttributes[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

background_operation_priority¶

Gets the background_operation_priority of this DiskPoolDefaultAttributes. Priority of other background operations (DVE,DCE,DCR, and IAF).

Required/optional:
Returns:	The background_operation_priority of this DiskPoolDefaultAttributes.
Return type:	str
	required

critical_reconstruct_priority¶

Gets the critical_reconstruct_priority of this DiskPoolDefaultAttributes. Two failed drive reconstruction critical priority.

Required/optional:
Returns:	The critical_reconstruct_priority of this DiskPoolDefaultAttributes.
Return type:	str
	required

degraded_reconstruct_priority¶

Gets the degraded_reconstruct_priority of this DiskPoolDefaultAttributes. One failed drive degraded reconstruction priority.

Required/optional:
Returns:	The degraded_reconstruct_priority of this DiskPoolDefaultAttributes.
Return type:	str
	required

max_dce_drive_count¶

Gets the max_dce_drive_count of this DiskPoolDefaultAttributes. The maximum number of drives that can be used for Dynamic Capacity Expansion (DCE).

Required/optional:
Returns:	The max_dce_drive_count of this DiskPoolDefaultAttributes.
Return type:	int
	required

max_total_disk_pool_support_in_megabytes¶

Gets the max_total_disk_pool_support_in_megabytes of this DiskPoolDefaultAttributes. The maximum total size for all disk pools.

Required/optional:
Returns:	The max_total_disk_pool_support_in_megabytes of this DiskPoolDefaultAttributes.
Return type:	int
	required

max_volume_size_in_megabytes¶

Gets the max_volume_size_in_megabytes of this DiskPoolDefaultAttributes. The maximum volume size (in megabytes) for disk pools.

Required/optional:
Returns:	The max_volume_size_in_megabytes of this DiskPoolDefaultAttributes.
Return type:	int
	required

max_volume_synchronous_creation_in_megabytes¶

Gets the max_volume_synchronous_creation_in_megabytes of this DiskPoolDefaultAttributes. Volumes with a capacity this size or smaller are created synchronously (i.e. the volume definition is complete when the SYMbol command completes). Larger volumes are completed as a background operation. The state of the volume after the SYMbol command completes is “creating” until the background operation completes.

Required/optional:
Returns:	The max_volume_synchronous_creation_in_megabytes of this DiskPoolDefaultAttributes.
Return type:	int
	required

pool_utilization_critical_threshold¶

Gets the pool_utilization_critical_threshold of this DiskPoolDefaultAttributes. The pool utilization critical threshold as a percentage of the total user configurable capacity. A MEL event is generated when the configured capacity exceeds the specified level of the configurable capacity.

Required/optional:
Returns:	The pool_utilization_critical_threshold of this DiskPoolDefaultAttributes.
Return type:	int
	required

pool_utilization_warning_threshold¶

Gets the pool_utilization_warning_threshold of this DiskPoolDefaultAttributes. The pool utilization warning threshold as a percentage of the total user configurable capacity. A MEL event is generated when the configured capacity exceeds the specified level of the configurable capacity.

Required/optional:
Returns:	The pool_utilization_warning_threshold of this DiskPoolDefaultAttributes.
Return type:	int
	required

repos_granularity¶

Gets the repos_granularity of this DiskPoolDefaultAttributes. The granularity (in bytes) of the volume capacity values that are allowed for any repository member volume allocated from disk pools.

Required/optional:
Returns:	The repos_granularity of this DiskPoolDefaultAttributes.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.disk_pool_expansion_descriptor module¶

DiskPoolExpansionDescriptor.py

class netapp.santricity.models.symbol.disk_pool_expansion_descriptor.DiskPoolExpansionDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_ref¶

Gets the drive_ref of this DiskPoolExpansionDescriptor. The drives to be used for expansion.

Required/optional:
Returns:	The drive_ref of this DiskPoolExpansionDescriptor.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_group_ref¶

Gets the volume_group_ref of this DiskPoolExpansionDescriptor. The disk pool being expanded.

Required/optional:
Returns:	The volume_group_ref of this DiskPoolExpansionDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.disk_pool_max_reserved_drive_count_return module¶

DiskPoolMaxReservedDriveCountReturn.py

class netapp.santricity.models.symbol.disk_pool_max_reserved_drive_count_return.DiskPoolMaxReservedDriveCountReturn[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

count¶

Gets the count of this DiskPoolMaxReservedDriveCountReturn. This field is present only if the value of returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The count of this DiskPoolMaxReservedDriveCountReturn.
Return type:	int
	optional

return_code¶

Gets the return_code of this DiskPoolMaxReservedDriveCountReturn. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this DiskPoolMaxReservedDriveCountReturn.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.disk_pool_priority_update_descriptor module¶

DiskPoolPriorityUpdateDescriptor.py

class netapp.santricity.models.symbol.disk_pool_priority_update_descriptor.DiskPoolPriorityUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

new_priority_value¶

Gets the new_priority_value of this DiskPoolPriorityUpdateDescriptor. The new priority value.

Required/optional:
Returns:	The new_priority_value of this DiskPoolPriorityUpdateDescriptor.
Return type:	str
	required

priority_type¶

Gets the priority_type of this DiskPoolPriorityUpdateDescriptor. The Disk Pool priority type to set.

Required/optional:
Returns:	The priority_type of this DiskPoolPriorityUpdateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_group_ref¶

Gets the volume_group_ref of this DiskPoolPriorityUpdateDescriptor. A reference to the Disk Pool.

Required/optional:
Returns:	The volume_group_ref of this DiskPoolPriorityUpdateDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.disk_pool_reduction_descriptor module¶

DiskPoolReductionDescriptor.py

class netapp.santricity.models.symbol.disk_pool_reduction_descriptor.DiskPoolReductionDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_ref¶

Gets the drive_ref of this DiskPoolReductionDescriptor. The drives to be removed.

Required/optional:
Returns:	The drive_ref of this DiskPoolReductionDescriptor.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_group_ref¶

Gets the volume_group_ref of this DiskPoolReductionDescriptor. The disk pool undergoing the capacity reduction.

Required/optional:
Returns:	The volume_group_ref of this DiskPoolReductionDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.disk_pool_reduction_drive_count_return module¶

DiskPoolReductionDriveCountReturn.py

class netapp.santricity.models.symbol.disk_pool_reduction_drive_count_return.DiskPoolReductionDriveCountReturn[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

count¶

Gets the count of this DiskPoolReductionDriveCountReturn. The maximum number of drives that can be removed from a disk pool. This field is returned if the value of returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The count of this DiskPoolReductionDriveCountReturn.
Return type:	int
	optional

return_code¶

Gets the return_code of this DiskPoolReductionDriveCountReturn. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this DiskPoolReductionDriveCountReturn.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.disk_pool_reserved_drive_count_update_descriptor module¶

DiskPoolReservedDriveCountUpdateDescriptor.py

class netapp.santricity.models.symbol.disk_pool_reserved_drive_count_update_descriptor.DiskPoolReservedDriveCountUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

new_drive_count¶

Gets the new_drive_count of this DiskPoolReservedDriveCountUpdateDescriptor. The new reserved drive count.

Required/optional:
Returns:	The new_drive_count of this DiskPoolReservedDriveCountUpdateDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_group_ref¶

Gets the volume_group_ref of this DiskPoolReservedDriveCountUpdateDescriptor. A reference to the Disk Pool.

Required/optional:
Returns:	The volume_group_ref of this DiskPoolReservedDriveCountUpdateDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.disk_pool_threshold_update_descriptor module¶

DiskPoolThresholdUpdateDescriptor.py

class netapp.santricity.models.symbol.disk_pool_threshold_update_descriptor.DiskPoolThresholdUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

new_threshold_value¶

Gets the new_threshold_value of this DiskPoolThresholdUpdateDescriptor. The new threshold value.

Required/optional:
Returns:	The new_threshold_value of this DiskPoolThresholdUpdateDescriptor.
Return type:	int
	required

threshold_type¶

Gets the threshold_type of this DiskPoolThresholdUpdateDescriptor. The type of threshold to set.

Required/optional:
Returns:	The threshold_type of this DiskPoolThresholdUpdateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_group_ref¶

Gets the volume_group_ref of this DiskPoolThresholdUpdateDescriptor. A reference to the Disk Pool.

Required/optional:
Returns:	The volume_group_ref of this DiskPoolThresholdUpdateDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.disk_pool_volume_candidate_data module¶

DiskPoolVolumeCandidateData.py

class netapp.santricity.models.symbol.disk_pool_volume_candidate_data.DiskPoolVolumeCandidateData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

reconstruction_reserved_amt¶

Gets the reconstruction_reserved_amt of this DiskPoolVolumeCandidateData. The pool capacity reserved to hold rebuild data (in bytes). This value is calculated from the reconstructionReservedDriveCount.

Required/optional:
Returns:	The reconstruction_reserved_amt of this DiskPoolVolumeCandidateData.
Return type:	int
	required

reconstruction_reserved_drive_count¶

Gets the reconstruction_reserved_drive_count of this DiskPoolVolumeCandidateData. The number of drives reserved for reconstruction of failed drives.

Required/optional:
Returns:	The reconstruction_reserved_drive_count of this DiskPoolVolumeCandidateData.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

unusable_capacity¶

Gets the unusable_capacity of this DiskPoolVolumeCandidateData. This value identifies how much capacity (in bytes) is being wasted due to a mix of drive sizes. This value will be zero as long as the pool consists of like drive sizes.

Required/optional:
Returns:	The unusable_capacity of this DiskPoolVolumeCandidateData.
Return type:	int
	required

netapp.santricity.models.symbol.disk_pool_volume_candidate_request_data module¶

DiskPoolVolumeCandidateRequestData.py

class netapp.santricity.models.symbol.disk_pool_volume_candidate_request_data.DiskPoolVolumeCandidateRequestData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

reconstruction_reserved_drive_count¶

Gets the reconstruction_reserved_drive_count of this DiskPoolVolumeCandidateRequestData. The number of drives reserved for reconstruction of failed drives.

Required/optional:
Returns:	The reconstruction_reserved_drive_count of this DiskPoolVolumeCandidateRequestData.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.dns_acquisition_descriptor module¶

DnsAcquisitionDescriptor.py

class netapp.santricity.models.symbol.dns_acquisition_descriptor.DnsAcquisitionDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

dns_acquisition_type¶

Gets the dns_acquisition_type of this DnsAcquisitionDescriptor. How the DNS addresses were acquired.

Required/optional:
Returns:	The dns_acquisition_type of this DnsAcquisitionDescriptor.
Return type:	str
	required

dns_servers¶

Gets the dns_servers of this DnsAcquisitionDescriptor. This field is used if the method is set to DNS_ACQUISITION_METHOD_STATIC. If more than one address is specified, the first (lowest index) item is given highest precedence and the last item (highest index) is given the lowest precedence.

Required/optional:
Returns:	The dns_servers of this DnsAcquisitionDescriptor.
Return type:	list[IpVxAddress]
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.dom0_support_data_chunk_details module¶

Dom0SupportDataChunkDetails.py

class netapp.santricity.models.symbol.dom0_support_data_chunk_details.Dom0SupportDataChunkDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

dom0_data_chunk¶

Gets the dom0_data_chunk of this Dom0SupportDataChunkDetails. Contains the Dom0 support data chunk.

Required/optional:
Returns:	The dom0_data_chunk of this Dom0SupportDataChunkDetails.
Return type:	str
	required

dom0_support_data_type¶

Gets the dom0_support_data_type of this Dom0SupportDataChunkDetails. Sepcified which type of support data we’re processing.

Required/optional:
Returns:	The dom0_support_data_type of this Dom0SupportDataChunkDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.dom0_support_data_journal_start_details module¶

Dom0SupportDataJournalStartDetails.py

class netapp.santricity.models.symbol.dom0_support_data_journal_start_details.Dom0SupportDataJournalStartDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

start_time¶

Gets the start_time of this Dom0SupportDataJournalStartDetails. Describes the time to start collecting the journal logs based on seconds since 1/1/1970.

Required/optional:
Returns:	The start_time of this Dom0SupportDataJournalStartDetails.
Return type:	int
	required

stop_time¶

Gets the stop_time of this Dom0SupportDataJournalStartDetails. Describes the time to stop collecting the journal logs based on seconds since 1/1/1970.

Required/optional:
Returns:	The stop_time of this Dom0SupportDataJournalStartDetails.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.dom0_support_data_start_details module¶

Dom0SupportDataStartDetails.py

class netapp.santricity.models.symbol.dom0_support_data_start_details.Dom0SupportDataStartDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

dom0_support_data_journal_start_details¶

Gets the dom0_support_data_journal_start_details of this Dom0SupportDataStartDetails. This is only valid when the Dom0 support data type is DOM0_SUPPORT_DATA_JOURNAL_LOGS

Required/optional:
Returns:	The dom0_support_data_journal_start_details of this Dom0SupportDataStartDetails.
Return type:	Dom0SupportDataJournalStartDetails
	optional

support_data_type¶

Gets the support_data_type of this Dom0SupportDataStartDetails. Enumerates the types of support data that can be retrieved from Dom0

Required/optional:
Returns:	The support_data_type of this Dom0SupportDataStartDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.dpl_core_dump_data module¶

DPLCoreDumpData.py

class netapp.santricity.models.symbol.dpl_core_dump_data.DPLCoreDumpData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

dpl_core_dump_enabled¶

Gets the dpl_core_dump_enabled of this DPLCoreDumpData. If true, DPL Core Dump is enabled in the controller.

Required/optional:
Returns:	The dpl_core_dump_enabled of this DPLCoreDumpData.
Return type:	bool
	required

dpl_core_dump_needs_retrieved¶

Gets the dpl_core_dump_needs_retrieved of this DPLCoreDumpData. If true, a DPL core dump currently exists in controller memory and has not been retrieved.

Required/optional:
Returns:	The dpl_core_dump_needs_retrieved of this DPLCoreDumpData.
Return type:	bool
	required

dpl_core_dump_tag¶

Gets the dpl_core_dump_tag of this DPLCoreDumpData. The tag value of the DPL core dump currently in controller memory. Each core dump has a unique tag value. A value of DPL_CORE_DUMP_NULL_TAG indicates there is no DPL core dump to retrieve.

Required/optional:
Returns:	The dpl_core_dump_tag of this DPLCoreDumpData.
Return type:	int
	required

time_stamp¶

Gets the time_stamp of this DPLCoreDumpData. The time that the core dump was collected measured in seconds since midnight GMT on January 1, 1970.

Required/optional:
Returns:	The time_stamp of this DPLCoreDumpData.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.dpl_core_dump_detail module¶

DPLCoreDumpDetail.py

class netapp.santricity.models.symbol.dpl_core_dump_detail.DPLCoreDumpDetail[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

fw_location¶

Gets the fw_location of this DPLCoreDumpDetail. This field is present only if the value of reason is equal to DPL_CORE_DUMP_REASON_ASSERT. In the case of an assertion this structure will contain the firmware location.

Required/optional:
Returns:	The fw_location of this DPLCoreDumpDetail.
Return type:	DPLCoreDumpFWLocation
	optional

panic_reason¶

Gets the panic_reason of this DPLCoreDumpDetail. This field is present only if the value of reason is equal to DPL_CORE_DUMP_REASON_PANIC. It contains a string with the panic message.

Required/optional:
Returns:	The panic_reason of this DPLCoreDumpDetail.
Return type:	str
	optional

reason¶

Gets the reason of this DPLCoreDumpDetail. This enumeration identifies the reason for a DPL core dump.

Required/optional:
Returns:	The reason of this DPLCoreDumpDetail.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.dpl_core_dump_fw_location module¶

DPLCoreDumpFWLocation.py

class netapp.santricity.models.symbol.dpl_core_dump_fw_location.DPLCoreDumpFWLocation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

filename¶

Gets the filename of this DPLCoreDumpFWLocation. The file name within controller firmware.

Required/optional:
Returns:	The filename of this DPLCoreDumpFWLocation.
Return type:	str
	required

line_number¶

Gets the line_number of this DPLCoreDumpFWLocation. The line number within the file.

Required/optional:
Returns:	The line_number of this DPLCoreDumpFWLocation.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.dpl_core_dump_info module¶

DPLCoreDumpInfo.py

class netapp.santricity.models.symbol.dpl_core_dump_info.DPLCoreDumpInfo[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

alt_capture_size¶

Gets the alt_capture_size of this DPLCoreDumpInfo.

Required/optional:
Returns:	The alt_capture_size of this DPLCoreDumpInfo.
Return type:	int
	optional

alt_ctlr¶

Gets the alt_ctlr of this DPLCoreDumpInfo. The controller with an alternate DPL core dump. May be none.

Required/optional:
Returns:	The alt_ctlr of this DPLCoreDumpInfo.
Return type:	str
	required

alt_ctlr_serial_number¶

Gets the alt_ctlr_serial_number of this DPLCoreDumpInfo. The serial number of the controller with an alternate DPL core dump.

Required/optional:
Returns:	The alt_ctlr_serial_number of this DPLCoreDumpInfo.
Return type:	str
	required

capture_time¶

Gets the capture_time of this DPLCoreDumpInfo. The time that the DPL core dump was captured measured in seconds since January 1, 1970.

Required/optional:
Returns:	The capture_time of this DPLCoreDumpInfo.
Return type:	int
	required

detail¶

Gets the detail of this DPLCoreDumpInfo. Additional detail about the DPL Core Dump.

Required/optional:
Returns:	The detail of this DPLCoreDumpInfo.
Return type:	DPLCoreDumpDetail
	required

dom0_alt_capture_size¶

Gets the dom0_alt_capture_size of this DPLCoreDumpInfo. This is the total size of the core dump data to be retrieved from the alternate controller, in bytes.

Required/optional:
Returns:	The dom0_alt_capture_size of this DPLCoreDumpInfo.
Return type:	int
	required

dom0_alt_capture_time¶

Gets the dom0_alt_capture_time of this DPLCoreDumpInfo. This is the time stamp of the latest core dump file on the alternate controller measured in seconds since January 1, 1970.

Required/optional:
Returns:	The dom0_alt_capture_time of this DPLCoreDumpInfo.
Return type:	int
	required

dom0_capture_size¶

Gets the dom0_capture_size of this DPLCoreDumpInfo. This is the total size of the core dump data to be retrieved from this controller, in bytes.

Required/optional:
Returns:	The dom0_capture_size of this DPLCoreDumpInfo.
Return type:	int
	required

dom0_capture_time¶

Gets the dom0_capture_time of this DPLCoreDumpInfo. This is the time stamp of the latest core dump file on this controller measured in seconds since January 1, 1970.

Required/optional:
Returns:	The dom0_capture_time of this DPLCoreDumpInfo.
Return type:	int
	required

dpl_core_dump_tag¶

Gets the dpl_core_dump_tag of this DPLCoreDumpInfo. The DPL core dump tag. Each core dump has a unique tag value.

Required/optional:
Returns:	The dpl_core_dump_tag of this DPLCoreDumpInfo.
Return type:	int
	required

full_capture_size¶

Gets the full_capture_size of this DPLCoreDumpInfo. The size of the full core dump, in megabytes.

Required/optional:
Returns:	The full_capture_size of this DPLCoreDumpInfo.
Return type:	int
	required

full_ctlr¶

Gets the full_ctlr of this DPLCoreDumpInfo. The controller with the full DPL core dump.

Required/optional:
Returns:	The full_ctlr of this DPLCoreDumpInfo.
Return type:	str
	required

full_ctlr_serial_number¶

Gets the full_ctlr_serial_number of this DPLCoreDumpInfo. The serial number of the controller with the full DPL core dump.

Required/optional:
Returns:	The full_ctlr_serial_number of this DPLCoreDumpInfo.
Return type:	str
	required

fw_version¶

Gets the fw_version of this DPLCoreDumpInfo. The controller firmware version at the time the core dump was captured.

Required/optional:
Returns:	The fw_version of this DPLCoreDumpInfo.
Return type:	str
	required

platform_type¶

Gets the platform_type of this DPLCoreDumpInfo. The controller platform type.

Required/optional:
Returns:	The platform_type of this DPLCoreDumpInfo.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

trigger_reason¶

Gets the trigger_reason of this DPLCoreDumpInfo. The type of trigger or reboot reason resulting in the DPL core dump. This information is for internal LSI use only.

Required/optional:
Returns:	The trigger_reason of this DPLCoreDumpInfo.
Return type:	int
	required

netapp.santricity.models.symbol.dpl_core_dump_info_return module¶

DPLCoreDumpInfoReturn.py

class netapp.santricity.models.symbol.dpl_core_dump_info_return.DPLCoreDumpInfoReturn[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

info¶

Gets the info of this DPLCoreDumpInfoReturn. This field is present only if the value of returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The info of this DPLCoreDumpInfoReturn.
Return type:	DPLCoreDumpInfo
	optional

return_code¶

Gets the return_code of this DPLCoreDumpInfoReturn. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this DPLCoreDumpInfoReturn.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.dpl_core_dump_on_demand_return module¶

DPLCoreDumpOnDemandReturn.py

class netapp.santricity.models.symbol.dpl_core_dump_on_demand_return.DPLCoreDumpOnDemandReturn[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

dpl_core_dump_tag¶

Gets the dpl_core_dump_tag of this DPLCoreDumpOnDemandReturn. This field is present only if the value of returnCode is equal to RETCODE_OK. The value of the tag is unique for each core dump.

Required/optional:
Returns:	The dpl_core_dump_tag of this DPLCoreDumpOnDemandReturn.
Return type:	int
	optional

return_code¶

Gets the return_code of this DPLCoreDumpOnDemandReturn. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this DPLCoreDumpOnDemandReturn.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.dpl_core_dump_retrieve_chunk_details module¶

DPLCoreDumpRetrieveChunkDetails.py

class netapp.santricity.models.symbol.dpl_core_dump_retrieve_chunk_details.DPLCoreDumpRetrieveChunkDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

dpl_core_dump_data¶

Gets the dpl_core_dump_data of this DPLCoreDumpRetrieveChunkDetails. The current chunk of the DPL core dump data requested.

Required/optional:
Returns:	The dpl_core_dump_data of this DPLCoreDumpRetrieveChunkDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.dpl_core_dump_retrieve_start_details module¶

DPLCoreDumpRetrieveStartDetails.py

class netapp.santricity.models.symbol.dpl_core_dump_retrieve_start_details.DPLCoreDumpRetrieveStartDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

dpl_core_dump_tag¶

Gets the dpl_core_dump_tag of this DPLCoreDumpRetrieveStartDetails. The tag value of the DPL core dump to be retrieved. This value is unique for each core dump.

Required/optional:
Returns:	The dpl_core_dump_tag of this DPLCoreDumpRetrieveStartDetails.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.dq_retrieve_chunk_details module¶

DqRetrieveChunkDetails.py

class netapp.santricity.models.symbol.dq_retrieve_chunk_details.DqRetrieveChunkDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

compressed¶

Gets the compressed of this DqRetrieveChunkDetails. When true, the data is compressed for the retrieval.

Required/optional:
Returns:	The compressed of this DqRetrieveChunkDetails.
Return type:	bool
	required

dq_data¶

Gets the dq_data of this DqRetrieveChunkDetails. An array of opaque data fields will be returned.

Required/optional:
Returns:	The dq_data of this DqRetrieveChunkDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.dq_retrieve_start_details module¶

DqRetrieveStartDetails.py

class netapp.santricity.models.symbol.dq_retrieve_start_details.DqRetrieveStartDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

compress¶

Gets the compress of this DqRetrieveStartDetails. When set to true, the data is compressed for the retrieval.

Required/optional:
Returns:	The compress of this DqRetrieveStartDetails.
Return type:	bool
	required

flush_current¶

Gets the flush_current of this DqRetrieveStartDetails. indicates whether the retrieved buffer is to be flushed

Required/optional:
Returns:	The flush_current of this DqRetrieveStartDetails.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

trace_id¶

Gets the trace_id of this DqRetrieveStartDetails. set to the type of trace buffers to retrieve

Required/optional:
Returns:	The trace_id of this DqRetrieveStartDetails.
Return type:	str
	required

netapp.santricity.models.symbol.drawer module¶

Drawer.py

class netapp.santricity.models.symbol.drawer.Drawer[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drawer_ref¶

Gets the drawer_ref of this Drawer. The component reference associated with the drawer.

Required/optional:
Returns:	The drawer_ref of this Drawer.
Return type:	str
	required

drawer_type¶

Gets the drawer_type of this Drawer. This data is a variable length ASCII text string describing the type of drawer.

Required/optional:
Returns:	The drawer_type of this Drawer.
Return type:	str
	required

fru_type¶

Gets the fru_type of this Drawer. This data is a variable length ASCII text string. It contains the Field Replaceable Unit (FRU) type, obtained from VPD data.

Required/optional:
Returns:	The fru_type of this Drawer.
Return type:	str
	required

id¶

Gets the id of this Drawer.

Required/optional:
Returns:	The id of this Drawer.
Return type:	str
	optional

is_open¶

Gets the is_open of this Drawer. This value is set to true when the drawer is open; otherwise it is set to false.

Required/optional:
Returns:	The is_open of this Drawer.
Return type:	bool
	required

manufacture_date¶

Gets the manufacture_date of this Drawer. This data is a variable length ASCII text string. It contains the DCM (Drawer Control and Monitor) manufacture date, obtained from VPD data.

Required/optional:
Returns:	The manufacture_date of this Drawer.
Return type:	int
	required

part_number¶

Gets the part_number of this Drawer. This data is a variable length ASCII text string. It contains the DCM (Drawer Control and Monitor) chip part number on the drawer component. This part number is from VPD data.

Required/optional:
Returns:	The part_number of this Drawer.
Return type:	str
	required

physical_location¶

Gets the physical_location of this Drawer. This field contains the drawer location. This will be a tray reference to the tray containing the drawer.

Required/optional:
Returns:	The physical_location of this Drawer.
Return type:	Location
	required

repair_policy¶

Gets the repair_policy of this Drawer. This field contains the repair policy for the drawer component.

Required/optional:
Returns:	The repair_policy of this Drawer.
Return type:	RepairPolicy
	required

serial_number¶

Gets the serial_number of this Drawer. This data is a variable length ASCII text string. It contains the DCM (Drawer Control and Monitor) chip serial number on the drawer component. This serial number is from VPD data.

Required/optional:
Returns:	The serial_number of this Drawer.
Return type:	str
	required

software_version¶

Gets the software_version of this Drawer. This data is a variable length ASCII text string. It contains the firmware version for the DCM (Drawer Control and Monitor) chip on the drawer component.

Required/optional:
Returns:	The software_version of this Drawer.
Return type:	str
	required

status¶

Gets the status of this Drawer. This field contains the drawer status.

Required/optional:
Returns:	The status of this Drawer.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

vendor_name¶

Gets the vendor_name of this Drawer. This data is a variable length ASCII text string. It contains the DCM (Drawer Control and Monitor) chip manufacturer name, obtained from VPD data.

Required/optional:
Returns:	The vendor_name of this Drawer.
Return type:	str
	required

netapp.santricity.models.symbol.drive module¶

Drive.py

class netapp.santricity.models.symbol.drive.Drive[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

available¶

Gets the available of this Drive. True if the drive is available for use in creating a new volume group; false otherwise. This field is valid for missing drives.

Required/optional:
Returns:	The available of this Drive.
Return type:	bool
	required

blk_size¶

Gets the blk_size of this Drive. The block (i.e. sector) size used by the drive, represented in bytes. This field is valid for missing drives.

Required/optional:
Returns:	The blk_size of this Drive.
Return type:	int
	required

blk_size_physical¶

Gets the blk_size_physical of this Drive. The physical block (i.e., sector) size for the drive, represented in bytes. This field is valid for missing drives.

Required/optional:
Returns:	The blk_size_physical of this Drive.
Return type:	int
	required

bypass_source¶

Gets the bypass_source of this Drive. A list of object references where each reference identifies the source of a drive bypass condition. Possible referenced objects include the drive itself, a controller, or the ESM(s). When the bypass source is a controller or the drive, the list will typically hold just one reference; when the bypass source is the ESM(s), the list can hold up to two references, indicating either one or both ESMs. The list normally holds valid data whenever the drive is in the bypassed state (DRIVE_STAT_BYPASSED) , however it may be empty if the source of the bypass is unknown. It is also possible for the list to hold valid data when the drive is optimal, if only one ESM has bypassed the drive.

Required/optional:
Returns:	The bypass_source of this Drive.
Return type:	list[ObjectReference]
	required

cause¶

Gets the cause of this Drive. An indication of the reason for the current status of the drive. This field is most useful when the current status is something other than optimal; it identifies the event that caused the status to change to its current value. This field is valid for missing drives.

Required/optional:
Returns:	The cause of this Drive.
Return type:	str
	required

current_command_aging_timeout¶

Gets the current_command_aging_timeout of this Drive. The current command aging timeout value in hundreds of milliseconds. If this value is 0 the default command aging timeout value will be used, otherwise this value overrides the default value.

Required/optional:
Returns:	The current_command_aging_timeout of this Drive.
Return type:	int
	required

current_speed¶

Gets the current_speed of this Drive. The speed of the drive. Will be unknown for a SCSI drive.

Required/optional:
Returns:	The current_speed of this Drive.
Return type:	str
	required

current_volume_group_ref¶

Gets the current_volume_group_ref of this Drive. The reference value of the volume group, disk pool, or flash cache to which this drive is currently assigned. If a hot spare drive is actively sparing for a failed drive, this field will identify the volume group, disk pool, or flash cache that is using the hot spare drive. If the drive is not currently assigned, or is an idle hot spare, the reference value will be null. This field is valid for missing drives.

Required/optional:
Returns:	The current_volume_group_ref of this Drive.
Return type:	str
	required

default_command_aging_timeout¶

Gets the default_command_aging_timeout of this Drive. The default command aging timeout value in hundreds of milliseconds as specified by the drive. If this value is 0, the drive command aging timeout cannot be changed.

Required/optional:
Returns:	The default_command_aging_timeout of this Drive.
Return type:	int
	required

degraded_channels¶

Gets the degraded_channels of this Drive. The IDs of degraded channels.

Required/optional:
Returns:	The degraded_channels of this Drive.
Return type:	list[int]
	required

drive_media_type¶

Gets the drive_media_type of this Drive. This field is set to the drive media type of the drive.

Required/optional:
Returns:	The drive_media_type of this Drive.
Return type:	str
	required

drive_ref¶

Gets the drive_ref of this Drive. The identifier value for this drive. Other objects may use this reference value to refer to the drive. This field is valid for missing drives.

Required/optional:
Returns:	The drive_ref of this Drive.
Return type:	str
	required

drive_temperature¶

Gets the drive_temperature of this Drive. Drive temperature data.

Required/optional:
Returns:	The drive_temperature of this Drive.
Return type:	DriveTemperature
	required

fde_capable¶

Gets the fde_capable of this Drive. True if the drive supports FDE, false otherwise

Required/optional:
Returns:	The fde_capable of this Drive.
Return type:	bool
	required

fde_enabled¶

Gets the fde_enabled of this Drive. true if drive security is enabled; false if disabled

Required/optional:
Returns:	The fde_enabled of this Drive.
Return type:	bool
	required

fde_locked¶

Gets the fde_locked of this Drive. True if the drive is locked, false if the drive is unlocked

Required/optional:
Returns:	The fde_locked of this Drive.
Return type:	bool
	required

fips_capable¶

Gets the fips_capable of this Drive. This flag is true if the drive supports FIPS (Federal Information Processing Standard). FIPS 140-2 specification.

Required/optional:
Returns:	The fips_capable of this Drive.
Return type:	bool
	required

fpga_version¶

Gets the fpga_version of this Drive. This data is a variable-length ASCII text string that identifies the version of the FPGA package.

Required/optional:
Returns:	The fpga_version of this Drive.
Return type:	str
	required

has_degraded_channel¶

Gets the has_degraded_channel of this Drive. True, if a path to this drive is degraded.

Required/optional:
Returns:	The has_degraded_channel of this Drive.
Return type:	bool
	required

hot_spare¶

Gets the hot_spare of this Drive. True if the drive has been designated as a hot spare; false otherwise. This field is valid for missing drives.

Required/optional:
Returns:	The hot_spare of this Drive.
Return type:	bool
	required

id¶

Gets the id of this Drive.

Required/optional:
Returns:	The id of this Drive.
Return type:	str
	optional

interface_type¶

Gets the interface_type of this Drive. Information about the I/O interface between the controller and the drive. For example, for a SCSI-attached drive, this field will contain information about the drive’s channel and SCSI ID values. For other interface types, different data will be available in this field.

Required/optional:
Returns:	The interface_type of this Drive.
Return type:	DriveTypeData
	required

interposer_present¶

Gets the interposer_present of this Drive. A value of true for this property means the drive is behind an interposer.

Required/optional:
Returns:	The interposer_present of this Drive.
Return type:	bool
	required

interposer_ref¶

Gets the interposer_ref of this Drive. The drive interposer identifier. This field is valid only if the interposerPresent field is set to True.

Required/optional:
Returns:	The interposer_ref of this Drive.
Return type:	str
	required

invalid_drive_data¶

Gets the invalid_drive_data of this Drive. True if no drive information (serial #, capacity, etc.) can be obtained. This field is always true for missing drives.

Required/optional:
Returns:	The invalid_drive_data of this Drive.
Return type:	bool
	required

locate_in_progress¶

Gets the locate_in_progress of this Drive. Indicates that a locate operation for the device is currently active. The device will show a visual indication to aid an operator in locating the drive.

Required/optional:
Returns:	The locate_in_progress of this Drive.
Return type:	bool
	required

lock_key_id¶

Gets the lock_key_id of this Drive. The lock key ID as read from the drive.

Required/optional:
Returns:	The lock_key_id of this Drive.
Return type:	str
	required

lowest_aligned_lba¶

Gets the lowest_aligned_lba of this Drive. The lowest aligned LBA for the physical sector. Typically this will be 0, but could be non-zero for emulation drives where LBA 0 starts at some logical sector offset within the physical sector.

Required/optional:
Returns:	The lowest_aligned_lba of this Drive.
Return type:	int
	required

manufacturer¶

Gets the manufacturer of this Drive. The variable-length ASCII text string that identifies the drive manufacturer. Note that this information is not returned for most Serial ATA (SATA) drives.

Required/optional:
Returns:	The manufacturer of this Drive.
Return type:	str
	required

manufacturer_date¶

Gets the manufacturer_date of this Drive. The date of manufacture of the drive, represented in seconds since midnight GMT on January 1, 1970. Note that this information is not returned for most Serial ATA (SATA) drives.

Required/optional:
Returns:	The manufacturer_date of this Drive.
Return type:	int
	required

max_speed¶

Gets the max_speed of this Drive. The maximum speed of the drive. Currently not used.

Required/optional:
Returns:	The max_speed of this Drive.
Return type:	str
	required

mirror_drive¶

Gets the mirror_drive of this Drive. This field is only used if the Drive object represents a drive that is part of a RAID-1 volume group. It identifies the drive that is tied to this one for RAID-1 mirroring operations. This field is valid for missing drives.

Required/optional:
Returns:	The mirror_drive of this Drive.
Return type:	str
	required

non_redundant_access¶

Gets the non_redundant_access of this Drive. True if the drive does not have redundant access.

Required/optional:
Returns:	The non_redundant_access of this Drive.
Return type:	bool
	required

offline¶

Gets the offline of this Drive. True if the drive is in the offline state, false otherwise. This field is valid for missing drives.

Required/optional:
Returns:	The offline of this Drive.
Return type:	bool
	required

pfa¶

Gets the pfa of this Drive. True if the drive is drive Predicted Failure analysis predicts a drive failure. This field is valid for missing drives.

Required/optional:
Returns:	The pfa of this Drive.
Return type:	bool
	required

pfa_reason¶

Gets the pfa_reason of this Drive. The reason a PFA condition has been raised for this drive.

Required/optional:
Returns:	The pfa_reason of this Drive.
Return type:	str
	required

phy_drive_type¶

Gets the phy_drive_type of this Drive. The physical drive type.

Required/optional:
Returns:	The phy_drive_type of this Drive.
Return type:	str
	required

phy_drive_type_data¶

Gets the phy_drive_type_data of this Drive. Information specific to a physical drive type.

Required/optional:
Returns:	The phy_drive_type_data of this Drive.
Return type:	PhysicalDriveTypeData
	required

physical_location¶

Gets the physical_location of this Drive. The physical location of the drive. Beginning with the Allegheny release, the parent reference in Location identifies the tray or drawer containing the drive, and the position field is the parent-relative/like-component relative slot number of the drive, starting at 1. For missing drives this field contains the last known location.

Required/optional:
Returns:	The physical_location of this Drive.
Return type:	Location
	required

product_id¶

Gets the product_id of this Drive. The variable-length ASCII text string that identifies the product by name, as assigned by the manufacturer.

Required/optional:
Returns:	The product_id of this Drive.
Return type:	str
	required

protection_information_capabilities¶

Gets the protection_information_capabilities of this Drive. This structure contains a protectionInformationCapable field which is set to true when the drive is formatted to support type 2 protection with a 512-byte logical block size, or if the drive is a type 0 drive formatted with a 520-byte logical block size. It also contains a field that is set to the protection type provided for the drive.

Required/optional:
Returns:	The protection_information_capabilities of this Drive.
Return type:	ProtectionInformationCapabilities
	required

protection_information_capable¶

Gets the protection_information_capable of this Drive. Field is no longer used.

Required/optional:
Returns:	The protection_information_capable of this Drive.
Return type:	bool
	required

protection_type¶

Gets the protection_type of this Drive. Field is no longer used.

Required/optional:
Returns:	The protection_type of this Drive.
Return type:	str
	required

raw_capacity¶

Gets the raw_capacity of this Drive. The raw capacity of the drive, in bytes. This field is valid for missing drives.

Required/optional:
Returns:	The raw_capacity of this Drive.
Return type:	int
	required

removed¶

Gets the removed of this Drive. True if the drive is in the process of being removed from the volume group. Only applies to Disk Pools

Required/optional:
Returns:	The removed of this Drive.
Return type:	bool
	required

repair_policy¶

Gets the repair_policy of this Drive. This field contains the repair policy for the Drive.

Required/optional:
Returns:	The repair_policy of this Drive.
Return type:	RepairPolicy
	required

reserved¶

Gets the reserved of this Drive. reserved.

Required/optional:
Returns:	The reserved of this Drive.
Return type:	str
	required

rtr_attributes¶

Gets the rtr_attributes of this Drive. The CRU type of the drive plus its ready-to-remove attributes, which are based on the CRU type.

Required/optional:
Returns:	The rtr_attributes of this Drive.
Return type:	RTRAttributes
	required

serial_number¶

Gets the serial_number of this Drive. The variable-length ASCII text string for the serial number of the drive.

Required/optional:
Returns:	The serial_number of this Drive.
Return type:	str
	required

software_version¶

Gets the software_version of this Drive. This data is a variable-length ASCII text string. If an interposer is present in front of SATA drives, the string identifies the version of the interposer package. In this case, the SATA drive firmware version can be found in the physicalDriveTypeData field. If an interposer is not present (always the case for Fibre Channel drives) this field describes the drive firmware version.

Required/optional:
Returns:	The software_version of this Drive.
Return type:	str
	required

spared_for_drive_ref¶

Gets the spared_for_drive_ref of this Drive. The reference value of the drive for which this drive is acting as a hot spare. This field is only used if the Drive object represents a global hot spare that is actively sparing for a failed drive. This field is valid for missing drives.

Required/optional:
Returns:	The spared_for_drive_ref of this Drive.
Return type:	str
	required

spindle_speed¶

Gets the spindle_speed of this Drive. The drive reported spindle speed. Solid State Disk (SSD) drives report zero.

Required/optional:
Returns:	The spindle_speed of this Drive.
Return type:	int
	required

ssd_wear_life¶

Gets the ssd_wear_life of this Drive. Contains wear life data for the SSD drive.

Required/optional:
Returns:	The ssd_wear_life of this Drive.
Return type:	SSDWearLife
	required

status¶

Gets the status of this Drive. An indication of the current status of the drive. This field is valid for missing drives.

Required/optional:
Returns:	The status of this Drive.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

uncertified¶

Gets the uncertified of this Drive. True, if the drive has the DR_UNCERTIFIED flag set. This field is valid for missing drives.

Required/optional:
Returns:	The uncertified of this Drive.
Return type:	bool
	required

usable_capacity¶

Gets the usable_capacity of this Drive. The usable capacity of the drive, in bytes, after accounting for any space that is reserved for use by the array controller for overhead information. This field is valid for missing drives.

Required/optional:
Returns:	The usable_capacity of this Drive.
Return type:	int
	required

volume_group_index¶

Gets the volume_group_index of this Drive. The volume group index. This is the zero-relative position of the drive with respect to the stripe-ordering for the volume group. A value of -1 indicates that the drive does not belong to any group. This field is valid for missing drives.

Required/optional:
Returns:	The volume_group_index of this Drive.
Return type:	int
	required

working_channel¶

Gets the working_channel of this Drive. The channel to the tray that is still operational (if nonRedundantAccess is True).

Required/optional:
Returns:	The working_channel of this Drive.
Return type:	int
	required

world_wide_name¶

Gets the world_wide_name of this Drive. A variable-length, opaque field that contains the drive’s world-wide name, or globally unique identifier value. This field is valid for missing drives.

Required/optional:
Returns:	The world_wide_name of this Drive.
Return type:	str
	required

netapp.santricity.models.symbol.drive_channel module¶

DriveChannel.py

class netapp.santricity.models.symbol.drive_channel.DriveChannel[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this DriveChannel. The channel number.

Required/optional:
Returns:	The channel of this DriveChannel.
Return type:	int
	required

degrading_controller¶

Gets the degrading_controller of this DriveChannel. If auto degraded, the degraded controller.

Required/optional:
Returns:	The degrading_controller of this DriveChannel.
Return type:	str
	required

reason¶

Gets the reason of this DriveChannel. The reason the channel was degraded.

Required/optional:
Returns:	The reason of this DriveChannel.
Return type:	str
	required

state¶

Gets the state of this DriveChannel. The operational state of the channel.

Required/optional:
Returns:	The state of this DriveChannel.
Return type:	str
	required

stats_controller_a¶

Gets the stats_controller_a of this DriveChannel. The statistics for Controller A.

Required/optional:
Returns:	The stats_controller_a of this DriveChannel.
Return type:	DriveChannelStatistics
	required

stats_controller_b¶

Gets the stats_controller_b of this DriveChannel. The statistics for Controller B.

Required/optional:
Returns:	The stats_controller_b of this DriveChannel.
Return type:	DriveChannelStatistics
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_channel_error_counts module¶

DriveChannelErrorCounts.py

class netapp.santricity.models.symbol.drive_channel_error_counts.DriveChannelErrorCounts[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_detected_errors¶

Gets the controller_detected_errors of this DriveChannelErrorCounts. The number of controller detected errors.

Required/optional:
Returns:	The controller_detected_errors of this DriveChannelErrorCounts.
Return type:	int
	required

drive_detected_errors¶

Gets the drive_detected_errors of this DriveChannelErrorCounts. The number of drive detected errors.

Required/optional:
Returns:	The drive_detected_errors of this DriveChannelErrorCounts.
Return type:	int
	required

link_down_errors¶

Gets the link_down_errors of this DriveChannelErrorCounts. The number of link down errors.

Required/optional:
Returns:	The link_down_errors of this DriveChannelErrorCounts.
Return type:	int
	required

non_channel_errors¶

Gets the non_channel_errors of this DriveChannelErrorCounts. The number of non channel errors.

Required/optional:
Returns:	The non_channel_errors of this DriveChannelErrorCounts.
Return type:	int
	required

timeout_errors¶

Gets the timeout_errors of this DriveChannelErrorCounts. The number of timeout errors.

Required/optional:
Returns:	The timeout_errors of this DriveChannelErrorCounts.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_channel_list module¶

DriveChannelList.py

class netapp.santricity.models.symbol.drive_channel_list.DriveChannelList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_channels¶

Gets the drive_channels of this DriveChannelList. The drive channels.

Required/optional:
Returns:	The drive_channels of this DriveChannelList.
Return type:	list[DriveChannel]
	required

return_code¶

Gets the return_code of this DriveChannelList. The return code from the getDriveChannelStatistics API.

Required/optional:
Returns:	The return_code of this DriveChannelList.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_channel_parent module¶

DriveChannelParent.py

class netapp.santricity.models.symbol.drive_channel_parent.DriveChannelParent[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_ref¶

Gets the controller_ref of this DriveChannelParent. This field is present only if the DriveChannelParentType is CONTROLLER.

Required/optional:
Returns:	The controller_ref of this DriveChannelParent.
Return type:	str
	optional

drive_channel_parent¶

Gets the drive_channel_parent of this DriveChannelParent. This enumeration object is used to specify the Drive Channel parent.

Required/optional:
Returns:	The drive_channel_parent of this DriveChannelParent.
Return type:	str
	required

minihub_ref¶

Gets the minihub_ref of this DriveChannelParent. This field is present only if the DriveChanelParentType is MINIHUB.

Required/optional:
Returns:	The minihub_ref of this DriveChannelParent.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_channel_port module¶

DriveChannelPort.py

class netapp.santricity.models.symbol.drive_channel_port.DriveChannelPort[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this DriveChannelPort. The Fibre Channel number of the port.

Required/optional:
Returns:	The channel of this DriveChannelPort.
Return type:	int
	required

parent_type¶

Gets the parent_type of this DriveChannelPort. The parent type (minihub/controller).

Required/optional:
Returns:	The parent_type of this DriveChannelPort.
Return type:	DriveChannelParent
	required

port_ref¶

Gets the port_ref of this DriveChannelPort. A reference to the drive channel port.

Required/optional:
Returns:	The port_ref of this DriveChannelPort.
Return type:	str
	required

port_type¶

Gets the port_type of this DriveChannelPort. The type of port (XBB/expansion/internal).

Required/optional:
Returns:	The port_type of this DriveChannelPort.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_channel_specifier module¶

DriveChannelSpecifier.py

class netapp.santricity.models.symbol.drive_channel_specifier.DriveChannelSpecifier[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this DriveChannelSpecifier. The channel identifier.

Required/optional:
Returns:	The channel of this DriveChannelSpecifier.
Return type:	int
	required

controller¶

Gets the controller of this DriveChannelSpecifier. The controller identifier.

Required/optional:
Returns:	The controller of this DriveChannelSpecifier.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_channel_state_descriptor module¶

DriveChannelStateDescriptor.py

class netapp.santricity.models.symbol.drive_channel_state_descriptor.DriveChannelStateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this DriveChannelStateDescriptor. The drive channel number.

Required/optional:
Returns:	The channel of this DriveChannelStateDescriptor.
Return type:	int
	required

state¶

Gets the state of this DriveChannelStateDescriptor. The state of the channel (optimal or degraded).

Required/optional:
Returns:	The state of this DriveChannelStateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_channel_statistics module¶

DriveChannelStatistics.py

class netapp.santricity.models.symbol.drive_channel_statistics.DriveChannelStatistics[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

end_time_stamp¶

Gets the end_time_stamp of this DriveChannelStatistics. The time stamp of when the error tracking ended.

Required/optional:
Returns:	The end_time_stamp of this DriveChannelStatistics.
Return type:	int
	required

error_counts¶

Gets the error_counts of this DriveChannelStatistics. The error category counts.

Required/optional:
Returns:	The error_counts of this DriveChannelStatistics.
Return type:	DriveChannelErrorCounts
	required

link_status¶

Gets the link_status of this DriveChannelStatistics. The status of the link - up, down, failed

Required/optional:
Returns:	The link_status of this DriveChannelStatistics.
Return type:	str
	required

start_time_stamp¶

Gets the start_time_stamp of this DriveChannelStatistics. The time stamp of when the error tracking began.

Required/optional:
Returns:	The start_time_stamp of this DriveChannelStatistics.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

total_io_count¶

Gets the total_io_count of this DriveChannelStatistics. The total number of I/Os.

Required/optional:
Returns:	The total_io_count of this DriveChannelStatistics.
Return type:	int
	required

total_io_error_count¶

Gets the total_io_error_count of this DriveChannelStatistics. The total number of I/O errors.

Required/optional:
Returns:	The total_io_error_count of this DriveChannelStatistics.
Return type:	int
	required

netapp.santricity.models.symbol.drive_counter_group module¶

DriveCounterGroup.py

class netapp.santricity.models.symbol.drive_counter_group.DriveCounterGroup[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

base_time¶

Gets the base_time of this DriveCounterGroup. The time that the counters were last reset. Time is the number of seconds since midnight, January 1, 1970.

Required/optional:
Returns:	The base_time of this DriveCounterGroup.
Return type:	int
	required

controller_ref¶

Gets the controller_ref of this DriveCounterGroup. A reference to the controller that accumulated the counters for this group.

Required/optional:
Returns:	The controller_ref of this DriveCounterGroup.
Return type:	str
	required

cumulative_delta_lba¶

Gets the cumulative_delta_lba of this DriveCounterGroup. Sum of LBA shifts accessed from the drive within an observation interval.

Required/optional:
Returns:	The cumulative_delta_lba of this DriveCounterGroup.
Return type:	int
	required

cumulative_lba¶

Gets the cumulative_lba of this DriveCounterGroup. Sum of LBA’s accessed from the drive within an observation interval.

Required/optional:
Returns:	The cumulative_lba of this DriveCounterGroup.
Return type:	int
	required

idle_time¶

Gets the idle_time of this DriveCounterGroup. The total time in microseconds spent idle since baseTime.

Required/optional:
Returns:	The idle_time of this DriveCounterGroup.
Return type:	int
	required

observed_time¶

Gets the observed_time of this DriveCounterGroup. End time for this collection as measured by the number of seconds since baseTime.

Required/optional:
Returns:	The observed_time of this DriveCounterGroup.
Return type:	int
	required

other_ops¶

Gets the other_ops of this DriveCounterGroup. The number of non-read-write operations.

Required/optional:
Returns:	The other_ops of this DriveCounterGroup.
Return type:	int
	required

other_time_max¶

Gets the other_time_max of this DriveCounterGroup. The maximum time in microseconds spent in any one non-read-write operation.

Required/optional:
Returns:	The other_time_max of this DriveCounterGroup.
Return type:	int
	required

other_time_total¶

Gets the other_time_total of this DriveCounterGroup. The total time in microseconds spent in non-read-write operations.

Required/optional:
Returns:	The other_time_total of this DriveCounterGroup.
Return type:	int
	required

other_time_total_sq¶

Gets the other_time_total_sq of this DriveCounterGroup. The sum of the squares of microseconds spent in non read-write operations.

Required/optional:
Returns:	The other_time_total_sq of this DriveCounterGroup.
Return type:	int
	required

queue_depth_max¶

Gets the queue_depth_max of this DriveCounterGroup. Maximum queue depth.

Required/optional:
Returns:	The queue_depth_max of this DriveCounterGroup.
Return type:	int
	required

queue_depth_total¶

Gets the queue_depth_total of this DriveCounterGroup. Total drive queue depth.

Required/optional:
Returns:	The queue_depth_total of this DriveCounterGroup.
Return type:	int
	required

random_bytes_total¶

Gets the random_bytes_total of this DriveCounterGroup. Total number of Bytes that are categorized as random.

Required/optional:
Returns:	The random_bytes_total of this DriveCounterGroup.
Return type:	int
	required

random_ios_total¶

Gets the random_ios_total of this DriveCounterGroup. Total number of IOs that are categorized as random.

Required/optional:
Returns:	The random_ios_total of this DriveCounterGroup.
Return type:	int
	required

read_bytes¶

Gets the read_bytes of this DriveCounterGroup. The number of bytes read.

Required/optional:
Returns:	The read_bytes of this DriveCounterGroup.
Return type:	int
	required

read_ops¶

Gets the read_ops of this DriveCounterGroup. The number of read operations.

Required/optional:
Returns:	The read_ops of this DriveCounterGroup.
Return type:	int
	required

read_time_max¶

Gets the read_time_max of this DriveCounterGroup. The maximum time in microseconds spent in any one read operation.

Required/optional:
Returns:	The read_time_max of this DriveCounterGroup.
Return type:	int
	required

read_time_total¶

Gets the read_time_total of this DriveCounterGroup. The total time in microseconds spent in read operations.

Required/optional:
Returns:	The read_time_total of this DriveCounterGroup.
Return type:	int
	required

read_time_total_sq¶

Gets the read_time_total_sq of this DriveCounterGroup. The sum of the squares of microseconds spent in read operations.

Required/optional:
Returns:	The read_time_total_sq of this DriveCounterGroup.
Return type:	int
	required

recovered_errors¶

Gets the recovered_errors of this DriveCounterGroup. The number of recovered errors.

Required/optional:
Returns:	The recovered_errors of this DriveCounterGroup.
Return type:	int
	required

retried_ios¶

Gets the retried_ios of this DriveCounterGroup. The number of retried I/O operations.

Required/optional:
Returns:	The retried_ios of this DriveCounterGroup.
Return type:	int
	required

start_time¶

Gets the start_time of this DriveCounterGroup. Start time for this collection as measured by the number of seconds since baseTime.

Required/optional:
Returns:	The start_time of this DriveCounterGroup.
Return type:	int
	required

timeouts¶

Gets the timeouts of this DriveCounterGroup. The number of timeouts.

Required/optional:
Returns:	The timeouts of this DriveCounterGroup.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

unrecovered_errors¶

Gets the unrecovered_errors of this DriveCounterGroup. The number of unrecovered errors.

Required/optional:
Returns:	The unrecovered_errors of this DriveCounterGroup.
Return type:	int
	required

write_bytes¶

Gets the write_bytes of this DriveCounterGroup. The number of bytes written.

Required/optional:
Returns:	The write_bytes of this DriveCounterGroup.
Return type:	int
	required

write_ops¶

Gets the write_ops of this DriveCounterGroup. The number of write operations.

Required/optional:
Returns:	The write_ops of this DriveCounterGroup.
Return type:	int
	required

write_time_max¶

Gets the write_time_max of this DriveCounterGroup. The maximum time in microseconds spent in any one write operation.

Required/optional:
Returns:	The write_time_max of this DriveCounterGroup.
Return type:	int
	required

write_time_total¶

Gets the write_time_total of this DriveCounterGroup. The total time in microseconds spent in write operations.

Required/optional:
Returns:	The write_time_total of this DriveCounterGroup.
Return type:	int
	required

write_time_total_sq¶

Gets the write_time_total_sq of this DriveCounterGroup. The sum of the squares of microseconds spent in write operations.

Required/optional:
Returns:	The write_time_total_sq of this DriveCounterGroup.
Return type:	int
	required

netapp.santricity.models.symbol.drive_download_drive_status module¶

DriveDownloadDriveStatus.py

class netapp.santricity.models.symbol.drive_download_drive_status.DriveDownloadDriveStatus[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_ref¶

Gets the drive_ref of this DriveDownloadDriveStatus. The drive reference.

Required/optional:
Returns:	The drive_ref of this DriveDownloadDriveStatus.
Return type:	str
	required

percent_complete¶

Gets the percent_complete of this DriveDownloadDriveStatus. Will be set to zero unless the DriveDownloadStatus is equal to DRIVE_DL_STAT_IN_PROGRESS_RECON (meaning a reconstruction is in progress).

Required/optional:
Returns:	The percent_complete of this DriveDownloadDriveStatus.
Return type:	int
	required

status¶

Gets the status of this DriveDownloadDriveStatus. The drive download status.

Required/optional:
Returns:	The status of this DriveDownloadDriveStatus.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_download_set module¶

DriveDownloadSet.py

class netapp.santricity.models.symbol.drive_download_set.DriveDownloadSet[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_list¶

Gets the drive_list of this DriveDownloadSet. The drive list.

Required/optional:
Returns:	The drive_list of this DriveDownloadSet.
Return type:	list[str]
	required

file_size¶

Gets the file_size of this DriveDownloadSet. The file size.

Required/optional:
Returns:	The file_size of this DriveDownloadSet.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_firmware_chunk_descriptor module¶

DriveFirmwareChunkDescriptor.py

class netapp.santricity.models.symbol.drive_firmware_chunk_descriptor.DriveFirmwareChunkDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

firmware_chunk_image¶

Gets the firmware_chunk_image of this DriveFirmwareChunkDescriptor. The image.

Required/optional:
Returns:	The firmware_chunk_image of this DriveFirmwareChunkDescriptor.
Return type:	str
	required

offset¶

Gets the offset of this DriveFirmwareChunkDescriptor. The offset.

Required/optional:
Returns:	The offset of this DriveFirmwareChunkDescriptor.
Return type:	int
	required

set_id¶

Gets the set_id of this DriveFirmwareChunkDescriptor. the id to set.

Required/optional:
Returns:	The set_id of this DriveFirmwareChunkDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_firmware_download module¶

DriveFirmwareDownload.py

class netapp.santricity.models.symbol.drive_firmware_download.DriveFirmwareDownload[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

download_set¶

Gets the download_set of this DriveFirmwareDownload. The drive download data list.

Required/optional:
Returns:	The download_set of this DriveFirmwareDownload.
Return type:	list[DriveDownloadSet]
	required

online¶

Gets the online of this DriveFirmwareDownload. Set to true by the caller of startDriveFirmwareDownload if the download is to be performed online.

Required/optional:
Returns:	The online of this DriveFirmwareDownload.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_firmware_status module¶

DriveFirmwareStatus.py

class netapp.santricity.models.symbol.drive_firmware_status.DriveFirmwareStatus[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_status¶

Gets the drive_status of this DriveFirmwareStatus. The drive status.

Required/optional:
Returns:	The drive_status of this DriveFirmwareStatus.
Return type:	list[DriveDownloadDriveStatus]
	required

overall_status¶

Gets the overall_status of this DriveFirmwareStatus. The overall status.

Required/optional:
Returns:	The overall_status of this DriveFirmwareStatus.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_firmware_update_descriptor module¶

DriveFirmwareUpdateDescriptor.py

class netapp.santricity.models.symbol.drive_firmware_update_descriptor.DriveFirmwareUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_ref¶

Gets the drive_ref of this DriveFirmwareUpdateDescriptor. This object uniquely identifies the particular drive within the storage array that will receive the new firmware.

Required/optional:
Returns:	The drive_ref of this DriveFirmwareUpdateDescriptor.
Return type:	str
	required

firmware_update_descriptor¶

Gets the firmware_update_descriptor of this DriveFirmwareUpdateDescriptor. The chunk of firmware to download to the drive.

Required/optional:
Returns:	The firmware_update_descriptor of this DriveFirmwareUpdateDescriptor.
Return type:	FirmwareUpdateDescriptor
	required

mode_select_file¶

Gets the mode_select_file of this DriveFirmwareUpdateDescriptor. True if the image is a mode select file.

Required/optional:
Returns:	The mode_select_file of this DriveFirmwareUpdateDescriptor.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_health_logs_chunk_details module¶

DriveHealthLogsChunkDetails.py

class netapp.santricity.models.symbol.drive_health_logs_chunk_details.DriveHealthLogsChunkDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_health_log_data¶

Gets the drive_health_log_data of this DriveHealthLogsChunkDetails. This is a xml tagged ascii data used to describe a drive’s health.

Required/optional:
Returns:	The drive_health_log_data of this DriveHealthLogsChunkDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_health_logs_start_details module¶

DriveHealthLogsStartDetails.py

class netapp.santricity.models.symbol.drive_health_logs_start_details.DriveHealthLogsStartDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_health_log_data¶

Gets the drive_health_log_data of this DriveHealthLogsStartDetails. This is a xml tagged ascii data used to describe a drive’s health.

Required/optional:
Returns:	The drive_health_log_data of this DriveHealthLogsStartDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_layout module¶

DriveLayout.py

class netapp.santricity.models.symbol.drive_layout.DriveLayout[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_orientation¶

Gets the drive_orientation of this DriveLayout. The drive orientation in the drawer or tray.

Required/optional:
Returns:	The drive_orientation of this DriveLayout.
Return type:	str
	required

num_columns¶

Gets the num_columns of this DriveLayout. The number of columns in the drive layout. If driveOrientation field is set to “None”, the value of this field should be zero.

Required/optional:
Returns:	The num_columns of this DriveLayout.
Return type:	int
	required

num_rows¶

Gets the num_rows of this DriveLayout. The number of rows in the drive layout. If driveOrientation field is set to “None”, the value of this field should be zero.

Required/optional:
Returns:	The num_rows of this DriveLayout.
Return type:	int
	required

primary_traversal¶

Gets the primary_traversal of this DriveLayout. The primary traversal method for the drawer or tray. If driveOrientation field is set to “None”, the value of this field should be TRAVERSAL_NONE

Required/optional:
Returns:	The primary_traversal of this DriveLayout.
Return type:	str
	required

secondary_traversal¶

Gets the secondary_traversal of this DriveLayout. The secondary traversal method for the drawer or tray. If driveOrientation field is set to “None”, the value of this field should be TRAVERSAL_NONE

Required/optional:
Returns:	The secondary_traversal of this DriveLayout.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_log_data module¶

DriveLogData.py

class netapp.santricity.models.symbol.drive_log_data.DriveLogData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

logs¶

Gets the logs of this DriveLogData. The concatenated drive logs.

Required/optional:
Returns:	The logs of this DriveLogData.
Return type:	str
	required

physical_location¶

Gets the physical_location of this DriveLogData. The drive tray and slot number.

Required/optional:
Returns:	The physical_location of this DriveLogData.
Return type:	Location
	required

return_code¶

Gets the return_code of this DriveLogData. The return code from the getDriveLogData procedure.

Required/optional:
Returns:	The return_code of this DriveLogData.
Return type:	str
	required

serial_number¶

Gets the serial_number of this DriveLogData. The drive serial number

Required/optional:
Returns:	The serial_number of this DriveLogData.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_lost_redundancy_failure module¶

DriveLostRedundancyFailure.py

class netapp.santricity.models.symbol.drive_lost_redundancy_failure.DriveLostRedundancyFailure[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_lost_redundancy¶

Gets the drive_lost_redundancy of this DriveLostRedundancyFailure. This object uniquely identifies the particular drive within the storage array that has lost redundancy.

Required/optional:
Returns:	The drive_lost_redundancy of this DriveLostRedundancyFailure.
Return type:	str
	required

failed_esm¶

Gets the failed_esm of this DriveLostRedundancyFailure. This object uniquely identifies the failed ESM within the storage array.

Required/optional:
Returns:	The failed_esm of this DriveLostRedundancyFailure.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

working_channel¶

Gets the working_channel of this DriveLostRedundancyFailure. The channel to the drive that is still operational.

Required/optional:
Returns:	The working_channel of this DriveLostRedundancyFailure.
Return type:	int
	required

netapp.santricity.models.symbol.drive_performance_history_retrieve_chunk_details module¶

DrivePerformanceHistoryRetrieveChunkDetails.py

class netapp.santricity.models.symbol.drive_performance_history_retrieve_chunk_details.DrivePerformanceHistoryRetrieveChunkDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_performance_history_data¶

Gets the drive_performance_history_data of this DrivePerformanceHistoryRetrieveChunkDetails. Drive performance history data.

Required/optional:
Returns:	The drive_performance_history_data of this DrivePerformanceHistoryRetrieveChunkDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_performance_history_retrieve_start_details module¶

DrivePerformanceHistoryRetrieveStartDetails.py

class netapp.santricity.models.symbol.drive_performance_history_retrieve_start_details.DrivePerformanceHistoryRetrieveStartDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

reserved¶

Gets the reserved of this DrivePerformanceHistoryRetrieveStartDetails. reserved.

Required/optional:
Returns:	The reserved of this DrivePerformanceHistoryRetrieveStartDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_physical_security_id module¶

DrivePhysicalSecurityId.py

class netapp.santricity.models.symbol.drive_physical_security_id.DrivePhysicalSecurityId[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_ref¶

Gets the drive_ref of this DrivePhysicalSecurityId. The reference to the drive for which the PSID is to be applied.

Required/optional:
Returns:	The drive_ref of this DrivePhysicalSecurityId.
Return type:	str
	required

physical_security_id¶

Gets the physical_security_id of this DrivePhysicalSecurityId. This string contains the Physical Security ID (PSID) for this drive. The PSID allows the drive to be reset back to factory settings which could happen if the previous lock key was lost. The drive needs to be set back to factory settings in order to be used in the current array.

Required/optional:
Returns:	The physical_security_id of this DrivePhysicalSecurityId.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_physical_security_id_descriptor module¶

DrivePhysicalSecurityIdDescriptor.py

class netapp.santricity.models.symbol.drive_physical_security_id_descriptor.DrivePhysicalSecurityIdDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_physical_security_id_list¶

Gets the drive_physical_security_id_list of this DrivePhysicalSecurityIdDescriptor. This is a list of drive refs and the corresponding PSIDs for which to update on those drives.

Required/optional:
Returns:	The drive_physical_security_id_list of this DrivePhysicalSecurityIdDescriptor.
Return type:	list[DrivePhysicalSecurityId]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_ref_list module¶

DriveRefList.py

class netapp.santricity.models.symbol.drive_ref_list.DriveRefList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_ref¶

Gets the drive_ref of this DriveRefList. A variable-length array of DriveRef objects.

Required/optional:
Returns:	The drive_ref of this DriveRefList.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_replacement_descriptor module¶

DriveReplacementDescriptor.py

class netapp.santricity.models.symbol.drive_replacement_descriptor.DriveReplacementDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_to_replace¶

Gets the drive_to_replace of this DriveReplacementDescriptor. A reference to the drive to be replaced.

Required/optional:
Returns:	The drive_to_replace of this DriveReplacementDescriptor.
Return type:	str
	required

replacement_drive¶

Gets the replacement_drive of this DriveReplacementDescriptor. A reference to the replacement drive.

Required/optional:
Returns:	The replacement_drive of this DriveReplacementDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_temperature module¶

DriveTemperature.py

class netapp.santricity.models.symbol.drive_temperature.DriveTemperature[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

current_temp¶

Gets the current_temp of this DriveTemperature. The current drive temperature (in degrees Celsius).

Required/optional:
Returns:	The current_temp of this DriveTemperature.
Return type:	int
	required

ref_temp¶

Gets the ref_temp of this DriveTemperature. Reference temperature (maximum safe operating temperature in degrees Celsius).

Required/optional:
Returns:	The ref_temp of this DriveTemperature.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_temperature_data module¶

DriveTemperatureData.py

class netapp.santricity.models.symbol.drive_temperature_data.DriveTemperatureData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_ref¶

Gets the drive_ref of this DriveTemperatureData. A reference to the drive object.

Required/optional:
Returns:	The drive_ref of this DriveTemperatureData.
Return type:	str
	required

drive_temperature¶

Gets the drive_temperature of this DriveTemperatureData. Drive temperature data.

Required/optional:
Returns:	The drive_temperature of this DriveTemperatureData.
Return type:	DriveTemperature
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_temperature_returned module¶

DriveTemperatureReturned.py

class netapp.santricity.models.symbol.drive_temperature_returned.DriveTemperatureReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_temp_data¶

Gets the drive_temp_data of this DriveTemperatureReturned. An array of drive temperature data. This field is only valid if returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The drive_temp_data of this DriveTemperatureReturned.
Return type:	list[DriveTemperatureData]
	optional

return_code¶

Gets the return_code of this DriveTemperatureReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this DriveTemperatureReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.drive_type_data module¶

DriveTypeData.py

class netapp.santricity.models.symbol.drive_type_data.DriveTypeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_type¶

Gets the drive_type of this DriveTypeData. This enumeration type is used to distinguish between the different I/O protocols used by the controller to communicate with drives. This is not necessarily the same as the physical drive interface type (PhysicalDriveType).

Required/optional:
Returns:	The drive_type of this DriveTypeData.
Return type:	str
	required

fibre¶

Gets the fibre of this DriveTypeData. This field is present only if the driveType value is DRIVE_TYPE_FIBRE. It contains the address information for a Fibre Channel drive. Such drives are typically multi-ported, so there will be one element in this variable-length array for each I/O port on the drive. The first element in the array is the drive address on the preferred channel, and the second element is the drive address on the redundant channel.

Required/optional:
Returns:	The fibre of this DriveTypeData.
Return type:	list[FibreDriveAddress]
	optional

sas¶

Gets the sas of this DriveTypeData. This field is present only if the driveType value is DRIVE_TYPE_SAS. It contains the address information for a serial-attached SCSI drive.

Required/optional:
Returns:	The sas of this DriveTypeData.
Return type:	SasDriveAddress
	optional

scsi¶

Gets the scsi of this DriveTypeData. This field is present only if the driveType value is DRIVE_TYPE_SCSI. It contains the address information for a SCSI drive.

Required/optional:
Returns:	The scsi of this DriveTypeData.
Return type:	SCSIDriveAddress
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.dual_mirror_primary module¶

DualMirrorPrimary.py

class netapp.santricity.models.symbol.dual_mirror_primary.DualMirrorPrimary[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

mirror_volume¶

Gets the mirror_volume of this DualMirrorPrimary. The reference to the mirror volume with a role conflict.

Required/optional:
Returns:	The mirror_volume of this DualMirrorPrimary.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.dual_mirror_secondary module¶

DualMirrorSecondary.py

class netapp.santricity.models.symbol.dual_mirror_secondary.DualMirrorSecondary[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

mirror_volume¶

Gets the mirror_volume of this DualMirrorSecondary. The reference to the mirror volume with a role conflict.

Required/optional:
Returns:	The mirror_volume of this DualMirrorSecondary.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.dve_volume module¶

DVEVolume.py

class netapp.santricity.models.symbol.dve_volume.DVEVolume[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

amount_of_increase¶

Gets the amount_of_increase of this DVEVolume. The amount of capacity increase for the volume.

Required/optional:
Returns:	The amount_of_increase of this DVEVolume.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume¶

Gets the volume of this DVEVolume. The reference to the volume.

Required/optional:
Returns:	The volume of this DVEVolume.
Return type:	str
	required

netapp.santricity.models.symbol.embedded_snmp_agent_default_attributes module¶

EmbeddedSNMPAgentDefaultAttributes.py

class netapp.santricity.models.symbol.embedded_snmp_agent_default_attributes.EmbeddedSNMPAgentDefaultAttributes[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

default_system_variable_value¶

Gets the default_system_variable_value of this EmbeddedSNMPAgentDefaultAttributes. Default value for system variables that are settable via SYMbol.

Required/optional:
Returns:	The default_system_variable_value of this EmbeddedSNMPAgentDefaultAttributes.
Return type:	str
	required

max_communities¶

Gets the max_communities of this EmbeddedSNMPAgentDefaultAttributes. Maximum number of communities that can be added with the addSNMPCommunity procedure.

Required/optional:
Returns:	The max_communities of this EmbeddedSNMPAgentDefaultAttributes.
Return type:	int
	required

max_community_name_string_length¶

Gets the max_community_name_string_length of this EmbeddedSNMPAgentDefaultAttributes. Maximum length of a community name.

Required/optional:
Returns:	The max_community_name_string_length of this EmbeddedSNMPAgentDefaultAttributes.
Return type:	int
	required

max_system_variable_string_length¶

Gets the max_system_variable_string_length of this EmbeddedSNMPAgentDefaultAttributes. Maximum length of the user-settable system variables.

Required/optional:
Returns:	The max_system_variable_string_length of this EmbeddedSNMPAgentDefaultAttributes.
Return type:	int
	required

max_trap_destinations¶

Gets the max_trap_destinations of this EmbeddedSNMPAgentDefaultAttributes. Maximum number of trap destinations that can be added with the addSNMPTrapDestination procedure.

Required/optional:
Returns:	The max_trap_destinations of this EmbeddedSNMPAgentDefaultAttributes.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.enclosure_state_capture_retrieve_chunk_details module¶

EnclosureStateCaptureRetrieveChunkDetails.py

class netapp.santricity.models.symbol.enclosure_state_capture_retrieve_chunk_details.EnclosureStateCaptureRetrieveChunkDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

block_data¶

Gets the block_data of this EnclosureStateCaptureRetrieveChunkDetails. An array of block data.

Required/optional:
Returns:	The block_data of this EnclosureStateCaptureRetrieveChunkDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray_ref¶

Gets the tray_ref of this EnclosureStateCaptureRetrieveChunkDetails. A reference to the enclosure.

Required/optional:
Returns:	The tray_ref of this EnclosureStateCaptureRetrieveChunkDetails.
Return type:	str
	required

netapp.santricity.models.symbol.enclosure_state_capture_retrieve_start_details module¶

EnclosureStateCaptureRetrieveStartDetails.py

class netapp.santricity.models.symbol.enclosure_state_capture_retrieve_start_details.EnclosureStateCaptureRetrieveStartDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray_ref¶

Gets the tray_ref of this EnclosureStateCaptureRetrieveStartDetails. A reference to the enclosure.

Required/optional:
Returns:	The tray_ref of this EnclosureStateCaptureRetrieveStartDetails.
Return type:	str
	required

netapp.santricity.models.symbol.encrypted_password module¶

EncryptedPassword.py

class netapp.santricity.models.symbol.encrypted_password.EncryptedPassword[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

pkcs5_aes_data¶

Gets the pkcs5_aes_data of this EncryptedPassword. The PKCS#5 data associated with an AES encrypted password. This field is valid only if the encryption type is ENCRYPT_PKCS5_SHA2_AES.

Required/optional:
Returns:	The pkcs5_aes_data of this EncryptedPassword.
Return type:	PKCS5EncryptionData
	optional

pkcs5_data¶

Gets the pkcs5_data of this EncryptedPassword. The PKCS #5 data associated with the encrypted password. This field is valid only if the encryption type is ENCRYPT_PKCS5_SHA1_DES.

Required/optional:
Returns:	The pkcs5_data of this EncryptedPassword.
Return type:	PKCS5EncryptionData
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this EncryptedPassword. This enumeration object is used to identify the type of encryption used for a particular operation or object.

Required/optional:
Returns:	The type of this EncryptedPassword.
Return type:	str
	required

netapp.santricity.models.symbol.energy_star_data module¶

EnergyStarData.py

class netapp.santricity.models.symbol.energy_star_data.EnergyStarData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

number_of_trays¶

Gets the number_of_trays of this EnergyStarData. The number of trays reporting power data.

Required/optional:
Returns:	The number_of_trays of this EnergyStarData.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

total_power¶

Gets the total_power of this EnergyStarData. The total measured power drawn by the array measured in watts.

Required/optional:
Returns:	The total_power of this EnergyStarData.
Return type:	int
	required

tray_power¶

Gets the tray_power of this EnergyStarData. List of power data by tray.

Required/optional:
Returns:	The tray_power of this EnergyStarData.
Return type:	list[TrayPower]
	required

netapp.santricity.models.symbol.energy_star_data_return module¶

EnergyStarDataReturn.py

class netapp.santricity.models.symbol.energy_star_data_return.EnergyStarDataReturn[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

energy_star_data¶

Gets the energy_star_data of this EnergyStarDataReturn. This field is present only if the value of returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The energy_star_data of this EnergyStarDataReturn.
Return type:	EnergyStarData
	optional

return_code¶

Gets the return_code of this EnergyStarDataReturn. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this EnergyStarDataReturn.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.enh_eth_features_state module¶

EnhEthFeaturesState.py

class netapp.santricity.models.symbol.enh_eth_features_state.EnhEthFeaturesState[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

fcoe_bandwidth¶

Gets the fcoe_bandwidth of this EnhEthFeaturesState. This bool indicates if this interface has the FCoE bandwidth.

Required/optional:
Returns:	The fcoe_bandwidth of this EnhEthFeaturesState.
Return type:	bool
	required

fcoe_fip_mismatch¶

Gets the fcoe_fip_mismatch of this EnhEthFeaturesState. This bool indicates if this interface has a FCoE/FIP Application Map Mismatch.

Required/optional:
Returns:	The fcoe_fip_mismatch of this EnhEthFeaturesState.
Return type:	bool
	required

fcoe_operational¶

Gets the fcoe_operational of this EnhEthFeaturesState. This bool indicates the Operational mode of the FCoE Application.

Required/optional:
Returns:	The fcoe_operational of this EnhEthFeaturesState.
Return type:	bool
	required

fip_operational¶

Gets the fip_operational of this EnhEthFeaturesState. This bool indicates the Operational mode of the FIP Application. .

Required/optional:
Returns:	The fip_operational of this EnhEthFeaturesState.
Return type:	bool
	required

iscsi_operational¶

Gets the iscsi_operational of this EnhEthFeaturesState. This bool indicates the Operational Mode of the iSCSI Application.

Required/optional:
Returns:	The iscsi_operational of this EnhEthFeaturesState.
Return type:	bool
	required

pfc_operational¶

Gets the pfc_operational of this EnhEthFeaturesState. This bool indicates the Operational mode of the PFC Feature.

Required/optional:
Returns:	The pfc_operational of this EnhEthFeaturesState.
Return type:	bool
	required

pg_operational¶

Gets the pg_operational of this EnhEthFeaturesState. The bool indicates the Operational mode of the PG Feature.

Required/optional:
Returns:	The pg_operational of this EnhEthFeaturesState.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.enh_eth_tlv module¶

EnhEthTLV.py

class netapp.santricity.models.symbol.enh_eth_tlv.EnhEthTLV[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

chassis_idtlv¶

Gets the chassis_idtlv of this EnhEthTLV. This field is mandatory and conveys its information when the enhEthTLVType is equal to ENH_ETH_TLV_CHASSISID.

Required/optional:
Returns:	The chassis_idtlv of this EnhEthTLV.
Return type:	ChassisIDTLV
	optional

enh_eth_tlv_type¶

Gets the enh_eth_tlv_type of this EnhEthTLV. An enumeration that includes Time Length Value (TLV)Types for Enhanced Ethernet. Refer to the IEEE Std 802.1AB-2005

Required/optional:
Returns:	The enh_eth_tlv_type of this EnhEthTLV.
Return type:	str
	required

port_idtlv¶

Gets the port_idtlv of this EnhEthTLV. This field is mandatory and conveys its information when the enhEthTLVType is equal to ENH_ETH_TLV_PORTID.

Required/optional:
Returns:	The port_idtlv of this EnhEthTLV.
Return type:	PortIDTLV
	optional

time_to_live_tlv¶

Gets the time_to_live_tlv of this EnhEthTLV. This field is mandatory and conveys its information when the enhEthTLVType is equal to ENH_ETH_TLV_TIMETOLIVE.

Required/optional:
Returns:	The time_to_live_tlv of this EnhEthTLV.
Return type:	TimeToLiveTLV
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.enh_eth_tlv_set module¶

EnhEthTLVSet.py

class netapp.santricity.models.symbol.enh_eth_tlv_set.EnhEthTLVSet[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

dcbx_summary_data¶

Gets the dcbx_summary_data of this EnhEthTLVSet. This is the summary of DCBX data.

Required/optional:
Returns:	The dcbx_summary_data of this EnhEthTLVSet.
Return type:	list[DCBXSummaryData]
	required

enh_eth_tlv¶

Gets the enh_eth_tlv of this EnhEthTLVSet. This is Enhanced Ethernet TLV data (local, remote and operational).

Required/optional:
Returns:	The enh_eth_tlv of this EnhEthTLVSet.
Return type:	list[EnhEthTLV]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.enhanced_ethernet_statistics module¶

EnhancedEthernetStatistics.py

class netapp.santricity.models.symbol.enhanced_ethernet_statistics.EnhancedEthernetStatistics[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

enh_eth_features_state¶

Gets the enh_eth_features_state of this EnhancedEthernetStatistics. This structure contains the operational state of the given DCBX features for Enhanced Ethernet.

Required/optional:
Returns:	The enh_eth_features_state of this EnhancedEthernetStatistics.
Return type:	EnhEthFeaturesState
	required

enhanced_ethernet_flow_control_status¶

Gets the enhanced_ethernet_flow_control_status of this EnhancedEthernetStatistics. This is the port/interface priority-based flow control state

Required/optional:
Returns:	The enhanced_ethernet_flow_control_status of this EnhancedEthernetStatistics.
Return type:	str
	required

interfaces¶

Gets the interfaces of this EnhancedEthernetStatistics. This is the Interface(s) to which the Enhanced Ethernet Statistics apply. Even though this is shown as an array, it will only be a single instance.

Required/optional:
Returns:	The interfaces of this EnhancedEthernetStatistics.
Return type:	list[str]
	required

local_tl_vs¶

Gets the local_tl_vs of this EnhancedEthernetStatistics. This structure contains the TLV set for the Local Node.

Required/optional:
Returns:	The local_tl_vs of this EnhancedEthernetStatistics.
Return type:	EnhEthTLVSet
	required

operational_tl_vs¶

Gets the operational_tl_vs of this EnhancedEthernetStatistics. This structure contains the Operational (Negotiated) TLV set.

Required/optional:
Returns:	The operational_tl_vs of this EnhancedEthernetStatistics.
Return type:	EnhEthTLVSet
	required

remote_tl_vs¶

Gets the remote_tl_vs of this EnhancedEthernetStatistics. This structure contains the TLVs sent from the Remote Node.

Required/optional:
Returns:	The remote_tl_vs of this EnhancedEthernetStatistics.
Return type:	EnhEthTLVSet
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.enhanced_ib_baselined_statistics module¶

EnhancedIbBaselinedStatistics.py

class netapp.santricity.models.symbol.enhanced_ib_baselined_statistics.EnhancedIbBaselinedStatistics[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ib_interface_statistics_raw¶

Gets the ib_interface_statistics_raw of this EnhancedIbBaselinedStatistics. Contains “raw” IB host interface statistics. (1) Note that these raw values are reset to zero on a controller reboot so the counters will contain values accumulated since the last controller reboot. The one exception to this rule is when the Infiniband (IB) subnet manager running in the IB fabric resets a counter, usually as a result of a manual command issued from a host. (2) Note that the raw counters may reach a hardware limited maximum value in which case they will not accumulate any more until reset by the subnet manager or if the controller reboots. If the counter reaches its maximum value, the StatisticQualifier element for the statistic will indicate STAT_INVALID_STUCK and the value will reflect the max value. (3) Note that raw statistics that are not supported by that particular type of IB hardware will return a qualifier of STAT_NOT SUPPORTED.

Required/optional:
Returns:	The ib_interface_statistics_raw of this EnhancedIbBaselinedStatistics.
Return type:	list[EnhancedIbInterfaceStatistics]
	required

ib_interface_statistics_rel¶

Gets the ib_interface_statistics_rel of this EnhancedIbBaselinedStatistics. Contains “rel” IB host interface statistics. “Rel” is the difference between the raw counters (see IbInterfaceStatisticsRaw) and the value of the counters at the time setIserStatisticsBaseline() or setIbStatisticsBaseline() was invoked. (1) A controller reboot sets the baseline timestamp for counters for that controller to the time of the (re)boot with counter values all set to zero. (2) The subnet manager resetting a counter may cause the “rel” difference to be negative, in which case the counter’s associated “value” attribute will be negative and the StatisticQualifier element will indicate STAT_INVALID_EXTERNAL_RESET. (3) Note that if the associated raw counter is set to STAT_INVALID_STUCK then the rel counter will also be set to STAT_INVALID_STUCK. (4) If the associated raw counter is set to STAT_NOT_SUPPORTED then the rel counter will be set to STAT_NOT_SUPPORTED.

Required/optional:
Returns:	The ib_interface_statistics_rel of this EnhancedIbBaselinedStatistics.
Return type:	list[EnhancedIbInterfaceStatistics]
	required

time_data¶

Gets the time_data of this EnhancedIbBaselinedStatistics. The time at which the baseline was established.

Required/optional:
Returns:	The time_data of this EnhancedIbBaselinedStatistics.
Return type:	StatisticalTimeData
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.enhanced_ib_interface_statistics module¶

EnhancedIbInterfaceStatistics.py

class netapp.santricity.models.symbol.enhanced_ib_interface_statistics.EnhancedIbInterfaceStatistics[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

interface_ref¶

Gets the interface_ref of this EnhancedIbInterfaceStatistics. A reference to the interface for which the statistics apply.

Required/optional:
Returns:	The interface_ref of this EnhancedIbInterfaceStatistics.
Return type:	str
	required

recovered_link_errors¶

Gets the recovered_link_errors of this EnhancedIbInterfaceStatistics. The number of recovered link errors.

Required/optional:
Returns:	The recovered_link_errors of this EnhancedIbInterfaceStatistics.
Return type:	StatisticalContainer
	required

rx_constraint_error_packet_discards¶

Gets the rx_constraint_error_packet_discards of this EnhancedIbInterfaceStatistics. The number of inbound packets discarded because either (1) the packet is a raw datagram, (2) the packet has a wrong partition key, or (3) the packet has a bad transport header version.

Required/optional:
Returns:	The rx_constraint_error_packet_discards of this EnhancedIbInterfaceStatistics.
Return type:	StatisticalContainer
	required

rx_ebp_delimited_packets¶

Gets the rx_ebp_delimited_packets of this EnhancedIbInterfaceStatistics. The total number of packets with End Bad Packet delimiter that have been received on the port.

Required/optional:
Returns:	The rx_ebp_delimited_packets of this EnhancedIbInterfaceStatistics.
Return type:	StatisticalContainer
	required

rx_multicast_total_packets¶

Gets the rx_multicast_total_packets of this EnhancedIbInterfaceStatistics. Total number of multicast packets, including multicast packets containing errors received from all VLs on the port.

Required/optional:
Returns:	The rx_multicast_total_packets of this EnhancedIbInterfaceStatistics.
Return type:	StatisticalContainer
	required

rx_packet_errors¶

Gets the rx_packet_errors of this EnhancedIbInterfaceStatistics. The number of packets containing an error that have been received on the port.

Required/optional:
Returns:	The rx_packet_errors of this EnhancedIbInterfaceStatistics.
Return type:	StatisticalContainer
	required

rx_subnet_management_dropped_packets¶

Gets the rx_subnet_management_dropped_packets of this EnhancedIbInterfaceStatistics. The number of virtual lane 15 packets dropped due to resource limitations (e.g., lack of buffers) in the port.

Required/optional:
Returns:	The rx_subnet_management_dropped_packets of this EnhancedIbInterfaceStatistics.
Return type:	StatisticalContainer
	required

rx_total_bytes¶

Gets the rx_total_bytes of this EnhancedIbInterfaceStatistics. The number of bytes received at the port on all virtual lanes.

Required/optional:
Returns:	The rx_total_bytes of this EnhancedIbInterfaceStatistics.
Return type:	StatisticalContainer
	required

rx_total_packets¶

Gets the rx_total_packets of this EnhancedIbInterfaceStatistics. The number of packets received at the port on all virtual lanes.

Required/optional:
Returns:	The rx_total_packets of this EnhancedIbInterfaceStatistics.
Return type:	StatisticalContainer
	required

rx_unicast_total_packets¶

Gets the rx_unicast_total_packets of this EnhancedIbInterfaceStatistics. Total number of unicast packets, including unicast packets containing errors, and excluding link packets, received from all VLs on the port.

Required/optional:
Returns:	The rx_unicast_total_packets of this EnhancedIbInterfaceStatistics.
Return type:	StatisticalContainer
	required

symbol_errors¶

Gets the symbol_errors of this EnhancedIbInterfaceStatistics. The number of symbol errors.

Required/optional:
Returns:	The symbol_errors of this EnhancedIbInterfaceStatistics.
Return type:	StatisticalContainer
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tx_constraint_error_packet_discards¶

Gets the tx_constraint_error_packet_discards of this EnhancedIbInterfaceStatistics. The number of outbound packets discarded because either (1) the packet is a raw datagram, (2) the packet has a wrong partition key, or (3) the packet has a bad transport header version.

Required/optional:
Returns:	The tx_constraint_error_packet_discards of this EnhancedIbInterfaceStatistics.
Return type:	StatisticalContainer
	required

tx_multicast_total_packets¶

Gets the tx_multicast_total_packets of this EnhancedIbInterfaceStatistics. Total number of multicast packets transmitted on all VLs from the port. This may include multicast packets with errors.

Required/optional:
Returns:	The tx_multicast_total_packets of this EnhancedIbInterfaceStatistics.
Return type:	StatisticalContainer
	required

tx_port_down_packet_discards¶

Gets the tx_port_down_packet_discards of this EnhancedIbInterfaceStatistics. The number of outbound packets discarded because the port is either down or congested.

Required/optional:
Returns:	The tx_port_down_packet_discards of this EnhancedIbInterfaceStatistics.
Return type:	StatisticalContainer
	required

tx_total_bytes¶

Gets the tx_total_bytes of this EnhancedIbInterfaceStatistics. The number of bytes transmitted at the port on all virtual lanes.

Required/optional:
Returns:	The tx_total_bytes of this EnhancedIbInterfaceStatistics.
Return type:	StatisticalContainer
	required

tx_total_packets¶

Gets the tx_total_packets of this EnhancedIbInterfaceStatistics. The number of packets transmitted at the port on all virtual lanes.

Required/optional:
Returns:	The tx_total_packets of this EnhancedIbInterfaceStatistics.
Return type:	StatisticalContainer
	required

tx_unicast_total_packets¶

Gets the tx_unicast_total_packets of this EnhancedIbInterfaceStatistics. Total number of unicast packets transmitted on all VLs from the port. This may include unicast packets with errors and excludes link packets.

Required/optional:
Returns:	The tx_unicast_total_packets of this EnhancedIbInterfaceStatistics.
Return type:	StatisticalContainer
	required

tx_wait_time¶

Gets the tx_wait_time of this EnhancedIbInterfaceStatistics. The number of microseconds during which the port had data to transmit, but none was sent because of insufficient credits or due to arbitration.

Required/optional:
Returns:	The tx_wait_time of this EnhancedIbInterfaceStatistics.
Return type:	StatisticalContainer
	required

unrecovered_link_errors¶

Gets the unrecovered_link_errors of this EnhancedIbInterfaceStatistics. The number of unrecovered link errors.

Required/optional:
Returns:	The unrecovered_link_errors of this EnhancedIbInterfaceStatistics.
Return type:	StatisticalContainer
	required

netapp.santricity.models.symbol.enhanced_ib_statistical_data module¶

EnhancedIbStatisticalData.py

class netapp.santricity.models.symbol.enhanced_ib_statistical_data.EnhancedIbStatisticalData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

baselined_stats¶

Gets the baselined_stats of this EnhancedIbStatisticalData. These are Raw and Relative IB stats.

Required/optional:
Returns:	The baselined_stats of this EnhancedIbStatisticalData.
Return type:	EnhancedIbBaselinedStatistics
	required

controller¶

Gets the controller of this EnhancedIbStatisticalData. This field is a reference to the controller that collected these statistics.

Required/optional:
Returns:	The controller of this EnhancedIbStatisticalData.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.enhanced_ib_statistics_returned module¶

EnhancedIbStatisticsReturned.py

class netapp.santricity.models.symbol.enhanced_ib_statistics_returned.EnhancedIbStatisticsReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ib_statistics¶

Gets the ib_statistics of this EnhancedIbStatisticsReturned. This field contains all IB statistical data for SA.

Required/optional:
Returns:	The ib_statistics of this EnhancedIbStatisticsReturned.
Return type:	list[EnhancedIbStatisticalData]
	optional

return_code¶

Gets the return_code of this EnhancedIbStatisticsReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this EnhancedIbStatisticsReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.env_card_log_data module¶

EnvCardLogData.py

class netapp.santricity.models.symbol.env_card_log_data.EnvCardLogData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

log¶

Gets the log of this EnvCardLogData. The event log data for the the environmental card, as an opaque byte array

Required/optional:
Returns:	The log of this EnvCardLogData.
Return type:	str
	required

physical_location¶

Gets the physical_location of this EnvCardLogData. The tray and slot number of the environmental card.

Required/optional:
Returns:	The physical_location of this EnvCardLogData.
Return type:	Location
	required

serial_number¶

Gets the serial_number of this EnvCardLogData. The serial number of the environmental card

Required/optional:
Returns:	The serial_number of this EnvCardLogData.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.env_card_log_data_returned module¶

EnvCardLogDataReturned.py

class netapp.santricity.models.symbol.env_card_log_data_returned.EnvCardLogDataReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

env_card_log¶

Gets the env_card_log of this EnvCardLogDataReturned. The log data for the environmental card. This field is only present if the returnCode is RETCODE_OK.

Required/optional:
Returns:	The env_card_log of this EnvCardLogDataReturned.
Return type:	EnvCardLogData
	optional

return_code¶

Gets the return_code of this EnvCardLogDataReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this EnvCardLogDataReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.esm module¶

Esm.py

class netapp.santricity.models.symbol.esm.Esm[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

board_id¶

Gets the board_id of this Esm. The board ID of the ESM card.

Required/optional:
Returns:	The board_id of this Esm.
Return type:	str
	required

current_speed¶

Gets the current_speed of this Esm. The current speed of the ESM.

Required/optional:
Returns:	The current_speed of this Esm.
Return type:	str
	required

esm_interface_attributes¶

Gets the esm_interface_attributes of this Esm. Attributes that are specific to the ESM’s I/O interface type.

Required/optional:
Returns:	The esm_interface_attributes of this Esm.
Return type:	EsmInterfaceAttributes
	required

esm_interface_data¶

Gets the esm_interface_data of this Esm. The interface type information for the ESM. This field is now deprecated. The field esmInterfaceAttributes should be used instead.

Required/optional:
Returns:	The esm_interface_data of this Esm.
Return type:	ESMInterfaceTypeData
	required

esm_ref¶

Gets the esm_ref of this Esm. The reference for this physical ESM.

Required/optional:
Returns:	The esm_ref of this Esm.
Return type:	str
	required

esm_type¶

Gets the esm_type of this Esm. Type of ESM or IOM.

Required/optional:
Returns:	The esm_type of this Esm.
Return type:	str
	required

factory_defaults_data¶

Gets the factory_defaults_data of this Esm. This field contains information about the version of the ESM’s factory default settings.

Required/optional:
Returns:	The factory_defaults_data of this Esm.
Return type:	EsmFactoryDefaultsVersionData
	required

fibre_esm¶

Gets the fibre_esm of this Esm. The Fibre Channel information for the ESM. This field is deprecated. The field fibreEsmAddress located within esmInterfaceAttributes should be used instead.

Required/optional:
Returns:	The fibre_esm of this Esm.
Return type:	FibreESMAddress
	required

fru_type¶

Gets the fru_type of this Esm. The field replaceable unit type of the ESM.

Required/optional:
Returns:	The fru_type of this Esm.
Return type:	str
	required

has_tray_identity_indicator¶

Gets the has_tray_identity_indicator of this Esm. The device contains 7-segment indicators used to display the Tray Identity.

Required/optional:
Returns:	The has_tray_identity_indicator of this Esm.
Return type:	bool
	required

id¶

Gets the id of this Esm.

Required/optional:
Returns:	The id of this Esm.
Return type:	str
	optional

is_trunk_capable¶

Gets the is_trunk_capable of this Esm. True when ESM is trunk capable.

Required/optional:
Returns:	The is_trunk_capable of this Esm.
Return type:	bool
	required

locate_in_progress¶

Gets the locate_in_progress of this Esm. Indicates that a locate operation for the device is currently active. The device will show a visual indication to aid an operator in locating the device.

Required/optional:
Returns:	The locate_in_progress of this Esm.
Return type:	bool
	required

manufacturer¶

Gets the manufacturer of this Esm. The date the ESM was manufactured.

Required/optional:
Returns:	The manufacturer of this Esm.
Return type:	str
	required

manufacturer_date¶

Gets the manufacturer_date of this Esm. The date the ESM was manufactured.

Required/optional:
Returns:	The manufacturer_date of this Esm.
Return type:	int
	required

max_speed¶

Gets the max_speed of this Esm. The maximum speed of the ESM.

Required/optional:
Returns:	The max_speed of this Esm.
Return type:	str
	required

non_redundant_access¶

Gets the non_redundant_access of this Esm. True if the ESM does not have redundant access.

Required/optional:
Returns:	The non_redundant_access of this Esm.
Return type:	bool
	required

part_number¶

Gets the part_number of this Esm. The part number of the ESM.

Required/optional:
Returns:	The part_number of this Esm.
Return type:	str
	required

physical_location¶

Gets the physical_location of this Esm. The physical location of the ESM. The parent reference in Location identifies the tray containing the ESM, and the position field is the parent-relative/like-component relative slot number of the ESM, starting at 1.

Required/optional:
Returns:	The physical_location of this Esm.
Return type:	Location
	required

product_id¶

Gets the product_id of this Esm. The product identifier of the ESM.

Required/optional:
Returns:	The product_id of this Esm.
Return type:	str
	required

repair_policy¶

Gets the repair_policy of this Esm. The repair policy for the ESM component.

Required/optional:
Returns:	The repair_policy of this Esm.
Return type:	RepairPolicy
	required

reserved1¶

Gets the reserved1 of this Esm.

Required/optional:
Returns:	The reserved1 of this Esm.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this Esm.

Required/optional:
Returns:	The reserved2 of this Esm.
Return type:	str
	optional

rtr_attributes¶

Gets the rtr_attributes of this Esm. The CRU type of the ESM plus its ready-to-remove attributes, which are based on the CRU type.

Required/optional:
Returns:	The rtr_attributes of this Esm.
Return type:	RTRAttributes
	required

serial_number¶

Gets the serial_number of this Esm. The serial number of the ESM.

Required/optional:
Returns:	The serial_number of this Esm.
Return type:	str
	required

software_version¶

Gets the software_version of this Esm. The firmware version of the ESM.

Required/optional:
Returns:	The software_version of this Esm.
Return type:	str
	required

status¶

Gets the status of this Esm. The operational status for this ESM.

Required/optional:
Returns:	The status of this Esm.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

trunk_miswire¶

Gets the trunk_miswire of this Esm. True only when ESM is trunk capable and cabled incorrectly, or not trunk capable but connected in trunk mode.

Required/optional:
Returns:	The trunk_miswire of this Esm.
Return type:	bool
	required

working_channel¶

Gets the working_channel of this Esm. The channel to the tray that is still operational (if nonRedundantAccess is True).

Required/optional:
Returns:	The working_channel of this Esm.
Return type:	int
	required

netapp.santricity.models.symbol.esm_factory_defaults_version_data module¶

EsmFactoryDefaultsVersionData.py

class netapp.santricity.models.symbol.esm_factory_defaults_version_data.EsmFactoryDefaultsVersionData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

factory_defaults_version¶

Gets the factory_defaults_version of this EsmFactoryDefaultsVersionData. The factory default version string. The format of the string is:

Required/optional:
Returns:	The factory_defaults_version of this EsmFactoryDefaultsVersionData.
Return type:	str
	required

is_supported¶

Gets the is_supported of this EsmFactoryDefaultsVersionData. This field is set to true if the ESM supports version reporting and downloading of factory default settings, and false otherwise. A setting of false in this field can mean either (1) the ESM is a legacy ESM for which the version-reporting feature is unavailable or (2) the ESM is capable of supporting version-reporting, but is not running the correct firmware version to do so.

Required/optional:
Returns:	The is_supported of this EsmFactoryDefaultsVersionData.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.esm_firmware_update_descriptor module¶

ESMFirmwareUpdateDescriptor.py

class netapp.santricity.models.symbol.esm_firmware_update_descriptor.ESMFirmwareUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

firmware_update_descriptor¶

Gets the firmware_update_descriptor of this ESMFirmwareUpdateDescriptor. The chunk of firmware to download to the ESM card.

Required/optional:
Returns:	The firmware_update_descriptor of this ESMFirmwareUpdateDescriptor.
Return type:	FirmwareUpdateDescriptor
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray_ref¶

Gets the tray_ref of this ESMFirmwareUpdateDescriptor. This object uniquely identifies the particular tray within the storage array that will receive the new firmware.

Required/optional:
Returns:	The tray_ref of this ESMFirmwareUpdateDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.esm_interface_attributes module¶

EsmInterfaceAttributes.py

class netapp.santricity.models.symbol.esm_interface_attributes.EsmInterfaceAttributes[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

fibre_esm_attributes¶

Gets the fibre_esm_attributes of this EsmInterfaceAttributes. This field is only present if the ioInterfaceType value is IO_IF_FC. It contains attributes that are specific to fibre channel ESMs.

Required/optional:
Returns:	The fibre_esm_attributes of this EsmInterfaceAttributes.
Return type:	FibreEsmAttributes
	optional

io_interface_type¶

Gets the io_interface_type of this EsmInterfaceAttributes. This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller.

Required/optional:
Returns:	The io_interface_type of this EsmInterfaceAttributes.
Return type:	str
	required

sas_esm_attributes¶

Gets the sas_esm_attributes of this EsmInterfaceAttributes. This field is only present if the ioInterfaceType value is IO_IF_SAS. It contains attributes that are specific serial-attached SCSI ESMs.

Required/optional:
Returns:	The sas_esm_attributes of this EsmInterfaceAttributes.
Return type:	SasEsmAttributes
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.esm_interface_type_data module¶

ESMInterfaceTypeData.py

class netapp.santricity.models.symbol.esm_interface_type_data.ESMInterfaceTypeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

io_interface_type¶

Gets the io_interface_type of this ESMInterfaceTypeData. This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller.

Required/optional:
Returns:	The io_interface_type of this ESMInterfaceTypeData.
Return type:	str
	required

port_list¶

Gets the port_list of this ESMInterfaceTypeData. A list of detailed information for each port.

Required/optional:
Returns:	The port_list of this ESMInterfaceTypeData.
Return type:	PortList
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.esm_lost_redundancy_failure module¶

EsmLostRedundancyFailure.py

class netapp.santricity.models.symbol.esm_lost_redundancy_failure.EsmLostRedundancyFailure[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

esm_lost_redundancy¶

Gets the esm_lost_redundancy of this EsmLostRedundancyFailure. This object uniquely identifies the particular ESM card within the storage array that has lost redundancy.

Required/optional:
Returns:	The esm_lost_redundancy of this EsmLostRedundancyFailure.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

working_channel¶

Gets the working_channel of this EsmLostRedundancyFailure. The channel to the ESM card that is still operational.

Required/optional:
Returns:	The working_channel of this EsmLostRedundancyFailure.
Return type:	int
	required

netapp.santricity.models.symbol.ethernet_interface module¶

EthernetInterface.py

class netapp.santricity.models.symbol.ethernet_interface.EthernetInterface[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

alias¶

Gets the alias of this EthernetInterface. An ASCII string that identifies the alias name for the interface; this name is presumed to be associated with the IP protocol address.

Required/optional:
Returns:	The alias of this EthernetInterface.
Return type:	str
	required

bootp_used¶

Gets the bootp_used of this EthernetInterface. Bootpserver used to get network parameters.

Required/optional:
Returns:	The bootp_used of this EthernetInterface.
Return type:	bool
	required

channel¶

Gets the channel of this EthernetInterface. The channel number of this Ethernet interface.

Required/optional:
Returns:	The channel of this EthernetInterface.
Return type:	int
	required

configured_speed_setting¶

Gets the configured_speed_setting of this EthernetInterface. Configured setting for the interface.

Required/optional:
Returns:	The configured_speed_setting of this EthernetInterface.
Return type:	str
	required

current_speed¶

Gets the current_speed of this EthernetInterface. Current speed of the interface.

Required/optional:
Returns:	The current_speed of this EthernetInterface.
Return type:	str
	required

full_duplex¶

Gets the full_duplex of this EthernetInterface. If set to true, the interface is operating in full duplex mode; otherwise, it is operating in half-duplex mode.

Required/optional:
Returns:	The full_duplex of this EthernetInterface.
Return type:	bool
	required

gateway_ip¶

Gets the gateway_ip of this EthernetInterface. IP address of the gateway.

Required/optional:
Returns:	The gateway_ip of this EthernetInterface.
Return type:	int
	required

interface_name¶

Gets the interface_name of this EthernetInterface. Name of the Ethernet port, as reported by the controller.

Required/optional:
Returns:	The interface_name of this EthernetInterface.
Return type:	str
	required

interface_ref¶

Gets the interface_ref of this EthernetInterface. The unique identifier for a given instance of this structure.

Required/optional:
Returns:	The interface_ref of this EthernetInterface.
Return type:	str
	required

ip¶

Gets the ip of this EthernetInterface. The 32-bit IP protocol address assigned to the interface.

Required/optional:
Returns:	The ip of this EthernetInterface.
Return type:	int
	required

ipv4_address¶

Gets the ipv4_address of this EthernetInterface. The IPV4 address for the interface.

Required/optional:
Returns:	The ipv4_address of this EthernetInterface.
Return type:	str
	required

ipv4_address_config_method¶

Gets the ipv4_address_config_method of this EthernetInterface. The method by which the IPV4 address information is configured.

Required/optional:
Returns:	The ipv4_address_config_method of this EthernetInterface.
Return type:	str
	required

ipv4_enabled¶

Gets the ipv4_enabled of this EthernetInterface. True if IPV4 is enabled for this interface; otherwise false.

Required/optional:
Returns:	The ipv4_enabled of this EthernetInterface.
Return type:	bool
	required

ipv4_subnet_mask¶

Gets the ipv4_subnet_mask of this EthernetInterface. The IPV4 subnet mask for the interface.

Required/optional:
Returns:	The ipv4_subnet_mask of this EthernetInterface.
Return type:	str
	required

ipv6_address_config_method¶

Gets the ipv6_address_config_method of this EthernetInterface. The method by which the IPV6 address information is configured for the interface.

Required/optional:
Returns:	The ipv6_address_config_method of this EthernetInterface.
Return type:	str
	required

ipv6_enabled¶

Gets the ipv6_enabled of this EthernetInterface. True if IPV6 is enabled for this interface; otherwise false.

Required/optional:
Returns:	The ipv6_enabled of this EthernetInterface.
Return type:	bool
	required

ipv6_local_address¶

Gets the ipv6_local_address of this EthernetInterface. The IPV6 local address for the interface and associated data.

Required/optional:
Returns:	The ipv6_local_address of this EthernetInterface.
Return type:	IpV6AddressData
	required

ipv6_port_routable_addresses¶

Gets the ipv6_port_routable_addresses of this EthernetInterface. The set of IPV6 port routable addresses for the interface.

Required/optional:
Returns:	The ipv6_port_routable_addresses of this EthernetInterface.
Return type:	list[IpV6AddressData]
	required

ipv6_port_static_routable_address¶

Gets the ipv6_port_static_routable_address of this EthernetInterface. The IPV6 static routable address for the interface and associated data.

Required/optional:
Returns:	The ipv6_port_static_routable_address of this EthernetInterface.
Return type:	IpV6AddressData
	required

link_status¶

Gets the link_status of this EthernetInterface. The status of the network link for this interface.

Required/optional:
Returns:	The link_status of this EthernetInterface.
Return type:	str
	required

mac_addr¶

Gets the mac_addr of this EthernetInterface. An ASCII string representation of the globally-unique 48-bit MAC address assigned to the Ethernet interface.

Required/optional:
Returns:	The mac_addr of this EthernetInterface.
Return type:	str
	required

physical_location¶

Gets the physical_location of this EthernetInterface. The physical location of the Ethernet interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying “1st ethernet interface relative to the parent,” “2nd ethernet interface relative to the parent,” etc. This “interface number” is independent of the interface’s channel association.

Required/optional:
Returns:	The physical_location of this EthernetInterface.
Return type:	Location
	required

reserved1¶

Gets the reserved1 of this EthernetInterface.

Required/optional:
Returns:	The reserved1 of this EthernetInterface.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this EthernetInterface.

Required/optional:
Returns:	The reserved2 of this EthernetInterface.
Return type:	str
	optional

rlogin_enabled¶

Gets the rlogin_enabled of this EthernetInterface. True if rlogin sessions are allowed.

Required/optional:
Returns:	The rlogin_enabled of this EthernetInterface.
Return type:	bool
	required

setup_error¶

Gets the setup_error of this EthernetInterface. Set to true if there is a configuration error.

Required/optional:
Returns:	The setup_error of this EthernetInterface.
Return type:	bool
	required

speed¶

Gets the speed of this EthernetInterface. The speed of the interface, as currently configured, in Mbit/sec.

Required/optional:
Returns:	The speed of this EthernetInterface.
Return type:	int
	required

subnet_mask¶

Gets the subnet_mask of this EthernetInterface. Network subnet mask.

Required/optional:
Returns:	The subnet_mask of this EthernetInterface.
Return type:	int
	required

supported_speed_settings¶

Gets the supported_speed_settings of this EthernetInterface. Support speed setting for interface

Required/optional:
Returns:	The supported_speed_settings of this EthernetInterface.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ethernet_interface_data module¶

EthernetInterfaceData.py

class netapp.santricity.models.symbol.ethernet_interface_data.EthernetInterfaceData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

autoconfig_support¶

Gets the autoconfig_support of this EthernetInterfaceData. If set to true, autoconfiguration is supported.

Required/optional:
Returns:	The autoconfig_support of this EthernetInterfaceData.
Return type:	bool
	required

copper_cable_diagnostics_support¶

Gets the copper_cable_diagnostics_support of this EthernetInterfaceData. If true, support is provided for copper cable diagnostics.

Required/optional:
Returns:	The copper_cable_diagnostics_support of this EthernetInterfaceData.
Return type:	bool
	required

current_interface_speed¶

Gets the current_interface_speed of this EthernetInterfaceData. The speed of the interface, as currently configured.

Required/optional:
Returns:	The current_interface_speed of this EthernetInterfaceData.
Return type:	str
	required

full_duplex¶

Gets the full_duplex of this EthernetInterfaceData. If set to true, the interface is operating in full duplex mode; otherwise, it is operating in half-duplex mode.

Required/optional:
Returns:	The full_duplex of this EthernetInterfaceData.
Return type:	bool
	required

link_status¶

Gets the link_status of this EthernetInterfaceData. The status of the network link for this interface.

Required/optional:
Returns:	The link_status of this EthernetInterfaceData.
Return type:	str
	required

mac_address¶

Gets the mac_address of this EthernetInterfaceData. The Ethernet MAC address associated with the interface.

Required/optional:
Returns:	The mac_address of this EthernetInterfaceData.
Return type:	str
	required

maximum_frame_payload_size¶

Gets the maximum_frame_payload_size of this EthernetInterfaceData. The maximum size of the payload section in an Ethernet frame.

Required/optional:
Returns:	The maximum_frame_payload_size of this EthernetInterfaceData.
Return type:	int
	required

maximum_interface_speed¶

Gets the maximum_interface_speed of this EthernetInterfaceData. The maximum speed supported by the interface.

Required/optional:
Returns:	The maximum_interface_speed of this EthernetInterfaceData.
Return type:	str
	required

part_data¶

Gets the part_data of this EthernetInterfaceData. Vendor-supplied about the physical part.

Required/optional:
Returns:	The part_data of this EthernetInterfaceData.
Return type:	VendorPartData
	required

supported_interface_speeds¶

Gets the supported_interface_speeds of this EthernetInterfaceData. A list of speeds supported by the Ethernet interface.

Required/optional:
Returns:	The supported_interface_speeds of this EthernetInterfaceData.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ethernet_params_update_descriptor module¶

EthernetParamsUpdateDescriptor.py

class netapp.santricity.models.symbol.ethernet_params_update_descriptor.EthernetParamsUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this EthernetParamsUpdateDescriptor. The channel number of this interface.

Required/optional:
Returns:	The channel of this EthernetParamsUpdateDescriptor.
Return type:	int
	required

controller_ref¶

Gets the controller_ref of this EthernetParamsUpdateDescriptor. The intended target of this command.

Required/optional:
Returns:	The controller_ref of this EthernetParamsUpdateDescriptor.
Return type:	str
	required

gateway_ip¶

Gets the gateway_ip of this EthernetParamsUpdateDescriptor. IP address of the gateway.

Required/optional:
Returns:	The gateway_ip of this EthernetParamsUpdateDescriptor.
Return type:	int
	required

interface_name¶

Gets the interface_name of this EthernetParamsUpdateDescriptor. Name of Ethernet port, as reported by bootWare.

Required/optional:
Returns:	The interface_name of this EthernetParamsUpdateDescriptor.
Return type:	str
	required

ip¶

Gets the ip of this EthernetParamsUpdateDescriptor. IP address of the controller. 0 - use bootp.

Required/optional:
Returns:	The ip of this EthernetParamsUpdateDescriptor.
Return type:	int
	required

subnet_mask¶

Gets the subnet_mask of this EthernetParamsUpdateDescriptor. Network subnet mask.

Required/optional:
Returns:	The subnet_mask of this EthernetParamsUpdateDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ethernet_port_statistics module¶

EthernetPortStatistics.py

class netapp.santricity.models.symbol.ethernet_port_statistics.EthernetPortStatistics[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

bytes_received¶

Gets the bytes_received of this EthernetPortStatistics. The total number of bytes received.

Required/optional:
Returns:	The bytes_received of this EthernetPortStatistics.
Return type:	int
	required

bytes_transmitted¶

Gets the bytes_transmitted of this EthernetPortStatistics. The total number of bytes transmitted.

Required/optional:
Returns:	The bytes_transmitted of this EthernetPortStatistics.
Return type:	int
	required

carrier_sense_errors¶

Gets the carrier_sense_errors of this EthernetPortStatistics. The number of times the carrier sense condition was lost or never asserted when attempting to transmit a frame.

Required/optional:
Returns:	The carrier_sense_errors of this EthernetPortStatistics.
Return type:	int
	required

deferred_transmissions¶

Gets the deferred_transmissions of this EthernetPortStatistics. The number of frames for which the first transmission attempt is delayed because the medium is busy.

Required/optional:
Returns:	The deferred_transmissions of this EthernetPortStatistics.
Return type:	int
	required

frame_too_longs¶

Gets the frame_too_longs of this EthernetPortStatistics. The number of received frames that exceed the maximum permitted frame size.

Required/optional:
Returns:	The frame_too_longs of this EthernetPortStatistics.
Return type:	int
	required

interfaces¶

Gets the interfaces of this EthernetPortStatistics. The interface(s) for which the statistics apply. In some cases, the statistics may be aggregated across multiple interfaces. Even though this is shown as an array, it will only be a single instance.

Required/optional:
Returns:	The interfaces of this EthernetPortStatistics.
Return type:	list[str]
	required

late_collisions¶

Gets the late_collisions of this EthernetPortStatistics. The number of times a collision is detected later than 512 bit-times into the transmission of a packet.

Required/optional:
Returns:	The late_collisions of this EthernetPortStatistics.
Return type:	int
	required

multiple_collision_frames¶

Gets the multiple_collision_frames of this EthernetPortStatistics. The number of successfully-transmitted frames for which transmission is inhibited by multiple collisions.

Required/optional:
Returns:	The multiple_collision_frames of this EthernetPortStatistics.
Return type:	int
	required

packets_received¶

Gets the packets_received of this EthernetPortStatistics. Total number of packets received.

Required/optional:
Returns:	The packets_received of this EthernetPortStatistics.
Return type:	int
	required

packets_transmitted¶

Gets the packets_transmitted of this EthernetPortStatistics. Total number of packets transmitted.

Required/optional:
Returns:	The packets_transmitted of this EthernetPortStatistics.
Return type:	int
	required

rx_broadcast_frame_count¶

Gets the rx_broadcast_frame_count of this EthernetPortStatistics. The number of broadcast frames received over the interface.

Required/optional:
Returns:	The rx_broadcast_frame_count of this EthernetPortStatistics.
Return type:	int
	required

rx_control_frame_count¶

Gets the rx_control_frame_count of this EthernetPortStatistics. The number of control frames received over the interface.

Required/optional:
Returns:	The rx_control_frame_count of this EthernetPortStatistics.
Return type:	int
	required

rx_frame_crc_error_count¶

Gets the rx_frame_crc_error_count of this EthernetPortStatistics. The number of frames received and discarded with a CRC error.

Required/optional:
Returns:	The rx_frame_crc_error_count of this EthernetPortStatistics.
Return type:	int
	required

rx_frame_droped_count¶

Gets the rx_frame_droped_count of this EthernetPortStatistics. Received frames that were dropped.

Required/optional:
Returns:	The rx_frame_droped_count of this EthernetPortStatistics.
Return type:	int
	required

rx_frame_encoding_error_count¶

Gets the rx_frame_encoding_error_count of this EthernetPortStatistics. The number of frames received with encoding errors.

Required/optional:
Returns:	The rx_frame_encoding_error_count of this EthernetPortStatistics.
Return type:	int
	required

rx_frame_length_error_count¶

Gets the rx_frame_length_error_count of this EthernetPortStatistics. The number of frames received with 802.3 frame length errors.

Required/optional:
Returns:	The rx_frame_length_error_count of this EthernetPortStatistics.
Return type:	int
	required

rx_jabber_count¶

Gets the rx_jabber_count of this EthernetPortStatistics. The number of jabber errors detected.

Required/optional:
Returns:	The rx_jabber_count of this EthernetPortStatistics.
Return type:	int
	required

rx_multicast_frame_count¶

Gets the rx_multicast_frame_count of this EthernetPortStatistics. The number of multicast frames received over the interface.

Required/optional:
Returns:	The rx_multicast_frame_count of this EthernetPortStatistics.
Return type:	int
	required

rx_pause_frame_count¶

Gets the rx_pause_frame_count of this EthernetPortStatistics. The number of pause frames received over the interface.

Required/optional:
Returns:	The rx_pause_frame_count of this EthernetPortStatistics.
Return type:	int
	required

rx_small_frame_error_count¶

Gets the rx_small_frame_error_count of this EthernetPortStatistics. The number of frames received that are smaller than the minimum size allowed (64 bytes).

Required/optional:
Returns:	The rx_small_frame_error_count of this EthernetPortStatistics.
Return type:	int
	required

rx_unknown_control_frame_count¶

Gets the rx_unknown_control_frame_count of this EthernetPortStatistics. The number of control frames received with unknown op codes.

Required/optional:
Returns:	The rx_unknown_control_frame_count of this EthernetPortStatistics.
Return type:	int
	required

single_collision_frames¶

Gets the single_collision_frames of this EthernetPortStatistics. The number of successfully-transmitted frames for which transmission is inhibited by a single collision.

Required/optional:
Returns:	The single_collision_frames of this EthernetPortStatistics.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tx_broadcast_frame_count¶

Gets the tx_broadcast_frame_count of this EthernetPortStatistics. The number of broadcast frames transmitted over the interface.

Required/optional:
Returns:	The tx_broadcast_frame_count of this EthernetPortStatistics.
Return type:	int
	required

tx_control_frame_count¶

Gets the tx_control_frame_count of this EthernetPortStatistics. The number of control frames transmitted over the interface.

Required/optional:
Returns:	The tx_control_frame_count of this EthernetPortStatistics.
Return type:	int
	required

tx_frame_abort_count¶

Gets the tx_frame_abort_count of this EthernetPortStatistics. The number of aborts that occurred while transmitting.

Required/optional:
Returns:	The tx_frame_abort_count of this EthernetPortStatistics.
Return type:	int
	required

tx_frame_collision_count¶

Gets the tx_frame_collision_count of this EthernetPortStatistics. The number of frames that could not be sent due to a single or multiple collisions.

Required/optional:
Returns:	The tx_frame_collision_count of this EthernetPortStatistics.
Return type:	int
	required

tx_frame_dropped_count¶

Gets the tx_frame_dropped_count of this EthernetPortStatistics. The number of frames that were dropped because the transmit FIFO was full.

Required/optional:
Returns:	The tx_frame_dropped_count of this EthernetPortStatistics.
Return type:	int
	required

tx_frame_excess_deferral_count¶

Gets the tx_frame_excess_deferral_count of this EthernetPortStatistics. The number of frames which experienced deferred transmission for an excessive period of time.

Required/optional:
Returns:	The tx_frame_excess_deferral_count of this EthernetPortStatistics.
Return type:	int
	required

tx_jumbo_frame_count¶

Gets the tx_jumbo_frame_count of this EthernetPortStatistics. The number of jumbo frames transmitted over the interface.

Required/optional:
Returns:	The tx_jumbo_frame_count of this EthernetPortStatistics.
Return type:	int
	required

tx_multicast_frame_count¶

Gets the tx_multicast_frame_count of this EthernetPortStatistics. The number of multicast frames transmitted over the interface.

Required/optional:
Returns:	The tx_multicast_frame_count of this EthernetPortStatistics.
Return type:	int
	required

tx_pause_frame_count¶

Gets the tx_pause_frame_count of this EthernetPortStatistics. The number of pause frames transmitted over the interface.

Required/optional:
Returns:	The tx_pause_frame_count of this EthernetPortStatistics.
Return type:	int
	required

netapp.santricity.models.symbol.event_control module¶

EventControl.py

class netapp.santricity.models.symbol.event_control.EventControl[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

collect_support_bundle¶

Gets the collect_support_bundle of this EventControl. If this value is true, a support bundle will be collected.

Required/optional:
Returns:	The collect_support_bundle of this EventControl.
Return type:	bool
	required

default_needs_attention¶

Gets the default_needs_attention of this EventControl. This is the default value for needs attention. Its value can be overridden by oemNeedsAttention.

Required/optional:
Returns:	The default_needs_attention of this EventControl.
Return type:	bool
	required

default_send_alert¶

Gets the default_send_alert of this EventControl. This is the default value for sending an alert. Its value can be overridden by oemSendAlert.

Required/optional:
Returns:	The default_send_alert of this EventControl.
Return type:	bool
	required

default_visibility¶

Gets the default_visibility of this EventControl. This is the default value for visibility. Its value can be overridden by oemVisibility.

Required/optional:
Returns:	The default_visibility of this EventControl.
Return type:	bool
	required

oem_needs_attention¶

Gets the oem_needs_attention of this EventControl. If this value is equal to EVENT_CONTROL_ACCEPT_DEFAULT then the value of defaultNeedsAttention determines whether Needs Attention is set on the array. Otherwise, this field determines whether Needs Attention is set on the array.

Required/optional:
Returns:	The oem_needs_attention of this EventControl.
Return type:	str
	required

oem_priority¶

Gets the oem_priority of this EventControl. If this value if equal to EVENT_DEFAULT_PRIORITY then the management client should use the priority value from the MelEntry structure when filtering events for display, otherwise this value should be used.

Required/optional:
Returns:	The oem_priority of this EventControl.
Return type:	str
	required

oem_send_alert¶

Gets the oem_send_alert of this EventControl. If this value is equal to EVENT_CONTROL_ACCEPT_DEFAULT then the value of defaultSendAlert determines whether an alert will be sent. Otherwise this field determines whether an alert will be sent.

Required/optional:
Returns:	The oem_send_alert of this EventControl.
Return type:	str
	required

oem_visibility¶

Gets the oem_visibility of this EventControl. If this value is equal to EVENT_CONTROL_ACCEPT_DEFAULT then the value of defaultVisibility determines whether the event will be displayed. Otherwise, this field determines whether the event will be displayed.

Required/optional:
Returns:	The oem_visibility of this EventControl.
Return type:	str
	required

priority_case_creation_trigger¶

Gets the priority_case_creation_trigger of this EventControl. This flag indicates whether or not this MEL event should be marked as the reason a customer case was automatically created. It’s possible that multiple MEL events could be present in the MEL log that would trigger case creation. But the first MEL event in the log that has this flag set will be tagged as the event that caused the case to be created.

Required/optional:
Returns:	The priority_case_creation_trigger of this EventControl.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.excessive_reboots_detected module¶

ExcessiveRebootsDetected.py

class netapp.santricity.models.symbol.excessive_reboots_detected.ExcessiveRebootsDetected[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_ref¶

Gets the controller_ref of this ExcessiveRebootsDetected. This structure contains the controller ref for the controller that has experienced an excessive number of reboots.

Required/optional:
Returns:	The controller_ref of this ExcessiveRebootsDetected.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.expansion_candidates_returned module¶

ExpansionCandidatesReturned.py

class netapp.santricity.models.symbol.expansion_candidates_returned.ExpansionCandidatesReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

candidates¶

Gets the candidates of this ExpansionCandidatesReturned. A list of candidate drive sets that may be used for expanding the given volume group. This field is valid only when the value of returnCode is RETCODE_OK.

Required/optional:
Returns:	The candidates of this ExpansionCandidatesReturned.
Return type:	list[VolumeGroupExpansionCandidate]
	optional

return_code¶

Gets the return_code of this ExpansionCandidatesReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this ExpansionCandidatesReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.export_dependencies_returned module¶

ExportDependenciesReturned.py

class netapp.santricity.models.symbol.export_dependencies_returned.ExportDependenciesReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

dependency¶

Gets the dependency of this ExportDependenciesReturned. This field is an array of ExportDependency structures. This field is present only when the returnCode field is RETCODE_OK.

Required/optional:
Returns:	The dependency of this ExportDependenciesReturned.
Return type:	list[ExportDependency]
	optional

return_code¶

Gets the return_code of this ExportDependenciesReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this ExportDependenciesReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.export_dependency module¶

ExportDependency.py

class netapp.santricity.models.symbol.export_dependency.ExportDependency[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

dependency¶

Gets the dependency of this ExportDependency. Export dependency information for the dependent volume.

Required/optional:
Returns:	The dependency of this ExportDependency.
Return type:	ExportDependencyTypeData
	required

dependent_volume¶

Gets the dependent_volume of this ExportDependency. A reference to a dependent volume associated with the volume group of interest.

Required/optional:
Returns:	The dependent_volume of this ExportDependency.
Return type:	str
	required

is_portable¶

Gets the is_portable of this ExportDependency. Set to true if the dependency is portable.

Required/optional:
Returns:	The is_portable of this ExportDependency.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.export_dependency_type_data module¶

ExportDependencyTypeData.py

class netapp.santricity.models.symbol.export_dependency_type_data.ExportDependencyTypeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

amg_member¶

Gets the amg_member of this ExportDependencyTypeData. The identification of an Async Mirror Group member that is associated with the dependent volume. This field is only present if the type field is set to EXPORT_DEPENDENCY_ASYNC_MIRROR_GROUP_MEMBER.

Required/optional:
Returns:	The amg_member of this ExportDependencyTypeData.
Return type:	str
	optional

concat_vol¶

Gets the concat_vol of this ExportDependencyTypeData. This field contains an identification of the Concat Volume. This field is only present if the type field is set to EXPORT_DEPENDENCY_CONCAT_MEMBER.

Required/optional:
Returns:	The concat_vol of this ExportDependencyTypeData.
Return type:	str
	optional

metadata_ref¶

Gets the metadata_ref of this ExportDependencyTypeData. The identification of a metadata volume that is associated with the dependent volume. This field is only present if the type field is set to EXPORT_DEPENDENCY_METADATA.

Required/optional:
Returns:	The metadata_ref of this ExportDependencyTypeData.
Return type:	str
	optional

mirror_ref¶

Gets the mirror_ref of this ExportDependencyTypeData. The identification of the mirror pair that is associated with the dependent volume. This field is only present if the type field is set to EXPORT_DEPENDENCY_MIRROR_PAIR.

Required/optional:
Returns:	The mirror_ref of this ExportDependencyTypeData.
Return type:	str
	optional

pit_group¶

Gets the pit_group of this ExportDependencyTypeData. This field contains an identification of the PiT Group. This field is only present if the type field is set to EXPORT_DEPENDENCY_PIT_GROUP.

Required/optional:
Returns:	The pit_group of this ExportDependencyTypeData.
Return type:	str
	optional

pit_view¶

Gets the pit_view of this ExportDependencyTypeData. This field contains an identification of the PiT View. This field is only present if the type field is set to EXPORT_DEPENDENCY_PIT_VIEW.

Required/optional:
Returns:	The pit_view of this ExportDependencyTypeData.
Return type:	str
	optional

snapshot_ref¶

Gets the snapshot_ref of this ExportDependencyTypeData. The identification of a snapshot volume that is associated with the dependent volume. This field is only present if the type field is set to EXPORT_DEPENDENCY_SNAPSHOT.

Required/optional:
Returns:	The snapshot_ref of this ExportDependencyTypeData.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this ExportDependencyTypeData. This enumeration specifies the types of dependencies that may be identified for a volume belonging to a group that is a candidate to be exported.

Required/optional:
Returns:	The type of this ExportDependencyTypeData.
Return type:	str
	required

volcopy_ref¶

Gets the volcopy_ref of this ExportDependencyTypeData. The identification of a volume copy relationship that is associated with the dependent volume. This field is only present if the type field is set to EXPORT_DEPENDENCY_VOLUME_COPY.

Required/optional:
Returns:	The volcopy_ref of this ExportDependencyTypeData.
Return type:	str
	optional

netapp.santricity.models.symbol.extended_component_location module¶

ExtendedComponentLocation.py

class netapp.santricity.models.symbol.extended_component_location.ExtendedComponentLocation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

comp_channel_loc¶

Gets the comp_channel_loc of this ExtendedComponentLocation. This field is present only if the ExtendedComponentLocationType value is EXT_COMP_LOCTYPE_CHANNEL. This field is deprecated.

Required/optional:
Returns:	The comp_channel_loc of this ExtendedComponentLocation.
Return type:	ChannelLocation
	optional

comp_label¶

Gets the comp_label of this ExtendedComponentLocation. This field is present only if the ExtendedComponentLocationType value is EXT_COMP_LOCTYPE_VOLUME. This field is deprecated.

Required/optional:
Returns:	The comp_label of this ExtendedComponentLocation.
Return type:	str
	optional

comp_minihub_loc¶

Gets the comp_minihub_loc of this ExtendedComponentLocation. This field is present only if the ExtendedComponentLocationType value is EXT_COMP_LOCTYPE_MINIHUB. This field is deprecated.

Required/optional:
Returns:	The comp_minihub_loc of this ExtendedComponentLocation.
Return type:	MinihubLocation
	optional

comp_reference¶

Gets the comp_reference of this ExtendedComponentLocation. SYMbolRef of the component or channelPort

Required/optional:
Returns:	The comp_reference of this ExtendedComponentLocation.
Return type:	str
	optional

comp_tray¶

Gets the comp_tray of this ExtendedComponentLocation. This field is present only if the extLocType value is EXT_COMP_LOCTYPE_TRAY

Required/optional:
Returns:	The comp_tray of this ExtendedComponentLocation.
Return type:	int
	optional

comp_tray_slot¶

Gets the comp_tray_slot of this ExtendedComponentLocation. This field is present only if the extLocType value is EXT_COMP_LOCTYPE_TRAYSLOT

Required/optional:
Returns:	The comp_tray_slot of this ExtendedComponentLocation.
Return type:	TraySlot
	optional

controller_reference¶

Gets the controller_reference of this ExtendedComponentLocation. Controller Reference

Required/optional:
Returns:	The controller_reference of this ExtendedComponentLocation.
Return type:	str
	optional

ext_loc_type¶

Gets the ext_loc_type of this ExtendedComponentLocation. This enumeration object contains a list of all possible extended component location types that can be returned in a MEL entry.

Required/optional:
Returns:	The ext_loc_type of this ExtendedComponentLocation.
Return type:	str
	required

location_label¶

Gets the location_label of this ExtendedComponentLocation. Label associated with the physical location of the component or port.

Required/optional:
Returns:	The location_label of this ExtendedComponentLocation.
Return type:	str
	optional

pit_sequence¶

Gets the pit_sequence of this ExtendedComponentLocation. This field is present only if the ExtendedComponentLocationType value is EXT_COMP_LOCTYPE_PIT.

Required/optional:
Returns:	The pit_sequence of this ExtendedComponentLocation.
Return type:	int
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.extended_sa_data module¶

ExtendedSAData.py

class netapp.santricity.models.symbol.extended_sa_data.ExtendedSAData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

code_versions¶

Gets the code_versions of this ExtendedSAData. This is a list of versions for the various firmware components (RAID, NVSRAM, hypervisor, ....). The list contains an entry for every code module applicable to the current platform.

Required/optional:
Returns:	The code_versions of this ExtendedSAData.
Return type:	list[VersionDescriptor]
	required

reserved1¶

Gets the reserved1 of this ExtendedSAData.

Required/optional:
Returns:	The reserved1 of this ExtendedSAData.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.external_redundancy_failure module¶

ExternalRedundancyFailure.py

class netapp.santricity.models.symbol.external_redundancy_failure.ExternalRedundancyFailure[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_channel_list¶

Gets the drive_channel_list of this ExternalRedundancyFailure. A list of unconnected drive channels.

Required/optional:
Returns:	The drive_channel_list of this ExternalRedundancyFailure.
Return type:	list[DriveChannelSpecifier]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.factory_defaults_descriptor module¶

FactoryDefaultsDescriptor.py

class netapp.santricity.models.symbol.factory_defaults_descriptor.FactoryDefaultsDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

factory_defaults_data¶

Gets the factory_defaults_data of this FactoryDefaultsDescriptor. The factory default information for the indicated tray.

Required/optional:
Returns:	The factory_defaults_data of this FactoryDefaultsDescriptor.
Return type:	FirmwareUpdateDescriptor
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray¶

Gets the tray of this FactoryDefaultsDescriptor. This object uniquely identifies the particular tray within the storage array that will receive the factory default information.

Required/optional:
Returns:	The tray of this FactoryDefaultsDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.factory_defaults_version_data module¶

FactoryDefaultsVersionData.py

class netapp.santricity.models.symbol.factory_defaults_version_data.FactoryDefaultsVersionData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

factory_defaults_version¶

Gets the factory_defaults_version of this FactoryDefaultsVersionData. The factory default version string

Required/optional:
Returns:	The factory_defaults_version of this FactoryDefaultsVersionData.
Return type:	str
	required

is_supported¶

Gets the is_supported of this FactoryDefaultsVersionData. This field is set to true when version reporting is supported and factory default settings may be downloaded; otherwise it is set to false.

Required/optional:
Returns:	The is_supported of this FactoryDefaultsVersionData.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.failure_type_entry module¶

FailureTypeEntry.py

class netapp.santricity.models.symbol.failure_type_entry.FailureTypeEntry[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

alarm_removed¶

Gets the alarm_removed of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_REMOVED_ALARM. It contains the identification of the alarm that was removed.

Required/optional:
Returns:	The alarm_removed of this FailureTypeEntry.
Return type:	str
	optional

alt_ctlr_board_id_unreadable¶

Gets the alt_ctlr_board_id_unreadable of this FailureTypeEntry. Identifies a controller that is unable to read the board ID of its alternate. The referenced controller is not necessarily the source of the problem.

Required/optional:
Returns:	The alt_ctlr_board_id_unreadable of this FailureTypeEntry.
Return type:	str
	optional

async_mirror_repository_over_warn_threshold¶

Gets the async_mirror_repository_over_warn_threshold of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_ARVM_REPOSITORY_OVER_WARN_THRESHOLD. It contains information about a mirror group member fault condition.

Required/optional:
Returns:	The async_mirror_repository_over_warn_threshold of this FailureTypeEntry.
Return type:	AsyncMirrorGroupMemberFaultIndication
	optional

base_controller_diag_failed¶

Gets the base_controller_diag_failed of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_BASE_CONTROLLER_DIAG_FAILED. It contains the identification of the controller that failed diagnostic testing.

Required/optional:
Returns:	The base_controller_diag_failed of this FailureTypeEntry.
Return type:	str
	optional

battery_capacity_warn¶

Gets the battery_capacity_warn of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_BATTERY_WARN. It is a reference to a battery component that has insufficient capacity to hold up the cache.

Required/optional:
Returns:	The battery_capacity_warn of this FailureTypeEntry.
Return type:	str
	optional

battery_config_mismatch¶

Gets the battery_config_mismatch of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_BATTERY_CONFIG_MISMATCH

Required/optional:
Returns:	The battery_config_mismatch of this FailureTypeEntry.
Return type:	str
	optional

battery_expired¶

Gets the battery_expired of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_EXPIRED_BATTERY,. It contains the identification of the battery component that has expired.

Required/optional:
Returns:	The battery_expired of this FailureTypeEntry.
Return type:	str
	optional

battery_fail¶

Gets the battery_fail of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_FAILED_BATTERY. It contains the identification of the battery component that has failed.

Required/optional:
Returns:	The battery_fail of this FailureTypeEntry.
Return type:	str
	optional

battery_pack_removed¶

Gets the battery_pack_removed of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_REMOVED_BATTERY_PACK.

Required/optional:
Returns:	The battery_pack_removed of this FailureTypeEntry.
Return type:	str
	optional

battery_removed¶

Gets the battery_removed of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_REMOVED_BATTERY. It contains the identification of the battery that was removed.

Required/optional:
Returns:	The battery_removed of this FailureTypeEntry.
Return type:	str
	optional

battery_stat_unknown¶

Gets the battery_stat_unknown of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_BATTERY_UNKNOWN_STAT.

Required/optional:
Returns:	The battery_stat_unknown of this FailureTypeEntry.
Return type:	str
	optional

battery_system_fail¶

Gets the battery_system_fail of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_FAILED_BATTERY_SYSTEM.

Required/optional:
Returns:	The battery_system_fail of this FailureTypeEntry.
Return type:	BatteryPackICCFailure
	optional

battery_temp_warn¶

Gets the battery_temp_warn of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_BATTERY_OVERTEMP. It is a reference to a battery component that is experiencing the over-temp condition.

Required/optional:
Returns:	The battery_temp_warn of this FailureTypeEntry.
Return type:	str
	optional

battery_warn¶

Gets the battery_warn of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_BATTERY_NEAR_EXPIRATION. It contains the identification of the battery component that is nearing its age limit.

Required/optional:
Returns:	The battery_warn of this FailureTypeEntry.
Return type:	str
	optional

cache_data_loss¶

Gets the cache_data_loss of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType value is equal to REC_CACHE_DATA_LOSS. It identifies a controller that has lost data in cache; along with a list of volumes that are offline as a result.

Required/optional:
Returns:	The cache_data_loss of this FailureTypeEntry.
Return type:	ControllerVolumeList
	optional

cache_memory_size_unsupported¶

Gets the cache_memory_size_unsupported of this FailureTypeEntry. This field is present if the value of recFailureType is equal to REC_UNSUPPORTED_CACHE_MEMORY_SIZE. It identifies a controller having a cache of unsupported size.

Required/optional:
Returns:	The cache_memory_size_unsupported of this FailureTypeEntry.
Return type:	str
	optional

cg_pending_create_failed¶

Gets the cg_pending_create_failed of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_PENDING_CGPIT_CREATION_FAILED. It contains a reference to the PiT Consistency Group.

Required/optional:
Returns:	The cg_pending_create_failed of this FailureTypeEntry.
Return type:	str
	optional

ch_fail¶

Gets the ch_fail of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_FAILED_DRIVE_SCSI_CHANNEL. It contains the identification of the controller that has experienced a failed drive-side I/O channel.

Required/optional:
Returns:	The ch_fail of this FailureTypeEntry.
Return type:	str
	optional

chan_miswire¶

Gets the chan_miswire of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_CHANNEL_MISWIRE. It identifies the controller having the channel miswire information.

Required/optional:
Returns:	The chan_miswire of this FailureTypeEntry.
Return type:	str
	optional

chan_sas_phy_disabled_local_wide_port_degraded¶

Gets the chan_sas_phy_disabled_local_wide_port_degraded of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType value is equal to REC_SAS_PHY_DISABLED_LOCAL_WIDE_PORT_DEGRADED. It identifies the channel.

Required/optional:
Returns:	The chan_sas_phy_disabled_local_wide_port_degraded of this FailureTypeEntry.
Return type:	int
	optional

chan_sas_phy_disabled_shared_wide_port_degraded¶

Gets the chan_sas_phy_disabled_shared_wide_port_degraded of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType value is equal to REC_SAS_PHY_DISABLED_SHARED_WIDE_PORT_DEGRADED. It identifies the channel.

Required/optional:
Returns:	The chan_sas_phy_disabled_shared_wide_port_degraded of this FailureTypeEntry.
Return type:	int
	optional

channel_degraded_failure¶

Gets the channel_degraded_failure of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_CHANNEL_DEGRADED. The channel is in a degraded state.

Required/optional:
Returns:	The channel_degraded_failure of this FailureTypeEntry.
Return type:	ChannelDegradedFailure
	optional

channel_failed_failure¶

Gets the channel_failed_failure of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_CHANNEL_FAILED.

Required/optional:
Returns:	The channel_failed_failure of this FailureTypeEntry.
Return type:	ChannelFailedFailure
	optional

controller_in_lockdown¶

Gets the controller_in_lockdown of this FailureTypeEntry. The controller has gone into lockdown mode due to the detection of PI errors on all controllers in the array.

Required/optional:
Returns:	The controller_in_lockdown of this FailureTypeEntry.
Return type:	str
	optional

controller_in_service_mode¶

Gets the controller_in_service_mode of this FailureTypeEntry. The controller has automatically gone into service mode due to the detection of a PI error.

Required/optional:
Returns:	The controller_in_service_mode of this FailureTypeEntry.
Return type:	str
	optional

ctl_mismatch¶

Gets the ctl_mismatch of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_CTL_MISMATCH.

Required/optional:
Returns:	The ctl_mismatch of this FailureTypeEntry.
Return type:	str
	optional

ctl_miswire¶

Gets the ctl_miswire of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_CTL_MISWIRE.

Required/optional:
Returns:	The ctl_miswire of this FailureTypeEntry.
Return type:	ControllerMiswireError
	optional

ctlr_ioc_diag_failed¶

Gets the ctlr_ioc_diag_failed of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType value is equal to REC_IOC_DIAG_FAIL. It identifies the controller that failed IOC diagnostic testing.

Required/optional:
Returns:	The ctlr_ioc_diag_failed of this FailureTypeEntry.
Return type:	str
	optional

ctlr_with_dirty_cache_not_flushed¶

Gets the ctlr_with_dirty_cache_not_flushed of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_CACHE_NOT_FLUSHED_ON_ONLY_CTLR. It contains the identification of the controller that fails to flush dirty cache data on failed volume(s) possibly due to offlined drives. The controller should not be replaced to avoid loss of data.

Required/optional:
Returns:	The ctlr_with_dirty_cache_not_flushed of this FailureTypeEntry.
Return type:	ControllerWithDirtyCacheDetails
	optional

database_metadata¶

Gets the database_metadata of this FailureTypeEntry. It contains metadata for the stable store database backup that is in recovery mode.

Required/optional:
Returns:	The database_metadata of this FailureTypeEntry.
Return type:	DatabaseMetadata
	optional

ddf_drive_other_vendor¶

Gets the ddf_drive_other_vendor of this FailureTypeEntry. This field is present only if recFailureType is equal to REC_DDF_DRIVE_OTHER_VENDOR. It identifies a drive that has a SNIA Disk Data Format (DDF) anchor indicating a vendor other than LSI-Engenio.

Required/optional:
Returns:	The ddf_drive_other_vendor of this FailureTypeEntry.
Return type:	str
	optional

degraded_async_mirror_group¶

Gets the degraded_async_mirror_group of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_ARVM_DEGRADED_MIRROR_GROUP. It contains information about a mirror group fault condition.

Required/optional:
Returns:	The degraded_async_mirror_group of this FailureTypeEntry.
Return type:	AsyncMirrorGroupFaultIndication
	optional

degraded_drawer_ref¶

Gets the degraded_drawer_ref of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType value is equal to REC_DRAWER_DEGRADED. It identifies the degraded drawer.

Required/optional:
Returns:	The degraded_drawer_ref of this FailureTypeEntry.
Return type:	str
	optional

degraded_host_board¶

Gets the degraded_host_board of this FailureTypeEntry. This field is present only if the recFailureType is equal to REC_DEGRADED_HOST_IO_CARD. It identifies s host board, for which some, but not all, of its I/O ports are operational.

Required/optional:
Returns:	The degraded_host_board of this FailureTypeEntry.
Return type:	str
	optional

degraded_sas_port¶

Gets the degraded_sas_port of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_SAS_PORT_DEGRADED. It supplies information about a degraded SAS port, including the parent device and the attached device. An entry of this type appears once in the failure type list for each degraded port in the array.

Required/optional:
Returns:	The degraded_sas_port of this FailureTypeEntry.
Return type:	SasPort
	optional

discovery_error_sas_port¶

Gets the discovery_error_sas_port of this FailureTypeEntry. This data associated with the backend SAS channel to help diagnose the discovery error.

Required/optional:
Returns:	The discovery_error_sas_port of this FailureTypeEntry.
Return type:	SasPort
	optional

discrete_line_fail¶

Gets the discrete_line_fail of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_FAILED_DISCRETE_LINE.

Required/optional:
Returns:	The discrete_line_fail of this FailureTypeEntry.
Return type:	str
	optional

disk_pool_capacity_depleted¶

Gets the disk_pool_capacity_depleted of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_DISK_POOL_CAPACITY_DEPLETED. It identifies the Disk Pool with depleted capacity.

Required/optional:
Returns:	The disk_pool_capacity_depleted of this FailureTypeEntry.
Return type:	str
	optional

disk_pool_drive_failure¶

Gets the disk_pool_drive_failure of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_DISK_POOL_DRIVE_FAILURE. It identifies the Disk Pool with at least one failed drive.

Required/optional:
Returns:	The disk_pool_drive_failure of this FailureTypeEntry.
Return type:	str
	optional

disk_pool_insufficient_memory¶

Gets the disk_pool_insufficient_memory of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_DISK_POOL_INSUFFICIENT_MEMORY. It identifies the controller where access to disk pool volumes is prohibited because of insufficient memory.

Required/optional:
Returns:	The disk_pool_insufficient_memory of this FailureTypeEntry.
Return type:	str
	optional

disk_pool_reconstruction¶

Gets the disk_pool_reconstruction of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_DISK_POOL_RECONSTRUCTION_DRIVE_COUNT_BELOW_THRESHOLD. It contains the identification of the Disk Pool with space reserved for reconstructions that has fallen below the reconstruction reserved disk count value.

Required/optional:
Returns:	The disk_pool_reconstruction of this FailureTypeEntry.
Return type:	str
	optional

disk_pool_state_incomplete¶

Gets the disk_pool_state_incomplete of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_DISK_POOL_INCOMPLETE. It contains the identification of the Disk Pool that has transitioned to Incomplete state.

Required/optional:
Returns:	The disk_pool_state_incomplete of this FailureTypeEntry.
Return type:	str
	optional

disk_pool_state_missing¶

Gets the disk_pool_state_missing of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_DISK_POOL_MISSING. It contains the identification of the Disk Pool that has transitioned to Missing state.

Required/optional:
Returns:	The disk_pool_state_missing of this FailureTypeEntry.
Return type:	str
	optional

disk_pool_state_partial¶

Gets the disk_pool_state_partial of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_DISK_POOL_PARTIALLY_PRESENT. It contains the identification of the Disk Pool that has transitioned to Partial state..

Required/optional:
Returns:	The disk_pool_state_partial of this FailureTypeEntry.
Return type:	str
	optional

disk_pool_utilization_critical¶

Gets the disk_pool_utilization_critical of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_DISK_POOL_UTILIZATION_CRITICAL. It contains the identification of the Disk Pool that has exceeded the Utilization Threshold Critical attribute.

Required/optional:
Returns:	The disk_pool_utilization_critical of this FailureTypeEntry.
Return type:	str
	optional

disk_pool_utilization_warning¶

Gets the disk_pool_utilization_warning of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_DISK_POOL_UTILIZATION_WARNING. It contains the identification of the Disk Pool that has exceeded the Utilization Threshold Warning attribute.

Required/optional:
Returns:	The disk_pool_utilization_warning of this FailureTypeEntry.
Return type:	str
	optional

disk_pool_waiting_on_hot_spare¶

Gets the disk_pool_waiting_on_hot_spare of this FailureTypeEntry.

Required/optional:
Returns:	The disk_pool_waiting_on_hot_spare of this FailureTypeEntry.
Return type:	str
	optional

drawer_invalid¶

Gets the drawer_invalid of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType value is equal to REC_DRAWER_INVALID. It identifies the invalid (unsupported) drawer.

Required/optional:
Returns:	The drawer_invalid of this FailureTypeEntry.
Return type:	str
	optional

drawer_removed¶

Gets the drawer_removed of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType value is equal to REC_DRAWER_REMOVED. It identifies the drawer that has been removed.

Required/optional:
Returns:	The drawer_removed of this FailureTypeEntry.
Return type:	str
	optional

drive_bypassed_single_port¶

Gets the drive_bypassed_single_port of this FailureTypeEntry. This field is present only if the value of the recFailureType is equal to REC_DRIVE_BYPASSED_SINGLE_PORT. It is a reference to a drive that is bypassed on just one of its ports.

Required/optional:
Returns:	The drive_bypassed_single_port of this FailureTypeEntry.
Return type:	str
	optional

drive_capacity_insufficient¶

Gets the drive_capacity_insufficient of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_REPLACED_INSUFFICIENT_DRIVE_CAPACITY. It is a reference to an inserted drive that has insufficient capacity for the user data of the drive it is replacing.

Required/optional:
Returns:	The drive_capacity_insufficient of this FailureTypeEntry.
Return type:	str
	optional

drive_emulation_incompatible_alignment¶

Gets the drive_emulation_incompatible_alignment of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType value is equal to REC_DRIVE_INCOMPATIBLE_ALIGNMENT_FOR_EMULATION_DRIVE. It identifies an emulation drive with an incompatible alignment.

Required/optional:
Returns:	The drive_emulation_incompatible_alignment of this FailureTypeEntry.
Return type:	str
	optional

drive_fail¶

Gets the drive_fail of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_FAILED_DRIVE. It contains the identification of a drive that has failed.

Required/optional:
Returns:	The drive_fail of this FailureTypeEntry.
Return type:	str
	optional

drive_fail_impending_high¶

Gets the drive_fail_impending_high of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_IMPENDING_DRIVE_FAILURE_RISK_HIGH. It contains the identification of a volume group containing a drive for which the risk of impending failure is considered to be “high”. Failure risk levels are determined by built-in drive algorithms for early failure detection.

Required/optional:
Returns:	The drive_fail_impending_high of this FailureTypeEntry.
Return type:	str
	optional

drive_fail_impending_low¶

Gets the drive_fail_impending_low of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_IMPENDING_DRIVE_FAILURE_RISK_LOW. It contains the identification of a drive for which an impending failure condition has been detected. This failure type is only used for drives that are not assigned to any volume group.

Required/optional:
Returns:	The drive_fail_impending_low of this FailureTypeEntry.
Return type:	str
	optional

drive_fail_impending_med¶

Gets the drive_fail_impending_med of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_IMPENDING_DRIVE_FAILURE_RISK_MED. It contains the identification of a volume group containing a drive for which the risk of impending failure is considered to be “medium”.

Required/optional:
Returns:	The drive_fail_impending_med of this FailureTypeEntry.
Return type:	str
	optional

drive_incompatible_p_itype¶

Gets the drive_incompatible_p_itype of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType value is equal to REC_DRIVE_INCOMPATIBLE_PI_TYPE. It identifies the drive that is incompatible.

Required/optional:
Returns:	The drive_incompatible_p_itype of this FailureTypeEntry.
Return type:	str
	optional

drive_model_number_unsupported¶

Gets the drive_model_number_unsupported of this FailureTypeEntry. This field is present only if the value of the recFailureType is equal to REC_DRIVE_INCOMPATIBLE_MODEL_NUMBER_UNSUPPORTED. It is a reference to a SATA drive that is incompatible because of the model number.

Required/optional:
Returns:	The drive_model_number_unsupported of this FailureTypeEntry.
Return type:	str
	optional

drive_redundancy_failure¶

Gets the drive_redundancy_failure of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_LOST_REDUNDANCY_DRIVE. It contains the identification of the drive that has lost redundancy.

Required/optional:
Returns:	The drive_redundancy_failure of this FailureTypeEntry.
Return type:	DriveLostRedundancyFailure
	optional

drive_ref¶

Gets the drive_ref of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_SSD_AT_END_OF_LIFE. It is a reference to the SSD drive that is at end of life.

Required/optional:
Returns:	The drive_ref of this FailureTypeEntry.
Return type:	str
	optional

drive_slot_limit_feature¶

Gets the drive_slot_limit_feature of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_DRIVE_SLOT_LIMIT_NOT_COMPLIANT.

Required/optional:
Returns:	The drive_slot_limit_feature of this FailureTypeEntry.
Return type:	FeatureState
	optional

drive_thres_excded_mismatch_corrected¶

Gets the drive_thres_excded_mismatch_corrected of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_THRES_EXCDED_MISMATCH_CORRECTED. The identification of the drive for which the PFA threshold was exceeded but the redundancy mismatch corrected is returned.

Required/optional:
Returns:	The drive_thres_excded_mismatch_corrected of this FailureTypeEntry.
Return type:	str
	optional

drive_tray_expansion_feature¶

Gets the drive_tray_expansion_feature of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_DRIVE_TRAYS_NOT_COMPLIANT. It indicates that the drive tray feature is out of compliance.

Required/optional:
Returns:	The drive_tray_expansion_feature of this FailureTypeEntry.
Return type:	FeatureState
	optional

drive_trays_not_grouped_together¶

Gets the drive_trays_not_grouped_together of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_DRIVE_TRAYS_NOT_GROUPED_TOGETHER.

Required/optional:
Returns:	The drive_trays_not_grouped_together of this FailureTypeEntry.
Return type:	TrayRefList
	optional

drive_uncertified¶

Gets the drive_uncertified of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_UNCERTIFIED_DRIVE. It contains the identification of a drive whose type/model is not certified for use within the storage array.

Required/optional:
Returns:	The drive_uncertified of this FailureTypeEntry.
Return type:	str
	optional

drive_unsuccess_isolation_redun_mismatch¶

Gets the drive_unsuccess_isolation_redun_mismatch of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_UNSUCCESS_ISOLATION_REDUN_MISMATCH. The identification of the drive for which the redundancy mismatch was unsuccessfully isolated is returned.

Required/optional:
Returns:	The drive_unsuccess_isolation_redun_mismatch of this FailureTypeEntry.
Return type:	str
	optional

drive_unsupported_interposer_fw_version¶

Gets the drive_unsupported_interposer_fw_version of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType value is equal to REC_DRIVE_UNSUPPORTED_INTERPOSER_FW_VERSION. It identifies a drive that has an unsupported interposer firmware version.

Required/optional:
Returns:	The drive_unsupported_interposer_fw_version of this FailureTypeEntry.
Return type:	str
	optional

drv_bypass_cause_unknown¶

Gets the drv_bypass_cause_unknown of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_DRIVE_BYPASSED_CAUSE_UNKNOWN. It contains the identification of the drive that was bypassed.

Required/optional:
Returns:	The drv_bypass_cause_unknown of this FailureTypeEntry.
Return type:	str
	optional

dual_mirror_primary¶

Gets the dual_mirror_primary of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_MIRROR_DUAL_PRIMARY. It contains the identification of the mirror relationship.

Required/optional:
Returns:	The dual_mirror_primary of this FailureTypeEntry.
Return type:	DualMirrorPrimary
	optional

dual_mirror_secondary¶

Gets the dual_mirror_secondary of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_MIRROR_DUAL_SECONDARY. It contains the identification of the mirror relationship.

Required/optional:
Returns:	The dual_mirror_secondary of this FailureTypeEntry.
Return type:	DualMirrorSecondary
	optional

enclosure_thermal_shutdown¶

Gets the enclosure_thermal_shutdown of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType value is equal to REC_ENCLOSURE_THERMAL_SHUTDOWN. It contains the identification of the tray that is powering down due to an over-temperature or under-temperature threshold condition.

Required/optional:
Returns:	The enclosure_thermal_shutdown of this FailureTypeEntry.
Return type:	str
	optional

esm_factory_defaults_mismatch¶

Gets the esm_factory_defaults_mismatch of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_ESM_FACTORY_DEFAULTS_MISMATCH. It is a reference to a tray in which the versions of the factory default settings reported by the two ESMs do not match.

Required/optional:
Returns:	The esm_factory_defaults_mismatch of this FailureTypeEntry.
Return type:	str
	optional

esm_fail¶

Gets the esm_fail of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_FAILED_ESM. It contains the identification of the ESM component that has failed.

Required/optional:
Returns:	The esm_fail of this FailureTypeEntry.
Return type:	str
	optional

esm_miswire¶

Gets the esm_miswire of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_ESM_MISWIRE. It contains the identification of the tray that has the ESM miswire.

Required/optional:
Returns:	The esm_miswire of this FailureTypeEntry.
Return type:	str
	optional

esm_redundancy_failure¶

Gets the esm_redundancy_failure of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_LOST_REDUNDANCY_ESM. It contains the identification of the ESM card that has lost redundancy.

Required/optional:
Returns:	The esm_redundancy_failure of this FailureTypeEntry.
Return type:	EsmLostRedundancyFailure
	optional

esm_removed¶

Gets the esm_removed of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_REMOVED_ESM. It contains the identification of the ESM canister that was removed.

Required/optional:
Returns:	The esm_removed of this FailureTypeEntry.
Return type:	str
	optional

esm_stat_unknown¶

Gets the esm_stat_unknown of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_ESM_UNKNOWN_STAT. It contains the identification of the ESM that has failed with unknown status.

Required/optional:
Returns:	The esm_stat_unknown of this FailureTypeEntry.
Return type:	str
	optional

esm_uncertified¶

Gets the esm_uncertified of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_UNCERTIFIED_ESM.

Required/optional:
Returns:	The esm_uncertified of this FailureTypeEntry.
Return type:	str
	optional

eval_expiration_imminent¶

Gets the eval_expiration_imminent of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType value is equal to REC_EVALUATION_LICENSE_EXPIRATION_IMMINENT.

Required/optional:
Returns:	The eval_expiration_imminent of this FailureTypeEntry.
Return type:	str
	optional

excessive_reboots_detected¶

Gets the excessive_reboots_detected of this FailureTypeEntry. Excessive reboots have been detected – return the controller ref in the Failure Type Entry.

Required/optional:
Returns:	The excessive_reboots_detected of this FailureTypeEntry.
Return type:	ExcessiveRebootsDetected
	optional

failed_async_mirror¶

Gets the failed_async_mirror of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_ARVM_FAILED_MIRROR. It identifies the Async Mirror Group member that failed.

Required/optional:
Returns:	The failed_async_mirror of this FailureTypeEntry.
Return type:	str
	optional

failed_cache_backup_device¶

Gets the failed_cache_backup_device of this FailureTypeEntry. This field is present if the recFailuretype is equal to REC_CACHE_BACKUP_DEVICE_FAILED. It identifies a cache backup device that has failed.

Required/optional:
Returns:	The failed_cache_backup_device of this FailureTypeEntry.
Return type:	str
	optional

failed_dedicated_mirror_channel¶

Gets the failed_dedicated_mirror_channel of this FailureTypeEntry. This field is present if the value of recFailureType is equal to REC_DEDICATED_MIRROR_CHANNEL_FAILED. It identifies a degraded controller that is the root cause of the channel failure(s). If the channel failure root cause cannot be tied to a controller, the reference is null.

Required/optional:
Returns:	The failed_dedicated_mirror_channel of this FailureTypeEntry.
Return type:	str
	optional

failed_drawer_ref¶

Gets the failed_drawer_ref of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_DRAWER_FAILED. It is a reference to the failed drawer.

Required/optional:
Returns:	The failed_drawer_ref of this FailureTypeEntry.
Return type:	str
	optional

failed_host_board¶

Gets the failed_host_board of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_HOST_BOARD_FAULT (or the numerically-equivalent REC_FAILED_HOST_IO_CARD). It identifies the failed host board.

Required/optional:
Returns:	The failed_host_board of this FailureTypeEntry.
Return type:	str
	optional

failed_sas_port¶

Gets the failed_sas_port of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_SAS_PORT_FAILED. It supplies information about a failed SAS port, including the parent device and the attached device. An entry of this type appears once in the failure type list for each failed port in the array.

Required/optional:
Returns:	The failed_sas_port of this FailureTypeEntry.
Return type:	SasPort
	optional

failed_volume_copy¶

Gets the failed_volume_copy of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_VOLCOPY_FAILED. It contains the identification of the failed volume copy.

Required/optional:
Returns:	The failed_volume_copy of this FailureTypeEntry.
Return type:	str
	optional

fan_fail¶

Gets the fan_fail of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_FAILED_FAN. It contains the identification of the fan component that has failed.

Required/optional:
Returns:	The fan_fail of this FailureTypeEntry.
Return type:	str
	optional

fan_removed¶

Gets the fan_removed of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_REMOVED_FAN.

Required/optional:
Returns:	The fan_removed of this FailureTypeEntry.
Return type:	str
	optional

fan_stat_unknown¶

Gets the fan_stat_unknown of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_FAN_UNKNOWN_STAT. It contains the identification of the fan that has failed with unknown status.

Required/optional:
Returns:	The fan_stat_unknown of this FailureTypeEntry.
Return type:	str
	optional

fde_feature¶

Gets the fde_feature of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_SECURITY_NOT_COMPLIANT. The security feature is out of compliance.

Required/optional:
Returns:	The fde_feature of this FailureTypeEntry.
Return type:	FeatureState
	optional

fde_proxy_key_mgmt_feature¶

Gets the fde_proxy_key_mgmt_feature of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_EXTERNAL_KMS_NOT_COMPLIANT.

Required/optional:
Returns:	The fde_proxy_key_mgmt_feature of this FailureTypeEntry.
Return type:	FeatureState
	optional

feature_out_of_compliance¶

Gets the feature_out_of_compliance of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType value is equal to REC_FEATURE_NOT_COMPLIANT. It identifies the feature that is out of compliance..

Required/optional:
Returns:	The feature_out_of_compliance of this FailureTypeEntry.
Return type:	str
	optional

fibre_trunk_incompatible_esm¶

Gets the fibre_trunk_incompatible_esm of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_FIBRE_TRUNK_INCOMPATIBLE_ESM. It contains a reference to an ESM that does not support trunking.

Required/optional:
Returns:	The fibre_trunk_incompatible_esm of this FailureTypeEntry.
Return type:	str
	optional

fibre_trunk_miswire¶

Gets the fibre_trunk_miswire of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_FIBRE_TRUNK_MISWIRE. It contains a structure that identifies both the incorrect and required cabling.

Required/optional:
Returns:	The fibre_trunk_miswire of this FailureTypeEntry.
Return type:	FibreTrunkMiswire
	optional

flash_cache_hot_spare_in_use¶

Gets the flash_cache_hot_spare_in_use of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_FLASH_CACHE_HOT_SPARE_IN_USE.

Required/optional:
Returns:	The flash_cache_hot_spare_in_use of this FailureTypeEntry.
Return type:	FlashCacheRecoveryData
	optional

flash_cache_non_optimal_drives¶

Gets the flash_cache_non_optimal_drives of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_FLASH_CACHE_NON_OPTIMAL_DRIVES.

Required/optional:
Returns:	The flash_cache_non_optimal_drives of this FailureTypeEntry.
Return type:	FlashCacheRecoveryData
	optional

foreign_drive_has_inconsistent_role¶

Gets the foreign_drive_has_inconsistent_role of this FailureTypeEntry. This field is present only if recFailureType is equal to REC_FOREIGN_DRIVE_HAS_INCONSISTENT_ROLE. It identifies the data that is pertinent to this recovery scenario. The drive field in this structure is a reference to the drive having the inconsistent role, and the volumeGroup field is a reference to the volume group referring to that drive.

Required/optional:
Returns:	The foreign_drive_has_inconsistent_role of this FailureTypeEntry.
Return type:	PvgRecoveryData
	optional

foreign_drive_inconsistent¶

Gets the foreign_drive_inconsistent of this FailureTypeEntry. This field is present only if recFailureType is equal to REC_FOREIGN_DRIVE_INCONSISTENT. It identifies the inconsistent foreign drive.

Required/optional:
Returns:	The foreign_drive_inconsistent of this FailureTypeEntry.
Return type:	str
	optional

foreign_drive_refers_to_native_drive¶

Gets the foreign_drive_refers_to_native_drive of this FailureTypeEntry. This field is present only if recFailureType is equal to REC_FOREIGN_DRIVE_REFERS_TO_NATIVE_DRIVE. It identifies the drive that caused the problem to be recognized (the first-inserted drive of what appears to be an incoming foreign volume group).

Required/optional:
Returns:	The foreign_drive_refers_to_native_drive of this FailureTypeEntry.
Return type:	str
	optional

full_primary_repository_mirror_member¶

Gets the full_primary_repository_mirror_member of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_ARVM_PRIMARY_REPOSITORY_FULL. It contains information about the primary repository mirror member that has reached the full point.

Required/optional:
Returns:	The full_primary_repository_mirror_member of this FailureTypeEntry.
Return type:	AsyncMirrorGroupMemberFaultIndication
	optional

full_secondary_repository_mirror_member¶

Gets the full_secondary_repository_mirror_member of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_ARVM_SECONDARY_REPOSITORY_FULL. It contains a reference to the secondary repository mirror member that has reached the full point.

Required/optional:
Returns:	The full_secondary_repository_mirror_member of this FailureTypeEntry.
Return type:	str
	optional

ghost_volume¶

Gets the ghost_volume of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_GHOST_VOLUME. It contains the identification of the missing volume.

Required/optional:
Returns:	The ghost_volume of this FailureTypeEntry.
Return type:	str
	optional

goldkey_feature¶

Gets the goldkey_feature of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_GOLD_KEY_NOT_COMPLIANT.

Required/optional:
Returns:	The goldkey_feature of this FailureTypeEntry.
Return type:	FeatureState
	optional

host_board_id_mismatch¶

Gets the host_board_id_mismatch of this FailureTypeEntry. This field is present only if the recFailureType is equal to REC_HOST_BOARD_ID_MISMATCH. It identifies a host board on the other controller that has a mismatched identifier, and which caused the other controller to lock down.

Required/optional:
Returns:	The host_board_id_mismatch of this FailureTypeEntry.
Return type:	str
	optional

host_board_stat_unknown¶

Gets the host_board_stat_unknown of this FailureTypeEntry. This field is only present if the value of the recFailureType is equal to REC_HOST_BOARD_UNKNOWN_STAT. It is a reference to the host board for which the status is unknown.

Required/optional:
Returns:	The host_board_stat_unknown of this FailureTypeEntry.
Return type:	str
	optional

host_redundancy_loss_details¶

Gets the host_redundancy_loss_details of this FailureTypeEntry. This field is only present if the RecoveryFailureType value is equal to REC_HOST_REDUNDANCY_LOST. This field conveys details about the connectivity loss, including indications of the specific host and controller that are not connected.

Required/optional:
Returns:	The host_redundancy_loss_details of this FailureTypeEntry.
Return type:	HostRedundancyLossDetails
	optional

host_ref¶

Gets the host_ref of this FailureTypeEntry. This field is only valid when recFailureType is equal to REC_INVALID_HOST_TYPE_INDEX. It is a reference to a Host in the storage partitions topology that has an invalid host type index, or a null reference if the problem applies to the default host type.

Required/optional:
Returns:	The host_ref of this FailureTypeEntry.
Return type:	str
	optional

icc_cru_fail¶

Gets the icc_cru_fail of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_FAILED_ICC_CRU.

Required/optional:
Returns:	The icc_cru_fail of this FailureTypeEntry.
Return type:	str
	optional

icc_cru_removed¶

Gets the icc_cru_removed of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_REMOVED_ICC_CRU.

Required/optional:
Returns:	The icc_cru_removed of this FailureTypeEntry.
Return type:	str
	optional

icc_cru_stat_unknown¶

Gets the icc_cru_stat_unknown of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_ICC_CRU_UNKNOWN_STAT. It contains the identification of the interconnect CRU that has unknown status.

Required/optional:
Returns:	The icc_cru_stat_unknown of this FailureTypeEntry.
Return type:	str
	optional

icc_missing¶

Gets the icc_missing of this FailureTypeEntry. This field is present only if the recFailureType is equal to REC_ICC_MISSING. It identifies a controller enclosure having a missing interconnect cannister, which caused the other controller to lock down.

Required/optional:
Returns:	The icc_missing of this FailureTypeEntry.
Return type:	str
	optional

inactive_host_port¶

Gets the inactive_host_port of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_INACTIVE_HOST_PORT The identification of the inactive host port is returned.

Required/optional:
Returns:	The inactive_host_port of this FailureTypeEntry.
Return type:	str
	optional

inactive_initiator¶

Gets the inactive_initiator of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_INACTIVE_INITIATOR. The identification of the inactive initiator is returned.

Required/optional:
Returns:	The inactive_initiator of this FailureTypeEntry.
Return type:	str
	optional

incompatible_down_rev_dacstore_drive_ref¶

Gets the incompatible_down_rev_dacstore_drive_ref of this FailureTypeEntry. This field is only present if the value of recFailureType is equal to REC_DRIVE_INCOMPATIBLE_DOWNREV_DACSTORE. It is a reference to a drive that has an unrecognizable DACStore that was written by an earlier firmware version.

Required/optional:
Returns:	The incompatible_down_rev_dacstore_drive_ref of this FailureTypeEntry.
Return type:	str
	optional

incompatible_failed_legacy_drive¶

Gets the incompatible_failed_legacy_drive of this FailureTypeEntry. This field is present only if recFailureType is equal to REC_INCOMPATIBLE_FAILED_LEGACY_DRIVE. It identifies the data that is pertinent to this recovery scenario. The drive field in this structure is a reference to a legacy failed or in-use hot spare drive; the volumeGroup field is a reference to the drive’s parent volume group, or a null reference if the drive is unassigned. Also, it is safe to assume that the drives identified in the object graph as belonging to the volume group are valid.

Required/optional:
Returns:	The incompatible_failed_legacy_drive of this FailureTypeEntry.
Return type:	PvgRecoveryData
	optional

incompatible_sector_size_drive_ref¶

Gets the incompatible_sector_size_drive_ref of this FailureTypeEntry. This field is only present if the value of recFailureType is equal to REC_DRIVE_INCOMPATIBLE_SECTOR_SIZE. It is a reference to a drive that has a formatted sector size that is different from the other drives in the array.

Required/optional:
Returns:	The incompatible_sector_size_drive_ref of this FailureTypeEntry.
Return type:	str
	optional

incompatible_up_rev_dacstore_drive_ref¶

Gets the incompatible_up_rev_dacstore_drive_ref of this FailureTypeEntry. This field is only present if the value of recFailureType is equal to REC_DRIVE_INCOMPATIBLE_UPREV_DACSTORE. It is a reference to a drive that has an unrecognizable DACStore that was written by a later firmware version.

Required/optional:
Returns:	The incompatible_up_rev_dacstore_drive_ref of this FailureTypeEntry.
Return type:	str
	optional

incompatible_volume_group_security¶

Gets the incompatible_volume_group_security of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_INCOMPATIBLE_VOLUME_GROUP_SECURITY. It identifies the volume group with incompatible security.

Required/optional:
Returns:	The incompatible_volume_group_security of this FailureTypeEntry.
Return type:	str
	optional

incomplete_volume_group_ref¶

Gets the incomplete_volume_group_ref of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_VOLUME_GROUP_INCOMPLETE. It is a reference to a volume group that has transitioned to “incomplete” state.

Required/optional:
Returns:	The incomplete_volume_group_ref of this FailureTypeEntry.
Return type:	str
	optional

incorrect_support_cru¶

Gets the incorrect_support_cru of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_REDUNDANT_PS_REQUIRED. It contains the identification of the support CRU that is lacking a required power supply component.

Required/optional:
Returns:	The incorrect_support_cru of this FailureTypeEntry.
Return type:	str
	optional

insufficient_cache_backup_device_capacity¶

Gets the insufficient_cache_backup_device_capacity of this FailureTypeEntry. This field is present if the recFailuretype is equal to REC_CACHE_BACKUP_DEVICE_INSUFFICIENT_CAPACITY. It identifies a controller whose cache backup device configuration is such that it does not have sufficient space for a full cache backup.

Required/optional:
Returns:	The insufficient_cache_backup_device_capacity of this FailureTypeEntry.
Return type:	str
	optional

integrated_battery_expired¶

Gets the integrated_battery_expired of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_EXPIRED_INTEGRATED_BATTERY. It contains the identification of the integrated battery component that has expired.

Required/optional:
Returns:	The integrated_battery_expired of this FailureTypeEntry.
Return type:	str
	optional

invalid_sata_flash_config¶

Gets the invalid_sata_flash_config of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType value is equal to REC_INVALID_SATA_FLASH_CONFIGURATION. It identifies a controller with an invalid SATA flash drive configuration.

Required/optional:
Returns:	The invalid_sata_flash_config of this FailureTypeEntry.
Return type:	str
	optional

key_invalid¶

Gets the key_invalid of this FailureTypeEntry. Obsolete. This field is present only if the value of RecoveryFailureType value is equal to REC_EXTERNAL_KMS_KEY_INVALID.

Required/optional:
Returns:	The key_invalid of this FailureTypeEntry.
Return type:	str
	optional

key_validation_lock¶

Gets the key_validation_lock of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType value is equal to REC_SECURITY_KEY_VALIDATION_LOCK. It identifies a controller that will no longer accept key validation requests.

Required/optional:
Returns:	The key_validation_lock of this FailureTypeEntry.
Return type:	str
	optional

ld_fw_version_mismatch¶

Gets the ld_fw_version_mismatch of this FailureTypeEntry. This field is present only if the recFailureType is equal to REC_LD_FW_VERSION_MISMATCH. It identifies the controller firmware version recorded on the drives (the native controller firmware version) when a newly inserted Simplex controller has been locked down due to a mismatch between it’s reported controller firmware version and the native controller firmware version. Download the reported native controller firmware version to the locked down controller to recover from this failure.

Required/optional:
Returns:	The ld_fw_version_mismatch of this FailureTypeEntry.
Return type:	LockdownCtrlFwVersion
	optional

legacy_vg_not_optimal¶

Gets the legacy_vg_not_optimal of this FailureTypeEntry. This “field” is present if the recFailureType value has no associated reference. It means that, there is no data in the structure other than the failure type itself. This is true for the following recFailureType values:

Required/optional:
Returns:	The legacy_vg_not_optimal of this FailureTypeEntry.
Return type:	str
	optional

link_speed_detection_error¶

Gets the link_speed_detection_error of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_LINK_SPEED_DETECTION_MISMATCH.

Required/optional:
Returns:	The link_speed_detection_error of this FailureTypeEntry.
Return type:	LinkSpeedDetectionError
	optional

link_speed_mismatch¶

Gets the link_speed_mismatch of this FailureTypeEntry. This field is present only if the recFailureType is equal to REC_LINK_SPEED_MISMATCH. It identifies a controller that is locked down due to detection of a mismatch between an enclosure link speed setting and link speeds that the controller is able to support.

Required/optional:
Returns:	The link_speed_mismatch of this FailureTypeEntry.
Return type:	str
	optional

max_temp_warn¶

Gets the max_temp_warn of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_MAX_TEMP_EXCEEDED. It contains the identification of the thermal sensor component that is reporting a temperature above the maximum level.

Required/optional:
Returns:	The max_temp_warn of this FailureTypeEntry.
Return type:	str
	optional

mem_parity_error¶

Gets the mem_parity_error of this FailureTypeEntry. This field is equal to present only if the RecoveryFailureType value is equal to REC_MEM_PARITY_ERROR. It contains the identification of the controller that has failed due to a persistent memory parity error.

Required/optional:
Returns:	The mem_parity_error of this FailureTypeEntry.
Return type:	str
	optional

metadata_offline¶

Gets the metadata_offline of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_METADATA_OFFLINE.

Required/optional:
Returns:	The metadata_offline of this FailureTypeEntry.
Return type:	MetadataOffline
	optional

mini_hub_fail¶

Gets the mini_hub_fail of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_FAILED_MINIHUB. It contains the identification of the minihub component that has failed.

Required/optional:
Returns:	The mini_hub_fail of this FailureTypeEntry.
Return type:	str
	optional

mini_hub_unsupported¶

Gets the mini_hub_unsupported of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_UNSUPPORTED_MINIHUB. It contains the identification of the unsupported minihub.

Required/optional:
Returns:	The mini_hub_unsupported of this FailureTypeEntry.
Return type:	str
	optional

minihub_ref¶

Gets the minihub_ref of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_MINIHUB_SPEED_MISMATCH. It contains the identification of the drive side minihub with the data rate mismatch.

Required/optional:
Returns:	The minihub_ref of this FailureTypeEntry.
Return type:	str
	optional

mirror_proxy_ref¶

Gets the mirror_proxy_ref of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_RVM_WRITE_MODE_INCONSISTENT.

Required/optional:
Returns:	The mirror_proxy_ref of this FailureTypeEntry.
Return type:	str
	optional

mirror_unsynchronized¶

Gets the mirror_unsynchronized of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_MIRROR_UNSYNCHRONIZED. It contains the identification of the mirror relationship.

Required/optional:
Returns:	The mirror_unsynchronized of this FailureTypeEntry.
Return type:	MirrorUnsynchronized
	optional

misconfigured_enclosure¶

Gets the misconfigured_enclosure of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_ENCLOSURE_MISCONFIGURED. It indicates an enclosure has invalid configuration settings.

Required/optional:
Returns:	The misconfigured_enclosure of this FailureTypeEntry.
Return type:	str
	optional

misconfigured_host¶

Gets the misconfigured_host of this FailureTypeEntry. This field is only present if the RecoveryFailureType value is equal to REC_MULTIPATH_CONFIGURATION_ERROR. This field contains a reference to the Host in the storage partitions topology that has the multipath configuration issue.

Required/optional:
Returns:	The misconfigured_host of this FailureTypeEntry.
Return type:	str
	optional

mismatched_eeprom_contents¶

Gets the mismatched_eeprom_contents of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType value is equal to REC_MISMATCHED_MIDPLANE_EEPROMS. It contains a reference to the tray in which the midplane EEPROMs are mismatched.

Required/optional:
Returns:	The mismatched_eeprom_contents of this FailureTypeEntry.
Return type:	str
	optional

missing_assigned_drives¶

Gets the missing_assigned_drives of this FailureTypeEntry. This recovery failure type includes a list of the drives that have gone missing. The drives in the list are identified as a collection of tray/slot combinations.

Required/optional:
Returns:	The missing_assigned_drives of this FailureTypeEntry.
Return type:	list[TraySlot]
	optional

missing_hot_spare_drive_ref¶

Gets the missing_hot_spare_drive_ref of this FailureTypeEntry. This field is only present if the value of recFailureType is equal to REC_HOTSPARE_DRIVE_MISSING. It is a reference to a standby hot spare drive that is missing from the configuration.

Required/optional:
Returns:	The missing_hot_spare_drive_ref of this FailureTypeEntry.
Return type:	str
	optional

missing_volume_group_ref¶

Gets the missing_volume_group_ref of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_VOLUME_GROUP_MISSING. It is a reference to a volume group that has transitioned to “missing” state.

Required/optional:
Returns:	The missing_volume_group_ref of this FailureTypeEntry.
Return type:	str
	optional

miswired_sas_cross¶

Gets the miswired_sas_cross of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_SAS_CROSS_MISWIRE. It identifies the SAS port that has been disabled.

Required/optional:
Returns:	The miswired_sas_cross of this FailureTypeEntry.
Return type:	SasPort
	optional

miswired_sas_host¶

Gets the miswired_sas_host of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_SAS_HOST_MISWIRE. It identifies the SAS port from which the miswire originates.

Required/optional:
Returns:	The miswired_sas_host of this FailureTypeEntry.
Return type:	SasPort
	optional

miswired_sas_loop¶

Gets the miswired_sas_loop of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_SAS_LOOP_MISWIRE. It identifies the SAS port that has been disabled.

Required/optional:
Returns:	The miswired_sas_loop of this FailureTypeEntry.
Return type:	SasPort
	optional

miswired_sas_port¶

Gets the miswired_sas_port of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_SAS_PORT_MISWIRED. It identifies the SAS port from which the miswire originates. The type of miswire is identified by a field in the SasPort structure.

Required/optional:
Returns:	The miswired_sas_port of this FailureTypeEntry.
Return type:	SasPort
	optional

mixed_drive_enclosure_miswire¶

Gets the mixed_drive_enclosure_miswire of this FailureTypeEntry. This field is only present if the value of recFailureType is equal to REC_MIXED_DRIVE_ENCLOSURE_MISWIRE. It identifies the drive channels with an unsupported combination of drive enclosures.

Required/optional:
Returns:	The mixed_drive_enclosure_miswire of this FailureTypeEntry.
Return type:	list[MiswiredDriveChannelList]
	optional

mixeddrivetypes_feature¶

Gets the mixeddrivetypes_feature of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_MISMATCHED_DRIVE_TYPE.

Required/optional:
Returns:	The mixeddrivetypes_feature of this FailureTypeEntry.
Return type:	FeatureState
	optional

multiple_mismatched_keys¶

Gets the multiple_mismatched_keys of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType value is equal to REC_MULTIPLE_MISMATCHED_KEY_IDS_FOUND.

Required/optional:
Returns:	The multiple_mismatched_keys of this FailureTypeEntry.
Return type:	str
	optional

native_sata_incompatible_nvsram¶

Gets the native_sata_incompatible_nvsram of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_ALL_DRIVES_BYPASSED_INCOMPATIBLE_NVSRAM. It identifies the controller in a Native SATA array that has a duplex NVSRAM setting and all drives appear as bypassed.

Required/optional:
Returns:	The native_sata_incompatible_nvsram of this FailureTypeEntry.
Return type:	str
	optional

native_vg_foreign_drive_mutual_ref¶

Gets the native_vg_foreign_drive_mutual_ref of this FailureTypeEntry. This field is present only if recFailureType is equal to REC_NATIVE_VG_FOREIGN_DRIVE_MUTUAL_REF. It identifies the data that is pertinent to this recovery scenario. The drive field in this structure is a reference to the foreign drive; the volumeGroup field is a reference to the native volume group.

Required/optional:
Returns:	The native_vg_foreign_drive_mutual_ref of this FailureTypeEntry.
Return type:	PvgRecoveryData
	optional

native_vg_refers_to_foreign_drive¶

Gets the native_vg_refers_to_foreign_drive of this FailureTypeEntry. This field is present only if recFailureType is equal to REC_NATIVE_VG_REFERS_TO_FOREIGN_DRIVE. It identifies the data that is pertinent to this recovery scenario. The drive field in this structure is a reference to the foreign drive, and the volumeGroup field is a reference to the native volume group.

Required/optional:
Returns:	The native_vg_refers_to_foreign_drive of this FailureTypeEntry.
Return type:	PvgRecoveryData
	optional

network_setup_error¶

Gets the network_setup_error of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_NET_SETUP_ERROR.

Required/optional:
Returns:	The network_setup_error of this FailureTypeEntry.
Return type:	str
	optional

new_key_sequence¶

Gets the new_key_sequence of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_SECURITY_GET_NEW_KEY.

Required/optional:
Returns:	The new_key_sequence of this FailureTypeEntry.
Return type:	int
	optional

nominal_temp_warn¶

Gets the nominal_temp_warn of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_NOMINAL_TEMP_EXCEEDED. It contains the identification of the thermal sensor component that is reporting a temperature above the nominal level.

Required/optional:
Returns:	The nominal_temp_warn of this FailureTypeEntry.
Return type:	str
	optional

non_fru_battery_fail¶

Gets the non_fru_battery_fail of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_NON_FRU_FAILED_BATTERY (or its equivalent REC_FAILED_INTEGRATED_BATTERY). It contains the identification of the controller with the failed battery. Note that the “non-FRU” terminology is really misleading since this case applies only when the battery is in a FRU (as opposed to a CRU).

Required/optional:
Returns:	The non_fru_battery_fail of this FailureTypeEntry.
Return type:	str
	optional

non_fru_battery_removed¶

Gets the non_fru_battery_removed of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_NON_FRU_REMOVED_BATTERY (or its equivalent REC_REMOVED_INTEGRATED_BATTERY). It contains the identification of the FRU’d battery that was removed. Note that the “non-FRU” terminology is really misleading since this case applies only when the battery is in a FRU (as opposed to a CRU).

Required/optional:
Returns:	The non_fru_battery_removed of this FailureTypeEntry.
Return type:	str
	optional

non_fru_battery_warn¶

Gets the non_fru_battery_warn of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_NON_FRU_BATTERY_NEAR_EXPIRATION (or its equivalent REC_INTEGRATED_BATTERY_NEAR_EXPIRATION). It contains the identification of the controller with the battery warning. Note that the “non-FRU” terminology is really misleading since this case applies only when the battery is in a FRU (as opposed to a CRU).

Required/optional:
Returns:	The non_fru_battery_warn of this FailureTypeEntry.
Return type:	str
	optional

non_preferred_path¶

Gets the non_preferred_path of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_NON_PREFERRED_PATH. It contains the identification of the controller that is the preferred owner of the volume(s) that have been switched to the non-preferred owner due to some sort of I/O path error.

Required/optional:
Returns:	The non_preferred_path of this FailureTypeEntry.
Return type:	NotOnPreferredPath
	optional

ntp_query_failure¶

Gets the ntp_query_failure of this FailureTypeEntry. Provides details regarding an NTP query failure that is preventing the controller from updating its software clock

Required/optional:
Returns:	The ntp_query_failure of this FailureTypeEntry.
Return type:	ControllerNtpErrorDetails
	optional

ntp_resolution_failure¶

Gets the ntp_resolution_failure of this FailureTypeEntry. Provides details regarding an NTP resolution failure that is preventing the controller from updating its software clock

Required/optional:
Returns:	The ntp_resolution_failure of this FailureTypeEntry.
Return type:	ControllerNtpErrorDetails
	optional

ntp_service_failure_controller¶

Gets the ntp_service_failure_controller of this FailureTypeEntry. Controller reporting the NTP Service failure

Required/optional:
Returns:	The ntp_service_failure_controller of this FailureTypeEntry.
Return type:	str
	optional

offline_ctl¶

Gets the offline_ctl of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_OFFLINE_CTL. It contains the identification of a controller that has been placed offline.

Required/optional:
Returns:	The offline_ctl of this FailureTypeEntry.
Return type:	str
	optional

offline_ctlr_ioc_diag_failed¶

Gets the offline_ctlr_ioc_diag_failed of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType value is equal to REC_OFFLINE_CTL_IOC_FAIL. It identifies the controller that failed IOC diagnostic testing and which is now offline.

Required/optional:
Returns:	The offline_ctlr_ioc_diag_failed of this FailureTypeEntry.
Return type:	str
	optional

open_drawer_ref¶

Gets the open_drawer_ref of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_DRAWER_OPENED. It is a reference to the open or removed drawer.

Required/optional:
Returns:	The open_drawer_ref of this FailureTypeEntry.
Return type:	str
	optional

orphan_incomplete_member¶

Gets the orphan_incomplete_member of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_ARVM_ORPHAN_INCOMPLETE_MEMBER. It identifies the orphan incomplete async mirror group member.

Required/optional:
Returns:	The orphan_incomplete_member of this FailureTypeEntry.
Return type:	str
	optional

orphan_mirror_group¶

Gets the orphan_mirror_group of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_ARVM_ORPHAN_GROUP. It identifies the orphaned mirror group.

Required/optional:
Returns:	The orphan_mirror_group of this FailureTypeEntry.
Return type:	str
	optional

orphan_mirror_member¶

Gets the orphan_mirror_member of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_ARVM_ORPHAN_MEMBER. It identifies the orphaned member.

Required/optional:
Returns:	The orphan_mirror_member of this FailureTypeEntry.
Return type:	str
	optional

partial_present_volume_group_ref¶

Gets the partial_present_volume_group_ref of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_VOLUME_GROUP_PARTIALLY_COMPLETE. It is a reference to a volume group that has transitioned to “partial” state.

Required/optional:
Returns:	The partial_present_volume_group_ref of this FailureTypeEntry.
Return type:	str
	optional

passive_ctl¶

Gets the passive_ctl of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_PASSIVE_CTL. It contains the identification of a controller that has been placed into the “passive” mode of operation.

Required/optional:
Returns:	The passive_ctl of this FailureTypeEntry.
Return type:	str
	optional

path_degraded_failure¶

Gets the path_degraded_failure of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_PATH_DEGRADED.

Required/optional:
Returns:	The path_degraded_failure of this FailureTypeEntry.
Return type:	PathDegradedFailure
	optional

paused_alt_state_mirror_group¶

Gets the paused_alt_state_mirror_group of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_ARVM_SYNC_PAUSED_ALT_STATE. It identifies the AsyncMirrorGroup whose synchronization has been paused.

Required/optional:
Returns:	The paused_alt_state_mirror_group of this FailureTypeEntry.
Return type:	str
	optional

paused_role_change_group¶

Gets the paused_role_change_group of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType is equal to REC_ARVM_ROLE_CHANGE_PAUSED. It identifies the async mirror group that has had a role change pause due to issues with required data synchronization.

Required/optional:
Returns:	The paused_role_change_group of this FailureTypeEntry.
Return type:	str
	optional

performance_tier_feature¶

Gets the performance_tier_feature of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_PERFORMANCE_TIER_NOT_COMPLIANT. It indicates that the performance tier feature is out of compliance.

Required/optional:
Returns:	The performance_tier_feature of this FailureTypeEntry.
Return type:	FeatureState
	optional

pit_group_failed¶

Gets the pit_group_failed of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_PIT_GROUP_FAILED. It contains a reference to a PiT Group that has failed.

Required/optional:
Returns:	The pit_group_failed of this FailureTypeEntry.
Return type:	str
	optional

pit_group_over_warn_threshold¶

Gets the pit_group_over_warn_threshold of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_PIT_GROUP_REPOSITORY_OVER_THRESHOLD. It contains a reference to a PiT Group with a repository capacity over the warning threshold.

Required/optional:
Returns:	The pit_group_over_warn_threshold of this FailureTypeEntry.
Return type:	str
	optional

pit_group_pending_create_failed¶

Gets the pit_group_pending_create_failed of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_PENDING_PIT_CREATION_FAILED. It contains a reference to the PiT Group.

Required/optional:
Returns:	The pit_group_pending_create_failed of this FailureTypeEntry.
Return type:	str
	optional

pit_group_repository_full¶

Gets the pit_group_repository_full of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_PIT_GROUP_REPOSITORY_FULL. It contains a reference to a PiT Group with a full repository.

Required/optional:
Returns:	The pit_group_repository_full of this FailureTypeEntry.
Return type:	str
	optional

pit_purged¶

Gets the pit_purged of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_PIT_PURGED. It contains a reference to a PiT that has been purged to free PiT group repository capacity.

Required/optional:
Returns:	The pit_purged of this FailureTypeEntry.
Return type:	str
	optional

pit_rollback_paused¶

Gets the pit_rollback_paused of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_PIT_ROLLBACK_PAUSED. It contains a reference to the PiT Group with a paused rollback operation.

Required/optional:
Returns:	The pit_rollback_paused of this FailureTypeEntry.
Return type:	str
	optional

pit_view_failed¶

Gets the pit_view_failed of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_PIT_VIEW_FAILED. It contains a reference to a PiT View that has failed.

Required/optional:
Returns:	The pit_view_failed of this FailureTypeEntry.
Return type:	str
	optional

pit_view_over_warn_threshold¶

Gets the pit_view_over_warn_threshold of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_PIT_VIEW_REPOSITORY_OVER_THRESHOLD. It contains a reference to a PiT View with a repository over the warning threshold.

Required/optional:
Returns:	The pit_view_over_warn_threshold of this FailureTypeEntry.
Return type:	str
	optional

pit_view_repository_full¶

Gets the pit_view_repository_full of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_PIT_VIEW_REPOSITORY_FULL. It contains a reference to a PiT View with a full repository.

Required/optional:
Returns:	The pit_view_repository_full of this FailureTypeEntry.
Return type:	str
	optional

power_supply_fail¶

Gets the power_supply_fail of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_FAILED_POWER_SUPPLY. It contains the identification of the power supply component that has failed.

Required/optional:
Returns:	The power_supply_fail of this FailureTypeEntry.
Return type:	str
	optional

power_supply_invalid¶

Gets the power_supply_invalid of this FailureTypeEntry. This field is present only if the value of the RecoveryFailureType entry is equal to REC_INVALID_POWER_SUPPLY. It is a reference to a power supply that has failed validation.

Required/optional:
Returns:	The power_supply_invalid of this FailureTypeEntry.
Return type:	str
	optional

power_supply_removed¶

Gets the power_supply_removed of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_REMOVED_POWER_SUPPLY.

Required/optional:
Returns:	The power_supply_removed of this FailureTypeEntry.
Return type:	str
	optional

power_supply_stat_unknown¶

Gets the power_supply_stat_unknown of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_POWER_SUPPLY_UNKNOWN_STAT. It contains the identification of the power supply that has failed with unknown status.

Required/optional:
Returns:	The power_supply_stat_unknown of this FailureTypeEntry.
Return type:	str
	optional

proc_mem_too_small_for_cache¶

Gets the proc_mem_too_small_for_cache of this FailureTypeEntry. This field is present only if the recFailureType value is equal to REC_PROC_MEM_TOO_SMALL_FOR_CACHE. It identifies a controller that does not have enough processor memory for managing the amount of cache memory it has.

Required/optional:
Returns:	The proc_mem_too_small_for_cache of this FailureTypeEntry.
Return type:	str
	optional

protection_information_feature¶

Gets the protection_information_feature of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_PROTECTION_INFORMATION_NOT_COMPLIANT. It indicates that the T10 Protection Information feature is out of compliance.

Required/optional:
Returns:	The protection_information_feature of this FailureTypeEntry.
Return type:	FeatureState
	optional

protection_information_not_supported¶

Gets the protection_information_not_supported of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_PROTECTION_INFORMATION_NOT_SUPPORTED. The identification of the volume group with the protected volumes that cannot be supported by the storage array is returned.

Required/optional:
Returns:	The protection_information_not_supported of this FailureTypeEntry.
Return type:	str
	optional

raid6_feature¶

Gets the raid6_feature of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_RAID6_NOT_COMPLIANT. It is a FeatureState structure indicating that the RAID 6 feature is out of compliance.

Required/optional:
Returns:	The raid6_feature of this FailureTypeEntry.
Return type:	FeatureState
	optional

rec_failure_type¶

Gets the rec_failure_type of this FailureTypeEntry. This enumeration defines the different recovery failure types that may be reported by a controller as part of the getRecoveryFailureList procedure.

Required/optional:
Returns:	The rec_failure_type of this FailureTypeEntry.
Return type:	str
	required

recovery_point_lost_group¶

Gets the recovery_point_lost_group of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_ARVM_MIRROR_GROUP_RECOVERY_POINT_LOST. It identifies the Async Mirror Group that lost a recovery point.

Required/optional:
Returns:	The recovery_point_lost_group of this FailureTypeEntry.
Return type:	str
	optional

redundancy_fail¶

Gets the redundancy_fail of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_LOSS_OF_EXTERNAL_REDUNDANCY. It identifies drive channels that are not externally connected..

Required/optional:
Returns:	The redundancy_fail of this FailureTypeEntry.
Return type:	ExternalRedundancyFailure
	optional

remote_vol_no_array¶

Gets the remote_vol_no_array of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_REMOTE_NO_ARRAY. It contains the identification of the remote volume.

Required/optional:
Returns:	The remote_vol_no_array of this FailureTypeEntry.
Return type:	RemoteVolNoArray
	optional

remote_vol_no_fabric¶

Gets the remote_vol_no_fabric of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_REMOTE_NO_FABRIC. It contains the identification of the remote volume.

Required/optional:
Returns:	The remote_vol_no_fabric of this FailureTypeEntry.
Return type:	RemoteVolNoFabric
	optional

remote_vol_no_lun¶

Gets the remote_vol_no_lun of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_REMOTE_NO_LUN. It contains the identification of the remote volume.

Required/optional:
Returns:	The remote_vol_no_lun of this FailureTypeEntry.
Return type:	RemoteVolNoLUN
	optional

remote_vol_wwn_change_failed¶

Gets the remote_vol_wwn_change_failed of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_REMOTE_WWN_CHANGE_FAILED. It contains the identification of the remote volume.

Required/optional:
Returns:	The remote_vol_wwn_change_failed of this FailureTypeEntry.
Return type:	RemoteVolWWNChangeFailed
	optional

removed_ctrl¶

Gets the removed_ctrl of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_REMOVED_CONTROLLER. The identification of the missing controller is returned.

Required/optional:
Returns:	The removed_ctrl of this FailureTypeEntry.
Return type:	str
	optional

replaced_drive_wrong_type¶

Gets the replaced_drive_wrong_type of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_REPLACED_DRIVE_WRONG_TYPE. It indicates that a failed drive has been replaced with a drive of the wrong type. The failure type list will contain one entry of this type for each wrong replacement drive in the storage array.

Required/optional:
Returns:	The replaced_drive_wrong_type of this FailureTypeEntry.
Return type:	str
	optional

repository_full¶

Gets the repository_full of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_REPOSITORY_FULL. It contains the identification of the repository that is full.

Required/optional:
Returns:	The repository_full of this FailureTypeEntry.
Return type:	FullRepository
	optional

repository_over_threshold¶

Gets the repository_over_threshold of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_REPOSITORY_OVER_THRESHOLD. It contains the identification of the repository volume that is over the threshold.

Required/optional:
Returns:	The repository_over_threshold of this FailureTypeEntry.
Return type:	str
	optional

role_conflict_mirror_group¶

Gets the role_conflict_mirror_group of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_ARVM_MIRROR_GROUP_ROLE_CONFLICT. It identifies the Async Mirror Group with a role conflict.

Required/optional:
Returns:	The role_conflict_mirror_group of this FailureTypeEntry.
Return type:	str
	optional

rpa_parity_error¶

Gets the rpa_parity_error of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_RPA_ERR_CTL. It contains the identification of the controller with the RPA parity error.

Required/optional:
Returns:	The rpa_parity_error of this FailureTypeEntry.
Return type:	str
	optional

rvm_feature¶

Gets the rvm_feature of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_RVM_NOT_COMPLIANT.

Required/optional:
Returns:	The rvm_feature of this FailureTypeEntry.
Return type:	FeatureState
	optional

sata_sct_cmnd_unsupported¶

Gets the sata_sct_cmnd_unsupported of this FailureTypeEntry. This field is present only if the value of the recFailureType is equal to REC_INCOMPATIBLE_SATA_DRIVE. It is a reference to a SATA drive that is incompatible because it does not support SMART Command Transfer (SCT) commands.

Required/optional:
Returns:	The sata_sct_cmnd_unsupported of this FailureTypeEntry.
Return type:	str
	optional

sbb_validation_failure¶

Gets the sbb_validation_failure of this FailureTypeEntry. This field is present only if the value of the RecoveryFailureType entry is equal to REC_SBB_VALIDATION_FAILURE. It contains the identification of the component that failed validation.

Required/optional:
Returns:	The sbb_validation_failure of this FailureTypeEntry.
Return type:	str
	optional

security_key_needed¶

Gets the security_key_needed of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_SECURITY_GET_KEY. It contains a list of drive references for the drives that are locked down and a lockKeyIDRef of the lockKey that is needed to unlock the drives.

Required/optional:
Returns:	The security_key_needed of this FailureTypeEntry.
Return type:	SecurityKeyNeeded
	optional

snap_fail¶

Gets the snap_fail of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_SNAPSHOT_FAILED. It contains the identification of the snapshot volume that failed.

Required/optional:
Returns:	The snap_fail of this FailureTypeEntry.
Return type:	SnapshotFailure
	optional

snap_rollback_paused¶

Gets the snap_rollback_paused of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType value is equal to REC_SNAPSHOT_ROLLBACK_PAUSED. It is a reference to a snapshot that is currently paused.

Required/optional:
Returns:	The snap_rollback_paused of this FailureTypeEntry.
Return type:	str
	optional

snapshot_feature¶

Gets the snapshot_feature of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_SNAPSHOT_NOT_COMPLIANT.

Required/optional:
Returns:	The snapshot_feature of this FailureTypeEntry.
Return type:	FeatureState
	optional

solid_state_disks_feature¶

Gets the solid_state_disks_feature of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_SSD_NOT_COMPLIANT. It indicates that the Solid State Disk Support feature is out of compliance.

Required/optional:
Returns:	The solid_state_disks_feature of this FailureTypeEntry.
Return type:	FeatureState
	optional

speed_mismatch_drive¶

Gets the speed_mismatch_drive of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_DRIVE_BYPASSED_SPEED_MISMATCH. It contains the identification of the drive that was bypassed.

Required/optional:
Returns:	The speed_mismatch_drive of this FailureTypeEntry.
Return type:	str
	optional

speed_neg_error¶

Gets the speed_neg_error of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_SPEED_NEG_ERROR. It indicates that a Fibre Channel speed negotiation error has occurred.

Required/optional:
Returns:	The speed_neg_error of this FailureTypeEntry.
Return type:	SpeedNegError
	optional

spm_feature¶

Gets the spm_feature of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_PARTITIONS_NOT_COMPLIANT. It contains the identification of the storage partitions feature that is not in compliance.

Required/optional:
Returns:	The spm_feature of this FailureTypeEntry.
Return type:	FeatureState
	optional

submodel_mismatch¶

Gets the submodel_mismatch of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_SUBMODEL_MISMATCH.

Required/optional:
Returns:	The submodel_mismatch of this FailureTypeEntry.
Return type:	str
	optional

submodel_not_set¶

Gets the submodel_not_set of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_SUBMODEL_NOT_SET.

Required/optional:
Returns:	The submodel_not_set of this FailureTypeEntry.
Return type:	str
	optional

submodel_not_supported¶

Gets the submodel_not_supported of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_SUBMODEL_NOT_SUPPORTED.

Required/optional:
Returns:	The submodel_not_supported of this FailureTypeEntry.
Return type:	str
	optional

support_cru_fail¶

Gets the support_cru_fail of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_FAILED_SUPPORT_CRU.

Required/optional:
Returns:	The support_cru_fail of this FailureTypeEntry.
Return type:	str
	optional

support_cru_no_input¶

Gets the support_cru_no_input of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_SUPPORT_CRU_NOINPUT.

Required/optional:
Returns:	The support_cru_no_input of this FailureTypeEntry.
Return type:	str
	optional

support_cru_removed¶

Gets the support_cru_removed of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_REMOVED_SUPPORT_CRU.

Required/optional:
Returns:	The support_cru_removed of this FailureTypeEntry.
Return type:	str
	optional

support_cru_stat_unknown¶

Gets the support_cru_stat_unknown of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_SUPPORT_CRU_UNKNOWN_STAT. It contains the identification of the support CRU that has unknown status.

Required/optional:
Returns:	The support_cru_stat_unknown of this FailureTypeEntry.
Return type:	str
	optional

suspended_mirror_group¶

Gets the suspended_mirror_group of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_ARVM_SYNC_INTERNALLY_SUSPENDED. It identifies an async mirror group that has been suspended by the controller due to an error condition.

Required/optional:
Returns:	The suspended_mirror_group of this FailureTypeEntry.
Return type:	str
	optional

sync_interval_time_exceeded¶

Gets the sync_interval_time_exceeded of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_ARVM_SYNC_INTERVAL_TIME_OVER_THRESHOLD. It contains information about a mirror group fault condition.

Required/optional:
Returns:	The sync_interval_time_exceeded of this FailureTypeEntry.
Return type:	AsyncMirrorGroupFaultIndication
	optional

temp_sensor_removed¶

Gets the temp_sensor_removed of this FailureTypeEntry. This field is present if the RecoveryFailureType value is equal to REC_REMOVED_TEMP_SENSOR.

Required/optional:
Returns:	The temp_sensor_removed of this FailureTypeEntry.
Return type:	str
	optional

temp_sensor_stat_unknown¶

Gets the temp_sensor_stat_unknown of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_TEMP_SENSOR_UNKNOWN_STAT. It contains the identification of the temperature sensor that has failed with unknown status.

Required/optional:
Returns:	The temp_sensor_stat_unknown of this FailureTypeEntry.
Return type:	str
	optional

thin_volume_failed¶

Gets the thin_volume_failed of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_TPV_FAILED. It identifies a thin volume that is in a failed state.

Required/optional:
Returns:	The thin_volume_failed of this FailureTypeEntry.
Return type:	str
	optional

thin_volume_over_threshold¶

Gets the thin_volume_over_threshold of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_TPV_REPOSITORY_OVER_THRESHOLD. It identifies a thin volume with a repository over the threshold value.

Required/optional:
Returns:	The thin_volume_over_threshold of this FailureTypeEntry.
Return type:	str
	optional

thin_volume_repository_full¶

Gets the thin_volume_repository_full of this FailureTypeEntry. This field is present only if the value of recFailureType is equal to REC_TPV_REPOSITORY_FULL. It identifies a thin volume with a full repository.

Required/optional:
Returns:	The thin_volume_repository_full of this FailureTypeEntry.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

transceiver_module_failed¶

Gets the transceiver_module_failed of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_FAILED_TRANSCEIVER_MODULE. It contains the identification of the transceiver module.

Required/optional:
Returns:	The transceiver_module_failed of this FailureTypeEntry.
Return type:	str
	optional

transceiver_module_stat_unknown¶

Gets the transceiver_module_stat_unknown of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_TRANS_MOD_UNKNOWN_STAT. It contains the identification of the transceiver module that has failed with unknown status.

Required/optional:
Returns:	The transceiver_module_stat_unknown of this FailureTypeEntry.
Return type:	str
	optional

tray_code_mismatch¶

Gets the tray_code_mismatch of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_ESM_CODE_VERSION_MISMATCH. It contains the identification of the tray that has the ESM cards that have mismatching firmware versions.

Required/optional:
Returns:	The tray_code_mismatch of this FailureTypeEntry.
Return type:	str
	optional

tray_hardware_mismatch¶

Gets the tray_hardware_mismatch of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_ESM_HARDWARE_MISMATCH. It contains the identification of the tray that has the mismatched ESM cards.

Required/optional:
Returns:	The tray_hardware_mismatch of this FailureTypeEntry.
Return type:	str
	optional

tray_id_conflicts¶

Gets the tray_id_conflicts of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_TRAYID_CONFLICT. It contains the identification of the drive trays that have conflicting tray IDs.

Required/optional:
Returns:	The tray_id_conflicts of this FailureTypeEntry.
Return type:	TrayRefList
	optional

tray_id_mismatch¶

Gets the tray_id_mismatch of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_TRAYID_MISMATCH. It contains the identification of the tray that has IDs that do not match.

Required/optional:
Returns:	The tray_id_mismatch of this FailureTypeEntry.
Return type:	str
	optional

tray_redundancy_failure¶

Gets the tray_redundancy_failure of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_LOST_REDUNDANCY_TRAY. It contains the identification of the tray that has lost redundancy.

Required/optional:
Returns:	The tray_redundancy_failure of this FailureTypeEntry.
Return type:	TrayLostRedundancyFailure
	optional

twi_bus_failed¶

Gets the twi_bus_failed of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType value is equal to REC_FAILED_TWI_BUS. It contains a reference to the tray with a failed TWI bus.

Required/optional:
Returns:	The twi_bus_failed of this FailureTypeEntry.
Return type:	str
	optional

unsupported_capacity_drive¶

Gets the unsupported_capacity_drive of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType value is equal to REC_DRIVE_UNSUPPORTED_CAPACITY. It contains a reference to the drive with an unsupported capacity.

Required/optional:
Returns:	The unsupported_capacity_drive of this FailureTypeEntry.
Return type:	str
	optional

unsupported_host_board¶

Gets the unsupported_host_board of this FailureTypeEntry. This field is present only if the recFailureType is equal to REC_UNSUPPORTED_HOST_BOARD. It identifies an unsupported host board that is responsible for the other controller locking down.

Required/optional:
Returns:	The unsupported_host_board of this FailureTypeEntry.
Return type:	str
	optional

unsupported_protocol_connection¶

Gets the unsupported_protocol_connection of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType value is equal to REC_DRIVE_UNSUPPORTED_PROTOCOL_CONNECTION. It identifies the drive using an unsupported protocol connection.

Required/optional:
Returns:	The unsupported_protocol_connection of this FailureTypeEntry.
Return type:	str
	optional

unsupported_tray¶

Gets the unsupported_tray of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_UNSUPPORTED_TRAY. It contains the identification of the unsupported tray.

Required/optional:
Returns:	The unsupported_tray of this FailureTypeEntry.
Return type:	str
	optional

ups_on_battery¶

Gets the ups_on_battery of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_UPS_ON_BATTERY. It contains the identification of the UPS component that has switched to battery power.

Required/optional:
Returns:	The ups_on_battery of this FailureTypeEntry.
Return type:	str
	optional

usm_db_full_error¶

Gets the usm_db_full_error of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_USM_DATABASE_FULL.

Required/optional:
Returns:	The usm_db_full_error of this FailureTypeEntry.
Return type:	UsmError
	optional

usm_exist_error¶

Gets the usm_exist_error of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_USM_UNREADABLE_SECTORS_EXIST.

Required/optional:
Returns:	The usm_exist_error of this FailureTypeEntry.
Return type:	UsmError
	optional

vg_cloned¶

Gets the vg_cloned of this FailureTypeEntry. This field is present only if recFailureType is equal to REC_VG_CLONED. It identifies the cloned volume group. Also, it is safe to assume that the drives identified in the object graph as belonging to the volume group are valid.

Required/optional:
Returns:	The vg_cloned of this FailureTypeEntry.
Return type:	str
	optional

vg_drive_part_of_multiple_vgs¶

Gets the vg_drive_part_of_multiple_vgs of this FailureTypeEntry. This field is present only if recFailureType is equal to REC_VG_DRIVE_PART_OF_MULTIPLE_VGS. It identifies the data that is pertinent to this recovery scenario. The drive field in this structure is a reference to the foreign drive; the volumeGroup field is a reference to the primary affected volume group (the one that needs to have its drives removed). Also, it is safe to assume that the drives identified in the object graph as belonging to the volume group are valid.

Required/optional:
Returns:	The vg_drive_part_of_multiple_vgs of this FailureTypeEntry.
Return type:	PvgRecoveryData
	optional

vg_has_drive_part_of_multiple_vgs¶

Gets the vg_has_drive_part_of_multiple_vgs of this FailureTypeEntry. This field is present only if recFailureType is equal to REC_VG_HAS_DRIVE_PART_OF_MULTIPLE_VGS. It identifies the data that is pertinent to this recovery scenario. The drive field in this structure is a reference to the problem drive (the one having DriveStatusCause of DRIVE_CAUSE_INCOMPATIBLE_VG_HAS_DRIVE_PART_OF_MULTIPLE_VGS); the volumeGroup field is a reference to the foreign volume group. Also, it is safe to assume that the drives identified in the object graph as belonging to the foreign volume group are valid.

Required/optional:
Returns:	The vg_has_drive_part_of_multiple_vgs of this FailureTypeEntry.
Return type:	PvgRecoveryData
	optional

vol_degraded¶

Gets the vol_degraded of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_DEGRADED_VOLUME. It contains the identification of a volume group that has transitioned to the degraded state due to a drive failure.

Required/optional:
Returns:	The vol_degraded of this FailureTypeEntry.
Return type:	str
	optional

vol_fail¶

Gets the vol_fail of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_FAILED_VOLUME_INTERRUPTED_WRITE. It contains the identification of a volume group that has experienced an interrupted write failure.

Required/optional:
Returns:	The vol_fail of this FailureTypeEntry.
Return type:	str
	optional

vol_fail_awaiting_init¶

Gets the vol_fail_awaiting_init of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_VOLUME_AWAITING_INIT. It contains the identification of a volume group that was failed due to excessive drive failures, but has since had all failed drives replaced. Since the volumes within the volume group are no longer usable, they must all be formatted/initialized to make them usable again.

Required/optional:
Returns:	The vol_fail_awaiting_init of this FailureTypeEntry.
Return type:	str
	optional

vol_fail_during_modify¶

Gets the vol_fail_during_modify of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_FAILED_MODIFYING_VOLUME. It contains the identification of a volume group that has experienced a failure during a modification operation (i.e. dynamic capacity expansion, RAID migration, segment resizing, initialization, etc.).

Required/optional:
Returns:	The vol_fail_during_modify of this FailureTypeEntry.
Return type:	str
	optional

vol_fail_during_modify_multi_raid¶

Gets the vol_fail_during_modify_multi_raid of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_FAILED_MODIFYING_MULTI_RAID. It contains the identification of a volume group that has experienced a failure during a modification operation (i.e. dynamic capacity expansion, RAID migration, segment resizing, initialization, etc.). This failure indication applies specifically to volume groups containing volumes of different RAID levels. It is not supported in the current release of the firmware.

Required/optional:
Returns:	The vol_fail_during_modify_multi_raid of this FailureTypeEntry.
Return type:	str
	optional

vol_fail_interrupted_write¶

Gets the vol_fail_interrupted_write of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_FAILED_VOLUME_INTERRUPTED_WRITE. It contains the identification of a volume group that has experienced an interrupted write failure.

Required/optional:
Returns:	The vol_fail_interrupted_write of this FailureTypeEntry.
Return type:	str
	optional

vol_fail_multi_raid¶

Gets the vol_fail_multi_raid of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_FAILED_VOLUME_MULTI_RAID. It contains the identification of a volume group that has been marked failed due to an excessive number of drive failures. This failure indication applies specifically to volume groups containing volumes of different RAID levels. It is not supported in the current release of the firmware.

Required/optional:
Returns:	The vol_fail_multi_raid of this FailureTypeEntry.
Return type:	str
	optional

vol_group_offline¶

Gets the vol_group_offline of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_OFFLINE_VOLUME_GROUP. It contains the identification of a volume group that has been marked offline. This can occur due to either an explicit user request, or the physical insertion of drives from another storage array.

Required/optional:
Returns:	The vol_group_offline of this FailureTypeEntry.
Return type:	str
	optional

vol_group_waiting_on_hot_spare¶

Gets the vol_group_waiting_on_hot_spare of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_COPY_THEN_FAIL_WAITING_ON_HOT_SPARE: A copy then fail operation is waiting on the user to identify a suitable hot spare drive.

Required/optional:
Returns:	The vol_group_waiting_on_hot_spare of this FailureTypeEntry.
Return type:	str
	optional

vol_hot_spare_in_use¶

Gets the vol_hot_spare_in_use of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_VOLUME_HOT_SPARE_IN_USE. It contains the identification of a volume group that has experienced a drive failure, but has acquired a hot spare drive as a temporary replacement.

Required/optional:
Returns:	The vol_hot_spare_in_use of this FailureTypeEntry.
Return type:	str
	optional

vol_impaired¶

Gets the vol_impaired of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_IMPAIRED_VOLUME. It contains the identification of a volume that has been marked impaired due to the detection of an internal consistency problem.

Required/optional:
Returns:	The vol_impaired of this FailureTypeEntry.
Return type:	str
	optional

volcopy_feature¶

Gets the volcopy_feature of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_VOLCOPY_NOT_COMPLIANT. The volume copy feature is out of compliance.

Required/optional:
Returns:	The volcopy_feature of this FailureTypeEntry.
Return type:	FeatureState
	optional

volume_offline_during_reconfig¶

Gets the volume_offline_during_reconfig of this FailureTypeEntry. This field is present only if the value of RecoveryFailureType value is equal to REC_REDUNDANCY_GROUP_NOT_CONSISTENT_DURING_RECONFIG. It identifies a volume that has been taken offline due to the detection of an internal consistency problem. After the reconfiguration completes the data will be consistent, but may be corrupt.

Required/optional:
Returns:	The volume_offline_during_reconfig of this FailureTypeEntry.
Return type:	str
	optional

vpd_eeprom_corrupted¶

Gets the vpd_eeprom_corrupted of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_CORRUPT_VPD_EEPROM. It indicates a controller tray in which corruption of one of the redundant Storage Bridge Bay (SBB) EEPROMs has been detected.

Required/optional:
Returns:	The vpd_eeprom_corrupted of this FailureTypeEntry.
Return type:	str
	optional

vpd_i2c_failure¶

Gets the vpd_i2c_failure of this FailureTypeEntry. This field is present only if the RecoveryFailureType value is equal to REC_FAILED_I2C_BUS. It refers to a controller that has detected a failure of one of the I2C busses used to access the Storage Bridge Bay (SBB) vital product data stored in EEPROM. For a given I2C bus failure, the failure type list may contain an entry for one or both controllers.

Required/optional:
Returns:	The vpd_i2c_failure of this FailureTypeEntry.
Return type:	str
	optional

write_protected_cache_backup_device¶

Gets the write_protected_cache_backup_device of this FailureTypeEntry. This field is present if the recFailuretype is equal to REC_CACHE_BACKUP_DEVICE_WRITE_PROTECTED. It identifies a cache backup device that is write-protected.

Required/optional:
Returns:	The write_protected_cache_backup_device of this FailureTypeEntry.
Return type:	str
	optional

netapp.santricity.models.symbol.failure_type_list module¶

FailureTypeList.py

class netapp.santricity.models.symbol.failure_type_list.FailureTypeList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

failure_list¶

Gets the failure_list of this FailureTypeList. A variable-length array of FailureTypeEntry objects.

Required/optional:
Returns:	The failure_list of this FailureTypeList.
Return type:	list[FailureTypeEntry]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.fan module¶

Fan.py

class netapp.santricity.models.symbol.fan.Fan[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

fan_ref¶

Gets the fan_ref of this Fan. The reference for this physical fan.

Required/optional:
Returns:	The fan_ref of this Fan.
Return type:	str
	required

id¶

Gets the id of this Fan.

Required/optional:
Returns:	The id of this Fan.
Return type:	str
	optional

physical_location¶

Gets the physical_location of this Fan. The physical location of the fan. The parent reference in Location identifies the CRU that houses the fan, and the position field is a firmware-assigned 1-relative number signifying “1st fan relative to parent CRU,” 2nd fan relative to parent CRU.” etc.

Required/optional:
Returns:	The physical_location of this Fan.
Return type:	Location
	required

repair_policy¶

Gets the repair_policy of this Fan. The repair policy for the fan component.

Required/optional:
Returns:	The repair_policy of this Fan.
Return type:	RepairPolicy
	required

reserved1¶

Gets the reserved1 of this Fan.

Required/optional:
Returns:	The reserved1 of this Fan.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this Fan.

Required/optional:
Returns:	The reserved2 of this Fan.
Return type:	str
	optional

rtr_attributes¶

Gets the rtr_attributes of this Fan. The CRU type of the fan plus its ready-to-remove attributes, which are based on the CRU type.

Required/optional:
Returns:	The rtr_attributes of this Fan.
Return type:	RTRAttributes
	required

status¶

Gets the status of this Fan. The operational status of the fan

Required/optional:
Returns:	The status of this Fan.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.fdi_dems_log_retrieve_chunk_details module¶

FdiDemsLogRetrieveChunkDetails.py

class netapp.santricity.models.symbol.fdi_dems_log_retrieve_chunk_details.FdiDemsLogRetrieveChunkDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

fdi_dems_log_data¶

Gets the fdi_dems_log_data of this FdiDemsLogRetrieveChunkDetails. An array of opaque data will be returned.

Required/optional:
Returns:	The fdi_dems_log_data of this FdiDemsLogRetrieveChunkDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.fdi_dems_log_retrieve_start_details module¶

FdiDemsLogRetrieveStartDetails.py

class netapp.santricity.models.symbol.fdi_dems_log_retrieve_start_details.FdiDemsLogRetrieveStartDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

all_drives¶

Gets the all_drives of this FdiDemsLogRetrieveStartDetails. If true, log entries will be retrieved for all drives and the values in driveRefs will be ignored.

Required/optional:
Returns:	The all_drives of this FdiDemsLogRetrieveStartDetails.
Return type:	bool
	required

all_log_entries¶

Gets the all_log_entries of this FdiDemsLogRetrieveStartDetails. If true, all log entries will be retrieved and the value of oldestEntryTimestamp will be ignored.

Required/optional:
Returns:	The all_log_entries of this FdiDemsLogRetrieveStartDetails.
Return type:	bool
	required

drive_refs¶

Gets the drive_refs of this FdiDemsLogRetrieveStartDetails. If allDrives is false, log entries will be retrieved only for the drives in this list.

Required/optional:
Returns:	The drive_refs of this FdiDemsLogRetrieveStartDetails.
Return type:	DriveRefList
	required

oldest_entry_timestamp¶

Gets the oldest_entry_timestamp of this FdiDemsLogRetrieveStartDetails. If allLogEntries is false, log entries will be retrieved if their timestamp is equal to or more recent than this value (measured in seconds since midnight January 1, 1970).

Required/optional:
Returns:	The oldest_entry_timestamp of this FdiDemsLogRetrieveStartDetails.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.feature_attribute module¶

FeatureAttribute.py

class netapp.santricity.models.symbol.feature_attribute.FeatureAttribute[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

evaluation_duration¶

Gets the evaluation_duration of this FeatureAttribute. An unsigned integer representing the number of days for the “EVALUATION DURATION” attribute. This field is only present if featureAttrId is equal to FEATURE_ATTR_EVAL_DURATION.

Required/optional:
Returns:	The evaluation_duration of this FeatureAttribute.
Return type:	int
	optional

feature_attr_id¶

Gets the feature_attr_id of this FeatureAttribute. This enumeration identifies the defined feature attributes.

Required/optional:
Returns:	The feature_attr_id of this FeatureAttribute.
Return type:	str
	required

key_enabled¶

Gets the key_enabled of this FeatureAttribute. The boolean value for a “KEY ENABLED” attribute. This field is only present if featureAttrId is equal to FEATURE_ATTR_KEY_ENABLED.

Required/optional:
Returns:	The key_enabled of this FeatureAttribute.
Return type:	bool
	optional

key_limit¶

Gets the key_limit of this FeatureAttribute. The integer value for a “KEY LIMIT” attribute. This field is only present if featureAttrId is equal to FEAUTRE_ATTR_KEY_LIMIT.

Required/optional:
Returns:	The key_limit of this FeatureAttribute.
Return type:	int
	optional

shipped_enabled¶

Gets the shipped_enabled of this FeatureAttribute. The boolean value for a “SHIPPED ENABLED” attribute. This field is only present if featureAttrId is equal to FEATURE_ATTR_SHIPPED_ENABLED.

Required/optional:
Returns:	The shipped_enabled of this FeatureAttribute.
Return type:	bool
	optional

shipped_limit¶

Gets the shipped_limit of this FeatureAttribute. The integer value for a “SHIPPED LIMIT” attribute. This field is only present if featurAttrId is equal to FEATURE_ATTR_SHIPPED_LIMIT.

Required/optional:
Returns:	The shipped_limit of this FeatureAttribute.
Return type:	int
	optional

subject_to_gold_key¶

Gets the subject_to_gold_key of this FeatureAttribute. The boolean value for a “SUBJECT_TO_GOLD_KEY” attribute. This field is only present if featureAttrId is equal to FEATURE_ATTR_SUBJECT_TO_GOLD_KEY.

Required/optional:
Returns:	The subject_to_gold_key of this FeatureAttribute.
Return type:	bool
	optional

supported_values¶

Gets the supported_values of this FeatureAttribute. The set of string values for a “SUPPORTED VALUES” attribute. This field is only present if featureAttrId is equal to FEATURE_ATTR_SUPPORTED_VALUES.

Required/optional:
Returns:	The supported_values of this FeatureAttribute.
Return type:	list[str]
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.feature_bundle module¶

FeatureBundle.py

class netapp.santricity.models.symbol.feature_bundle.FeatureBundle[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

bundle_submodel_id¶

Gets the bundle_submodel_id of this FeatureBundle. The submodel Identifier associated with the feature bundle.

Required/optional:
Returns:	The bundle_submodel_id of this FeatureBundle.
Return type:	str
	required

bundled_features¶

Gets the bundled_features of this FeatureBundle. A variable-length collection of BundledFeature instances, one for every feature comprising the bundle.

Required/optional:
Returns:	The bundled_features of this FeatureBundle.
Return type:	list[BundledFeature]
	required

name¶

Gets the name of this FeatureBundle. The name of the feature bundle.

Required/optional:
Returns:	The name of this FeatureBundle.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.feature_key module¶

FeatureKey.py

class netapp.santricity.models.symbol.feature_key.FeatureKey[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

capability¶

Gets the capability of this FeatureKey. The capability code for the feature that is to be enabled by this key.

Required/optional:
Returns:	The capability of this FeatureKey.
Return type:	str
	required

digest¶

Gets the digest of this FeatureKey. A computed message digest that verifies the authenticity of this feature key.

Required/optional:
Returns:	The digest of this FeatureKey.
Return type:	str
	required

duration¶

Gets the duration of this FeatureKey. The duration before this feature is expired. An evaluation period is specified in days. A zero value for an evaluation period indicates a permanent license that has been purchased.

Required/optional:
Returns:	The duration of this FeatureKey.
Return type:	int
	required

key_id¶

Gets the key_id of this FeatureKey. For an additive license this will be the Key ID.

Required/optional:
Returns:	The key_id of this FeatureKey.
Return type:	str
	required

key_version¶

Gets the key_version of this FeatureKey. An internal indication of the version of the feature key.

Required/optional:
Returns:	The key_version of this FeatureKey.
Return type:	int
	required

limit¶

Gets the limit of this FeatureKey. The numeric limit for this specific feature. A zero value for a limit indicates a feature that is fully enabled and does not support tiers such as RAID 6.

Required/optional:
Returns:	The limit of this FeatureKey.
Return type:	int
	required

sa_id¶

Gets the sa_id of this FeatureKey. This field contains a unique identifier maintained by SAFE for use by storage management software. Storage management software uses this data to enable SAFE features and perform Feature Bundle migration.

Required/optional:
Returns:	The sa_id of this FeatureKey.
Return type:	SAIdentifier
	required

supported_feature_bundle_id¶

Gets the supported_feature_bundle_id of this FeatureKey. The supported Feature Bundle ID. When not in use this value will be zero.

Required/optional:
Returns:	The supported_feature_bundle_id of this FeatureKey.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.feature_params module¶

FeatureParams.py

class netapp.santricity.models.symbol.feature_params.FeatureParams[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

absolute_max_dss_segment_size¶

Gets the absolute_max_dss_segment_size of this FeatureParams. The global upper bound, expressed in bytes, on the new segment size that may be requested on the startVolumeSegmentSizing procedure.

Required/optional:
Returns:	The absolute_max_dss_segment_size of this FeatureParams.
Return type:	int
	required

battery_not_in_configuration¶

Gets the battery_not_in_configuration of this FeatureParams. The NVSRAM setting for optional controller battery.

Required/optional:
Returns:	The battery_not_in_configuration of this FeatureParams.
Return type:	bool
	required

cache_block_sizes¶

Gets the cache_block_sizes of this FeatureParams. A variable-length array in which each element specifies one of the supported cache block sizes that can be set on the controller. Cache block sizes are reported in bytes.

Required/optional:
Returns:	The cache_block_sizes of this FeatureParams.
Return type:	list[int]
	required

current_max_mirrors¶

Gets the current_max_mirrors of this FeatureParams. The maximum number of mirrored volumes allowed per array for existing repositories.

Required/optional:
Returns:	The current_max_mirrors of this FeatureParams.
Return type:	int
	required

default_media_scan_period¶

Gets the default_media_scan_period of this FeatureParams. The default media scan period stored in the controller’s NVSRAM. Units are days.

Required/optional:
Returns:	The default_media_scan_period of this FeatureParams.
Return type:	int
	required

mappable_lun_count¶

Gets the mappable_lun_count of this FeatureParams. The maximum number of LUN addresses that are available for volume mapping operations. The range of supported LUN values is thus 0 through mappableLUNCoun-1.

Required/optional:
Returns:	The mappable_lun_count of this FeatureParams.
Return type:	int
	required

max_concurrent_background_copys¶

Gets the max_concurrent_background_copys of this FeatureParams. The maximum number of background copies that can be active at any one time. This maximum number applies to the entire array, not just one controller.

Required/optional:
Returns:	The max_concurrent_background_copys of this FeatureParams.
Return type:	int
	required

max_dce_drives¶

Gets the max_dce_drives of this FeatureParams. The maximum number of drives that can be added, in a given operation, to an existing volume group to expand the capacity of the volume group.

Required/optional:
Returns:	The max_dce_drives of this FeatureParams.
Return type:	int
	required

max_drive_download_files¶

Gets the max_drive_download_files of this FeatureParams. The maximum number of drive download files permitted.

Required/optional:
Returns:	The max_drive_download_files of this FeatureParams.
Return type:	int
	required

max_drive_slots¶

Gets the max_drive_slots of this FeatureParams. The maximum number of drive slots supported on the array.

Required/optional:
Returns:	The max_drive_slots of this FeatureParams.
Return type:	int
	required

max_expansion_drive_trays¶

Gets the max_expansion_drive_trays of this FeatureParams. The maximum number of expansion drive trays allowed for this storage array.

Required/optional:
Returns:	The max_expansion_drive_trays of this FeatureParams.
Return type:	int
	required

max_flash_cache_size¶

Gets the max_flash_cache_size of this FeatureParams. The maximum flash cache repository size measured in bytes.

Required/optional:
Returns:	The max_flash_cache_size of this FeatureParams.
Return type:	int
	required

max_hot_spares¶

Gets the max_hot_spares of this FeatureParams. The maximum number of hot spare drives that can be assigned. If the value in this field is ‘0xFFFFFFFF’ it means there is no limit to the number of hot spares.

Required/optional:
Returns:	The max_hot_spares of this FeatureParams.
Return type:	int
	required

max_iscsi_ipv6_local_addresses_per_port¶

Gets the max_iscsi_ipv6_local_addresses_per_port of this FeatureParams. Max number of iSCSI IPV6 local addresses

Required/optional:
Returns:	The max_iscsi_ipv6_local_addresses_per_port of this FeatureParams.
Return type:	int
	required

max_iscsi_ipv6_routable_addresses_per_port¶

Gets the max_iscsi_ipv6_routable_addresses_per_port of this FeatureParams. Max number of iSCSI IPV6 routable addresses

Required/optional:
Returns:	The max_iscsi_ipv6_routable_addresses_per_port of this FeatureParams.
Return type:	int
	required

max_mappings_per_volume¶

Gets the max_mappings_per_volume of this FeatureParams. The number of mappings allowed per volume.

Required/optional:
Returns:	The max_mappings_per_volume of this FeatureParams.
Return type:	int
	required

max_media_scan_period¶

Gets the max_media_scan_period of this FeatureParams. The maximum supported period over which a complete media scan can be set to occur (measured in days).

Required/optional:
Returns:	The max_media_scan_period of this FeatureParams.
Return type:	int
	required

max_mgmt_client_record_size¶

Gets the max_mgmt_client_record_size of this FeatureParams. The maximum record size of a client data record.

Required/optional:
Returns:	The max_mgmt_client_record_size of this FeatureParams.
Return type:	int
	required

max_mgmt_client_records¶

Gets the max_mgmt_client_records of this FeatureParams. The maximum number of records allowed in the client data storage area.

Required/optional:
Returns:	The max_mgmt_client_records of this FeatureParams.
Return type:	int
	required

max_mirrors¶

Gets the max_mirrors of this FeatureParams. The maximum number of mirrored volumes allowed per array assuming full size repositories.

Required/optional:
Returns:	The max_mirrors of this FeatureParams.
Return type:	int
	required

max_partition_count¶

Gets the max_partition_count of this FeatureParams. The number of partitions supported by the controller.

Required/optional:
Returns:	The max_partition_count of this FeatureParams.
Return type:	int
	required

max_read_ahead_multiplier¶

Gets the max_read_ahead_multiplier of this FeatureParams. The maximum multiplier value that can be specified when configuring cache the read-ahead parameter for a volume. (Realize, however, that the volume read-ahead parameter is no longer treated as a quantify, but as a simple on (non-zero) / off (zero) indicator.

Required/optional:
Returns:	The max_read_ahead_multiplier of this FeatureParams.
Return type:	int
	required

max_snapshots¶

Gets the max_snapshots of this FeatureParams. The maximum number of snapshot volumes allowed per array.

Required/optional:
Returns:	The max_snapshots of this FeatureParams.
Return type:	int
	required

max_snapshots_per_base¶

Gets the max_snapshots_per_base of this FeatureParams. The maximum number of snapshots allowed on any given base volume.

Required/optional:
Returns:	The max_snapshots_per_base of this FeatureParams.
Return type:	int
	required

max_ss_ds_supported¶

Gets the max_ss_ds_supported of this FeatureParams. The maximum number of SSDs supported on the array. If SSDs are not supported this value is 0.

Required/optional:
Returns:	The max_ss_ds_supported of this FeatureParams.
Return type:	int
	required

max_utm_lun_value¶

Gets the max_utm_lun_value of this FeatureParams. The maximum value a UTM LUN can be set to.

Required/optional:
Returns:	The max_utm_lun_value of this FeatureParams.
Return type:	int
	required

max_vol_copys¶

Gets the max_vol_copys of this FeatureParams. The maximum number of volume copies allowed per array.

Required/optional:
Returns:	The max_vol_copys of this FeatureParams.
Return type:	int
	required

max_volumes¶

Gets the max_volumes of this FeatureParams. The maximum number of standard volumes allowed per array.

Required/optional:
Returns:	The max_volumes of this FeatureParams.
Return type:	int
	required

max_volumes_per_group¶

Gets the max_volumes_per_group of this FeatureParams. The maximum number of volumes allowed per volume group.

Required/optional:
Returns:	The max_volumes_per_group of this FeatureParams.
Return type:	int
	required

min_media_scan_period¶

Gets the min_media_scan_period of this FeatureParams. The minimum supported period over which a complete media scan can be set to occur (measured in days).

Required/optional:
Returns:	The min_media_scan_period of this FeatureParams.
Return type:	int
	required

min_repository_size¶

Gets the min_repository_size of this FeatureParams. The minimum size of a repository volume in bytes.

Required/optional:
Returns:	The min_repository_size of this FeatureParams.
Return type:	int
	required

num_standard_seg_sizes¶

Gets the num_standard_seg_sizes of this FeatureParams. The number of standard segment size values (at beginning of list).

Required/optional:
Returns:	The num_standard_seg_sizes of this FeatureParams.
Return type:	int
	required

redundancy_mode¶

Gets the redundancy_mode of this FeatureParams. Indicates whether the system is Simplex or Duplex.

Required/optional:
Returns:	The redundancy_mode of this FeatureParams.
Return type:	str
	required

reserved1¶

Gets the reserved1 of this FeatureParams.

Required/optional:
Returns:	The reserved1 of this FeatureParams.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this FeatureParams.

Required/optional:
Returns:	The reserved2 of this FeatureParams.
Return type:	str
	optional

seg_transitions¶

Gets the seg_transitions of this FeatureParams. A variable-length array in which each element specifies one of the supported segment size transition options. The user of the SYMbol interface should consult this list to determine a valid new segment size for a volume before attempting to use the startVolumeSegmentSizing procedure.

Required/optional:
Returns:	The seg_transitions of this FeatureParams.
Return type:	list[str]
	required

smart_battery_technology¶

Gets the smart_battery_technology of this FeatureParams. This field is set to true if the storage array uses smart battery technology, and false otherwise.

Required/optional:
Returns:	The smart_battery_technology of this FeatureParams.
Return type:	bool
	required

ssd_interface_type_mixing_supported¶

Gets the ssd_interface_type_mixing_supported of this FeatureParams. True if different SSD interface types (e.g. Fibre Channel, SAS) can be used in the same volume group.

Required/optional:
Returns:	The ssd_interface_type_mixing_supported of this FeatureParams.
Return type:	bool
	required

supported_auth_methods¶

Gets the supported_auth_methods of this FeatureParams. The iSCSI authentication methods supported by the storage array.

Required/optional:
Returns:	The supported_auth_methods of this FeatureParams.
Return type:	list[str]
	required

supported_drive_types¶

Gets the supported_drive_types of this FeatureParams. A list of supported drive types.

Required/optional:
Returns:	The supported_drive_types of this FeatureParams.
Return type:	list[str]
	required

supported_event_priorities¶

Gets the supported_event_priorities of this FeatureParams. An array listing the MEL event priorities that are configured for use in the current controller firmware build.

Required/optional:
Returns:	The supported_event_priorities of this FeatureParams.
Return type:	list[str]
	required

supported_protection_types¶

Gets the supported_protection_types of this FeatureParams. The protection types supported by the storage array.

Required/optional:
Returns:	The supported_protection_types of this FeatureParams.
Return type:	list[str]
	required

supported_seg_sizes¶

Gets the supported_seg_sizes of this FeatureParams. A variable-length array in which each element specifies one of the supported segment size values, in bytes. This array should be consulted prior to attempting to create a volume modify a volume’s segment size via the startVolumeSegmentSizing procedure.

Required/optional:
Returns:	The supported_seg_sizes of this FeatureParams.
Return type:	list[int]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

write_caching_enabled_during_learn_cycle¶

Gets the write_caching_enabled_during_learn_cycle of this FeatureParams. This field, which is only applicable if smartBatteryTechnology is true, is set to true if the charge level on a smart battery unit is expected to remain above the minimum level needed to support write caching.

Required/optional:
Returns:	The write_caching_enabled_during_learn_cycle of this FeatureParams.
Return type:	bool
	required

netapp.santricity.models.symbol.feature_state module¶

FeatureState.py

class netapp.santricity.models.symbol.feature_state.FeatureState[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

capability¶

Gets the capability of this FeatureState. This field will contain the value of the premium feature being described.

Required/optional:
Returns:	The capability of this FeatureState.
Return type:	str
	required

duration¶

Gets the duration of this FeatureState. Describes the timeframe this feature will be available. A zero value describes an infinite duration. The unit of duration is in days.

Required/optional:
Returns:	The duration of this FeatureState.
Return type:	int
	required

enabled_time¶

Gets the enabled_time of this FeatureState. Describes the time when this feature was enabled.

Required/optional:
Returns:	The enabled_time of this FeatureState.
Return type:	int
	required

feature_id¶

Gets the feature_id of this FeatureState. This field contains the value of the feature ID associated with the feature.

Required/optional:
Returns:	The feature_id of this FeatureState.
Return type:	str
	required

feature_ref¶

Gets the feature_ref of this FeatureState. This field contains a reference to the feature.

Required/optional:
Returns:	The feature_ref of this FeatureState.
Return type:	str
	required

is_compliant¶

Gets the is_compliant of this FeatureState. A true value in this field indicates that the feature has been purchased (in compliance). A false value indicates that the feature has not been purchased. The user will receive warning messages indicating that they are not in compliance. The warning message will continue until the feature is purchased or the feature is disabled.

Required/optional:
Returns:	The is_compliant of this FeatureState.
Return type:	bool
	required

is_enabled¶

Gets the is_enabled of this FeatureState. A true value in this field indicates that the feature is enabled (regardless of compliance)

Required/optional:
Returns:	The is_enabled of this FeatureState.
Return type:	bool
	required

is_within_limits¶

Gets the is_within_limits of this FeatureState. This field is deprecated. Use isCompliant field instead.

Required/optional:
Returns:	The is_within_limits of this FeatureState.
Return type:	bool
	required

limit¶

Gets the limit of this FeatureState. A numerical description associated with this FeatureState object, describing the level or tier for this feature. A zero value represents a feature that does not support tiering. Non-zero implies a tiering level.

Required/optional:
Returns:	The limit of this FeatureState.
Return type:	int
	required

permanent_license_applied¶

Gets the permanent_license_applied of this FeatureState. TRUE if a permanent license for this feature has been applied. FALSE if the feature is being evaluated or is not enabled at all.

Required/optional:
Returns:	The permanent_license_applied of this FeatureState.
Return type:	bool
	required

supported_feature_bundle_id¶

Gets the supported_feature_bundle_id of this FeatureState. The supported Feature Bundle ID. When not in use this value will be zero.

Required/optional:
Returns:	The supported_feature_bundle_id of this FeatureState.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.fibre_channel_target_location module¶

FibreChannelTargetLocation.py

class netapp.santricity.models.symbol.fibre_channel_target_location.FibreChannelTargetLocation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

target_name¶

Gets the target_name of this FibreChannelTargetLocation. The Fibre Channel node name of the target,a binary 8-byte SCSI name.

Required/optional:
Returns:	The target_name of this FibreChannelTargetLocation.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.fibre_drive_address module¶

FibreDriveAddress.py

class netapp.santricity.models.symbol.fibre_drive_address.FibreDriveAddress[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this FibreDriveAddress. The controller drive-side channel number used to access the drive via this interface.

Required/optional:
Returns:	The channel of this FibreDriveAddress.
Return type:	int
	required

loop_id¶

Gets the loop_id of this FibreDriveAddress. The drive’s Fibre Channel loop ID value on the given channel.

Required/optional:
Returns:	The loop_id of this FibreDriveAddress.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.fibre_esm_address module¶

FibreESMAddress.py

class netapp.santricity.models.symbol.fibre_esm_address.FibreESMAddress[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

esm_port_ref¶

Gets the esm_port_ref of this FibreESMAddress. The esmPortRef identifies the drive port.

Required/optional:
Returns:	The esm_port_ref of this FibreESMAddress.
Return type:	str
	required

loop_id¶

Gets the loop_id of this FibreESMAddress. The loop ID of the ESM.

Required/optional:
Returns:	The loop_id of this FibreESMAddress.
Return type:	int
	required

port_ref¶

Gets the port_ref of this FibreESMAddress. A reference to the controller drive side channel port associated with this ESM.

Required/optional:
Returns:	The port_ref of this FibreESMAddress.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.fibre_esm_attributes module¶

FibreEsmAttributes.py

class netapp.santricity.models.symbol.fibre_esm_attributes.FibreEsmAttributes[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

fibre_esm_address¶

Gets the fibre_esm_address of this FibreEsmAttributes. Addressing information for the fibre channel ESM.

Required/optional:
Returns:	The fibre_esm_address of this FibreEsmAttributes.
Return type:	FibreESMAddress
	required

is_switched¶

Gets the is_switched of this FibreEsmAttributes. True if the fibre channel components use switched technology.

Required/optional:
Returns:	The is_switched of this FibreEsmAttributes.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.fibre_interface module¶

FibreInterface.py

class netapp.santricity.models.symbol.fibre_interface.FibreInterface[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

bidirectional_max_rate¶

Gets the bidirectional_max_rate of this FibreInterface. Maximum bi-directional data rate in B/s

Required/optional:
Returns:	The bidirectional_max_rate of this FibreInterface.
Return type:	int
	required

chan_miswire¶

Gets the chan_miswire of this FibreInterface. True, if this channel is joined with another one.

Required/optional:
Returns:	The chan_miswire of this FibreInterface.
Return type:	bool
	required

channel¶

Gets the channel of this FibreInterface. The channel number of this interface.

Required/optional:
Returns:	The channel of this FibreInterface.
Return type:	int
	required

channel_ports¶

Gets the channel_ports of this FibreInterface. Channel port speed information. This field is deprecated. The same information is available in the LinkSpeedDetectionError structure.

Required/optional:
Returns:	The channel_ports of this FibreInterface.
Return type:	list[ChannelPorts]
	required

current_interface_speed¶

Gets the current_interface_speed of this FibreInterface. The current interface speed of the Fibre Channel interface.

Required/optional:
Returns:	The current_interface_speed of this FibreInterface.
Return type:	str
	required

dds_channel_state¶

Gets the dds_channel_state of this FibreInterface. The DDS state of this drive side channel: optimal, degraded, or failed.

Required/optional:
Returns:	The dds_channel_state of this FibreInterface.
Return type:	int
	required

dds_state_reason¶

Gets the dds_state_reason of this FibreInterface. DDS state reason.

Required/optional:
Returns:	The dds_state_reason of this FibreInterface.
Return type:	int
	required

dds_state_who¶

Gets the dds_state_who of this FibreInterface. Which controller placed the drive side channel in this DDS state.

Required/optional:
Returns:	The dds_state_who of this FibreInterface.
Return type:	int
	required

esm_miswire¶

Gets the esm_miswire of this FibreInterface. True, if an ESM miswire condition exists somewhere on this channel.

Required/optional:
Returns:	The esm_miswire of this FibreInterface.
Return type:	bool
	required

hard_address¶

Gets the hard_address of this FibreInterface. The hard (preferred) address of the interface, in loop ID format.

Required/optional:
Returns:	The hard_address of this FibreInterface.
Return type:	int
	required

id¶

Gets the id of this FibreInterface.

Required/optional:
Returns:	The id of this FibreInterface.
Return type:	str
	optional

interface_ref¶

Gets the interface_ref of this FibreInterface. The unique identifier for a given instance of this structure.

Required/optional:
Returns:	The interface_ref of this FibreInterface.
Return type:	str
	required

is_degraded¶

Gets the is_degraded of this FibreInterface. True if the channel associated with this interface is degraded.

Required/optional:
Returns:	The is_degraded of this FibreInterface.
Return type:	bool
	required

is_local¶

Gets the is_local of this FibreInterface. Set to True if there are channel ports physically attached to this controller.

Required/optional:
Returns:	The is_local of this FibreInterface.
Return type:	bool
	required

is_trunk_capable¶

Gets the is_trunk_capable of this FibreInterface. This field is true if the Fibre interface on the controller board is trunk capable. This field is always false for host-side interfaces.

Required/optional:
Returns:	The is_trunk_capable of this FibreInterface.
Return type:	bool
	required

link_status¶

Gets the link_status of this FibreInterface. The status of the fibre channel link for this interface.

Required/optional:
Returns:	The link_status of this FibreInterface.
Return type:	str
	required

loop_id¶

Gets the loop_id of this FibreInterface. The FC loop ID value used by the controller on this channel.

Required/optional:
Returns:	The loop_id of this FibreInterface.
Return type:	int
	required

max_speed¶

Gets the max_speed of this FibreInterface. The maximum speed in MB/s the interface can run. This field is deprecated. The field maximumInterfaceSpeed should be used instead.

Required/optional:
Returns:	The max_speed of this FibreInterface.
Return type:	int
	required

maximum_interface_speed¶

Gets the maximum_interface_speed of this FibreInterface. The maximum interface speed of the Fibre Channel interface.

Required/optional:
Returns:	The maximum_interface_speed of this FibreInterface.
Return type:	str
	required

node_name¶

Gets the node_name of this FibreInterface. The unique identifier of the storage array node associated with this interface.

Required/optional:
Returns:	The node_name of this FibreInterface.
Return type:	str
	required

one_way_max_rate¶

Gets the one_way_max_rate of this FibreInterface. Maximum one way data rate in B/s

Required/optional:
Returns:	The one_way_max_rate of this FibreInterface.
Return type:	int
	required

part¶

Gets the part of this FibreInterface. An ASCII text string that describes the Fibre Channel controller chip type.

Required/optional:
Returns:	The part of this FibreInterface.
Return type:	str
	required

physical_location¶

Gets the physical_location of this FibreInterface. The physical location of the Fibre Channel interface. The parent reference in location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying “1st Fibre Channel interface relative to the parent,” “2nd Fibre Channel interface relative to the parent,” etc. This “interface number” is independent of the interface’s channel association.

Required/optional:
Returns:	The physical_location of this FibreInterface.
Return type:	Location
	required

port_id¶

Gets the port_id of this FibreInterface. The NL_Port identifier assigned to this interface.

Required/optional:
Returns:	The port_id of this FibreInterface.
Return type:	str
	required

port_name¶

Gets the port_name of this FibreInterface. The unique identifier of the Fibre Channel port associated with this interface.

Required/optional:
Returns:	The port_name of this FibreInterface.
Return type:	str
	required

protection_information_capable¶

Gets the protection_information_capable of this FibreInterface.

Required/optional:
Returns:	The protection_information_capable of this FibreInterface.
Return type:	bool
	required

reserved1¶

Gets the reserved1 of this FibreInterface.

Required/optional:
Returns:	The reserved1 of this FibreInterface.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this FibreInterface.

Required/optional:
Returns:	The reserved2 of this FibreInterface.
Return type:	str
	optional

revision¶

Gets the revision of this FibreInterface. The revision level of the Fibre Channel controller chip.

Required/optional:
Returns:	The revision of this FibreInterface.
Return type:	int
	required

speed¶

Gets the speed of this FibreInterface. The speed of the interface in MB/sec. This field is deprecated. The field currentInterfaceSpeed should be used instead.

Required/optional:
Returns:	The speed of this FibreInterface.
Return type:	int
	required

speed_control¶

Gets the speed_control of this FibreInterface. The speed of the interface in MB per sec. This field is deprecated. The fieldcurrentInterfaceSpeed should be used instead.

Required/optional:
Returns:	The speed_control of this FibreInterface.
Return type:	str
	required

speed_neg_error¶

Gets the speed_neg_error of this FibreInterface. True if speed negotiation could not complete.

Required/optional:
Returns:	The speed_neg_error of this FibreInterface.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

topology¶

Gets the topology of this FibreInterface. The Fibre Channel topology type being used.

Required/optional:
Returns:	The topology of this FibreInterface.
Return type:	str
	required

trunk_miswire¶

Gets the trunk_miswire of this FibreInterface. True only when ESM is trunk capable and cabled incorrectly, or not trunk capable but connected in trunk mode.

Required/optional:
Returns:	The trunk_miswire of this FibreInterface.
Return type:	bool
	required

netapp.santricity.models.symbol.fibre_port_login module¶

FibrePortLogin.py

class netapp.santricity.models.symbol.fibre_port_login.FibrePortLogin[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

switch_port_id¶

Gets the switch_port_id of this FibrePortLogin. The switch port ID.

Required/optional:
Returns:	The switch_port_id of this FibrePortLogin.
Return type:	str
	required

target_port_name¶

Gets the target_port_name of this FibrePortLogin. The target port name.

Required/optional:
Returns:	The target_port_name of this FibrePortLogin.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.fibre_remote_target_connections module¶

FibreRemoteTargetConnections.py

class netapp.santricity.models.symbol.fibre_remote_target_connections.FibreRemoteTargetConnections[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

associated_switch_ports¶

Gets the associated_switch_ports of this FibreRemoteTargetConnections. Associated (visible) switch ports.

Required/optional:
Returns:	The associated_switch_ports of this FibreRemoteTargetConnections.
Return type:	list[str]
	required

connected_remote_target_ports¶

Gets the connected_remote_target_ports of this FibreRemoteTargetConnections. Connected remote target ports.

Required/optional:
Returns:	The connected_remote_target_ports of this FibreRemoteTargetConnections.
Return type:	list[FibrePortLogin]
	required

remote_node_wwn¶

Gets the remote_node_wwn of this FibreRemoteTargetConnections. Remote node name.

Required/optional:
Returns:	The remote_node_wwn of this FibreRemoteTargetConnections.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.fibre_trunk_miswire module¶

FibreTrunkMiswire.py

class netapp.santricity.models.symbol.fibre_trunk_miswire.FibreTrunkMiswire[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

connected_ports¶

Gets the connected_ports of this FibreTrunkMiswire. Identifies the channel ports currently cabled together that lead to an unsupported trunk connection.

Required/optional:
Returns:	The connected_ports of this FibreTrunkMiswire.
Return type:	list[ChannelPortPair]
	required

required_ports¶

Gets the required_ports of this FibreTrunkMiswire. Identifies the channel ports that should be cabled together in order to establish a supported trunk connection.

Required/optional:
Returns:	The required_ports of this FibreTrunkMiswire.
Return type:	list[ChannelPortPair]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.firmware_update_descriptor module¶

FirmwareUpdateDescriptor.py

class netapp.santricity.models.symbol.firmware_update_descriptor.FirmwareUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

firmware_chunk_image¶

Gets the firmware_chunk_image of this FirmwareUpdateDescriptor. A raw byte array that contains a segment, or chunk, of the firmware (or NVSRAM) image being downloaded to a controller. For firmware downloads, iterative operations are supported, where the overall firmware image can be iteratively transferred to the controller in multiple chunks. For NVSRAM downloads, however, the entire NVSRAM image must be provided in one call.

Required/optional:
Returns:	The firmware_chunk_image of this FirmwareUpdateDescriptor.
Return type:	str
	required

firmware_version¶

Gets the firmware_version of this FirmwareUpdateDescriptor. An ASCII character string that identifies the version of the firmware or NVSRAM being downloaded.

Required/optional:
Returns:	The firmware_version of this FirmwareUpdateDescriptor.
Return type:	str
	required

number_of_files¶

Gets the number_of_files of this FirmwareUpdateDescriptor. The number of files in this download stream.

Required/optional:
Returns:	The number_of_files of this FirmwareUpdateDescriptor.
Return type:	int
	required

offset¶

Gets the offset of this FirmwareUpdateDescriptor. The offset of this chunk from the beginning of the overall image.

Required/optional:
Returns:	The offset of this FirmwareUpdateDescriptor.
Return type:	int
	required

size_of_stream¶

Gets the size_of_stream of this FirmwareUpdateDescriptor. Total size (in bytes) of all files being downloaded in this download stream.

Required/optional:
Returns:	The size_of_stream of this FirmwareUpdateDescriptor.
Return type:	int
	required

staged_download¶

Gets the staged_download of this FirmwareUpdateDescriptor. If false, activate firmware after download. If true, stage firmware for later activation.

Required/optional:
Returns:	The staged_download of this FirmwareUpdateDescriptor.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

total_size¶

Gets the total_size of this FirmwareUpdateDescriptor. The total size of the overall firmware image.

Required/optional:
Returns:	The total_size of this FirmwareUpdateDescriptor.
Return type:	int
	required

netapp.santricity.models.symbol.flash_cache module¶

FlashCache.py

class netapp.santricity.models.symbol.flash_cache.FlashCache[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

fc_drive_info¶

Gets the fc_drive_info of this FlashCache. Drive information for the flash cache.

Required/optional:
Returns:	The fc_drive_info of this FlashCache.
Return type:	FlashCacheDriveInfo
	required

flash_cache_base¶

Gets the flash_cache_base of this FlashCache. Contains the base-level Flash Cache attributes pertaining to all types of Flash Caches.

Required/optional:
Returns:	The flash_cache_base of this FlashCache.
Return type:	FlashCacheBase
	required

flash_cache_ref¶

Gets the flash_cache_ref of this FlashCache. A reference to the high level flash cache volume.

Required/optional:
Returns:	The flash_cache_ref of this FlashCache.
Return type:	str
	required

id¶

Gets the id of this FlashCache.

Required/optional:
Returns:	The id of this FlashCache.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

wwn¶

Gets the wwn of this FlashCache. The WWN of the high level flash cache volume.

Required/optional:
Returns:	The wwn of this FlashCache.
Return type:	str
	required

netapp.santricity.models.symbol.flash_cache_analytics_creation_descriptor module¶

FlashCacheAnalyticsCreationDescriptor.py

class netapp.santricity.models.symbol.flash_cache_analytics_creation_descriptor.FlashCacheAnalyticsCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

flash_cache_label¶

Gets the flash_cache_label of this FlashCacheAnalyticsCreationDescriptor. The label to be assigned to the flash cache.

Required/optional:
Returns:	The flash_cache_label of this FlashCacheAnalyticsCreationDescriptor.
Return type:	str
	required

flash_cache_type¶

Gets the flash_cache_type of this FlashCacheAnalyticsCreationDescriptor. The type of flash cache to create (read only or write cache).

Required/optional:
Returns:	The flash_cache_type of this FlashCacheAnalyticsCreationDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.flash_cache_analytics_data module¶

FlashCacheAnalyticsData.py

class netapp.santricity.models.symbol.flash_cache_analytics_data.FlashCacheAnalyticsData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

analytics¶

Gets the analytics of this FlashCacheAnalyticsData. A list of analytics items containing data for various sizes of flash cache.

Required/optional:
Returns:	The analytics of this FlashCacheAnalyticsData.
Return type:	list[FlashCacheAnalyticsItem]
	required

real_cache_analytics¶

Gets the real_cache_analytics of this FlashCacheAnalyticsData. Real statistics for the current cache size.

Required/optional:
Returns:	The real_cache_analytics of this FlashCacheAnalyticsData.
Return type:	FlashCacheAnalyticsItem
	required

start_time¶

Gets the start_time of this FlashCacheAnalyticsData. The time analytics started being collected in seconds since January 1, 1970.

Required/optional:
Returns:	The start_time of this FlashCacheAnalyticsData.
Return type:	int
	required

stop_time¶

Gets the stop_time of this FlashCacheAnalyticsData. The time analytics stopped being collected in seconds since January 1, 1970.

Required/optional:
Returns:	The stop_time of this FlashCacheAnalyticsData.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.flash_cache_analytics_item module¶

FlashCacheAnalyticsItem.py

class netapp.santricity.models.symbol.flash_cache_analytics_item.FlashCacheAnalyticsItem[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cache_hit_pct¶

Gets the cache_hit_pct of this FlashCacheAnalyticsItem. The flash cache hit percentage times 100. This is calculated using totalFlashCacheReads/(totalBaseWrites + totalBaseReads + totalFlashCacheReads).

Required/optional:
Returns:	The cache_hit_pct of this FlashCacheAnalyticsItem.
Return type:	int
	required

cache_size¶

Gets the cache_size of this FlashCacheAnalyticsItem. The cache size in Gigabytes.

Required/optional:
Returns:	The cache_size of this FlashCacheAnalyticsItem.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

total_base_read_latency¶

Gets the total_base_read_latency of this FlashCacheAnalyticsItem. Read latency associated with HDD or DRAM access (in micro-seconds) for the volume(s) enabled for flash cache.

Required/optional:
Returns:	The total_base_read_latency of this FlashCacheAnalyticsItem.
Return type:	int
	required

total_base_reads¶

Gets the total_base_reads of this FlashCacheAnalyticsItem. Host reads sent to volume(s) enabled for flash cache and serviced from either HDD or Primary Cache.

Required/optional:
Returns:	The total_base_reads of this FlashCacheAnalyticsItem.
Return type:	int
	required

total_base_write_latency¶

Gets the total_base_write_latency of this FlashCacheAnalyticsItem. Write latency associated with HDD or DRAM access (in micro-seconds) for the volume(s) enabled for flash cache.

Required/optional:
Returns:	The total_base_write_latency of this FlashCacheAnalyticsItem.
Return type:	int
	required

total_base_writes¶

Gets the total_base_writes of this FlashCacheAnalyticsItem. Host writes sent to volume(s) enabled for flash cache and serviced from either HDD or Primary Cache.

Required/optional:
Returns:	The total_base_writes of this FlashCacheAnalyticsItem.
Return type:	int
	required

total_flash_cache_read_latency¶

Gets the total_flash_cache_read_latency of this FlashCacheAnalyticsItem. Read latency associated with flash cache access (in micro-seconds) for the volume(s) enabled for flash cache.

Required/optional:
Returns:	The total_flash_cache_read_latency of this FlashCacheAnalyticsItem.
Return type:	int
	required

total_flash_cache_reads¶

Gets the total_flash_cache_reads of this FlashCacheAnalyticsItem. Host reads sent to volume(s) enabled for flash cache and serviced from flash cache (SSD or Primary Cache).

Required/optional:
Returns:	The total_flash_cache_reads of this FlashCacheAnalyticsItem.
Return type:	int
	required

netapp.santricity.models.symbol.flash_cache_analytics_returned module¶

FlashCacheAnalyticsReturned.py

class netapp.santricity.models.symbol.flash_cache_analytics_returned.FlashCacheAnalyticsReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

analytics_data¶

Gets the analytics_data of this FlashCacheAnalyticsReturned. Analytics data is returned here only if the ReturnCode equals RETCODE_OK.

Required/optional:
Returns:	The analytics_data of this FlashCacheAnalyticsReturned.
Return type:	FlashCacheAnalyticsData
	optional

return_code¶

Gets the return_code of this FlashCacheAnalyticsReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this FlashCacheAnalyticsReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.flash_cache_base module¶

FlashCacheBase.py

class netapp.santricity.models.symbol.flash_cache_base.FlashCacheBase[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

analytics_cause¶

Gets the analytics_cause of this FlashCacheBase. The flash cache analytics status cause.

Required/optional:
Returns:	The analytics_cause of this FlashCacheBase.
Return type:	str
	required

analytics_status¶

Gets the analytics_status of this FlashCacheBase. The flash cache analytics status.

Required/optional:
Returns:	The analytics_status of this FlashCacheBase.
Return type:	str
	required

config_type¶

Gets the config_type of this FlashCacheBase. The flash cache configuration type.

Required/optional:
Returns:	The config_type of this FlashCacheBase.
Return type:	str
	required

label¶

Gets the label of this FlashCacheBase. The user-assigned label of the flash cache.

Required/optional:
Returns:	The label of this FlashCacheBase.
Return type:	str
	required

status¶

Gets the status of this FlashCacheBase. The status of the flash cache.

Required/optional:
Returns:	The status of this FlashCacheBase.
Return type:	str
	required

status_cause¶

Gets the status_cause of this FlashCacheBase. The flash cache status cause.

Required/optional:
Returns:	The status_cause of this FlashCacheBase.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.flash_cache_bundle module¶

FlashCacheBundle.py

class netapp.santricity.models.symbol.flash_cache_bundle.FlashCacheBundle[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

flash_cache¶

Gets the flash_cache of this FlashCacheBundle. A list of flash cache objects.

Required/optional:
Returns:	The flash_cache of this FlashCacheBundle.
Return type:	list[FlashCache]
	required

flash_cache_map¶

Gets the flash_cache_map of this FlashCacheBundle. A list of structures that map between the cached volumes and their associated flash cache.

Required/optional:
Returns:	The flash_cache_map of this FlashCacheBundle.
Return type:	list[FlashCacheMap]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.flash_cache_creation_descriptor module¶

FlashCacheCreationDescriptor.py

class netapp.santricity.models.symbol.flash_cache_creation_descriptor.FlashCacheCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

candidate¶

Gets the candidate of this FlashCacheCreationDescriptor. The volume candidate object to be used for creation of the flash cache.

Required/optional:
Returns:	The candidate of this FlashCacheCreationDescriptor.
Return type:	VolumeCandidate
	required

enable_existing¶

Gets the enable_existing of this FlashCacheCreationDescriptor. If true, all user mapped volumes will have flash cache enabled.

Required/optional:
Returns:	The enable_existing of this FlashCacheCreationDescriptor.
Return type:	bool
	required

flash_cache_label¶

Gets the flash_cache_label of this FlashCacheCreationDescriptor. The label to be assigned to the flash cache.

Required/optional:
Returns:	The flash_cache_label of this FlashCacheCreationDescriptor.
Return type:	str
	required

flash_cache_type¶

Gets the flash_cache_type of this FlashCacheCreationDescriptor. This field identifies the flash cache as either a read only or write cache.

Required/optional:
Returns:	The flash_cache_type of this FlashCacheCreationDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.flash_cache_drive_info module¶

FlashCacheDriveInfo.py

class netapp.santricity.models.symbol.flash_cache_drive_info.FlashCacheDriveInfo[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

fc_with_drives¶

Gets the fc_with_drives of this FlashCacheDriveInfo. Test results are returned if the flashCacheType does not equal FC_TYPE_VIRTUAL.

Required/optional:
Returns:	The fc_with_drives of this FlashCacheDriveInfo.
Return type:	FlashCacheWithDrives
	optional

flash_cache_type¶

Gets the flash_cache_type of this FlashCacheDriveInfo. This enumeration identifies the type of flash cache.

Required/optional:
Returns:	The flash_cache_type of this FlashCacheDriveInfo.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.flash_cache_map module¶

FlashCacheMap.py

class netapp.santricity.models.symbol.flash_cache_map.FlashCacheMap[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cached_volume¶

Gets the cached_volume of this FlashCacheMap. A reference to the cached volume.

Required/optional:
Returns:	The cached_volume of this FlashCacheMap.
Return type:	str
	required

flash_cache¶

Gets the flash_cache of this FlashCacheMap. A reference to the associated flash cache.

Required/optional:
Returns:	The flash_cache of this FlashCacheMap.
Return type:	str
	required

flash_cache_map_ref¶

Gets the flash_cache_map_ref of this FlashCacheMap. A unique identifier for the map entry.

Required/optional:
Returns:	The flash_cache_map_ref of this FlashCacheMap.
Return type:	str
	required

id¶

Gets the id of this FlashCacheMap.

Required/optional:
Returns:	The id of this FlashCacheMap.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.flash_cache_params_update_descriptor module¶

FlashCacheParamsUpdateDescriptor.py

class netapp.santricity.models.symbol.flash_cache_params_update_descriptor.FlashCacheParamsUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

config_type¶

Gets the config_type of this FlashCacheParamsUpdateDescriptor. The flash cache configuration type. This identifies how the flash cache is to be used.

Required/optional:
Returns:	The config_type of this FlashCacheParamsUpdateDescriptor.
Return type:	str
	required

flash_cache_ref¶

Gets the flash_cache_ref of this FlashCacheParamsUpdateDescriptor. The flash cache to which the parameters should be applied.

Required/optional:
Returns:	The flash_cache_ref of this FlashCacheParamsUpdateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

user_label¶

Gets the user_label of this FlashCacheParamsUpdateDescriptor. The user assigned label of the flash cache.

Required/optional:
Returns:	The user_label of this FlashCacheParamsUpdateDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.flash_cache_reconfigure_drives_descriptor module¶

FlashCacheReconfigureDrivesDescriptor.py

class netapp.santricity.models.symbol.flash_cache_reconfigure_drives_descriptor.FlashCacheReconfigureDrivesDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_ref¶

Gets the drive_ref of this FlashCacheReconfigureDrivesDescriptor. A list of drives to be removed.

Required/optional:
Returns:	The drive_ref of this FlashCacheReconfigureDrivesDescriptor.
Return type:	list[str]
	required

flash_cache_ref¶

Gets the flash_cache_ref of this FlashCacheReconfigureDrivesDescriptor. The flash cache from which the drives will be removed.

Required/optional:
Returns:	The flash_cache_ref of this FlashCacheReconfigureDrivesDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.flash_cache_recovery_data module¶

FlashCacheRecoveryData.py

class netapp.santricity.models.symbol.flash_cache_recovery_data.FlashCacheRecoveryData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_ref_list¶

Gets the drive_ref_list of this FlashCacheRecoveryData. A list of drives.

Required/optional:
Returns:	The drive_ref_list of this FlashCacheRecoveryData.
Return type:	DriveRefList
	required

flash_cache¶

Gets the flash_cache of this FlashCacheRecoveryData. The flash cache in non-optimal state.

Required/optional:
Returns:	The flash_cache of this FlashCacheRecoveryData.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.flash_cache_statistics module¶

FlashCacheStatistics.py

class netapp.santricity.models.symbol.flash_cache_statistics.FlashCacheStatistics[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

allocated_bytes¶

Gets the allocated_bytes of this FlashCacheStatistics. The number of allocated bytes.

Required/optional:
Returns:	The allocated_bytes of this FlashCacheStatistics.
Return type:	int
	required

available_bytes¶

Gets the available_bytes of this FlashCacheStatistics. The number of available bytes.

Required/optional:
Returns:	The available_bytes of this FlashCacheStatistics.
Return type:	int
	required

complete_cache_miss¶

Gets the complete_cache_miss of this FlashCacheStatistics. The number of complete cache misses.

Required/optional:
Returns:	The complete_cache_miss of this FlashCacheStatistics.
Return type:	int
	required

complete_cache_miss_blocks¶

Gets the complete_cache_miss_blocks of this FlashCacheStatistics. The number of complete cache miss blocks.

Required/optional:
Returns:	The complete_cache_miss_blocks of this FlashCacheStatistics.
Return type:	int
	required

full_cache_hit_blocks¶

Gets the full_cache_hit_blocks of this FlashCacheStatistics. The number of full cache hit blocks.

Required/optional:
Returns:	The full_cache_hit_blocks of this FlashCacheStatistics.
Return type:	int
	required

full_cache_hits¶

Gets the full_cache_hits of this FlashCacheStatistics. The number of full cache hits.

Required/optional:
Returns:	The full_cache_hits of this FlashCacheStatistics.
Return type:	int
	required

invalidates¶

Gets the invalidates of this FlashCacheStatistics. The number of invalidates on host writes.

Required/optional:
Returns:	The invalidates of this FlashCacheStatistics.
Return type:	int
	required

partial_cache_hit_blocks¶

Gets the partial_cache_hit_blocks of this FlashCacheStatistics. The number of partial cache hit blocks.

Required/optional:
Returns:	The partial_cache_hit_blocks of this FlashCacheStatistics.
Return type:	int
	required

partial_cache_hits¶

Gets the partial_cache_hits of this FlashCacheStatistics. The number of partial cache hits.

Required/optional:
Returns:	The partial_cache_hits of this FlashCacheStatistics.
Return type:	int
	required

populate_on_read_blocks¶

Gets the populate_on_read_blocks of this FlashCacheStatistics. The number of populate on read blocks.

Required/optional:
Returns:	The populate_on_read_blocks of this FlashCacheStatistics.
Return type:	int
	required

populate_on_reads¶

Gets the populate_on_reads of this FlashCacheStatistics. The number of populate on reads.

Required/optional:
Returns:	The populate_on_reads of this FlashCacheStatistics.
Return type:	int
	required

populate_on_write_blocks¶

Gets the populate_on_write_blocks of this FlashCacheStatistics. The number of populate on write blocks.

Required/optional:
Returns:	The populate_on_write_blocks of this FlashCacheStatistics.
Return type:	int
	required

populate_on_writes¶

Gets the populate_on_writes of this FlashCacheStatistics. The number of populate on writes.

Required/optional:
Returns:	The populate_on_writes of this FlashCacheStatistics.
Return type:	int
	required

populated_clean_bytes¶

Gets the populated_clean_bytes of this FlashCacheStatistics. The number of populated clean bytes.

Required/optional:
Returns:	The populated_clean_bytes of this FlashCacheStatistics.
Return type:	int
	required

populated_dirty_bytes¶

Gets the populated_dirty_bytes of this FlashCacheStatistics. The number of populated dirty bytes.

Required/optional:
Returns:	The populated_dirty_bytes of this FlashCacheStatistics.
Return type:	int
	required

read_blocks¶

Gets the read_blocks of this FlashCacheStatistics. The number of block read operations.

Required/optional:
Returns:	The read_blocks of this FlashCacheStatistics.
Return type:	int
	required

reads¶

Gets the reads of this FlashCacheStatistics. The number of read operations.

Required/optional:
Returns:	The reads of this FlashCacheStatistics.
Return type:	int
	required

recycles¶

Gets the recycles of this FlashCacheStatistics. The number of times data is removed from the LRU.

Required/optional:
Returns:	The recycles of this FlashCacheStatistics.
Return type:	int
	required

timestamp¶

Gets the timestamp of this FlashCacheStatistics. The time these statistics were recorded measured in seconds since midnight January 1, 1970.

Required/optional:
Returns:	The timestamp of this FlashCacheStatistics.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

write_blocks¶

Gets the write_blocks of this FlashCacheStatistics. The number of block write operations.

Required/optional:
Returns:	The write_blocks of this FlashCacheStatistics.
Return type:	int
	required

writes¶

Gets the writes of this FlashCacheStatistics. The number of write operations.

Required/optional:
Returns:	The writes of this FlashCacheStatistics.
Return type:	int
	required

netapp.santricity.models.symbol.flash_cache_statistics_returned module¶

FlashCacheStatisticsReturned.py

class netapp.santricity.models.symbol.flash_cache_statistics_returned.FlashCacheStatisticsReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

flash_cache_statistics¶

Gets the flash_cache_statistics of this FlashCacheStatisticsReturned. The flash cache statistics are returned if the returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The flash_cache_statistics of this FlashCacheStatisticsReturned.
Return type:	FlashCacheStatistics
	optional

return_code¶

Gets the return_code of this FlashCacheStatisticsReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this FlashCacheStatisticsReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.flash_cache_with_drives module¶

FlashCacheWithDrives.py

class netapp.santricity.models.symbol.flash_cache_with_drives.FlashCacheWithDrives[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

protection_information_capabilities¶

Gets the protection_information_capabilities of this FlashCacheWithDrives. The protection information capabilities of the drives.

Required/optional:
Returns:	The protection_information_capabilities of this FlashCacheWithDrives.
Return type:	ProtectionInformationCapabilities
	required

security_level¶

Gets the security_level of this FlashCacheWithDrives. Refines the information in the securityType field to describe the set of drives.

Required/optional:
Returns:	The security_level of this FlashCacheWithDrives.
Return type:	str
	required

security_type¶

Gets the security_type of this FlashCacheWithDrives. The security type of the drives.

Required/optional:
Returns:	The security_type of this FlashCacheWithDrives.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

used_capacity¶

Gets the used_capacity of this FlashCacheWithDrives. The used capacity of the drives (in bytes).

Required/optional:
Returns:	The used_capacity of this FlashCacheWithDrives.
Return type:	int
	required

netapp.santricity.models.symbol.free_extent module¶

FreeExtent.py

class netapp.santricity.models.symbol.free_extent.FreeExtent[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

free_extent_ref¶

Gets the free_extent_ref of this FreeExtent. The unique identification value for this free extent. Other objects may use this reference value to refer to the free extent.

Required/optional:
Returns:	The free_extent_ref of this FreeExtent.
Return type:	str
	required

raid_level¶

Gets the raid_level of this FreeExtent. The RAID level of this free extent, which governs the allowed configuration of volumes that can be created on it.

Required/optional:
Returns:	The raid_level of this FreeExtent.
Return type:	str
	required

raw_capacity¶

Gets the raw_capacity of this FreeExtent. The total raw capacity of this free extent. If the storage array supports mixed RAID levels per volume group, this value will represent the raw capacity without accounting for RAID parity requirements. Otherwise, this value will represent the RAID-factored capacity of the free extent, and thus provide an indication of the maximum volume (using the volume group’s RAID level) that can be created on this free extent.

Required/optional:
Returns:	The raw_capacity of this FreeExtent.
Return type:	int
	required

reserved1¶

Gets the reserved1 of this FreeExtent.

Required/optional:
Returns:	The reserved1 of this FreeExtent.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this FreeExtent.

Required/optional:
Returns:	The reserved2 of this FreeExtent.
Return type:	str
	optional

sector_offset¶

Gets the sector_offset of this FreeExtent. The sector offset of this free extent within its volume group. This value is provided only to allow the client application to determine the relative positions of free extents and volumes within a given volume group. No other assumptions or computations should be made with this value.

Required/optional:
Returns:	The sector_offset of this FreeExtent.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_group_ref¶

Gets the volume_group_ref of this FreeExtent. The volume group reference value of the volume group on which this free extent resides.

Required/optional:
Returns:	The volume_group_ref of this FreeExtent.
Return type:	str
	required

netapp.santricity.models.symbol.fru_diag_descriptor module¶

FruDiagDescriptor.py

class netapp.santricity.models.symbol.fru_diag_descriptor.FruDiagDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

fru_diag_test_identifier¶

Gets the fru_diag_test_identifier of this FruDiagDescriptor. The diagnostic test to be performed.

Required/optional:
Returns:	The fru_diag_test_identifier of this FruDiagDescriptor.
Return type:	str
	required

fru_diag_test_type¶

Gets the fru_diag_test_type of this FruDiagDescriptor. The diagnostic test type.

Required/optional:
Returns:	The fru_diag_test_type of this FruDiagDescriptor.
Return type:	str
	required

slot¶

Gets the slot of this FruDiagDescriptor. The slot number (1-based) of the device on which the test should be performed. If a slot number is not required by the diagnostic, this value will be ignored.

Required/optional:
Returns:	The slot of this FruDiagDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.fru_diag_return module¶

FruDiagReturn.py

class netapp.santricity.models.symbol.fru_diag_return.FruDiagReturn[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

fru_diag_return_data¶

Gets the fru_diag_return_data of this FruDiagReturn. This contains the data associated with a FRU diagnostic test. This field is only available when the returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The fru_diag_return_data of this FruDiagReturn.
Return type:	FruDiagReturnData
	optional

return_code¶

Gets the return_code of this FruDiagReturn. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this FruDiagReturn.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.fru_diag_return_data module¶

FruDiagReturnData.py

class netapp.santricity.models.symbol.fru_diag_return_data.FruDiagReturnData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

end_time¶

Gets the end_time of this FruDiagReturnData. If the diagnostic is not running this is the time the diagnostic was completed or interrupted. If the diagnostic is running this is the time the status was requested. The time is represented in seconds since midnight GMT on January 1, 1970.

Required/optional:
Returns:	The end_time of this FruDiagReturnData.
Return type:	int
	required

error_code¶

Gets the error_code of this FruDiagReturnData. The diagnostic test error code.

Required/optional:
Returns:	The error_code of this FruDiagReturnData.
Return type:	int
	required

percent_complete¶

Gets the percent_complete of this FruDiagReturnData. This value is a number in the range 0 to 100 indicating the percent complete.

Required/optional:
Returns:	The percent_complete of this FruDiagReturnData.
Return type:	int
	required

serial_number¶

Gets the serial_number of this FruDiagReturnData. Variable-length ASCII text string that identifies the device serial number.

Required/optional:
Returns:	The serial_number of this FruDiagReturnData.
Return type:	str
	required

slot¶

Gets the slot of this FruDiagReturnData. Device slot number (1-based).

Required/optional:
Returns:	The slot of this FruDiagReturnData.
Return type:	int
	required

start_time¶

Gets the start_time of this FruDiagReturnData. The time the diagnostic was started, represented in seconds since midnight GMT on January 1, 1970.

Required/optional:
Returns:	The start_time of this FruDiagReturnData.
Return type:	int
	required

status¶

Gets the status of this FruDiagReturnData. The diagnostic test status.

Required/optional:
Returns:	The status of this FruDiagReturnData.
Return type:	str
	required

test_identifier¶

Gets the test_identifier of this FruDiagReturnData. The diagnostic test identifier.

Required/optional:
Returns:	The test_identifier of this FruDiagReturnData.
Return type:	str
	required

test_type¶

Gets the test_type of this FruDiagReturnData. The diagnostic test type.

Required/optional:
Returns:	The test_type of this FruDiagReturnData.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.full_repository module¶

FullRepository.py

class netapp.santricity.models.symbol.full_repository.FullRepository[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

full_policy¶

Gets the full_policy of this FullRepository. The policy concerning the behavior when a repository is full.

Required/optional:
Returns:	The full_policy of this FullRepository.
Return type:	str
	required

repository_volume¶

Gets the repository_volume of this FullRepository. The repository volume that is full.

Required/optional:
Returns:	The repository_volume of this FullRepository.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.function_state_descriptor module¶

FunctionStateDescriptor.py

class netapp.santricity.models.symbol.function_state_descriptor.FunctionStateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

function_action¶

Gets the function_action of this FunctionStateDescriptor. The action that should be taken on the specified function.

Required/optional:
Returns:	The function_action of this FunctionStateDescriptor.
Return type:	str
	required

function_id¶

Gets the function_id of this FunctionStateDescriptor. The function that should be acted upon.

Required/optional:
Returns:	The function_id of this FunctionStateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.function_state_returned module¶

FunctionStateReturned.py

class netapp.santricity.models.symbol.function_state_returned.FunctionStateReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

function_state¶

Gets the function_state of this FunctionStateReturned. This field is present only if the value of returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The function_state of this FunctionStateReturned.
Return type:	str
	optional

return_code¶

Gets the return_code of this FunctionStateReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this FunctionStateReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.gbic module¶

Gbic.py

class netapp.santricity.models.symbol.gbic.Gbic[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

gbic_port¶

Gets the gbic_port of this Gbic. This field provides information about the port that the GBIC is associated with.

Required/optional:
Returns:	The gbic_port of this Gbic.
Return type:	str
	required

gbic_ref¶

Gets the gbic_ref of this Gbic. The reference for this physical GBIC.

Required/optional:
Returns:	The gbic_ref of this Gbic.
Return type:	str
	required

gbic_type¶

Gets the gbic_type of this Gbic. This field is the discriminator value, which identifies the type of GBIC.

Required/optional:
Returns:	The gbic_type of this Gbic.
Return type:	str
	required

parent_data¶

Gets the parent_data of this Gbic. Information returned is based on the type of the GBIC parent. The data returned describes the component or controller that is associated with the GBIC.

Required/optional:
Returns:	The parent_data of this Gbic.
Return type:	GBICParentTypeData
	required

physical_location¶

Gets the physical_location of this Gbic. The physical location of the GBIC. Note that the tray reference identifies the enclosure containing the GBIC, but the slot information does not apply to this component.

Required/optional:
Returns:	The physical_location of this Gbic.
Return type:	Location
	required

reserved1¶

Gets the reserved1 of this Gbic.

Required/optional:
Returns:	The reserved1 of this Gbic.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this Gbic.

Required/optional:
Returns:	The reserved2 of this Gbic.
Return type:	str
	optional

status¶

Gets the status of this Gbic. The operational status of the GBIC.

Required/optional:
Returns:	The status of this Gbic.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.gbic_parent_type_data module¶

GBICParentTypeData.py

class netapp.santricity.models.symbol.gbic_parent_type_data.GBICParentTypeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_gbic¶

Gets the controller_gbic of this GBICParentTypeData. This field is present only if the gbicParentType value is GBIC_PARENT_TYPE_CONTROLLER. It contains the detailed information about the controller channel.

Required/optional:
Returns:	The controller_gbic of this GBICParentTypeData.
Return type:	ControllerGBIC
	optional

gbic_parent_type¶

Gets the gbic_parent_type of this GBICParentTypeData. This enumeration is used to identify the parent type of a GBIC component.

Required/optional:
Returns:	The gbic_parent_type of this GBICParentTypeData.
Return type:	str
	required

parent_esm¶

Gets the parent_esm of this GBICParentTypeData. No information is returned

Required/optional:
Returns:	The parent_esm of this GBICParentTypeData.
Return type:	str
	optional

parent_minihub¶

Gets the parent_minihub of this GBICParentTypeData. This field is present only if the gbicParentType value is GBIC_PARENT_TYPE_MINIHUB. It contains the detailed information about the minihub the GBIC belongs to.

Required/optional:
Returns:	The parent_minihub of this GBICParentTypeData.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.get_iscsi_sessions_filter module¶

GetIscsiSessionsFilter.py

class netapp.santricity.models.symbol.get_iscsi_sessions_filter.GetIscsiSessionsFilter[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

initiator_ref¶

Gets the initiator_ref of this GetIscsiSessionsFilter. A reference to an initiator instance. This field is present only if type is GET_ISCSI_SESSIONS_BY_INITIATOR.

Required/optional:
Returns:	The initiator_ref of this GetIscsiSessionsFilter.
Return type:	str
	optional

target_ref¶

Gets the target_ref of this GetIscsiSessionsFilter. A reference to a target instance. This field is present only if type is GET_ISCSI_SESSIONS_BY_TARGET.

Required/optional:
Returns:	The target_ref of this GetIscsiSessionsFilter.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this GetIscsiSessionsFilter. This enumeration type identifies the different filter options for the getIscsiSessions procedure.

Required/optional:
Returns:	The type of this GetIscsiSessionsFilter.
Return type:	str
	required

netapp.santricity.models.symbol.ghost_vol_bundle module¶

GhostVolBundle.py

class netapp.santricity.models.symbol.ghost_vol_bundle.GhostVolBundle[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ghost_vol¶

Gets the ghost_vol of this GhostVolBundle. An array of GhostVolume objects.

Required/optional:
Returns:	The ghost_vol of this GhostVolBundle.
Return type:	list[GhostVolume]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ghost_volume module¶

GhostVolume.py

class netapp.santricity.models.symbol.ghost_volume.GhostVolume[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

reserved1¶

Gets the reserved1 of this GhostVolume.

Required/optional:
Returns:	The reserved1 of this GhostVolume.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this GhostVolume.

Required/optional:
Returns:	The reserved2 of this GhostVolume.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this GhostVolume. The reference for this volume.

Required/optional:
Returns:	The volume_ref of this GhostVolume.
Return type:	str
	required

world_wide_name¶

Gets the world_wide_name of this GhostVolume. The World Wide Name of the volume.

Required/optional:
Returns:	The world_wide_name of this GhostVolume.
Return type:	str
	required

netapp.santricity.models.symbol.high_resolution_request_descriptor module¶

HighResolutionRequestDescriptor.py

class netapp.santricity.models.symbol.high_resolution_request_descriptor.HighResolutionRequestDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

enable¶

Gets the enable of this HighResolutionRequestDescriptor. Enable or disable high resolution statistical sampling.

Required/optional:
Returns:	The enable of this HighResolutionRequestDescriptor.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.high_resolution_returned module¶

HighResolutionReturned.py

class netapp.santricity.models.symbol.high_resolution_returned.HighResolutionReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

is_enabled¶

Gets the is_enabled of this HighResolutionReturned. True if high resolution is enabled and false if disabled.

Required/optional:
Returns:	The is_enabled of this HighResolutionReturned.
Return type:	bool
	required

return_code¶

Gets the return_code of this HighResolutionReturned. The return code from the procedure to enable or disable high resolution statistical sampling.

Required/optional:
Returns:	The return_code of this HighResolutionReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.histogram module¶

Histogram.py

class netapp.santricity.models.symbol.histogram.Histogram[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

above_range¶

Gets the above_range of this Histogram. A summary of above-range, unrecorded values.

Required/optional:
Returns:	The above_range of this Histogram.
Return type:	HistogramSummary
	required

below_range¶

Gets the below_range of this Histogram. A summary of below-range, unrecorded values.

Required/optional:
Returns:	The below_range of this Histogram.
Return type:	HistogramSummary
	required

controller_ref¶

Gets the controller_ref of this Histogram. A reference to the controller that provided the statistics.

Required/optional:
Returns:	The controller_ref of this Histogram.
Return type:	str
	required

frequency_table¶

Gets the frequency_table of this Histogram. An array of counter values, one counter per histogram category.

Required/optional:
Returns:	The frequency_table of this Histogram.
Return type:	list[int]
	required

in_range¶

Gets the in_range of this Histogram. A summary of recorded values.

Required/optional:
Returns:	The in_range of this Histogram.
Return type:	HistogramSummary
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.histogram_bundle module¶

HistogramBundle.py

class netapp.santricity.models.symbol.histogram_bundle.HistogramBundle[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

histogram¶

Gets the histogram of this HistogramBundle. An array of histogram streams, one stream per controller.

Required/optional:
Returns:	The histogram of this HistogramBundle.
Return type:	list[Histogram]
	required

object_ref¶

Gets the object_ref of this HistogramBundle. A reference to the object to which the histogram applies.

Required/optional:
Returns:	The object_ref of this HistogramBundle.
Return type:	ObjectReference
	required

observation_time¶

Gets the observation_time of this HistogramBundle. The time that the histogram was retrieved. Time is the number of seconds since midnight, January 1, 1970.

Required/optional:
Returns:	The observation_time of this HistogramBundle.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.histogram_bundle_returned module¶

HistogramBundleReturned.py

class netapp.santricity.models.symbol.histogram_bundle_returned.HistogramBundleReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

histogram_bundle¶

Gets the histogram_bundle of this HistogramBundleReturned. The statistical stream data in the form of histograms.

Required/optional:
Returns:	The histogram_bundle of this HistogramBundleReturned.
Return type:	HistogramBundle
	optional

return_code¶

Gets the return_code of this HistogramBundleReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this HistogramBundleReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.histogram_descriptor module¶

HistogramDescriptor.py

class netapp.santricity.models.symbol.histogram_descriptor.HistogramDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

duration¶

Gets the duration of this HistogramDescriptor. The amount of time, expressed in seconds, to spend recording observations. If the discrete time series is not retrieved by the client before the end of the duration, the stream wraps around, i.e., observations will be overwritten

Required/optional:
Returns:	The duration of this HistogramDescriptor.
Return type:	int
	required

lowest_range¶

Gets the lowest_range of this HistogramDescriptor. The number of values in the first category.

Required/optional:
Returns:	The lowest_range of this HistogramDescriptor.
Return type:	int
	required

lowest_value¶

Gets the lowest_value of this HistogramDescriptor. The lowest value of interest for the stream.

Required/optional:
Returns:	The lowest_value of this HistogramDescriptor.
Return type:	int
	required

num_categories¶

Gets the num_categories of this HistogramDescriptor. The number of categories in the histogram.

Required/optional:
Returns:	The num_categories of this HistogramDescriptor.
Return type:	int
	required

object_ref¶

Gets the object_ref of this HistogramDescriptor. A reference to the storage array object (e.g., volume, drive, ets.) to observe.

Required/optional:
Returns:	The object_ref of this HistogramDescriptor.
Return type:	ObjectReference
	required

scale_type¶

Gets the scale_type of this HistogramDescriptor. The type of scale to use for the histogram.

Required/optional:
Returns:	The scale_type of this HistogramDescriptor.
Return type:	str
	required

stream_type¶

Gets the stream_type of this HistogramDescriptor. The type of statistic to observe in the activated streams.

Required/optional:
Returns:	The stream_type of this HistogramDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.histogram_summary module¶

HistogramSummary.py

class netapp.santricity.models.symbol.histogram_summary.HistogramSummary[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

max_sample¶

Gets the max_sample of this HistogramSummary. The maximum sampled value.

Required/optional:
Returns:	The max_sample of this HistogramSummary.
Return type:	int
	required

min_sample¶

Gets the min_sample of this HistogramSummary. The minimum sampled value.

Required/optional:
Returns:	The min_sample of this HistogramSummary.
Return type:	int
	required

sum_samples¶

Gets the sum_samples of this HistogramSummary. The sum of all samples.

Required/optional:
Returns:	The sum_samples of this HistogramSummary.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

total_samples¶

Gets the total_samples of this HistogramSummary. The total number of samples.

Required/optional:
Returns:	The total_samples of this HistogramSummary.
Return type:	int
	required

netapp.santricity.models.symbol.hl_volume_bundle module¶

HLVolumeBundle.py

class netapp.santricity.models.symbol.hl_volume_bundle.HLVolumeBundle[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

async_mirror_group¶

Gets the async_mirror_group of this HLVolumeBundle. Async Mirror Groups.

Required/optional:
Returns:	The async_mirror_group of this HLVolumeBundle.
Return type:	list[AsyncMirrorGroup]
	required

async_mirror_group_incomplete_member¶

Gets the async_mirror_group_incomplete_member of this HLVolumeBundle. “Incomplete” Async Mirror Group Members.

Required/optional:
Returns:	The async_mirror_group_incomplete_member of this HLVolumeBundle.
Return type:	list[AsyncMirrorGroupIncompleteMember]
	required

async_mirror_group_member¶

Gets the async_mirror_group_member of this HLVolumeBundle. Async Mirror Group Members.

Required/optional:
Returns:	The async_mirror_group_member of this HLVolumeBundle.
Return type:	list[AsyncMirrorGroupMember]
	required

concat_vol_member¶

Gets the concat_vol_member of this HLVolumeBundle. An array of ConcatVolumeMember objects.

Required/optional:
Returns:	The concat_vol_member of this HLVolumeBundle.
Return type:	list[ConcatVolumeMember]
	required

concat_volume¶

Gets the concat_volume of this HLVolumeBundle. An array of ConcatVolume objects.

Required/optional:
Returns:	The concat_volume of this HLVolumeBundle.
Return type:	list[ConcatVolume]
	required

metadata_vol¶

Gets the metadata_vol of this HLVolumeBundle. An array of MetadataVolume objects.

Required/optional:
Returns:	The metadata_vol of this HLVolumeBundle.
Return type:	list[MetadataVolume]
	required

mirror_vol¶

Gets the mirror_vol of this HLVolumeBundle. An array of MirrorProxyVolume objects.

Required/optional:
Returns:	The mirror_vol of this HLVolumeBundle.
Return type:	list[MirrorProxyVolume]
	required

pit¶

Gets the pit of this HLVolumeBundle. An array of PiT objects.

Required/optional:
Returns:	The pit of this HLVolumeBundle.
Return type:	list[PIT]
	required

pit_consistency_group¶

Gets the pit_consistency_group of this HLVolumeBundle. An array of PITConsistencyGroup objects.

Required/optional:
Returns:	The pit_consistency_group of this HLVolumeBundle.
Return type:	list[PITConsistencyGroup]
	required

pit_consistency_group_view¶

Gets the pit_consistency_group_view of this HLVolumeBundle. An array of PITConsistencyGroupView objects.

Required/optional:
Returns:	The pit_consistency_group_view of this HLVolumeBundle.
Return type:	list[PITConsistencyGroupView]
	required

pit_group¶

Gets the pit_group of this HLVolumeBundle. An array of PITGroup objects.

Required/optional:
Returns:	The pit_group of this HLVolumeBundle.
Return type:	list[PITGroup]
	required

pit_view¶

Gets the pit_view of this HLVolumeBundle. An array of PITView objects.

Required/optional:
Returns:	The pit_view of this HLVolumeBundle.
Return type:	list[PITView]
	required

remote_vol¶

Gets the remote_vol of this HLVolumeBundle. An array of RemoteVolume objects.

Required/optional:
Returns:	The remote_vol of this HLVolumeBundle.
Return type:	list[RemoteVolume]
	required

snapshot_vol¶

Gets the snapshot_vol of this HLVolumeBundle. An array of SnapshotVolume objects.

Required/optional:
Returns:	The snapshot_vol of this HLVolumeBundle.
Return type:	list[SnapshotVolume]
	required

thin_volume¶

Gets the thin_volume of this HLVolumeBundle. An array of ThinVolume objects.

Required/optional:
Returns:	The thin_volume of this HLVolumeBundle.
Return type:	list[ThinVolume]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_copy¶

Gets the volume_copy of this HLVolumeBundle. An array of VolumeCopy objects.

Required/optional:
Returns:	The volume_copy of this HLVolumeBundle.
Return type:	list[VolumeCopy]
	required

netapp.santricity.models.symbol.host module¶

Host.py

class netapp.santricity.models.symbol.host.Host[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cluster_ref¶

Gets the cluster_ref of this Host. The cluster reference value of the cluster in which this host resides. A NULL reference value indicates that the host has not been assigned to a cluster.

Required/optional:
Returns:	The cluster_ref of this Host.
Return type:	str
	required

confirm_lun_mapping_creation¶

Gets the confirm_lun_mapping_creation of this Host. If true, indicates that creation of LUN-to-volume mappings should require careful confirmation from the end-user, since such a mapping will alter the volume access rights of other hosts, in addition to this one.

Required/optional:
Returns:	The confirm_lun_mapping_creation of this Host.
Return type:	bool
	required

host_ref¶

Gets the host_ref of this Host. The unique identification value for this object. Other objects may use this reference value to refer to the host.

Required/optional:
Returns:	The host_ref of this Host.
Return type:	str
	required

host_type_index¶

Gets the host_type_index of this Host. An integer index indicating the type of host.

Required/optional:
Returns:	The host_type_index of this Host.
Return type:	int
	required

id¶

Gets the id of this Host.

Required/optional:
Returns:	The id of this Host.
Return type:	str
	optional

is_large_block_format_host¶

Gets the is_large_block_format_host of this Host. If true, the host is capable of supporting large block formats.

Required/optional:
Returns:	The is_large_block_format_host of this Host.
Return type:	bool
	required

is_sa_controlled¶

Gets the is_sa_controlled of this Host. If true, indicates that I/O accesses from this host are subject to the storage array’s default LUN-to-volume mappings. If false, indicates that I/O accesses from the host are subject to host-specific or cluster-specific LUN-to-volume mappings.

Required/optional:
Returns:	The is_sa_controlled of this Host.
Return type:	bool
	required

label¶

Gets the label of this Host. The user-assigned, descriptive label string for the host.

Required/optional:
Returns:	The label of this Host.
Return type:	str
	required

name¶

Gets the name of this Host.

Required/optional:
Returns:	The name of this Host.
Return type:	str
	optional

protection_information_capable_access_method¶

Gets the protection_information_capable_access_method of this Host. This field is true if the host has a PI capable access method.

Required/optional:
Returns:	The protection_information_capable_access_method of this Host.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.host_board module¶

HostBoard.py

class netapp.santricity.models.symbol.host_board.HostBoard[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

fru_type¶

Gets the fru_type of this HostBoard. The field replaceable unit type string, from VPD.

Required/optional:
Returns:	The fru_type of this HostBoard.
Return type:	str
	required

hb_type_data¶

Gets the hb_type_data of this HostBoard. Data that is specific to the type of host board.

Required/optional:
Returns:	The hb_type_data of this HostBoard.
Return type:	HostBoardTypeData
	required

host_board_controller_slot¶

Gets the host_board_controller_slot of this HostBoard. The number of the slot on the controller where the host board resides. Host board slots are numbered starting at one, independent of other types of slots (e.g., cache backup device slots) on the controller.

Required/optional:
Returns:	The host_board_controller_slot of this HostBoard.
Return type:	int
	required

host_board_id¶

Gets the host_board_id of this HostBoard. The board ID of the controller’s host card.

Required/optional:
Returns:	The host_board_id of this HostBoard.
Return type:	str
	required

host_board_ref¶

Gets the host_board_ref of this HostBoard. The reference for this physical host board.

Required/optional:
Returns:	The host_board_ref of this HostBoard.
Return type:	str
	required

id¶

Gets the id of this HostBoard.

Required/optional:
Returns:	The id of this HostBoard.
Return type:	str
	optional

manufacturer_date¶

Gets the manufacturer_date of this HostBoard. The host board’s date of manufacture, from VPD.

Required/optional:
Returns:	The manufacturer_date of this HostBoard.
Return type:	int
	required

number_of_ports¶

Gets the number_of_ports of this HostBoard. The number of ports provided by the host board.

Required/optional:
Returns:	The number_of_ports of this HostBoard.
Return type:	int
	required

oem_part_number¶

Gets the oem_part_number of this HostBoard. The OEM part number of the host board.

Required/optional:
Returns:	The oem_part_number of this HostBoard.
Return type:	str
	required

parent_controller¶

Gets the parent_controller of this HostBoard. The controller associated with the host board.

Required/optional:
Returns:	The parent_controller of this HostBoard.
Return type:	str
	required

part_number¶

Gets the part_number of this HostBoard. The host board’s part number, from VPD.

Required/optional:
Returns:	The part_number of this HostBoard.
Return type:	str
	required

physical_location¶

Gets the physical_location of this HostBoard. The physical location of the host board. The parent reference in Location identifies the controller where the host board is physically located, and the position field is the parent-relative/like-component relative slot number of the host card, starting at 1.

Required/optional:
Returns:	The physical_location of this HostBoard.
Return type:	Location
	required

repair_policy¶

Gets the repair_policy of this HostBoard. The repair policy for the host board component.

Required/optional:
Returns:	The repair_policy of this HostBoard.
Return type:	RepairPolicy
	required

serial_number¶

Gets the serial_number of this HostBoard. The host board’s serial number, from VPD.

Required/optional:
Returns:	The serial_number of this HostBoard.
Return type:	str
	required

status¶

Gets the status of this HostBoard. The host board’s status.

Required/optional:
Returns:	The status of this HostBoard.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this HostBoard. The host board’s type.

Required/optional:
Returns:	The type of this HostBoard.
Return type:	str
	required

vendor_name¶

Gets the vendor_name of this HostBoard. The host board’s vendor name, from VPD.

Required/optional:
Returns:	The vendor_name of this HostBoard.
Return type:	str
	required

netapp.santricity.models.symbol.host_board2_port_ib_type_data module¶

HostBoard2PortIbTypeData.py

class netapp.santricity.models.symbol.host_board2_port_ib_type_data.HostBoard2PortIbTypeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

completion_queues_supported¶

Gets the completion_queues_supported of this HostBoard2PortIbTypeData. The number of completion queues supported by the host board.

Required/optional:
Returns:	The completion_queues_supported of this HostBoard2PortIbTypeData.
Return type:	int
	required

queue_pairs_supported¶

Gets the queue_pairs_supported of this HostBoard2PortIbTypeData. The number of queue pairs supported by the host board.

Required/optional:
Returns:	The queue_pairs_supported of this HostBoard2PortIbTypeData.
Return type:	int
	required

shared_receive_queues_supported¶

Gets the shared_receive_queues_supported of this HostBoard2PortIbTypeData. The number of shared receive queues supported by the host board.

Required/optional:
Returns:	The shared_receive_queues_supported of this HostBoard2PortIbTypeData.
Return type:	int
	required

tca_guid¶

Gets the tca_guid of this HostBoard2PortIbTypeData. The globally unique identifier (GUID) assigned to the host board.

Required/optional:
Returns:	The tca_guid of this HostBoard2PortIbTypeData.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.host_board_type_data module¶

HostBoardTypeData.py

class netapp.santricity.models.symbol.host_board_type_data.HostBoardTypeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

dual_port_denali_ib_type_data¶

Gets the dual_port_denali_ib_type_data of this HostBoardTypeData. If the host board type is denali with two port infiniband, return the two port ib type data struct.

Required/optional:
Returns:	The dual_port_denali_ib_type_data of this HostBoardTypeData.
Return type:	HostBoard2PortIbTypeData
	optional

dual_port_ib_type_data¶

Gets the dual_port_ib_type_data of this HostBoardTypeData. Host board data for two-port InfiniBand host board. This field is only present if type is equal to HB_TYPE_2PORT_IB.

Required/optional:
Returns:	The dual_port_ib_type_data of this HostBoardTypeData.
Return type:	HostBoard2PortIbTypeData
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this HostBoardTypeData. This enumeration object is used to indicate the type of a controller’s host board.

Required/optional:
Returns:	The type of this HostBoardTypeData.
Return type:	str
	required

netapp.santricity.models.symbol.host_changeable_properties module¶

HostChangeableProperties.py

class netapp.santricity.models.symbol.host_changeable_properties.HostChangeableProperties[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cluster_ref¶

Gets the cluster_ref of this HostChangeableProperties. The cluster reference value of the cluster in which this host resides. A null reference (binary zeros) means that the host should not be attached to any cluster.

Required/optional:
Returns:	The cluster_ref of this HostChangeableProperties.
Return type:	list[str]
	required

host_type_index¶

Gets the host_type_index of this HostChangeableProperties. The index value indicating the type of host. This value is used to reference the appropriate entry in the hostPortType field of the associated StorageArray object.

Required/optional:
Returns:	The host_type_index of this HostChangeableProperties.
Return type:	list[int]
	required

label¶

Gets the label of this HostChangeableProperties. The user-assigned, descriptive label string for the host.

Required/optional:
Returns:	The label of this HostChangeableProperties.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.host_creation_descriptor module¶

HostCreationDescriptor.py

class netapp.santricity.models.symbol.host_creation_descriptor.HostCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cluster_ref¶

Gets the cluster_ref of this HostCreationDescriptor. The cluster reference value of the cluster in which this host resides, or a null reference.

Required/optional:
Returns:	The cluster_ref of this HostCreationDescriptor.
Return type:	str
	required

label¶

Gets the label of this HostCreationDescriptor. The user-assigned, descriptive label string for the host.

Required/optional:
Returns:	The label of this HostCreationDescriptor.
Return type:	str
	required

settings¶

Gets the settings of this HostCreationDescriptor. The initial settings for the new host.

Required/optional:
Returns:	The settings of this HostCreationDescriptor.
Return type:	HostChangeableProperties
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.host_io_card_location module¶

HostIoCardLocation.py

class netapp.santricity.models.symbol.host_io_card_location.HostIoCardLocation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_slot¶

Gets the controller_slot of this HostIoCardLocation. The slot number of the controller that houses the host card.

Required/optional:
Returns:	The controller_slot of this HostIoCardLocation.
Return type:	int
	required

controller_tray¶

Gets the controller_tray of this HostIoCardLocation. The tray ID of the controller that houses the host card.

Required/optional:
Returns:	The controller_tray of this HostIoCardLocation.
Return type:	int
	required

host_io_card_controller_slot¶

Gets the host_io_card_controller_slot of this HostIoCardLocation. The number of the slot on the controller where the host I/O card (a.k.a., host board) resides. Host I/O card slots are numbered starting at one, independent of other types of slots (e.g., cache backup device slots) on the controller.

Required/optional:
Returns:	The host_io_card_controller_slot of this HostIoCardLocation.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.host_port module¶

HostPort.py

class netapp.santricity.models.symbol.host_port.HostPort[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

confirm_lun_mapping_creation¶

Gets the confirm_lun_mapping_creation of this HostPort. If true, indicates that creation of LUN-to-volume mappings should require careful confirmation from the end-user, since such a mapping will alter the volume access rights of other host ports, in addition to this one.

Required/optional:
Returns:	The confirm_lun_mapping_creation of this HostPort.
Return type:	bool
	required

host_port_name¶

Gets the host_port_name of this HostPort. The unique, externally-defined identifier for this object. For example, for a Fibre Channel host port, this field contains the value of the Fibre Channel world-wide name for the port.

Required/optional:
Returns:	The host_port_name of this HostPort.
Return type:	str
	required

host_port_ref¶

Gets the host_port_ref of this HostPort. The unique identification value for this object. Other objects may use this reference value to refer to the host port.

Required/optional:
Returns:	The host_port_ref of this HostPort.
Return type:	str
	required

host_port_type_index¶

Gets the host_port_type_index of this HostPort. An index value that indicates the type of host port. This value is used to reference the appropriate entry in the hostPortType field of the associated StorageArray object.

Required/optional:
Returns:	The host_port_type_index of this HostPort.
Return type:	int
	required

host_ref¶

Gets the host_ref of this HostPort. The host reference value of the host in which this port resides.

Required/optional:
Returns:	The host_ref of this HostPort.
Return type:	str
	required

id¶

Gets the id of this HostPort.

Required/optional:
Returns:	The id of this HostPort.
Return type:	str
	optional

is_sa_controlled¶

Gets the is_sa_controlled of this HostPort. If true, indicates that I/O accesses from this host port are subject to the storage array’s default LUN-to-volume mappings. If false, indicates that I/O accesses from the host port are subject to host-specific or cluster-specific LUN-to-volume mappings.

Required/optional:
Returns:	The is_sa_controlled of this HostPort.
Return type:	bool
	required

label¶

Gets the label of this HostPort. The user-assigned, descriptive label string for the host port.

Required/optional:
Returns:	The label of this HostPort.
Return type:	str
	required

port_id¶

Gets the port_id of this HostPort. The I/O-protocol-based unique port identifier. This field replaces the deprecated hostPortName field.

Required/optional:
Returns:	The port_id of this HostPort.
Return type:	SCSIInitiatorPortId
	required

port_inactive¶

Gets the port_inactive of this HostPort. The host port has been marked inactive

Required/optional:
Returns:	The port_inactive of this HostPort.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.host_port_changeable_properties module¶

HostPortChangeableProperties.py

class netapp.santricity.models.symbol.host_port_changeable_properties.HostPortChangeableProperties[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

host_port_name¶

Gets the host_port_name of this HostPortChangeableProperties. The unique, externally-defined identifier for this object. For example, for a Fibre Channel host port, this field contains the value of the Fibre Channel world-wide name for the port.

Required/optional:
Returns:	The host_port_name of this HostPortChangeableProperties.
Return type:	list[str]
	required

host_ref¶

Gets the host_ref of this HostPortChangeableProperties. The host reference value of the host in which this port resides.

Required/optional:
Returns:	The host_ref of this HostPortChangeableProperties.
Return type:	list[str]
	required

label¶

Gets the label of this HostPortChangeableProperties. The user-assigned, descriptive label string for the host port.

Required/optional:
Returns:	The label of this HostPortChangeableProperties.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.host_port_create_descriptor module¶

HostPortCreateDescriptor.py

class netapp.santricity.models.symbol.host_port_create_descriptor.HostPortCreateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

settings¶

Gets the settings of this HostPortCreateDescriptor. An object containing the initial settings for the new host port.

Required/optional:
Returns:	The settings of this HostPortCreateDescriptor.
Return type:	HostPortMutableProperties
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.host_port_creation_descriptor module¶

HostPortCreationDescriptor.py

class netapp.santricity.models.symbol.host_port_creation_descriptor.HostPortCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

host_port_name¶

Gets the host_port_name of this HostPortCreationDescriptor. The unique, externally-defined identifier for this object. For example, for a Fibre Channel host port, this field contains the value of the Fibre Channel world-wide name for the port.

Required/optional:
Returns:	The host_port_name of this HostPortCreationDescriptor.
Return type:	str
	required

host_port_type_index¶

Gets the host_port_type_index of this HostPortCreationDescriptor. An index value that indicates the type of host port. This value is used to reference the appropriate entry in the hostPortType field of the associated StorageArray object.

Required/optional:
Returns:	The host_port_type_index of this HostPortCreationDescriptor.
Return type:	int
	required

host_ref¶

Gets the host_ref of this HostPortCreationDescriptor. The host reference value of the host in which this port resides.

Required/optional:
Returns:	The host_ref of this HostPortCreationDescriptor.
Return type:	str
	required

label¶

Gets the label of this HostPortCreationDescriptor. The user-assigned, descriptive label string for the host port.

Required/optional:
Returns:	The label of this HostPortCreationDescriptor.
Return type:	str
	required

settings¶

Gets the settings of this HostPortCreationDescriptor. The settings to apply to the new host port. This field is in place of the above deprecated fields.

Required/optional:
Returns:	The settings of this HostPortCreationDescriptor.
Return type:	HostPortChangeableProperties
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.host_port_location module¶

HostPortLocation.py

class netapp.santricity.models.symbol.host_port_location.HostPortLocation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

fc_port_name¶

Gets the fc_port_name of this HostPortLocation. This field is present only if the type value is equal to IO_IF_FC.

Required/optional:
Returns:	The fc_port_name of this HostPortLocation.
Return type:	str
	optional

ib_port_name¶

Gets the ib_port_name of this HostPortLocation. This field is present only if the type value is equal to IO_IF_IB.

Required/optional:
Returns:	The ib_port_name of this HostPortLocation.
Return type:	str
	optional

io_interface_type¶

Gets the io_interface_type of this HostPortLocation. This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller.

Required/optional:
Returns:	The io_interface_type of this HostPortLocation.
Return type:	str
	required

sas_port_name¶

Gets the sas_port_name of this HostPortLocation. This field is present only if the type value is equal to IO_IF_SAS.

Required/optional:
Returns:	The sas_port_name of this HostPortLocation.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.host_port_mutable_properties module¶

HostPortMutableProperties.py

class netapp.santricity.models.symbol.host_port_mutable_properties.HostPortMutableProperties[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

host_ref¶

Gets the host_ref of this HostPortMutableProperties. Either an empty field (length indicator = 0) signifying no change, or the new value of the hostRef field used to associate the port with a host.

Required/optional:
Returns:	The host_ref of this HostPortMutableProperties.
Return type:	list[str]
	required

label¶

Gets the label of this HostPortMutableProperties. Either an empty field (length indicator = 0) signifying no change, or the new value of the user-assigned label for the port.r

Required/optional:
Returns:	The label of this HostPortMutableProperties.
Return type:	list[str]
	required

port_id¶

Gets the port_id of this HostPortMutableProperties. Either an empty field (length indicator = 0) signifying no change, or the new value of the I/O-protocol-based unique port identifier

Required/optional:
Returns:	The port_id of this HostPortMutableProperties.
Return type:	list[SCSIInitiatorPortId]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.host_port_properties_update_descriptor module¶

HostPortPropertiesUpdateDescriptor.py

class netapp.santricity.models.symbol.host_port_properties_update_descriptor.HostPortPropertiesUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

host_port_ref¶

Gets the host_port_ref of this HostPortPropertiesUpdateDescriptor. A reference to the affected host port.

Required/optional:
Returns:	The host_port_ref of this HostPortPropertiesUpdateDescriptor.
Return type:	str
	required

settings¶

Gets the settings of this HostPortPropertiesUpdateDescriptor. The new property settings for the host port.

Required/optional:
Returns:	The settings of this HostPortPropertiesUpdateDescriptor.
Return type:	HostPortMutableProperties
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.host_port_rename_descriptor module¶

HostPortRenameDescriptor.py

class netapp.santricity.models.symbol.host_port_rename_descriptor.HostPortRenameDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

host_port_name¶

Gets the host_port_name of this HostPortRenameDescriptor. The new world-wide name value for the HostPort object.

Required/optional:
Returns:	The host_port_name of this HostPortRenameDescriptor.
Return type:	str
	required

host_port_ref¶

Gets the host_port_ref of this HostPortRenameDescriptor. The unique identification value that identifies the HostPort to be modified.

Required/optional:
Returns:	The host_port_ref of this HostPortRenameDescriptor.
Return type:	str
	required

label¶

Gets the label of this HostPortRenameDescriptor. The new user-assigned label value for the HostPort object.

Required/optional:
Returns:	The label of this HostPortRenameDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.host_port_type_update_descriptor module¶

HostPortTypeUpdateDescriptor.py

class netapp.santricity.models.symbol.host_port_type_update_descriptor.HostPortTypeUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

host_port_ref¶

Gets the host_port_ref of this HostPortTypeUpdateDescriptor. The unique identification value that identifies the HostPort to be modified.

Required/optional:
Returns:	The host_port_ref of this HostPortTypeUpdateDescriptor.
Return type:	str
	required

host_port_type_index¶

Gets the host_port_type_index of this HostPortTypeUpdateDescriptor. The new index value that is to be used to identify the type of the HostPort object.

Required/optional:
Returns:	The host_port_type_index of this HostPortTypeUpdateDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.host_properties_update_descriptor module¶

HostPropertiesUpdateDescriptor.py

class netapp.santricity.models.symbol.host_properties_update_descriptor.HostPropertiesUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

host_ref¶

Gets the host_ref of this HostPropertiesUpdateDescriptor. A reference to the host to update.

Required/optional:
Returns:	The host_ref of this HostPropertiesUpdateDescriptor.
Return type:	str
	required

settings¶

Gets the settings of this HostPropertiesUpdateDescriptor. The new property settings for the host.

Required/optional:
Returns:	The settings of this HostPropertiesUpdateDescriptor.
Return type:	HostChangeableProperties
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.host_redundancy_loss_details module¶

HostRedundancyLossDetails.py

class netapp.santricity.models.symbol.host_redundancy_loss_details.HostRedundancyLossDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_ref¶

Gets the controller_ref of this HostRedundancyLossDetails. The host has lost connection to this controller.

Required/optional:
Returns:	The controller_ref of this HostRedundancyLossDetails.
Return type:	str
	required

host_ref¶

Gets the host_ref of this HostRedundancyLossDetails. The host that has lost redundant connection to the array.

Required/optional:
Returns:	The host_ref of this HostRedundancyLossDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.host_specific_nvsram_update_descriptor module¶

HostSpecificNVSRAMUpdateDescriptor.py

class netapp.santricity.models.symbol.host_specific_nvsram_update_descriptor.HostSpecificNVSRAMUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

host_index¶

Gets the host_index of this HostSpecificNVSRAMUpdateDescriptor. Host Type Index mapped by SPM.

Required/optional:
Returns:	The host_index of this HostSpecificNVSRAMUpdateDescriptor.
Return type:	int
	required

offset¶

Gets the offset of this HostSpecificNVSRAMUpdateDescriptor. The offset into the region to update.

Required/optional:
Returns:	The offset of this HostSpecificNVSRAMUpdateDescriptor.
Return type:	int
	required

region_data¶

Gets the region_data of this HostSpecificNVSRAMUpdateDescriptor. The data to write to NVSRAM.

Required/optional:
Returns:	The region_data of this HostSpecificNVSRAMUpdateDescriptor.
Return type:	str
	required

region_id¶

Gets the region_id of this HostSpecificNVSRAMUpdateDescriptor. The region of NVSRAM to update.

Required/optional:
Returns:	The region_id of this HostSpecificNVSRAMUpdateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.host_specific_values module¶

HostSpecificValues.py

class netapp.santricity.models.symbol.host_specific_values.HostSpecificValues[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

allow_preferred_owner_reporting_suppression¶

Gets the allow_preferred_owner_reporting_suppression of this HostSpecificValues. If true, the controller will suppress reporting the preferred owner in REPORT TARGET PORT GROUPS or INQUIRY VPD data in conditions when the preferred controller cannot process I/O.

Required/optional:
Returns:	The allow_preferred_owner_reporting_suppression of this HostSpecificValues.
Return type:	bool
	required

allow_reservation_on_unowned_lu_ns¶

Gets the allow_reservation_on_unowned_lu_ns of this HostSpecificValues. This value determines the controller response to Reservation/Release commands that are received for LUNs that are not owned by the controller.

Required/optional:
Returns:	The allow_reservation_on_unowned_lu_ns of this HostSpecificValues.
Return type:	bool
	required

asymmetric_lu_access¶

Gets the asymmetric_lu_access of this HostSpecificValues. If true, Asymmetric Logical Unit Access is enabled.

Required/optional:
Returns:	The asymmetric_lu_access of this HostSpecificValues.
Return type:	bool
	required

auto_lun_transfer¶

Gets the auto_lun_transfer of this HostSpecificValues. Auto Volume Transfer.

Required/optional:
Returns:	The auto_lun_transfer of this HostSpecificValues.
Return type:	bool
	required

avt_exclusion_extents_enabled¶

Gets the avt_exclusion_extents_enabled of this HostSpecificValues. Enable the AVT exclusion extents for this heterogeneous host region.

Required/optional:
Returns:	The avt_exclusion_extents_enabled of this HostSpecificValues.
Return type:	bool
	required

check_condition_for_vendor_unique_ua_conditions¶

Gets the check_condition_for_vendor_unique_ua_conditions of this HostSpecificValues. This value determines if the controller will report a vendor unique Unit Attention condition as a Check Condition status.

Required/optional:
Returns:	The check_condition_for_vendor_unique_ua_conditions of this HostSpecificValues.
Return type:	bool
	required

conditional_fc_logout¶

Gets the conditional_fc_logout of this HostSpecificValues. Conditional Fibre Channel Logout.

Required/optional:
Returns:	The conditional_fc_logout of this HostSpecificValues.
Return type:	bool
	required

disable_explicit_tpgs¶

Gets the disable_explicit_tpgs of this HostSpecificValues. If true, the standard INQUIRY data reporting TPGS support to the initiator will only indicate support for implicit mode (providing TPGS support is enabled, see tpgsSupported field).

Required/optional:
Returns:	The disable_explicit_tpgs of this HostSpecificValues.
Return type:	bool
	required

enable_auto_load_balance¶

Gets the enable_auto_load_balance of this HostSpecificValues. If true, the controller may issue volume ownership changes to balance IO load between controllers.

Required/optional:
Returns:	The enable_auto_load_balance of this HostSpecificValues.
Return type:	bool
	required

enable_lu_check_condition_parallel_responses¶

Gets the enable_lu_check_condition_parallel_responses of this HostSpecificValues. If true, array may return multiple CHECK CONDITION responses simultaneously on a given logical unit.

Required/optional:
Returns:	The enable_lu_check_condition_parallel_responses of this HostSpecificValues.
Return type:	bool
	required

enable_target_failback¶

Gets the enable_target_failback of this HostSpecificValues. If true, controller initiates fail-back of volumes to the preferred owner .

Required/optional:
Returns:	The enable_target_failback of this HostSpecificValues.
Return type:	bool
	required

force_scsi2¶

Gets the force_scsi2 of this HostSpecificValues. Report SCSI-2 Through Fibre Channel Host Interface.

Required/optional:
Returns:	The force_scsi2 of this HostSpecificValues.
Return type:	bool
	required

host_port_type¶

Gets the host_port_type of this HostSpecificValues. The host type.

Required/optional:
Returns:	The host_port_type of this HostSpecificValues.
Return type:	str
	required

host_type¶

Gets the host_type of this HostSpecificValues. The host type string. A zero-length string is allowed and indicates that the associated host-specific NVSRAM region has been cleared. This field should be used in place of the deprecated hostPortType field.

Required/optional:
Returns:	The host_type of this HostSpecificValues.
Return type:	str
	required

ignore_force_unit_access¶

Gets the ignore_force_unit_access of this HostSpecificValues. This value determines controller treatment of the Force Unit Access Option in the SCSI Read(10) and Write(10) commands.

Required/optional:
Returns:	The ignore_force_unit_access of this HostSpecificValues.
Return type:	bool
	required

ignore_iscsi_session_id_in_itn¶

Gets the ignore_iscsi_session_id_in_itn of this HostSpecificValues. If true, the array iSCSI target driver will not use the session identifier as part of its internal I_T Nexus identifiers. This reduces churn in I_T Nexus identifiers if the initiator does not re-use iSCSI session identifiers when re-opening a session.

Required/optional:
Returns:	The ignore_iscsi_session_id_in_itn of this HostSpecificValues.
Return type:	bool
	required

ignore_sync_cache¶

Gets the ignore_sync_cache of this HostSpecificValues. Ignore Cache Sync Command.

Required/optional:
Returns:	The ignore_sync_cache of this HostSpecificValues.
Return type:	bool
	required

ignore_utm_lun_ownership¶

Gets the ignore_utm_lun_ownership of this HostSpecificValues. Ignore UTM LUN Ownership.

Required/optional:
Returns:	The ignore_utm_lun_ownership of this HostSpecificValues.
Return type:	bool
	required

ignore_write_cache_disable¶

Gets the ignore_write_cache_disable of this HostSpecificValues. This value determines if the controller will allow the resetting of the WCE bit in the Mode Select Caching Page to disable write caching.

Required/optional:
Returns:	The ignore_write_cache_disable of this HostSpecificValues.
Return type:	bool
	required

inquiry_unconfigured_device_type¶

Gets the inquiry_unconfigured_device_type of this HostSpecificValues. The value returned in the Inquiry Device Type Field when an unconfigured LUN is accessed.

Required/optional:
Returns:	The inquiry_unconfigured_device_type of this HostSpecificValues.
Return type:	str
	required

inquiry_unowned_device_type¶

Gets the inquiry_unowned_device_type of this HostSpecificValues. This value is used to define the device type the controller should return in the first byte of the Inquiry data, if the addressed logical unit is not owned by the addressed controller.

Required/optional:
Returns:	The inquiry_unowned_device_type of this HostSpecificValues.
Return type:	str
	required

max_restricted_lu_ns¶

Gets the max_restricted_lu_ns of this HostSpecificValues. Maximum number of LUNs allowed for host type.

Required/optional:
Returns:	The max_restricted_lu_ns of this HostSpecificValues.
Return type:	int
	required

not_ready_sense_for_quiescence_in_progress¶

Gets the not_ready_sense_for_quiescence_in_progress of this HostSpecificValues. This value determines the response of the controller to commands received during the ‘controller quiesced’ state.

Required/optional:
Returns:	The not_ready_sense_for_quiescence_in_progress of this HostSpecificValues.
Return type:	bool
	required

not_ready_sense_for_quiescence_in_progress2¶

Gets the not_ready_sense_for_quiescence_in_progress2 of this HostSpecificValues. This value determines the response of the controller to commands received during the ‘controller quiesced’ state.

Required/optional:
Returns:	The not_ready_sense_for_quiescence_in_progress2 of this HostSpecificValues.
Return type:	bool
	required

persistent_id¶

Gets the persistent_id of this HostSpecificValues. Unique identifier for this specific host type. This value is stored in the controller configuration database when persisting Host objects in order to uniquely identify this specific host type across all NVSRAM builds.

Required/optional:
Returns:	The persistent_id of this HostSpecificValues.
Return type:	int
	required

propagate_host_bus_resets¶

Gets the propagate_host_bus_resets of this HostSpecificValues. This value determines whether the controller will propagate a Host Bus Reset/Target Reset/Logical Unit Reset to the other controller in a dual controller subsystem to support Microsoft Clustering Services.

Required/optional:
Returns:	The propagate_host_bus_resets of this HostSpecificValues.
Return type:	bool
	required

quiescence_in_progress_asc¶

Gets the quiescence_in_progress_asc of this HostSpecificValues. Additional Sense Code returned to host for Quiescence In Progress Check Conditions.

Required/optional:
Returns:	The quiescence_in_progress_asc of this HostSpecificValues.
Return type:	int
	required

quiescence_in_progress_ascq¶

Gets the quiescence_in_progress_ascq of this HostSpecificValues. Additional Sense Code Qualifier returned to host for Quiscence In Progress Check Conditions.

Required/optional:
Returns:	The quiescence_in_progress_ascq of this HostSpecificValues.
Return type:	int
	required

quiescence_in_progress_sense_key¶

Gets the quiescence_in_progress_sense_key of this HostSpecificValues. Sense Key returned to host for Quiescence In Progress Check Conditions.

Required/optional:
Returns:	The quiescence_in_progress_sense_key of this HostSpecificValues.
Return type:	int
	required

report_deferred_errors¶

Gets the report_deferred_errors of this HostSpecificValues. This value is used to determine how deferred errors are reported to the host.

Required/optional:
Returns:	The report_deferred_errors of this HostSpecificValues.
Return type:	bool
	required

report_lun_preferred_path_in_standard_inquiry¶

Gets the report_lun_preferred_path_in_standard_inquiry of this HostSpecificValues. Report LUN Preferred Path in Standard Inquiry Data.

Required/optional:
Returns:	The report_lun_preferred_path_in_standard_inquiry of this HostSpecificValues.
Return type:	bool
	required

report_scc_device_enable¶

Gets the report_scc_device_enable of this HostSpecificValues. Report SCC Device Enable.

Required/optional:
Returns:	The report_scc_device_enable of this HostSpecificValues.
Return type:	bool
	required

report_unconfigured_lu_ns¶

Gets the report_unconfigured_lu_ns of this HostSpecificValues. This value determines the LUN data returned by the Report LUNs command.

Required/optional:
Returns:	The report_unconfigured_lu_ns of this HostSpecificValues.
Return type:	bool
	required

reserved1¶

Gets the reserved1 of this HostSpecificValues.

Required/optional:
Returns:	The reserved1 of this HostSpecificValues.
Return type:	str
	optional

restricted_lun0¶

Gets the restricted_lun0 of this HostSpecificValues. If true, LUN 0 is restricted and volume mapping to LUN 0 will not be allowed or be reported in the REPORT LUNS data. If false, a volume-to-LUN mapping can be created to LUN 0 and will be reported in a REPORT LUNS response.

Required/optional:
Returns:	The restricted_lun0 of this HostSpecificValues.
Return type:	bool
	required

retain_logins¶

Gets the retain_logins of this HostSpecificValues. This field is deprecated.

Required/optional:
Returns:	The retain_logins of this HostSpecificValues.
Return type:	bool
	required

suppress_vol_off_preferred_path_alert¶

Gets the suppress_vol_off_preferred_path_alert of this HostSpecificValues. If true, then volume-off-preferred events are not considered critical.

Required/optional:
Returns:	The suppress_vol_off_preferred_path_alert of this HostSpecificValues.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tpgs_supported¶

Gets the tpgs_supported of this HostSpecificValues. This field is set to true if Target Port Group Support is provided; otherwise it is false.

Required/optional:
Returns:	The tpgs_supported of this HostSpecificValues.
Return type:	bool
	required

unowned_block0_read¶

Gets the unowned_block0_read of this HostSpecificValues. This value is used to define how the controller handles a read request to Block 0 of an unowned volume. When this is enabled, the non-owning controller sends a request for the block 0 data to the owning controller and the owning controller sends the requested block 0 data back to the non-owning controller. If disabled, the controller will do a volume transfer (if AVT is enabled) and then a read of the now owned volume.

Required/optional:
Returns:	The unowned_block0_read of this HostSpecificValues.
Return type:	str
	required

unowned_check_condition_during_fw_activation¶

Gets the unowned_check_condition_during_fw_activation of this HostSpecificValues. If true, controller will return a LUN NOT OWNED (05h/94h/01h) CHECK CONDITION when unable to handle I/O during firmware activation.

Required/optional:
Returns:	The unowned_check_condition_during_fw_activation of this HostSpecificValues.
Return type:	bool
	required

use_page2_c_quiescence_timeout¶

Gets the use_page2_c_quiescence_timeout of this HostSpecificValues. The quiescence timeout is the amount of time the controller should wait to achieve a “no I/Os active” state before invoking a forced transfer of LUN ownership. When this field is set to true, the timeout parameter provided by the host initiator in a mode select Page 2C will be used. When this field is set to false, the timeout value applied will be calculated by the controller.

Required/optional:
Returns:	The use_page2_c_quiescence_timeout of this HostSpecificValues.
Return type:	bool
	required

volume_format_options¶

Gets the volume_format_options of this HostSpecificValues. If true, a format unit request will interrupt any in-progress IAF and start a write-zeros initialization. If false, the format unit will be returned with no action.

Required/optional:
Returns:	The volume_format_options of this HostSpecificValues.
Return type:	bool
	required

wait_for_download¶

Gets the wait_for_download of this HostSpecificValues. The download microcode status control.

Required/optional:
Returns:	The wait_for_download of this HostSpecificValues.
Return type:	bool
	required

world_wide_name_in_standard_inquiry¶

Gets the world_wide_name_in_standard_inquiry of this HostSpecificValues. Set to true if the WWN is in the standard inquiry data.

Required/optional:
Returns:	The world_wide_name_in_standard_inquiry of this HostSpecificValues.
Return type:	bool
	required

netapp.santricity.models.symbol.hot_spare_candidate module¶

HotSpareCandidate.py

class netapp.santricity.models.symbol.hot_spare_candidate.HotSpareCandidate[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_ref¶

Gets the drive_ref of this HotSpareCandidate. The hot spare candidate (unassigned).

Required/optional:
Returns:	The drive_ref of this HotSpareCandidate.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_group_ref_list¶

Gets the volume_group_ref_list of this HotSpareCandidate. The volume groups the drive can cover.

Required/optional:
Returns:	The volume_group_ref_list of this HotSpareCandidate.
Return type:	VolumeGroupRefList
	required

netapp.santricity.models.symbol.hot_spare_candidate_list module¶

HotSpareCandidateList.py

class netapp.santricity.models.symbol.hot_spare_candidate_list.HotSpareCandidateList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

hot_spare_candidate¶

Gets the hot_spare_candidate of this HotSpareCandidateList. A list of hot spare candidates.

Required/optional:
Returns:	The hot_spare_candidate of this HotSpareCandidateList.
Return type:	list[HotSpareCandidate]
	required

return_code¶

Gets the return_code of this HotSpareCandidateList. The return code from the getHotSpareCandidates API.

Required/optional:
Returns:	The return_code of this HotSpareCandidateList.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.hot_spare_coverage module¶

HotSpareCoverage.py

class netapp.santricity.models.symbol.hot_spare_coverage.HotSpareCoverage[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_ref¶

Gets the drive_ref of this HotSpareCoverage. The hot spare drive.

Required/optional:
Returns:	The drive_ref of this HotSpareCoverage.
Return type:	str
	required

in_use¶

Gets the in_use of this HotSpareCoverage. True, if hot spare is in use.

Required/optional:
Returns:	The in_use of this HotSpareCoverage.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_group_ref_list¶

Gets the volume_group_ref_list of this HotSpareCoverage. The volume groups covered by the drive.

Required/optional:
Returns:	The volume_group_ref_list of this HotSpareCoverage.
Return type:	VolumeGroupRefList
	required

netapp.santricity.models.symbol.hot_spare_coverage_list module¶

HotSpareCoverageList.py

class netapp.santricity.models.symbol.hot_spare_coverage_list.HotSpareCoverageList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

hot_spare_coverage¶

Gets the hot_spare_coverage of this HotSpareCoverageList. A list of the hot spare drives and the volume groups they cover.

Required/optional:
Returns:	The hot_spare_coverage of this HotSpareCoverageList.
Return type:	list[HotSpareCoverage]
	required

return_code¶

Gets the return_code of this HotSpareCoverageList. The return code from the getHotSpareCoverage API.

Required/optional:
Returns:	The return_code of this HotSpareCoverageList.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ib_baselined_statistics module¶

IbBaselinedStatistics.py

class netapp.santricity.models.symbol.ib_baselined_statistics.IbBaselinedStatistics[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ib_interface_statistics_raw¶

Gets the ib_interface_statistics_raw of this IbBaselinedStatistics. An array of structures containing “raw” (i.e., baseline = controller start-of-day) InfiniBand host interface statistics, one structure per InfiniBand interface.

Required/optional:
Returns:	The ib_interface_statistics_raw of this IbBaselinedStatistics.
Return type:	list[IbInterfaceStatistics]
	required

ib_interface_statistics_rel¶

Gets the ib_interface_statistics_rel of this IbBaselinedStatistics. An array of structures containing “relative” (i.e., baseline = user pre-set baseline) InfiniBand host interface statistics, one structure per InfiniBand interface.

Required/optional:
Returns:	The ib_interface_statistics_rel of this IbBaselinedStatistics.
Return type:	list[IbInterfaceStatistics]
	required

time_data¶

Gets the time_data of this IbBaselinedStatistics. The time data associated with this set of statistics.

Required/optional:
Returns:	The time_data of this IbBaselinedStatistics.
Return type:	StatisticalTimeData
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ib_interface module¶

IbInterface.py

class netapp.santricity.models.symbol.ib_interface.IbInterface[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

bidirectional_max_rate¶

Gets the bidirectional_max_rate of this IbInterface. Maximum bi-directional data rate in B/s

Required/optional:
Returns:	The bidirectional_max_rate of this IbInterface.
Return type:	int
	required

channel¶

Gets the channel of this IbInterface. The number of the host channel associated with this interface.

Required/optional:
Returns:	The channel of this IbInterface.
Return type:	int
	required

channel_port_ref¶

Gets the channel_port_ref of this IbInterface. A reference to the channel port for the channel associated with this interface.

Required/optional:
Returns:	The channel_port_ref of this IbInterface.
Return type:	str
	required

current_data_virtual_lanes¶

Gets the current_data_virtual_lanes of this IbInterface. The number of data virtual lanes that are currently active for this interface.

Required/optional:
Returns:	The current_data_virtual_lanes of this IbInterface.
Return type:	int
	required

current_link_width¶

Gets the current_link_width of this IbInterface. The width at which the link is currently operating, e.g., 1 means “1X,” 4 means “4X,”.etc.

Required/optional:
Returns:	The current_link_width of this IbInterface.
Return type:	str
	required

current_speed¶

Gets the current_speed of this IbInterface. The speed at which the interface is currently operating.

Required/optional:
Returns:	The current_speed of this IbInterface.
Return type:	str
	required

global_identifier¶

Gets the global_identifier of this IbInterface. The InfiniBand global identifier associated with this interface.

Required/optional:
Returns:	The global_identifier of this IbInterface.
Return type:	str
	required

id¶

Gets the id of this IbInterface.

Required/optional:
Returns:	The id of this IbInterface.
Return type:	str
	optional

interface_ref¶

Gets the interface_ref of this IbInterface. The opaque data by which an instance of IbInterface is uniquely identified.

Required/optional:
Returns:	The interface_ref of this IbInterface.
Return type:	str
	required

is_iser_supported¶

Gets the is_iser_supported of this IbInterface. This flag is true if iSER (iSCSI Extensions for RDMA) is currently supported.

Required/optional:
Returns:	The is_iser_supported of this IbInterface.
Return type:	bool
	required

is_srp_supported¶

Gets the is_srp_supported of this IbInterface. This flag is true if SRP (SCSI RDMA Protocol) is currently supported.

Required/optional:
Returns:	The is_srp_supported of this IbInterface.
Return type:	bool
	required

link_state¶

Gets the link_state of this IbInterface. The state of the InfiniBand link.

Required/optional:
Returns:	The link_state of this IbInterface.
Return type:	str
	required

local_identifier¶

Gets the local_identifier of this IbInterface. The InfiniBand local identifier associated with this interface.

Required/optional:
Returns:	The local_identifier of this IbInterface.
Return type:	int
	required

maximum_data_virtual_lanes¶

Gets the maximum_data_virtual_lanes of this IbInterface. The maximum number of data virtual lanes supported by the interface.

Required/optional:
Returns:	The maximum_data_virtual_lanes of this IbInterface.
Return type:	int
	required

maximum_transmission_unit¶

Gets the maximum_transmission_unit of this IbInterface. The size in bytes of the largest packet that the interface can transmit.

Required/optional:
Returns:	The maximum_transmission_unit of this IbInterface.
Return type:	int
	required

one_way_max_rate¶

Gets the one_way_max_rate of this IbInterface. Maximum one way data rate in B/s

Required/optional:
Returns:	The one_way_max_rate of this IbInterface.
Return type:	int
	required

phys_port_state¶

Gets the phys_port_state of this IbInterface. This element contains the current state of the physical Infiniband port.

Required/optional:
Returns:	The phys_port_state of this IbInterface.
Return type:	str
	required

physical_location¶

Gets the physical_location of this IbInterface. The physical location of the Infiniband interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying “1st Infiniband interface relative to the parent,” “2nd Infiniband interface relative to the parent,” etc. This “interface number” is independent of the interface’s channel association.

Required/optional:
Returns:	The physical_location of this IbInterface.
Return type:	Location
	required

port_state¶

Gets the port_state of this IbInterface. The state of the InfiniBand port.

Required/optional:
Returns:	The port_state of this IbInterface.
Return type:	str
	required

protection_information_capable¶

Gets the protection_information_capable of this IbInterface. This field indicates whether or not the I/O interface is PI capable.

Required/optional:
Returns:	The protection_information_capable of this IbInterface.
Return type:	bool
	required

supported_link_width¶

Gets the supported_link_width of this IbInterface. An array containing the different link widths at which the link is capable of operating.

Required/optional:
Returns:	The supported_link_width of this IbInterface.
Return type:	list[str]
	required

supported_speed¶

Gets the supported_speed of this IbInterface. An array containing the different speeds at which the interface is capable of operating.

Required/optional:
Returns:	The supported_speed of this IbInterface.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ib_interface_statistics module¶

IbInterfaceStatistics.py

class netapp.santricity.models.symbol.ib_interface_statistics.IbInterfaceStatistics[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

interface_ref¶

Gets the interface_ref of this IbInterfaceStatistics. A reference to the interface for which the statistics apply.

Required/optional:
Returns:	The interface_ref of this IbInterfaceStatistics.
Return type:	str
	required

recovered_link_errors¶

Gets the recovered_link_errors of this IbInterfaceStatistics. The number of recovered link errors.

Required/optional:
Returns:	The recovered_link_errors of this IbInterfaceStatistics.
Return type:	int
	required

rx_constraint_error_packet_discards¶

Gets the rx_constraint_error_packet_discards of this IbInterfaceStatistics. The number of inbound packets discarded because either (1) the packet is a raw datagram, (2) the packet has a wrong partition key, or (3) the packet has a bad transport header version.

Required/optional:
Returns:	The rx_constraint_error_packet_discards of this IbInterfaceStatistics.
Return type:	int
	required

rx_ebp_delimited_packets¶

Gets the rx_ebp_delimited_packets of this IbInterfaceStatistics. The total number of packets with End Bad Packet delimiter that have been received on the port.

Required/optional:
Returns:	The rx_ebp_delimited_packets of this IbInterfaceStatistics.
Return type:	int
	required

rx_multicast_total_packets¶

Gets the rx_multicast_total_packets of this IbInterfaceStatistics. Total number of multicast packets, including multicast packets containing errors received from all VLs on the port.

Required/optional:
Returns:	The rx_multicast_total_packets of this IbInterfaceStatistics.
Return type:	int
	required

rx_packet_errors¶

Gets the rx_packet_errors of this IbInterfaceStatistics. The number of packets containing an error that have been received on the port.

Required/optional:
Returns:	The rx_packet_errors of this IbInterfaceStatistics.
Return type:	int
	required

rx_subnet_management_dropped_packets¶

Gets the rx_subnet_management_dropped_packets of this IbInterfaceStatistics. The number of virtual lane 15 packets dropped due to resource limitations (e.g., lack of buffers) in the port.

Required/optional:
Returns:	The rx_subnet_management_dropped_packets of this IbInterfaceStatistics.
Return type:	int
	required

rx_total_bytes¶

Gets the rx_total_bytes of this IbInterfaceStatistics. The number of bytes received at the port on all virtual lanes.

Required/optional:
Returns:	The rx_total_bytes of this IbInterfaceStatistics.
Return type:	int
	required

rx_total_packets¶

Gets the rx_total_packets of this IbInterfaceStatistics. The number of packets received at the port on all virtual lanes.

Required/optional:
Returns:	The rx_total_packets of this IbInterfaceStatistics.
Return type:	int
	required

rx_unicast_total_packets¶

Gets the rx_unicast_total_packets of this IbInterfaceStatistics. Total number of unicast packets, including unicast packets containing errors, and excluding link packets, received from all VLs on the port.

Required/optional:
Returns:	The rx_unicast_total_packets of this IbInterfaceStatistics.
Return type:	int
	required

symbol_errors¶

Gets the symbol_errors of this IbInterfaceStatistics. The number of symbol errors.

Required/optional:
Returns:	The symbol_errors of this IbInterfaceStatistics.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tx_constraint_error_packet_discards¶

Gets the tx_constraint_error_packet_discards of this IbInterfaceStatistics. The number of outbound packets discarded because either (1) the packet is a raw datagram, (2) the packet has a wrong partition key, or (3) the packet has a bad transport header version.

Required/optional:
Returns:	The tx_constraint_error_packet_discards of this IbInterfaceStatistics.
Return type:	int
	required

tx_multicast_total_packets¶

Gets the tx_multicast_total_packets of this IbInterfaceStatistics. Total number of multicast packets transmitted on all VLs from the port. This may include multicast packets with errors.

Required/optional:
Returns:	The tx_multicast_total_packets of this IbInterfaceStatistics.
Return type:	int
	required

tx_port_down_packet_discards¶

Gets the tx_port_down_packet_discards of this IbInterfaceStatistics. The number of outbound packets discarded because the port is either down or congested.

Required/optional:
Returns:	The tx_port_down_packet_discards of this IbInterfaceStatistics.
Return type:	int
	required

tx_total_bytes¶

Gets the tx_total_bytes of this IbInterfaceStatistics. The number of bytes transmitted at the port on all virtual lanes.

Required/optional:
Returns:	The tx_total_bytes of this IbInterfaceStatistics.
Return type:	int
	required

tx_total_packets¶

Gets the tx_total_packets of this IbInterfaceStatistics. The number of packets transmitted at the port on all virtual lanes.

Required/optional:
Returns:	The tx_total_packets of this IbInterfaceStatistics.
Return type:	int
	required

tx_unicast_total_packets¶

Gets the tx_unicast_total_packets of this IbInterfaceStatistics. Total number of unicast packets transmitted on all VLs from the port. This may include unicast packets with errors and excludes link packets.

Required/optional:
Returns:	The tx_unicast_total_packets of this IbInterfaceStatistics.
Return type:	int
	required

tx_wait_time¶

Gets the tx_wait_time of this IbInterfaceStatistics. The number of microseconds during which the port had data to transmit, but none was sent because of insufficient credits or due to arbitration.

Required/optional:
Returns:	The tx_wait_time of this IbInterfaceStatistics.
Return type:	int
	required

unrecovered_link_errors¶

Gets the unrecovered_link_errors of this IbInterfaceStatistics. The number of unrecovered link errors.

Required/optional:
Returns:	The unrecovered_link_errors of this IbInterfaceStatistics.
Return type:	int
	required

netapp.santricity.models.symbol.ib_ioc_attributes module¶

IbIocAttributes.py

class netapp.santricity.models.symbol.ib_ioc_attributes.IbIocAttributes[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

host_board_ref¶

Gets the host_board_ref of this IbIocAttributes. A reference to the host board (a.k.a., InfiniBand Target Channel Adapter) with which the I/O controller is associated.

Required/optional:
Returns:	The host_board_ref of this IbIocAttributes.
Return type:	str
	required

ioc_profile¶

Gets the ioc_profile of this IbIocAttributes. The I/O controller profile for the storage array controller.

Required/optional:
Returns:	The ioc_profile of this IbIocAttributes.
Return type:	IbIocProfile
	required

service_entries¶

Gets the service_entries of this IbIocAttributes. An array of structures indicating the services that are provided by the InfiniBand I/O controller.

Required/optional:
Returns:	The service_entries of this IbIocAttributes.
Return type:	list[IbServiceEntry]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ib_ioc_attributes_returned module¶

IbIocAttributesReturned.py

class netapp.santricity.models.symbol.ib_ioc_attributes_returned.IbIocAttributesReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ioc_attributes¶

Gets the ioc_attributes of this IbIocAttributesReturned. An array of InfiniBand I/O controller attributes for the storage array, one entry for each InfiniBand I/O controller that is part of the storage array. An individual set of attributes consists of the I/O controller profile and the list of services that the controller provides. This field is only present when returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The ioc_attributes of this IbIocAttributesReturned.
Return type:	list[IbIocAttributes]
	optional

return_code¶

Gets the return_code of this IbIocAttributesReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this IbIocAttributesReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ib_ioc_profile module¶

IbIocProfile.py

class netapp.santricity.models.symbol.ib_ioc_profile.IbIocProfile[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_ops_capability_mask¶

Gets the controller_ops_capability_mask of this IbIocProfile. Supported operation types of this controller.: Bit 0 on = Send Messages to IOCs Bit 1 on = Send Messages from IOCs Bit 2 on = RDMA Read Requests to IOCs Bit 3 on = RDMA Read Requests from IOCs Bit 4 on = RDMA Write Requests to IOCs Bit 5 on = RDMA Write Requests from IOCs Bit 6 on = Atomic operations to IOCs Bit 7 on = Atomic operations from IOCs

Required/optional:
Returns:	The controller_ops_capability_mask of this IbIocProfile.
Return type:	int
	required

device_version¶

Gets the device_version of this IbIocProfile. A number assigned by the vendor to identify the device version.

Required/optional:
Returns:	The device_version of this IbIocProfile.
Return type:	int
	required

id_string¶

Gets the id_string of this IbIocProfile. A UTF-8 encoded string for identifying the controller to user.

Required/optional:
Returns:	The id_string of this IbIocProfile.
Return type:	str
	required

io_class¶

Gets the io_class of this IbIocProfile. The I/O class of the controller. 0x0000 -0xFFFE is reserved for I/O classes encompassed by the InfiniBand architecture. 0xFFFF is vendor-specific.

Required/optional:
Returns:	The io_class of this IbIocProfile.
Return type:	int
	required

io_device_id¶

Gets the io_device_id of this IbIocProfile. A number assigned by vendor to identify the type of I/O controller

Required/optional:
Returns:	The io_device_id of this IbIocProfile.
Return type:	int
	required

io_subclass¶

Gets the io_subclass of this IbIocProfile. The I/O sub-class of the controller. 0x0000 -0xFFFE is reserved for I/O sub-classes encompassed by the InfiniBand architecture. 0xFFFF is vendor-specific.

Required/optional:
Returns:	The io_subclass of this IbIocProfile.
Return type:	int
	required

ioc_guid¶

Gets the ioc_guid of this IbIocProfile. The EUI-64 GUID used to uniquely identify the I/O controller.

Required/optional:
Returns:	The ioc_guid of this IbIocProfile.
Return type:	str
	required

protocol¶

Gets the protocol of this IbIocProfile. The I/O protocol of the controller. 0x0000 -0xFFFE is reserved for I/O protocols encompassed by the InfiniBand architecture. 0xFFFF is vendor-specific.

Required/optional:
Returns:	The protocol of this IbIocProfile.
Return type:	int
	required

protocol_version¶

Gets the protocol_version of this IbIocProfile. The protocol version (protocol-specific).

Required/optional:
Returns:	The protocol_version of this IbIocProfile.
Return type:	int
	required

rdma_read_queue_depth¶

Gets the rdma_read_queue_depth of this IbIocProfile. The maximum depth of the per-channel RDMA Read Queue

Required/optional:
Returns:	The rdma_read_queue_depth of this IbIocProfile.
Return type:	int
	required

rdma_transfer_size¶

Gets the rdma_transfer_size of this IbIocProfile. The maximum size of outbound RDMA transfers initiated by the controller.

Required/optional:
Returns:	The rdma_transfer_size of this IbIocProfile.
Return type:	int
	required

send_message_queue_depth¶

Gets the send_message_queue_depth of this IbIocProfile. The maximum depth of the Send Message Queue.

Required/optional:
Returns:	The send_message_queue_depth of this IbIocProfile.
Return type:	int
	required

send_message_size¶

Gets the send_message_size of this IbIocProfile. The maximum size of Send Messages in bytes.

Required/optional:
Returns:	The send_message_size of this IbIocProfile.
Return type:	int
	required

service_entries¶

Gets the service_entries of this IbIocProfile. The number of entries in the service entries table

Required/optional:
Returns:	The service_entries of this IbIocProfile.
Return type:	int
	required

subsystem_id¶

Gets the subsystem_id of this IbIocProfile. A number identifying the subsystem where the I/O controller resides.

Required/optional:
Returns:	The subsystem_id of this IbIocProfile.
Return type:	int
	required

subsystem_vendor_id¶

Gets the subsystem_vendor_id of this IbIocProfile. The ID of the enclosure vendor in IEEE format, or else all zeros if there is no vendor ID.

Required/optional:
Returns:	The subsystem_vendor_id of this IbIocProfile.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

vendor_id¶

Gets the vendor_id of this IbIocProfile. The I/O controller vendor ID in IEEE format.

Required/optional:
Returns:	The vendor_id of this IbIocProfile.
Return type:	str
	required

netapp.santricity.models.symbol.ib_point_in_time_statistics module¶

IbPointInTimeStatistics.py

class netapp.santricity.models.symbol.ib_point_in_time_statistics.IbPointInTimeStatistics[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ib_rdma_channel_statistics¶

Gets the ib_rdma_channel_statistics of this IbPointInTimeStatistics. An array of structures containing the IB RDMA channel statistics, one structure per RDMA channel.

Required/optional:
Returns:	The ib_rdma_channel_statistics of this IbPointInTimeStatistics.
Return type:	list[IbRdmaChannelStatistics]
	required

ib_tca_statistics¶

Gets the ib_tca_statistics of this IbPointInTimeStatistics. An array of structures containing the IB TCA statistics, one structure per TCA (i.e., InfiniBand host board).

Required/optional:
Returns:	The ib_tca_statistics of this IbPointInTimeStatistics.
Return type:	list[IbTcaStatistics]
	required

time_of_reading¶

Gets the time_of_reading of this IbPointInTimeStatistics. A timestamp, expressed as number of seconds since midnight GMT on January 1, 1970, which is the time at which the statistics were read by the controller firmware.

Required/optional:
Returns:	The time_of_reading of this IbPointInTimeStatistics.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ib_port_partition_table module¶

IbPortPartitionTable.py

class netapp.santricity.models.symbol.ib_port_partition_table.IbPortPartitionTable[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_ref¶

Gets the controller_ref of this IbPortPartitionTable. A reference to the controller that is associated with the port described by this structure.

Required/optional:
Returns:	The controller_ref of this IbPortPartitionTable.
Return type:	str
	required

pkeys¶

Gets the pkeys of this IbPortPartitionTable. An array containing the partition keys for the port.

Required/optional:
Returns:	The pkeys of this IbPortPartitionTable.
Return type:	list[int]
	required

port_guid¶

Gets the port_guid of this IbPortPartitionTable. The globally-unique identifier associated with the port.

Required/optional:
Returns:	The port_guid of this IbPortPartitionTable.
Return type:	str
	required

port_number¶

Gets the port_number of this IbPortPartitionTable. The controller-relative number of the port for which the table applies.

Required/optional:
Returns:	The port_number of this IbPortPartitionTable.
Return type:	int
	required

tca_guid¶

Gets the tca_guid of this IbPortPartitionTable. The globally-unique identifier of the Target Channel Adapter that controls the port.

Required/optional:
Returns:	The tca_guid of this IbPortPartitionTable.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ib_port_partition_tables_returned module¶

IbPortPartitionTablesReturned.py

class netapp.santricity.models.symbol.ib_port_partition_tables_returned.IbPortPartitionTablesReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

port_partition_tables¶

Gets the port_partition_tables of this IbPortPartitionTablesReturned. An array of InfiniBand port partition tables, one table per InfiniBand port. This field is only present when returnCode equals RETCODE_OK.

Required/optional:
Returns:	The port_partition_tables of this IbPortPartitionTablesReturned.
Return type:	list[IbPortPartitionTable]
	optional

return_code¶

Gets the return_code of this IbPortPartitionTablesReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this IbPortPartitionTablesReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ib_rdma_channel module¶

IbRdmaChannel.py

class netapp.santricity.models.symbol.ib_rdma_channel.IbRdmaChannel[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel_state¶

Gets the channel_state of this IbRdmaChannel. The current state of this RDMA channel.

Required/optional:
Returns:	The channel_state of this IbRdmaChannel.
Return type:	str
	required

endpoints¶

Gets the endpoints of this IbRdmaChannel. This field identifies the RDMA channel by identifying its initiator and target endpoints.

Required/optional:
Returns:	The endpoints of this IbRdmaChannel.
Return type:	IbRdmaChannelEndpoints
	required

maximum_queue_depth¶

Gets the maximum_queue_depth of this IbRdmaChannel. The maximum supported queue depth for this RDMA channel.

Required/optional:
Returns:	The maximum_queue_depth of this IbRdmaChannel.
Return type:	int
	required

maximum_rdma_message_size¶

Gets the maximum_rdma_message_size of this IbRdmaChannel. The maximum supported RDMA message size or this RDMA channel.

Required/optional:
Returns:	The maximum_rdma_message_size of this IbRdmaChannel.
Return type:	int
	required

path_maximum_transmission_unit¶

Gets the path_maximum_transmission_unit of this IbRdmaChannel. The maximum supported transmission unit for the path associated with the RDMA channel.

Required/optional:
Returns:	The path_maximum_transmission_unit of this IbRdmaChannel.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ib_rdma_channel_endpoints module¶

IbRdmaChannelEndpoints.py

class netapp.santricity.models.symbol.ib_rdma_channel_endpoints.IbRdmaChannelEndpoints[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

initiator_port_id¶

Gets the initiator_port_id of this IbRdmaChannelEndpoints. The InfiniBand global identifier of the initiator port.

Required/optional:
Returns:	The initiator_port_id of this IbRdmaChannelEndpoints.
Return type:	str
	required

target_channel_port¶

Gets the target_channel_port of this IbRdmaChannelEndpoints. A reference to the target channel port.

Required/optional:
Returns:	The target_channel_port of this IbRdmaChannelEndpoints.
Return type:	str
	required

target_port_id¶

Gets the target_port_id of this IbRdmaChannelEndpoints. The InfiniBand global identifier of the target port.

Required/optional:
Returns:	The target_port_id of this IbRdmaChannelEndpoints.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ib_rdma_channel_statistics module¶

IbRdmaChannelStatistics.py

class netapp.santricity.models.symbol.ib_rdma_channel_statistics.IbRdmaChannelStatistics[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

active_messages¶

Gets the active_messages of this IbRdmaChannelStatistics. The number of messages in-flight on the channel.

Required/optional:
Returns:	The active_messages of this IbRdmaChannelStatistics.
Return type:	int
	required

endpoints¶

Gets the endpoints of this IbRdmaChannelStatistics. A structure that identifies the RDMA channel by identifying its endpoints.

Required/optional:
Returns:	The endpoints of this IbRdmaChannelStatistics.
Return type:	IbRdmaChannelEndpoints
	required

maximum_observed_message_size¶

Gets the maximum_observed_message_size of this IbRdmaChannelStatistics. The maximum message size observed since the baseline time.

Required/optional:
Returns:	The maximum_observed_message_size of this IbRdmaChannelStatistics.
Return type:	int
	required

maximum_observed_queue_depth¶

Gets the maximum_observed_queue_depth of this IbRdmaChannelStatistics. The maximum queue depth observed since the baseline time.

Required/optional:
Returns:	The maximum_observed_queue_depth of this IbRdmaChannelStatistics.
Return type:	int
	required

messages_completed_with_error¶

Gets the messages_completed_with_error of this IbRdmaChannelStatistics. The number of RDMA completed with error on the channel.

Required/optional:
Returns:	The messages_completed_with_error of this IbRdmaChannelStatistics.
Return type:	int
	required

queued_messages¶

Gets the queued_messages of this IbRdmaChannelStatistics. The number of messages queued on the channel.

Required/optional:
Returns:	The queued_messages of this IbRdmaChannelStatistics.
Return type:	int
	required

rdma_ops_completed¶

Gets the rdma_ops_completed of this IbRdmaChannelStatistics. The number of RDMA operations completed on the channel.

Required/optional:
Returns:	The rdma_ops_completed of this IbRdmaChannelStatistics.
Return type:	int
	required

rdma_ops_started¶

Gets the rdma_ops_started of this IbRdmaChannelStatistics. The number of RDMA operations started on the channel.

Required/optional:
Returns:	The rdma_ops_started of this IbRdmaChannelStatistics.
Return type:	int
	required

rx_messages¶

Gets the rx_messages of this IbRdmaChannelStatistics. The number of messages received on the channel.

Required/optional:
Returns:	The rx_messages of this IbRdmaChannelStatistics.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tx_messages¶

Gets the tx_messages of this IbRdmaChannelStatistics. The number of messages transmitted on the channel.

Required/optional:
Returns:	The tx_messages of this IbRdmaChannelStatistics.
Return type:	int
	required

netapp.santricity.models.symbol.ib_rdma_channels_returned module¶

IbRdmaChannelsReturned.py

class netapp.santricity.models.symbol.ib_rdma_channels_returned.IbRdmaChannelsReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

rdma_channels¶

Gets the rdma_channels of this IbRdmaChannelsReturned. An array of structures containing information about an RDMA channel, one structure per currently-active channel. This field is only present when returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The rdma_channels of this IbRdmaChannelsReturned.
Return type:	list[IbRdmaChannel]
	optional

return_code¶

Gets the return_code of this IbRdmaChannelsReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this IbRdmaChannelsReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ib_service_entry module¶

IbServiceEntry.py

class netapp.santricity.models.symbol.ib_service_entry.IbServiceEntry[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

service_id¶

Gets the service_id of this IbServiceEntry. An identifier associated with the service

Required/optional:
Returns:	The service_id of this IbServiceEntry.
Return type:	str
	required

service_name¶

Gets the service_name of this IbServiceEntry. The UTF-8-encoded, name of the service

Required/optional:
Returns:	The service_name of this IbServiceEntry.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ib_statistical_data module¶

IbStatisticalData.py

class netapp.santricity.models.symbol.ib_statistical_data.IbStatisticalData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

baselined_stats¶

Gets the baselined_stats of this IbStatisticalData. InfiniBand counter-oriented statistics that are relative to a pre-set baseline.

Required/optional:
Returns:	The baselined_stats of this IbStatisticalData.
Return type:	IbBaselinedStatistics
	required

controller¶

Gets the controller of this IbStatisticalData. A reference to the controller that collected these statistics.

Required/optional:
Returns:	The controller of this IbStatisticalData.
Return type:	str
	required

pit_stats¶

Gets the pit_stats of this IbStatisticalData. InfiniBand statistical data that just consists of certain values that are read at the point in time the request is received.

Required/optional:
Returns:	The pit_stats of this IbStatisticalData.
Return type:	IbPointInTimeStatistics
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ib_statistics_returned module¶

IbStatisticsReturned.py

class netapp.santricity.models.symbol.ib_statistics_returned.IbStatisticsReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ib_statistics¶

Gets the ib_statistics of this IbStatisticsReturned. This field is an array of structures, one per controller, containing all InfiniBand statistical data for the storage array. It is only valid if returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The ib_statistics of this IbStatisticsReturned.
Return type:	list[IbStatisticalData]
	optional

return_code¶

Gets the return_code of this IbStatisticsReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this IbStatisticsReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ib_tca_statistics module¶

IbTcaStatistics.py

class netapp.santricity.models.symbol.ib_tca_statistics.IbTcaStatistics[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

average_depth_of_any_qpair¶

Gets the average_depth_of_any_qpair of this IbTcaStatistics. The average depth attained across all queue pairs of the TCA.

Required/optional:
Returns:	The average_depth_of_any_qpair of this IbTcaStatistics.
Return type:	int
	required

average_qpairs_used_simultaneously¶

Gets the average_qpairs_used_simultaneously of this IbTcaStatistics. The average number of queue pairs that were in use simultaneously.

Required/optional:
Returns:	The average_qpairs_used_simultaneously of this IbTcaStatistics.
Return type:	int
	required

host_board_ref¶

Gets the host_board_ref of this IbTcaStatistics. A reference to the host board for which the statistics apply.

Required/optional:
Returns:	The host_board_ref of this IbTcaStatistics.
Return type:	str
	required

maximum_depth_of_any_qpair¶

Gets the maximum_depth_of_any_qpair of this IbTcaStatistics. The maximum depth attained by any queue pair of the TCA.

Required/optional:
Returns:	The maximum_depth_of_any_qpair of this IbTcaStatistics.
Return type:	int
	required

maximum_qpairs_used_simultaneously¶

Gets the maximum_qpairs_used_simultaneously of this IbTcaStatistics. The maximum number of queue pairs that were in use simultaneously.

Required/optional:
Returns:	The maximum_qpairs_used_simultaneously of this IbTcaStatistics.
Return type:	int
	required

minimum_depth_of_any_qpair¶

Gets the minimum_depth_of_any_qpair of this IbTcaStatistics. The minimum depth attained by any queue pair of the TCA.

Required/optional:
Returns:	The minimum_depth_of_any_qpair of this IbTcaStatistics.
Return type:	int
	required

minimum_qpairs_used_simultaneously¶

Gets the minimum_qpairs_used_simultaneously of this IbTcaStatistics. The minimum number of queue pairs that were in use simultaneously.

Required/optional:
Returns:	The minimum_qpairs_used_simultaneously of this IbTcaStatistics.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.implementation_counter_group module¶

ImplementationCounterGroup.py

class netapp.santricity.models.symbol.implementation_counter_group.ImplementationCounterGroup[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

base_time¶

Gets the base_time of this ImplementationCounterGroup. The time that the counters were last reset. Time is the number of seconds since midnight, January 1, 1970.

Required/optional:
Returns:	The base_time of this ImplementationCounterGroup.
Return type:	int
	required

controller_ref¶

Gets the controller_ref of this ImplementationCounterGroup. A reference to the controller that accumulated the counters for this group.

Required/optional:
Returns:	The controller_ref of this ImplementationCounterGroup.
Return type:	str
	required

err_redundancy_chk_indeterminate_reads¶

Gets the err_redundancy_chk_indeterminate_reads of this ImplementationCounterGroup. The number of read requests for which the consistency of the redundancy data could not be determined, but for which the read was carried out to completion.

Required/optional:
Returns:	The err_redundancy_chk_indeterminate_reads of this ImplementationCounterGroup.
Return type:	int
	required

err_redundancy_chk_recovered_reads¶

Gets the err_redundancy_chk_recovered_reads of this ImplementationCounterGroup. The number of read requests that have experienced a redundancy group inconsistency that was subsequently recovered by retrying the consistency check.

Required/optional:
Returns:	The err_redundancy_chk_recovered_reads of this ImplementationCounterGroup.
Return type:	int
	required

err_redundancy_chk_unrecovered_reads¶

Gets the err_redundancy_chk_unrecovered_reads of this ImplementationCounterGroup. The number of read requests that have failed due to redundancy group inconsistencies.

Required/optional:
Returns:	The err_redundancy_chk_unrecovered_reads of this ImplementationCounterGroup.
Return type:	int
	required

flash_cache_read_hit_bytes¶

Gets the flash_cache_read_hit_bytes of this ImplementationCounterGroup. The number of flash cache read hit bytes.

Required/optional:
Returns:	The flash_cache_read_hit_bytes of this ImplementationCounterGroup.
Return type:	int
	required

flash_cache_read_hit_ops¶

Gets the flash_cache_read_hit_ops of this ImplementationCounterGroup. The number of flash cache read hit operations.

Required/optional:
Returns:	The flash_cache_read_hit_ops of this ImplementationCounterGroup.
Return type:	int
	required

flash_cache_read_hit_time_max¶

Gets the flash_cache_read_hit_time_max of this ImplementationCounterGroup. Maximum I/O time in microseconds for any one read I/O that has a cache hit.

Required/optional:
Returns:	The flash_cache_read_hit_time_max of this ImplementationCounterGroup.
Return type:	int
	required

flash_cache_read_hit_time_total¶

Gets the flash_cache_read_hit_time_total of this ImplementationCounterGroup. The sum of all response times for all reads that have cache hits, in microseconds.

Required/optional:
Returns:	The flash_cache_read_hit_time_total of this ImplementationCounterGroup.
Return type:	int
	required

flash_cache_read_hit_time_total_sq¶

Gets the flash_cache_read_hit_time_total_sq of this ImplementationCounterGroup. The sum of the squares of the response times for all reads that have cache hits, in microseconds (used for standard deviation).

Required/optional:
Returns:	The flash_cache_read_hit_time_total_sq of this ImplementationCounterGroup.
Return type:	int
	required

idle_time¶

Gets the idle_time of this ImplementationCounterGroup. The total time in microseconds spent idle since baseTime.

Required/optional:
Returns:	The idle_time of this ImplementationCounterGroup.
Return type:	int
	required

other_ops¶

Gets the other_ops of this ImplementationCounterGroup. The number of non-read-write operations.

Required/optional:
Returns:	The other_ops of this ImplementationCounterGroup.
Return type:	int
	required

other_time_max¶

Gets the other_time_max of this ImplementationCounterGroup. The maximum time in microseconds spent in any one non-read-write operation.

Required/optional:
Returns:	The other_time_max of this ImplementationCounterGroup.
Return type:	int
	required

other_time_total¶

Gets the other_time_total of this ImplementationCounterGroup. The total time in microseconds spent in non-read-write operations.

Required/optional:
Returns:	The other_time_total of this ImplementationCounterGroup.
Return type:	int
	required

other_time_total_sq¶

Gets the other_time_total_sq of this ImplementationCounterGroup. The sum of the squares of microseconds spent in non read-write operations.

Required/optional:
Returns:	The other_time_total_sq of this ImplementationCounterGroup.
Return type:	int
	required

read_bytes¶

Gets the read_bytes of this ImplementationCounterGroup. The number of bytes read.

Required/optional:
Returns:	The read_bytes of this ImplementationCounterGroup.
Return type:	int
	required

read_hit_bytes¶

Gets the read_hit_bytes of this ImplementationCounterGroup. The number of bytes read that hit cache.

Required/optional:
Returns:	The read_hit_bytes of this ImplementationCounterGroup.
Return type:	int
	required

read_hit_ops¶

Gets the read_hit_ops of this ImplementationCounterGroup. The number of read operations that hit cache.

Required/optional:
Returns:	The read_hit_ops of this ImplementationCounterGroup.
Return type:	int
	required

read_hit_segments¶

Gets the read_hit_segments of this ImplementationCounterGroup. The number of segment reads that hit cache.

Required/optional:
Returns:	The read_hit_segments of this ImplementationCounterGroup.
Return type:	int
	required

read_hit_stripes¶

Gets the read_hit_stripes of this ImplementationCounterGroup. The number of stripe reads that hit cache.

Required/optional:
Returns:	The read_hit_stripes of this ImplementationCounterGroup.
Return type:	int
	required

read_hit_time_max¶

Gets the read_hit_time_max of this ImplementationCounterGroup. The maximum time in microseconds spent in any one read operation that hit cache.

Required/optional:
Returns:	The read_hit_time_max of this ImplementationCounterGroup.
Return type:	int
	required

read_hit_time_total¶

Gets the read_hit_time_total of this ImplementationCounterGroup. The total time in microseconds spent in read operations that hit cache.

Required/optional:
Returns:	The read_hit_time_total of this ImplementationCounterGroup.
Return type:	int
	required

read_hit_time_total_sq¶

Gets the read_hit_time_total_sq of this ImplementationCounterGroup. The sum of the squares of microseconds spent in read operations that hit cache.

Required/optional:
Returns:	The read_hit_time_total_sq of this ImplementationCounterGroup.
Return type:	int
	required

read_ops¶

Gets the read_ops of this ImplementationCounterGroup. The number of read operations.

Required/optional:
Returns:	The read_ops of this ImplementationCounterGroup.
Return type:	int
	required

read_segments¶

Gets the read_segments of this ImplementationCounterGroup. The number of segment reads.

Required/optional:
Returns:	The read_segments of this ImplementationCounterGroup.
Return type:	int
	required

read_stripes¶

Gets the read_stripes of this ImplementationCounterGroup. The number of stripe reads.

Required/optional:
Returns:	The read_stripes of this ImplementationCounterGroup.
Return type:	int
	required

read_time_max¶

Gets the read_time_max of this ImplementationCounterGroup. The maximum time in microseconds spent in any one read operation.

Required/optional:
Returns:	The read_time_max of this ImplementationCounterGroup.
Return type:	int
	required

read_time_total¶

Gets the read_time_total of this ImplementationCounterGroup. The total time in microseconds spent in read operations.

Required/optional:
Returns:	The read_time_total of this ImplementationCounterGroup.
Return type:	int
	required

read_time_total_sq¶

Gets the read_time_total_sq of this ImplementationCounterGroup. The sum of the squares of microseconds spent in read operations.

Required/optional:
Returns:	The read_time_total_sq of this ImplementationCounterGroup.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

write_bytes¶

Gets the write_bytes of this ImplementationCounterGroup. The number of bytes written.

Required/optional:
Returns:	The write_bytes of this ImplementationCounterGroup.
Return type:	int
	required

write_hit_bytes¶

Gets the write_hit_bytes of this ImplementationCounterGroup. The number of bytes written that hit cache.

Required/optional:
Returns:	The write_hit_bytes of this ImplementationCounterGroup.
Return type:	int
	required

write_hit_ops¶

Gets the write_hit_ops of this ImplementationCounterGroup. The number of write operations that hit cache.

Required/optional:
Returns:	The write_hit_ops of this ImplementationCounterGroup.
Return type:	int
	required

write_hit_segments¶

Gets the write_hit_segments of this ImplementationCounterGroup. The number of segment writes that hit cache.

Required/optional:
Returns:	The write_hit_segments of this ImplementationCounterGroup.
Return type:	int
	required

write_hit_stripes¶

Gets the write_hit_stripes of this ImplementationCounterGroup. The number of stripe writes that hit cache.

Required/optional:
Returns:	The write_hit_stripes of this ImplementationCounterGroup.
Return type:	int
	required

write_hit_time_max¶

Gets the write_hit_time_max of this ImplementationCounterGroup. The maximum time in microseconds spent in any one write operation that hit cache.

Required/optional:
Returns:	The write_hit_time_max of this ImplementationCounterGroup.
Return type:	int
	required

write_hit_time_total¶

Gets the write_hit_time_total of this ImplementationCounterGroup. The total time in microseconds spent in write operations that hit cache.

Required/optional:
Returns:	The write_hit_time_total of this ImplementationCounterGroup.
Return type:	int
	required

write_hit_time_total_sq¶

Gets the write_hit_time_total_sq of this ImplementationCounterGroup. The sum of the squares of microseconds spent in write operations that hit cache.

Required/optional:
Returns:	The write_hit_time_total_sq of this ImplementationCounterGroup.
Return type:	int
	required

write_ops¶

Gets the write_ops of this ImplementationCounterGroup. The number of write operations.

Required/optional:
Returns:	The write_ops of this ImplementationCounterGroup.
Return type:	int
	required

write_ops_by_algorithm¶

Gets the write_ops_by_algorithm of this ImplementationCounterGroup. This field is used to record the number of write operations for a given RAID implementation algorithm. The algorithms are numbered 0..(NUMBER_OF_ALGORITHMS - 1). The actual algorithm represented by a given algorithm number depends on the RAID level of the object of interest. For RAID 0 objects, algorithm 0 is Single, Algorithm 2 is Complex, and Algorithm 3 is Fast. For RAID 3/5, Algorithm 0 is Full, Algorithm 1 is Partial, Algorithm 2 is RMW, Algorithm 3 is No Parity, and Algorithm 4 is Fast.

Required/optional:
Returns:	The write_ops_by_algorithm of this ImplementationCounterGroup.
Return type:	list[int]
	required

write_segments¶

Gets the write_segments of this ImplementationCounterGroup. The number of segment writes.

Required/optional:
Returns:	The write_segments of this ImplementationCounterGroup.
Return type:	int
	required

write_stripes¶

Gets the write_stripes of this ImplementationCounterGroup. The number of stripe writes.

Required/optional:
Returns:	The write_stripes of this ImplementationCounterGroup.
Return type:	int
	required

write_time_max¶

Gets the write_time_max of this ImplementationCounterGroup. The maximum time in microseconds spent in any one write operation.

Required/optional:
Returns:	The write_time_max of this ImplementationCounterGroup.
Return type:	int
	required

write_time_total¶

Gets the write_time_total of this ImplementationCounterGroup. The total time in microseconds spent in write operations.

Required/optional:
Returns:	The write_time_total of this ImplementationCounterGroup.
Return type:	int
	required

write_time_total_sq¶

Gets the write_time_total_sq of this ImplementationCounterGroup. The sum of the squares of microseconds spent in write operations.

Required/optional:
Returns:	The write_time_total_sq of this ImplementationCounterGroup.
Return type:	int
	required

netapp.santricity.models.symbol.import_dependencies_returned module¶

ImportDependenciesReturned.py

class netapp.santricity.models.symbol.import_dependencies_returned.ImportDependenciesReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

dependency_types¶

Gets the dependency_types of this ImportDependenciesReturned. This field is an array of ImportDependencyType values that identify all of the import dependencies for the volume group identified in the getImportDependencies call. This field is present only when the returnCode field is RETCODE_OK.

Required/optional:
Returns:	The dependency_types of this ImportDependenciesReturned.
Return type:	list[str]
	optional

return_code¶

Gets the return_code of this ImportDependenciesReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this ImportDependenciesReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.infiniband_interface_data module¶

InfinibandInterfaceData.py

class netapp.santricity.models.symbol.infiniband_interface_data.InfinibandInterfaceData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

is_iser¶

Gets the is_iser of this InfinibandInterfaceData. If true, iSER (iSCSI Extensions for RDMA) is active and a corresponding IBInterface object exists

Required/optional:
Returns:	The is_iser of this InfinibandInterfaceData.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.initialization_operation module¶

InitializationOperation.py

class netapp.santricity.models.symbol.initialization_operation.InitializationOperation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

pending¶

Gets the pending of this InitializationOperation. If true, the operation has not started.

Required/optional:
Returns:	The pending of this InitializationOperation.
Return type:	bool
	required

percent_complete¶

Gets the percent_complete of this InitializationOperation. Completion percentage for the operation. If the operation is not currently running this value will be equal to PERCENT_COMPLETE_OP_NOT_RUNNING.

Required/optional:
Returns:	The percent_complete of this InitializationOperation.
Return type:	int
	required

time_to_completion¶

Gets the time_to_completion of this InitializationOperation. Estimated time to completion in minutes. If the time is not known this value will be equal to TIME_TO_COMPLETION_UNKNOWN.

Required/optional:
Returns:	The time_to_completion of this InitializationOperation.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this InitializationOperation. Reference to the volume.

Required/optional:
Returns:	The volume_ref of this InitializationOperation.
Return type:	str
	required

netapp.santricity.models.symbol.initiator module¶

Initiator.py

class netapp.santricity.models.symbol.initiator.Initiator[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

alias¶

Gets the alias of this Initiator. An additional name that can be assigned to an initiator, which is usually “friendlier” than the node name.

Required/optional:
Returns:	The alias of this Initiator.
Return type:	ScsiAlias
	required

configured_auth_methods¶

Gets the configured_auth_methods of this Initiator. The authentication methods that have been configured for the initiator. Associated secrets are not exposed. instead the type field of the EncryptedPassword is set to ENCRYPT_UNSPECIFIED.

Required/optional:
Returns:	The configured_auth_methods of this Initiator.
Return type:	AuthenticationBundle
	required

host_ref¶

Gets the host_ref of this Initiator. A reference to the Host object to which the initiator belongs.

Required/optional:
Returns:	The host_ref of this Initiator.
Return type:	str
	required

id¶

Gets the id of this Initiator.

Required/optional:
Returns:	The id of this Initiator.
Return type:	str
	optional

initiator_inactive¶

Gets the initiator_inactive of this Initiator. The initiator is marked inactive.

Required/optional:
Returns:	The initiator_inactive of this Initiator.
Return type:	bool
	required

initiator_ref¶

Gets the initiator_ref of this Initiator. The reference that uniquely identifies an instance of this object.

Required/optional:
Returns:	The initiator_ref of this Initiator.
Return type:	str
	required

label¶

Gets the label of this Initiator. An additional “friendly” name that can be assigned to an initiator through the Storage Manager application.

Required/optional:
Returns:	The label of this Initiator.
Return type:	str
	required

node_name¶

Gets the node_name of this Initiator. The unique node name associated with the initiator.

Required/optional:
Returns:	The node_name of this Initiator.
Return type:	ScsiNodeName
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.initiator_changeable_properties module¶

InitiatorChangeableProperties.py

class netapp.santricity.models.symbol.initiator_changeable_properties.InitiatorChangeableProperties[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

configured_auth_methods¶

Gets the configured_auth_methods of this InitiatorChangeableProperties. The set of the authentication methods for the initiator. When creating a new initiator, this field defines the authentication methods that the new initiator will have. When updating an existing initiator, this field replaces all existing authentication methods; depending on how the caller populates the list, authentication methods may be added, deleted, or modified. Secrets associated with authentication methods may be modified in this manner. The way to indicate that there is no password is to set the length indicator on the field named secret within AuthMethodTypeData (which is the type of the individual elements of AuthenticationBundle) to zero.

Required/optional:
Returns:	The configured_auth_methods of this InitiatorChangeableProperties.
Return type:	list[AuthenticationBundle]
	required

host_ref¶

Gets the host_ref of this InitiatorChangeableProperties. A reference to the host with which this initiator is associated.

Required/optional:
Returns:	The host_ref of this InitiatorChangeableProperties.
Return type:	list[str]
	required

label¶

Gets the label of this InitiatorChangeableProperties. The user-assigned, descriptive label string for the initiator.

Required/optional:
Returns:	The label of this InitiatorChangeableProperties.
Return type:	list[str]
	required

node_name¶

Gets the node_name of this InitiatorChangeableProperties. The node name for the initiator.

Required/optional:
Returns:	The node_name of this InitiatorChangeableProperties.
Return type:	list[ScsiNodeName]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.initiator_creation_descriptor module¶

InitiatorCreationDescriptor.py

class netapp.santricity.models.symbol.initiator_creation_descriptor.InitiatorCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

settings¶

Gets the settings of this InitiatorCreationDescriptor. The initial settings for the new initiator.

Required/optional:
Returns:	The settings of this InitiatorCreationDescriptor.
Return type:	InitiatorChangeableProperties
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.initiator_location module¶

InitiatorLocation.py

class netapp.santricity.models.symbol.initiator_location.InitiatorLocation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

initiator_name¶

Gets the initiator_name of this InitiatorLocation. The iSCSI node name of the initiator, left-truncated if necessary. (Left-truncation preserves the part of the name most likely to vary.)

Required/optional:
Returns:	The initiator_name of this InitiatorLocation.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.initiator_properties_update_descriptor module¶

InitiatorPropertiesUpdateDescriptor.py

class netapp.santricity.models.symbol.initiator_properties_update_descriptor.InitiatorPropertiesUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

initiator_ref¶

Gets the initiator_ref of this InitiatorPropertiesUpdateDescriptor. A reference to the initiator to which the property settings apply.

Required/optional:
Returns:	The initiator_ref of this InitiatorPropertiesUpdateDescriptor.
Return type:	str
	required

settings¶

Gets the settings of this InitiatorPropertiesUpdateDescriptor. The settings for the initiator.

Required/optional:
Returns:	The settings of this InitiatorPropertiesUpdateDescriptor.
Return type:	InitiatorChangeableProperties
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.initiator_target_changeable_properties module¶

InitiatorTargetChangeableProperties.py

class netapp.santricity.models.symbol.initiator_target_changeable_properties.InitiatorTargetChangeableProperties[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

io_interface_type¶

Gets the io_interface_type of this InitiatorTargetChangeableProperties. This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller.

Required/optional:
Returns:	The io_interface_type of this InitiatorTargetChangeableProperties.
Return type:	str
	required

iscsiinitiator_target_base_parameters¶

Gets the iscsiinitiator_target_base_parameters of this InitiatorTargetChangeableProperties.

Required/optional:
Returns:	The iscsiinitiator_target_base_parameters of this InitiatorTargetChangeableProperties.
Return type:	IscsiInitiatorTargetBaseParameters
	optional

node_name¶

Gets the node_name of this InitiatorTargetChangeableProperties. The node name is returned if the ioInterfaceType is equal to IO_IF_FC.

Required/optional:
Returns:	The node_name of this InitiatorTargetChangeableProperties.
Return type:	list[ScsiNodeName]
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.initiator_target_initial_properties module¶

InitiatorTargetInitialProperties.py

class netapp.santricity.models.symbol.initiator_target_initial_properties.InitiatorTargetInitialProperties[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

node_name¶

Gets the node_name of this InitiatorTargetInitialProperties. Node name for the target.

Required/optional:
Returns:	The node_name of this InitiatorTargetInitialProperties.
Return type:	list[ScsiNodeName]
	required

scsiinitiator_target_base_properties¶

Gets the scsiinitiator_target_base_properties of this InitiatorTargetInitialProperties.

Required/optional:
Returns:	The scsiinitiator_target_base_properties of this InitiatorTargetInitialProperties.
Return type:	ScsiInitiatorTargetBaseProperties
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.initiator_target_properties_update_descriptor module¶

InitiatorTargetPropertiesUpdateDescriptor.py

class netapp.santricity.models.symbol.initiator_target_properties_update_descriptor.InitiatorTargetPropertiesUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

remote_ref¶

Gets the remote_ref of this InitiatorTargetPropertiesUpdateDescriptor. The remote entity (initiator or target) to which the property settings apply.

Required/optional:
Returns:	The remote_ref of this InitiatorTargetPropertiesUpdateDescriptor.
Return type:	str
	required

remote_target_settings¶

Gets the remote_target_settings of this InitiatorTargetPropertiesUpdateDescriptor. The settings for the remote target.

Required/optional:
Returns:	The remote_target_settings of this InitiatorTargetPropertiesUpdateDescriptor.
Return type:	InitiatorTargetChangeableProperties
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.instance_returned module¶

InstanceReturned.py

class netapp.santricity.models.symbol.instance_returned.InstanceReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ref¶

Gets the ref of this InstanceReturned. This field contains the reference to the new object. It is present only when the returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The ref of this InstanceReturned.
Return type:	str
	optional

return_code¶

Gets the return_code of this InstanceReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this InstanceReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.interconnect_cru module¶

InterconnectCRU.py

class netapp.santricity.models.symbol.interconnect_cru.InterconnectCRU[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

fru_type¶

Gets the fru_type of this InterconnectCRU. The VPD field replaceable unit type

Required/optional:
Returns:	The fru_type of this InterconnectCRU.
Return type:	str
	required

interconnect_cru_ref¶

Gets the interconnect_cru_ref of this InterconnectCRU. The reference for this physical interconnect CRU

Required/optional:
Returns:	The interconnect_cru_ref of this InterconnectCRU.
Return type:	str
	required

manufacturer_date¶

Gets the manufacturer_date of this InterconnectCRU. VPD Manufacture Date

Required/optional:
Returns:	The manufacturer_date of this InterconnectCRU.
Return type:	int
	required

physical_location¶

Gets the physical_location of this InterconnectCRU. The physical location of the interconnect CRU. The parent reference in Location identifies the tray containing the CRU, and the position field is always one.

Required/optional:
Returns:	The physical_location of this InterconnectCRU.
Return type:	Location
	required

ready_to_remove¶

Gets the ready_to_remove of this InterconnectCRU. When set to True, it means that the component is ready to remove (and the Ready to Remove indicator will be turned on). This field is deprecated. The rtrAttributes field should be used instead.

Required/optional:
Returns:	The ready_to_remove of this InterconnectCRU.
Return type:	bool
	required

repair_policy¶

Gets the repair_policy of this InterconnectCRU. The repair policy for the interconnect CRU component.

Required/optional:
Returns:	The repair_policy of this InterconnectCRU.
Return type:	RepairPolicy
	required

rtr_attributes¶

Gets the rtr_attributes of this InterconnectCRU. The CRU type of the interconnect CRU plus its ready-to-remove attributes, which are based on the CRU type.

Required/optional:
Returns:	The rtr_attributes of this InterconnectCRU.
Return type:	RTRAttributes
	required

status¶

Gets the status of this InterconnectCRU. The operational status of the interconnect CRU

Required/optional:
Returns:	The status of this InterconnectCRU.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

vendor_name¶

Gets the vendor_name of this InterconnectCRU. The VPD vendor name

Required/optional:
Returns:	The vendor_name of this InterconnectCRU.
Return type:	str
	required

vendor_pn¶

Gets the vendor_pn of this InterconnectCRU. The VPD part number

Required/optional:
Returns:	The vendor_pn of this InterconnectCRU.
Return type:	str
	required

vendor_sn¶

Gets the vendor_sn of this InterconnectCRU. The VPD serial number

Required/optional:
Returns:	The vendor_sn of this InterconnectCRU.
Return type:	str
	required

netapp.santricity.models.symbol.interface_counter_group module¶

InterfaceCounterGroup.py

class netapp.santricity.models.symbol.interface_counter_group.InterfaceCounterGroup[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

base_time¶

Gets the base_time of this InterfaceCounterGroup. Time the counters were last reset. Time is the number of seconds since midnight, January 1, 1970.

Required/optional:
Returns:	The base_time of this InterfaceCounterGroup.
Return type:	int
	required

channel_error_counts¶

Gets the channel_error_counts of this InterfaceCounterGroup. The total number of errors detected on this channel.

Required/optional:
Returns:	The channel_error_counts of this InterfaceCounterGroup.
Return type:	int
	required

channel_number¶

Gets the channel_number of this InterfaceCounterGroup. Channel numerical ID.

Required/optional:
Returns:	The channel_number of this InterfaceCounterGroup.
Return type:	int
	required

channel_type¶

Gets the channel_type of this InterfaceCounterGroup. Channel Type enumeration Drive side, host side, or management.

Required/optional:
Returns:	The channel_type of this InterfaceCounterGroup.
Return type:	str
	required

controller_ref¶

Gets the controller_ref of this InterfaceCounterGroup. The controller that generated this group.

Required/optional:
Returns:	The controller_ref of this InterfaceCounterGroup.
Return type:	str
	required

observed_time¶

Gets the observed_time of this InterfaceCounterGroup. End time for this collection as measured by the number of seconds since baseTime.

Required/optional:
Returns:	The observed_time of this InterfaceCounterGroup.
Return type:	int
	required

other_ops¶

Gets the other_ops of this InterfaceCounterGroup. Number of non-read-write operations.

Required/optional:
Returns:	The other_ops of this InterfaceCounterGroup.
Return type:	int
	required

other_time_max¶

Gets the other_time_max of this InterfaceCounterGroup. Max time in microseconds spent processing one non-read-write op.

Required/optional:
Returns:	The other_time_max of this InterfaceCounterGroup.
Return type:	int
	required

other_time_total¶

Gets the other_time_total of this InterfaceCounterGroup. Total time in microseconds spent in non-read-write ops.

Required/optional:
Returns:	The other_time_total of this InterfaceCounterGroup.
Return type:	int
	required

other_time_total_sq¶

Gets the other_time_total_sq of this InterfaceCounterGroup. Sum of the squares of microseconds spent in non-read-write operations.

Required/optional:
Returns:	The other_time_total_sq of this InterfaceCounterGroup.
Return type:	int
	required

queue_depth_max¶

Gets the queue_depth_max of this InterfaceCounterGroup. Maximum channel queue depth.

Required/optional:
Returns:	The queue_depth_max of this InterfaceCounterGroup.
Return type:	int
	required

queue_depth_total¶

Gets the queue_depth_total of this InterfaceCounterGroup. Total channel queue depth.

Required/optional:
Returns:	The queue_depth_total of this InterfaceCounterGroup.
Return type:	int
	required

read_bytes¶

Gets the read_bytes of this InterfaceCounterGroup. Number of bytes read.

Required/optional:
Returns:	The read_bytes of this InterfaceCounterGroup.
Return type:	int
	required

read_ops¶

Gets the read_ops of this InterfaceCounterGroup. Number of read operations.

Required/optional:
Returns:	The read_ops of this InterfaceCounterGroup.
Return type:	int
	required

read_time_max¶

Gets the read_time_max of this InterfaceCounterGroup. Max time in microseconds spent processing one read operation.

Required/optional:
Returns:	The read_time_max of this InterfaceCounterGroup.
Return type:	int
	required

read_time_total¶

Gets the read_time_total of this InterfaceCounterGroup. Total time in microseconds spent in read operations.

Required/optional:
Returns:	The read_time_total of this InterfaceCounterGroup.
Return type:	int
	required

read_time_total_sq¶

Gets the read_time_total_sq of this InterfaceCounterGroup. Sum of the squares of microseconds spent in read operations.

Required/optional:
Returns:	The read_time_total_sq of this InterfaceCounterGroup.
Return type:	int
	required

start_time¶

Gets the start_time of this InterfaceCounterGroup. Start time for this collection as measured by the number of seconds since baseTime.

Required/optional:
Returns:	The start_time of this InterfaceCounterGroup.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

write_bytes¶

Gets the write_bytes of this InterfaceCounterGroup. Number of bytes write.

Required/optional:
Returns:	The write_bytes of this InterfaceCounterGroup.
Return type:	int
	required

write_ops¶

Gets the write_ops of this InterfaceCounterGroup. Number of write operations.

Required/optional:
Returns:	The write_ops of this InterfaceCounterGroup.
Return type:	int
	required

write_time_max¶

Gets the write_time_max of this InterfaceCounterGroup. Max time in microseconds spent processing one write operation.

Required/optional:
Returns:	The write_time_max of this InterfaceCounterGroup.
Return type:	int
	required

write_time_total¶

Gets the write_time_total of this InterfaceCounterGroup. Total time in microseconds spent in write operations.

Required/optional:
Returns:	The write_time_total of this InterfaceCounterGroup.
Return type:	int
	required

write_time_total_sq¶

Gets the write_time_total_sq of this InterfaceCounterGroup. Sum of the squares of microseconds spent in write operations.

Required/optional:
Returns:	The write_time_total_sq of this InterfaceCounterGroup.
Return type:	int
	required

netapp.santricity.models.symbol.interface_update_descriptor module¶

InterfaceUpdateDescriptor.py

class netapp.santricity.models.symbol.interface_update_descriptor.InterfaceUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_ref¶

Gets the controller_ref of this InterfaceUpdateDescriptor. The reference value that identifies the controller whose interface configuration is to be changed by this operation.

Required/optional:
Returns:	The controller_ref of this InterfaceUpdateDescriptor.
Return type:	str
	required

port_name¶

Gets the port_name of this InterfaceUpdateDescriptor. The unique identifier of the port associated with this channel.

Required/optional:
Returns:	The port_name of this InterfaceUpdateDescriptor.
Return type:	str
	required

preferred_id¶

Gets the preferred_id of this InterfaceUpdateDescriptor. The new preferred ID value for the channel. For Fibre Channel interfaces, the following values are supported:

Required/optional:
Returns:	The preferred_id of this InterfaceUpdateDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.internet_protocol_v4_data module¶

InternetProtocolV4Data.py

class netapp.santricity.models.symbol.internet_protocol_v4_data.InternetProtocolV4Data[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ipv4_address¶

Gets the ipv4_address of this InternetProtocolV4Data. The various IPV4 address-related elements (IP address, gateway IP address, and subnet mask), along with the state of their configuration.

Required/optional:
Returns:	The ipv4_address of this InternetProtocolV4Data.
Return type:	str
	required

ipv4_address_config_method¶

Gets the ipv4_address_config_method of this InternetProtocolV4Data. IPV4 configuration method for the endpoint; always STATIC for iSER interfaces.

Required/optional:
Returns:	The ipv4_address_config_method of this InternetProtocolV4Data.
Return type:	str
	required

ipv4_address_data¶

Gets the ipv4_address_data of this InternetProtocolV4Data. The various IPV4 address-related elements (IP address, gateway IP address, and subnet mask), along with the state of their configuration.

Required/optional:
Returns:	The ipv4_address_data of this InternetProtocolV4Data.
Return type:	IpV4AddressData
	required

ipv4_outbound_packet_priority¶

Gets the ipv4_outbound_packet_priority of this InternetProtocolV4Data. Priority associate with outbound IPV4 packets; always disabled for iSER interfaces.

Required/optional:
Returns:	The ipv4_outbound_packet_priority of this InternetProtocolV4Data.
Return type:	SettingControl
	required

ipv4_vlan_id¶

Gets the ipv4_vlan_id of this InternetProtocolV4Data. Value of IPV4 VLAN id for the interface; always disabled for iSER interfaces.

Required/optional:
Returns:	The ipv4_vlan_id of this InternetProtocolV4Data.
Return type:	SettingControl
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.internet_protocol_v6_data module¶

InternetProtocolV6Data.py

class netapp.santricity.models.symbol.internet_protocol_v6_data.InternetProtocolV6Data[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ipv6_address_config_method¶

Gets the ipv6_address_config_method of this InternetProtocolV6Data. The method by which the IPV6 address information is configured for the endpoint.

Required/optional:
Returns:	The ipv6_address_config_method of this InternetProtocolV6Data.
Return type:	str
	required

ipv6_duplicate_address_detection_attempts¶

Gets the ipv6_duplicate_address_detection_attempts of this InternetProtocolV6Data. The number of neighbor-solicitation messages to send in trying to determine IP address uniqueness.

Required/optional:
Returns:	The ipv6_duplicate_address_detection_attempts of this InternetProtocolV6Data.
Return type:	int
	required

ipv6_hop_limit¶

Gets the ipv6_hop_limit of this InternetProtocolV6Data. The hop limit to use in IPV6 packets sent over the interface.

Required/optional:
Returns:	The ipv6_hop_limit of this InternetProtocolV6Data.
Return type:	int
	required

ipv6_local_addresses¶

Gets the ipv6_local_addresses of this InternetProtocolV6Data. The set of IPV6 local addresses that have been assigned to the iSCSI Ethernet port.

Required/optional:
Returns:	The ipv6_local_addresses of this InternetProtocolV6Data.
Return type:	list[IpV6AddressData]
	required

ipv6_nd_reachable_time¶

Gets the ipv6_nd_reachable_time of this InternetProtocolV6Data. A “neighbor discovery” parameter - the amount of time in milliseconds, within which a neighbor is assumed to be reachable.

Required/optional:
Returns:	The ipv6_nd_reachable_time of this InternetProtocolV6Data.
Return type:	int
	required

ipv6_nd_retransmit_time¶

Gets the ipv6_nd_retransmit_time of this InternetProtocolV6Data. A “neighbor discovery” parameter - the number of milliseconds between neighbor solicitation probes.

Required/optional:
Returns:	The ipv6_nd_retransmit_time of this InternetProtocolV6Data.
Return type:	int
	required

ipv6_nd_stale_timeout¶

Gets the ipv6_nd_stale_timeout of this InternetProtocolV6Data. A “neighbor discovery” parameter - the time in milliseconds after which information for a neighbor that cannot be verified as reachable will be considered “stale.”

Required/optional:
Returns:	The ipv6_nd_stale_timeout of this InternetProtocolV6Data.
Return type:	int
	required

ipv6_outbound_packet_priority¶

Gets the ipv6_outbound_packet_priority of this InternetProtocolV6Data. Settings that govern the priority to associate with outbound IPV6 packets sent over the interface

Required/optional:
Returns:	The ipv6_outbound_packet_priority of this InternetProtocolV6Data.
Return type:	SettingControl
	required

ipv6_port_router_address¶

Gets the ipv6_port_router_address of this InternetProtocolV6Data. The IPV6 address of the port router.

Required/optional:
Returns:	The ipv6_port_router_address of this InternetProtocolV6Data.
Return type:	IpV6AddressData
	required

ipv6_routable_addresses¶

Gets the ipv6_routable_addresses of this InternetProtocolV6Data. The set of IPV6 routable addresses that have been assigned to the iSCSI Ethernet port

Required/optional:
Returns:	The ipv6_routable_addresses of this InternetProtocolV6Data.
Return type:	list[IpV6AddressData]
	required

ipv6_vlan_id¶

Gets the ipv6_vlan_id of this InternetProtocolV6Data. Settings that govern the value of the IPV6 VLAN identifier for the interface. VLAN identifiers are in the range 1 through 4094.

Required/optional:
Returns:	The ipv6_vlan_id of this InternetProtocolV6Data.
Return type:	SettingControl
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.interposer module¶

Interposer.py

class netapp.santricity.models.symbol.interposer.Interposer[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

interposer_ref¶

Gets the interposer_ref of this Interposer. The drive interposer identifier.

Required/optional:
Returns:	The interposer_ref of this Interposer.
Return type:	str
	required

interposer_type_data¶

Gets the interposer_type_data of this Interposer. The vendor product data associated with the interposer.

Required/optional:
Returns:	The interposer_type_data of this Interposer.
Return type:	InterposerTypeData
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.interposer_data module¶

InterposerData.py

class netapp.santricity.models.symbol.interposer_data.InterposerData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

device_wwn¶

Gets the device_wwn of this InterposerData. This data represents the device name of the interposer.

Required/optional:
Returns:	The device_wwn of this InterposerData.
Return type:	str
	required

drive_fw_version¶

Gets the drive_fw_version of this InterposerData. 4 bytes left-justified ASCII drive firmware version as retrieved from the drive’s standard INQUIRY data, followed by 4 blank bytes.

Required/optional:
Returns:	The drive_fw_version of this InterposerData.
Return type:	str
	required

part_number¶

Gets the part_number of this InterposerData. This data is a variable length ASCII text string that represents the part number of the interposer.

Required/optional:
Returns:	The part_number of this InterposerData.
Return type:	str
	required

product_id¶

Gets the product_id of this InterposerData. This data is a variable length ASCII text string containing the product identification of the interposer.

Required/optional:
Returns:	The product_id of this InterposerData.
Return type:	str
	required

revision¶

Gets the revision of this InterposerData. This data is a variable length ASCII text string that represents the current version, or revision level, of the interposer.

Required/optional:
Returns:	The revision of this InterposerData.
Return type:	str
	required

serial_number¶

Gets the serial_number of this InterposerData. This data is a variable length ASCII text string that represents the serial number of the interposer.

Required/optional:
Returns:	The serial_number of this InterposerData.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

vendor_id¶

Gets the vendor_id of this InterposerData. This data is a variable length ASCII text string containing the vendor identification of the interposer.

Required/optional:
Returns:	The vendor_id of this InterposerData.
Return type:	str
	required

netapp.santricity.models.symbol.interposer_type_data module¶

InterposerTypeData.py

class netapp.santricity.models.symbol.interposer_type_data.InterposerTypeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

fc_sas_interposer¶

Gets the fc_sas_interposer of this InterposerTypeData. This field is available when the interfaceTypeData is equal to INTERPOSER_TYPE_FC_TO_SAS

Required/optional:
Returns:	The fc_sas_interposer of this InterposerTypeData.
Return type:	InterposerData
	optional

interposer_type¶

Gets the interposer_type of this InterposerTypeData. This enumeration defines the different interposer types.

Required/optional:
Returns:	The interposer_type of this InterposerTypeData.
Return type:	str
	required

reserved¶

Gets the reserved of this InterposerTypeData. Reserved.

Required/optional:
Returns:	The reserved of this InterposerTypeData.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.inventory_item module¶

InventoryItem.py

class netapp.santricity.models.symbol.inventory_item.InventoryItem[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

item_name¶

Gets the item_name of this InventoryItem. An ASCII string that provides the symbolic name of the item.

Required/optional:
Returns:	The item_name of this InventoryItem.
Return type:	str
	required

item_version¶

Gets the item_version of this InventoryItem. An ASCII string that represents the current version, or revision level, of the item.

Required/optional:
Returns:	The item_version of this InventoryItem.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.io_counter_group module¶

IoCounterGroup.py

class netapp.santricity.models.symbol.io_counter_group.IoCounterGroup[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

base_time¶

Gets the base_time of this IoCounterGroup. The time the counters were last reset. Time is the number of seconds since midnight, January 1, 1970.

Required/optional:
Returns:	The base_time of this IoCounterGroup.
Return type:	int
	required

bytes_in¶

Gets the bytes_in of this IoCounterGroup. The number of bytes transferred into controller memory.

Required/optional:
Returns:	The bytes_in of this IoCounterGroup.
Return type:	int
	required

bytes_out¶

Gets the bytes_out of this IoCounterGroup. The number of bytes transferred out of controller memory.

Required/optional:
Returns:	The bytes_out of this IoCounterGroup.
Return type:	int
	required

controller_ref¶

Gets the controller_ref of this IoCounterGroup. A reference to the controller that generated this group.

Required/optional:
Returns:	The controller_ref of this IoCounterGroup.
Return type:	str
	required

idle_time¶

Gets the idle_time of this IoCounterGroup. The amount of time in microseconds the channel spent idle since baseTime.

Required/optional:
Returns:	The idle_time of this IoCounterGroup.
Return type:	int
	required

opcode_counters¶

Gets the opcode_counters of this IoCounterGroup. An array of opcode counters. Each element in the array has an opcode value and an associated count of the number of times that opcode was observed.

Required/optional:
Returns:	The opcode_counters of this IoCounterGroup.
Return type:	list[OpcodeCounter]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.io_interface module¶

IoInterface.py

class netapp.santricity.models.symbol.io_interface.IoInterface[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel_type¶

Gets the channel_type of this IoInterface. The type of channel (e.g., host-side, drive-side) that the interface is associated with.

Required/optional:
Returns:	The channel_type of this IoInterface.
Return type:	str
	required

controller_ref¶

Gets the controller_ref of this IoInterface. Uniquely identifies a particular physical RAID controller within the storage array.

Required/optional:
Returns:	The controller_ref of this IoInterface.
Return type:	str
	required

interface_ref¶

Gets the interface_ref of this IoInterface. The SYMbol array-wide unique name for the interface object.

Required/optional:
Returns:	The interface_ref of this IoInterface.
Return type:	str
	required

io_interface_type_data¶

Gets the io_interface_type_data of this IoInterface. A field whose contents vary depending on the I/O protocol type of the interface.

Required/optional:
Returns:	The io_interface_type_data of this IoInterface.
Return type:	IOInterfaceTypeData
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.io_interface_hic_map module¶

IoInterfaceHicMap.py

class netapp.santricity.models.symbol.io_interface_hic_map.IoInterfaceHicMap[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

host_board_ref¶

Gets the host_board_ref of this IoInterfaceHicMap. The reference to the associated HIC.

Required/optional:
Returns:	The host_board_ref of this IoInterfaceHicMap.
Return type:	str
	required

interface_ref¶

Gets the interface_ref of this IoInterfaceHicMap. A reference to the I/O interface.

Required/optional:
Returns:	The interface_ref of this IoInterfaceHicMap.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.io_interface_type_data module¶

IOInterfaceTypeData.py

class netapp.santricity.models.symbol.io_interface_type_data.IOInterfaceTypeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

fibre¶

Gets the fibre of this IOInterfaceTypeData. This field is present only if the interfaceType value is equal to IO_IF_FC. It contains the detailed interface information for a Fibre Channel I/O interface.

Required/optional:
Returns:	The fibre of this IOInterfaceTypeData.
Return type:	FibreInterface
	optional

ib¶

Gets the ib of this IOInterfaceTypeData. This field is present only if the interfaceType value is equal to IO_IF_IB. It contains the detailed interface information for an Infiniband interface.

Required/optional:
Returns:	The ib of this IOInterfaceTypeData.
Return type:	IbInterface
	optional

interface_type¶

Gets the interface_type of this IOInterfaceTypeData. This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller.

Required/optional:
Returns:	The interface_type of this IOInterfaceTypeData.
Return type:	str
	required

iscsi¶

Gets the iscsi of this IOInterfaceTypeData. This field is present only if the interface type value is equal to IO_IF_ISCSI. It contains the detailed interface information for an iSCSI I/O interface.

Required/optional:
Returns:	The iscsi of this IOInterfaceTypeData.
Return type:	IscsiInterface
	optional

sas¶

Gets the sas of this IOInterfaceTypeData. This field is present only if the interfaceType value is equal to IO_IF_SAS. It contains the detailed interface information for a serial-attached SCSI I/O interface.

Required/optional:
Returns:	The sas of this IOInterfaceTypeData.
Return type:	SasInterface
	optional

sata¶

Gets the sata of this IOInterfaceTypeData. This field is present only if the interfaceType value is equal to IO_IF_SATA. It contains the detailed interface information for a SATA I/O interface.

Required/optional:
Returns:	The sata of this IOInterfaceTypeData.
Return type:	SATAInterface
	optional

scsi¶

Gets the scsi of this IOInterfaceTypeData. This field is present only if the interfaceType value is equal to IO_IF_SCSI. It contains the detailed interface information for a SCSI I/O interface.

Required/optional:
Returns:	The scsi of this IOInterfaceTypeData.
Return type:	SCSIInterface
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.io_interface_type_data_list module¶

IOInterfaceTypeDataList.py

class netapp.santricity.models.symbol.io_interface_type_data_list.IOInterfaceTypeDataList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

interfaces¶

Gets the interfaces of this IOInterfaceTypeDataList. A variable-length array of IOInterfaceTypeData objects.

Required/optional:
Returns:	The interfaces of this IOInterfaceTypeDataList.
Return type:	list[IOInterfaceTypeData]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.io_statistics_retrieve_chunk_details module¶

IoStatisticsRetrieveChunkDetails.py

class netapp.santricity.models.symbol.io_statistics_retrieve_chunk_details.IoStatisticsRetrieveChunkDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

io_statistics_data¶

Gets the io_statistics_data of this IoStatisticsRetrieveChunkDetails.

Required/optional:
Returns:	The io_statistics_data of this IoStatisticsRetrieveChunkDetails.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.io_statistics_retrieve_start_details module¶

IoStatisticsRetrieveStartDetails.py

class netapp.santricity.models.symbol.io_statistics_retrieve_start_details.IoStatisticsRetrieveStartDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

clear¶

Gets the clear of this IoStatisticsRetrieveStartDetails. This field is not used.

Required/optional:
Returns:	The clear of this IoStatisticsRetrieveStartDetails.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ioc_dump_data module¶

IOCDumpData.py

class netapp.santricity.models.symbol.ioc_dump_data.IOCDumpData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ioc_dump_enabled¶

Gets the ioc_dump_enabled of this IOCDumpData. If true, IOC Dump is enabled in the controller.

Required/optional:
Returns:	The ioc_dump_enabled of this IOCDumpData.
Return type:	bool
	required

ioc_dump_needs_retrieved¶

Gets the ioc_dump_needs_retrieved of this IOCDumpData. If true, an IOC Dump currently exists in controller memory and has not been retrieved.

Required/optional:
Returns:	The ioc_dump_needs_retrieved of this IOCDumpData.
Return type:	bool
	required

ioc_dump_tag¶

Gets the ioc_dump_tag of this IOCDumpData. The tag value of the IOC Dump currently in controller memory. Each dump has a unique tag value. A value of IOC_DUMP_NULL_TAG indicates there is no IOC Dump to retrieve.

Required/optional:
Returns:	The ioc_dump_tag of this IOCDumpData.
Return type:	int
	required

time_stamp¶

Gets the time_stamp of this IOCDumpData. The time that the dump was collected measured in seconds since midnight GMT on January 1, 1970.

Required/optional:
Returns:	The time_stamp of this IOCDumpData.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ioc_dump_info module¶

IOCDumpInfo.py

class netapp.santricity.models.symbol.ioc_dump_info.IOCDumpInfo[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

capture_size¶

Gets the capture_size of this IOCDumpInfo. The size of the IOC Dump in megabytes.

Required/optional:
Returns:	The capture_size of this IOCDumpInfo.
Return type:	int
	required

capture_time¶

Gets the capture_time of this IOCDumpInfo. The time that the IOC Dump was captured measured in seconds since January 1, 1970.

Required/optional:
Returns:	The capture_time of this IOCDumpInfo.
Return type:	int
	required

channel¶

Gets the channel of this IOCDumpInfo. The channel number.

Required/optional:
Returns:	The channel of this IOCDumpInfo.
Return type:	int
	required

fw_version¶

Gets the fw_version of this IOCDumpInfo. The controller firmware version at the time the IOC Dump was captured.

Required/optional:
Returns:	The fw_version of this IOCDumpInfo.
Return type:	str
	required

ioc_dump_reason¶

Gets the ioc_dump_reason of this IOCDumpInfo. The reason for the IOC Dump.

Required/optional:
Returns:	The ioc_dump_reason of this IOCDumpInfo.
Return type:	str
	required

ioc_dump_tag¶

Gets the ioc_dump_tag of this IOCDumpInfo. The IOC Dump Tag. Each IOC Dump has a unique tag value.

Required/optional:
Returns:	The ioc_dump_tag of this IOCDumpInfo.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ioc_dump_info_return module¶

IOCDumpInfoReturn.py

class netapp.santricity.models.symbol.ioc_dump_info_return.IOCDumpInfoReturn[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

info¶

Gets the info of this IOCDumpInfoReturn. This field is present only if the value of returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The info of this IOCDumpInfoReturn.
Return type:	IOCDumpInfo
	optional

return_code¶

Gets the return_code of this IOCDumpInfoReturn. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this IOCDumpInfoReturn.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ioc_dump_on_demand_return module¶

IOCDumpOnDemandReturn.py

class netapp.santricity.models.symbol.ioc_dump_on_demand_return.IOCDumpOnDemandReturn[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ioc_dump_tag¶

Gets the ioc_dump_tag of this IOCDumpOnDemandReturn. This field is present only if the value of returnCode is equal to RETCODE_OK. The value of the tag is unique for each IOC dump.

Required/optional:
Returns:	The ioc_dump_tag of this IOCDumpOnDemandReturn.
Return type:	int
	optional

return_code¶

Gets the return_code of this IOCDumpOnDemandReturn. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this IOCDumpOnDemandReturn.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ioc_dump_retrieve_chunk_details module¶

IOCDumpRetrieveChunkDetails.py

class netapp.santricity.models.symbol.ioc_dump_retrieve_chunk_details.IOCDumpRetrieveChunkDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ioc_dump_data¶

Gets the ioc_dump_data of this IOCDumpRetrieveChunkDetails. The current chunk of the IOC Dump data requested.

Required/optional:
Returns:	The ioc_dump_data of this IOCDumpRetrieveChunkDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ioc_dump_retrieve_start_details module¶

IOCDumpRetrieveStartDetails.py

class netapp.santricity.models.symbol.ioc_dump_retrieve_start_details.IOCDumpRetrieveStartDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ioc_dump_tag¶

Gets the ioc_dump_tag of this IOCDumpRetrieveStartDetails. The tag value of the IOC Dump to be retrieved. This value is unique for each dump.

Required/optional:
Returns:	The ioc_dump_tag of this IOCDumpRetrieveStartDetails.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ip_endpoint_statistics module¶

IpEndpointStatistics.py

class netapp.santricity.models.symbol.ip_endpoint_statistics.IpEndpointStatistics[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

interfaces¶

Gets the interfaces of this IpEndpointStatistics. The interface(s) for which the statistics apply. In some cases, the statistics may be aggregated across multiple interfaces. Even though this is shown as an array, it will only be a single instance.

Required/optional:
Returns:	The interfaces of this IpEndpointStatistics.
Return type:	list[str]
	required

ipv4_fragmentation¶

Gets the ipv4_fragmentation of this IpEndpointStatistics. The number of IPV4 packet fragments received.

Required/optional:
Returns:	The ipv4_fragmentation of this IpEndpointStatistics.
Return type:	int
	required

ipv4_fragmented_pdus_creates¶

Gets the ipv4_fragmented_pdus_creates of this IpEndpointStatistics. The number of IPV4 packet fragments transmitted.

Required/optional:
Returns:	The ipv4_fragmented_pdus_creates of this IpEndpointStatistics.
Return type:	int
	required

ipv4_out_of_order_frag_count¶

Gets the ipv4_out_of_order_frag_count of this IpEndpointStatistics. The number of IPV4 datagrams with fragments received that were out of order.

Required/optional:
Returns:	The ipv4_out_of_order_frag_count of this IpEndpointStatistics.
Return type:	int
	required

ipv4_overlapped_frag_count¶

Gets the ipv4_overlapped_frag_count of this IpEndpointStatistics. The number of IPV4 datagrams with fragments that overlapped.

Required/optional:
Returns:	The ipv4_overlapped_frag_count of this IpEndpointStatistics.
Return type:	int
	required

ipv4_reassembled_packets¶

Gets the ipv4_reassembled_packets of this IpEndpointStatistics. The number of IPV4 datagrams successfully reassembled.

Required/optional:
Returns:	The ipv4_reassembled_packets of this IpEndpointStatistics.
Return type:	int
	required

ipv4_received_pdus¶

Gets the ipv4_received_pdus of this IpEndpointStatistics. The number of IPV4 input datagrams received.

Required/optional:
Returns:	The ipv4_received_pdus of this IpEndpointStatistics.
Return type:	int
	required

ipv4_rx_byte_count¶

Gets the ipv4_rx_byte_count of this IpEndpointStatistics. The number of data payload bytes received in IPV4 packets.

Required/optional:
Returns:	The ipv4_rx_byte_count of this IpEndpointStatistics.
Return type:	int
	required

ipv4_rx_error_count¶

Gets the ipv4_rx_error_count of this IpEndpointStatistics. # of IPV4 packets received with errors

Required/optional:
Returns:	The ipv4_rx_error_count of this IpEndpointStatistics.
Return type:	int
	required

ipv4_sent_pdus¶

Gets the ipv4_sent_pdus of this IpEndpointStatistics. The number of IPV4 output datagrams sent.

Required/optional:
Returns:	The ipv4_sent_pdus of this IpEndpointStatistics.
Return type:	int
	required

ipv4_timeout_count¶

Gets the ipv4_timeout_count of this IpEndpointStatistics. The number of timed-out IPV4 datagrams waiting for reassembly.

Required/optional:
Returns:	The ipv4_timeout_count of this IpEndpointStatistics.
Return type:	int
	required

ipv4_tx_byte_count¶

Gets the ipv4_tx_byte_count of this IpEndpointStatistics. The number of data payload bytes transmitted in IPV4 packets.

Required/optional:
Returns:	The ipv4_tx_byte_count of this IpEndpointStatistics.
Return type:	int
	required

ipv6_fragmentation¶

Gets the ipv6_fragmentation of this IpEndpointStatistics. The number of IPV6packet fragments received.

Required/optional:
Returns:	The ipv6_fragmentation of this IpEndpointStatistics.
Return type:	int
	required

ipv6_fragmented_pdus_creates¶

Gets the ipv6_fragmented_pdus_creates of this IpEndpointStatistics. The number of IPV6 packet fragments transmitted.

Required/optional:
Returns:	The ipv6_fragmented_pdus_creates of this IpEndpointStatistics.
Return type:	int
	required

ipv6_out_of_order_frag_count¶

Gets the ipv6_out_of_order_frag_count of this IpEndpointStatistics. The number of IPV6 datagrams with fragments received that were out of order.

Required/optional:
Returns:	The ipv6_out_of_order_frag_count of this IpEndpointStatistics.
Return type:	int
	required

ipv6_overlapped_frag_count¶

Gets the ipv6_overlapped_frag_count of this IpEndpointStatistics. The number of IPV6 datagrams with fragments that overlapped.

Required/optional:
Returns:	The ipv6_overlapped_frag_count of this IpEndpointStatistics.
Return type:	int
	required

ipv6_reassembled_packets¶

Gets the ipv6_reassembled_packets of this IpEndpointStatistics. The number of IPV6 datagrams successfully reassembled.

Required/optional:
Returns:	The ipv6_reassembled_packets of this IpEndpointStatistics.
Return type:	int
	required

ipv6_received_pdus¶

Gets the ipv6_received_pdus of this IpEndpointStatistics. The number of IPV6 input datagrams received.

Required/optional:
Returns:	The ipv6_received_pdus of this IpEndpointStatistics.
Return type:	int
	required

ipv6_rx_byte_count¶

Gets the ipv6_rx_byte_count of this IpEndpointStatistics. The number of data payload bytes received in IPV6 packets.

Required/optional:
Returns:	The ipv6_rx_byte_count of this IpEndpointStatistics.
Return type:	int
	required

ipv6_rx_error_count¶

Gets the ipv6_rx_error_count of this IpEndpointStatistics. The number of IPV6 packets received with errors.

Required/optional:
Returns:	The ipv6_rx_error_count of this IpEndpointStatistics.
Return type:	int
	required

ipv6_sent_pdus¶

Gets the ipv6_sent_pdus of this IpEndpointStatistics. The number of IPV6output datagrams sent.

Required/optional:
Returns:	The ipv6_sent_pdus of this IpEndpointStatistics.
Return type:	int
	required

ipv6_timeout_count¶

Gets the ipv6_timeout_count of this IpEndpointStatistics. The number of timed-out IPV6 datagrams waiting for reassembly.

Required/optional:
Returns:	The ipv6_timeout_count of this IpEndpointStatistics.
Return type:	int
	required

ipv6_tx_byte_count¶

Gets the ipv6_tx_byte_count of this IpEndpointStatistics. The number of data payload bytes transmitted in IPV6 packets.

Required/optional:
Returns:	The ipv6_tx_byte_count of this IpEndpointStatistics.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ip_v4_address_data module¶

IpV4AddressData.py

class netapp.santricity.models.symbol.ip_v4_address_data.IpV4AddressData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

config_state¶

Gets the config_state of this IpV4AddressData. Configuration state for the various address elements; always IP_CONFIG_STATE_CONFIGURED for iSER interfaces.

Required/optional:
Returns:	The config_state of this IpV4AddressData.
Return type:	str
	required

ipv4_address¶

Gets the ipv4_address of this IpV4AddressData. The IPV4 address associated with the endpoint.

Required/optional:
Returns:	The ipv4_address of this IpV4AddressData.
Return type:	str
	required

ipv4_gateway_address¶

Gets the ipv4_gateway_address of this IpV4AddressData. IPV4 gateway address associated w/ the endpoint; used for iSER interfaces.

Required/optional:
Returns:	The ipv4_gateway_address of this IpV4AddressData.
Return type:	str
	required

ipv4_subnet_mask¶

Gets the ipv4_subnet_mask of this IpV4AddressData. IPV4 subnet mask associated w/ the endpoint; used for iSER interfaces.

Required/optional:
Returns:	The ipv4_subnet_mask of this IpV4AddressData.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ip_v6_address_data module¶

IpV6AddressData.py

class netapp.santricity.models.symbol.ip_v6_address_data.IpV6AddressData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

address¶

Gets the address of this IpV6AddressData. The IPV6 address.

Required/optional:
Returns:	The address of this IpV6AddressData.
Return type:	str
	required

address_state¶

Gets the address_state of this IpV6AddressData. The state of the IPV6 address.

Required/optional:
Returns:	The address_state of this IpV6AddressData.
Return type:	IpV6AddressState
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ip_v6_address_data_bundle module¶

IpV6AddressDataBundle.py

class netapp.santricity.models.symbol.ip_v6_address_data_bundle.IpV6AddressDataBundle[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

value¶

Gets the value of this IpV6AddressDataBundle.

Required/optional:
Returns:	The value of this IpV6AddressDataBundle.
Return type:	list[IpV6AddressData]
	optional

netapp.santricity.models.symbol.ip_v6_address_state module¶

IpV6AddressState.py

class netapp.santricity.models.symbol.ip_v6_address_state.IpV6AddressState[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

address_type¶

Gets the address_type of this IpV6AddressState. This enumeration defines the two different types of IPV6 addresses - interface or router.

Required/optional:
Returns:	The address_type of this IpV6AddressState.
Return type:	str
	required

interface_address_state¶

Gets the interface_address_state of this IpV6AddressState. The interface address state. This field is only valid if addressType is equal to IPV6_ADDR_TYPE_INTERFACE.

Required/optional:
Returns:	The interface_address_state of this IpV6AddressState.
Return type:	str
	optional

router_address_state¶

Gets the router_address_state of this IpV6AddressState. The router address state. This field is only valid if addressType is equal to IPV6_ADDR_TYPE_ROUTER.

Required/optional:
Returns:	The router_address_state of this IpV6AddressState.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ip_vx_address module¶

IpVxAddress.py

class netapp.santricity.models.symbol.ip_vx_address.IpVxAddress[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

address_type¶

Gets the address_type of this IpVxAddress. This enumeration defines the different types of IP addresses, corresponding to different versions of the Internet protocol.

Required/optional:
Returns:	The address_type of this IpVxAddress.
Return type:	str
	required

ipv4_address¶

Gets the ipv4_address of this IpVxAddress. An IP address formatted according to version 4 of the Internet protocol. This field is only present if addressType is equal to IPV4.

Required/optional:
Returns:	The ipv4_address of this IpVxAddress.
Return type:	str
	optional

ipv6_address¶

Gets the ipv6_address of this IpVxAddress. An IP address formatted according to version 6 of the Internet protocol. This field is only present if addressType is equal to IPV6.

Required/optional:
Returns:	The ipv6_address of this IpVxAddress.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_cable_diag_channel_results module¶

IscsiCableDiagChannelResults.py

class netapp.santricity.models.symbol.iscsi_cable_diag_channel_results.IscsiCableDiagChannelResults[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cable_length¶

Gets the cable_length of this IscsiCableDiagChannelResults. The approximate length of the cable measured in meters.

Required/optional:
Returns:	The cable_length of this IscsiCableDiagChannelResults.
Return type:	int
	required

channel_status¶

Gets the channel_status of this IscsiCableDiagChannelResults. A code indicating the status results for the channel.

Required/optional:
Returns:	The channel_status of this IscsiCableDiagChannelResults.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_cable_diag_results module¶

IscsiCableDiagResults.py

class netapp.santricity.models.symbol.iscsi_cable_diag_results.IscsiCableDiagResults[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel_results¶

Gets the channel_results of this IscsiCableDiagResults. The diagnostic results for each channel. This array will be empty unless the diagnostics completed, i.e., completionStatus is equal to ISCSI_DIAG_STATUS_COMPLETE.

Required/optional:
Returns:	The channel_results of this IscsiCableDiagResults.
Return type:	list[IscsiCableDiagChannelResults]
	required

completion_status¶

Gets the completion_status of this IscsiCableDiagResults. The completion status for the diagnostics.

Required/optional:
Returns:	The completion_status of this IscsiCableDiagResults.
Return type:	str
	required

interface_ref¶

Gets the interface_ref of this IscsiCableDiagResults. A reference to the interface on which the diagnostics were performed.

Required/optional:
Returns:	The interface_ref of this IscsiCableDiagResults.
Return type:	str
	required

time_stamp¶

Gets the time_stamp of this IscsiCableDiagResults. The time the diagnostics were performed, represented in seconds since midnight GMT on January 1, 1970.

Required/optional:
Returns:	The time_stamp of this IscsiCableDiagResults.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_cable_diagnostics_descriptor module¶

IscsiCableDiagnosticsDescriptor.py

class netapp.santricity.models.symbol.iscsi_cable_diagnostics_descriptor.IscsiCableDiagnosticsDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

interface_ref¶

Gets the interface_ref of this IscsiCableDiagnosticsDescriptor. The interface on which the diagnostics should be performed.

Required/optional:
Returns:	The interface_ref of this IscsiCableDiagnosticsDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_cable_diagnostics_return module¶

IscsiCableDiagnosticsReturn.py

class netapp.santricity.models.symbol.iscsi_cable_diagnostics_return.IscsiCableDiagnosticsReturn[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

iscsi_cable_diag_results¶

Gets the iscsi_cable_diag_results of this IscsiCableDiagnosticsReturn. This field is present only if returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The iscsi_cable_diag_results of this IscsiCableDiagnosticsReturn.
Return type:	IscsiCableDiagResults
	optional

return_code¶

Gets the return_code of this IscsiCableDiagnosticsReturn. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this IscsiCableDiagnosticsReturn.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_connection module¶

IscsiConnection.py

class netapp.santricity.models.symbol.iscsi_connection.IscsiConnection[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

active_iscsi_version¶

Gets the active_iscsi_version of this IscsiConnection. The active version number of the iSCSI specification negotiated on this connection.

Required/optional:
Returns:	The active_iscsi_version of this IscsiConnection.
Return type:	str
	required

connection_id¶

Gets the connection_id of this IscsiConnection. The unique identifier of the connection within the scope of the parent session.

Required/optional:
Returns:	The connection_id of this IscsiConnection.
Return type:	int
	required

endpoints¶

Gets the endpoints of this IscsiConnection. The TCP protocol endpoints of the connection.

Required/optional:
Returns:	The endpoints of this IscsiConnection.
Return type:	IscsiConnectionEndpoints
	required

iscsi_interface¶

Gets the iscsi_interface of this IscsiConnection. A reference to the physical interface to which this connection is bound.

Required/optional:
Returns:	The iscsi_interface of this IscsiConnection.
Return type:	str
	required

max_transmit_data_segment_length¶

Gets the max_transmit_data_segment_length of this IscsiConnection. The maximum data payload size supported for command or data PDUs to be sent on this connection.

Required/optional:
Returns:	The max_transmit_data_segment_length of this IscsiConnection.
Return type:	int
	required

mutual_authentication¶

Gets the mutual_authentication of this IscsiConnection. True if the target is required to authenticate itself to the Initiator, in addition to the Initiator authenticating itself to the target.

Required/optional:
Returns:	The mutual_authentication of this IscsiConnection.
Return type:	bool
	required

negotiated_settings¶

Gets the negotiated_settings of this IscsiConnection. A collection of connection-level settings that are subject to initiator-target negotiation.

Required/optional:
Returns:	The negotiated_settings of this IscsiConnection.
Return type:	IscsiNegotiableConnectionSettings
	required

sending_markers¶

Gets the sending_markers of this IscsiConnection. True if this connection is inserting markers in in its outgoing data stream.

Required/optional:
Returns:	The sending_markers of this IscsiConnection.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_connection_endpoints module¶

IscsiConnectionEndpoints.py

class netapp.santricity.models.symbol.iscsi_connection_endpoints.IscsiConnectionEndpoints[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

local_endpoint¶

Gets the local_endpoint of this IscsiConnectionEndpoints. The TCP/IP protocol endpoint that is local to the storage array.

Required/optional:
Returns:	The local_endpoint of this IscsiConnectionEndpoints.
Return type:	TcpProtocolEndpoint
	required

remote_endpoint¶

Gets the remote_endpoint of this IscsiConnectionEndpoints. The TCP/IP protocol endpoint that is remote from the storage array.

Required/optional:
Returns:	The remote_endpoint of this IscsiConnectionEndpoints.
Return type:	TcpProtocolEndpoint
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_entity_changeable_properties module¶

IscsiEntityChangeableProperties.py

class netapp.santricity.models.symbol.iscsi_entity_changeable_properties.IscsiEntityChangeableProperties[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

icmp_ping_response_enabled¶

Gets the icmp_ping_response_enabled of this IscsiEntityChangeableProperties. The setting for enabling or disabling the ICMP (Internet Control Message Protocol) ping messages.

Required/optional:
Returns:	The icmp_ping_response_enabled of this IscsiEntityChangeableProperties.
Return type:	list[bool]
	required

ipv4_isns_server_address¶

Gets the ipv4_isns_server_address of this IscsiEntityChangeableProperties. The IPV4 configuration method to use for determining the IP address of the iSNS server. Whenever there is a transition of the configuration method from IPV4_CONFIG_STATIC to IPV4_CONFIG_DHCP, the storage array performs the equivalent of a refreshIsnsServerLocation operation.

Required/optional:
Returns:	The ipv4_isns_server_address of this IscsiEntityChangeableProperties.
Return type:	list[str]
	required

ipv4_isns_server_address_config_method¶

Gets the ipv4_isns_server_address_config_method of this IscsiEntityChangeableProperties. The IPV4 configuration method to use for determining the IP address of the iSNS server. Whenever there is a transition of the configuration method from IPV4_CONFIG_STATIC to IPV4_CONFIG_DHCP, the storage array performs the equivalent of a refreshIsnsServerLocation operation.

Required/optional:
Returns:	The ipv4_isns_server_address_config_method of this IscsiEntityChangeableProperties.
Return type:	list[str]
	required

ipv6_isns_server_address¶

Gets the ipv6_isns_server_address of this IscsiEntityChangeableProperties. The IPV6 address of the iSNS server.

Required/optional:
Returns:	The ipv6_isns_server_address of this IscsiEntityChangeableProperties.
Return type:	list[str]
	required

isns_server_registration_enabled¶

Gets the isns_server_registration_enabled of this IscsiEntityChangeableProperties. The setting is for enabling or disabling storage array registration with the iSNS server.

Required/optional:
Returns:	The isns_server_registration_enabled of this IscsiEntityChangeableProperties.
Return type:	list[bool]
	required

isns_server_tcp_listen_port¶

Gets the isns_server_tcp_listen_port of this IscsiEntityChangeableProperties. The number of the TCP port on which the iSNS server listens for incoming connections.

Required/optional:
Returns:	The isns_server_tcp_listen_port of this IscsiEntityChangeableProperties.
Return type:	list[int]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

unnamed_discovery_sessions_enabled¶

Gets the unnamed_discovery_sessions_enabled of this IscsiEntityChangeableProperties. The setting for enabling or disabling unnamed discovery sessions.

Required/optional:
Returns:	The unnamed_discovery_sessions_enabled of this IscsiEntityChangeableProperties.
Return type:	list[bool]
	required

netapp.santricity.models.symbol.iscsi_entity_data module¶

IscsiEntityData.py

class netapp.santricity.models.symbol.iscsi_entity_data.IscsiEntityData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

host_ports_configured_dhcp¶

Gets the host_ports_configured_dhcp of this IscsiEntityData. True if all the host ports have DHCP enabled, regardless of the configuration state.

Required/optional:
Returns:	The host_ports_configured_dhcp of this IscsiEntityData.
Return type:	bool
	required

icmp_ping_response_enabled¶

Gets the icmp_ping_response_enabled of this IscsiEntityData. True if the storage array is enabled to respond to ICMP ping messages.

Required/optional:
Returns:	The icmp_ping_response_enabled of this IscsiEntityData.
Return type:	bool
	required

ipv4_isns_server_address¶

Gets the ipv4_isns_server_address of this IscsiEntityData. The method by which the storage array determines the IPV4 address of the iSNS server.

Required/optional:
Returns:	The ipv4_isns_server_address of this IscsiEntityData.
Return type:	str
	required

ipv4_isns_server_address_config_method¶

Gets the ipv4_isns_server_address_config_method of this IscsiEntityData. The method by which the storage array determines the IPV4 address of the iSNS server.

Required/optional:
Returns:	The ipv4_isns_server_address_config_method of this IscsiEntityData.
Return type:	str
	required

ipv6_isns_server_address¶

Gets the ipv6_isns_server_address of this IscsiEntityData. The method by which the storage array determines the IPV6 address of the iSNS server. This is always set to “static” and cannot be changed.

Required/optional:
Returns:	The ipv6_isns_server_address of this IscsiEntityData.
Return type:	str
	required

ipv6_isns_server_address_config_method¶

Gets the ipv6_isns_server_address_config_method of this IscsiEntityData. The method by which the storage array determines the IPV6 address of the iSNS server. This is always set to “static” and cannot be changed.

Required/optional:
Returns:	The ipv6_isns_server_address_config_method of this IscsiEntityData.
Return type:	str
	required

isns_registration_state¶

Gets the isns_registration_state of this IscsiEntityData. The state of the iSCSI entity with respect to iSNS server registration.

Required/optional:
Returns:	The isns_registration_state of this IscsiEntityData.
Return type:	str
	required

isns_server_registration_enabled¶

Gets the isns_server_registration_enabled of this IscsiEntityData. True if the storage array is enabled to register with the iSNS (Internet Storage Name Service) server.

Required/optional:
Returns:	The isns_server_registration_enabled of this IscsiEntityData.
Return type:	bool
	required

isns_server_tcp_listen_port¶

Gets the isns_server_tcp_listen_port of this IscsiEntityData. The number of the TCP port on which the iSNS server listens for incoming connections.

Required/optional:
Returns:	The isns_server_tcp_listen_port of this IscsiEntityData.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

unnamed_discovery_sessions_enabled¶

Gets the unnamed_discovery_sessions_enabled of this IscsiEntityData. True if the storage array is enabled to participate in unnamed discovery sessions.

Required/optional:
Returns:	The unnamed_discovery_sessions_enabled of this IscsiEntityData.
Return type:	bool
	required

netapp.santricity.models.symbol.iscsi_entity_properties_update_descriptor module¶

IscsiEntityPropertiesUpdateDescriptor.py

class netapp.santricity.models.symbol.iscsi_entity_properties_update_descriptor.IscsiEntityPropertiesUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

settings¶

Gets the settings of this IscsiEntityPropertiesUpdateDescriptor. The settings for the new iSCSI entity.

Required/optional:
Returns:	The settings of this IscsiEntityPropertiesUpdateDescriptor.
Return type:	IscsiEntityChangeableProperties
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_initiator_port_id module¶

IscsiInitiatorPortId.py

class netapp.santricity.models.symbol.iscsi_initiator_port_id.IscsiInitiatorPortId[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

initiator_node_name¶

Gets the initiator_node_name of this IscsiInitiatorPortId. The iSCSI node name of the initiator.

Required/optional:
Returns:	The initiator_node_name of this IscsiInitiatorPortId.
Return type:	str
	required

initiator_session_id¶

Gets the initiator_session_id of this IscsiInitiatorPortId. The initiator session ID associated with the initiator port.

Required/optional:
Returns:	The initiator_session_id of this IscsiInitiatorPortId.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_initiator_statistics module¶

IscsiInitiatorStatistics.py

class netapp.santricity.models.symbol.iscsi_initiator_statistics.IscsiInitiatorStatistics[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

authentication_login_failures¶

Gets the authentication_login_failures of this IscsiInitiatorStatistics. This element contains the number of times an initiator login authentication attempt was rejected by the target.

Required/optional:
Returns:	The authentication_login_failures of this IscsiInitiatorStatistics.
Return type:	int
	required

connection_failures¶

Gets the connection_failures of this IscsiInitiatorStatistics. This element contains the number of iSCSI connections for the initiator that terminated abnormally, either by administrative action or due to firmware-detected error.

Required/optional:
Returns:	The connection_failures of this IscsiInitiatorStatistics.
Return type:	int
	required

data_digest_errors¶

Gets the data_digest_errors of this IscsiInitiatorStatistics. This element contains the number of iSCSI PDUs received by the initiator having data digest errors.

Required/optional:
Returns:	The data_digest_errors of this IscsiInitiatorStatistics.
Return type:	int
	required

error_free_pdus¶

Gets the error_free_pdus of this IscsiInitiatorStatistics. This element contains the number of iSCSI PDUs processed by the initiator that experienced no errors of any sort.

Required/optional:
Returns:	The error_free_pdus of this IscsiInitiatorStatistics.
Return type:	int
	required

header_digest_errors¶

Gets the header_digest_errors of this IscsiInitiatorStatistics. This element contains the number of iSCSI PDUs received by the initiator having header digest errors.

Required/optional:
Returns:	The header_digest_errors of this IscsiInitiatorStatistics.
Return type:	int
	required

login_failures¶

Gets the login_failures of this IscsiInitiatorStatistics. This element contains the number of times an iSCSI login attempt to or from the target failed.

Required/optional:
Returns:	The login_failures of this IscsiInitiatorStatistics.
Return type:	int
	required

protocol_error_pdus¶

Gets the protocol_error_pdus of this IscsiInitiatorStatistics. This element contains the number of iSCSI PDUs processed by the initiator that experienced protocol errors.

Required/optional:
Returns:	The protocol_error_pdus of this IscsiInitiatorStatistics.
Return type:	int
	required

session_failures¶

Gets the session_failures of this IscsiInitiatorStatistics. This element contains the number of iSCSI sessions for the initiator that terminated abnormally, either by administrative action or due to firmware-detected error.

Required/optional:
Returns:	The session_failures of this IscsiInitiatorStatistics.
Return type:	int
	required

successful_login_authentications¶

Gets the successful_login_authentications of this IscsiInitiatorStatistics. This element contains the number of times an initiator login authentication attempt was accepted by the target.

Required/optional:
Returns:	The successful_login_authentications of this IscsiInitiatorStatistics.
Return type:	int
	required

successful_logins¶

Gets the successful_logins of this IscsiInitiatorStatistics. This element contains the count of successful iSCSI logins to the target.

Required/optional:
Returns:	The successful_logins of this IscsiInitiatorStatistics.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_initiator_target_base_parameters module¶

IscsiInitiatorTargetBaseParameters.py

class netapp.santricity.models.symbol.iscsi_initiator_target_base_parameters.IscsiInitiatorTargetBaseParameters[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

portals¶

Gets the portals of this IscsiInitiatorTargetBaseParameters. The IP addresses, portal group numbers, and port number for the initiator or target.

Required/optional:
Returns:	The portals of this IscsiInitiatorTargetBaseParameters.
Return type:	list[TargetPortal]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_interface module¶

IscsiInterface.py

class netapp.santricity.models.symbol.iscsi_interface.IscsiInterface[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

bidirectional_max_rate¶

Gets the bidirectional_max_rate of this IscsiInterface. Maximum bi-directional data rate in B/s

Required/optional:
Returns:	The bidirectional_max_rate of this IscsiInterface.
Return type:	int
	required

channel¶

Gets the channel of this IscsiInterface. The number of the channel controlled by this interface.

Required/optional:
Returns:	The channel of this IscsiInterface.
Return type:	int
	required

channel_port_ref¶

Gets the channel_port_ref of this IscsiInterface. A reference to the channel port object associated with the channel controlled by this interface.

Required/optional:
Returns:	The channel_port_ref of this IscsiInterface.
Return type:	str
	required

id¶

Gets the id of this IscsiInterface.

Required/optional:
Returns:	The id of this IscsiInterface.
Return type:	str
	optional

interface_data¶

Gets the interface_data of this IscsiInterface. Information about the physical interface (e.g., Ethernet).

Required/optional:
Returns:	The interface_data of this IscsiInterface.
Return type:	PhysicalInterfaceTypeData
	required

interface_ref¶

Gets the interface_ref of this IscsiInterface. The unique identifier for a given instance of this structure.

Required/optional:
Returns:	The interface_ref of this IscsiInterface.
Return type:	str
	required

ipv4_data¶

Gets the ipv4_data of this IscsiInterface. IPV4-related information for the interface.

Required/optional:
Returns:	The ipv4_data of this IscsiInterface.
Return type:	InternetProtocolV4Data
	required

ipv4_enabled¶

Gets the ipv4_enabled of this IscsiInterface. True if IPV4 is enabled for this interface; always true for iSER interface.

Required/optional:
Returns:	The ipv4_enabled of this IscsiInterface.
Return type:	bool
	required

ipv6_data¶

Gets the ipv6_data of this IscsiInterface. IPV6-related information for the interface.

Required/optional:
Returns:	The ipv6_data of this IscsiInterface.
Return type:	InternetProtocolV6Data
	required

ipv6_enabled¶

Gets the ipv6_enabled of this IscsiInterface. True if IPV6 is enabled for this interface; otherwise false.

Required/optional:
Returns:	The ipv6_enabled of this IscsiInterface.
Return type:	bool
	required

is_i_pv6_capable¶

Gets the is_i_pv6_capable of this IscsiInterface. This flag is true if the interface is capable of IPv6 functionality.

Required/optional:
Returns:	The is_i_pv6_capable of this IscsiInterface.
Return type:	bool
	required

one_way_max_rate¶

Gets the one_way_max_rate of this IscsiInterface. Maximum one way data rate in B/s

Required/optional:
Returns:	The one_way_max_rate of this IscsiInterface.
Return type:	int
	required

physical_location¶

Gets the physical_location of this IscsiInterface. The physical location of the iSCSI interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying “1st iSCSI interface relative to the parent,” “2nd iSCSI interface relative to the parent,” etc. This “interface number” is independent of the interface’s channel association.

Required/optional:
Returns:	The physical_location of this IscsiInterface.
Return type:	Location
	required

protection_information_capable¶

Gets the protection_information_capable of this IscsiInterface. This field indicates whether or not the I/O interface is PI capable.

Required/optional:
Returns:	The protection_information_capable of this IscsiInterface.
Return type:	bool
	required

tcp_listen_port¶

Gets the tcp_listen_port of this IscsiInterface. The number of the TCP port on which the target listens for incoming connections.

Required/optional:
Returns:	The tcp_listen_port of this IscsiInterface.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_interface_changeable_properties module¶

IscsiInterfaceChangeableProperties.py

class netapp.santricity.models.symbol.iscsi_interface_changeable_properties.IscsiInterfaceChangeableProperties[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ipv4_address¶

Gets the ipv4_address of this IscsiInterfaceChangeableProperties. The IPV4 address for the interface.

Required/optional:
Returns:	The ipv4_address of this IscsiInterfaceChangeableProperties.
Return type:	list[str]
	required

ipv4_address_config_method¶

Gets the ipv4_address_config_method of this IscsiInterfaceChangeableProperties. The IPV4 configuration method for the interface. The method is either by static setting of the IP address (IPV4_CONFIG_STATIC) or by use of the dynamic host configuration protocol (IPV4_CONFIG_DHCP). Whenever there is a transition of the configuration method from IPV4_CONFIG_STATIC to IPV4_CONFIG_DHCP, the storage array performs the equivalent of a refreshIscsiDhcpParameters operation.

Required/optional:
Returns:	The ipv4_address_config_method of this IscsiInterfaceChangeableProperties.
Return type:	list[str]
	required

ipv4_enabled¶

Gets the ipv4_enabled of this IscsiInterfaceChangeableProperties. A boolean which, if set to true, indicates that IPV4 addressing should be enabled for the interface.

Required/optional:
Returns:	The ipv4_enabled of this IscsiInterfaceChangeableProperties.
Return type:	list[bool]
	required

ipv4_gateway_address¶

Gets the ipv4_gateway_address of this IscsiInterfaceChangeableProperties. The gateway IPV4 address for the interface.

Required/optional:
Returns:	The ipv4_gateway_address of this IscsiInterfaceChangeableProperties.
Return type:	list[str]
	required

ipv4_outbound_packet_priority¶

Gets the ipv4_outbound_packet_priority of this IscsiInterfaceChangeableProperties. Settings that govern the priority to associate with outbound IPV4 packets sent over the interface.

Required/optional:
Returns:	The ipv4_outbound_packet_priority of this IscsiInterfaceChangeableProperties.
Return type:	list[SettingControl]
	required

ipv4_subnet_mask¶

Gets the ipv4_subnet_mask of this IscsiInterfaceChangeableProperties. The IPV4 subnet mask for the interface.

Required/optional:
Returns:	The ipv4_subnet_mask of this IscsiInterfaceChangeableProperties.
Return type:	list[str]
	required

ipv4_vlan_id¶

Gets the ipv4_vlan_id of this IscsiInterfaceChangeableProperties. Settings that govern the value of the IPV4 VLAN identifier for the interface.

Required/optional:
Returns:	The ipv4_vlan_id of this IscsiInterfaceChangeableProperties.
Return type:	list[SettingControl]
	required

ipv6_address_config_method¶

Gets the ipv6_address_config_method of this IscsiInterfaceChangeableProperties. The method to use in configuring IPV6 addresses for the interface.

Required/optional:
Returns:	The ipv6_address_config_method of this IscsiInterfaceChangeableProperties.
Return type:	list[str]
	required

ipv6_duplicate_address_detection_attempts¶

Gets the ipv6_duplicate_address_detection_attempts of this IscsiInterfaceChangeableProperties. The number of neighbor-solicitation messages to send in trying to determine IP address uniqueness.

Required/optional:
Returns:	The ipv6_duplicate_address_detection_attempts of this IscsiInterfaceChangeableProperties.
Return type:	list[int]
	required

ipv6_enabled¶

Gets the ipv6_enabled of this IscsiInterfaceChangeableProperties. A boolean which, if set to true, indicates that IPV6 addressing should be enabled for the interface.

Required/optional:
Returns:	The ipv6_enabled of this IscsiInterfaceChangeableProperties.
Return type:	list[bool]
	required

ipv6_hop_limit¶

Gets the ipv6_hop_limit of this IscsiInterfaceChangeableProperties. The hop limit to use in IPV6 packets sent over the interface.

Required/optional:
Returns:	The ipv6_hop_limit of this IscsiInterfaceChangeableProperties.
Return type:	list[int]
	required

ipv6_local_addresses¶

Gets the ipv6_local_addresses of this IscsiInterfaceChangeableProperties. The set of IPV6 local addresses that are to be assigned to the interface. This set completely replaces the previous set.

Required/optional:
Returns:	The ipv6_local_addresses of this IscsiInterfaceChangeableProperties.
Return type:	list[IpV6AddressDataBundle]
	required

ipv6_nd_reachable_time¶

Gets the ipv6_nd_reachable_time of this IscsiInterfaceChangeableProperties. The amount of time in milliseconds, within which a neighbor is assumed to be reachable

Required/optional:
Returns:	The ipv6_nd_reachable_time of this IscsiInterfaceChangeableProperties.
Return type:	list[int]
	required

ipv6_nd_retransmit_time¶

Gets the ipv6_nd_retransmit_time of this IscsiInterfaceChangeableProperties. The number of milliseconds between neighbor solicitation probes.

Required/optional:
Returns:	The ipv6_nd_retransmit_time of this IscsiInterfaceChangeableProperties.
Return type:	list[int]
	required

ipv6_nd_stale_timeout¶

Gets the ipv6_nd_stale_timeout of this IscsiInterfaceChangeableProperties. The time in milliseconds after which information for a neighbor that cannot be verified as reachable will be considered “stale.

Required/optional:
Returns:	The ipv6_nd_stale_timeout of this IscsiInterfaceChangeableProperties.
Return type:	list[int]
	required

ipv6_outbound_packet_priority¶

Gets the ipv6_outbound_packet_priority of this IscsiInterfaceChangeableProperties. Settings that govern priority assignment for packets sent over the interface.

Required/optional:
Returns:	The ipv6_outbound_packet_priority of this IscsiInterfaceChangeableProperties.
Return type:	list[SettingControl]
	required

ipv6_port_router_address¶

Gets the ipv6_port_router_address of this IscsiInterfaceChangeableProperties. The address to set for the IPV6 port router.

Required/optional:
Returns:	The ipv6_port_router_address of this IscsiInterfaceChangeableProperties.
Return type:	list[IpV6AddressData]
	required

ipv6_routable_addresses¶

Gets the ipv6_routable_addresses of this IscsiInterfaceChangeableProperties. The set of IPV6 routable addresses that are to be assigned to the interface. This set completely replaces the previous set.

Required/optional:
Returns:	The ipv6_routable_addresses of this IscsiInterfaceChangeableProperties.
Return type:	list[IpV6AddressDataBundle]
	required

ipv6_vlan_id¶

Gets the ipv6_vlan_id of this IscsiInterfaceChangeableProperties. Settings that govern VLAN identifier assignment for packets sent over the interface.

Required/optional:
Returns:	The ipv6_vlan_id of this IscsiInterfaceChangeableProperties.
Return type:	list[SettingControl]
	required

maximum_frame_payload_size¶

Gets the maximum_frame_payload_size of this IscsiInterfaceChangeableProperties. The maximum size of the payload section in an Ethernet frame.

Required/optional:
Returns:	The maximum_frame_payload_size of this IscsiInterfaceChangeableProperties.
Return type:	list[int]
	required

maximum_interface_speed¶

Gets the maximum_interface_speed of this IscsiInterfaceChangeableProperties. This field is used to set the maximum interface speed. If autoconfiguration is supported (see the autoconfigSupport field in the EthernetInterfaceData structure), the value in this field is ignored.

Required/optional:
Returns:	The maximum_interface_speed of this IscsiInterfaceChangeableProperties.
Return type:	list[str]
	required

tcp_listen_port¶

Gets the tcp_listen_port of this IscsiInterfaceChangeableProperties. The tcp port number on which to listen for incoming connections.

Required/optional:
Returns:	The tcp_listen_port of this IscsiInterfaceChangeableProperties.
Return type:	list[int]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_interface_properties_update_descriptor module¶

IscsiInterfacePropertiesUpdateDescriptor.py

class netapp.santricity.models.symbol.iscsi_interface_properties_update_descriptor.IscsiInterfacePropertiesUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

iscsi_interface¶

Gets the iscsi_interface of this IscsiInterfacePropertiesUpdateDescriptor. The data needed to uniquely identify the interface.

Required/optional:
Returns:	The iscsi_interface of this IscsiInterfacePropertiesUpdateDescriptor.
Return type:	str
	required

settings¶

Gets the settings of this IscsiInterfacePropertiesUpdateDescriptor. The property settings for the interface.

Required/optional:
Returns:	The settings of this IscsiInterfacePropertiesUpdateDescriptor.
Return type:	IscsiInterfaceChangeableProperties
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_interface_statistics module¶

IscsiInterfaceStatistics.py

class netapp.santricity.models.symbol.iscsi_interface_statistics.IscsiInterfaceStatistics[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

enh_stats¶

Gets the enh_stats of this IscsiInterfaceStatistics. This member is used to report statistical data related to Enhanced Ethernet features.

Required/optional:
Returns:	The enh_stats of this IscsiInterfaceStatistics.
Return type:	list[EnhancedEthernetStatistics]
	required

ethernet_port_stats¶

Gets the ethernet_port_stats of this IscsiInterfaceStatistics. Statistics related to the physical Ethernet port.

Required/optional:
Returns:	The ethernet_port_stats of this IscsiInterfaceStatistics.
Return type:	list[EthernetPortStatistics]
	required

ip_stats¶

Gets the ip_stats of this IscsiInterfaceStatistics. Statistics related to the IP protocol.

Required/optional:
Returns:	The ip_stats of this IscsiInterfaceStatistics.
Return type:	list[IpEndpointStatistics]
	required

tcp_stats¶

Gets the tcp_stats of this IscsiInterfaceStatistics. Statistics related to the TCP protocol.

Required/optional:
Returns:	The tcp_stats of this IscsiInterfaceStatistics.
Return type:	list[TcpStatisticalData]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_negotiable_connection_settings module¶

IscsiNegotiableConnectionSettings.py

class netapp.santricity.models.symbol.iscsi_negotiable_connection_settings.IscsiNegotiableConnectionSettings[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

auth_method¶

Gets the auth_method of this IscsiNegotiableConnectionSettings. The authentication method being used on this connection, as communicated during the login phase. The same method is followed as for header digest in reporting default versus current settings.

Required/optional:
Returns:	The auth_method of this IscsiNegotiableConnectionSettings.
Return type:	list[str]
	required

data_digest_method¶

Gets the data_digest_method of this IscsiNegotiableConnectionSettings. The iSCSI data digest scheme in use within this connection. The same method is followed as for header digest in reporting default versus current settings.

Required/optional:
Returns:	The data_digest_method of this IscsiNegotiableConnectionSettings.
Return type:	list[str]
	required

header_digest_method¶

Gets the header_digest_method of this IscsiNegotiableConnectionSettings. The iSCSI header digest scheme in use within this connection. This field is an array of at most two elements so that, when reporting default settings, both primary and secondary methods can be reported, which are at array indexes 0 and 1 respectively. When used to report current settings, the array is sized at one.

Required/optional:
Returns:	The header_digest_method of this IscsiNegotiableConnectionSettings.
Return type:	list[str]
	required

max_receive_data_segment_length¶

Gets the max_receive_data_segment_length of this IscsiNegotiableConnectionSettings. The maximum data payload size supported for command or data PDUs able to be received on this connection.

Required/optional:
Returns:	The max_receive_data_segment_length of this IscsiNegotiableConnectionSettings.
Return type:	int
	required

receiving_markers¶

Gets the receiving_markers of this IscsiNegotiableConnectionSettings. True if this connection is receiving markers in in its incoming data stream.

Required/optional:
Returns:	The receiving_markers of this IscsiNegotiableConnectionSettings.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_negotiable_session_settings module¶

IscsiNegotiableSessionSettings.py

class netapp.santricity.models.symbol.iscsi_negotiable_session_settings.IscsiNegotiableSessionSettings[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

data_pdu_in_order¶

Gets the data_pdu_in_order of this IscsiNegotiableSessionSettings. True indicates that data PDUs within sequences must be at continuously increasing addresses, with no gaps or overlay between PDUs. False indicates that iSCSI data PDUs within sequences may be in any order.

Required/optional:
Returns:	The data_pdu_in_order of this IscsiNegotiableSessionSettings.
Return type:	bool
	required

data_sequence_in_order¶

Gets the data_sequence_in_order of this IscsiNegotiableSessionSettings. True indicates that data PDU sequences must be transferred using continuously increasing offsets, except during error recovery False indicates that iSCSI data PDU sequences may be transferred in any order.

Required/optional:
Returns:	The data_sequence_in_order of this IscsiNegotiableSessionSettings.
Return type:	bool
	required

default_time_to_retain¶

Gets the default_time_to_retain of this IscsiNegotiableSessionSettings. The maximum time, in seconds after an initial wait, before which an active iSCSI task reassignment is still possible after an unexpected connection.

Required/optional:
Returns:	The default_time_to_retain of this IscsiNegotiableSessionSettings.
Return type:	int
	required

default_time_to_wait¶

Gets the default_time_to_wait of this IscsiNegotiableSessionSettings. The minimum time, in seconds, to wait before attempting an explicit/implicit logout or active iSCSI task reassignment after an unexpected connection termination or a connection reset.

Required/optional:
Returns:	The default_time_to_wait of this IscsiNegotiableSessionSettings.
Return type:	int
	required

error_recovery_level¶

Gets the error_recovery_level of this IscsiNegotiableSessionSettings. The level of error recovery negotiated between the initiator and the target.

Required/optional:
Returns:	The error_recovery_level of this IscsiNegotiableSessionSettings.
Return type:	int
	required

immediate_data¶

Gets the immediate_data of this IscsiNegotiableSessionSettings. True indicates that the initiator and target have agreed to support immediate data on this session.

Required/optional:
Returns:	The immediate_data of this IscsiNegotiableSessionSettings.
Return type:	bool
	required

initial_r2t¶

Gets the initial_r2t of this IscsiNegotiableSessionSettings. True indicates that the initiator must wait for an R2T before sending to the target. False indicates the initiator may send data immediately.

Required/optional:
Returns:	The initial_r2t of this IscsiNegotiableSessionSettings.
Return type:	bool
	required

max_connections_per_session¶

Gets the max_connections_per_session of this IscsiNegotiableSessionSettings. The maximum number of connections allowed in this session.

Required/optional:
Returns:	The max_connections_per_session of this IscsiNegotiableSessionSettings.
Return type:	int
	required

max_data_burst_length¶

Gets the max_data_burst_length of this IscsiNegotiableSessionSettings. The maximum number of bytes which can be sent within a single sequence of Data-In or Data-Out PDUs.

Required/optional:
Returns:	The max_data_burst_length of this IscsiNegotiableSessionSettings.
Return type:	int
	required

max_outstanding_r2t¶

Gets the max_outstanding_r2t of this IscsiNegotiableSessionSettings. The maximum number of outstanding request-to-transmit (R2T)s per iSCSI task within this session.

Required/optional:
Returns:	The max_outstanding_r2t of this IscsiNegotiableSessionSettings.
Return type:	int
	required

max_unsolicited_first_data_burst_length¶

Gets the max_unsolicited_first_data_burst_length of this IscsiNegotiableSessionSettings. The maximum length supported for unsolicited data sent within this session.

Required/optional:
Returns:	The max_unsolicited_first_data_burst_length of this IscsiNegotiableSessionSettings.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_negotiation_defaults module¶

IscsiNegotiationDefaults.py

class netapp.santricity.models.symbol.iscsi_negotiation_defaults.IscsiNegotiationDefaults[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

connection_defaults¶

Gets the connection_defaults of this IscsiNegotiationDefaults. The connection-level default settings

Required/optional:
Returns:	The connection_defaults of this IscsiNegotiationDefaults.
Return type:	IscsiNegotiableConnectionSettings
	required

session_defaults¶

Gets the session_defaults of this IscsiNegotiationDefaults. The session-level default settings

Required/optional:
Returns:	The session_defaults of this IscsiNegotiationDefaults.
Return type:	IscsiNegotiableSessionSettings
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_negotiation_defaults_returned module¶

IscsiNegotiationDefaultsReturned.py

class netapp.santricity.models.symbol.iscsi_negotiation_defaults_returned.IscsiNegotiationDefaultsReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

defaults¶

Gets the defaults of this IscsiNegotiationDefaultsReturned. The default settings for iSCSI negotiation.

Required/optional:
Returns:	The defaults of this IscsiNegotiationDefaultsReturned.
Return type:	IscsiNegotiationDefaults
	optional

return_code¶

Gets the return_code of this IscsiNegotiationDefaultsReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this IscsiNegotiationDefaultsReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_remote_target_connections module¶

IscsiRemoteTargetConnections.py

class netapp.santricity.models.symbol.iscsi_remote_target_connections.IscsiRemoteTargetConnections[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

connected_remote_target_portals¶

Gets the connected_remote_target_portals of this IscsiRemoteTargetConnections. Connected remote target ports.

Required/optional:
Returns:	The connected_remote_target_portals of this IscsiRemoteTargetConnections.
Return type:	list[TargetPortal]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_session module¶

IscsiSession.py

class netapp.santricity.models.symbol.iscsi_session.IscsiSession[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

connections¶

Gets the connections of this IscsiSession. The set of connections that are associated with this session.

Required/optional:
Returns:	The connections of this IscsiSession.
Return type:	list[IscsiConnection]
	required

endpoints¶

Gets the endpoints of this IscsiSession. The SCSI protocol endpoints of the session.

Required/optional:
Returns:	The endpoints of this IscsiSession.
Return type:	IscsiSessionEndpoints
	required

negotiated_settings¶

Gets the negotiated_settings of this IscsiSession. A collection of session-level settings that are subject to initiator-target negotiation.

Required/optional:
Returns:	The negotiated_settings of this IscsiSession.
Return type:	IscsiNegotiableSessionSettings
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tsih¶

Gets the tsih of this IscsiSession. A target-assigned handle of unspecified format that uniquely identifies the session.

Required/optional:
Returns:	The tsih of this IscsiSession.
Return type:	int
	required

type¶

Gets the type of this IscsiSession. The type of session, discovery or normal.

Required/optional:
Returns:	The type of this IscsiSession.
Return type:	str
	required

netapp.santricity.models.symbol.iscsi_session_endpoints module¶

IscsiSessionEndpoints.py

class netapp.santricity.models.symbol.iscsi_session_endpoints.IscsiSessionEndpoints[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

local_endpoint¶

Gets the local_endpoint of this IscsiSessionEndpoints. The SCSI protocol endpoint that is local to the storage array.

Required/optional:
Returns:	The local_endpoint of this IscsiSessionEndpoints.
Return type:	ScsiProtocolEndpoint
	required

remote_endpoint¶

Gets the remote_endpoint of this IscsiSessionEndpoints. The SCSI protocol endpoint that is remote from the storage array.

Required/optional:
Returns:	The remote_endpoint of this IscsiSessionEndpoints.
Return type:	ScsiProtocolEndpoint
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_sessions_returned module¶

IscsiSessionsReturned.py

class netapp.santricity.models.symbol.iscsi_sessions_returned.IscsiSessionsReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

return_code¶

Gets the return_code of this IscsiSessionsReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this IscsiSessionsReturned.
Return type:	str
	required

sessions¶

Gets the sessions of this IscsiSessionsReturned. The settings that are in effect for the sessions identified in the getIscsiSessions procedure call.

Required/optional:
Returns:	The sessions of this IscsiSessionsReturned.
Return type:	list[IscsiSession]
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_statistical_data module¶

IscsiStatisticalData.py

class netapp.santricity.models.symbol.iscsi_statistical_data.IscsiStatisticalData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller¶

Gets the controller of this IscsiStatisticalData. A reference to the controller that collected these statistics.

Required/optional:
Returns:	The controller of this IscsiStatisticalData.
Return type:	str
	required

iscsi_initiator_statistics¶

Gets the iscsi_initiator_statistics of this IscsiStatisticalData. iSCSI statistical data that pertain to the iSCSI initiator. Each element of the array contains the statistics for one initiator that was collected by this controller. The counters from the two controllers, for a given initiator, must be added together by the client if a combined total for the initiator is desired.

Required/optional:
Returns:	The iscsi_initiator_statistics of this IscsiStatisticalData.
Return type:	list[IscsiInitiatorStatistics]
	required

iscsi_interface_statistics¶

Gets the iscsi_interface_statistics of this IscsiStatisticalData. iSCSI statistical data that pertain to the iSCSI interfaces for this controller. Each sub-structure of IscsiInterfaceStatistics has data identifying the iSCSI interface(s) with which the statistics are associated. Note that the data in any of the sub-structures may be associated with multiple interfaces. See the section on the IscsiInterfaceStatistics structure.

Required/optional:
Returns:	The iscsi_interface_statistics of this IscsiStatisticalData.
Return type:	IscsiInterfaceStatistics
	required

iscsi_target_statistics¶

Gets the iscsi_target_statistics of this IscsiStatisticalData. iSCSI statistical data that pertain to the iSCSI targets. Each element of the array contains the statistics for one target that was collected by this controller. The counters from the two controllers, for a given target, must be added together by the client if a combined total for the target is desired.

Required/optional:
Returns:	The iscsi_target_statistics of this IscsiStatisticalData.
Return type:	list[IscsiTargetStatistics]
	required

time_data¶

Gets the time_data of this IscsiStatisticalData. The time data associated with this set of statistics.

Required/optional:
Returns:	The time_data of this IscsiStatisticalData.
Return type:	StatisticalTimeData
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_statistics_returned module¶

IscsiStatisticsReturned.py

class netapp.santricity.models.symbol.iscsi_statistics_returned.IscsiStatisticsReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

iscsi_statistics¶

Gets the iscsi_statistics of this IscsiStatisticsReturned. This field is an array of structures, one per controller, containing all iSCSI statistical data for the storage array. It is only valid if returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The iscsi_statistics of this IscsiStatisticsReturned.
Return type:	list[IscsiStatisticalData]
	optional

return_code¶

Gets the return_code of this IscsiStatisticsReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this IscsiStatisticsReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_target_port_id module¶

IscsiTargetPortId.py

class netapp.santricity.models.symbol.iscsi_target_port_id.IscsiTargetPortId[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

target_node_name¶

Gets the target_node_name of this IscsiTargetPortId. The iSCSI node name of the target.

Required/optional:
Returns:	The target_node_name of this IscsiTargetPortId.
Return type:	str
	required

target_portal_group_tag¶

Gets the target_portal_group_tag of this IscsiTargetPortId. The portal group tag associated with the target port.

Required/optional:
Returns:	The target_portal_group_tag of this IscsiTargetPortId.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.iscsi_target_statistics module¶

IscsiTargetStatistics.py

class netapp.santricity.models.symbol.iscsi_target_statistics.IscsiTargetStatistics[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

authentication_login_failures¶

Gets the authentication_login_failures of this IscsiTargetStatistics. The number of times an initiator login authentication attempt was rejected by the target.

Required/optional:
Returns:	The authentication_login_failures of this IscsiTargetStatistics.
Return type:	int
	required

connection_failures¶

Gets the connection_failures of this IscsiTargetStatistics. The number of iSCSI connections for the target that terminated abnormally, either by administrative action or due to firmware-detected error.

Required/optional:
Returns:	The connection_failures of this IscsiTargetStatistics.
Return type:	int
	required

data_digest_errors¶

Gets the data_digest_errors of this IscsiTargetStatistics. The number of iSCSI PDUs received by the target having data digest errors.

Required/optional:
Returns:	The data_digest_errors of this IscsiTargetStatistics.
Return type:	int
	required

error_free_pdus¶

Gets the error_free_pdus of this IscsiTargetStatistics. The number of iSCSI PDUs processed by the target that experienced no errors of any sort.

Required/optional:
Returns:	The error_free_pdus of this IscsiTargetStatistics.
Return type:	int
	required

header_digest_errors¶

Gets the header_digest_errors of this IscsiTargetStatistics. The number of iSCSI PDUs received by the target having header digest errors.

Required/optional:
Returns:	The header_digest_errors of this IscsiTargetStatistics.
Return type:	int
	required

login_failures¶

Gets the login_failures of this IscsiTargetStatistics. The number of times an iSCSI login attempt to or from the target failed.

Required/optional:
Returns:	The login_failures of this IscsiTargetStatistics.
Return type:	int
	required

protocol_error_pdus¶

Gets the protocol_error_pdus of this IscsiTargetStatistics. The number of iSCSI PDUs processed by the target that experienced protocol errors.

Required/optional:
Returns:	The protocol_error_pdus of this IscsiTargetStatistics.
Return type:	int
	required

session_failures¶

Gets the session_failures of this IscsiTargetStatistics. The number of iSCSI sessions for the target that terminated abnormally, either by administrative action or due to firmware-detected error.

Required/optional:
Returns:	The session_failures of this IscsiTargetStatistics.
Return type:	int
	required

successful_login_authentications¶

Gets the successful_login_authentications of this IscsiTargetStatistics. The number of times an initiator login authentication attempt was accepted by the target.

Required/optional:
Returns:	The successful_login_authentications of this IscsiTargetStatistics.
Return type:	int
	required

successful_logins¶

Gets the successful_logins of this IscsiTargetStatistics. The count of successful iSCSI logins to the target.

Required/optional:
Returns:	The successful_logins of this IscsiTargetStatistics.
Return type:	int
	required

target¶

Gets the target of this IscsiTargetStatistics. A reference to the target with which the statistics are associated.

Required/optional:
Returns:	The target of this IscsiTargetStatistics.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.isns_server_location module¶

IsnsServerLocation.py

class netapp.santricity.models.symbol.isns_server_location.IsnsServerLocation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ip_address¶

Gets the ip_address of this IsnsServerLocation. The IP address of the iSNS server.

Required/optional:
Returns:	The ip_address of this IsnsServerLocation.
Return type:	IpVxAddress
	required

tcp_listen_port¶

Gets the tcp_listen_port of this IsnsServerLocation. The number of the TCP port on which the iSNS server listens for incoming connections.

Required/optional:
Returns:	The tcp_listen_port of this IsnsServerLocation.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.it_nexus module¶

ITNexus.py

class netapp.santricity.models.symbol.it_nexus.ITNexus[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

host_label¶

Gets the host_label of this ITNexus. The user label for a host port (iSCSI host initiator).

Required/optional:
Returns:	The host_label of this ITNexus.
Return type:	str
	required

initiator_port_id¶

Gets the initiator_port_id of this ITNexus. The TCP port of an iSCSI initiator.

Required/optional:
Returns:	The initiator_port_id of this ITNexus.
Return type:	SCSIInitiatorPortId
	required

target_port_id¶

Gets the target_port_id of this ITNexus. The TCP port of an iSCSI target.

Required/optional:
Returns:	The target_port_id of this ITNexus.
Return type:	SCSITargetPortId
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.key_id_info module¶

KeyIDInfo.py

class netapp.santricity.models.symbol.key_id_info.KeyIDInfo[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

lock_key_id¶

Gets the lock_key_id of this KeyIDInfo. This is the lock Key ID. Whenever a lock key is initialized or changed, a new lock key ID is generated. The lock key ID can be set to a value set by the user, or the controller can generate a lock key. The lock key ID is written to all security-enabled drives that use the referenced lock key. Note that the lock key ID can be read at any time from the disk drive, even if the drive is locked.

Required/optional:
Returns:	The lock_key_id of this KeyIDInfo.
Return type:	str
	required

pass_phrase¶

Gets the pass_phrase of this KeyIDInfo. The Pass Phrase is an alphanumeric string that is used to provide a human-compatible method of generating a lock key (for MegaRAID controllers) or for securely wrapping the lock key (external controllers). The controller firmware places no restrictions on the Pass Phrase, but for improved security, the management application will place the following requirements on a Pass Phrase used for any purpose:

Required/optional:
Returns:	The pass_phrase of this KeyIDInfo.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.key_value_tag module¶

KeyValueTag.py

class netapp.santricity.models.symbol.key_value_tag.KeyValueTag[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

key¶

Gets the key of this KeyValueTag. The key is a fixed length, opaque byte sequence that stores user-defined data.

Required/optional:
Returns:	The key of this KeyValueTag.
Return type:	str
	required

key_value_tag_ref¶

Gets the key_value_tag_ref of this KeyValueTag. The unique handle for a key-value object contained within this structure.

Required/optional:
Returns:	The key_value_tag_ref of this KeyValueTag.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

value¶

Gets the value of this KeyValueTag. The value is a fixed length opaque byte sequence that stores user-defined data.

Required/optional:
Returns:	The value of this KeyValueTag.
Return type:	str
	required

netapp.santricity.models.symbol.key_value_tag_creation_descriptor module¶

KeyValueTagCreationDescriptor.py

class netapp.santricity.models.symbol.key_value_tag_creation_descriptor.KeyValueTagCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

key¶

Gets the key of this KeyValueTagCreationDescriptor. The key is an opaque fixed length byte field that contains user-assigned data. The data is not required to be ASCII.

Required/optional:
Returns:	The key of this KeyValueTagCreationDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

value¶

Gets the value of this KeyValueTagCreationDescriptor. The value is a fixed length opaque byte field that stores user-defined data. The data are not required to be ASCII.

Required/optional:
Returns:	The value of this KeyValueTagCreationDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.key_value_tag_creation_descriptor_list module¶

KeyValueTagCreationDescriptorList.py

class netapp.santricity.models.symbol.key_value_tag_creation_descriptor_list.KeyValueTagCreationDescriptorList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

descriptor_list¶

Gets the descriptor_list of this KeyValueTagCreationDescriptorList. Contains the KeyValue descriptor object.

Required/optional:
Returns:	The descriptor_list of this KeyValueTagCreationDescriptorList.
Return type:	list[KeyValueTagCreationDescriptor]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.key_value_tag_mapping module¶

KeyValueTagMapping.py

class netapp.santricity.models.symbol.key_value_tag_mapping.KeyValueTagMapping[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

associated_object¶

Gets the associated_object of this KeyValueTagMapping. This element identifies the object that is associated with the key-value tag.

Required/optional:
Returns:	The associated_object of this KeyValueTagMapping.
Return type:	KeyValueTagObjectReference
	required

key_value_tag_ref¶

Gets the key_value_tag_ref of this KeyValueTagMapping. This field identifies the key-value tag to be associated with the Volume or Workload.

Required/optional:
Returns:	The key_value_tag_ref of this KeyValueTagMapping.
Return type:	str
	required

mapping_ref¶

Gets the mapping_ref of this KeyValueTagMapping. The unique identifier for the specific mapping between the KeyValueTag and the KeyValueTagObjectReference identified in this structure.

Required/optional:
Returns:	The mapping_ref of this KeyValueTagMapping.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.key_value_tag_mapping_deletion_descriptor module¶

KeyValueTagMappingDeletionDescriptor.py

class netapp.santricity.models.symbol.key_value_tag_mapping_deletion_descriptor.KeyValueTagMappingDeletionDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

associated_object¶

Gets the associated_object of this KeyValueTagMappingDeletionDescriptor. This defines the list of objects whose associates are to be deleted.

Required/optional:
Returns:	The associated_object of this KeyValueTagMappingDeletionDescriptor.
Return type:	KeyValueTagObjectReference
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.key_value_tag_mapping_deletion_descriptor_list module¶

KeyValueTagMappingDeletionDescriptorList.py

class netapp.santricity.models.symbol.key_value_tag_mapping_deletion_descriptor_list.KeyValueTagMappingDeletionDescriptorList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

descriptor_list¶

Gets the descriptor_list of this KeyValueTagMappingDeletionDescriptorList. The array of mappings between a volume and a list of key value tags.

Required/optional:
Returns:	The descriptor_list of this KeyValueTagMappingDeletionDescriptorList.
Return type:	list[KeyValueTagMappingDeletionDescriptor]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.key_value_tag_mapping_set_descriptor module¶

KeyValueTagMappingSetDescriptor.py

class netapp.santricity.models.symbol.key_value_tag_mapping_set_descriptor.KeyValueTagMappingSetDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

key_value_tag_ref_list¶

Gets the key_value_tag_ref_list of this KeyValueTagMappingSetDescriptor. This defines the list of key value tags that are associated with the volume.

Required/optional:
Returns:	The key_value_tag_ref_list of this KeyValueTagMappingSetDescriptor.
Return type:	KeyValueTagRefList
	required

object¶

Gets the object of this KeyValueTagMappingSetDescriptor. This union identifies the type of object and its reference which is to be associated with the key values contained in the list.

Required/optional:
Returns:	The object of this KeyValueTagMappingSetDescriptor.
Return type:	KeyValueTagObjectReference
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.key_value_tag_mapping_set_descriptor_list module¶

KeyValueTagMappingSetDescriptorList.py

class netapp.santricity.models.symbol.key_value_tag_mapping_set_descriptor_list.KeyValueTagMappingSetDescriptorList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

descriptor_list¶

Gets the descriptor_list of this KeyValueTagMappingSetDescriptorList. This field defines the mapping between a specified object and a collection of key values.

Required/optional:
Returns:	The descriptor_list of this KeyValueTagMappingSetDescriptorList.
Return type:	list[KeyValueTagMappingSetDescriptor]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.key_value_tag_object_reference module¶

KeyValueTagObjectReference.py

class netapp.santricity.models.symbol.key_value_tag_object_reference.KeyValueTagObjectReference[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

object_type¶

Gets the object_type of this KeyValueTagObjectReference. Enumeration used to define the different type of object that can be associated with a key value tag.

Required/optional:
Returns:	The object_type of this KeyValueTagObjectReference.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume¶

Gets the volume of this KeyValueTagObjectReference. This field is returned for an object of type Volume.

Required/optional:
Returns:	The volume of this KeyValueTagObjectReference.
Return type:	str
	optional

workload¶

Gets the workload of this KeyValueTagObjectReference. This field is returned for an object of type Workload.

Required/optional:
Returns:	The workload of this KeyValueTagObjectReference.
Return type:	str
	optional

netapp.santricity.models.symbol.key_value_tag_ref_list module¶

KeyValueTagRefList.py

class netapp.santricity.models.symbol.key_value_tag_ref_list.KeyValueTagRefList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

key_value_tag_ref¶

Gets the key_value_tag_ref of this KeyValueTagRefList. An array of references for the key-value tags used for application awareness.

Required/optional:
Returns:	The key_value_tag_ref of this KeyValueTagRefList.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.link_speed_detection_error module¶

LinkSpeedDetectionError.py

class netapp.santricity.models.symbol.link_speed_detection_error.LinkSpeedDetectionError[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this LinkSpeedDetectionError. The drive channel identifier.

Required/optional:
Returns:	The channel of this LinkSpeedDetectionError.
Return type:	int
	required

channel_port¶

Gets the channel_port of this LinkSpeedDetectionError. The channel port identifier.

Required/optional:
Returns:	The channel_port of this LinkSpeedDetectionError.
Return type:	int
	required

channel_port_ref¶

Gets the channel_port_ref of this LinkSpeedDetectionError. A reference to the channel port object identifying where the link speed detection occurred. This field is currently not used.

Required/optional:
Returns:	The channel_port_ref of this LinkSpeedDetectionError.
Return type:	str
	required

connector¶

Gets the connector of this LinkSpeedDetectionError. Connector type from VPD data.

Required/optional:
Returns:	The connector of this LinkSpeedDetectionError.
Return type:	str
	required

current_link_speed¶

Gets the current_link_speed of this LinkSpeedDetectionError. Actual link speed.

Required/optional:
Returns:	The current_link_speed of this LinkSpeedDetectionError.
Return type:	int
	required

manually_bypassed¶

Gets the manually_bypassed of this LinkSpeedDetectionError. True if manually bypassed.

Required/optional:
Returns:	The manually_bypassed of this LinkSpeedDetectionError.
Return type:	bool
	required

parent_ref¶

Gets the parent_ref of this LinkSpeedDetectionError. The reference for the controller.

Required/optional:
Returns:	The parent_ref of this LinkSpeedDetectionError.
Return type:	str
	required

supported_link_speeds¶

Gets the supported_link_speeds of this LinkSpeedDetectionError. Link speeds supported by device.

Required/optional:
Returns:	The supported_link_speeds of this LinkSpeedDetectionError.
Return type:	list[str]
	required

supports_speed¶

Gets the supports_speed of this LinkSpeedDetectionError. True if currentLinkSpeed is also supported

Required/optional:
Returns:	The supports_speed of this LinkSpeedDetectionError.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.location module¶

Location.py

class netapp.santricity.models.symbol.location.Location[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

label¶

Gets the label of this Location. Label associated with the location (i.e., label printed on the canister or the enclosure).

Required/optional:
Returns:	The label of this Location.
Return type:	str
	required

location_parent¶

Gets the location_parent of this Location. An object reference that identifies the parent physical component (e.g., Tray, CRU, etc.) of the object containing the Location attribute.

Required/optional:
Returns:	The location_parent of this Location.
Return type:	ObjectReference
	required

location_position¶

Gets the location_position of this Location. The parent-relative/like-component relative position of the object containing the Location attribute.

Required/optional:
Returns:	The location_position of this Location.
Return type:	int
	required

slot¶

Gets the slot of this Location. The slot identifier, or ordinal identifier, of the component within its physical tray.

Required/optional:
Returns:	The slot of this Location.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray_ref¶

Gets the tray_ref of this Location. The TrayRef reference value of the tray object in which the component resides.

Required/optional:
Returns:	The tray_ref of this Location.
Return type:	str
	required

netapp.santricity.models.symbol.lock_down_info module¶

LockDownInfo.py

class netapp.santricity.models.symbol.lock_down_info.LockDownInfo[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

board_id¶

Gets the board_id of this LockDownInfo. This field contains the board id of the foreign controller.

Required/optional:
Returns:	The board_id of this LockDownInfo.
Return type:	str
	required

board_submodel_id¶

Gets the board_submodel_id of this LockDownInfo. sub-model ID of the foreign controller.

Required/optional:
Returns:	The board_submodel_id of this LockDownInfo.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.lock_down_info_returned module¶

LockDownInfoReturned.py

class netapp.santricity.models.symbol.lock_down_info_returned.LockDownInfoReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

lock_down_info¶

Gets the lock_down_info of this LockDownInfoReturned. This field contains information about a locked down controller and is only valid if returnCode is RETCODE_OK.

Required/optional:
Returns:	The lock_down_info of this LockDownInfoReturned.
Return type:	LockDownInfo
	optional

return_code¶

Gets the return_code of this LockDownInfoReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this LockDownInfoReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.lock_key_blob module¶

LockKeyBlob.py

class netapp.santricity.models.symbol.lock_key_blob.LockKeyBlob[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

lock_key¶

Gets the lock_key of this LockKeyBlob. The wrapped lock key that contains the encrypted wrappedLockKey string.

Required/optional:
Returns:	The lock_key of this LockKeyBlob.
Return type:	WrappedLockKey
	required

pass_phrase¶

Gets the pass_phrase of this LockKeyBlob. The encrypted pass phrase used in generating the wrappedLockKey string.

Required/optional:
Returns:	The pass_phrase of this LockKeyBlob.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.lock_key_id module¶

LockKeyID.py

class netapp.santricity.models.symbol.lock_key_id.LockKeyID[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

lock_key_id¶

Gets the lock_key_id of this LockKeyID. The lock key ID.

Required/optional:
Returns:	The lock_key_id of this LockKeyID.
Return type:	str
	required

lock_key_id_ref¶

Gets the lock_key_id_ref of this LockKeyID. The unique reference to a lockKeyID.

Required/optional:
Returns:	The lock_key_id_ref of this LockKeyID.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.lockdown_ctrl_fw_version module¶

LockdownCtrlFwVersion.py

class netapp.santricity.models.symbol.lockdown_ctrl_fw_version.LockdownCtrlFwVersion[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

fw_version¶

Gets the fw_version of this LockdownCtrlFwVersion. The firmware version of the native controller, as read from the configuration database on the array drives. Note that this will be dot delimited; i.e. nn.nn.nn.nn.

Required/optional:
Returns:	The fw_version of this LockdownCtrlFwVersion.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.long_lived_operation module¶

LongLivedOperation.py

class netapp.santricity.models.symbol.long_lived_operation.LongLivedOperation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

capacity_expansion¶

Gets the capacity_expansion of this LongLivedOperation. This field is present only if volAction is equal to VOL_ACTION_REMAPPING_DCE.

Required/optional:
Returns:	The capacity_expansion of this LongLivedOperation.
Return type:	VolumeGroupOperation
	optional

copy¶

Gets the copy of this LongLivedOperation. This field is present only if volAction is equal to VOL_ACTION_VOLUME_COPY.

Required/optional:
Returns:	The copy of this LongLivedOperation.
Return type:	VolumeCopyOperation
	optional

copy_then_fail¶

Gets the copy_then_fail of this LongLivedOperation. This field is present only if the value of volAction is equal to VOL_ACTION_COPY_THEN_FAIL.

Required/optional:
Returns:	The copy_then_fail of this LongLivedOperation.
Return type:	VolumeGroupOperation
	optional

copy_then_fail_pending¶

Gets the copy_then_fail_pending of this LongLivedOperation. This field is present only if the value of volAction is equal to VOL_ACTION_COPY_THEN_FAIL_PENDING.

Required/optional:
Returns:	The copy_then_fail_pending of this LongLivedOperation.
Return type:	VolumeGroupOperation
	optional

copy_then_replace¶

Gets the copy_then_replace of this LongLivedOperation. This field is present only if the value of volAction is equal to VOL_ACTION_COPY_THEN_REPLACE.

Required/optional:
Returns:	The copy_then_replace of this LongLivedOperation.
Return type:	VolumeGroupOperation
	optional

copy_then_replace_and_fail¶

Gets the copy_then_replace_and_fail of this LongLivedOperation. This field is present only if the value of volAction is equal to VOL_ACTION_COPY_THEN_REPLACE_AND_FAIL.

Required/optional:
Returns:	The copy_then_replace_and_fail of this LongLivedOperation.
Return type:	VolumeGroupOperation
	optional

copyback¶

Gets the copyback of this LongLivedOperation. This field is present only if volAction is equal to VOL_ACTION_COPYBACK.

Required/optional:
Returns:	The copyback of this LongLivedOperation.
Return type:	VolumeGroupOperation
	optional

defrag¶

Gets the defrag of this LongLivedOperation. This field is present only if volAction is equal to VOL_ACTION_REMAPPING_DEFRAG.

Required/optional:
Returns:	The defrag of this LongLivedOperation.
Return type:	VolumeGroupOperation
	optional

format¶

Gets the format of this LongLivedOperation. This field is present only if volAction is equal to VOL_ACTION_FORMATTING.

Required/optional:
Returns:	The format of this LongLivedOperation.
Return type:	InitializationOperation
	optional

init¶

Gets the init of this LongLivedOperation. This field is present only if volAction is equal to VOL_ACTION_INITIALIZING.

Required/optional:
Returns:	The init of this LongLivedOperation.
Return type:	InitializationOperation
	optional

initial_sync¶

Gets the initial_sync of this LongLivedOperation. This field is present only if the value of volAction is equal to VOL_ACTION_ASYNC_MIRROR_GROUP_INITIAL_SYNC.

Required/optional:
Returns:	The initial_sync of this LongLivedOperation.
Return type:	AsyncMirrorGroupInitialSyncOperation
	optional

parity_scan¶

Gets the parity_scan of this LongLivedOperation. This field is present only if volAction is equal to VOL_ACTION_PARITY_SCAN.

Required/optional:
Returns:	The parity_scan of this LongLivedOperation.
Return type:	VolumeGroupOperation
	optional

pit_rollback¶

Gets the pit_rollback of this LongLivedOperation. This field is present only if volAction is equal to VOL_ACTION_PIT_ROLLBACK.

Required/optional:
Returns:	The pit_rollback of this LongLivedOperation.
Return type:	PITRollbackOperation
	optional

raid_migration¶

Gets the raid_migration of this LongLivedOperation. This field is present only if volAction is equal to VOL_ACTION_REMAPPING_DRM.

Required/optional:
Returns:	The raid_migration of this LongLivedOperation.
Return type:	VolumeGroupOperation
	optional

raid_migrationand_expansion¶

Gets the raid_migrationand_expansion of this LongLivedOperation. This field is present only if volAction is equal to VOL_ACTION_REMAPPING_DCEDRM.

Required/optional:
Returns:	The raid_migrationand_expansion of this LongLivedOperation.
Return type:	VolumeGroupOperation
	optional

rebalancing¶

Gets the rebalancing of this LongLivedOperation. This field is present only if the value of volAction is equal to VOL_ACTION_REBALANCING.

Required/optional:
Returns:	The rebalancing of this LongLivedOperation.
Return type:	VolumeGroupOperation
	optional

reconstruct¶

Gets the reconstruct of this LongLivedOperation. This field is present only if volAction is equal to VOL_ACTION_RECONSTRUCTING.

Required/optional:
Returns:	The reconstruct of this LongLivedOperation.
Return type:	VolumeGroupOperation
	optional

reconstruct_critical¶

Gets the reconstruct_critical of this LongLivedOperation. This field is present only if the DDP pool is critical due to two drive failures.

Required/optional:
Returns:	The reconstruct_critical of this LongLivedOperation.
Return type:	VolumeGroupOperation
	optional

rollback¶

Gets the rollback of this LongLivedOperation. This field is present only if volAction is equal to VOL_ACTION_SNAPSHOT_ROLLBACK.

Required/optional:
Returns:	The rollback of this LongLivedOperation.
Return type:	SnapshotRollbackOperation
	optional

seg_size¶

Gets the seg_size of this LongLivedOperation. This field is present only if volAction is equal to VOL_ACTION_REMAPPING_DSEG.

Required/optional:
Returns:	The seg_size of this LongLivedOperation.
Return type:	VolumeGroupOperation
	optional

sync¶

Gets the sync of this LongLivedOperation. This field is present only if volAction is equal to VOL_ACTION_SYNCHRONIZING.

Required/optional:
Returns:	The sync of this LongLivedOperation.
Return type:	MirrorSyncOperation
	optional

thin_defrag¶

Gets the thin_defrag of this LongLivedOperation. Thin volume defrag operation

Required/optional:
Returns:	The thin_defrag of this LongLivedOperation.
Return type:	VolumeOperation
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

vol_action¶

Gets the vol_action of this LongLivedOperation. This enumeration object is used to specify one of a set of volume actions that may be active for a volume. These volume actions represent “long-running” operations on a volume. Any time such an operation is active, the current progress can be determined using the getVolumeActionProgress procedure.

Required/optional:
Returns:	The vol_action of this LongLivedOperation.
Return type:	str
	required

vol_and_cap_expansion¶

Gets the vol_and_cap_expansion of this LongLivedOperation. This field is present only if volAction is equal to VOL_ACTION_REMAPPING_DCEDVE.

Required/optional:
Returns:	The vol_and_cap_expansion of this LongLivedOperation.
Return type:	VolumeGroupOperation
	optional

vol_creation¶

Gets the vol_creation of this LongLivedOperation. A DDP Volume is in the creating state.

Required/optional:
Returns:	The vol_creation of this LongLivedOperation.
Return type:	VolumeOperation
	optional

vol_deletion¶

Gets the vol_deletion of this LongLivedOperation. A DDP Volume is in the deleting state.

Required/optional:
Returns:	The vol_deletion of this LongLivedOperation.
Return type:	VolumeOperation
	optional

vol_expansion¶

Gets the vol_expansion of this LongLivedOperation. This field is present only if volAction is equal to VOL_ACTION_REMAPPING_DVE.

Required/optional:
Returns:	The vol_expansion of this LongLivedOperation.
Return type:	VolumeGroupOperation
	optional

netapp.santricity.models.symbol.long_lived_ops_progress_return module¶

LongLivedOpsProgressReturn.py

class netapp.santricity.models.symbol.long_lived_ops_progress_return.LongLivedOpsProgressReturn[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

long_lived_ops_progress¶

Gets the long_lived_ops_progress of this LongLivedOpsProgressReturn. This field is present only if returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The long_lived_ops_progress of this LongLivedOpsProgressReturn.
Return type:	list[LongLivedOperation]
	optional

return_code¶

Gets the return_code of this LongLivedOpsProgressReturn. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this LongLivedOpsProgressReturn.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.lun_mapping module¶

LUNMapping.py

class netapp.santricity.models.symbol.lun_mapping.LUNMapping[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

id¶

Gets the id of this LUNMapping.

Required/optional:
Returns:	The id of this LUNMapping.
Return type:	str
	optional

lun¶

Gets the lun of this LUNMapping. The unique identification value for this object. Other objects may use this reference value to refer to the mapping definition.

Required/optional:
Returns:	The lun of this LUNMapping.
Return type:	int
	required

lun_mapping_ref¶

Gets the lun_mapping_ref of this LUNMapping. The unique identification value for this object. Other objects may use this reference value to refer to the mapping definition.

Required/optional:
Returns:	The lun_mapping_ref of this LUNMapping.
Return type:	str
	required

map_ref¶

Gets the map_ref of this LUNMapping. The unique identifier of the entity for which the mapping applies. The type of the entity, and thus of the SYMbol reference, depends on the mapping type. For example, if the LUNMapping object represents a cluster-wide mapping, this field will contain the ClusterRef of the cluster for which the mapping applies. Similarly, if the object represents a host-specific mapping, this field will contain the HostRef of the host for which the mapping applies. Note that if the object represents a default mapping, this field will contain a NULL SYMbolRef.

Required/optional:
Returns:	The map_ref of this LUNMapping.
Return type:	str
	required

perms¶

Gets the perms of this LUNMapping. The permission values associated with this mapping definition. This field is not currently used, but is provided for future extensions.

Required/optional:
Returns:	The perms of this LUNMapping.
Return type:	int
	required

ssid¶

Gets the ssid of this LUNMapping. An internal volume identifier value that is not meaningful outside the firmware environment.

Required/optional:
Returns:	The ssid of this LUNMapping.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this LUNMapping. The type of the LUN mapping.

Required/optional:
Returns:	The type of this LUNMapping.
Return type:	str
	required

volume_ref¶

Gets the volume_ref of this LUNMapping. The unique identification value of the volume that is accessed via the LUN value associated with this mapping definition.

Required/optional:
Returns:	The volume_ref of this LUNMapping.
Return type:	str
	required

netapp.santricity.models.symbol.lun_mapping_creation_descriptor module¶

LUNMappingCreationDescriptor.py

class netapp.santricity.models.symbol.lun_mapping_creation_descriptor.LUNMappingCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

lun¶

Gets the lun of this LUNMappingCreationDescriptor. The logical unit number used to access the volume via the new mapping definition.

Required/optional:
Returns:	The lun of this LUNMappingCreationDescriptor.
Return type:	int
	required

map_ref¶

Gets the map_ref of this LUNMappingCreationDescriptor. The unique identifier of the entity for which the mapping applies. The type of the entity, and thus of the SYMbol reference, depends on the mapping type. For example, if the LUNMapping object represents a cluster-wide mapping, this field will contain the ClusterRef of the cluster for which the mapping applies. Similarly, if the object represents a host-specific mapping, this field will contain the HostRef of the host for which the mapping applies. Note that if the object represents a default mapping, this field must contain a NULL SYMbolRef.

Required/optional:
Returns:	The map_ref of this LUNMappingCreationDescriptor.
Return type:	str
	required

perms¶

Gets the perms of this LUNMappingCreationDescriptor. The permission values associated with the new mapping definition. This field is not currently used, but is provided for future extensions.

Required/optional:
Returns:	The perms of this LUNMappingCreationDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this LUNMappingCreationDescriptor. The unique identification value of the volume that is accessed via the LUN value associated with the new mapping definition.

Required/optional:
Returns:	The volume_ref of this LUNMappingCreationDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.lun_mapping_update_descriptor module¶

LUNMappingUpdateDescriptor.py

class netapp.santricity.models.symbol.lun_mapping_update_descriptor.LUNMappingUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

lun¶

Gets the lun of this LUNMappingUpdateDescriptor. A reference to the LUN mapping to update.

Required/optional:
Returns:	The lun of this LUNMappingUpdateDescriptor.
Return type:	int
	required

lun_mapping_ref¶

Gets the lun_mapping_ref of this LUNMappingUpdateDescriptor. A reference to the LUN mapping to update.

Required/optional:
Returns:	The lun_mapping_ref of this LUNMappingUpdateDescriptor.
Return type:	str
	required

map_ref¶

Gets the map_ref of this LUNMappingUpdateDescriptor. The unique identifier of the entity for which the mapping applies. The type of the entity, and thus of the SYMbol reference, depends on the mapping type. For example, if the LUNMapping object represents a cluster-wide mapping, this field will contain the ClusterRef of the cluster for which the mapping applies. Similarly, if the object represents a host-specific mapping, this field will contain the HostRef of the host for which the mapping applies. Note that if the object represents a default mapping, this field must contain a NULL SYMbolRef.

Required/optional:
Returns:	The map_ref of this LUNMappingUpdateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.lun_mappings module¶

LUNMappings.py

class netapp.santricity.models.symbol.lun_mappings.LUNMappings[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

lun_mapping¶

Gets the lun_mapping of this LUNMappings. An array containing all currently-defined LUN mappings. The unique identification value for this object. Other objects may use this reference value to refer to the mapping definition.

Required/optional:
Returns:	The lun_mapping of this LUNMappings.
Return type:	list[LUNMapping]
	required

return_code¶

Gets the return_code of this LUNMappings. An indication of the outcome of the request.

Required/optional:
Returns:	The return_code of this LUNMappings.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.matched_pending_host module¶

MatchedPendingHost.py

class netapp.santricity.models.symbol.matched_pending_host.MatchedPendingHost[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

conflicting_initiators¶

Gets the conflicting_initiators of this MatchedPendingHost. A list of ScsiNodeRef elements representing configured initiators belonging to the pending host that conflict with ports or initiators in the configured topology. The definition of an initiator conflict for a matched pending host is any initiator belonging to the pending host that (1) is not identified in matching Initiators and (2) matches an initiator in the configured topology.

Required/optional:
Returns:	The conflicting_initiators of this MatchedPendingHost.
Return type:	list[str]
	required

conflicting_ports¶

Gets the conflicting_ports of this MatchedPendingHost. A list of HostPortRef structures representing configured ports belonging to the pending host that conflict with ports in the configured topology. The definition of a port conflict for a matched pending host is any port belonging to the pending host that (1) is not identified in matchingPorts and (2) matches a port in the configured topology.

Required/optional:
Returns:	The conflicting_ports of this MatchedPendingHost.
Return type:	list[str]
	required

host_name_change¶

Gets the host_name_change of this MatchedPendingHost. True if the name of the pending host is different than the configured host.

Required/optional:
Returns:	The host_name_change of this MatchedPendingHost.
Return type:	bool
	required

host_type_change¶

Gets the host_type_change of this MatchedPendingHost. True if the type of the pending host is different than the configured host.

Required/optional:
Returns:	The host_type_change of this MatchedPendingHost.
Return type:	bool
	required

match_type¶

Gets the match_type of this MatchedPendingHost. An indication of the host properties on which the match is based.

Required/optional:
Returns:	The match_type of this MatchedPendingHost.
Return type:	str
	required

matching_configured_host¶

Gets the matching_configured_host of this MatchedPendingHost. A reference to the configured host with which the pending host is matched.

Required/optional:
Returns:	The matching_configured_host of this MatchedPendingHost.
Return type:	str
	required

matching_initiators¶

Gets the matching_initiators of this MatchedPendingHost. A list of ScsiNodeRef elements representing configured initiators that are common between this pending host and the configured host identified by the matchingConfiguredHost field.

Required/optional:
Returns:	The matching_initiators of this MatchedPendingHost.
Return type:	list[str]
	required

matching_ports¶

Gets the matching_ports of this MatchedPendingHost. A list of HostPortRef structures representing configured ports that are common between this pending host and the configured host identified by the matchingConfiguredHost field.

Required/optional:
Returns:	The matching_ports of this MatchedPendingHost.
Return type:	list[str]
	required

missing_initiators¶

Gets the missing_initiators of this MatchedPendingHost. A list of ScsiNodeRef elements representing configured initiators belonging to the host identified by matchingConfiguredHost, which are not present in the pending host initiators.

Required/optional:
Returns:	The missing_initiators of this MatchedPendingHost.
Return type:	list[str]
	required

missing_ports¶

Gets the missing_ports of this MatchedPendingHost. A list of HostPortRef structures representing configured ports belonging to the host identified by matchingConfiguredHost, which are not present in the pending host ports.

Required/optional:
Returns:	The missing_ports of this MatchedPendingHost.
Return type:	list[str]
	required

pending_host¶

Gets the pending_host of this MatchedPendingHost. A description of the pending host as it was submitted by the host context agent.

Required/optional:
Returns:	The pending_host of this MatchedPendingHost.
Return type:	PendingHost
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

unconfigured_ports¶

Gets the unconfigured_ports of this MatchedPendingHost. yet been created in the configured topology.

Required/optional:
Returns:	The unconfigured_ports of this MatchedPendingHost.
Return type:	list[SCSIInitiatorPortId]
	required

netapp.santricity.models.symbol.mel_entry module¶

MelEntry.py

class netapp.santricity.models.symbol.mel_entry.MelEntry[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

asc¶

Gets the asc of this MelEntry.

Required/optional:
Returns:	The asc of this MelEntry.
Return type:	int
	optional

ascq¶

Gets the ascq of this MelEntry.

Required/optional:
Returns:	The ascq of this MelEntry.
Return type:	int
	optional

category¶

Gets the category of this MelEntry. The category into which this event falls. This value identifies the general type of activity or event that occurred and caused the entry to be generated.

Required/optional:
Returns:	The category of this MelEntry.
Return type:	str
	required

component_location¶

Gets the component_location of this MelEntry. The location, or other identifying value, of the component associated with this entry.

Required/optional:
Returns:	The component_location of this MelEntry.
Return type:	ComponentLocation
	required

component_type¶

Gets the component_type of this MelEntry. The type of component that is associated with this entry.

Required/optional:
Returns:	The component_type of this MelEntry.
Return type:	str
	required

control_params¶

Gets the control_params of this MelEntry. This field allows customized control over the handling of MEL events.

Required/optional:
Returns:	The control_params of this MelEntry.
Return type:	EventControl
	required

event_source_controller¶

Gets the event_source_controller of this MelEntry. The controller that is the source of the event (Controller 1 or 2).

Required/optional:
Returns:	The event_source_controller of this MelEntry.
Return type:	int
	required

event_type¶

Gets the event_type of this MelEntry. An integer value that indicates the specific type of event being reported.

Required/optional:
Returns:	The event_type of this MelEntry.
Return type:	int
	required

ext_component_location¶

Gets the ext_component_location of this MelEntry. Extended component location information for this entry. This data type of this field is a union with discriminator extLocType. If the discriminator is set to something other than EXT_COMP_LOCTYPE_UNKNOWN, then the location information in this field overrides what is in the componentLocation field.

Required/optional:
Returns:	The ext_component_location of this MelEntry.
Return type:	ExtendedComponentLocation
	required

location_valid¶

Gets the location_valid of this MelEntry. A true/false indication of whether the ComponentLocation field is valid for this entry.

Required/optional:
Returns:	The location_valid of this MelEntry.
Return type:	bool
	required

priority¶

Gets the priority of this MelEntry. The priority code associated with this event.

Required/optional:
Returns:	The priority of this MelEntry.
Return type:	str
	required

raw_data¶

Gets the raw_data of this MelEntry. The raw data stored for this event. This information may be useful for debugging or troubleshooting problems with the assistance of a field support or development representative.

Required/optional:
Returns:	The raw_data of this MelEntry.
Return type:	str
	required

sense_key¶

Gets the sense_key of this MelEntry. The Sense Key value associated with this event, or zero if no key is applicable.

Required/optional:
Returns:	The sense_key of this MelEntry.
Return type:	int
	required

sequence_number¶

Gets the sequence_number of this MelEntry. The sequence number of the MEL entry. The controller maintains a unique, monotonically increasing 64-bit sequence number value and stamps each MEL entry with the next value of this counter.

Required/optional:
Returns:	The sequence_number of this MelEntry.
Return type:	int
	required

time_stamp¶

Gets the time_stamp of this MelEntry. The time at which the MEL entry was generated. This value is defined in terms of the number of seconds since midnight GMT on January 1, 1970.

Required/optional:
Returns:	The time_stamp of this MelEntry.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.mel_entry_list module¶

MelEntryList.py

class netapp.santricity.models.symbol.mel_entry_list.MelEntryList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

events¶

Gets the events of this MelEntryList. A variable-length array of MelEntry objects.

Required/optional:
Returns:	The events of this MelEntryList.
Return type:	list[MelEntry]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.mel_extent module¶

MelExtent.py

class netapp.santricity.models.symbol.mel_extent.MelExtent[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ending_seq_num¶

Gets the ending_seq_num of this MelExtent. When this value is returned by getMelExtents, it is the sequence number that is one beyond the entry at the high end of the extent. For example, if the ending sequence number is 3232, then MEL entries up to sequence 3231 are retrievable. When this value is input to getMelEntries, it is the sequence number of the last MEL event to be returned.

Required/optional:
Returns:	The ending_seq_num of this MelExtent.
Return type:	int
	required

starting_seq_num¶

Gets the starting_seq_num of this MelExtent. This is the sequence number of the entry at the low end of the extent. So, when this value is returned in getMelExtents, it is the sequence number of the first MEL event that can be returned in getMelEntries. When specified as an input to getMelEntries, it is the sequence number of the first MEL event to be returned.

Required/optional:
Returns:	The starting_seq_num of this MelExtent.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.metadata_offline module¶

MetadataOffline.py

class netapp.santricity.models.symbol.metadata_offline.MetadataOffline[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

metadata_volume¶

Gets the metadata_volume of this MetadataOffline. An object to describe the metadata volume.

Required/optional:
Returns:	The metadata_volume of this MetadataOffline.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.metadata_vol_creation_descriptor module¶

MetadataVolCreationDescriptor.py

class netapp.santricity.models.symbol.metadata_vol_creation_descriptor.MetadataVolCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

candidate¶

Gets the candidate of this MetadataVolCreationDescriptor. The volume candidate for the repository.

Required/optional:
Returns:	The candidate of this MetadataVolCreationDescriptor.
Return type:	VolumeCandidate
	required

ctl0_label¶

Gets the ctl0_label of this MetadataVolCreationDescriptor. The user assigned label, as assigned by the firmware, for controller 0 volume.

Required/optional:
Returns:	The ctl0_label of this MetadataVolCreationDescriptor.
Return type:	str
	required

ctl1_label¶

Gets the ctl1_label of this MetadataVolCreationDescriptor. The user assigned label, as assigned by the firmware, for controller 1 volume.

Required/optional:
Returns:	The ctl1_label of this MetadataVolCreationDescriptor.
Return type:	str
	required

metadata_vol_type¶

Gets the metadata_vol_type of this MetadataVolCreationDescriptor. The metadata volume type to create.

Required/optional:
Returns:	The metadata_vol_type of this MetadataVolCreationDescriptor.
Return type:	str
	required

protection_type¶

Gets the protection_type of this MetadataVolCreationDescriptor. The protection type that should be used for the metadata volume being created

Required/optional:
Returns:	The protection_type of this MetadataVolCreationDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_group_label¶

Gets the volume_group_label of this MetadataVolCreationDescriptor. The label to assign to the new volume group for the repository, if any. This field is only used when the repository candidate selection type is CANDIDATE_SEL_MANUAL or CANDIDATE_SEL_COUNT.

Required/optional:
Returns:	The volume_group_label of this MetadataVolCreationDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.metadata_volume module¶

MetadataVolume.py

class netapp.santricity.models.symbol.metadata_volume.MetadataVolume[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

associated_volume¶

Gets the associated_volume of this MetadataVolume. Volume that contains data

Required/optional:
Returns:	The associated_volume of this MetadataVolume.
Return type:	str
	required

metadata_vol_ref¶

Gets the metadata_vol_ref of this MetadataVolume. This object identifies the metadata volume.

Required/optional:
Returns:	The metadata_vol_ref of this MetadataVolume.
Return type:	str
	required

metadata_vol_type¶

Gets the metadata_vol_type of this MetadataVolume. This object specifies the metadata volume type.

Required/optional:
Returns:	The metadata_vol_type of this MetadataVolume.
Return type:	str
	required

offline¶

Gets the offline of this MetadataVolume. True, if the volume is offline.

Required/optional:
Returns:	The offline of this MetadataVolume.
Return type:	bool
	required

perms¶

Gets the perms of this MetadataVolume. The permissions allowed.

Required/optional:
Returns:	The perms of this MetadataVolume.
Return type:	VolumePerms
	required

preferred_manager¶

Gets the preferred_manager of this MetadataVolume. The controller that created the metadata volume.

Required/optional:
Returns:	The preferred_manager of this MetadataVolume.
Return type:	str
	required

reserved1¶

Gets the reserved1 of this MetadataVolume.

Required/optional:
Returns:	The reserved1 of this MetadataVolume.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.mgmt_client_record module¶

MgmtClientRecord.py

class netapp.santricity.models.symbol.mgmt_client_record.MgmtClientRecord[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

content¶

Gets the content of this MgmtClientRecord. This field contains data that is represented as a group of byte values along with information about the content length.

Required/optional:
Returns:	The content of this MgmtClientRecord.
Return type:	str
	required

id¶

Gets the id of this MgmtClientRecord. This field contains the database ID of the record.

Required/optional:
Returns:	The id of this MgmtClientRecord.
Return type:	MgmtClientRecordId
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.mgmt_client_record_delete_descriptor module¶

MgmtClientRecordDeleteDescriptor.py

class netapp.santricity.models.symbol.mgmt_client_record_delete_descriptor.MgmtClientRecordDeleteDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

range_begin¶

Gets the range_begin of this MgmtClientRecordDeleteDescriptor. This field contains the database ID of the first record of a range of records to delete. Note that the delete operation deletes all records in the range, inclusive of this record.

Required/optional:
Returns:	The range_begin of this MgmtClientRecordDeleteDescriptor.
Return type:	MgmtClientRecordId
	required

range_end¶

Gets the range_end of this MgmtClientRecordDeleteDescriptor. This field contains the database ID of the last record of a range of records to delete. Note that the delete operation deletes all records in the range, inclusive of this record.

Required/optional:
Returns:	The range_end of this MgmtClientRecordDeleteDescriptor.
Return type:	MgmtClientRecordId
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.mgmt_client_record_id module¶

MgmtClientRecordId.py

class netapp.santricity.models.symbol.mgmt_client_record_id.MgmtClientRecordId[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

group_id¶

Gets the group_id of this MgmtClientRecordId. Needed.

Required/optional:
Returns:	The group_id of this MgmtClientRecordId.
Return type:	str
	required

record_num¶

Gets the record_num of this MgmtClientRecordId. This object specifies the management client record number in the database.

Required/optional:
Returns:	The record_num of this MgmtClientRecordId.
Return type:	int
	required

reserved¶

Gets the reserved of this MgmtClientRecordId. This field must be set to zero.

Required/optional:
Returns:	The reserved of this MgmtClientRecordId.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.mgmt_client_record_read_descriptor module¶

MgmtClientRecordReadDescriptor.py

class netapp.santricity.models.symbol.mgmt_client_record_read_descriptor.MgmtClientRecordReadDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

range_begin¶

Gets the range_begin of this MgmtClientRecordReadDescriptor. This field contains the database ID of the first record of a range of records to read. Note that the read operation reads all records in the range, inclusive of this record.

Required/optional:
Returns:	The range_begin of this MgmtClientRecordReadDescriptor.
Return type:	MgmtClientRecordId
	required

range_end¶

Gets the range_end of this MgmtClientRecordReadDescriptor. This field contains the database ID of the last record of a range of records to read. Note that the read operation reads all records in the range, inclusive of this record.

Required/optional:
Returns:	The range_end of this MgmtClientRecordReadDescriptor.
Return type:	MgmtClientRecordId
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.mgmt_client_record_read_result module¶

MgmtClientRecordReadResult.py

class netapp.santricity.models.symbol.mgmt_client_record_read_result.MgmtClientRecordReadResult[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

records¶

Gets the records of this MgmtClientRecordReadResult. A variable-length array containing up to MAX_XFER_COUNT records.

Required/optional:
Returns:	The records of this MgmtClientRecordReadResult.
Return type:	list[MgmtClientRecord]
	required

ret_code¶

Gets the ret_code of this MgmtClientRecordReadResult. The return code.

Required/optional:
Returns:	The ret_code of this MgmtClientRecordReadResult.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.mgmt_client_record_write_descriptor module¶

MgmtClientRecordWriteDescriptor.py

class netapp.santricity.models.symbol.mgmt_client_record_write_descriptor.MgmtClientRecordWriteDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

records¶

Gets the records of this MgmtClientRecordWriteDescriptor. A variable-length array containing up to MAX_XFER_COUNT records.

Required/optional:
Returns:	The records of this MgmtClientRecordWriteDescriptor.
Return type:	list[MgmtClientRecord]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.minihub module¶

Minihub.py

class netapp.santricity.models.symbol.minihub.Minihub[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this Minihub. The channel number that this minihub is associated with.

Required/optional:
Returns:	The channel of this Minihub.
Return type:	int
	required

current_speed¶

Gets the current_speed of this Minihub. The current speed of the minihub.

Required/optional:
Returns:	The current_speed of this Minihub.
Return type:	str
	required

fru_type¶

Gets the fru_type of this Minihub. The field replaceable unit type of the minihub.

Required/optional:
Returns:	The fru_type of this Minihub.
Return type:	str
	required

manufacturer_date¶

Gets the manufacturer_date of this Minihub. The date the minihub was manufactured.

Required/optional:
Returns:	The manufacturer_date of this Minihub.
Return type:	int
	required

max_speed¶

Gets the max_speed of this Minihub. The maximum speed of the minihub.

Required/optional:
Returns:	The max_speed of this Minihub.
Return type:	str
	required

minihub_data¶

Gets the minihub_data of this Minihub. Information returned is based on the minihub type.

Required/optional:
Returns:	The minihub_data of this Minihub.
Return type:	MinihubTypeData
	required

minihub_ref¶

Gets the minihub_ref of this Minihub. The reference for this physical minihub.

Required/optional:
Returns:	The minihub_ref of this Minihub.
Return type:	str
	required

part_number¶

Gets the part_number of this Minihub. The part number of the minihub.

Required/optional:
Returns:	The part_number of this Minihub.
Return type:	str
	required

physical_location¶

Gets the physical_location of this Minihub. The physical location of the minihub. Note that the tray reference identifies the enclosure containing the minihub, but the slot information does not apply to this component.

Required/optional:
Returns:	The physical_location of this Minihub.
Return type:	Location
	required

port_list¶

Gets the port_list of this Minihub. Detailed information for each port of the minihub. This field is deprecated.

Required/optional:
Returns:	The port_list of this Minihub.
Return type:	PortList
	required

reserved1¶

Gets the reserved1 of this Minihub.

Required/optional:
Returns:	The reserved1 of this Minihub.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this Minihub.

Required/optional:
Returns:	The reserved2 of this Minihub.
Return type:	str
	optional

rtr_attributes¶

Gets the rtr_attributes of this Minihub. The CRU type of the minihub plus its ready-to-remove attributes, which are based on the CRU type

Required/optional:
Returns:	The rtr_attributes of this Minihub.
Return type:	RTRAttributes
	required

serial_number¶

Gets the serial_number of this Minihub. The serial number of the minihub.

Required/optional:
Returns:	The serial_number of this Minihub.
Return type:	str
	required

status¶

Gets the status of this Minihub. The operational status of the minihub.

Required/optional:
Returns:	The status of this Minihub.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

vendor_name¶

Gets the vendor_name of this Minihub. The vendor name of the minihub.

Required/optional:
Returns:	The vendor_name of this Minihub.
Return type:	str
	required

netapp.santricity.models.symbol.minihub_location module¶

MinihubLocation.py

class netapp.santricity.models.symbol.minihub_location.MinihubLocation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this MinihubLocation. The channel number that this minihub is associated with.

Required/optional:
Returns:	The channel of this MinihubLocation.
Return type:	int
	required

controller_slot¶

Gets the controller_slot of this MinihubLocation. Controller number 1 if in top slot. Controller number 2 if in bottom slot.

Required/optional:
Returns:	The controller_slot of this MinihubLocation.
Return type:	int
	required

minihub_type¶

Gets the minihub_type of this MinihubLocation. Information returned is based on the minihub type.

Required/optional:
Returns:	The minihub_type of this MinihubLocation.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray¶

Gets the tray of this MinihubLocation. Tray ID number. This field is not used and is considered deprecated.

Required/optional:
Returns:	The tray of this MinihubLocation.
Return type:	int
	required

netapp.santricity.models.symbol.minihub_type_data module¶

MinihubTypeData.py

class netapp.santricity.models.symbol.minihub_type_data.MinihubTypeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

minihub_type¶

Gets the minihub_type of this MinihubTypeData. This enumeration is used to identify the type of a minihub.

Required/optional:
Returns:	The minihub_type of this MinihubTypeData.
Return type:	str
	required

parent_controller¶

Gets the parent_controller of this MinihubTypeData. This field is present only if the minihubType value is equal to MINIHUB_TYPE_HOSTSIDE. It contains the detailed information about the controller the minihub is associated with.

Required/optional:
Returns:	The parent_controller of this MinihubTypeData.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.mirror_auto_resync_descriptor module¶

MirrorAutoResyncDescriptor.py

class netapp.santricity.models.symbol.mirror_auto_resync_descriptor.MirrorAutoResyncDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

allow_flag¶

Gets the allow_flag of this MirrorAutoResyncDescriptor. True, if auto resynchronization is allowed.

Required/optional:
Returns:	The allow_flag of this MirrorAutoResyncDescriptor.
Return type:	bool
	required

mirror_proxy¶

Gets the mirror_proxy of this MirrorAutoResyncDescriptor. The mirror proxy reference.

Required/optional:
Returns:	The mirror_proxy of this MirrorAutoResyncDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.mirror_candidate_descriptor module¶

MirrorCandidateDescriptor.py

class netapp.santricity.models.symbol.mirror_candidate_descriptor.MirrorCandidateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

base_volume¶

Gets the base_volume of this MirrorCandidateDescriptor. The local base volume - potential primary volume.

Required/optional:
Returns:	The base_volume of this MirrorCandidateDescriptor.
Return type:	str
	required

remote_node_name¶

Gets the remote_node_name of this MirrorCandidateDescriptor. The name of the RemoteVolume.

Required/optional:
Returns:	The remote_node_name of this MirrorCandidateDescriptor.
Return type:	ScsiNodeName
	required

remote_node_wwn¶

Gets the remote_node_wwn of this MirrorCandidateDescriptor. This field is deprecated. It will continue to be supported if remoteNodeName is NULL (IOInterfaceType == IO_IF_NOT_IMPLEMENTED). This will allow continued compatibility with clients still using this field.

Required/optional:
Returns:	The remote_node_wwn of this MirrorCandidateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.mirror_creation_descriptor module¶

MirrorCreationDescriptor.py

class netapp.santricity.models.symbol.mirror_creation_descriptor.MirrorCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

auto_resync_flag¶

Gets the auto_resync_flag of this MirrorCreationDescriptor. Indicator for whether automatic resynchronization is allowed for this mirror.

Required/optional:
Returns:	The auto_resync_flag of this MirrorCreationDescriptor.
Return type:	bool
	required

base_volume¶

Gets the base_volume of this MirrorCreationDescriptor. The local base volume to mirror from.

Required/optional:
Returns:	The base_volume of this MirrorCreationDescriptor.
Return type:	str
	required

consistency_group_ref¶

Gets the consistency_group_ref of this MirrorCreationDescriptor. Write consistency group reference. NULL = not in group.

Required/optional:
Returns:	The consistency_group_ref of this MirrorCreationDescriptor.
Return type:	str
	required

remote_node_name¶

Gets the remote_node_name of this MirrorCreationDescriptor. The name of the RemoteVolume.

Required/optional:
Returns:	The remote_node_name of this MirrorCreationDescriptor.
Return type:	ScsiNodeName
	required

remote_node_wwn¶

Gets the remote_node_wwn of this MirrorCreationDescriptor. This field is deprecated. It will continue to be supported if remoteNodeName is NULL (IOInterfaceType == IO_IF_NOT_IMPLEMENTED). This will allow continued compatibility with clients still using this field.

Required/optional:
Returns:	The remote_node_wwn of this MirrorCreationDescriptor.
Return type:	str
	required

remote_password¶

Gets the remote_password of this MirrorCreationDescriptor. The password of the remote array.

Required/optional:
Returns:	The remote_password of this MirrorCreationDescriptor.
Return type:	RemoteMirrorAuthenticator
	required

remote_vol_wwn¶

Gets the remote_vol_wwn of this MirrorCreationDescriptor. Remote volume WWN.

Required/optional:
Returns:	The remote_vol_wwn of this MirrorCreationDescriptor.
Return type:	str
	required

sync_priority¶

Gets the sync_priority of this MirrorCreationDescriptor. Synchronization priority for mirrors.

Required/optional:
Returns:	The sync_priority of this MirrorCreationDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

write_mode¶

Gets the write_mode of this MirrorCreationDescriptor. Mirror write mode for the pair.

Required/optional:
Returns:	The write_mode of this MirrorCreationDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.mirror_proxy_volume module¶

MirrorProxyVolume.py

class netapp.santricity.models.symbol.mirror_proxy_volume.MirrorProxyVolume[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

action¶

Gets the action of this MirrorProxyVolume. An indication of what current long-running activity, if any, is currently in progress on the volume.

Required/optional:
Returns:	The action of this MirrorProxyVolume.
Return type:	str
	required

auto_resync¶

Gets the auto_resync of this MirrorProxyVolume. Indicates whether auto resynchronization is allowed.

Required/optional:
Returns:	The auto_resync of this MirrorProxyVolume.
Return type:	bool
	required

base_volume¶

Gets the base_volume of this MirrorProxyVolume. The reference to the base volume of the local mirror.

Required/optional:
Returns:	The base_volume of this MirrorProxyVolume.
Return type:	str
	required

consistency_group_ref¶

Gets the consistency_group_ref of this MirrorProxyVolume. The write consistency group reference.

Required/optional:
Returns:	The consistency_group_ref of this MirrorProxyVolume.
Return type:	str
	required

current_manager¶

Gets the current_manager of this MirrorProxyVolume. The controller reference that owns the local mirror volume.

Required/optional:
Returns:	The current_manager of this MirrorProxyVolume.
Return type:	str
	required

local_mirror_status¶

Gets the local_mirror_status of this MirrorProxyVolume. The status of the local mirror volume.

Required/optional:
Returns:	The local_mirror_status of this MirrorProxyVolume.
Return type:	str
	required

local_priority¶

Gets the local_priority of this MirrorProxyVolume. The synchronization priority for the local mirror volume.

Required/optional:
Returns:	The local_priority of this MirrorProxyVolume.
Return type:	str
	required

local_role¶

Gets the local_role of this MirrorProxyVolume. The role of the local mirror volume.

Required/optional:
Returns:	The local_role of this MirrorProxyVolume.
Return type:	str
	required

local_write_mode¶

Gets the local_write_mode of this MirrorProxyVolume. The local mirror volume’s write mode.

Required/optional:
Returns:	The local_write_mode of this MirrorProxyVolume.
Return type:	str
	required

mirror_proxy_ref¶

Gets the mirror_proxy_ref of this MirrorProxyVolume. The reference to the local mirror volume.

Required/optional:
Returns:	The mirror_proxy_ref of this MirrorProxyVolume.
Return type:	str
	required

peer_priority¶

Gets the peer_priority of this MirrorProxyVolume. The synchronization priority for the remote mirror volume.

Required/optional:
Returns:	The peer_priority of this MirrorProxyVolume.
Return type:	str
	required

remote_mirror_status¶

Gets the remote_mirror_status of this MirrorProxyVolume. The status of the remote mirror volume.

Required/optional:
Returns:	The remote_mirror_status of this MirrorProxyVolume.
Return type:	str
	required

remote_role¶

Gets the remote_role of this MirrorProxyVolume. The role of the remote mirror volume.

Required/optional:
Returns:	The remote_role of this MirrorProxyVolume.
Return type:	str
	required

remote_vol_ref¶

Gets the remote_vol_ref of this MirrorProxyVolume. The reference to the remote volume.

Required/optional:
Returns:	The remote_vol_ref of this MirrorProxyVolume.
Return type:	str
	required

reserved1¶

Gets the reserved1 of this MirrorProxyVolume.

Required/optional:
Returns:	The reserved1 of this MirrorProxyVolume.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this MirrorProxyVolume.

Required/optional:
Returns:	The reserved2 of this MirrorProxyVolume.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

usable_capacity¶

Gets the usable_capacity of this MirrorProxyVolume. The amount of capacity being used by the mirror.

Required/optional:
Returns:	The usable_capacity of this MirrorProxyVolume.
Return type:	int
	required

volume_handle¶

Gets the volume_handle of this MirrorProxyVolume. The ssid of the local mirror volume.

Required/optional:
Returns:	The volume_handle of this MirrorProxyVolume.
Return type:	int
	required

world_wide_name¶

Gets the world_wide_name of this MirrorProxyVolume. The WWN of the local mirror volume.

Required/optional:
Returns:	The world_wide_name of this MirrorProxyVolume.
Return type:	str
	required

netapp.santricity.models.symbol.mirror_role_change_descriptor module¶

MirrorRoleChangeDescriptor.py

class netapp.santricity.models.symbol.mirror_role_change_descriptor.MirrorRoleChangeDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

forced¶

Gets the forced of this MirrorRoleChangeDescriptor. If true, ignore if remote array role change fails.

Required/optional:
Returns:	The forced of this MirrorRoleChangeDescriptor.
Return type:	bool
	required

mirror_proxy¶

Gets the mirror_proxy of this MirrorRoleChangeDescriptor. The reference to the mirror proxy volume.

Required/optional:
Returns:	The mirror_proxy of this MirrorRoleChangeDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_role¶

Gets the to_role of this MirrorRoleChangeDescriptor. The role to change the local mirror proxy volume to: primary or secondary.

Required/optional:
Returns:	The to_role of this MirrorRoleChangeDescriptor.
Return type:	str
	required

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.mirror_sync_operation module¶

MirrorSyncOperation.py

class netapp.santricity.models.symbol.mirror_sync_operation.MirrorSyncOperation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

mirror_proxy_ref¶

Gets the mirror_proxy_ref of this MirrorSyncOperation. Reference to the mirror proxy.

Required/optional:
Returns:	The mirror_proxy_ref of this MirrorSyncOperation.
Return type:	str
	required

percent_complete¶

Gets the percent_complete of this MirrorSyncOperation. Completion percentage for the operation. If the operation is not currently running this value will be equal to PERCENT_COMPLETE_OP_NOT_RUNNING

Required/optional:
Returns:	The percent_complete of this MirrorSyncOperation.
Return type:	int
	required

time_to_completion¶

Gets the time_to_completion of this MirrorSyncOperation. Estimated time to completion in minutes. If the time is not known this value will be equal to TIME_TO_COMPLETION_UNKNOWN.

Required/optional:
Returns:	The time_to_completion of this MirrorSyncOperation.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.mirror_sync_priority_descriptor module¶

MirrorSyncPriorityDescriptor.py

class netapp.santricity.models.symbol.mirror_sync_priority_descriptor.MirrorSyncPriorityDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

mirror_proxy¶

Gets the mirror_proxy of this MirrorSyncPriorityDescriptor. The reference to the mirror proxy volume.

Required/optional:
Returns:	The mirror_proxy of this MirrorSyncPriorityDescriptor.
Return type:	str
	required

sync_priority¶

Gets the sync_priority of this MirrorSyncPriorityDescriptor. The synchronization priority level. Valid values are 0-4.

Required/optional:
Returns:	The sync_priority of this MirrorSyncPriorityDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.mirror_unsynchronized module¶

MirrorUnsynchronized.py

class netapp.santricity.models.symbol.mirror_unsynchronized.MirrorUnsynchronized[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

mirror_volume¶

Gets the mirror_volume of this MirrorUnsynchronized. The reference to the mirror volume that is unsynchronized.

Required/optional:
Returns:	The mirror_volume of this MirrorUnsynchronized.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.mirror_volume_candidate module¶

MirrorVolumeCandidate.py

class netapp.santricity.models.symbol.mirror_volume_candidate.MirrorVolumeCandidate[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

capacity¶

Gets the capacity of this MirrorVolumeCandidate. The capacity of the remote volume.

Required/optional:
Returns:	The capacity of this MirrorVolumeCandidate.
Return type:	int
	required

protection_type¶

Gets the protection_type of this MirrorVolumeCandidate. The protection type of the mirror volume candidate.

Required/optional:
Returns:	The protection_type of this MirrorVolumeCandidate.
Return type:	str
	required

raid_level¶

Gets the raid_level of this MirrorVolumeCandidate. The RAID level of the remote volume.

Required/optional:
Returns:	The raid_level of this MirrorVolumeCandidate.
Return type:	str
	required

remote_vol_label¶

Gets the remote_vol_label of this MirrorVolumeCandidate. The user assigned label of the remote volume.

Required/optional:
Returns:	The remote_vol_label of this MirrorVolumeCandidate.
Return type:	str
	required

remote_vol_wwn¶

Gets the remote_vol_wwn of this MirrorVolumeCandidate. The WWN of the remote volume.

Required/optional:
Returns:	The remote_vol_wwn of this MirrorVolumeCandidate.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.mirror_volume_candidate_list module¶

MirrorVolumeCandidateList.py

class netapp.santricity.models.symbol.mirror_volume_candidate_list.MirrorVolumeCandidateList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

mirror_volume_candidate¶

Gets the mirror_volume_candidate of this MirrorVolumeCandidateList. The list of valid volumes for mirroring.

Required/optional:
Returns:	The mirror_volume_candidate of this MirrorVolumeCandidateList.
Return type:	list[MirrorVolumeCandidate]
	required

remote_cfg_generation¶

Gets the remote_cfg_generation of this MirrorVolumeCandidateList. The current configuration generation number of the remote array.

Required/optional:
Returns:	The remote_cfg_generation of this MirrorVolumeCandidateList.
Return type:	int
	required

return_code¶

Gets the return_code of this MirrorVolumeCandidateList. The return code from getVolumeListForMirroring.

Required/optional:
Returns:	The return_code of this MirrorVolumeCandidateList.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.mirror_volume_list module¶

MirrorVolumeList.py

class netapp.santricity.models.symbol.mirror_volume_list.MirrorVolumeList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

mirror_volume¶

Gets the mirror_volume of this MirrorVolumeList. The list of valid volumes for mirroring.

Required/optional:
Returns:	The mirror_volume of this MirrorVolumeList.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.mirror_write_mode_descriptor module¶

MirrorWriteModeDescriptor.py

class netapp.santricity.models.symbol.mirror_write_mode_descriptor.MirrorWriteModeDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

consistency_group_ref¶

Gets the consistency_group_ref of this MirrorWriteModeDescriptor. The reference for the consistency group.

Required/optional:
Returns:	The consistency_group_ref of this MirrorWriteModeDescriptor.
Return type:	str
	required

mirror_proxy¶

Gets the mirror_proxy of this MirrorWriteModeDescriptor. The mirror proxy.

Required/optional:
Returns:	The mirror_proxy of this MirrorWriteModeDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

write_mode¶

Gets the write_mode of this MirrorWriteModeDescriptor. The write mode.

Required/optional:
Returns:	The write_mode of this MirrorWriteModeDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.miswired_drive_channel_list module¶

MiswiredDriveChannelList.py

class netapp.santricity.models.symbol.miswired_drive_channel_list.MiswiredDriveChannelList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_channels¶

Gets the drive_channels of this MiswiredDriveChannelList. This is a list of drive channels.

Required/optional:
Returns:	The drive_channels of this MiswiredDriveChannelList.
Return type:	list[int]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.net_interface_type_data module¶

NetInterfaceTypeData.py

class netapp.santricity.models.symbol.net_interface_type_data.NetInterfaceTypeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ethernet¶

Gets the ethernet of this NetInterfaceTypeData. This field is present only if the interfaceType value is equal to NET_IF_ETHERNET. It contains the detailed interface information for an Ethernet network interface.

Required/optional:
Returns:	The ethernet of this NetInterfaceTypeData.
Return type:	EthernetInterface
	optional

interface_type¶

Gets the interface_type of this NetInterfaceTypeData. This enumeration defines the different network interface types that may be reported as part of the interface information associated with a controller.

Required/optional:
Returns:	The interface_type of this NetInterfaceTypeData.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.network_address module¶

NetworkAddress.py

class netapp.santricity.models.symbol.network_address.NetworkAddress[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

addr_type¶

Gets the addr_type of this NetworkAddress. This enum defines the possible network address types.

Required/optional:
Returns:	The addr_type of this NetworkAddress.
Return type:	str
	required

domain_name¶

Gets the domain_name of this NetworkAddress. Fully qualified domain name. This should be considered an IDN-unaware domain name slot as per RFC3490.

Required/optional:
Returns:	The domain_name of this NetworkAddress.
Return type:	str
	optional

ipvx_address¶

Gets the ipvx_address of this NetworkAddress. IPv4 or IPv6 address

Required/optional:
Returns:	The ipvx_address of this NetworkAddress.
Return type:	IpVxAddress
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.network_interface module¶

NetworkInterface.py

class netapp.santricity.models.symbol.network_interface.NetworkInterface[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel_type¶

Gets the channel_type of this NetworkInterface. The type of channel that the interface is associated with.

Required/optional:
Returns:	The channel_type of this NetworkInterface.
Return type:	str
	required

interface_ref¶

Gets the interface_ref of this NetworkInterface. The SYMbol array-wide unique name for the interface object.

Required/optional:
Returns:	The interface_ref of this NetworkInterface.
Return type:	str
	required

net_interface_type_data¶

Gets the net_interface_type_data of this NetworkInterface. A field whose contents vary depending on the type of the interface.

Required/optional:
Returns:	The net_interface_type_data of this NetworkInterface.
Return type:	NetInterfaceTypeData
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.new_lock_key module¶

NewLockKey.py

class netapp.santricity.models.symbol.new_lock_key.NewLockKey[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

lock_key_id¶

Gets the lock_key_id of this NewLockKey. The lock key ID to set for this lock key.

Required/optional:
Returns:	The lock_key_id of this NewLockKey.
Return type:	str
	required

new_key_sequence¶

Gets the new_key_sequence of this NewLockKey. The sequence number for this key.

Required/optional:
Returns:	The new_key_sequence of this NewLockKey.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

wrapped_lock_key¶

Gets the wrapped_lock_key of this NewLockKey. The wrapped lock key.

Required/optional:
Returns:	The wrapped_lock_key of this NewLockKey.
Return type:	str
	required

netapp.santricity.models.symbol.not_on_preferred_path module¶

NotOnPreferredPath.py

class netapp.santricity.models.symbol.not_on_preferred_path.NotOnPreferredPath[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

preferred_owner¶

Gets the preferred_owner of this NotOnPreferredPath. The preferred owner.

Required/optional:
Returns:	The preferred_owner of this NotOnPreferredPath.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volumes¶

Gets the volumes of this NotOnPreferredPath. A list of volumes not on the preferred path.

Required/optional:
Returns:	The volumes of this NotOnPreferredPath.
Return type:	list[str]
	required

netapp.santricity.models.symbol.ntp_acquisition_descriptor module¶

NtpAcquisitionDescriptor.py

class netapp.santricity.models.symbol.ntp_acquisition_descriptor.NtpAcquisitionDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ntp_acquisition_type¶

Gets the ntp_acquisition_type of this NtpAcquisitionDescriptor. How the NTP server addresses are acquired.

Required/optional:
Returns:	The ntp_acquisition_type of this NtpAcquisitionDescriptor.
Return type:	str
	required

ntp_servers¶

Gets the ntp_servers of this NtpAcquisitionDescriptor. This field is used if the method is set to NTP_ACQUISITION_METHOD_STATIC. If more than one address is specified, the first (lowest index) item is given highest precedence and the last item (highest index) is given the lowest precedence.

Required/optional:
Returns:	The ntp_servers of this NtpAcquisitionDescriptor.
Return type:	list[NetworkAddress]
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.nvsram_region module¶

NVSRAMRegion.py

class netapp.santricity.models.symbol.nvsram_region.NVSRAMRegion[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

region_data¶

Gets the region_data of this NVSRAMRegion. A variable-length byte array that contains the complete content of the region.

Required/optional:
Returns:	The region_data of this NVSRAMRegion.
Return type:	str
	required

region_id¶

Gets the region_id of this NVSRAMRegion. The identifier of the region whose data is contained in this object.

Required/optional:
Returns:	The region_id of this NVSRAMRegion.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.nvsram_region_id_and_host_index module¶

NVSRAMRegionIdAndHostIndex.py

class netapp.santricity.models.symbol.nvsram_region_id_and_host_index.NVSRAMRegionIdAndHostIndex[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

host_index¶

Gets the host_index of this NVSRAMRegionIdAndHostIndex. Host Type Index mapped by SPM.

Required/optional:
Returns:	The host_index of this NVSRAMRegionIdAndHostIndex.
Return type:	int
	required

region_id¶

Gets the region_id of this NVSRAMRegionIdAndHostIndex. The region of NVSRAM to update.

Required/optional:
Returns:	The region_id of this NVSRAMRegionIdAndHostIndex.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.nvsram_region_list module¶

NVSRAMRegionList.py

class netapp.santricity.models.symbol.nvsram_region_list.NVSRAMRegionList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

nvsram¶

Gets the nvsram of this NVSRAMRegionList. A variable-length array of NVSRAM region objects.

Required/optional:
Returns:	The nvsram of this NVSRAMRegionList.
Return type:	list[NVSRAMRegion]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.nvsram_update_descriptor module¶

NVSRAMUpdateDescriptor.py

class netapp.santricity.models.symbol.nvsram_update_descriptor.NVSRAMUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

offset¶

Gets the offset of this NVSRAMUpdateDescriptor. The offset from the beginning of the region where the update is to begin.

Required/optional:
Returns:	The offset of this NVSRAMUpdateDescriptor.
Return type:	int
	required

region_data¶

Gets the region_data of this NVSRAMUpdateDescriptor. A variable-length array of bytes that provides the new data to be written to the controller’s NVSRAM starting at the location specified by the offset field.

Required/optional:
Returns:	The region_data of this NVSRAMUpdateDescriptor.
Return type:	str
	required

region_id¶

Gets the region_id of this NVSRAMUpdateDescriptor. The region identifier for the NVSRAM region to be modified.

Required/optional:
Returns:	The region_id of this NVSRAMUpdateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.object_bundle module¶

ObjectBundle.py

class netapp.santricity.models.symbol.object_bundle.ObjectBundle[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

application_awareness_bundle¶

Gets the application_awareness_bundle of this ObjectBundle. This reports the key-value pairs and their references, and the mappings between Volumes and these key-value pairs. The data is used by the application and is opaque to the CFW.

Required/optional:
Returns:	The application_awareness_bundle of this ObjectBundle.
Return type:	ApplicationAwarenessBundle
	required

component_bundle¶

Gets the component_bundle of this ObjectBundle. A variable-length array of Component structures. This array contains one element for each physical component object that exists within the storage array.

Required/optional:
Returns:	The component_bundle of this ObjectBundle.
Return type:	ComponentBundle
	required

config_generation¶

Gets the config_generation of this ObjectBundle. The configuration generation number that was in effect at the time this object bundle was constructed by the controller. The client can use this value to determine if it currently holds the latest version of the object graph.

Required/optional:
Returns:	The config_generation of this ObjectBundle.
Return type:	int
	required

consistency_group_bundle¶

Gets the consistency_group_bundle of this ObjectBundle. Write consistency group bundle.

Required/optional:
Returns:	The consistency_group_bundle of this ObjectBundle.
Return type:	ConsistencyGroupBundle
	required

controller¶

Gets the controller of this ObjectBundle. A variable-length array of Controller structures. This array contains one element for each RAID controller object that exists within the storage array.

Required/optional:
Returns:	The controller of this ObjectBundle.
Return type:	list[Controller]
	required

drive¶

Gets the drive of this ObjectBundle. A variable-length array of Drive structures. This array contains one element for each physical disk drive object that exists within the storage array.

Required/optional:
Returns:	The drive of this ObjectBundle.
Return type:	list[Drive]
	required

dve_vol¶

Gets the dve_vol of this ObjectBundle. A variable-length array of DVE structures. This array contains one element for each volume being expanded.

Required/optional:
Returns:	The dve_vol of this ObjectBundle.
Return type:	list[DVEVolume]
	required

flash_cache_bundle¶

Gets the flash_cache_bundle of this ObjectBundle. An embedded object bundle that contains all of the information related to flash cache objects.

Required/optional:
Returns:	The flash_cache_bundle of this ObjectBundle.
Return type:	FlashCacheBundle
	required

free_extent¶

Gets the free_extent of this ObjectBundle. A variable-length array of FreeExtent structures. This array contains one element for each free extent object that exists within the storage array.

Required/optional:
Returns:	The free_extent of this ObjectBundle.
Return type:	list[FreeExtent]
	required

ghost_vol_bundle¶

Gets the ghost_vol_bundle of this ObjectBundle. An embedded object bundle that contains all the information relative to missing volumes.

Required/optional:
Returns:	The ghost_vol_bundle of this ObjectBundle.
Return type:	GhostVolBundle
	required

high_level_vol_bundle¶

Gets the high_level_vol_bundle of this ObjectBundle. An embedded object bundle that contains all the information relative to the Higher-Level Volumes.

Required/optional:
Returns:	The high_level_vol_bundle of this ObjectBundle.
Return type:	HLVolumeBundle
	required

interposer¶

Gets the interposer of this ObjectBundle. A variable length array of drive interposer data. An entry will appear in this array only if the interposerPresent field in the corresponding Drive structure is set to True.

Required/optional:
Returns:	The interposer of this ObjectBundle.
Return type:	list[Interposer]
	required

io_interface¶

Gets the io_interface of this ObjectBundle. A variable-length array of IoInterface structures. This array contains one element for each I/O interface object that exists within the storage array

Required/optional:
Returns:	The io_interface of this ObjectBundle.
Return type:	list[IoInterface]
	required

io_interface_hic_map¶

Gets the io_interface_hic_map of this ObjectBundle. This is a list of structures that provides a mapping from I/O interfaces to their associated HICs.

Required/optional:
Returns:	The io_interface_hic_map of this ObjectBundle.
Return type:	list[IoInterfaceHicMap]
	required

lock_key_i_ds¶

Gets the lock_key_i_ds of this ObjectBundle. A variable length array of LockKeyID structures. Contains lock key information for the array.

Required/optional:
Returns:	The lock_key_i_ds of this ObjectBundle.
Return type:	list[LockKeyID]
	required

network_interface¶

Gets the network_interface of this ObjectBundle. A variable-length array of NetworkInterface structures. This array contains one element for each network interface object that exists within the storage array

Required/optional:
Returns:	The network_interface of this ObjectBundle.
Return type:	list[NetworkInterface]
	required

remote_array¶

Gets the remote_array of this ObjectBundle. This is a list of remote arrays which this array has visibility to for monitoring.

Required/optional:
Returns:	The remote_array of this ObjectBundle.
Return type:	list[RemoteArray]
	required

sa¶

Gets the sa of this ObjectBundle. A StorageArray object that contains base information about the storage array as a whole.

Required/optional:
Returns:	The sa of this ObjectBundle.
Return type:	StorageArray
	required

schedule¶

Gets the schedule of this ObjectBundle. A list of current schedules.

Required/optional:
Returns:	The schedule of this ObjectBundle.
Return type:	list[ScheduleInstance]
	required

snmp_bundle¶

Gets the snmp_bundle of this ObjectBundle. SNMP-related objects

Required/optional:
Returns:	The snmp_bundle of this ObjectBundle.
Return type:	SNMPAgentBundle
	required

storage_pool_bundle¶

Gets the storage_pool_bundle of this ObjectBundle. An embedded object bundle that contains all configuration information relative to the “Storage Partitions” feature.

Required/optional:
Returns:	The storage_pool_bundle of this ObjectBundle.
Return type:	StoragePoolBundle
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray¶

Gets the tray of this ObjectBundle. A variable-length array of Tray structures. This array contains one element for each tray object that exists within the storage array.

Required/optional:
Returns:	The tray of this ObjectBundle.
Return type:	list[Tray]
	required

volume¶

Gets the volume of this ObjectBundle. A variable-length array of VolumeGroup structures. This array contains one element for each volume group object that exists within the storage array.

Required/optional:
Returns:	The volume of this ObjectBundle.
Return type:	list[Volume]
	required

volume_group¶

Gets the volume_group of this ObjectBundle. A variable-length array of VolumeGroup structures. This array contains one element for each volume group object that exists within the storage array.

Required/optional:
Returns:	The volume_group of this ObjectBundle.
Return type:	list[VolumeGroup]
	required

netapp.santricity.models.symbol.object_reference module¶

ObjectReference.py

class netapp.santricity.models.symbol.object_reference.ObjectReference[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_ref¶

Gets the controller_ref of this ObjectReference. A ControllerRef that refers to the object. Controllers are identified separately from other SYMbol objects because their refs require special handling by the firmware. This field is only valid if refType is equal to OBJ_REF_CONTROLLER.

Required/optional:
Returns:	The controller_ref of this ObjectReference.
Return type:	str
	optional

ref_type¶

Gets the ref_type of this ObjectReference. This enumeration identifies the different types of object references.

Required/optional:
Returns:	The ref_type of this ObjectReference.
Return type:	str
	required

symbol_ref¶

Gets the symbol_ref of this ObjectReference. A SYMbolRef that refers to the object. All non-controller objects can be identified by an untyped SYMbol reference. This field is only present if refType is equal to OBJ_REF_GENERIC.

Required/optional:
Returns:	The symbol_ref of this ObjectReference.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

typed_reference¶

Gets the typed_reference of this ObjectReference. A reference to a SYMbol object that includes object type information. This value is only present if the discriminator refType is set to OBJ_REF_GENERIC_TYPED.

Required/optional:
Returns:	The typed_reference of this ObjectReference.
Return type:	TypedSYMbolReference
	optional

netapp.santricity.models.symbol.opcode_counter module¶

OpcodeCounter.py

class netapp.santricity.models.symbol.opcode_counter.OpcodeCounter[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

count¶

Gets the count of this OpcodeCounter. The number of times the opcode has been observed.

Required/optional:
Returns:	The count of this OpcodeCounter.
Return type:	int
	required

opcode¶

Gets the opcode of this OpcodeCounter. A SCSI opcode value.

Required/optional:
Returns:	The opcode of this OpcodeCounter.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.optional_schedule_creation_descriptor module¶

OptionalScheduleCreationDescriptor.py

class netapp.santricity.models.symbol.optional_schedule_creation_descriptor.OptionalScheduleCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

descriptor¶

Gets the descriptor of this OptionalScheduleCreationDescriptor. This field is only present if the option field is equal to PARAMETER_PRESENT.

Required/optional:
Returns:	The descriptor of this OptionalScheduleCreationDescriptor.
Return type:	ScheduleCreationDescriptor
	optional

option¶

Gets the option of this OptionalScheduleCreationDescriptor. This enumeration is used to indicate whether a parameter is present or absent.

Required/optional:
Returns:	The option of this OptionalScheduleCreationDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.optional_target_object module¶

OptionalTargetObject.py

class netapp.santricity.models.symbol.optional_target_object.OptionalTargetObject[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

object¶

Gets the object of this OptionalTargetObject. The parameter is present. This means that a parameter that is considered to be optional is being included.

Required/optional:
Returns:	The object of this OptionalTargetObject.
Return type:	str
	optional

option¶

Gets the option of this OptionalTargetObject. This enumeration is used to indicate whether a parameter is present or absent.

Required/optional:
Returns:	The option of this OptionalTargetObject.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.p_registrant module¶

PRegistrant.py

class netapp.santricity.models.symbol.p_registrant.PRegistrant[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

it_nexus¶

Gets the it_nexus of this PRegistrant. A group of iSCSI initiators (hosts) participating in the reservation.

Required/optional:
Returns:	The it_nexus of this PRegistrant.
Return type:	ITNexus
	required

registration_key¶

Gets the registration_key of this PRegistrant. Authenticates the initiator ports.

Required/optional:
Returns:	The registration_key of this PRegistrant.
Return type:	str
	required

reserved¶

Gets the reserved of this PRegistrant. This is not used. It is for backward compatibility to the hostLabel definition found in crystal.

Required/optional:
Returns:	The reserved of this PRegistrant.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.p_registrant_list module¶

PRegistrantList.py

class netapp.santricity.models.symbol.p_registrant_list.PRegistrantList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

registrant¶

Gets the registrant of this PRegistrantList. A list of persistent registrants.

Required/optional:
Returns:	The registrant of this PRegistrantList.
Return type:	list[PRegistrant]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.p_registration module¶

PRegistration.py

class netapp.santricity.models.symbol.p_registration.PRegistration[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

holding_it_nexus¶

Gets the holding_it_nexus of this PRegistration. Invalid if Type = ALL_REG

Required/optional:
Returns:	The holding_it_nexus of this PRegistration.
Return type:	ITNexus
	required

lun¶

Gets the lun of this PRegistration. LUN (mapped)

Required/optional:
Returns:	The lun of this PRegistration.
Return type:	int
	required

ptpl_a¶

Gets the ptpl_a of this PRegistration. Persist through power loss

Required/optional:
Returns:	The ptpl_a of this PRegistration.
Return type:	bool
	required

registrant_list¶

Gets the registrant_list of this PRegistration. List of registrants

Required/optional:
Returns:	The registrant_list of this PRegistration.
Return type:	PRegistrantList
	required

reservation_type_id¶

Gets the reservation_type_id of this PRegistration. Reservation Type

Required/optional:
Returns:	The reservation_type_id of this PRegistration.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this PRegistration. The volume identifier

Required/optional:
Returns:	The volume_ref of this PRegistration.
Return type:	str
	required

netapp.santricity.models.symbol.p_registration_list module¶

PRegistrationList.py

class netapp.santricity.models.symbol.p_registration_list.PRegistrationList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

persistent_registration¶

Gets the persistent_registration of this PRegistrationList. A list of persistent registrations.

Required/optional:
Returns:	The persistent_registration of this PRegistrationList.
Return type:	list[PRegistration]
	required

return_code¶

Gets the return_code of this PRegistrationList. The return code from the getPersistentRegistrationList procedure. (Update)

Required/optional:
Returns:	The return_code of this PRegistrationList.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.parent_cru module¶

ParentCru.py

class netapp.santricity.models.symbol.parent_cru.ParentCru[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

parent_controller¶

Gets the parent_controller of this ParentCru. This field contains a reference to the parent controller. It is only valid if the type field is equal to PARENT_CRU_TYPE_CONTROLLER.

Required/optional:
Returns:	The parent_controller of this ParentCru.
Return type:	str
	optional

parent_drawer¶

Gets the parent_drawer of this ParentCru. This field contains a reference to the parent drawer. It is only valid if the type field is equal to PARENT_CRU_TYPE_DRAWER.

Required/optional:
Returns:	The parent_drawer of this ParentCru.
Return type:	str
	optional

parent_esm¶

Gets the parent_esm of this ParentCru. This field contains a reference to the parent ESM. It is only valid if the type field is equal to PARENT_CRU_TYPE_ESM.

Required/optional:
Returns:	The parent_esm of this ParentCru.
Return type:	str
	optional

parent_fan¶

Gets the parent_fan of this ParentCru. This field contains a reference to the parent Fan. It is only valid if the type field is equal to PARENT_CRU_TYPE_FAN.

Required/optional:
Returns:	The parent_fan of this ParentCru.
Return type:	str
	optional

parent_interconnect_cru¶

Gets the parent_interconnect_cru of this ParentCru. This field contains a reference to the parent interconnect CRU. It is only valid if the type field is equal to PARENT_CRU_TYPE_ICC_CRU.

Required/optional:
Returns:	The parent_interconnect_cru of this ParentCru.
Return type:	str
	optional

parent_support_cru¶

Gets the parent_support_cru of this ParentCru. This field contains a reference to the parent support CRU. It is only valid if the type field is equal to PARENT_CRU_TYPE_SUPPORT_CRU.

Required/optional:
Returns:	The parent_support_cru of this ParentCru.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this ParentCru. This enumeration object is used to specify the type of reference that is contained in a ParentCru union.

Required/optional:
Returns:	The type of this ParentCru.
Return type:	str
	required

netapp.santricity.models.symbol.parent_relative_location module¶

ParentRelativeLocation.py

class netapp.santricity.models.symbol.parent_relative_location.ParentRelativeLocation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

component_type¶

Gets the component_type of this ParentRelativeLocation. The type of component.

Required/optional:
Returns:	The component_type of this ParentRelativeLocation.
Return type:	str
	required

relative_position¶

Gets the relative_position of this ParentRelativeLocation. The relative position within the component’s parent.

Required/optional:
Returns:	The relative_position of this ParentRelativeLocation.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.parity_scan_response module¶

ParityScanResponse.py

class netapp.santricity.models.symbol.parity_scan_response.ParityScanResponse[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ending_lba¶

Gets the ending_lba of this ParityScanResponse. The last LBA scanned. This identifies the failing LBA when a parity or media error is detected. It identifies the last good LBA when the scan is successful or a timeout occurs.

Required/optional:
Returns:	The ending_lba of this ParityScanResponse.
Return type:	int
	required

parity_status¶

Gets the parity_status of this ParityScanResponse. The status of the scanVolume procedure specifying the scan result when returnCode is RETCODE_OK.

Required/optional:
Returns:	The parity_status of this ParityScanResponse.
Return type:	str
	required

return_code¶

Gets the return_code of this ParityScanResponse. The return code from the scanVolume procedure.

Required/optional:
Returns:	The return_code of this ParityScanResponse.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.path_degraded_failure module¶

PathDegradedFailure.py

class netapp.santricity.models.symbol.path_degraded_failure.PathDegradedFailure[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

degraded_paths¶

Gets the degraded_paths of this PathDegradedFailure. A list of drives with degraded paths.

Required/optional:
Returns:	The degraded_paths of this PathDegradedFailure.
Return type:	list[DegradedPath]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pending_host module¶

PendingHost.py

class netapp.santricity.models.symbol.pending_host.PendingHost[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

host_label¶

Gets the host_label of this PendingHost. The official node name of the host to which the pending topology host port belongs.

Required/optional:
Returns:	The host_label of this PendingHost.
Return type:	str
	required

host_port_id¶

Gets the host_port_id of this PendingHost. This field is a variable-length list of SCSIInitiatorPortId objects representing the ports associated with the host.

Required/optional:
Returns:	The host_port_id of this PendingHost.
Return type:	list[SCSIInitiatorPortId]
	required

host_type¶

Gets the host_type of this PendingHost. A string representing the host type of the pending topology host port. The contents of this field is the “short form” of the host type label used in the controller firmware.

Required/optional:
Returns:	The host_type of this PendingHost.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.performance_ring_chunk_details module¶

PerformanceRingChunkDetails.py

class netapp.santricity.models.symbol.performance_ring_chunk_details.PerformanceRingChunkDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

performance_ring_log_data¶

Gets the performance_ring_log_data of this PerformanceRingChunkDetails. This is the CSV formatted ascii data used to describe the controller’s performance statistics.

Required/optional:
Returns:	The performance_ring_log_data of this PerformanceRingChunkDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.performance_ring_start_details module¶

PerformanceRingStartDetails.py

class netapp.santricity.models.symbol.performance_ring_start_details.PerformanceRingStartDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

number_of_minutes¶

Gets the number_of_minutes of this PerformanceRingStartDetails. The total number of minutes to retrieve, up to 2048, 0 indicates all available, -1 indicates to skip any returning data.

Required/optional:
Returns:	The number_of_minutes of this PerformanceRingStartDetails.
Return type:	int
	required

number_of_seconds¶

Gets the number_of_seconds of this PerformanceRingStartDetails. The total number of seconds to retrieve, up to 2048, 0 indicates all available, -1 indicates to skip any returning data.

Required/optional:
Returns:	The number_of_seconds of this PerformanceRingStartDetails.
Return type:	int
	required

only_unread_data¶

Gets the only_unread_data of this PerformanceRingStartDetails. This field is used with a value of all available, once the data is read a flag is set in the ringBuffer structure to indicate that the data has been read via SYMbol. When combined with a numberOfSeconds or numberOfMinutes is 0 it returns only data previously not sent via SYMbol. When numberOfSeconds or numberOfMinutes are anything other than -1 or 0 the field is ignored.

Required/optional:
Returns:	The only_unread_data of this PerformanceRingStartDetails.
Return type:	bool
	required

perf_ring_type¶

Gets the perf_ring_type of this PerformanceRingStartDetails. This field is the output format for the ring buffer data retrieval.

Required/optional:
Returns:	The perf_ring_type of this PerformanceRingStartDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.persistent_registration module¶

PersistentRegistration.py

class netapp.santricity.models.symbol.persistent_registration.PersistentRegistration[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cluster_ref¶

Gets the cluster_ref of this PersistentRegistration. Group that volume is accessible by.

Required/optional:
Returns:	The cluster_ref of this PersistentRegistration.
Return type:	str
	required

host_ref¶

Gets the host_ref of this PersistentRegistration. Host that volume is accessible by.

Required/optional:
Returns:	The host_ref of this PersistentRegistration.
Return type:	str
	required

lun¶

Gets the lun of this PersistentRegistration. LUN (mapped).

Required/optional:
Returns:	The lun of this PersistentRegistration.
Return type:	int
	required

ptpl_a¶

Gets the ptpl_a of this PersistentRegistration. Persist through power loss active.

Required/optional:
Returns:	The ptpl_a of this PersistentRegistration.
Return type:	bool
	required

registrant_list¶

Gets the registrant_list of this PersistentRegistration. List of registrants.

Required/optional:
Returns:	The registrant_list of this PersistentRegistration.
Return type:	RegistrantList
	required

reservation_type_id¶

Gets the reservation_type_id of this PersistentRegistration. Reservation type.

Required/optional:
Returns:	The reservation_type_id of this PersistentRegistration.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this PersistentRegistration. The volume identifier.

Required/optional:
Returns:	The volume_ref of this PersistentRegistration.
Return type:	str
	required

netapp.santricity.models.symbol.persistent_registration_list module¶

PersistentRegistrationList.py

class netapp.santricity.models.symbol.persistent_registration_list.PersistentRegistrationList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

persistent_registration¶

Gets the persistent_registration of this PersistentRegistrationList. The persistent registration.

Required/optional:
Returns:	The persistent_registration of this PersistentRegistrationList.
Return type:	list[PersistentRegistration]
	required

return_code¶

Gets the return_code of this PersistentRegistrationList. The return code.

Required/optional:
Returns:	The return_code of this PersistentRegistrationList.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.physical_drive_type_data module¶

PhysicalDriveTypeData.py

class netapp.santricity.models.symbol.physical_drive_type_data.PhysicalDriveTypeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

phy_drive_type¶

Gets the phy_drive_type of this PhysicalDriveTypeData. This enumeration object is used to describe the physical interface of the drive. This is not necessarily the same as the I/O protocol interface used by the controller to communicate with the drive (DriveType). In addition, the supportedDriveTypes array in the FeatureParams structure will contain values from this enumeration identifying which drive types are supported on the storage array.

Required/optional:
Returns:	The phy_drive_type of this PhysicalDriveTypeData.
Return type:	str
	required

sata_drive_attributes¶

Gets the sata_drive_attributes of this PhysicalDriveTypeData. This field identifies the attributes of SATA drives It is only present if the phyDriveType field is equal to PHY_DRIVE_TYPE_SATA.

Required/optional:
Returns:	The sata_drive_attributes of this PhysicalDriveTypeData.
Return type:	SataDriveAttributes
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.physical_interface_type_data module¶

PhysicalInterfaceTypeData.py

class netapp.santricity.models.symbol.physical_interface_type_data.PhysicalInterfaceTypeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ethernet_data¶

Gets the ethernet_data of this PhysicalInterfaceTypeData. This field contains information about an Ethernet physical interface It is only present if the type field is equal to PHYSICAL_INTERFACE_ETHERNET.

Required/optional:
Returns:	The ethernet_data of this PhysicalInterfaceTypeData.
Return type:	EthernetInterfaceData
	optional

infiniband_data¶

Gets the infiniband_data of this PhysicalInterfaceTypeData. This field indicates iSCSI/iSER interface.

Required/optional:
Returns:	The infiniband_data of this PhysicalInterfaceTypeData.
Return type:	InfinibandInterfaceData
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this PhysicalInterfaceTypeData. This enumeration object is used to indicate the physical type of an I/O interface, in contrast to the logical protocol used by the interface (iSCSI is a logical protocol; Ethernet is a physical interface).

Required/optional:
Returns:	The type of this PhysicalInterfaceTypeData.
Return type:	str
	required

netapp.santricity.models.symbol.pit module¶

PIT.py

class netapp.santricity.models.symbol.pit.PIT[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

active_cow¶

Gets the active_cow of this PIT. If true, the PiT is actively recording copy-on-write data.

Required/optional:
Returns:	The active_cow of this PIT.
Return type:	bool
	required

creation_method¶

Gets the creation_method of this PIT. The PiT creation method.

Required/optional:
Returns:	The creation_method of this PIT.
Return type:	str
	required

id¶

Gets the id of this PIT.

Required/optional:
Returns:	The id of this PIT.
Return type:	str
	optional

is_rollback_source¶

Gets the is_rollback_source of this PIT. If true, the PiT is a rollback source.

Required/optional:
Returns:	The is_rollback_source of this PIT.
Return type:	bool
	required

pit_capacity¶

Gets the pit_capacity of this PIT. The capacity in bytes of this PiT (capacity of the base at the time the PiT was created).

Required/optional:
Returns:	The pit_capacity of this PIT.
Return type:	int
	required

pit_group_ref¶

Gets the pit_group_ref of this PIT. A reference to the associated PiT Group.

Required/optional:
Returns:	The pit_group_ref of this PIT.
Return type:	str
	required

pit_ref¶

Gets the pit_ref of this PIT. The reference (key) for this PiT.

Required/optional:
Returns:	The pit_ref of this PIT.
Return type:	str
	required

pit_sequence_number¶

Gets the pit_sequence_number of this PIT. The sequence number within PITGroup. This is a monotonically increasing sequence value that can be used to determine the absolute order of the PiTs within a PiT group. Using this sequence number avoids issues with timestamps when real-time clocks are changed. Note that this sequence number will be the same on all PiTs taken in multiple PITGroups at the same time under a single IO suspension, either as part of a consistency group operation (createCGPIT) or when a list of PITGroups is passed to createPIT.

Required/optional:
Returns:	The pit_sequence_number of this PIT.
Return type:	int
	required

pit_timestamp¶

Gets the pit_timestamp of this PIT. The controller-time (measured in seconds since January 1, 1970) when the PiT was created.

Required/optional:
Returns:	The pit_timestamp of this PIT.
Return type:	int
	required

repository_capacity_utilization¶

Gets the repository_capacity_utilization of this PIT. Repository utilization in bytes (only reported if activeCOW = false).

Required/optional:
Returns:	The repository_capacity_utilization of this PIT.
Return type:	int
	required

status¶

Gets the status of this PIT. The state of this PiT.

Required/optional:
Returns:	The status of this PIT.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_consistency_group module¶

PITConsistencyGroup.py

class netapp.santricity.models.symbol.pit_consistency_group.PITConsistencyGroup[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

auto_delete_limit¶

Gets the auto_delete_limit of this PITConsistencyGroup. The auto-delete indicator. If non-zero, the oldest PiT will be automatically deleted when creating a new one to keep the total number of PiTs limited to the number specified.

Required/optional:
Returns:	The auto_delete_limit of this PITConsistencyGroup.
Return type:	int
	required

cg_ref¶

Gets the cg_ref of this PITConsistencyGroup. The reference (key) for this PITConsistencyGroup.

Required/optional:
Returns:	The cg_ref of this PITConsistencyGroup.
Return type:	str
	required

creation_pending_status¶

Gets the creation_pending_status of this PITConsistencyGroup. The status of Pending PiT Creation.

Required/optional:
Returns:	The creation_pending_status of this PITConsistencyGroup.
Return type:	str
	required

full_warn_threshold¶

Gets the full_warn_threshold of this PITConsistencyGroup. The repository utilization warning threshold percentage.

Required/optional:
Returns:	The full_warn_threshold of this PITConsistencyGroup.
Return type:	int
	required

id¶

Gets the id of this PITConsistencyGroup.

Required/optional:
Returns:	The id of this PITConsistencyGroup.
Return type:	str
	optional

label¶

Gets the label of this PITConsistencyGroup. The name of the Consistency Group.

Required/optional:
Returns:	The label of this PITConsistencyGroup.
Return type:	str
	required

name¶

Gets the name of this PITConsistencyGroup.

Required/optional:
Returns:	The name of this PITConsistencyGroup.
Return type:	str
	optional

rep_full_policy¶

Gets the rep_full_policy of this PITConsistencyGroup. The behavior on repository full condition.

Required/optional:
Returns:	The rep_full_policy of this PITConsistencyGroup.
Return type:	str
	required

rollback_priority¶

Gets the rollback_priority of this PITConsistencyGroup. The importance of the rollback operation.

Required/optional:
Returns:	The rollback_priority of this PITConsistencyGroup.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

unique_sequence_number¶

Gets the unique_sequence_number of this PITConsistencyGroup. A list of all unique sequence numbers for all existing PiTs of members in this consistency group.

Required/optional:
Returns:	The unique_sequence_number of this PITConsistencyGroup.
Return type:	list[int]
	required

netapp.santricity.models.symbol.pit_consistency_group_add_member_descriptor module¶

PITConsistencyGroupAddMemberDescriptor.py

class netapp.santricity.models.symbol.pit_consistency_group_add_member_descriptor.PITConsistencyGroupAddMemberDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

base_volume¶

Gets the base_volume of this PITConsistencyGroupAddMemberDescriptor. The member base volume to add to the consistency group.

Required/optional:
Returns:	The base_volume of this PITConsistencyGroupAddMemberDescriptor.
Return type:	str
	required

cg_ref¶

Gets the cg_ref of this PITConsistencyGroupAddMemberDescriptor. The consistency group to which you will add the member.

Required/optional:
Returns:	The cg_ref of this PITConsistencyGroupAddMemberDescriptor.
Return type:	str
	required

repository_candidate¶

Gets the repository_candidate of this PITConsistencyGroupAddMemberDescriptor. The repository volume candidate for the consistency group PITGroup repository.

Required/optional:
Returns:	The repository_candidate of this PITConsistencyGroupAddMemberDescriptor.
Return type:	ConcatVolumeCreationDescriptor
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_consistency_group_add_member_descriptor_list module¶

PITConsistencyGroupAddMemberDescriptorList.py

class netapp.santricity.models.symbol.pit_consistency_group_add_member_descriptor_list.PITConsistencyGroupAddMemberDescriptorList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

add_member¶

Gets the add_member of this PITConsistencyGroupAddMemberDescriptorList. An array of PiT Consistency Group Add Member descriptors.

Required/optional:
Returns:	The add_member of this PITConsistencyGroupAddMemberDescriptorList.
Return type:	list[PITConsistencyGroupAddMemberDescriptor]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_consistency_group_creation_descriptor module¶

PITConsistencyGroupCreationDescriptor.py

class netapp.santricity.models.symbol.pit_consistency_group_creation_descriptor.PITConsistencyGroupCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

auto_delete_limit¶

Gets the auto_delete_limit of this PITConsistencyGroupCreationDescriptor. The auto-delete setting for Consistency Group. A non-zero value indicates auto delete is enabled and limit should be set to value specified.

Required/optional:
Returns:	The auto_delete_limit of this PITConsistencyGroupCreationDescriptor.
Return type:	int
	required

cg_schedule¶

Gets the cg_schedule of this PITConsistencyGroupCreationDescriptor. An optional schedule to be created with the new consistency group. The target object is empty in this structure (unknown because not yet created, assigned by this creation method).

Required/optional:
Returns:	The cg_schedule of this PITConsistencyGroupCreationDescriptor.
Return type:	OptionalScheduleCreationDescriptor
	required

full_warn_threshold¶

Gets the full_warn_threshold of this PITConsistencyGroupCreationDescriptor. The repository utilization warning threshold percentage.

Required/optional:
Returns:	The full_warn_threshold of this PITConsistencyGroupCreationDescriptor.
Return type:	int
	required

label¶

Gets the label of this PITConsistencyGroupCreationDescriptor. The name of the Consistency Group.

Required/optional:
Returns:	The label of this PITConsistencyGroupCreationDescriptor.
Return type:	str
	required

rep_full_policy¶

Gets the rep_full_policy of this PITConsistencyGroupCreationDescriptor. Behavior on repository full condition.

Required/optional:
Returns:	The rep_full_policy of this PITConsistencyGroupCreationDescriptor.
Return type:	str
	required

rollback_priority¶

Gets the rollback_priority of this PITConsistencyGroupCreationDescriptor. Importance of rollback operation.

Required/optional:
Returns:	The rollback_priority of this PITConsistencyGroupCreationDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_consistency_group_deletion_descriptor module¶

PITConsistencyGroupDeletionDescriptor.py

class netapp.santricity.models.symbol.pit_consistency_group_deletion_descriptor.PITConsistencyGroupDeletionDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cg_ref¶

Gets the cg_ref of this PITConsistencyGroupDeletionDescriptor. The consistency group to delete.

Required/optional:
Returns:	The cg_ref of this PITConsistencyGroupDeletionDescriptor.
Return type:	str
	required

retain_repository_members¶

Gets the retain_repository_members of this PITConsistencyGroupDeletionDescriptor. A flag used to indicate whether the member volumes of the associated repository should be retained or deleted (provided the PiT Groups are being deleted).

Required/optional:
Returns:	The retain_repository_members of this PITConsistencyGroupDeletionDescriptor.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_consistency_group_params_update_descriptor module¶

PITConsistencyGroupParamsUpdateDescriptor.py

class netapp.santricity.models.symbol.pit_consistency_group_params_update_descriptor.PITConsistencyGroupParamsUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

auto_delete_limit¶

Gets the auto_delete_limit of this PITConsistencyGroupParamsUpdateDescriptor. The auto-delete setting for the Consistency Group. A non-zero value indicates auto delete is enabled and limit should be set to value specified.

Required/optional:
Returns:	The auto_delete_limit of this PITConsistencyGroupParamsUpdateDescriptor.
Return type:	int
	required

cg_ref¶

Gets the cg_ref of this PITConsistencyGroupParamsUpdateDescriptor. The consistency group to be updated.

Required/optional:
Returns:	The cg_ref of this PITConsistencyGroupParamsUpdateDescriptor.
Return type:	str
	required

full_warn_threshold¶

Gets the full_warn_threshold of this PITConsistencyGroupParamsUpdateDescriptor. The repository utilization warning threshold percentage.

Required/optional:
Returns:	The full_warn_threshold of this PITConsistencyGroupParamsUpdateDescriptor.
Return type:	int
	required

label¶

Gets the label of this PITConsistencyGroupParamsUpdateDescriptor. The name of the consistency group.

Required/optional:
Returns:	The label of this PITConsistencyGroupParamsUpdateDescriptor.
Return type:	str
	required

rep_full_policy¶

Gets the rep_full_policy of this PITConsistencyGroupParamsUpdateDescriptor. Behavior on repository full condition.

Required/optional:
Returns:	The rep_full_policy of this PITConsistencyGroupParamsUpdateDescriptor.
Return type:	str
	required

rollback_priority¶

Gets the rollback_priority of this PITConsistencyGroupParamsUpdateDescriptor. Importance of rollback operation.

Required/optional:
Returns:	The rollback_priority of this PITConsistencyGroupParamsUpdateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_consistency_group_pit_deletion_descriptor module¶

PITConsistencyGroupPITDeletionDescriptor.py

class netapp.santricity.models.symbol.pit_consistency_group_pit_deletion_descriptor.PITConsistencyGroupPITDeletionDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cg_ref¶

Gets the cg_ref of this PITConsistencyGroupPITDeletionDescriptor. A reference to the consistency group from which one or more PiTs will be deleted.

Required/optional:
Returns:	The cg_ref of this PITConsistencyGroupPITDeletionDescriptor.
Return type:	str
	required

pit_sequence_number¶

Gets the pit_sequence_number of this PITConsistencyGroupPITDeletionDescriptor. A list of sequence numbers for the PiTs to be deleted.

Required/optional:
Returns:	The pit_sequence_number of this PITConsistencyGroupPITDeletionDescriptor.
Return type:	list[int]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_consistency_group_remove_member_descriptor module¶

PITConsistencyGroupRemoveMemberDescriptor.py

class netapp.santricity.models.symbol.pit_consistency_group_remove_member_descriptor.PITConsistencyGroupRemoveMemberDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cg_ref¶

Gets the cg_ref of this PITConsistencyGroupRemoveMemberDescriptor. The consistency group from which the member is to be removed.

Required/optional:
Returns:	The cg_ref of this PITConsistencyGroupRemoveMemberDescriptor.
Return type:	str
	required

member_ref¶

Gets the member_ref of this PITConsistencyGroupRemoveMemberDescriptor. The member to remove (must be a member of the consistency group specified above).

Required/optional:
Returns:	The member_ref of this PITConsistencyGroupRemoveMemberDescriptor.
Return type:	str
	required

retain_repository_members¶

Gets the retain_repository_members of this PITConsistencyGroupRemoveMemberDescriptor. An indication of whether the repository member volumes should be deleted or retained if the PiT Group is being deleted.

Required/optional:
Returns:	The retain_repository_members of this PITConsistencyGroupRemoveMemberDescriptor.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_consistency_group_rollback_start_descriptor module¶

PITConsistencyGroupRollbackStartDescriptor.py

class netapp.santricity.models.symbol.pit_consistency_group_rollback_start_descriptor.PITConsistencyGroupRollbackStartDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cg_ref¶

Gets the cg_ref of this PITConsistencyGroupRollbackStartDescriptor. The consistency group on which the rollback is to be invoked.

Required/optional:
Returns:	The cg_ref of this PITConsistencyGroupRollbackStartDescriptor.
Return type:	str
	required

pit_sequence_number¶

Gets the pit_sequence_number of this PITConsistencyGroupRollbackStartDescriptor. The sequence number of the PiT to roll back to the base on all members.

Required/optional:
Returns:	The pit_sequence_number of this PITConsistencyGroupRollbackStartDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_consistency_group_view module¶

PITConsistencyGroupView.py

class netapp.santricity.models.symbol.pit_consistency_group_view.PITConsistencyGroupView[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cg_view_ref¶

Gets the cg_view_ref of this PITConsistencyGroupView. The reference (key) for this PITConsistencyGroupView.

Required/optional:
Returns:	The cg_view_ref of this PITConsistencyGroupView.
Return type:	str
	required

group_ref¶

Gets the group_ref of this PITConsistencyGroupView. The PiT Consistency Group to which the Consistency Group View belongs.

Required/optional:
Returns:	The group_ref of this PITConsistencyGroupView.
Return type:	str
	required

id¶

Gets the id of this PITConsistencyGroupView.

Required/optional:
Returns:	The id of this PITConsistencyGroupView.
Return type:	str
	optional

label¶

Gets the label of this PITConsistencyGroupView. The name of the Consistency Group View.

Required/optional:
Returns:	The label of this PITConsistencyGroupView.
Return type:	str
	required

name¶

Gets the name of this PITConsistencyGroupView.

Required/optional:
Returns:	The name of this PITConsistencyGroupView.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

view_sequence_number¶

Gets the view_sequence_number of this PITConsistencyGroupView. The view sequence number. This is a monotonically increasing sequence value that is common across all member Views that are part of this Consistency Group View.

Required/optional:
Returns:	The view_sequence_number of this PITConsistencyGroupView.
Return type:	int
	required

view_time¶

Gets the view_time of this PITConsistencyGroupView. The controller-time (measured in seconds since January 1, 1970) when the Consistency Group View was created or re-attached to another PiT. All member Views that are part of this Consistency Group View have this value in their corresponding fields.

Required/optional:
Returns:	The view_time of this PITConsistencyGroupView.
Return type:	int
	required

netapp.santricity.models.symbol.pit_consistency_group_view_creation_descriptor module¶

PITConsistencyGroupViewCreationDescriptor.py

class netapp.santricity.models.symbol.pit_consistency_group_view_creation_descriptor.PITConsistencyGroupViewCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cg_ref¶

Gets the cg_ref of this PITConsistencyGroupViewCreationDescriptor. The Consistency Group on which views are to be created. All PiTs referenced in the view creation descriptors must be part of this consistency group.

Required/optional:
Returns:	The cg_ref of this PITConsistencyGroupViewCreationDescriptor.
Return type:	str
	required

label¶

Gets the label of this PITConsistencyGroupViewCreationDescriptor. The name of the new Consistency Group View.

Required/optional:
Returns:	The label of this PITConsistencyGroupViewCreationDescriptor.
Return type:	str
	required

pit_sequence_number¶

Gets the pit_sequence_number of this PITConsistencyGroupViewCreationDescriptor. The sequence number of PiTs for which views are to be created. PITRefs in the view creation descriptors provided must have this sequence number (this is just for cross-checking the list of PiTs).

Required/optional:
Returns:	The pit_sequence_number of this PITConsistencyGroupViewCreationDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

view_creation_descriptor¶

Gets the view_creation_descriptor of this PITConsistencyGroupViewCreationDescriptor. A list of creation descriptors for the views to be created.

Required/optional:
Returns:	The view_creation_descriptor of this PITConsistencyGroupViewCreationDescriptor.
Return type:	list[PITViewCreationDescriptor]
	required

netapp.santricity.models.symbol.pit_consistency_group_view_deletion_descriptor module¶

PITConsistencyGroupViewDeletionDescriptor.py

class netapp.santricity.models.symbol.pit_consistency_group_view_deletion_descriptor.PITConsistencyGroupViewDeletionDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cg_view_ref¶

Gets the cg_view_ref of this PITConsistencyGroupViewDeletionDescriptor. The Consistency Group View to be deleted.

Required/optional:
Returns:	The cg_view_ref of this PITConsistencyGroupViewDeletionDescriptor.
Return type:	str
	required

retain_repository_members¶

Gets the retain_repository_members of this PITConsistencyGroupViewDeletionDescriptor. If true, the repository member volumes should be retained if the PiT Group is being deleted.

Required/optional:
Returns:	The retain_repository_members of this PITConsistencyGroupViewDeletionDescriptor.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_consistency_group_view_params_update_descriptor module¶

PITConsistencyGroupViewParamsUpdateDescriptor.py

class netapp.santricity.models.symbol.pit_consistency_group_view_params_update_descriptor.PITConsistencyGroupViewParamsUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cg_view_ref¶

Gets the cg_view_ref of this PITConsistencyGroupViewParamsUpdateDescriptor. Consistency Group View to change.

Required/optional:
Returns:	The cg_view_ref of this PITConsistencyGroupViewParamsUpdateDescriptor.
Return type:	str
	required

new_label¶

Gets the new_label of this PITConsistencyGroupViewParamsUpdateDescriptor. New user label for the Consistency Group View.

Required/optional:
Returns:	The new_label of this PITConsistencyGroupViewParamsUpdateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_consistency_group_view_restart_descriptor module¶

PITConsistencyGroupViewRestartDescriptor.py

class netapp.santricity.models.symbol.pit_consistency_group_view_restart_descriptor.PITConsistencyGroupViewRestartDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cg_view_ref¶

Gets the cg_view_ref of this PITConsistencyGroupViewRestartDescriptor. The Consistency Group View to restart.

Required/optional:
Returns:	The cg_view_ref of this PITConsistencyGroupViewRestartDescriptor.
Return type:	str
	required

pit_sequence_number¶

Gets the pit_sequence_number of this PITConsistencyGroupViewRestartDescriptor. The sequence number of member PiTs to which each member View is to be attached.

Required/optional:
Returns:	The pit_sequence_number of this PITConsistencyGroupViewRestartDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_consistency_group_view_stop_descriptor module¶

PITConsistencyGroupViewStopDescriptor.py

class netapp.santricity.models.symbol.pit_consistency_group_view_stop_descriptor.PITConsistencyGroupViewStopDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cg_view_ref¶

Gets the cg_view_ref of this PITConsistencyGroupViewStopDescriptor. The Consistency Group View to be stopped.

Required/optional:
Returns:	The cg_view_ref of this PITConsistencyGroupViewStopDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_group module¶

PITGroup.py

class netapp.santricity.models.symbol.pit_group.PITGroup[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

action¶

Gets the action of this PITGroup. Long running operation.

Required/optional:
Returns:	The action of this PITGroup.
Return type:	str
	required

auto_delete_limit¶

Gets the auto_delete_limit of this PITGroup. The auto-delete indicator. If non-zero, the oldest PiT will be automatically deleted when creating a new one to keep the total number of PiTs limited to the number specified. This value is overridden by the consistency group setting if this PITGroup is associated with a consistency group.

Required/optional:
Returns:	The auto_delete_limit of this PITGroup.
Return type:	int
	required

base_volume¶

Gets the base_volume of this PITGroup. The base volume for this PiT Group.

Required/optional:
Returns:	The base_volume of this PITGroup.
Return type:	str
	required

cluster_size¶

Gets the cluster_size of this PITGroup. The cluster size (in bytes).

Required/optional:
Returns:	The cluster_size of this PITGroup.
Return type:	int
	required

consistency_group¶

Gets the consistency_group of this PITGroup. If true, this PiT group is part of a consistency group.

Required/optional:
Returns:	The consistency_group of this PITGroup.
Return type:	bool
	required

consistency_group_ref¶

Gets the consistency_group_ref of this PITGroup. A reference to the parent consistency group, if applicable. This value will be NULL if this PiT group is not part of a consistency group.

Required/optional:
Returns:	The consistency_group_ref of this PITGroup.
Return type:	str
	required

creation_pending_status¶

Gets the creation_pending_status of this PITGroup. The status of Pending PiT Creation.

Required/optional:
Returns:	The creation_pending_status of this PITGroup.
Return type:	str
	required

full_warn_threshold¶

Gets the full_warn_threshold of this PITGroup. The repository utilization warning threshold percentage.

Required/optional:
Returns:	The full_warn_threshold of this PITGroup.
Return type:	int
	required

id¶

Gets the id of this PITGroup.

Required/optional:
Returns:	The id of this PITGroup.
Return type:	str
	optional

label¶

Gets the label of this PITGroup. The name of the PiT Group. If this PiT group is part of a consistency group, then this label does not have to be present or unique as the parent consistency group label will be used.

Required/optional:
Returns:	The label of this PITGroup.
Return type:	str
	required

max_base_capacity¶

Gets the max_base_capacity of this PITGroup. The maximum allowable base volume size (in bytes) based on current cluster size. Only applicable if there is at least one PiT in the PiT group.

Required/optional:
Returns:	The max_base_capacity of this PITGroup.
Return type:	int
	required

max_repository_capacity¶

Gets the max_repository_capacity of this PITGroup. The maximum allowable repository size (in bytes) based on current cluster size. Only applicable if there is at least one PiT in the PiT group.

Required/optional:
Returns:	The max_repository_capacity of this PITGroup.
Return type:	int
	required

name¶

Gets the name of this PITGroup.

Required/optional:
Returns:	The name of this PITGroup.
Return type:	str
	optional

pit_group_ref¶

Gets the pit_group_ref of this PITGroup. The reference (key) for the PiT Group.

Required/optional:
Returns:	The pit_group_ref of this PITGroup.
Return type:	str
	required

rep_full_policy¶

Gets the rep_full_policy of this PITGroup. The behavior on repository full condition. Overridden by consistency group setting if this PITGroup is associated with a consistency group.

Required/optional:
Returns:	The rep_full_policy of this PITGroup.
Return type:	str
	required

repository_volume¶

Gets the repository_volume of this PITGroup. The copy-on-write (CoW) Repository for this PiT group.

Required/optional:
Returns:	The repository_volume of this PITGroup.
Return type:	str
	required

rollback_priority¶

Gets the rollback_priority of this PITGroup. The importance of the rollback operation.

Required/optional:
Returns:	The rollback_priority of this PITGroup.
Return type:	str
	required

rollback_status¶

Gets the rollback_status of this PITGroup. The status of the rollback (if rollback is indicated in VolumeAction above).

Required/optional:
Returns:	The rollback_status of this PITGroup.
Return type:	str
	required

status¶

Gets the status of this PITGroup. The status of the PiT Group.

Required/optional:
Returns:	The status of this PITGroup.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

unusable_repository_capacity¶

Gets the unusable_repository_capacity of this PITGroup. The amount of repository capacity that is unusable due to limited addressability of the current cluster size.

Required/optional:
Returns:	The unusable_repository_capacity of this PITGroup.
Return type:	int
	required

volume_handle¶

Gets the volume_handle of this PITGroup. The PiT group SSID. This is provided primarily for debug purposes.

Required/optional:
Returns:	The volume_handle of this PITGroup.
Return type:	int
	required

netapp.santricity.models.symbol.pit_group_creation_descriptor module¶

PITGroupCreationDescriptor.py

class netapp.santricity.models.symbol.pit_group_creation_descriptor.PITGroupCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

auto_delete_limit¶

Gets the auto_delete_limit of this PITGroupCreationDescriptor. The auto-delete setting for PiT Group. A non-zero value indicates auto delete is enabled and the limit should be set to the value specified.

Required/optional:
Returns:	The auto_delete_limit of this PITGroupCreationDescriptor.
Return type:	int
	required

base_volume¶

Gets the base_volume of this PITGroupCreationDescriptor. The base volume for this PiT Group.

Required/optional:
Returns:	The base_volume of this PITGroupCreationDescriptor.
Return type:	str
	required

full_warn_threshold¶

Gets the full_warn_threshold of this PITGroupCreationDescriptor. The repository utilization warning threshold percentage.

Required/optional:
Returns:	The full_warn_threshold of this PITGroupCreationDescriptor.
Return type:	int
	required

pit_group_label¶

Gets the pit_group_label of this PITGroupCreationDescriptor. The user-assigned PiT Group label.

Required/optional:
Returns:	The pit_group_label of this PITGroupCreationDescriptor.
Return type:	str
	required

pit_schedule¶

Gets the pit_schedule of this PITGroupCreationDescriptor. An optional PiT schedule to be created with the new PITGroup. The target object is empty in this structure (unknown because not yet created, assigned by this creation method).

Required/optional:
Returns:	The pit_schedule of this PITGroupCreationDescriptor.
Return type:	OptionalScheduleCreationDescriptor
	required

rep_full_policy¶

Gets the rep_full_policy of this PITGroupCreationDescriptor. Behavior on repository full condition.

Required/optional:
Returns:	The rep_full_policy of this PITGroupCreationDescriptor.
Return type:	str
	required

repository_candidate¶

Gets the repository_candidate of this PITGroupCreationDescriptor. The volume candidate for the repository.

Required/optional:
Returns:	The repository_candidate of this PITGroupCreationDescriptor.
Return type:	ConcatVolumeCreationDescriptor
	required

rollback_priority¶

Gets the rollback_priority of this PITGroupCreationDescriptor. Importance of rollback operation.

Required/optional:
Returns:	The rollback_priority of this PITGroupCreationDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_group_deletion_descriptor module¶

PITGroupDeletionDescriptor.py

class netapp.santricity.models.symbol.pit_group_deletion_descriptor.PITGroupDeletionDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

pit_group_ref¶

Gets the pit_group_ref of this PITGroupDeletionDescriptor. The PiT Group to delete.

Required/optional:
Returns:	The pit_group_ref of this PITGroupDeletionDescriptor.
Return type:	str
	required

retain_repository_members¶

Gets the retain_repository_members of this PITGroupDeletionDescriptor. A flag used to indicate whether the member volumes of the associated repository should be retained or deleted as part of the PiT Group deletion.

Required/optional:
Returns:	The retain_repository_members of this PITGroupDeletionDescriptor.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_group_params_update_descriptor module¶

PITGroupParamsUpdateDescriptor.py

class netapp.santricity.models.symbol.pit_group_params_update_descriptor.PITGroupParamsUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

auto_delete_limit¶

Gets the auto_delete_limit of this PITGroupParamsUpdateDescriptor. The auto-delete setting for the PiT Group. A non-zero value indicates auto delete is enabled and limit should be set to value specified.

Required/optional:
Returns:	The auto_delete_limit of this PITGroupParamsUpdateDescriptor.
Return type:	int
	required

full_warn_threshold¶

Gets the full_warn_threshold of this PITGroupParamsUpdateDescriptor. Repository utilization warning threshold percentage.

Required/optional:
Returns:	The full_warn_threshold of this PITGroupParamsUpdateDescriptor.
Return type:	int
	required

pit_group_label¶

Gets the pit_group_label of this PITGroupParamsUpdateDescriptor. The PiT Group label.

Required/optional:
Returns:	The pit_group_label of this PITGroupParamsUpdateDescriptor.
Return type:	str
	required

pit_group_ref¶

Gets the pit_group_ref of this PITGroupParamsUpdateDescriptor. The PITGroup to be updated.

Required/optional:
Returns:	The pit_group_ref of this PITGroupParamsUpdateDescriptor.
Return type:	str
	required

rep_full_policy¶

Gets the rep_full_policy of this PITGroupParamsUpdateDescriptor. Behavior on repository full condition.

Required/optional:
Returns:	The rep_full_policy of this PITGroupParamsUpdateDescriptor.
Return type:	str
	required

rollback_priority¶

Gets the rollback_priority of this PITGroupParamsUpdateDescriptor. Importance of rollback operation.

Required/optional:
Returns:	The rollback_priority of this PITGroupParamsUpdateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_group_ref_list module¶

PITGroupRefList.py

class netapp.santricity.models.symbol.pit_group_ref_list.PITGroupRefList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

pit_group_ref¶

Gets the pit_group_ref of this PITGroupRefList. An array of PITGroup references

Required/optional:
Returns:	The pit_group_ref of this PITGroupRefList.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_group_repository_utilization module¶

PITGroupRepositoryUtilization.py

class netapp.santricity.models.symbol.pit_group_repository_utilization.PITGroupRepositoryUtilization[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

group_ref¶

Gets the group_ref of this PITGroupRepositoryUtilization. The PiT Group for which this utilization information applies.

Required/optional:
Returns:	The group_ref of this PITGroupRepositoryUtilization.
Return type:	str
	required

pit_group_bytes_available¶

Gets the pit_group_bytes_available of this PITGroupRepositoryUtilization. The total number of bytes available for ongoing copy-on-write operations.

Required/optional:
Returns:	The pit_group_bytes_available of this PITGroupRepositoryUtilization.
Return type:	int
	required

pit_group_bytes_used¶

Gets the pit_group_bytes_used of this PITGroupRepositoryUtilization. The total number of bytes used in the repository for all PiTs in the group.

Required/optional:
Returns:	The pit_group_bytes_used of this PITGroupRepositoryUtilization.
Return type:	int
	required

pit_utilization¶

Gets the pit_utilization of this PITGroupRepositoryUtilization. The repository utilization of each specific PiT in the PiT group.

Required/optional:
Returns:	The pit_utilization of this PITGroupRepositoryUtilization.
Return type:	list[PITRepositoryUtilization]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_group_repository_utilization_list module¶

PITGroupRepositoryUtilizationList.py

class netapp.santricity.models.symbol.pit_group_repository_utilization_list.PITGroupRepositoryUtilizationList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

repository_utilization¶

Gets the repository_utilization of this PITGroupRepositoryUtilizationList. A variable-length array of PITGroupRepositoryUtilization objects.

Required/optional:
Returns:	The repository_utilization of this PITGroupRepositoryUtilizationList.
Return type:	list[PITGroupRepositoryUtilization]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_group_repository_utilization_list_returned module¶

PITGroupRepositoryUtilizationListReturned.py

class netapp.santricity.models.symbol.pit_group_repository_utilization_list_returned.PITGroupRepositoryUtilizationListReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

return_code¶

Gets the return_code of this PITGroupRepositoryUtilizationListReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this PITGroupRepositoryUtilizationListReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

utilization¶

Gets the utilization of this PITGroupRepositoryUtilizationListReturned. A list of PITGroupRepositoryUtilization structures. This field is present only if the value of returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The utilization of this PITGroupRepositoryUtilizationListReturned.
Return type:	PITGroupRepositoryUtilizationList
	optional

netapp.santricity.models.symbol.pit_group_rollback_utilization_estimate module¶

PITGroupRollbackUtilizationEstimate.py

class netapp.santricity.models.symbol.pit_group_rollback_utilization_estimate.PITGroupRollbackUtilizationEstimate[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cow_data_bytes_required¶

Gets the cow_data_bytes_required of this PITGroupRollbackUtilizationEstimate. The amount of repository capacity in bytes necessary for copy-on-write operations required by the rollback process to preserve all PiTs.

Required/optional:
Returns:	The cow_data_bytes_required of this PITGroupRollbackUtilizationEstimate.
Return type:	int
	required

current_bytes_available¶

Gets the current_bytes_available of this PITGroupRollbackUtilizationEstimate. The current remaining available capacity (in bytes) of the associated repository.

Required/optional:
Returns:	The current_bytes_available of this PITGroupRollbackUtilizationEstimate.
Return type:	int
	required

metadata_bytes_required¶

Gets the metadata_bytes_required of this PITGroupRollbackUtilizationEstimate. The amount of repository capacity in bytes necessary for PiT metadata during rollback.

Required/optional:
Returns:	The metadata_bytes_required of this PITGroupRollbackUtilizationEstimate.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_group_rollback_utilization_estimate_returned module¶

PITGroupRollbackUtilizationEstimateReturned.py

class netapp.santricity.models.symbol.pit_group_rollback_utilization_estimate_returned.PITGroupRollbackUtilizationEstimateReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

estimate¶

Gets the estimate of this PITGroupRollbackUtilizationEstimateReturned. A PiT Group rollback utilization estimate. This field is present only if the value of returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The estimate of this PITGroupRollbackUtilizationEstimateReturned.
Return type:	PITGroupRollbackUtilizationEstimate
	optional

return_code¶

Gets the return_code of this PITGroupRollbackUtilizationEstimateReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this PITGroupRollbackUtilizationEstimateReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_groups_default_attributes module¶

PITGroupsDefaultAttributes.py

class netapp.santricity.models.symbol.pit_groups_default_attributes.PITGroupsDefaultAttributes[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

default_repository_capacity_as_percent_of_base_capacity¶

Gets the default_repository_capacity_as_percent_of_base_capacity of this PITGroupsDefaultAttributes. Default repository capacity for PiT View or PiT Group as a percentage of the base volume capacity.

Required/optional:
Returns:	The default_repository_capacity_as_percent_of_base_capacity of this PITGroupsDefaultAttributes.
Return type:	int
	required

default_repository_utilization_warning_threshold¶

Gets the default_repository_utilization_warning_threshold of this PITGroupsDefaultAttributes. Default repository utilization warning threshold percentage.

Required/optional:
Returns:	The default_repository_utilization_warning_threshold of this PITGroupsDefaultAttributes.
Return type:	int
	required

max_pit_group_repository_capacity_as_percent_of_base_capacity¶

Gets the max_pit_group_repository_capacity_as_percent_of_base_capacity of this PITGroupsDefaultAttributes. Maximum repository size for a PiT group as a percentage of the base volume capacity.

Required/optional:
Returns:	The max_pit_group_repository_capacity_as_percent_of_base_capacity of this PITGroupsDefaultAttributes.
Return type:	int
	required

max_pit_view_repository_capacity_as_percent_of_base_capacity¶

Gets the max_pit_view_repository_capacity_as_percent_of_base_capacity of this PITGroupsDefaultAttributes. Maximum repository size for a PiT View as a percentage of the base volume capacity.

Required/optional:
Returns:	The max_pit_view_repository_capacity_as_percent_of_base_capacity of this PITGroupsDefaultAttributes.
Return type:	int
	required

max_views_per_pit¶

Gets the max_views_per_pit of this PITGroupsDefaultAttributes. The maximum number of views per PiT.

Required/optional:
Returns:	The max_views_per_pit of this PITGroupsDefaultAttributes.
Return type:	int
	required

minimum_concat_volume_capacity_expansion¶

Gets the minimum_concat_volume_capacity_expansion of this PITGroupsDefaultAttributes. Minimum capacity (in bytes) of a volume to be added to a ConcatVolume for expansion.

Required/optional:
Returns:	The minimum_concat_volume_capacity_expansion of this PITGroupsDefaultAttributes.
Return type:	int
	required

minimum_repository_capacity_in_bytes¶

Gets the minimum_repository_capacity_in_bytes of this PITGroupsDefaultAttributes. The minimum repository size (in bytes) for PiT Group or PiT View repository. Note that this is the absolute floor on the repository capacity, but a slightly higher minimum may be imposed based on the capacity of the base volume. This is necessary to ensure rollback operations have sufficient repository capacity for metadata.

Required/optional:
Returns:	The minimum_repository_capacity_in_bytes of this PITGroupsDefaultAttributes.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_ref_list module¶

PITRefList.py

class netapp.santricity.models.symbol.pit_ref_list.PITRefList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

pit_ref¶

Gets the pit_ref of this PITRefList. An array of PiT references

Required/optional:
Returns:	The pit_ref of this PITRefList.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_repository_utilization module¶

PITRepositoryUtilization.py

class netapp.santricity.models.symbol.pit_repository_utilization.PITRepositoryUtilization[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

bytes_used¶

Gets the bytes_used of this PITRepositoryUtilization. The total number of bytes in use in the repository for this specific PiTs metadata, copy-on-write indexes, and copy-on-write data.

Required/optional:
Returns:	The bytes_used of this PITRepositoryUtilization.
Return type:	int
	required

pit_ref¶

Gets the pit_ref of this PITRepositoryUtilization. A reference to the specific PiT for which utilization is being reported.

Required/optional:
Returns:	The pit_ref of this PITRepositoryUtilization.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_rollback_operation module¶

PITRollbackOperation.py

class netapp.santricity.models.symbol.pit_rollback_operation.PITRollbackOperation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

pending¶

Gets the pending of this PITRollbackOperation. If true, the operation has not started.

Required/optional:
Returns:	The pending of this PITRollbackOperation.
Return type:	bool
	required

percent_complete¶

Gets the percent_complete of this PITRollbackOperation. The completion percentage for the operation. If the operation is not currently running this value will be equal to PERCENT_COMPLETE_OP_NOT_RUNNING.

Required/optional:
Returns:	The percent_complete of this PITRollbackOperation.
Return type:	int
	required

pit_group_ref¶

Gets the pit_group_ref of this PITRollbackOperation. A reference to the PiT Group.

Required/optional:
Returns:	The pit_group_ref of this PITRollbackOperation.
Return type:	str
	required

pit_ref¶

Gets the pit_ref of this PITRollbackOperation. A reference to the specific PiT being rolled back.

Required/optional:
Returns:	The pit_ref of this PITRollbackOperation.
Return type:	str
	required

time_to_completion¶

Gets the time_to_completion of this PITRollbackOperation. The estimated time to completion in minutes. If the time is not known this value will be equal to TIME_TO_COMPLETION_UNKNOWN.

Required/optional:
Returns:	The time_to_completion of this PITRollbackOperation.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_view module¶

PITView.py

class netapp.santricity.models.symbol.pit_view.PITView[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

access_mode¶

Gets the access_mode of this PITView. The view access mode.

Required/optional:
Returns:	The access_mode of this PITView.
Return type:	str
	required

base_pit¶

Gets the base_pit of this PITView. A reference to the particular PiT of the base for which this view applies. This field is only valid if the boundToPIT field is true.

Required/optional:
Returns:	The base_pit of this PITView.
Return type:	str
	required

base_vol¶

Gets the base_vol of this PITView. A reference to the base volume with which this view is associated.

Required/optional:
Returns:	The base_vol of this PITView.
Return type:	str
	required

bound_to_pit¶

Gets the bound_to_pit of this PITView. If true, this flag indicates that the basePIT field is a valid reference to an associated PIT. If false, the view is disassociated from the PiT so the basePIT reference is invalid.

Required/optional:
Returns:	The bound_to_pit of this PITView.
Return type:	bool
	required

cluster_size¶

Gets the cluster_size of this PITView. The cluster size in bytes.

Required/optional:
Returns:	The cluster_size of this PITView.
Return type:	int
	required

current_manager¶

Gets the current_manager of this PITView. The current owner of the view.

Required/optional:
Returns:	The current_manager of this PITView.
Return type:	str
	required

full_warn_threshold¶

Gets the full_warn_threshold of this PITView. The repository utilization warning threshold percentage.

Required/optional:
Returns:	The full_warn_threshold of this PITView.
Return type:	int
	required

id¶

Gets the id of this PITView.

Required/optional:
Returns:	The id of this PITView.
Return type:	str
	optional

label¶

Gets the label of this PITView. The name of the view.

Required/optional:
Returns:	The label of this PITView.
Return type:	str
	required

max_repository_capacity¶

Gets the max_repository_capacity of this PITView. The maximum allowable repository size in bytes based on current cluster size.

Required/optional:
Returns:	The max_repository_capacity of this PITView.
Return type:	int
	required

membership¶

Gets the membership of this PITView. This view’s relationship (if any) to a Consistency Group View.

Required/optional:
Returns:	The membership of this PITView.
Return type:	PITViewMembership
	required

mgmt_client_attribute¶

Gets the mgmt_client_attribute of this PITView. The management client attribute.

Required/optional:
Returns:	The mgmt_client_attribute of this PITView.
Return type:	int
	required

name¶

Gets the name of this PITView.

Required/optional:
Returns:	The name of this PITView.
Return type:	str
	optional

offline¶

Gets the offline of this PITView. The view is offline due to the associated repository volume state.

Required/optional:
Returns:	The offline of this PITView.
Return type:	bool
	required

perms¶

Gets the perms of this PITView. The permissions for the view.

Required/optional:
Returns:	The perms of this PITView.
Return type:	VolumePerms
	required

preferred_manager¶

Gets the preferred_manager of this PITView. The preferred owner of the view.

Required/optional:
Returns:	The preferred_manager of this PITView.
Return type:	str
	required

repository_volume¶

Gets the repository_volume of this PITView. The copy-on-write repository for this view.

Required/optional:
Returns:	The repository_volume of this PITView.
Return type:	str
	required

status¶

Gets the status of this PITView. The view status.

Required/optional:
Returns:	The status of this PITView.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

unusable_repository_capacity¶

Gets the unusable_repository_capacity of this PITView. The amount of repository capacity in bytes that is unusable due to limited addressability of the current cluster size.

Required/optional:
Returns:	The unusable_repository_capacity of this PITView.
Return type:	int
	required

view_ref¶

Gets the view_ref of this PITView. The reference (key) for this view.

Required/optional:
Returns:	The view_ref of this PITView.
Return type:	str
	required

view_sequence_number¶

Gets the view_sequence_number of this PITView. Sequence number. This is a monotonically increasing sequence value that can be used to determine related views when the view was created as part of a consistency group operation.

Required/optional:
Returns:	The view_sequence_number of this PITView.
Return type:	int
	required

view_time¶

Gets the view_time of this PITView. The controller-time (measured in seconds since January 1, 1970) when view was created or re-attached to another PiT.

Required/optional:
Returns:	The view_time of this PITView.
Return type:	int
	required

volume_handle¶

Gets the volume_handle of this PITView. The volume ssid. This is provided primarily for debug purposes.

Required/optional:
Returns:	The volume_handle of this PITView.
Return type:	int
	required

world_wide_name¶

Gets the world_wide_name of this PITView. The WWN of the view.

Required/optional:
Returns:	The world_wide_name of this PITView.
Return type:	str
	required

netapp.santricity.models.symbol.pit_view_creation_descriptor module¶

PITViewCreationDescriptor.py

class netapp.santricity.models.symbol.pit_view_creation_descriptor.PITViewCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

base_pit¶

Gets the base_pit of this PITViewCreationDescriptor. A reference to the base PiT.

Required/optional:
Returns:	The base_pit of this PITViewCreationDescriptor.
Return type:	str
	required

full_warn_threshold¶

Gets the full_warn_threshold of this PITViewCreationDescriptor. The repository utilization warning threshold percentage.

Required/optional:
Returns:	The full_warn_threshold of this PITViewCreationDescriptor.
Return type:	int
	required

repository_descriptor¶

Gets the repository_descriptor of this PITViewCreationDescriptor. The copy-on-write repository for this view.

Required/optional:
Returns:	The repository_descriptor of this PITViewCreationDescriptor.
Return type:	PITViewRepositoryCreationDescriptor
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

view_label¶

Gets the view_label of this PITViewCreationDescriptor. The name of the view.

Required/optional:
Returns:	The view_label of this PITViewCreationDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.pit_view_deletion_descriptor module¶

PITViewDeletionDescriptor.py

class netapp.santricity.models.symbol.pit_view_deletion_descriptor.PITViewDeletionDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

retain_repository_members¶

Gets the retain_repository_members of this PITViewDeletionDescriptor. A flag used to indicate whether the member volumes of the associated repository should be retained or removed as part of the deletion.

Required/optional:
Returns:	The retain_repository_members of this PITViewDeletionDescriptor.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

view_ref¶

Gets the view_ref of this PITViewDeletionDescriptor. The view to delete.

Required/optional:
Returns:	The view_ref of this PITViewDeletionDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.pit_view_membership module¶

PITViewMembership.py

class netapp.santricity.models.symbol.pit_view_membership.PITViewMembership[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cg_view_ref¶

Gets the cg_view_ref of this PITViewMembership. A reference to the PITConsistencyGroupView is returned if the value of viewType is equal to PIT_VIEW_TYPE_MEMBER.

Required/optional:
Returns:	The cg_view_ref of this PITViewMembership.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

view_type¶

Gets the view_type of this PITViewMembership. This enumeration identifies the possible types for a PITView.

Required/optional:
Returns:	The view_type of this PITViewMembership.
Return type:	str
	required

netapp.santricity.models.symbol.pit_view_params_update_descriptor module¶

PITViewParamsUpdateDescriptor.py

class netapp.santricity.models.symbol.pit_view_params_update_descriptor.PITViewParamsUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

full_warn_threshold¶

Gets the full_warn_threshold of this PITViewParamsUpdateDescriptor. The repository utilization warning threshold percentage.

Required/optional:
Returns:	The full_warn_threshold of this PITViewParamsUpdateDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

view_label¶

Gets the view_label of this PITViewParamsUpdateDescriptor. The name of the view.

Required/optional:
Returns:	The view_label of this PITViewParamsUpdateDescriptor.
Return type:	str
	required

view_ref¶

Gets the view_ref of this PITViewParamsUpdateDescriptor. The view on which parameters are to be set.

Required/optional:
Returns:	The view_ref of this PITViewParamsUpdateDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.pit_view_ref_list module¶

PITViewRefList.py

class netapp.santricity.models.symbol.pit_view_ref_list.PITViewRefList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

pit_view_ref¶

Gets the pit_view_ref of this PITViewRefList. An array of PITView references

Required/optional:
Returns:	The pit_view_ref of this PITViewRefList.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_view_repository_creation_descriptor module¶

PITViewRepositoryCreationDescriptor.py

class netapp.santricity.models.symbol.pit_view_repository_creation_descriptor.PITViewRepositoryCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

access_mode¶

Gets the access_mode of this PITViewRepositoryCreationDescriptor. This enumeration is used to describe the allowed access mode(s) for a PiT View.

Required/optional:
Returns:	The access_mode of this PITViewRepositoryCreationDescriptor.
Return type:	str
	required

repository_candidate¶

Gets the repository_candidate of this PITViewRepositoryCreationDescriptor. This field is present only if the value of accessMode is equal to VIEW_READ_WRITE.

Required/optional:
Returns:	The repository_candidate of this PITViewRepositoryCreationDescriptor.
Return type:	ConcatVolumeCreationDescriptor
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_view_repository_utilization module¶

PITViewRepositoryUtilization.py

class netapp.santricity.models.symbol.pit_view_repository_utilization.PITViewRepositoryUtilization[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

view_bytes_available¶

Gets the view_bytes_available of this PITViewRepositoryUtilization. The total number of bytes available for ongoing copy-on-write operations.

Required/optional:
Returns:	The view_bytes_available of this PITViewRepositoryUtilization.
Return type:	int
	required

view_bytes_used¶

Gets the view_bytes_used of this PITViewRepositoryUtilization. The number of bytes used in the repository for the view metadata, copy-on-write indexes, and copy-on-write data.

Required/optional:
Returns:	The view_bytes_used of this PITViewRepositoryUtilization.
Return type:	int
	required

view_ref¶

Gets the view_ref of this PITViewRepositoryUtilization. The ViewRef for which this utilization applies.

Required/optional:
Returns:	The view_ref of this PITViewRepositoryUtilization.
Return type:	str
	required

netapp.santricity.models.symbol.pit_view_repository_utilization_list module¶

PITViewRepositoryUtilizationList.py

class netapp.santricity.models.symbol.pit_view_repository_utilization_list.PITViewRepositoryUtilizationList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

repository_utilization¶

Gets the repository_utilization of this PITViewRepositoryUtilizationList. A variable-length array of PITViewRepositoryUtilization objects.

Required/optional:
Returns:	The repository_utilization of this PITViewRepositoryUtilizationList.
Return type:	list[PITViewRepositoryUtilization]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pit_view_repository_utilization_list_returned module¶

PITViewRepositoryUtilizationListReturned.py

class netapp.santricity.models.symbol.pit_view_repository_utilization_list_returned.PITViewRepositoryUtilizationListReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

return_code¶

Gets the return_code of this PITViewRepositoryUtilizationListReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this PITViewRepositoryUtilizationListReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

utilization¶

Gets the utilization of this PITViewRepositoryUtilizationListReturned. A list of PITViewRepositoryUtilization structures. This field is present only if the value of returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The utilization of this PITViewRepositoryUtilizationListReturned.
Return type:	PITViewRepositoryUtilizationList
	optional

netapp.santricity.models.symbol.pit_view_restart_descriptor module¶

PITViewRestartDescriptor.py

class netapp.santricity.models.symbol.pit_view_restart_descriptor.PITViewRestartDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

base_pit¶

Gets the base_pit of this PITViewRestartDescriptor. The PiT to which to attach the view. Note this must be a PiT in a PITGroup of the base volume with which the view is associated.

Required/optional:
Returns:	The base_pit of this PITViewRestartDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

view_ref¶

Gets the view_ref of this PITViewRestartDescriptor. The view to restart.

Required/optional:
Returns:	The view_ref of this PITViewRestartDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.pit_view_rw_conversion_descriptor module¶

PITViewRWConversionDescriptor.py

class netapp.santricity.models.symbol.pit_view_rw_conversion_descriptor.PITViewRWConversionDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

full_warn_threshold¶

Gets the full_warn_threshold of this PITViewRWConversionDescriptor. The repository full warning threshold. Although this is specified on the view already, it does not make sense for a read-only view and so should be validated/set as part of the conversion to read/write to ensure the value set makes sense for the now read/write view.

Required/optional:
Returns:	The full_warn_threshold of this PITViewRWConversionDescriptor.
Return type:	int
	required

repository_candidate¶

Gets the repository_candidate of this PITViewRWConversionDescriptor. A descriptor for creation of the repository (read-only view does not have a repository so one must be created in order to convert to read/write).

Required/optional:
Returns:	The repository_candidate of this PITViewRWConversionDescriptor.
Return type:	ConcatVolumeCreationDescriptor
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

view_ref¶

Gets the view_ref of this PITViewRWConversionDescriptor. A reference to the view to convert.

Required/optional:
Returns:	The view_ref of this PITViewRWConversionDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.pkcs5_encryption_data module¶

PKCS5EncryptionData.py

class netapp.santricity.models.symbol.pkcs5_encryption_data.PKCS5EncryptionData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cipher_text¶

Gets the cipher_text of this PKCS5EncryptionData. A variable-length array containing the encrypted data, or cipher text. The length of this array must be a multiple of 8 in order to conform to the PKCS #5 standard. The standard specifies the appropriate technique for adding pad bytes to ensure that this constraint is met.

Required/optional:
Returns:	The cipher_text of this PKCS5EncryptionData.
Return type:	str
	required

iterations¶

Gets the iterations of this PKCS5EncryptionData. The number of message digest iterations to be performed when generating the encryption key and initialization vector from the passphrase and salt values.

Required/optional:
Returns:	The iterations of this PKCS5EncryptionData.
Return type:	int
	required

salt¶

Gets the salt of this PKCS5EncryptionData. A byte array containing the salt, or random data, selected by the encryption code for this particular encryption operation.

Required/optional:
Returns:	The salt of this PKCS5EncryptionData.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.port module¶

Port.py

class netapp.santricity.models.symbol.port.Port[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

port_status¶

Gets the port_status of this Port. An indication of the status of the fibre channel port.

Required/optional:
Returns:	The port_status of this Port.
Return type:	str
	required

port_type¶

Gets the port_type of this Port. An indication of the type of fibre channel port.

Required/optional:
Returns:	The port_type of this Port.
Return type:	str
	required

reserved1¶

Gets the reserved1 of this Port.

Required/optional:
Returns:	The reserved1 of this Port.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this Port.

Required/optional:
Returns:	The reserved2 of this Port.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.port_idtlv module¶

PortIDTLV.py

class netapp.santricity.models.symbol.port_idtlv.PortIDTLV[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

port_id¶

Gets the port_id of this PortIDTLV. This field contains an octet string indicating the specific identifier for the port.

Required/optional:
Returns:	The port_id of this PortIDTLV.
Return type:	str
	required

subtype¶

Gets the subtype of this PortIDTLV. This field contains the ID for the subtype.

Required/optional:
Returns:	The subtype of this PortIDTLV.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.port_list module¶

PortList.py

class netapp.santricity.models.symbol.port_list.PortList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ports¶

Gets the ports of this PortList. A variable-length array of Port objects.

Required/optional:
Returns:	The ports of this PortList.
Return type:	list[Port]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.power_cycle_physical_drive_data_return module¶

PowerCyclePhysicalDriveDataReturn.py

class netapp.santricity.models.symbol.power_cycle_physical_drive_data_return.PowerCyclePhysicalDriveDataReturn[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_ref¶

Gets the drive_ref of this PowerCyclePhysicalDriveDataReturn. The drive for which the powerCyclePhysicalDrive procedure was sent.

Required/optional:
Returns:	The drive_ref of this PowerCyclePhysicalDriveDataReturn.
Return type:	str
	required

ret_code¶

Gets the ret_code of this PowerCyclePhysicalDriveDataReturn. The return code from the powerCyclePhysicalDrive procedure.

Required/optional:
Returns:	The ret_code of this PowerCyclePhysicalDriveDataReturn.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.power_cycle_physical_drive_descriptor module¶

PowerCyclePhysicalDriveDescriptor.py

class netapp.santricity.models.symbol.power_cycle_physical_drive_descriptor.PowerCyclePhysicalDriveDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_ref¶

Gets the drive_ref of this PowerCyclePhysicalDriveDescriptor. The drive that should be acted upon.

Required/optional:
Returns:	The drive_ref of this PowerCyclePhysicalDriveDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.power_supply module¶

PowerSupply.py

class netapp.santricity.models.symbol.power_supply.PowerSupply[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

firmware_revision¶

Gets the firmware_revision of this PowerSupply. An ASCII character string that identifies the version of the firmware.

Required/optional:
Returns:	The firmware_revision of this PowerSupply.
Return type:	str
	required

fru_type¶

Gets the fru_type of this PowerSupply. The field replaceable unit type of the power supply.

Required/optional:
Returns:	The fru_type of this PowerSupply.
Return type:	str
	required

id¶

Gets the id of this PowerSupply.

Required/optional:
Returns:	The id of this PowerSupply.
Return type:	str
	optional

manufacturer_date¶

Gets the manufacturer_date of this PowerSupply. The date the power supply was manufactured.

Required/optional:
Returns:	The manufacturer_date of this PowerSupply.
Return type:	int
	required

manufacturing_device_code¶

Gets the manufacturing_device_code of this PowerSupply. An integer value that specifies the Manufacturing Device Code.

Required/optional:
Returns:	The manufacturing_device_code of this PowerSupply.
Return type:	int
	required

part_number¶

Gets the part_number of this PowerSupply. The part number of the power supply from VPD data.

Required/optional:
Returns:	The part_number of this PowerSupply.
Return type:	str
	required

physical_location¶

Gets the physical_location of this PowerSupply. The physical location of the power supply. Note that the tray reference identifies the enclosure containing the power supply. For non-XBB controller enclosures, the slot information does not apply. For XBB controller enclosures, the slot information is an ordinal identifier (a value of 1 means the first (left) power supply and a value of 2 means the second (right) power supply).

Required/optional:
Returns:	The physical_location of this PowerSupply.
Return type:	Location
	required

power_supply_ref¶

Gets the power_supply_ref of this PowerSupply. The physical location of the power supply. The parent reference in Location identifies the tray or CRU that physically houses the power supply, and the position field is the parent-relative/like-component relative number of the power supply, starting at one.

Required/optional:
Returns:	The power_supply_ref of this PowerSupply.
Return type:	str
	required

repair_policy¶

Gets the repair_policy of this PowerSupply. The repair policy for the power supply component.

Required/optional:
Returns:	The repair_policy of this PowerSupply.
Return type:	RepairPolicy
	required

reserved1¶

Gets the reserved1 of this PowerSupply.

Required/optional:
Returns:	The reserved1 of this PowerSupply.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this PowerSupply.

Required/optional:
Returns:	The reserved2 of this PowerSupply.
Return type:	str
	optional

rtr_attributes¶

Gets the rtr_attributes of this PowerSupply. The CRU type of the power supply plus its ready-to-remove attributes, which are based on the CRU type

Required/optional:
Returns:	The rtr_attributes of this PowerSupply.
Return type:	RTRAttributes
	required

serial_number¶

Gets the serial_number of this PowerSupply. The serial number of the power supply.

Required/optional:
Returns:	The serial_number of this PowerSupply.
Return type:	str
	required

status¶

Gets the status of this PowerSupply. The operation status of the power supply.

Required/optional:
Returns:	The status of this PowerSupply.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

vendor_name¶

Gets the vendor_name of this PowerSupply. The name of the manufacturer of the power supply.

Required/optional:
Returns:	The vendor_name of this PowerSupply.
Return type:	str
	required

netapp.santricity.models.symbol.premium_feature module¶

PremiumFeature.py

class netapp.santricity.models.symbol.premium_feature.PremiumFeature[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

capability¶

Gets the capability of this PremiumFeature. This field will contain the value of the premium feature being described.

Required/optional:
Returns:	The capability of this PremiumFeature.
Return type:	str
	required

feature_id¶

Gets the feature_id of this PremiumFeature. This field contains the value of the feature ID associated with the feature.

Required/optional:
Returns:	The feature_id of this PremiumFeature.
Return type:	str
	required

is_compliant¶

Gets the is_compliant of this PremiumFeature. A true value in this field indicates that the feature has been purchased (in compliance). A false value indicates that the feature has not been purchased. The user will receive warning messages indicating that they are not in compliance. The warning message will continue until the feature is purchased or the feature is disabled.

Required/optional:
Returns:	The is_compliant of this PremiumFeature.
Return type:	bool
	required

is_enabled¶

Gets the is_enabled of this PremiumFeature. A true value in this field indicates that the feature is enabled (regardless of compliance)

Required/optional:
Returns:	The is_enabled of this PremiumFeature.
Return type:	bool
	required

is_within_limits¶

Gets the is_within_limits of this PremiumFeature. A true value in this field indicates that the feature has been purchased and the subsystem configuration does not exceed the feature options specified at purchase. A false value in this field indicates that the feature has been purchased but new subsystem configuration has caused the user to exceed the feature options that were purchased. The user will receive warning messages indicating that they are no longer in compliance. The user can change the subsystem configuration so that it is in compliance with feature options or the user can purchase additional feature options so that the subsystem is again in compliance. The warning messages will continue until the feature is again in compliance or is disabled.

Required/optional:
Returns:	The is_within_limits of this PremiumFeature.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.processor_memory_dimm module¶

ProcessorMemoryDimm.py

class netapp.santricity.models.symbol.processor_memory_dimm.ProcessorMemoryDimm[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

capacity_in_megabytes¶

Gets the capacity_in_megabytes of this ProcessorMemoryDimm. The capacity of the DIMM expressed in megabytes.

Required/optional:
Returns:	The capacity_in_megabytes of this ProcessorMemoryDimm.
Return type:	int
	required

dimm_controller_slot¶

Gets the dimm_controller_slot of this ProcessorMemoryDimm. The controller-relative slot number of the DIMM, where “1” is the first slot number.

Required/optional:
Returns:	The dimm_controller_slot of this ProcessorMemoryDimm.
Return type:	int
	required

manufacture_date¶

Gets the manufacture_date of this ProcessorMemoryDimm. The manufacture date of the DIMM

Required/optional:
Returns:	The manufacture_date of this ProcessorMemoryDimm.
Return type:	int
	required

manufacturer¶

Gets the manufacturer of this ProcessorMemoryDimm. The manufacturer part number of the DIMM.

Required/optional:
Returns:	The manufacturer of this ProcessorMemoryDimm.
Return type:	str
	required

manufacturer_part_number¶

Gets the manufacturer_part_number of this ProcessorMemoryDimm. The manufacturer part number of the DIMM.

Required/optional:
Returns:	The manufacturer_part_number of this ProcessorMemoryDimm.
Return type:	str
	required

oem_part_number¶

Gets the oem_part_number of this ProcessorMemoryDimm. The OEM part number of the DIMM.

Required/optional:
Returns:	The oem_part_number of this ProcessorMemoryDimm.
Return type:	str
	required

parent_controller¶

Gets the parent_controller of this ProcessorMemoryDimm. The SYMbol reference of the DIMM’s parent controller.

Required/optional:
Returns:	The parent_controller of this ProcessorMemoryDimm.
Return type:	str
	required

part_number¶

Gets the part_number of this ProcessorMemoryDimm. The LSI Logic part number of the DIMM.

Required/optional:
Returns:	The part_number of this ProcessorMemoryDimm.
Return type:	str
	required

physical_location¶

Gets the physical_location of this ProcessorMemoryDimm. The physical location of the processor memory DIMM. The parent field of Location is set to the controller where the DIMM physically resides, and the position field is the parent-relative/like-component-relative slot number of the DIMM, starting at one.

Required/optional:
Returns:	The physical_location of this ProcessorMemoryDimm.
Return type:	Location
	required

processor_memory_dimm_ref¶

Gets the processor_memory_dimm_ref of this ProcessorMemoryDimm. The SYMbol reference value that uniquely identifies an instance of a cache memory DIMM object.

Required/optional:
Returns:	The processor_memory_dimm_ref of this ProcessorMemoryDimm.
Return type:	str
	required

repair_policy¶

Gets the repair_policy of this ProcessorMemoryDimm. The repair policy for the processor memory DIMM component.

Required/optional:
Returns:	The repair_policy of this ProcessorMemoryDimm.
Return type:	RepairPolicy
	required

revision_code¶

Gets the revision_code of this ProcessorMemoryDimm. The module revision code of the DIMM.

Required/optional:
Returns:	The revision_code of this ProcessorMemoryDimm.
Return type:	str
	required

serial_number¶

Gets the serial_number of this ProcessorMemoryDimm. The serial number of the DIMM.

Required/optional:
Returns:	The serial_number of this ProcessorMemoryDimm.
Return type:	str
	required

status¶

Gets the status of this ProcessorMemoryDimm. The operational status of the DIMM.

Required/optional:
Returns:	The status of this ProcessorMemoryDimm.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.product_capability_list module¶

ProductCapabilityList.py

class netapp.santricity.models.symbol.product_capability_list.ProductCapabilityList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

product_capabilities¶

Gets the product_capabilities of this ProductCapabilityList. A variable length list of product capabilities.

Required/optional:
Returns:	The product_capabilities of this ProductCapabilityList.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.protection_information_capabilities module¶

ProtectionInformationCapabilities.py

class netapp.santricity.models.symbol.protection_information_capabilities.ProtectionInformationCapabilities[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

protection_information_capable¶

Gets the protection_information_capable of this ProtectionInformationCapabilities. True when all drive(s) are PI capable.

Required/optional:
Returns:	The protection_information_capable of this ProtectionInformationCapabilities.
Return type:	bool
	required

protection_type¶

Gets the protection_type of this ProtectionInformationCapabilities. This field is set to the protection type provided for the drive(s).

Required/optional:
Returns:	The protection_type of this ProtectionInformationCapabilities.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.psu_firmware_update_descriptor module¶

PSUFirmwareUpdateDescriptor.py

class netapp.santricity.models.symbol.psu_firmware_update_descriptor.PSUFirmwareUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

firmware_update_descriptor¶

Gets the firmware_update_descriptor of this PSUFirmwareUpdateDescriptor. The firmware update descriptor containing the firmware image and related information.

Required/optional:
Returns:	The firmware_update_descriptor of this PSUFirmwareUpdateDescriptor.
Return type:	FirmwareUpdateDescriptor
	required

force_update¶

Gets the force_update of this PSUFirmwareUpdateDescriptor. Force an update of power supplies with the same FW revision as the updated FW or non-optimal power supplies.

Required/optional:
Returns:	The force_update of this PSUFirmwareUpdateDescriptor.
Return type:	bool
	required

power_supply_ref¶

Gets the power_supply_ref of this PSUFirmwareUpdateDescriptor. A list of references to power supply objects.

Required/optional:
Returns:	The power_supply_ref of this PSUFirmwareUpdateDescriptor.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.psu_firmware_update_status module¶

PSUFirmwareUpdateStatus.py

class netapp.santricity.models.symbol.psu_firmware_update_status.PSUFirmwareUpdateStatus[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

psu_update_status¶

Gets the psu_update_status of this PSUFirmwareUpdateStatus. This field is present only if returnCode is equal to RETCODE_OK. It is a variable length array of statuses.

Required/optional:
Returns:	The psu_update_status of this PSUFirmwareUpdateStatus.
Return type:	list[PSUUpdateStatus]
	optional

return_code¶

Gets the return_code of this PSUFirmwareUpdateStatus. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this PSUFirmwareUpdateStatus.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.psu_update_status module¶

PSUUpdateStatus.py

class netapp.santricity.models.symbol.psu_update_status.PSUUpdateStatus[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

power_supply_ref¶

Gets the power_supply_ref of this PSUUpdateStatus. A reference to the power supply object.

Required/optional:
Returns:	The power_supply_ref of this PSUUpdateStatus.
Return type:	str
	required

power_supply_update_status¶

Gets the power_supply_update_status of this PSUUpdateStatus. The firmware update status.

Required/optional:
Returns:	The power_supply_update_status of this PSUUpdateStatus.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.pvg_recovery_data module¶

PvgRecoveryData.py

class netapp.santricity.models.symbol.pvg_recovery_data.PvgRecoveryData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive¶

Gets the drive of this PvgRecoveryData. This field is a SYMbol reference indicating the “drive of interest” for the associated recovery failure type.

Required/optional:
Returns:	The drive of this PvgRecoveryData.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_group¶

Gets the volume_group of this PvgRecoveryData. This field is a SYMbol reference indicating the “volume group of interest” for the associated recovery failure type.

Required/optional:
Returns:	The volume_group of this PvgRecoveryData.
Return type:	str
	required

netapp.santricity.models.symbol.raw_data_restore_chunk_details module¶

RawDataRestoreChunkDetails.py

class netapp.santricity.models.symbol.raw_data_restore_chunk_details.RawDataRestoreChunkDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

dbm_blk¶

Gets the dbm_blk of this RawDataRestoreChunkDetails. This field is present only if the type value is equal to RAWDATA_DBMBLK.

Required/optional:
Returns:	The dbm_blk of this RawDataRestoreChunkDetails.
Return type:	DbmBlkRestoreChunkDetails
	optional

dbm_rec¶

Gets the dbm_rec of this RawDataRestoreChunkDetails. This field is present only if the type value is equal to RAWDATA_DBMREC.

Required/optional:
Returns:	The dbm_rec of this RawDataRestoreChunkDetails.
Return type:	DbmRecRestoreChunkDetails
	optional

raw_data_transfer_type¶

Gets the raw_data_transfer_type of this RawDataRestoreChunkDetails. This enumeration lists the raw data transfer types.

Required/optional:
Returns:	The raw_data_transfer_type of this RawDataRestoreChunkDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.raw_data_restore_continue_desc module¶

RawDataRestoreContinueDesc.py

class netapp.santricity.models.symbol.raw_data_restore_continue_desc.RawDataRestoreContinueDesc[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_ref¶

Gets the controller_ref of this RawDataRestoreContinueDesc. The controller running the retrieve.

Required/optional:
Returns:	The controller_ref of this RawDataRestoreContinueDesc.
Return type:	str
	required

details¶

Gets the details of this RawDataRestoreContinueDesc. The transfer type-specific details.

Required/optional:
Returns:	The details of this RawDataRestoreContinueDesc.
Return type:	RawDataRestoreChunkDetails
	required

final_sequence_number¶

Gets the final_sequence_number of this RawDataRestoreContinueDesc. Indicates the sequence number of the last chunk that will be delivered to the controller.

Required/optional:
Returns:	The final_sequence_number of this RawDataRestoreContinueDesc.
Return type:	int
	required

this_sequence_number¶

Gets the this_sequence_number of this RawDataRestoreContinueDesc. The sequence number of the current chunk of data being delivered to the controller.

Required/optional:
Returns:	The this_sequence_number of this RawDataRestoreContinueDesc.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this RawDataRestoreContinueDesc. The type of transfer

Required/optional:
Returns:	The type of this RawDataRestoreContinueDesc.
Return type:	str
	required

netapp.santricity.models.symbol.raw_data_restore_result module¶

RawDataRestoreResult.py

class netapp.santricity.models.symbol.raw_data_restore_result.RawDataRestoreResult[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ret_code¶

Gets the ret_code of this RawDataRestoreResult. Return code from the startRawDataRestore or continueRawDataRestore procedure.

Required/optional:
Returns:	The ret_code of this RawDataRestoreResult.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this RawDataRestoreResult. The data transfer type.

Required/optional:
Returns:	The type of this RawDataRestoreResult.
Return type:	str
	required

netapp.santricity.models.symbol.raw_data_restore_start_desc module¶

RawDataRestoreStartDesc.py

class netapp.santricity.models.symbol.raw_data_restore_start_desc.RawDataRestoreStartDesc[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_ref¶

Gets the controller_ref of this RawDataRestoreStartDesc. The controller that should run the restore.

Required/optional:
Returns:	The controller_ref of this RawDataRestoreStartDesc.
Return type:	str
	required

details¶

Gets the details of this RawDataRestoreStartDesc. identifies the type of transfer and transfer-type specific parameters for the restore operation.

Required/optional:
Returns:	The details of this RawDataRestoreStartDesc.
Return type:	RawDataRestoreStartDetails
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.raw_data_restore_start_details module¶

RawDataRestoreStartDetails.py

class netapp.santricity.models.symbol.raw_data_restore_start_details.RawDataRestoreStartDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

dbm_blk¶

Gets the dbm_blk of this RawDataRestoreStartDetails. This field is present only if the type value is equal to RAWDATA_DBMBLK.

Required/optional:
Returns:	The dbm_blk of this RawDataRestoreStartDetails.
Return type:	DbmBlkRestoreStartDetails
	optional

dbm_rec¶

Gets the dbm_rec of this RawDataRestoreStartDetails. This field is present only if the type value is equal to RAWDATA_DBMREC.

Required/optional:
Returns:	The dbm_rec of this RawDataRestoreStartDetails.
Return type:	DbmRecRestoreStartDetails
	optional

raw_data_transfer_type¶

Gets the raw_data_transfer_type of this RawDataRestoreStartDetails. This enumeration lists the raw data transfer types.

Required/optional:
Returns:	The raw_data_transfer_type of this RawDataRestoreStartDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.raw_data_retrieve_chunk_details module¶

RawDataRetrieveChunkDetails.py

class netapp.santricity.models.symbol.raw_data_retrieve_chunk_details.RawDataRetrieveChunkDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

auto_load_balance_statistics¶

Gets the auto_load_balance_statistics of this RawDataRetrieveChunkDetails. Auto Load Balance statistics log data returned to the reqeustor.

Required/optional:
Returns:	The auto_load_balance_statistics of this RawDataRetrieveChunkDetails.
Return type:	AutoLoadBalanceStatsLogRetrieveChunkDetails
	optional

ctrl_perf_stats¶

Gets the ctrl_perf_stats of this RawDataRetrieveChunkDetails.

Required/optional:
Returns:	The ctrl_perf_stats of this RawDataRetrieveChunkDetails.
Return type:	PerformanceRingChunkDetails
	optional

dbm_blk¶

Gets the dbm_blk of this RawDataRetrieveChunkDetails. This field is present only if the type value is equal to RAWDATA_DBMBLK.

Required/optional:
Returns:	The dbm_blk of this RawDataRetrieveChunkDetails.
Return type:	DbmBlkRetrieveChunkDetails
	optional

dbm_check¶

Gets the dbm_check of this RawDataRetrieveChunkDetails. This field is present only if the type value is equal to RAWDATA_DBM_CHECK.

Required/optional:
Returns:	The dbm_check of this RawDataRetrieveChunkDetails.
Return type:	DbmCheckRetrieveChunkDetails
	optional

dbm_rec¶

Gets the dbm_rec of this RawDataRetrieveChunkDetails. This field is present only if the type value is equal to RAWDATA_DBMREC.

Required/optional:
Returns:	The dbm_rec of this RawDataRetrieveChunkDetails.
Return type:	DbmRecRetrieveChunkDetails
	optional

dom0_data_chunk_details¶

Gets the dom0_data_chunk_details of this RawDataRetrieveChunkDetails. This field is present only if the type value is equal to RAWDATA_DOM0_SUPPORT_DATA.

Required/optional:
Returns:	The dom0_data_chunk_details of this RawDataRetrieveChunkDetails.
Return type:	Dom0SupportDataChunkDetails
	optional

dpl_core_dump¶

Gets the dpl_core_dump of this RawDataRetrieveChunkDetails. This field is present only if the type value is equal to RAWDATA_DPL_CORE_DUMP_BUNDLE.

Required/optional:
Returns:	The dpl_core_dump of this RawDataRetrieveChunkDetails.
Return type:	DPLCoreDumpRetrieveChunkDetails
	optional

dq¶

Gets the dq of this RawDataRetrieveChunkDetails. This field is present only if the type value is equal to RAWDATA_DQ.

Required/optional:
Returns:	The dq of this RawDataRetrieveChunkDetails.
Return type:	DqRetrieveChunkDetails
	optional

drive_health_logs¶

Gets the drive_health_logs of this RawDataRetrieveChunkDetails. This is the case for when drive health logs are being returned in the raw data retrieve operation.

Required/optional:
Returns:	The drive_health_logs of this RawDataRetrieveChunkDetails.
Return type:	DriveHealthLogsChunkDetails
	optional

drive_performance_history¶

Gets the drive_performance_history of this RawDataRetrieveChunkDetails. This field is present only if the type value is equal to RAWDATA_DRIVE_PERFORMANCE_HISTORY.

Required/optional:
Returns:	The drive_performance_history of this RawDataRetrieveChunkDetails.
Return type:	DrivePerformanceHistoryRetrieveChunkDetails
	optional

enclosure_state_capture¶

Gets the enclosure_state_capture of this RawDataRetrieveChunkDetails. This field is present only if the type value is equal to RAWDATA_ENCLOSURE_STATE_CAPTURE.

Required/optional:
Returns:	The enclosure_state_capture of this RawDataRetrieveChunkDetails.
Return type:	EnclosureStateCaptureRetrieveChunkDetails
	optional

fdi_dems_log¶

Gets the fdi_dems_log of this RawDataRetrieveChunkDetails. This field is present only if the type value is equal to RAWDATA_FDI_DEMS_LOGS.

Required/optional:
Returns:	The fdi_dems_log of this RawDataRetrieveChunkDetails.
Return type:	FdiDemsLogRetrieveChunkDetails
	optional

io_statistics¶

Gets the io_statistics of this RawDataRetrieveChunkDetails. This field is present only if the type value is equal to RAWDATA_IO_STATISTICS.

Required/optional:
Returns:	The io_statistics of this RawDataRetrieveChunkDetails.
Return type:	IoStatisticsRetrieveChunkDetails
	optional

ioc_dump¶

Gets the ioc_dump of this RawDataRetrieveChunkDetails. This field is present only if the type value is equal to RAWDATA_IOC_DUMP.

Required/optional:
Returns:	The ioc_dump of this RawDataRetrieveChunkDetails.
Return type:	IOCDumpRetrieveChunkDetails
	optional

raw_data_transfer_type¶

Gets the raw_data_transfer_type of this RawDataRetrieveChunkDetails. This enumeration lists the raw data transfer types.

Required/optional:
Returns:	The raw_data_transfer_type of this RawDataRetrieveChunkDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

wlc_analytics_chunk_details¶

Gets the wlc_analytics_chunk_details of this RawDataRetrieveChunkDetails. Data passed back to host application when workload capture data is retrieved.

Required/optional:
Returns:	The wlc_analytics_chunk_details of this RawDataRetrieveChunkDetails.
Return type:	WlcAnalyticsChunkDetails
	optional

netapp.santricity.models.symbol.raw_data_retrieve_continue_desc module¶

RawDataRetrieveContinueDesc.py

class netapp.santricity.models.symbol.raw_data_retrieve_continue_desc.RawDataRetrieveContinueDesc[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_ref¶

Gets the controller_ref of this RawDataRetrieveContinueDesc. The controller running the retrieve.

Required/optional:
Returns:	The controller_ref of this RawDataRetrieveContinueDesc.
Return type:	str
	required

sequence_number¶

Gets the sequence_number of this RawDataRetrieveContinueDesc. sequence number of the next chunk of data to be retrieved.

Required/optional:
Returns:	The sequence_number of this RawDataRetrieveContinueDesc.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this RawDataRetrieveContinueDesc. The raw data transfer type (dq, dbm, or unknown).

Required/optional:
Returns:	The type of this RawDataRetrieveContinueDesc.
Return type:	str
	required

netapp.santricity.models.symbol.raw_data_retrieve_info module¶

RawDataRetrieveInfo.py

class netapp.santricity.models.symbol.raw_data_retrieve_info.RawDataRetrieveInfo[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

details¶

Gets the details of this RawDataRetrieveInfo. The transfer type-specific details.

Required/optional:
Returns:	The details of this RawDataRetrieveInfo.
Return type:	RawDataRetrieveChunkDetails
	required

last_chunk¶

Gets the last_chunk of this RawDataRetrieveInfo. True for the last chunk of data; otherwise false.

Required/optional:
Returns:	The last_chunk of this RawDataRetrieveInfo.
Return type:	bool
	required

percent_complete¶

Gets the percent_complete of this RawDataRetrieveInfo. This value is a number in the range of 0 to 100 indicating the percent complete.

Required/optional:
Returns:	The percent_complete of this RawDataRetrieveInfo.
Return type:	int
	required

this_sequence_number¶

Gets the this_sequence_number of this RawDataRetrieveInfo. The sequence number of the current chunk of data being delivered to the controller.

Required/optional:
Returns:	The this_sequence_number of this RawDataRetrieveInfo.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this RawDataRetrieveInfo. The data transfer type.

Required/optional:
Returns:	The type of this RawDataRetrieveInfo.
Return type:	str
	required

netapp.santricity.models.symbol.raw_data_retrieve_result module¶

RawDataRetrieveResult.py

class netapp.santricity.models.symbol.raw_data_retrieve_result.RawDataRetrieveResult[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

info¶

Gets the info of this RawDataRetrieveResult. The transfer type, this sequence number, the final sequence number, and type-specific details.

Required/optional:
Returns:	The info of this RawDataRetrieveResult.
Return type:	RawDataRetrieveInfo
	optional

return_code¶

Gets the return_code of this RawDataRetrieveResult. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this RawDataRetrieveResult.
Return type:	str
	required

this_sequence_number¶

Gets the this_sequence_number of this RawDataRetrieveResult. The sequence number of the data chunk that could not be transferred is returned.

Required/optional:
Returns:	The this_sequence_number of this RawDataRetrieveResult.
Return type:	int
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.raw_data_retrieve_start_desc module¶

RawDataRetrieveStartDesc.py

class netapp.santricity.models.symbol.raw_data_retrieve_start_desc.RawDataRetrieveStartDesc[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_ref¶

Gets the controller_ref of this RawDataRetrieveStartDesc. The controller that should run the restore.

Required/optional:
Returns:	The controller_ref of this RawDataRetrieveStartDesc.
Return type:	str
	required

details¶

Gets the details of this RawDataRetrieveStartDesc. The transfer-type-specific details of the request.

Required/optional:
Returns:	The details of this RawDataRetrieveStartDesc.
Return type:	RawDataRetrieveStartDetails
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.raw_data_retrieve_start_details module¶

RawDataRetrieveStartDetails.py

class netapp.santricity.models.symbol.raw_data_retrieve_start_details.RawDataRetrieveStartDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

auto_load_balance_statistics_log¶

Gets the auto_load_balance_statistics_log of this RawDataRetrieveStartDetails. Specifies the details to start an Auto Load Balance statistics log data retrieval.

Required/optional:
Returns:	The auto_load_balance_statistics_log of this RawDataRetrieveStartDetails.
Return type:	AutoLoadBalanceStatsLogRetrieveStartDetails
	optional

ctrl_performance_parms¶

Gets the ctrl_performance_parms of this RawDataRetrieveStartDetails.

Required/optional:
Returns:	The ctrl_performance_parms of this RawDataRetrieveStartDetails.
Return type:	PerformanceRingStartDetails
	optional

dbm_blk¶

Gets the dbm_blk of this RawDataRetrieveStartDetails. This field is present only if the type value is equal to RAWDATA_DBMBLK.

Required/optional:
Returns:	The dbm_blk of this RawDataRetrieveStartDetails.
Return type:	DbmBlkRetrieveStartDetails
	optional

dbm_check¶

Gets the dbm_check of this RawDataRetrieveStartDetails. This field is present only if the type value is equal to RAWDATA_DBM_CHECK.

Required/optional:
Returns:	The dbm_check of this RawDataRetrieveStartDetails.
Return type:	DbmCheckRetrieveStartDetails
	optional

dbm_rec¶

Gets the dbm_rec of this RawDataRetrieveStartDetails. This field is present only if the type value is equal to RAWDATA_DBMREC.

Required/optional:
Returns:	The dbm_rec of this RawDataRetrieveStartDetails.
Return type:	DbmRecRetrieveStartDetails
	optional

dom0_support_data_start_details¶

Gets the dom0_support_data_start_details of this RawDataRetrieveStartDetails. Specifies the details required to start Dom0 support data retrieval for each data type.

Required/optional:
Returns:	The dom0_support_data_start_details of this RawDataRetrieveStartDetails.
Return type:	Dom0SupportDataStartDetails
	optional

dpl_core_dump¶

Gets the dpl_core_dump of this RawDataRetrieveStartDetails. This field is present only if the type value is equal to RAWDATA_DPL_CORE_DUMP_BUNDLE.

Required/optional:
Returns:	The dpl_core_dump of this RawDataRetrieveStartDetails.
Return type:	DPLCoreDumpRetrieveStartDetails
	optional

dq¶

Gets the dq of this RawDataRetrieveStartDetails. This field is present only if the type value is equal to RAWDATA_DQ.

Required/optional:
Returns:	The dq of this RawDataRetrieveStartDetails.
Return type:	DqRetrieveStartDetails
	optional

drive_health_logs¶

Gets the drive_health_logs of this RawDataRetrieveStartDetails. This is the case for when drive health logs are being returned in the raw data retrieve operation.

Required/optional:
Returns:	The drive_health_logs of this RawDataRetrieveStartDetails.
Return type:	DriveHealthLogsStartDetails
	optional

drive_performance_history¶

Gets the drive_performance_history of this RawDataRetrieveStartDetails. This field is present only if the type value is equal to RAWDATA_DRIVE_PERFORMANCE_HISTORY.

Required/optional:
Returns:	The drive_performance_history of this RawDataRetrieveStartDetails.
Return type:	DrivePerformanceHistoryRetrieveStartDetails
	optional

enclosure_state_capture¶

Gets the enclosure_state_capture of this RawDataRetrieveStartDetails. This field is present only if the type value is equal to RAWDATA_ENCLOSURE_STATE_CAPTURE.

Required/optional:
Returns:	The enclosure_state_capture of this RawDataRetrieveStartDetails.
Return type:	EnclosureStateCaptureRetrieveStartDetails
	optional

fdi_dems_log¶

Gets the fdi_dems_log of this RawDataRetrieveStartDetails. This field is present only if the type value is equal to RAWDATA_FDI_DEMS_LOGS.

Required/optional:
Returns:	The fdi_dems_log of this RawDataRetrieveStartDetails.
Return type:	FdiDemsLogRetrieveStartDetails
	optional

io_statistics¶

Gets the io_statistics of this RawDataRetrieveStartDetails. This field is present only if the type value is equal to RAWDATA_IO_STATISTICS.

Required/optional:
Returns:	The io_statistics of this RawDataRetrieveStartDetails.
Return type:	IoStatisticsRetrieveStartDetails
	optional

ioc_dump¶

Gets the ioc_dump of this RawDataRetrieveStartDetails. This field is present only if the type value is equal to RAWDATA_IOC_DUMP.

Required/optional:
Returns:	The ioc_dump of this RawDataRetrieveStartDetails.
Return type:	IOCDumpRetrieveStartDetails
	optional

raw_data_transfer_type¶

Gets the raw_data_transfer_type of this RawDataRetrieveStartDetails. This enumeration lists the raw data transfer types.

Required/optional:
Returns:	The raw_data_transfer_type of this RawDataRetrieveStartDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

wlc_analytics_start_details¶

Gets the wlc_analytics_start_details of this RawDataRetrieveStartDetails. Data to be used for the start of workload analytics data retrieve.

Required/optional:
Returns:	The wlc_analytics_start_details of this RawDataRetrieveStartDetails.
Return type:	WlcAnalyticsStartDetails
	optional

netapp.santricity.models.symbol.raw_data_retrieve_start_result module¶

RawDataRetrieveStartResult.py

class netapp.santricity.models.symbol.raw_data_retrieve_start_result.RawDataRetrieveStartResult[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

return_code¶

Gets the return_code of this RawDataRetrieveStartResult. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this RawDataRetrieveStartResult.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this RawDataRetrieveStartResult. The raw data transfer type.

Required/optional:
Returns:	The type of this RawDataRetrieveStartResult.
Return type:	str
	optional

netapp.santricity.models.symbol.raw_data_transfer_cancel_desc module¶

RawDataTransferCancelDesc.py

class netapp.santricity.models.symbol.raw_data_transfer_cancel_desc.RawDataTransferCancelDesc[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_ref¶

Gets the controller_ref of this RawDataTransferCancelDesc. The controller running the operation that should be canceled.

Required/optional:
Returns:	The controller_ref of this RawDataTransferCancelDesc.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

transfer_type¶

Gets the transfer_type of this RawDataTransferCancelDesc. The raw data transfer type

Required/optional:
Returns:	The transfer_type of this RawDataTransferCancelDesc.
Return type:	str
	required

netapp.santricity.models.symbol.recover_volume_descriptor module¶

RecoverVolumeDescriptor.py

class netapp.santricity.models.symbol.recover_volume_descriptor.RecoverVolumeDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

allocate_reserved_space¶

Gets the allocate_reserved_space of this RecoverVolumeDescriptor. Determines whether or not reserved space is allocated on the drives in the volume group.

Required/optional:
Returns:	The allocate_reserved_space of this RecoverVolumeDescriptor.
Return type:	bool
	required

capacity¶

Gets the capacity of this RecoverVolumeDescriptor. The volume capacity in megabytes.

Required/optional:
Returns:	The capacity of this RecoverVolumeDescriptor.
Return type:	int
	required

drive_count¶

Gets the drive_count of this RecoverVolumeDescriptor. The number of drives in the volume group.

Required/optional:
Returns:	The drive_count of this RecoverVolumeDescriptor.
Return type:	int
	required

drive_ref_list¶

Gets the drive_ref_list of this RecoverVolumeDescriptor. The list of drives to be used.

Required/optional:
Returns:	The drive_ref_list of this RecoverVolumeDescriptor.
Return type:	DriveRefList
	required

dss_prealloc_enabled¶

Gets the dss_prealloc_enabled of this RecoverVolumeDescriptor. True if dynamic segment sizing pre-allocation is enabled for the volume.

Required/optional:
Returns:	The dss_prealloc_enabled of this RecoverVolumeDescriptor.
Return type:	bool
	required

label¶

Gets the label of this RecoverVolumeDescriptor. The user assigned volume name.

Required/optional:
Returns:	The label of this RecoverVolumeDescriptor.
Return type:	str
	required

manager¶

Gets the manager of this RecoverVolumeDescriptor. The controller that will manage the volume. This is ignored if shared volume support is active.

Required/optional:
Returns:	The manager of this RecoverVolumeDescriptor.
Return type:	str
	required

offset¶

Gets the offset of this RecoverVolumeDescriptor. Volume begins at this drive offset (bytes).

Required/optional:
Returns:	The offset of this RecoverVolumeDescriptor.
Return type:	int
	required

protection_type¶

Gets the protection_type of this RecoverVolumeDescriptor. The protection type of the volume.

Required/optional:
Returns:	The protection_type of this RecoverVolumeDescriptor.
Return type:	str
	required

raid_level¶

Gets the raid_level of this RecoverVolumeDescriptor. The RAID level of the potential volume.

Required/optional:
Returns:	The raid_level of this RecoverVolumeDescriptor.
Return type:	str
	required

read_ahead¶

Gets the read_ahead of this RecoverVolumeDescriptor. A true (non-zero) / false (zero) indicator of whether or not automatic cache read-ahead is enabled.

Required/optional:
Returns:	The read_ahead of this RecoverVolumeDescriptor.
Return type:	int
	required

segment_size¶

Gets the segment_size of this RecoverVolumeDescriptor. The volume segment size (bytes).

Required/optional:
Returns:	The segment_size of this RecoverVolumeDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_group_label¶

Gets the volume_group_label of this RecoverVolumeDescriptor. The label to assign to the new volume group when unassigned drives are used for recovery.

Required/optional:
Returns:	The volume_group_label of this RecoverVolumeDescriptor.
Return type:	str
	required

volume_group_number¶

Gets the volume_group_number of this RecoverVolumeDescriptor. The volume group number.

Required/optional:
Returns:	The volume_group_number of this RecoverVolumeDescriptor.
Return type:	int
	required

volume_ssid¶

Gets the volume_ssid of this RecoverVolumeDescriptor. The SSID of the volume.

Required/optional:
Returns:	The volume_ssid of this RecoverVolumeDescriptor.
Return type:	int
	required

volume_wwn¶

Gets the volume_wwn of this RecoverVolumeDescriptor. The WWN of the volume.

Required/optional:
Returns:	The volume_wwn of this RecoverVolumeDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.recurrence module¶

Recurrence.py

class netapp.santricity.models.symbol.recurrence.Recurrence[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

recurrence_count¶

Gets the recurrence_count of this Recurrence. This field is present only if recurrenceType is equal to RECURRENCE_COUNT.

Required/optional:
Returns:	The recurrence_count of this Recurrence.
Return type:	int
	optional

recurrence_end_date¶

Gets the recurrence_end_date of this Recurrence. This field is present only if recurrenceType is equal to RECURRENCE_END_DATE.

Required/optional:
Returns:	The recurrence_end_date of this Recurrence.
Return type:	int
	optional

recurrence_type¶

Gets the recurrence_type of this Recurrence. This enumeration is used to specify the type of schedule recurrence.

Required/optional:
Returns:	The recurrence_type of this Recurrence.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.registered_ports module¶

RegisteredPorts.py

class netapp.santricity.models.symbol.registered_ports.RegisteredPorts[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

port_a0¶

Gets the port_a0 of this RegisteredPorts.

Required/optional:
Returns:	The port_a0 of this RegisteredPorts.
Return type:	bool
	optional

port_a1¶

Gets the port_a1 of this RegisteredPorts.

Required/optional:
Returns:	The port_a1 of this RegisteredPorts.
Return type:	bool
	optional

port_b0¶

Gets the port_b0 of this RegisteredPorts.

Required/optional:
Returns:	The port_b0 of this RegisteredPorts.
Return type:	bool
	optional

port_b1¶

Gets the port_b1 of this RegisteredPorts.

Required/optional:
Returns:	The port_b1 of this RegisteredPorts.
Return type:	bool
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.registrant module¶

Registrant.py

class netapp.santricity.models.symbol.registrant.Registrant[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

host_port_name¶

Gets the host_port_name of this Registrant. The host port name if not mapped.

Required/optional:
Returns:	The host_port_name of this Registrant.
Return type:	str
	required

host_port_ref¶

Gets the host_port_ref of this Registrant. The associated host port if mapped.

Required/optional:
Returns:	The host_port_ref of this Registrant.
Return type:	str
	required

registered_ports¶

Gets the registered_ports of this Registrant. Host port registered with these targets.

Required/optional:
Returns:	The registered_ports of this Registrant.
Return type:	RegisteredPorts
	required

reserved_port¶

Gets the reserved_port of this Registrant. Host port reserved for this target.

Required/optional:
Returns:	The reserved_port of this Registrant.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.registrant_list module¶

RegistrantList.py

class netapp.santricity.models.symbol.registrant_list.RegistrantList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

registrant¶

Gets the registrant of this RegistrantList. A list of persistent registrants.

Required/optional:
Returns:	The registrant of this RegistrantList.
Return type:	list[Registrant]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.remote_array module¶

RemoteArray.py

class netapp.santricity.models.symbol.remote_array.RemoteArray[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

remote_array_ref¶

Gets the remote_array_ref of this RemoteArray. A unique identifier for this RemoteArray object.

Required/optional:
Returns:	The remote_array_ref of this RemoteArray.
Return type:	str
	required

remote_targets¶

Gets the remote_targets of this RemoteArray. One or more paths to the remote array. Note these could be differing protocols.

Required/optional:
Returns:	The remote_targets of this RemoteArray.
Return type:	list[str]
	required

sa_id¶

Gets the sa_id of this RemoteArray. The storage array ID of the remote array.

Required/optional:
Returns:	The sa_id of this RemoteArray.
Return type:	SAIdentifier
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.remote_array_authenticator module¶

RemoteArrayAuthenticator.py

class netapp.santricity.models.symbol.remote_array_authenticator.RemoteArrayAuthenticator[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cfg_gen¶

Gets the cfg_gen of this RemoteArrayAuthenticator. The current configuration generation number of the remote array.

Required/optional:
Returns:	The cfg_gen of this RemoteArrayAuthenticator.
Return type:	int
	required

digest¶

Gets the digest of this RemoteArrayAuthenticator. The SHA-1 message digest value.

Required/optional:
Returns:	The digest of this RemoteArrayAuthenticator.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.remote_communication_check_descriptor module¶

RemoteCommunicationCheckDescriptor.py

class netapp.santricity.models.symbol.remote_communication_check_descriptor.RemoteCommunicationCheckDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

num_samples¶

Gets the num_samples of this RemoteCommunicationCheckDescriptor. The number of sample communication times to collect for the request.

Required/optional:
Returns:	The num_samples of this RemoteCommunicationCheckDescriptor.
Return type:	int
	required

remote_volume¶

Gets the remote_volume of this RemoteCommunicationCheckDescriptor. The reference for the remote volume in a mirror relationship.

Required/optional:
Returns:	The remote_volume of this RemoteCommunicationCheckDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.remote_communication_check_sample_list module¶

RemoteCommunicationCheckSampleList.py

class netapp.santricity.models.symbol.remote_communication_check_sample_list.RemoteCommunicationCheckSampleList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

remote_communication_check_samples¶

Gets the remote_communication_check_samples of this RemoteCommunicationCheckSampleList. Array of sample communication times collected.

Required/optional:
Returns:	The remote_communication_check_samples of this RemoteCommunicationCheckSampleList.
Return type:	list[int]
	required

return_code¶

Gets the return_code of this RemoteCommunicationCheckSampleList. Status of the SYMbol request.

Required/optional:
Returns:	The return_code of this RemoteCommunicationCheckSampleList.
Return type:	str
	required

test_status¶

Gets the test_status of this RemoteCommunicationCheckSampleList. Status of the communication test.

Required/optional:
Returns:	The test_status of this RemoteCommunicationCheckSampleList.
Return type:	str
	required

timeout¶

Gets the timeout of this RemoteCommunicationCheckSampleList. Timeout value used for communication test.

Required/optional:
Returns:	The timeout of this RemoteCommunicationCheckSampleList.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.remote_mirror_authenticator module¶

RemoteMirrorAuthenticator.py

class netapp.santricity.models.symbol.remote_mirror_authenticator.RemoteMirrorAuthenticator[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cfg_gen¶

Gets the cfg_gen of this RemoteMirrorAuthenticator. The current configuration generation number of the remote array.

Required/optional:
Returns:	The cfg_gen of this RemoteMirrorAuthenticator.
Return type:	int
	required

digest¶

Gets the digest of this RemoteMirrorAuthenticator. SHA-1 message digest value.

Required/optional:
Returns:	The digest of this RemoteMirrorAuthenticator.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.remote_target module¶

RemoteTarget.py

class netapp.santricity.models.symbol.remote_target.RemoteTarget[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

node_name¶

Gets the node_name of this RemoteTarget. Node name associated with the local initiator.

Required/optional:
Returns:	The node_name of this RemoteTarget.
Return type:	ScsiNodeName
	required

remote_ref¶

Gets the remote_ref of this RemoteTarget. Unique identifier for this initiator/target object.

Required/optional:
Returns:	The remote_ref of this RemoteTarget.
Return type:	str
	required

scsiinitiator_target_base_properties¶

Gets the scsiinitiator_target_base_properties of this RemoteTarget.

Required/optional:
Returns:	The scsiinitiator_target_base_properties of this RemoteTarget.
Return type:	ScsiInitiatorTargetBaseProperties
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.remote_target_creation_descriptor module¶

RemoteTargetCreationDescriptor.py

class netapp.santricity.models.symbol.remote_target_creation_descriptor.RemoteTargetCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

remote_target_settings¶

Gets the remote_target_settings of this RemoteTargetCreationDescriptor. The initial settings for the new remote target.

Required/optional:
Returns:	The remote_target_settings of this RemoteTargetCreationDescriptor.
Return type:	InitiatorTargetInitialProperties
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.remote_vol_no_array module¶

RemoteVolNoArray.py

class netapp.santricity.models.symbol.remote_vol_no_array.RemoteVolNoArray[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

remote_volume¶

Gets the remote_volume of this RemoteVolNoArray. The reference to the remote volume.

Required/optional:
Returns:	The remote_volume of this RemoteVolNoArray.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.remote_vol_no_fabric module¶

RemoteVolNoFabric.py

class netapp.santricity.models.symbol.remote_vol_no_fabric.RemoteVolNoFabric[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

remote_volume¶

Gets the remote_volume of this RemoteVolNoFabric. The reference to the remote volume.

Required/optional:
Returns:	The remote_volume of this RemoteVolNoFabric.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.remote_vol_no_lun module¶

RemoteVolNoLUN.py

class netapp.santricity.models.symbol.remote_vol_no_lun.RemoteVolNoLUN[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

remote_volume¶

Gets the remote_volume of this RemoteVolNoLUN. The reference to the remote volume.

Required/optional:
Returns:	The remote_volume of this RemoteVolNoLUN.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.remote_vol_wwn_change_failed module¶

RemoteVolWWNChangeFailed.py

class netapp.santricity.models.symbol.remote_vol_wwn_change_failed.RemoteVolWWNChangeFailed[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

remote_volume¶

Gets the remote_volume of this RemoteVolWWNChangeFailed. The reference to the remote volume.

Required/optional:
Returns:	The remote_volume of this RemoteVolWWNChangeFailed.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.remote_volume module¶

RemoteVolume.py

class netapp.santricity.models.symbol.remote_volume.RemoteVolume[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

manager¶

Gets the manager of this RemoteVolume. The controller that owns the remote volume.

Required/optional:
Returns:	The manager of this RemoteVolume.
Return type:	str
	required

perms¶

Gets the perms of this RemoteVolume. The permissions of the volume.

Required/optional:
Returns:	The perms of this RemoteVolume.
Return type:	VolumePerms
	required

remote_array_id¶

Gets the remote_array_id of this RemoteVolume. The identifier of the remote array.

Required/optional:
Returns:	The remote_array_id of this RemoteVolume.
Return type:	SAIdentifier
	required

remote_node_name¶

Gets the remote_node_name of this RemoteVolume. The name of the RemoteVolume.

Required/optional:
Returns:	The remote_node_name of this RemoteVolume.
Return type:	ScsiNodeName
	required

remote_node_wwn¶

Gets the remote_node_wwn of this RemoteVolume. This field is deprecated. It will continue to be supported if remoteNodeName is NULL (IOInterfaceType == IO_IF_NOT_IMPLEMENTED). This will allow continued compatibility with clients still using this field.

Required/optional:
Returns:	The remote_node_wwn of this RemoteVolume.
Return type:	str
	required

remote_vol_capacity¶

Gets the remote_vol_capacity of this RemoteVolume. The actual capacity of the volume on the remote array.

Required/optional:
Returns:	The remote_vol_capacity of this RemoteVolume.
Return type:	int
	required

remote_vol_ref¶

Gets the remote_vol_ref of this RemoteVolume. The identifier of the remote volume.

Required/optional:
Returns:	The remote_vol_ref of this RemoteVolume.
Return type:	str
	required

remote_vol_security_type¶

Gets the remote_vol_security_type of this RemoteVolume. The security type of the volume on the remote array. Note this may be SECURITY_TYPE_UNKNOWN if connection to remote array is down.

Required/optional:
Returns:	The remote_vol_security_type of this RemoteVolume.
Return type:	str
	required

remote_vol_state¶

Gets the remote_vol_state of this RemoteVolume. The state of the current remote volume.

Required/optional:
Returns:	The remote_vol_state of this RemoteVolume.
Return type:	str
	required

remote_vol_user_label¶

Gets the remote_vol_user_label of this RemoteVolume. The user assigned label of the remote volume.

Required/optional:
Returns:	The remote_vol_user_label of this RemoteVolume.
Return type:	str
	required

remote_vol_wwn¶

Gets the remote_vol_wwn of this RemoteVolume. The WWN of the volume on the remote array.

Required/optional:
Returns:	The remote_vol_wwn of this RemoteVolume.
Return type:	str
	required

reserved1¶

Gets the reserved1 of this RemoteVolume.

Required/optional:
Returns:	The reserved1 of this RemoteVolume.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this RemoteVolume.

Required/optional:
Returns:	The reserved2 of this RemoteVolume.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_handle¶

Gets the volume_handle of this RemoteVolume. The SSID of the remote volume.

Required/optional:
Returns:	The volume_handle of this RemoteVolume.
Return type:	int
	required

world_wide_name¶

Gets the world_wide_name of this RemoteVolume. The WWN of the remote volume.

Required/optional:
Returns:	The world_wide_name of this RemoteVolume.
Return type:	str
	required

netapp.santricity.models.symbol.repair_policy module¶

RepairPolicy.py

class netapp.santricity.models.symbol.repair_policy.RepairPolicy[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

removal_data¶

Gets the removal_data of this RepairPolicy. This field contains the removal data for the component. This primary piece of data is a removal method. Additional “ready-to-remove” attributes may be defined, depending on the removal method.

Required/optional:
Returns:	The removal_data of this RepairPolicy.
Return type:	ComponentRemovalData
	required

replacement_method¶

Gets the replacement_method of this RepairPolicy. This field defines the “replacement method” for the component.

Required/optional:
Returns:	The replacement_method of this RepairPolicy.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.repository_utilization module¶

RepositoryUtilization.py

class netapp.santricity.models.symbol.repository_utilization.RepositoryUtilization[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

repository_usage¶

Gets the repository_usage of this RepositoryUtilization. This field contains the number of bytes used in the repository.

Required/optional:
Returns:	The repository_usage of this RepositoryUtilization.
Return type:	int
	required

snap_ref¶

Gets the snap_ref of this RepositoryUtilization. The snapshot volume to which this utilization refers.

Required/optional:
Returns:	The snap_ref of this RepositoryUtilization.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.repository_utilization_list module¶

RepositoryUtilizationList.py

class netapp.santricity.models.symbol.repository_utilization_list.RepositoryUtilizationList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ret_code¶

Gets the ret_code of this RepositoryUtilizationList. The return code from the getRepositoryUtilization procedure.

Required/optional:
Returns:	The ret_code of this RepositoryUtilizationList.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

utilization¶

Gets the utilization of this RepositoryUtilizationList. A list of Repository Utilization structures.

Required/optional:
Returns:	The utilization of this RepositoryUtilizationList.
Return type:	list[RepositoryUtilization]
	required

netapp.santricity.models.symbol.reserve_support_data_returned module¶

ReserveSupportDataReturned.py

class netapp.santricity.models.symbol.reserve_support_data_returned.ReserveSupportDataReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

return_code¶

Gets the return_code of this ReserveSupportDataReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this ReserveSupportDataReturned.
Return type:	str
	required

support_data_lock_key¶

Gets the support_data_lock_key of this ReserveSupportDataReturned. This field is present only if the value of returnCode is equal to RETCODE_OK. It contains the lock key to be used when later releasing the reservation.

Required/optional:
Returns:	The support_data_lock_key of this ReserveSupportDataReturned.
Return type:	int
	optional

support_data_lock_time_remaining¶

Gets the support_data_lock_time_remaining of this ReserveSupportDataReturned. This field is present only if the value of returnCode is equal to RETCODE_CSB_RESERVE_FAILED. It is an integer indicating the suggested number of seconds to wait before retrying the reserve.

Required/optional:
Returns:	The support_data_lock_time_remaining of this ReserveSupportDataReturned.
Return type:	int
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.return_code_with_opaque_data module¶

ReturnCodeWithOpaqueData.py

class netapp.santricity.models.symbol.return_code_with_opaque_data.ReturnCodeWithOpaqueData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

data¶

Gets the data of this ReturnCodeWithOpaqueData. The first 2MB of the data generated by the function is returned to the user.

Required/optional:
Returns:	The data of this ReturnCodeWithOpaqueData.
Return type:	str
	required

return_code¶

Gets the return_code of this ReturnCodeWithOpaqueData. The return code indication for the requested procedure.

Required/optional:
Returns:	The return_code of this ReturnCodeWithOpaqueData.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.return_code_with_ref module¶

ReturnCodeWithRef.py

class netapp.santricity.models.symbol.return_code_with_ref.ReturnCodeWithRef[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ref¶

Gets the ref of this ReturnCodeWithRef. The SYMbol reference value associated with the operation. This is typically the reference value of a new entity that was created by the procedure, so the actual type of the reference will be one of the types that is derived directly from SYMbolRef.

Required/optional:
Returns:	The ref of this ReturnCodeWithRef.
Return type:	str
	required

return_code¶

Gets the return_code of this ReturnCodeWithRef. The return code indication for the requested procedure.

Required/optional:
Returns:	The return_code of this ReturnCodeWithRef.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.return_code_with_ref_list module¶

ReturnCodeWithRefList.py

class netapp.santricity.models.symbol.return_code_with_ref_list.ReturnCodeWithRefList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ref_list¶

Gets the ref_list of this ReturnCodeWithRefList. This field is present only if returnCode is equal to RETCODE_OK. It is a variable length array of references.

Required/optional:
Returns:	The ref_list of this ReturnCodeWithRefList.
Return type:	list[str]
	optional

return_code¶

Gets the return_code of this ReturnCodeWithRefList. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this ReturnCodeWithRefList.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.rlogin_update_descriptor module¶

RloginUpdateDescriptor.py

class netapp.santricity.models.symbol.rlogin_update_descriptor.RloginUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this RloginUpdateDescriptor. The channel number of this interface.

Required/optional:
Returns:	The channel of this RloginUpdateDescriptor.
Return type:	int
	required

controller_ref¶

Gets the controller_ref of this RloginUpdateDescriptor. The intended target of this command.

Required/optional:
Returns:	The controller_ref of this RloginUpdateDescriptor.
Return type:	str
	required

enable_rlogin¶

Gets the enable_rlogin of this RloginUpdateDescriptor. Set if rlogin capability is desired.

Required/optional:
Returns:	The enable_rlogin of this RloginUpdateDescriptor.
Return type:	bool
	required

interface_name¶

Gets the interface_name of this RloginUpdateDescriptor. Name of Ethernet port, as reported by bootWare.

Required/optional:
Returns:	The interface_name of this RloginUpdateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.rls_command_descriptor module¶

RLSCommandDescriptor.py

class netapp.santricity.models.symbol.rls_command_descriptor.RLSCommandDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channels¶

Gets the channels of this RLSCommandDescriptor. This field is present only if the command value is RLS_GET_CHANNELS. It contains detailed information about the channels.

Required/optional:
Returns:	The channels of this RLSCommandDescriptor.
Return type:	list[int]
	optional

command¶

Gets the command of this RLSCommandDescriptor. This enumeration defines the commands for Read Link Status.

Required/optional:
Returns:	The command of this RLSCommandDescriptor.
Return type:	str
	required

devices¶

Gets the devices of this RLSCommandDescriptor. This field is present only if the command value is RLS_GET_DEVICES. It contains detailed information about the devices.

Required/optional:
Returns:	The devices of this RLSCommandDescriptor.
Return type:	RLSDevices
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.rls_count module¶

RLSCount.py

class netapp.santricity.models.symbol.rls_count.RLSCount[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

invalid_crc_count¶

Gets the invalid_crc_count of this RLSCount. The number of invalid CRC failures.

Required/optional:
Returns:	The invalid_crc_count of this RLSCount.
Return type:	int
	required

invalid_xmit_word¶

Gets the invalid_xmit_word of this RLSCount. The number of invalid transmit word failures.

Required/optional:
Returns:	The invalid_xmit_word of this RLSCount.
Return type:	int
	required

link_failure_count¶

Gets the link_failure_count of this RLSCount. The number of link failures.

Required/optional:
Returns:	The link_failure_count of this RLSCount.
Return type:	int
	required

loss_of_signal_count¶

Gets the loss_of_signal_count of this RLSCount. The number of signal losses.

Required/optional:
Returns:	The loss_of_signal_count of this RLSCount.
Return type:	int
	required

loss_of_sync_count¶

Gets the loss_of_sync_count of this RLSCount. The number of synchronization losses.

Required/optional:
Returns:	The loss_of_sync_count of this RLSCount.
Return type:	int
	required

prim_seq_protocol_err¶

Gets the prim_seq_protocol_err of this RLSCount. The number of primary sequence protocol failures.

Required/optional:
Returns:	The prim_seq_protocol_err of this RLSCount.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.rls_data module¶

RLSData.py

class netapp.santricity.models.symbol.rls_data.RLSData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

baseline_time¶

Gets the baseline_time of this RLSData. The baseline time for this device, expressed as seconds since midnight GMT on January 1, 1970.

Required/optional:
Returns:	The baseline_time of this RLSData.
Return type:	int
	required

channel¶

Gets the channel of this RLSData. The channel the device is on.

Required/optional:
Returns:	The channel of this RLSData.
Return type:	int
	required

device¶

Gets the device of this RLSData. The SYMbol reference value that uniquely identifies this device.

Required/optional:
Returns:	The device of this RLSData.
Return type:	RLSDevice
	required

loop_map_index¶

Gets the loop_map_index of this RLSData. The position in the fibre loop map the device is located at.

Required/optional:
Returns:	The loop_map_index of this RLSData.
Return type:	int
	required

rls_count¶

Gets the rls_count of this RLSData. The RLS count for this device.

Required/optional:
Returns:	The rls_count of this RLSData.
Return type:	RLSCount
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

valid¶

Gets the valid of this RLSData. Set to true if the RSL Data is valid for the device.

Required/optional:
Returns:	The valid of this RLSData.
Return type:	bool
	required

netapp.santricity.models.symbol.rls_device module¶

RLSDevice.py

class netapp.santricity.models.symbol.rls_device.RLSDevice[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller¶

Gets the controller of this RLSDevice. This field is present only if the type value is RLS_CONTROLLER. It contains the detailed RLS data for the controller.

Required/optional:
Returns:	The controller of this RLSDevice.
Return type:	str
	optional

drive¶

Gets the drive of this RLSDevice. This field is present only if the type value is RLS_DRIVE. It contains the detailed RLS data for the drive.

Required/optional:
Returns:	The drive of this RLSDevice.
Return type:	str
	optional

esm¶

Gets the esm of this RLSDevice. This field is present only if the type value is RLS_ESM. It contains the detailed RLS data for the ESM.

Required/optional:
Returns:	The esm of this RLSDevice.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this RLSDevice. This enumeration object is used to specify the type of RLS device.

Required/optional:
Returns:	The type of this RLSDevice.
Return type:	str
	required

netapp.santricity.models.symbol.rls_devices module¶

RLSDevices.py

class netapp.santricity.models.symbol.rls_devices.RLSDevices[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controllers¶

Gets the controllers of this RLSDevices. The identifier value for the controllers.

Required/optional:
Returns:	The controllers of this RLSDevices.
Return type:	list[str]
	required

drives¶

Gets the drives of this RLSDevices. The identifier value for the drives.

Required/optional:
Returns:	The drives of this RLSDevices.
Return type:	list[str]
	required

esms¶

Gets the esms of this RLSDevices. The identifier value for the ESMs.

Required/optional:
Returns:	The esms of this RLSDevices.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.rls_results module¶

RLSResults.py

class netapp.santricity.models.symbol.rls_results.RLSResults[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controllers¶

Gets the controllers of this RLSResults. The RLS results for the controllers.

Required/optional:
Returns:	The controllers of this RLSResults.
Return type:	list[RLSData]
	required

drives¶

Gets the drives of this RLSResults. The RLS results for the drives.

Required/optional:
Returns:	The drives of this RLSResults.
Return type:	list[RLSData]
	required

esms¶

Gets the esms of this RLSResults. The RLS results for the ESMs.

Required/optional:
Returns:	The esms of this RLSResults.
Return type:	list[RLSData]
	required

overall_rls_time¶

Gets the overall_rls_time of this RLSResults. The time relative to the controllers that the getReadLinkStatus command was issued.

Required/optional:
Returns:	The overall_rls_time of this RLSResults.
Return type:	int
	required

return_code¶

Gets the return_code of this RLSResults. The return code from the getReadLinkStatus procedure.

Required/optional:
Returns:	The return_code of this RLSResults.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.rtr_attribute_data module¶

RTRAttributeData.py

class netapp.santricity.models.symbol.rtr_attribute_data.RTRAttributeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

has_ready_to_remove_indicator¶

Gets the has_ready_to_remove_indicator of this RTRAttributeData. True if the component has a ready-to-remove LED.

Required/optional:
Returns:	The has_ready_to_remove_indicator of this RTRAttributeData.
Return type:	bool
	required

ready_to_remove¶

Gets the ready_to_remove of this RTRAttributeData. True if the component is ready to remove.

Required/optional:
Returns:	The ready_to_remove of this RTRAttributeData.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.rtr_attributes module¶

RTRAttributes.py

class netapp.santricity.models.symbol.rtr_attributes.RTRAttributes[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cru_type¶

Gets the cru_type of this RTRAttributes. This enumeration identifies the type of CRU a component has.

Required/optional:
Returns:	The cru_type of this RTRAttributes.
Return type:	str
	required

parent_cru¶

Gets the parent_cru of this RTRAttributes. This field identifies the CRU that is the parent of this component, i.e., the CRU that it is sharing with other components. It is only present when the cruType field is set to CRU_TYPE_AGGREGATE.

Required/optional:
Returns:	The parent_cru of this RTRAttributes.
Return type:	ParentCru
	optional

rtr_attribute_data¶

Gets the rtr_attribute_data of this RTRAttributes. This field contains the actual settings for the ready-to-remove data. It is only present when the cruType field is set to CRU_TYPE_DEDICATED.

Required/optional:
Returns:	The rtr_attribute_data of this RTRAttributes.
Return type:	RTRAttributeData
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.rtr_object module¶

RTRObject.py

class netapp.santricity.models.symbol.rtr_object.RTRObject[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

alarm_ref¶

Gets the alarm_ref of this RTRObject. This field is present only if the RTRType is RTR_TYPE_ALARM.

Required/optional:
Returns:	The alarm_ref of this RTRObject.
Return type:	str
	optional

battery_ref¶

Gets the battery_ref of this RTRObject. This field is present only if rtrType is RTR_TYPE_BATTERY.

Required/optional:
Returns:	The battery_ref of this RTRObject.
Return type:	str
	optional

controller_ref¶

Gets the controller_ref of this RTRObject. This field is present only if rtrType is RTR_TYPE_CONTROLLER.

Required/optional:
Returns:	The controller_ref of this RTRObject.
Return type:	str
	optional

drawer_ref¶

Gets the drawer_ref of this RTRObject. This field is present only if rtrType is RTR_TYPE_DRAWER.

Required/optional:
Returns:	The drawer_ref of this RTRObject.
Return type:	str
	optional

drive_ref¶

Gets the drive_ref of this RTRObject. This field is present only if rtrType is RTR_TYPE_DRIVE.

Required/optional:
Returns:	The drive_ref of this RTRObject.
Return type:	str
	optional

esm_ref¶

Gets the esm_ref of this RTRObject. This field is present only if rtrType is RTR_TYPE_ESM.

Required/optional:
Returns:	The esm_ref of this RTRObject.
Return type:	str
	optional

fan_ref¶

Gets the fan_ref of this RTRObject. This field is present only if rtrType is RTR_TYPE_FAN.

Required/optional:
Returns:	The fan_ref of this RTRObject.
Return type:	str
	optional

interconnect_ref¶

Gets the interconnect_ref of this RTRObject. This field is present only if rtrType is RTR_TYPE_INTERCONNECT.

Required/optional:
Returns:	The interconnect_ref of this RTRObject.
Return type:	str
	optional

minihub_ref¶

Gets the minihub_ref of this RTRObject. This field is present only if rtrType is RTR_TYPE_MINIHUB.

Required/optional:
Returns:	The minihub_ref of this RTRObject.
Return type:	str
	optional

power_supply_ref¶

Gets the power_supply_ref of this RTRObject. This field is present only if rtrType is RTR_TYPE_POWER_SUPPLY.

Required/optional:
Returns:	The power_supply_ref of this RTRObject.
Return type:	str
	optional

rtr_type¶

Gets the rtr_type of this RTRObject. This enumeration is used to determine the type of a given component.

Required/optional:
Returns:	The rtr_type of this RTRObject.
Return type:	str
	required

support_cru_ref¶

Gets the support_cru_ref of this RTRObject. This field is present only if rtrType is RTR_TYPE_SUPPORT_CRU.

Required/optional:
Returns:	The support_cru_ref of this RTRObject.
Return type:	str
	optional

thermal_sensor_ref¶

Gets the thermal_sensor_ref of this RTRObject. This field is present only if the RTRType is RTR_TYPE_THERMAL_SENSOR.

Required/optional:
Returns:	The thermal_sensor_ref of this RTRObject.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.rtr_type_ref module¶

RTRTypeRef.py

class netapp.santricity.models.symbol.rtr_type_ref.RTRTypeRef[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

battery_ref¶

Gets the battery_ref of this RTRTypeRef. This field is present only if the RTRType is RTR_TYPE_BATTERY.

Required/optional:
Returns:	The battery_ref of this RTRTypeRef.
Return type:	str
	optional

controller_ref¶

Gets the controller_ref of this RTRTypeRef. This field is present only if the RTRType is RTR_TYPE_CONTROLLER.

Required/optional:
Returns:	The controller_ref of this RTRTypeRef.
Return type:	str
	optional

drive_ref¶

Gets the drive_ref of this RTRTypeRef. This field is present only if the RTRType is RTR_TYPE_DRIVE.

Required/optional:
Returns:	The drive_ref of this RTRTypeRef.
Return type:	str
	optional

esm_ref¶

Gets the esm_ref of this RTRTypeRef. This field is present only if the RTRType is RTR_TYPE_ESM.

Required/optional:
Returns:	The esm_ref of this RTRTypeRef.
Return type:	str
	optional

fan_ref¶

Gets the fan_ref of this RTRTypeRef. This field is present only if the RTRType is RTR_TYPE_FAN.

Required/optional:
Returns:	The fan_ref of this RTRTypeRef.
Return type:	str
	optional

interconnect_ref¶

Gets the interconnect_ref of this RTRTypeRef. This field is present only if the RTRType is RTR_TYPE_INTERCONNECT.

Required/optional:
Returns:	The interconnect_ref of this RTRTypeRef.
Return type:	str
	optional

minihub_ref¶

Gets the minihub_ref of this RTRTypeRef. This field is present only if the RTRType is RTR_TYPE_MINIHUB.

Required/optional:
Returns:	The minihub_ref of this RTRTypeRef.
Return type:	str
	optional

power_supply_ref¶

Gets the power_supply_ref of this RTRTypeRef. This field is present only if the RTRType is RTR_TYPE_POWER_SUPPLY.

Required/optional:
Returns:	The power_supply_ref of this RTRTypeRef.
Return type:	str
	optional

rtr_type¶

Gets the rtr_type of this RTRTypeRef. This enumeration is used to determine the type of a given component.

Required/optional:
Returns:	The rtr_type of this RTRTypeRef.
Return type:	str
	required

support_cru_ref¶

Gets the support_cru_ref of this RTRTypeRef. This field is present only if the RTRType is RTR_TYPE_SUPPORT_CRU.

Required/optional:
Returns:	The support_cru_ref of this RTRTypeRef.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.rtr_update_description module¶

RTRUpdateDescription.py

class netapp.santricity.models.symbol.rtr_update_description.RTRUpdateDescription[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

rtr_control¶

Gets the rtr_control of this RTRUpdateDescription. Indicates the ready-to-remove control to activate on the specified component (enable, disable, or put the indicator in automatic mode).

Required/optional:
Returns:	The rtr_control of this RTRUpdateDescription.
Return type:	str
	required

rtr_object¶

Gets the rtr_object of this RTRUpdateDescription. The reference that indicates the object to modify.

Required/optional:
Returns:	The rtr_object of this RTRUpdateDescription.
Return type:	RTRObject
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.rtr_update_descriptor module¶

RTRUpdateDescriptor.py

class netapp.santricity.models.symbol.rtr_update_descriptor.RTRUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

rtr_control¶

Gets the rtr_control of this RTRUpdateDescriptor. Indicates the ready-to-remove control to activate on the specified component (enable, disable, or put the indicator in automatic mode).

Required/optional:
Returns:	The rtr_control of this RTRUpdateDescriptor.
Return type:	str
	required

rtr_ref¶

Gets the rtr_ref of this RTRUpdateDescriptor. The reference that indicates the object to modify.

Required/optional:
Returns:	The rtr_ref of this RTRUpdateDescriptor.
Return type:	RTRTypeRef
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.runtime_diag_descriptor module¶

RuntimeDiagDescriptor.py

class netapp.santricity.models.symbol.runtime_diag_descriptor.RuntimeDiagDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this RuntimeDiagDescriptor. The channel to use for the loopback data test.

Required/optional:
Returns:	The channel of this RuntimeDiagDescriptor.
Return type:	int
	required

controller_ref¶

Gets the controller_ref of this RuntimeDiagDescriptor. The initiating (alternate) controller to the controller being tested. If the controller to be tested receives the request to run diagnostics, it will return a RETCODE_TRY_ALTERNATE error.

Required/optional:
Returns:	The controller_ref of this RuntimeDiagDescriptor.
Return type:	str
	required

pattern¶

Gets the pattern of this RuntimeDiagDescriptor. The loopback data test pattern.

Required/optional:
Returns:	The pattern of this RuntimeDiagDescriptor.
Return type:	str
	required

runtime_diag_test_id¶

Gets the runtime_diag_test_id of this RuntimeDiagDescriptor. The test or tests to run.

Required/optional:
Returns:	The runtime_diag_test_id of this RuntimeDiagDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

use_pattern¶

Gets the use_pattern of this RuntimeDiagDescriptor. TRUE, if pattern should be used on loopback data test.

Required/optional:
Returns:	The use_pattern of this RuntimeDiagDescriptor.
Return type:	bool
	required

netapp.santricity.models.symbol.runtime_diag_results module¶

RuntimeDiagResults.py

class netapp.santricity.models.symbol.runtime_diag_results.RuntimeDiagResults[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

extended_test_results¶

Gets the extended_test_results of this RuntimeDiagResults. A variable array of the test results.

Required/optional:
Returns:	The extended_test_results of this RuntimeDiagResults.
Return type:	list[RuntimeDiagTestResults]
	required

return_code¶

Gets the return_code of this RuntimeDiagResults. General returnCode - RETCODE_OK if diagnostics were initiated.

Required/optional:
Returns:	The return_code of this RuntimeDiagResults.
Return type:	str
	required

status_code¶

Gets the status_code of this RuntimeDiagResults. Additional returnCode - overall status of diagnostic tests.

Required/optional:
Returns:	The status_code of this RuntimeDiagResults.
Return type:	str
	required

test_results¶

Gets the test_results of this RuntimeDiagResults. An array of the test results.

Required/optional:
Returns:	The test_results of this RuntimeDiagResults.
Return type:	list[RuntimeDiagTestResults]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.runtime_diag_test_results module¶

RuntimeDiagTestResults.py

class netapp.santricity.models.symbol.runtime_diag_test_results.RuntimeDiagTestResults[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this RuntimeDiagTestResults. Identifies the channel the test was run on.

Required/optional:
Returns:	The channel of this RuntimeDiagTestResults.
Return type:	int
	required

test_id¶

Gets the test_id of this RuntimeDiagTestResults. Identifies the test the results are for.

Required/optional:
Returns:	The test_id of this RuntimeDiagTestResults.
Return type:	str
	required

test_level¶

Gets the test_level of this RuntimeDiagTestResults. Identifies the level of the test run.

Required/optional:
Returns:	The test_level of this RuntimeDiagTestResults.
Return type:	str
	required

test_status¶

Gets the test_status of this RuntimeDiagTestResults. Identifies the status of the test.

Required/optional:
Returns:	The test_status of this RuntimeDiagTestResults.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sa_cache module¶

SACache.py

class netapp.santricity.models.symbol.sa_cache.SACache[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cache_blk_size¶

Gets the cache_blk_size of this SACache. The characteristic size, in bytes, of a cache block.

Required/optional:
Returns:	The cache_blk_size of this SACache.
Return type:	int
	required

demand_flush_amount¶

Gets the demand_flush_amount of this SACache. Specifies the amount of cache data that will be flushed to disk when a cache flush operation is initiated. This value is specified as an integer in the range 0-100 that represents the percentage of the controller’s write cache data that can remain in the “dirty”, or unflushed state. When demand flush operations are started, data will be flushed from cache to disk until the overall amount of dirty data drops to or below the percentage specified by this value.

Required/optional:
Returns:	The demand_flush_amount of this SACache.
Return type:	int
	required

demand_flush_threshold¶

Gets the demand_flush_threshold of this SACache. Specifies the “level of fullness” of “dirty” data in the controller’s write cache which, when reached, will cause the controller to begin flushing data from cache to disk. This value is specified as a percentage, in the range 0-100, of the overall write cache capacity of the controller. After flushing begins, it will continue until enough data has been flushed to drop the percentage of dirty data to or below the value specified in the demandFlushAmount parameter described above.

Required/optional:
Returns:	The demand_flush_threshold of this SACache.
Return type:	int
	required

reserved1¶

Gets the reserved1 of this SACache.

Required/optional:
Returns:	The reserved1 of this SACache.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this SACache.

Required/optional:
Returns:	The reserved2 of this SACache.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sa_cache_params_update_descriptor module¶

SACacheParamsUpdateDescriptor.py

class netapp.santricity.models.symbol.sa_cache_params_update_descriptor.SACacheParamsUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cache_blk_size¶

Gets the cache_blk_size of this SACacheParamsUpdateDescriptor. The size (in bytes) used for each entry in the controller’s data cache. If volumes already exist in the array, the new cache block size must smaller than the smallest segment size currently defined for any volume. Furthermore, only two block sizes are currently supported: 4KB and 16KB.

Required/optional:
Returns:	The cache_blk_size of this SACacheParamsUpdateDescriptor.
Return type:	int
	required

demand_flush_amount¶

Gets the demand_flush_amount of this SACacheParamsUpdateDescriptor. Specifies the amount of cache data that will be flushed to disk when a cache flush operation is initiated. This value is specified as an integer in the range 0-100 that represents the percentage of the controller’s write cache data that can remain in the “dirty”, or unflushed state. When demand flush operations are started, data will be flushed from cache to disk until the overall amount of dirty data drops to or below the percentage specified by this value.

Required/optional:
Returns:	The demand_flush_amount of this SACacheParamsUpdateDescriptor.
Return type:	int
	required

demand_flush_threshold¶

Gets the demand_flush_threshold of this SACacheParamsUpdateDescriptor. Specifies the “level of fullness” of “dirty” data in the controller’s write cache which, when reached, will cause the controller to begin flushing data from cache to disk. This value is specified as a percentage, in the range 0-100, of the overall write cache capacity of the controller. After flushing begins, it will continue until enough data has been flushed to drop the percentage of dirty data to or below the value specified in the demandFlushAmount parameter described above.

Required/optional:
Returns:	The demand_flush_threshold of this SACacheParamsUpdateDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sa_data module¶

SAData.py

class netapp.santricity.models.symbol.sa_data.SAData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

app_version¶

Gets the app_version of this SAData. The version identifier of the “application” component of the currently-installed array firmware.

Required/optional:
Returns:	The app_version of this SAData.
Return type:	str
	required

array_attributes¶

Gets the array_attributes of this SAData. SAAttributeID attribute-value pairs.

Required/optional:
Returns:	The array_attributes of this SAData.
Return type:	list[int]
	required

boot_time¶

Gets the boot_time of this SAData. The timestamp value for the time at which the responding controller last booted. Note that this value may differ between the individual controllers of a storage array. This value is defined in terms of the number of seconds since midnight GMT on January 1, 1970.

Required/optional:
Returns:	The boot_time of this SAData.
Return type:	int
	required

boot_version¶

Gets the boot_version of this SAData. The version identifier of the “boot” component of the currently-installed array firmware.

Required/optional:
Returns:	The boot_version of this SAData.
Return type:	str
	required

chassis_serial_number¶

Gets the chassis_serial_number of this SAData. An ASCII string that describes the chassis serial number.

Required/optional:
Returns:	The chassis_serial_number of this SAData.
Return type:	str
	required

event_configuration_data_version¶

Gets the event_configuration_data_version of this SAData. An ASCII string that identifies the version of the MEL event configuration data. This is used for the event logging enhancements in Chessie 2.

Required/optional:
Returns:	The event_configuration_data_version of this SAData.
Return type:	str
	required

extended_sa_data¶

Gets the extended_sa_data of this SAData. This element allows additional content to be added to SAData with actually adding any new elements to the struct. The element replaces a reserved field that was of variable length.

Required/optional:
Returns:	The extended_sa_data of this SAData.
Return type:	ExtendedSAData
	required

fixing¶

Gets the fixing of this SAData. An indication of whether the array is in the process of recovering from a Needs Attention condition. A value of true indicates that no physical components are currently marked failed, but that some residual recovery activity (such as reconstruction, copyback, etc.) is still in progress.

Required/optional:
Returns:	The fixing of this SAData.
Return type:	bool
	required

fw_prefix¶

Gets the fw_prefix of this SAData. An ASCII string that describes the firmware prefix.

Required/optional:
Returns:	The fw_prefix of this SAData.
Return type:	str
	required

fw_version¶

Gets the fw_version of this SAData. The version identifier of the currently-installed array firmware.

Required/optional:
Returns:	The fw_version of this SAData.
Return type:	str
	required

management_class_name¶

Gets the management_class_name of this SAData. The name of the application-level entity required to manage configuration operations for the storage array.

Required/optional:
Returns:	The management_class_name of this SAData.
Return type:	str
	required

needs_attention¶

Gets the needs_attention of this SAData. An indication of whether the array needs attention. A value of true is returned if there are any components that have been marked failed for any reason. Otherwise, if all components are operating properly, a value of false is returned.

Required/optional:
Returns:	The needs_attention of this SAData.
Return type:	bool
	required

nvsram_version¶

Gets the nvsram_version of this SAData. An ASCII string that describes the currently-installed NVSRAM contents.

Required/optional:
Returns:	The nvsram_version of this SAData.
Return type:	str
	required

res4¶

Gets the res4 of this SAData.

Required/optional:
Returns:	The res4 of this SAData.
Return type:	list[int]
	optional

res5¶

Gets the res5 of this SAData.

Required/optional:
Returns:	The res5 of this SAData.
Return type:	list[int]
	optional

res6¶

Gets the res6 of this SAData.

Required/optional:
Returns:	The res6 of this SAData.
Return type:	list[int]
	optional

res7¶

Gets the res7 of this SAData.

Required/optional:
Returns:	The res7 of this SAData.
Return type:	str
	optional

sa_id¶

Gets the sa_id of this SAData. The globally-unique identifier value for this storage array.

Required/optional:
Returns:	The sa_id of this SAData.
Return type:	SAIdentifier
	required

storage_array_label¶

Gets the storage_array_label of this SAData. The user-assigned label for the storage array.

Required/optional:
Returns:	The storage_array_label of this SAData.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sa_identifier module¶

SAIdentifier.py

class netapp.santricity.models.symbol.sa_identifier.SAIdentifier[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

world_wide_name¶

Gets the world_wide_name of this SAIdentifier. A variable-length, opaque byte array whose value is guaranteed to be globally unique, and thus serves as the unique identifier for the storage array. No assumptions may be made outside the controller firmware environment about the meaning of the various bytes within this array. The only operation that a SYMbol client is allowed to perform on this field is a comparison for equality with the same field of a different storage array object.

Required/optional:
Returns:	The world_wide_name of this SAIdentifier.
Return type:	str
	required

netapp.santricity.models.symbol.sa_port module¶

SAPort.py

class netapp.santricity.models.symbol.sa_port.SAPort[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_ref¶

Gets the controller_ref of this SAPort. The reference value of the controller.

Required/optional:
Returns:	The controller_ref of this SAPort.
Return type:	str
	required

port_id¶

Gets the port_id of this SAPort. The host-side I/O port identifier of the port on the controller.

Required/optional:
Returns:	The port_id of this SAPort.
Return type:	int
	required

sa_port_group_ref¶

Gets the sa_port_group_ref of this SAPort. This object uniquely identifies an SAPortGroup.

Required/optional:
Returns:	The sa_port_group_ref of this SAPort.
Return type:	str
	required

sa_port_ref¶

Gets the sa_port_ref of this SAPort. This object uniquely identifies an SAPort.

Required/optional:
Returns:	The sa_port_ref of this SAPort.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sa_port_get_descriptor module¶

SAPortGetDescriptor.py

class netapp.santricity.models.symbol.sa_port_get_descriptor.SAPortGetDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_ref¶

Gets the controller_ref of this SAPortGetDescriptor. The reference value of the controller whose port identifier is needed.

Required/optional:
Returns:	The controller_ref of this SAPortGetDescriptor.
Return type:	str
	required

port_id¶

Gets the port_id of this SAPortGetDescriptor. The host-side I/O port identifier of the port on the controller.

Required/optional:
Returns:	The port_id of this SAPortGetDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sa_port_group module¶

SAPortGroup.py

class netapp.santricity.models.symbol.sa_port_group.SAPortGroup[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

label¶

Gets the label of this SAPortGroup. The user assigned label for the SAPortGroup.

Required/optional:
Returns:	The label of this SAPortGroup.
Return type:	str
	required

sa_port_group_ref¶

Gets the sa_port_group_ref of this SAPortGroup. This object uniquely identifies a specific SAPortGroup.

Required/optional:
Returns:	The sa_port_group_ref of this SAPortGroup.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sa_view_password_digest module¶

SAViewPasswordDigest.py

class netapp.santricity.models.symbol.sa_view_password_digest.SAViewPasswordDigest[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

digest¶

Gets the digest of this SAViewPasswordDigest. SHA-1 message digest value of the salt and view array password.

Required/optional:
Returns:	The digest of this SAViewPasswordDigest.
Return type:	str
	required

salt¶

Gets the salt of this SAViewPasswordDigest. Salt value used to mix with the view array password for generating the digest.

Required/optional:
Returns:	The salt of this SAViewPasswordDigest.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sa_view_password_digest_returned module¶

SAViewPasswordDigestReturned.py

class netapp.santricity.models.symbol.sa_view_password_digest_returned.SAViewPasswordDigestReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

return_code¶

Gets the return_code of this SAViewPasswordDigestReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this SAViewPasswordDigestReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

view_password_digest¶

Gets the view_password_digest of this SAViewPasswordDigestReturned. This field is returned if the value of returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The view_password_digest of this SAViewPasswordDigestReturned.
Return type:	SAViewPasswordDigest
	optional

netapp.santricity.models.symbol.sas_attached_device module¶

SasAttachedDevice.py

class netapp.santricity.models.symbol.sas_attached_device.SasAttachedDevice[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this SasAttachedDevice. The number of the channel where the SAS-attached device is located.

Required/optional:
Returns:	The channel of this SasAttachedDevice.
Return type:	int
	required

channel_type¶

Gets the channel_type of this SasAttachedDevice. An indication of which “side” the channel is on - host or drive.

Required/optional:
Returns:	The channel_type of this SasAttachedDevice.
Return type:	str
	required

sas_attached_device_data¶

Gets the sas_attached_device_data of this SasAttachedDevice. This field contains information that explicitly identifies the SAS-attached device.

Required/optional:
Returns:	The sas_attached_device_data of this SasAttachedDevice.
Return type:	SasAttachedDeviceTypeData
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sas_attached_device_type_data module¶

SasAttachedDeviceTypeData.py

class netapp.santricity.models.symbol.sas_attached_device_type_data.SasAttachedDeviceTypeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

alternate_controller¶

Gets the alternate_controller of this SasAttachedDeviceTypeData. A reference to the alternate controller that is the attached device. This field is only present if type equals SAS_ATTACHED_DEV_ALTERNATE_CONTROLLER.

Required/optional:
Returns:	The alternate_controller of this SasAttachedDeviceTypeData.
Return type:	str
	optional

drive¶

Gets the drive of this SasAttachedDeviceTypeData. A reference to a drive that is the attached device. This field is only present if type equals SAS_ATTACHED_DEV_DRIVE.

Required/optional:
Returns:	The drive of this SasAttachedDeviceTypeData.
Return type:	str
	optional

expander¶

Gets the expander of this SasAttachedDeviceTypeData. A reference to the SAS expander that is the attached device. This field is only present if type equals SAS_ATTACHED_DEV_EXPANDER.

Required/optional:
Returns:	The expander of this SasAttachedDeviceTypeData.
Return type:	str
	optional

local_controller¶

Gets the local_controller of this SasAttachedDeviceTypeData. A reference to the local controller that is the attached device. This field is only present if type equals SAS_ATTACHED_DEV_LOCAL_CONTROLLER.

Required/optional:
Returns:	The local_controller of this SasAttachedDeviceTypeData.
Return type:	str
	optional

physical_location¶

Gets the physical_location of this SasAttachedDeviceTypeData. The tray-slot location of a device of unknown type. This field is only present if type equals SAS_ATTACHED_DEV_UNKNOWN.

Required/optional:
Returns:	The physical_location of this SasAttachedDeviceTypeData.
Return type:	Location
	optional

remote_host_port_address¶

Gets the remote_host_port_address of this SasAttachedDeviceTypeData. The SAS address of the port in the host computer that is the attached device. This field is only present if type equals SAS_ATTACHED_DEV_HOST.

Required/optional:
Returns:	The remote_host_port_address of this SasAttachedDeviceTypeData.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this SasAttachedDeviceTypeData. This enumeration specifies the different kinds of devices that may be attached to a SAS port.

Required/optional:
Returns:	The type of this SasAttachedDeviceTypeData.
Return type:	str
	required

netapp.santricity.models.symbol.sas_data module¶

SasData.py

class netapp.santricity.models.symbol.sas_data.SasData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

port_data¶

Gets the port_data of this SasData. An array of SAS port data, one element per port on the port provider device.

Required/optional:
Returns:	The port_data of this SasData.
Return type:	list[SasPortData]
	required

port_provider¶

Gets the port_provider of this SasData. An indication of which SAS device provides the ports for which the reported statistics apply.

Required/optional:
Returns:	The port_provider of this SasData.
Return type:	SasPortProviderDevice
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sas_drive_address module¶

SasDriveAddress.py

class netapp.santricity.models.symbol.sas_drive_address.SasDriveAddress[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

device_name¶

Gets the device_name of this SasDriveAddress. The SAS address representing the device itself.

Required/optional:
Returns:	The device_name of this SasDriveAddress.
Return type:	str
	required

drive_port_addresses¶

Gets the drive_port_addresses of this SasDriveAddress. The SAS addresses of drive ports 0 and 1. The first element in the array is the drive address on the preferred channel, and the second element is the drive address on the redundant channel.

Required/optional:
Returns:	The drive_port_addresses of this SasDriveAddress.
Return type:	list[SasDrivePortAddress]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sas_drive_port_address module¶

SasDrivePortAddress.py

class netapp.santricity.models.symbol.sas_drive_port_address.SasDrivePortAddress[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this SasDrivePortAddress. The number of the channel where the drive port is located.

Required/optional:
Returns:	The channel of this SasDrivePortAddress.
Return type:	int
	required

port_identifier¶

Gets the port_identifier of this SasDrivePortAddress. The SAS address of the drive port.

Required/optional:
Returns:	The port_identifier of this SasDrivePortAddress.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sas_esm_attributes module¶

SasEsmAttributes.py

class netapp.santricity.models.symbol.sas_esm_attributes.SasEsmAttributes[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

sas_expander¶

Gets the sas_expander of this SasEsmAttributes. This field is a collection of references to objects representing the SAS expanders that physically reside on the ESM.

Required/optional:
Returns:	The sas_expander of this SasEsmAttributes.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sas_expander module¶

SasExpander.py

class netapp.santricity.models.symbol.sas_expander.SasExpander[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this SasExpander. The drive channel location of the expander

Required/optional:
Returns:	The channel of this SasExpander.
Return type:	int
	required

device_name¶

Gets the device_name of this SasExpander. The SAS address that is the expander device name

Required/optional:
Returns:	The device_name of this SasExpander.
Return type:	str
	required

domain_number¶

Gets the domain_number of this SasExpander. The domain number identifies which SAS domain this element is a part of. Domain numbers are arbitrarily assigned by the firmware and are consistent on a per controller basis – but not across controllers. So, the contents of domains will be consistent across controllers but the number identifying a particular domain may not be.

Required/optional:
Returns:	The domain_number of this SasExpander.
Return type:	int
	required

expander_ports¶

Gets the expander_ports of this SasExpander. List of ports that are part of this expander.

Required/optional:
Returns:	The expander_ports of this SasExpander.
Return type:	list[SasPort]
	required

expander_ref¶

Gets the expander_ref of this SasExpander. The reference value that uniquely identifies the SAS expander.

Required/optional:
Returns:	The expander_ref of this SasExpander.
Return type:	str
	required

fw_version¶

Gets the fw_version of this SasExpander. The version of the firmware on the SAS expander.

Required/optional:
Returns:	The fw_version of this SasExpander.
Return type:	str
	required

id¶

Gets the id of this SasExpander.

Required/optional:
Returns:	The id of this SasExpander.
Return type:	str
	optional

parent¶

Gets the parent of this SasExpander. The reference value that uniquely identifies the parent (controller or ESM) of the SAS expander.

Required/optional:
Returns:	The parent of this SasExpander.
Return type:	SasExpanderParent
	required

product_id¶

Gets the product_id of this SasExpander. The Inquiry product identification string for the SAS expander.

Required/optional:
Returns:	The product_id of this SasExpander.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

vendor_id¶

Gets the vendor_id of this SasExpander. The Inquiry vendor identification string for the SAS expander.

Required/optional:
Returns:	The vendor_id of this SasExpander.
Return type:	str
	required

netapp.santricity.models.symbol.sas_expander_parent module¶

SasExpanderParent.py

class netapp.santricity.models.symbol.sas_expander_parent.SasExpanderParent[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

expander_parent_type¶

Gets the expander_parent_type of this SasExpanderParent. This enumeration specifies the different types of parent elements a SAS expander may have.

Required/optional:
Returns:	The expander_parent_type of this SasExpanderParent.
Return type:	str
	required

parent_controller¶

Gets the parent_controller of this SasExpanderParent. A reference to the parent controller of the SAS expander. This field is present only if the expanderParentType value is SAS_EXPANDER_PARENT_CONTROLLER.

Required/optional:
Returns:	The parent_controller of this SasExpanderParent.
Return type:	str
	optional

parent_drawer¶

Gets the parent_drawer of this SasExpanderParent. A reference to the parent drawer of the SAS expander. This field is present only if the expanderParentType value is SAS_EXPANDER_PARENT_DRAWER.

Required/optional:
Returns:	The parent_drawer of this SasExpanderParent.
Return type:	str
	optional

parent_esm¶

Gets the parent_esm of this SasExpanderParent. A reference to the parent ESM of the SAS expander. This field is present only if the expanderParentType value is SAS_EXPANDER_PARENT_ESM.

Required/optional:
Returns:	The parent_esm of this SasExpanderParent.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sas_interface module¶

SasInterface.py

class netapp.santricity.models.symbol.sas_interface.SasInterface[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

bidirectional_max_rate¶

Gets the bidirectional_max_rate of this SasInterface. Maximum bi-directional data rate in B/s

Required/optional:
Returns:	The bidirectional_max_rate of this SasInterface.
Return type:	int
	required

channel¶

Gets the channel of this SasInterface. The number of the channel corresponding to this interface.

Required/optional:
Returns:	The channel of this SasInterface.
Return type:	int
	required

current_interface_speed¶

Gets the current_interface_speed of this SasInterface. The current interface speed of the SAS interface.

Required/optional:
Returns:	The current_interface_speed of this SasInterface.
Return type:	str
	required

id¶

Gets the id of this SasInterface.

Required/optional:
Returns:	The id of this SasInterface.
Return type:	str
	optional

interface_ref¶

Gets the interface_ref of this SasInterface. The unique identifier for a given instance of this structure.

Required/optional:
Returns:	The interface_ref of this SasInterface.
Return type:	str
	required

ioc_port¶

Gets the ioc_port of this SasInterface. Information about the SAS I/O controller port corresponding to this interface.

Required/optional:
Returns:	The ioc_port of this SasInterface.
Return type:	SasPort
	required

is_degraded¶

Gets the is_degraded of this SasInterface. True if the channel corresponding to this interface is degraded.

Required/optional:
Returns:	The is_degraded of this SasInterface.
Return type:	bool
	required

maximum_interface_speed¶

Gets the maximum_interface_speed of this SasInterface. The maximum interface speed of the SAS interface.

Required/optional:
Returns:	The maximum_interface_speed of this SasInterface.
Return type:	str
	required

one_way_max_rate¶

Gets the one_way_max_rate of this SasInterface. Maximum one way data rate in B/s

Required/optional:
Returns:	The one_way_max_rate of this SasInterface.
Return type:	int
	required

part¶

Gets the part of this SasInterface. A string indicating the chip type.

Required/optional:
Returns:	The part of this SasInterface.
Return type:	str
	required

physical_location¶

Gets the physical_location of this SasInterface. The physical location of the SAS interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying “1st SAS interface relative to the parent,” “2nd SAS interface relative to the parent,” etc. This “interface number” is independent of the interface’s channel association.

Required/optional:
Returns:	The physical_location of this SasInterface.
Return type:	Location
	required

protection_information_capable¶

Gets the protection_information_capable of this SasInterface. This field indicates whether or not the I/O interface is PI capable.

Required/optional:
Returns:	The protection_information_capable of this SasInterface.
Return type:	bool
	required

revision¶

Gets the revision of this SasInterface. The revision level of the firmware on the SAS I/O controller.

Required/optional:
Returns:	The revision of this SasInterface.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sas_phy module¶

SasPhy.py

class netapp.santricity.models.symbol.sas_phy.SasPhy[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

is_operational¶

Gets the is_operational of this SasPhy. True if the PHY is capable of normal operation.

Required/optional:
Returns:	The is_operational of this SasPhy.
Return type:	bool
	required

phy_identifier¶

Gets the phy_identifier of this SasPhy. A number in the range 0-127 that is the PHY identifier.

Required/optional:
Returns:	The phy_identifier of this SasPhy.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sas_phy_data module¶

SasPhyData.py

class netapp.santricity.models.symbol.sas_phy_data.SasPhyData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

current_speed¶

Gets the current_speed of this SasPhyData. The current negotiated physical link rate for the PHY.

Required/optional:
Returns:	The current_speed of this SasPhyData.
Return type:	str
	required

error_counts¶

Gets the error_counts of this SasPhyData. A collection of PHY error count values.

Required/optional:
Returns:	The error_counts of this SasPhyData.
Return type:	SasPhyErrorCounts
	required

is_valid¶

Gets the is_valid of this SasPhyData. When false, an indication that, though the associated attached device exists, the rest of the data in the structure could not be obtained.

Required/optional:
Returns:	The is_valid of this SasPhyData.
Return type:	bool
	required

maximum_speed¶

Gets the maximum_speed of this SasPhyData. The hardware maximum physical link rate for the PHY.

Required/optional:
Returns:	The maximum_speed of this SasPhyData.
Return type:	str
	required

phy_identifier¶

Gets the phy_identifier of this SasPhyData. A number in the range 0 - 127 that is the PHY identifier.

Required/optional:
Returns:	The phy_identifier of this SasPhyData.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sas_phy_error_counts module¶

SasPhyErrorCounts.py

class netapp.santricity.models.symbol.sas_phy_error_counts.SasPhyErrorCounts[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

invalid_dword_count¶

Gets the invalid_dword_count of this SasPhyErrorCounts. The number of invalid dwords that have been received outside of PHY reset sequences.

Required/optional:
Returns:	The invalid_dword_count of this SasPhyErrorCounts.
Return type:	int
	required

loss_of_dword_sync_count¶

Gets the loss_of_dword_sync_count of this SasPhyErrorCounts. The number of times the PHY has restarted the link reset sequence because it lost dword synchronization.

Required/optional:
Returns:	The loss_of_dword_sync_count of this SasPhyErrorCounts.
Return type:	int
	required

reset_problem_count¶

Gets the reset_problem_count of this SasPhyErrorCounts. The number of times the PHY did not receive dword synchronization during the final SAS speed negotiation window.

Required/optional:
Returns:	The reset_problem_count of this SasPhyErrorCounts.
Return type:	int
	required

running_disparity_error_count¶

Gets the running_disparity_error_count of this SasPhyErrorCounts. The number of dwords containing running disparity errors that have been received outside of PHY reset sequences.

Required/optional:
Returns:	The running_disparity_error_count of this SasPhyErrorCounts.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sas_port module¶

SasPort.py

class netapp.santricity.models.symbol.sas_port.SasPort[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

attached_channel_port_ref¶

Gets the attached_channel_port_ref of this SasPort. This ref identifies the connector on the attached device for a drive channel who’s external port is connected to another device.

Required/optional:
Returns:	The attached_channel_port_ref of this SasPort.
Return type:	str
	required

attached_device¶

Gets the attached_device of this SasPort. An indication of what device is attached to this port.

Required/optional:
Returns:	The attached_device of this SasPort.
Return type:	SasAttachedDevice
	required

channel_port_ref¶

Gets the channel_port_ref of this SasPort. A reference to the channel port object identifying the external connector associated with this port. If the port is not associated with an external connector, then this field is set to a null SYMbol ref.

Required/optional:
Returns:	The channel_port_ref of this SasPort.
Return type:	str
	required

discovery_status¶

Gets the discovery_status of this SasPort. This element contains the status of the SAS discovery - the status is a bit field and could indicate a successful discovery or could indicate one or more failure conditions (indicated by one or more error flags being set).

Required/optional:
Returns:	The discovery_status of this SasPort.
Return type:	int
	required

domain_number¶

Gets the domain_number of this SasPort. The domain number identifies which SAS domain this element is a part of. Domain numbers are arbitrarily assigned by the firmware and are consistent on a per controller basis – but not across controllers. So, the contents of domains will be consistent across controllers but the number identifying a particular domain may not be.

Required/optional:
Returns:	The domain_number of this SasPort.
Return type:	int
	required

miswire_type¶

Gets the miswire_type of this SasPort. The type of miswire involving this port (or “none”).

Required/optional:
Returns:	The miswire_type of this SasPort.
Return type:	str
	required

parent¶

Gets the parent of this SasPort. The device on which the port resides.

Required/optional:
Returns:	The parent of this SasPort.
Return type:	SasPortProviderDevice
	required

port_mode¶

Gets the port_mode of this SasPort. The SAS port connection mode.

Required/optional:
Returns:	The port_mode of this SasPort.
Return type:	str
	required

port_type_data¶

Gets the port_type_data of this SasPort. Information about a SAS port that is type-dependent.

Required/optional:
Returns:	The port_type_data of this SasPort.
Return type:	SasPortTypeData
	required

sas_phys¶

Gets the sas_phys of this SasPort. A list of PHYs associated with this port.

Required/optional:
Returns:	The sas_phys of this SasPort.
Return type:	list[SasPhy]
	required

state¶

Gets the state of this SasPort. The state of the SAS port.

Required/optional:
Returns:	The state of this SasPort.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sas_port_data module¶

SasPortData.py

class netapp.santricity.models.symbol.sas_port_data.SasPortData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

attached_device¶

Gets the attached_device of this SasPortData. An indication of what device is attached to this port.

Required/optional:
Returns:	The attached_device of this SasPortData.
Return type:	SasAttachedDevice
	required

sas_phy_data¶

Gets the sas_phy_data of this SasPortData. An array of SAS PHY data elements, one per PHY comprising the port.

Required/optional:
Returns:	The sas_phy_data of this SasPortData.
Return type:	list[SasPhyData]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sas_port_provider_device module¶

SasPortProviderDevice.py

class netapp.santricity.models.symbol.sas_port_provider_device.SasPortProviderDevice[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller¶

Gets the controller of this SasPortProviderDevice. A reference to a controller that is the port provider. This field is present only if the type field is equal to SAS_PORT_PROVIDER_CONTROLLER.

Required/optional:
Returns:	The controller of this SasPortProviderDevice.
Return type:	str
	optional

drive¶

Gets the drive of this SasPortProviderDevice. A reference to a drive that is the port provider. This field is present only if the type field is equal to SAS_PORT_PROVIDER_DRIVE.

Required/optional:
Returns:	The drive of this SasPortProviderDevice.
Return type:	str
	optional

expander¶

Gets the expander of this SasPortProviderDevice. A reference to a SAS expander that is the port provider. This field is present only if the type field is equal to SAS_PORT_PROVIDER_EXPANDER.

Required/optional:
Returns:	The expander of this SasPortProviderDevice.
Return type:	str
	optional

host_board_ref¶

Gets the host_board_ref of this SasPortProviderDevice. A reference to a SAS host board that is the port provider. This field is present only if the type field is equal to SAS_PORT_PROVIDER_HOSTBOARD.

Required/optional:
Returns:	The host_board_ref of this SasPortProviderDevice.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this SasPortProviderDevice. This enumeration object is used to identify the specific type of “port provider” device.

Required/optional:
Returns:	The type of this SasPortProviderDevice.
Return type:	str
	required

netapp.santricity.models.symbol.sas_port_type_data module¶

SasPortTypeData.py

class netapp.santricity.models.symbol.sas_port_type_data.SasPortTypeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

port_identifier¶

Gets the port_identifier of this SasPortTypeData. This field is the SAS address that is the port identifier. It is present only if the portType value is equal to SAS_PORT_TYPE_END_DEVICE.

Required/optional:
Returns:	The port_identifier of this SasPortTypeData.
Return type:	str
	optional

port_type¶

Gets the port_type of this SasPortTypeData. This enumeration specifies the different types of SAS ports.

Required/optional:
Returns:	The port_type of this SasPortTypeData.
Return type:	str
	required

routing_type¶

Gets the routing_type of this SasPortTypeData. This field indicates the routing method used on this port. It is present only if the portType value is equal to SAS_PORT_TYPE_EXPANDER.

Required/optional:
Returns:	The routing_type of this SasPortTypeData.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sas_statistics module¶

SasStatistics.py

class netapp.santricity.models.symbol.sas_statistics.SasStatistics[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

collection_elapsed_time¶

Gets the collection_elapsed_time of this SasStatistics. The length of the time interval, in seconds, during which the SAS statistics were collected.

Required/optional:
Returns:	The collection_elapsed_time of this SasStatistics.
Return type:	int
	required

sas_data¶

Gets the sas_data of this SasStatistics. An array of SasData structures, one element per SAS device reported by the procedure.

Required/optional:
Returns:	The sas_data of this SasStatistics.
Return type:	list[SasData]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sas_statistics_returned module¶

SasStatisticsReturned.py

class netapp.santricity.models.symbol.sas_statistics_returned.SasStatisticsReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

return_code¶

Gets the return_code of this SasStatisticsReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this SasStatisticsReturned.
Return type:	str
	required

sas_statistics¶

Gets the sas_statistics of this SasStatisticsReturned. This field contains the SAS statistics. It is only valid if the returnCode field is equal to RETCODE_OK.

Required/optional:
Returns:	The sas_statistics of this SasStatisticsReturned.
Return type:	SasStatistics
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sata_drive_attributes module¶

SataDriveAttributes.py

class netapp.santricity.models.symbol.sata_drive_attributes.SataDriveAttributes[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ata_disk_fw_revision¶

Gets the ata_disk_fw_revision of this SataDriveAttributes. This field is the disk firmware revision number as reported in the ATA protocol.

Required/optional:
Returns:	The ata_disk_fw_revision of this SataDriveAttributes.
Return type:	str
	required

ata_disk_model_number¶

Gets the ata_disk_model_number of this SataDriveAttributes. This field is the disk model number as reported in the ATA protocol.

Required/optional:
Returns:	The ata_disk_model_number of this SataDriveAttributes.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

translator_data¶

Gets the translator_data of this SataDriveAttributes. This field provides information about the SCSI-to-ATA translator hardware.

Required/optional:
Returns:	The translator_data of this SataDriveAttributes.
Return type:	ScsiToAtaTranslatorData
	required

netapp.santricity.models.symbol.sata_interface module¶

SATAInterface.py

class netapp.santricity.models.symbol.sata_interface.SATAInterface[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this SATAInterface. The channel number of this channel

Required/optional:
Returns:	The channel of this SATAInterface.
Return type:	int
	required

current_interface_speed¶

Gets the current_interface_speed of this SATAInterface. The current interface speed of the SATA interface.

Required/optional:
Returns:	The current_interface_speed of this SATAInterface.
Return type:	str
	required

id¶

Gets the id of this SATAInterface.

Required/optional:
Returns:	The id of this SATAInterface.
Return type:	str
	optional

interface_ref¶

Gets the interface_ref of this SATAInterface. The unique identifier for a given instance of this structure.

Required/optional:
Returns:	The interface_ref of this SATAInterface.
Return type:	str
	required

maximum_interface_speed¶

Gets the maximum_interface_speed of this SATAInterface. The maximum interface speed of the SATA interface.

Required/optional:
Returns:	The maximum_interface_speed of this SATAInterface.
Return type:	str
	required

part¶

Gets the part of this SATAInterface. A string indicating the chip type.

Required/optional:
Returns:	The part of this SATAInterface.
Return type:	str
	required

physical_location¶

Gets the physical_location of this SATAInterface. The physical location of the SATA interface. The parent reference in Location identifies the physical component (e.g., controller or host card) where the interface circuitry is located, and the position field is a firmware-assigned 1-relative number signifying “1st SATA interface relative to the parent,” “2nd SATA interface relative to the parent,” etc. This “interface number” is independent of the interface’s channel association.

Required/optional:
Returns:	The physical_location of this SATAInterface.
Return type:	Location
	required

protection_information_capable¶

Gets the protection_information_capable of this SATAInterface. This field indicates whether or not the I/O interface is PI capable.

Required/optional:
Returns:	The protection_information_capable of this SATAInterface.
Return type:	bool
	required

revision¶

Gets the revision of this SATAInterface. The revision level of the SATA part.

Required/optional:
Returns:	The revision of this SATAInterface.
Return type:	int
	required

speed_control¶

Gets the speed_control of this SATAInterface. An indicator of how the device speed is controlled.

Required/optional:
Returns:	The speed_control of this SATAInterface.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.schedule module¶

Schedule.py

class netapp.santricity.models.symbol.schedule.Schedule[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

calendar¶

Gets the calendar of this Schedule. Daily, weekly, or monthly calendar information.

Required/optional:
Returns:	The calendar of this Schedule.
Return type:	ScheduleCalendar
	required

recurrence¶

Gets the recurrence of this Schedule. The number of days, weeks, or months to run.

Required/optional:
Returns:	The recurrence of this Schedule.
Return type:	Recurrence
	required

start_date¶

Gets the start_date of this Schedule. The schedule will not run until this date/time, measured as seconds since midnight, January 1st, 1970 local time.

Required/optional:
Returns:	The start_date of this Schedule.
Return type:	int
	required

timezone¶

Gets the timezone of this Schedule. Specification of the time zone.

Required/optional:
Returns:	The timezone of this Schedule.
Return type:	TimeZoneDescription
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.schedule_calendar module¶

ScheduleCalendar.py

class netapp.santricity.models.symbol.schedule_calendar.ScheduleCalendar[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

daily¶

Gets the daily of this ScheduleCalendar. This field is present only if scheduleMethod is equal to SCHEDULE_METHOD_DAILY.

Required/optional:
Returns:	The daily of this ScheduleCalendar.
Return type:	ScheduleDaily
	optional

monthly_by_date¶

Gets the monthly_by_date of this ScheduleCalendar. This field is present only if scheduleMethod is equal to SCHEDULE_METHOD_MONTHLY_DATE.

Required/optional:
Returns:	The monthly_by_date of this ScheduleCalendar.
Return type:	ScheduleMonthlyByDate
	optional

monthly_by_day¶

Gets the monthly_by_day of this ScheduleCalendar. This field is present only if scheduleMethod is equal to SCHEDULE_METHOD_MONTHLY_DAY.

Required/optional:
Returns:	The monthly_by_day of this ScheduleCalendar.
Return type:	ScheduleMonthlyByDay
	optional

schedule_method¶

Gets the schedule_method of this ScheduleCalendar. This enumeration specifies the different types of scheduling methods.

Required/optional:
Returns:	The schedule_method of this ScheduleCalendar.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

weekly¶

Gets the weekly of this ScheduleCalendar. This field is present only if scheduleMethod is equal to SCHEDULE_METHOD_WEEKLY.

Required/optional:
Returns:	The weekly of this ScheduleCalendar.
Return type:	ScheduleWeekly
	optional

netapp.santricity.models.symbol.schedule_creation_descriptor module¶

ScheduleCreationDescriptor.py

class netapp.santricity.models.symbol.schedule_creation_descriptor.ScheduleCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

action¶

Gets the action of this ScheduleCreationDescriptor. The type of action to be taken.

Required/optional:
Returns:	The action of this ScheduleCreationDescriptor.
Return type:	str
	required

enabled¶

Gets the enabled of this ScheduleCreationDescriptor. If true, the schedule will be enabled, otherwise it will be disabled.

Required/optional:
Returns:	The enabled of this ScheduleCreationDescriptor.
Return type:	bool
	required

schedule¶

Gets the schedule of this ScheduleCreationDescriptor. All schedule-related information.

Required/optional:
Returns:	The schedule of this ScheduleCreationDescriptor.
Return type:	Schedule
	required

target_object¶

Gets the target_object of this ScheduleCreationDescriptor. The object associated with schedule.

Required/optional:
Returns:	The target_object of this ScheduleCreationDescriptor.
Return type:	OptionalTargetObject
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.schedule_creation_descriptor_list module¶

ScheduleCreationDescriptorList.py

class netapp.santricity.models.symbol.schedule_creation_descriptor_list.ScheduleCreationDescriptorList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

schedule_creation_descriptor¶

Gets the schedule_creation_descriptor of this ScheduleCreationDescriptorList. Contains the schedule creation descriptor object.

Required/optional:
Returns:	The schedule_creation_descriptor of this ScheduleCreationDescriptorList.
Return type:	list[ScheduleCreationDescriptor]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.schedule_daily module¶

ScheduleDaily.py

class netapp.santricity.models.symbol.schedule_daily.ScheduleDaily[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

daily_schedule¶

Gets the daily_schedule of this ScheduleDaily. Conveys time information, including time of day, recurrence and occurrence frequency.

Required/optional:
Returns:	The daily_schedule of this ScheduleDaily.
Return type:	DailySchedule
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.schedule_instance module¶

ScheduleInstance.py

class netapp.santricity.models.symbol.schedule_instance.ScheduleInstance[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

action¶

Gets the action of this ScheduleInstance. The type of action to be taken.

Required/optional:
Returns:	The action of this ScheduleInstance.
Return type:	str
	required

creation_time¶

Gets the creation_time of this ScheduleInstance. The schedule creation time (local time) measured as seconds since January 1, 1970.

Required/optional:
Returns:	The creation_time of this ScheduleInstance.
Return type:	int
	required

id¶

Gets the id of this ScheduleInstance.

Required/optional:
Returns:	The id of this ScheduleInstance.
Return type:	str
	optional

last_run_time¶

Gets the last_run_time of this ScheduleInstance. The last run time (local time) measured as seconds since January 1, 1970.

Required/optional:
Returns:	The last_run_time of this ScheduleInstance.
Return type:	int
	required

next_run_time¶

Gets the next_run_time of this ScheduleInstance. The next run time (local time) measured as seconds since January 1, 1970.

Required/optional:
Returns:	The next_run_time of this ScheduleInstance.
Return type:	int
	required

sched_ref¶

Gets the sched_ref of this ScheduleInstance. A reference to the schedule object.

Required/optional:
Returns:	The sched_ref of this ScheduleInstance.
Return type:	str
	required

schedule¶

Gets the schedule of this ScheduleInstance. The schedule information.

Required/optional:
Returns:	The schedule of this ScheduleInstance.
Return type:	Schedule
	required

schedule_status¶

Gets the schedule_status of this ScheduleInstance. The current status of the schedule.

Required/optional:
Returns:	The schedule_status of this ScheduleInstance.
Return type:	str
	required

stop_time¶

Gets the stop_time of this ScheduleInstance. The local time after which schedule is no longer active, measured as seconds since January 1, 1970.

Required/optional:
Returns:	The stop_time of this ScheduleInstance.
Return type:	int
	required

target_object¶

Gets the target_object of this ScheduleInstance. The object associated with schedule.

Required/optional:
Returns:	The target_object of this ScheduleInstance.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.schedule_monthly_by_date module¶

ScheduleMonthlyByDate.py

class netapp.santricity.models.symbol.schedule_monthly_by_date.ScheduleMonthlyByDate[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

daily_schedule¶

Gets the daily_schedule of this ScheduleMonthlyByDate. Conveys time information, including time of day, recurrence and occurrence frequency.

Required/optional:
Returns:	The daily_schedule of this ScheduleMonthlyByDate.
Return type:	DailySchedule
	required

days_of_month¶

Gets the days_of_month of this ScheduleMonthlyByDate. This is a bit mask. Values from the DayOfMonth enumeration should be added (or OR’ed) together to set this value.

Required/optional:
Returns:	The days_of_month of this ScheduleMonthlyByDate.
Return type:	list[str]
	required

months_of_year¶

Gets the months_of_year of this ScheduleMonthlyByDate. This is a bit mask. Values from the MonthOfYear enumeration should be added (or OR’ed) together to set this value.

Required/optional:
Returns:	The months_of_year of this ScheduleMonthlyByDate.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.schedule_monthly_by_day module¶

ScheduleMonthlyByDay.py

class netapp.santricity.models.symbol.schedule_monthly_by_day.ScheduleMonthlyByDay[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

daily_schedule¶

Gets the daily_schedule of this ScheduleMonthlyByDay. Conveys time information, including time of day, recurrence and occurrence frequency.

Required/optional:
Returns:	The daily_schedule of this ScheduleMonthlyByDay.
Return type:	DailySchedule
	required

day_of_week¶

Gets the day_of_week of this ScheduleMonthlyByDay. The day of the week. This is NOT a bit mask.

Required/optional:
Returns:	The day_of_week of this ScheduleMonthlyByDay.
Return type:	str
	required

months_of_year¶

Gets the months_of_year of this ScheduleMonthlyByDay. This is a bit mask. Values from the MonthOfYear enumeration should be added (or OR’ed) together to set this value.

Required/optional:
Returns:	The months_of_year of this ScheduleMonthlyByDay.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

week_number¶

Gets the week_number of this ScheduleMonthlyByDay. The week number during the month. For example, 1 = first, 2 = second, etc., and 5 = last.

Required/optional:
Returns:	The week_number of this ScheduleMonthlyByDay.
Return type:	int
	required

netapp.santricity.models.symbol.schedule_ref_list module¶

ScheduleRefList.py

class netapp.santricity.models.symbol.schedule_ref_list.ScheduleRefList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

schedule_ref¶

Gets the schedule_ref of this ScheduleRefList. A list of schedule references.

Required/optional:
Returns:	The schedule_ref of this ScheduleRefList.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.schedule_update_descriptor module¶

ScheduleUpdateDescriptor.py

class netapp.santricity.models.symbol.schedule_update_descriptor.ScheduleUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

enabled¶

Gets the enabled of this ScheduleUpdateDescriptor. If true, the schedule will be enabled, otherwise it will be disabled.

Required/optional:
Returns:	The enabled of this ScheduleUpdateDescriptor.
Return type:	bool
	required

sched_ref¶

Gets the sched_ref of this ScheduleUpdateDescriptor. The schedule to be updated.

Required/optional:
Returns:	The sched_ref of this ScheduleUpdateDescriptor.
Return type:	str
	required

schedule¶

Gets the schedule of this ScheduleUpdateDescriptor. The new schedule information.

Required/optional:
Returns:	The schedule of this ScheduleUpdateDescriptor.
Return type:	Schedule
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.schedule_update_descriptor_list module¶

ScheduleUpdateDescriptorList.py

class netapp.santricity.models.symbol.schedule_update_descriptor_list.ScheduleUpdateDescriptorList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

schedule_update_descriptor¶

Gets the schedule_update_descriptor of this ScheduleUpdateDescriptorList. Contains the schedule update descriptor object.

Required/optional:
Returns:	The schedule_update_descriptor of this ScheduleUpdateDescriptorList.
Return type:	list[ScheduleUpdateDescriptor]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.schedule_weekly module¶

ScheduleWeekly.py

class netapp.santricity.models.symbol.schedule_weekly.ScheduleWeekly[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

daily_schedule¶

Gets the daily_schedule of this ScheduleWeekly. Conveys time information, including time of day, recurrence and occurrence frequency.

Required/optional:
Returns:	The daily_schedule of this ScheduleWeekly.
Return type:	DailySchedule
	required

days_of_week¶

Gets the days_of_week of this ScheduleWeekly. This is a bit mask. Values from the DayOfWeek enumeration should be added (or OR’ed) together to set this value.

Required/optional:
Returns:	The days_of_week of this ScheduleWeekly.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.scsi_alias module¶

ScsiAlias.py

class netapp.santricity.models.symbol.scsi_alias.ScsiAlias[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

io_interface_type¶

Gets the io_interface_type of this ScsiAlias. This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller.

Required/optional:
Returns:	The io_interface_type of this ScsiAlias.
Return type:	str
	required

iscsi_alias¶

Gets the iscsi_alias of this ScsiAlias. The SCSI alias name as defined under iSCSI. This field is only valid if the I/O interface type is equal to IO_IF_ISCSI.

Required/optional:
Returns:	The iscsi_alias of this ScsiAlias.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.scsi_drive_address module¶

SCSIDriveAddress.py

class netapp.santricity.models.symbol.scsi_drive_address.SCSIDriveAddress[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this SCSIDriveAddress. The controller drive-side SCSI channel on which the drive resides.

Required/optional:
Returns:	The channel of this SCSIDriveAddress.
Return type:	int
	required

id¶

Gets the id of this SCSIDriveAddress. The drive’s SCSI ID value.

Required/optional:
Returns:	The id of this SCSIDriveAddress.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.scsi_initiator_port_id module¶

SCSIInitiatorPortId.py

class netapp.santricity.models.symbol.scsi_initiator_port_id.SCSIInitiatorPortId[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ib_port_name¶

Gets the ib_port_name of this SCSIInitiatorPortId. This field is present only if the type value is equal to IO_IF_IB.

Required/optional:
Returns:	The ib_port_name of this SCSIInitiatorPortId.
Return type:	str
	optional

io_interface_type¶

Gets the io_interface_type of this SCSIInitiatorPortId. This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller.

Required/optional:
Returns:	The io_interface_type of this SCSIInitiatorPortId.
Return type:	str
	required

iscsi_port_name¶

Gets the iscsi_port_name of this SCSIInitiatorPortId. This field is present only if the type value is equal to IO_IF_ISCSI.

Required/optional:
Returns:	The iscsi_port_name of this SCSIInitiatorPortId.
Return type:	IscsiInitiatorPortId
	optional

port_name¶

Gets the port_name of this SCSIInitiatorPortId. This field is present only if the type value is equal to IO_IF_FC.

Required/optional:
Returns:	The port_name of this SCSIInitiatorPortId.
Return type:	str
	optional

sas_port_name¶

Gets the sas_port_name of this SCSIInitiatorPortId. This field is present only if the type value is equal to IO_IF_SAS.

Required/optional:
Returns:	The sas_port_name of this SCSIInitiatorPortId.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.scsi_initiator_target_base_properties module¶

ScsiInitiatorTargetBaseProperties.py

class netapp.santricity.models.symbol.scsi_initiator_target_base_properties.ScsiInitiatorTargetBaseProperties[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

io_interface_type¶

Gets the io_interface_type of this ScsiInitiatorTargetBaseProperties. This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller.

Required/optional:
Returns:	The io_interface_type of this ScsiInitiatorTargetBaseProperties.
Return type:	str
	required

iscsiinitiator_target_base_parameters¶

Gets the iscsiinitiator_target_base_parameters of this ScsiInitiatorTargetBaseProperties.

Required/optional:
Returns:	The iscsiinitiator_target_base_parameters of this ScsiInitiatorTargetBaseProperties.
Return type:	IscsiInitiatorTargetBaseParameters
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.scsi_interface module¶

SCSIInterface.py

class netapp.santricity.models.symbol.scsi_interface.SCSIInterface[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this SCSIInterface. The channel number of this interface.

Required/optional:
Returns:	The channel of this SCSIInterface.
Return type:	int
	required

part¶

Gets the part of this SCSIInterface. An ASCII text string that describes the SCSI controller chip type.

Required/optional:
Returns:	The part of this SCSIInterface.
Return type:	str
	required

reserved1¶

Gets the reserved1 of this SCSIInterface.

Required/optional:
Returns:	The reserved1 of this SCSIInterface.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this SCSIInterface.

Required/optional:
Returns:	The reserved2 of this SCSIInterface.
Return type:	str
	optional

revision¶

Gets the revision of this SCSIInterface. The revision level of the SCSI controller chip.

Required/optional:
Returns:	The revision of this SCSIInterface.
Return type:	int
	required

scsi_id¶

Gets the scsi_id of this SCSIInterface. The SCSI ID value used by the controller on this interface.

Required/optional:
Returns:	The scsi_id of this SCSIInterface.
Return type:	int
	required

scsi_type¶

Gets the scsi_type of this SCSIInterface. The type of SCSI line driver (e.g. SE, LVD, etc.) being used.

Required/optional:
Returns:	The scsi_type of this SCSIInterface.
Return type:	str
	required

speed¶

Gets the speed of this SCSIInterface. The speed of the interface in MB/sec.

Required/optional:
Returns:	The speed of this SCSIInterface.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

width¶

Gets the width of this SCSIInterface. The transfer width of the SCSI bus, in bits.

Required/optional:
Returns:	The width of this SCSIInterface.
Return type:	int
	required

netapp.santricity.models.symbol.scsi_node_name module¶

ScsiNodeName.py

class netapp.santricity.models.symbol.scsi_node_name.ScsiNodeName[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

io_interface_type¶

Gets the io_interface_type of this ScsiNodeName. This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller.

Required/optional:
Returns:	The io_interface_type of this ScsiNodeName.
Return type:	str
	required

iscsi_node_name¶

Gets the iscsi_node_name of this ScsiNodeName. The SCSI node name as defined under iSCSI. This field is only valid if the I/O interface type is equal to IO_IF_ISCSI.

Required/optional:
Returns:	The iscsi_node_name of this ScsiNodeName.
Return type:	str
	optional

remote_node_wwn¶

Gets the remote_node_wwn of this ScsiNodeName. The FC WWN for the remote node. This field is only valid if the I/O interface type is equal to IO_IF_FC.

Required/optional:
Returns:	The remote_node_wwn of this ScsiNodeName.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.scsi_protocol_endpoint module¶

ScsiProtocolEndpoint.py

class netapp.santricity.models.symbol.scsi_protocol_endpoint.ScsiProtocolEndpoint[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

endpoint_role¶

Gets the endpoint_role of this ScsiProtocolEndpoint. This enumeration object is used to indicate the role of a SCSI protocol endpoint, either initiator or target.

Required/optional:
Returns:	The endpoint_role of this ScsiProtocolEndpoint.
Return type:	str
	required

initiator_id¶

Gets the initiator_id of this ScsiProtocolEndpoint. A SCSI initiator port identifier. This field is only valid if the endpointRole field is equal to SCSI_ROLE_INITIATOR.

Required/optional:
Returns:	The initiator_id of this ScsiProtocolEndpoint.
Return type:	SCSIInitiatorPortId
	optional

target_id¶

Gets the target_id of this ScsiProtocolEndpoint. A SCSI target port identifier. This field is only valid if the endpointRole field is equal to SCSI_ROLE_TARGET.

Required/optional:
Returns:	The target_id of this ScsiProtocolEndpoint.
Return type:	SCSITargetPortId
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.scsi_remote_connection module¶

ScsiRemoteConnection.py

class netapp.santricity.models.symbol.scsi_remote_connection.ScsiRemoteConnection[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller¶

Gets the controller of this ScsiRemoteConnection. Local controller acting as the initiator for these connections.

Required/optional:
Returns:	The controller of this ScsiRemoteConnection.
Return type:	str
	required

local_port¶

Gets the local_port of this ScsiRemoteConnection. Local initiator port for these connections.

Required/optional:
Returns:	The local_port of this ScsiRemoteConnection.
Return type:	str
	required

remote_target_connections¶

Gets the remote_target_connections of this ScsiRemoteConnection. Details of connections to remote target.

Required/optional:
Returns:	The remote_target_connections of this ScsiRemoteConnection.
Return type:	ScsiRemoteTargetConnections
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.scsi_remote_connections_returned module¶

ScsiRemoteConnectionsReturned.py

class netapp.santricity.models.symbol.scsi_remote_connections_returned.ScsiRemoteConnectionsReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

remote_connections¶

Gets the remote_connections of this ScsiRemoteConnectionsReturned. This field is returned if the value of returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The remote_connections of this ScsiRemoteConnectionsReturned.
Return type:	list[ScsiRemoteConnection]
	optional

return_code¶

Gets the return_code of this ScsiRemoteConnectionsReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this ScsiRemoteConnectionsReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.scsi_remote_target_connections module¶

ScsiRemoteTargetConnections.py

class netapp.santricity.models.symbol.scsi_remote_target_connections.ScsiRemoteTargetConnections[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

fibre_connection_detail¶

Gets the fibre_connection_detail of this ScsiRemoteTargetConnections. This field is returned if the value of ioInterfaceType is equal to IO_IF_FC.

Required/optional:
Returns:	The fibre_connection_detail of this ScsiRemoteTargetConnections.
Return type:	FibreRemoteTargetConnections
	optional

io_interface_type¶

Gets the io_interface_type of this ScsiRemoteTargetConnections. This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller.

Required/optional:
Returns:	The io_interface_type of this ScsiRemoteTargetConnections.
Return type:	str
	required

iscsi_connection_detail¶

Gets the iscsi_connection_detail of this ScsiRemoteTargetConnections. This field is returned if the value of ioInterfaceType is equal to IO_IF_ISCSI.

Required/optional:
Returns:	The iscsi_connection_detail of this ScsiRemoteTargetConnections.
Return type:	IscsiRemoteTargetConnections
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.scsi_target_port_id module¶

SCSITargetPortId.py

class netapp.santricity.models.symbol.scsi_target_port_id.SCSITargetPortId[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ib_port_name¶

Gets the ib_port_name of this SCSITargetPortId. This field is present only if the type value is equal to IO_IF_IB.

Required/optional:
Returns:	The ib_port_name of this SCSITargetPortId.
Return type:	str
	optional

io_interface_type¶

Gets the io_interface_type of this SCSITargetPortId. This enumeration defines the different I/O interface types that may be reported as part of the configuration information associated with a controller.

Required/optional:
Returns:	The io_interface_type of this SCSITargetPortId.
Return type:	str
	required

iscsi_port_name¶

Gets the iscsi_port_name of this SCSITargetPortId. This field is present only if the type value is equal to IO_IF_ISCSI.

Required/optional:
Returns:	The iscsi_port_name of this SCSITargetPortId.
Return type:	IscsiTargetPortId
	optional

port_name¶

Gets the port_name of this SCSITargetPortId. This field is present only if the type value is equal to IO_IF_FC.

Required/optional:
Returns:	The port_name of this SCSITargetPortId.
Return type:	str
	optional

sas_port_name¶

Gets the sas_port_name of this SCSITargetPortId. This field is present only if the type value is equal to IO_IF_SAS.

Required/optional:
Returns:	The sas_port_name of this SCSITargetPortId.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.scsi_to_ata_translator_data module¶

ScsiToAtaTranslatorData.py

class netapp.santricity.models.symbol.scsi_to_ata_translator_data.ScsiToAtaTranslatorData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

product_id¶

Gets the product_id of this ScsiToAtaTranslatorData. The product identification string.

Required/optional:
Returns:	The product_id of this ScsiToAtaTranslatorData.
Return type:	str
	required

product_rev_level¶

Gets the product_rev_level of this ScsiToAtaTranslatorData. The product revision level string. When no interposer card is available, this string is set to “—-” (four dashes).

Required/optional:
Returns:	The product_rev_level of this ScsiToAtaTranslatorData.
Return type:	str
	required

sat_type¶

Gets the sat_type of this ScsiToAtaTranslatorData. This field identifies the type of the SCSI-to-ATA translation hardware. Note that if this field is set to SAT_TYPE_UNKNOWN, the string in the productId field will have zero length, and the string in the productRevLevel field will be set to “—-” (four dashes).

Required/optional:
Returns:	The sat_type of this ScsiToAtaTranslatorData.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

vendor_id¶

Gets the vendor_id of this ScsiToAtaTranslatorData. The vendor identification string.

Required/optional:
Returns:	The vendor_id of this ScsiToAtaTranslatorData.
Return type:	str
	required

netapp.santricity.models.symbol.security_key_needed module¶

SecurityKeyNeeded.py

class netapp.santricity.models.symbol.security_key_needed.SecurityKeyNeeded[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

lock_key_id_ref¶

Gets the lock_key_id_ref of this SecurityKeyNeeded. This is a reference to the lock key needed for the set of locked drives referenced in the drives field.

Required/optional:
Returns:	The lock_key_id_ref of this SecurityKeyNeeded.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.setting_control module¶

SettingControl.py

class netapp.santricity.models.symbol.setting_control.SettingControl[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

is_enabled¶

Gets the is_enabled of this SettingControl. True when the property is enabled.

Required/optional:
Returns:	The is_enabled of this SettingControl.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

value¶

Gets the value of this SettingControl. The value of the property

Required/optional:
Returns:	The value of this SettingControl.
Return type:	int
	required

netapp.santricity.models.symbol.sfp module¶

Sfp.py

class netapp.santricity.models.symbol.sfp.Sfp[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

id¶

Gets the id of this Sfp.

Required/optional:
Returns:	The id of this Sfp.
Return type:	str
	optional

parent_data¶

Gets the parent_data of this Sfp. Data specific to SFP parent type.

Required/optional:
Returns:	The parent_data of this Sfp.
Return type:	SFPParentTypeData
	required

physical_location¶

Gets the physical_location of this Sfp. The physical location of the SFP.

Required/optional:
Returns:	The physical_location of this Sfp.
Return type:	Location
	required

repair_policy¶

Gets the repair_policy of this Sfp. The repair policy for the SFP component.

Required/optional:
Returns:	The repair_policy of this Sfp.
Return type:	RepairPolicy
	required

reserved1¶

Gets the reserved1 of this Sfp.

Required/optional:
Returns:	The reserved1 of this Sfp.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this Sfp.

Required/optional:
Returns:	The reserved2 of this Sfp.
Return type:	str
	optional

sfp_port¶

Gets the sfp_port of this Sfp. The port that the SFP is associated with.

Required/optional:
Returns:	The sfp_port of this Sfp.
Return type:	str
	required

sfp_port_ref¶

Gets the sfp_port_ref of this Sfp. A reference identifying the channel port that the SFP is plugged into.

Required/optional:
Returns:	The sfp_port_ref of this Sfp.
Return type:	str
	required

sfp_ref¶

Gets the sfp_ref of this Sfp. The reference for this physical SFP.

Required/optional:
Returns:	The sfp_ref of this Sfp.
Return type:	str
	required

sfp_type¶

Gets the sfp_type of this Sfp. The type of the SFP.

Required/optional:
Returns:	The sfp_type of this Sfp.
Return type:	SFPType
	required

status¶

Gets the status of this Sfp. The operational status of the SFP.

Required/optional:
Returns:	The status of this Sfp.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sfp_parent_type_data module¶

SFPParentTypeData.py

class netapp.santricity.models.symbol.sfp_parent_type_data.SFPParentTypeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_sfp¶

Gets the controller_sfp of this SFPParentTypeData. This field is present only if the sfpParentType is equal to SFP_PARENT_TYPE_CONTROLLER. It contains the parent type of a SFP.

Required/optional:
Returns:	The controller_sfp of this SFPParentTypeData.
Return type:	ControllerSFP
	optional

parent_esm¶

Gets the parent_esm of this SFPParentTypeData. No information is returned

Required/optional:
Returns:	The parent_esm of this SFPParentTypeData.
Return type:	str
	optional

parent_minihub¶

Gets the parent_minihub of this SFPParentTypeData. This field is present only if the sfpParentType is equal to SFP_PARENT_TYPE_MINIHUB. It contains the parent type of a SFP.

Required/optional:
Returns:	The parent_minihub of this SFPParentTypeData.
Return type:	str
	optional

sfp_parent_type¶

Gets the sfp_parent_type of this SFPParentTypeData. This enumeration object is used to describe the parent type of a SFP.

Required/optional:
Returns:	The sfp_parent_type of this SFPParentTypeData.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sfp_type module¶

SFPType.py

class netapp.santricity.models.symbol.sfp_type.SFPType[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

manufacturer_date¶

Gets the manufacturer_date of this SFPType. The date when the SFP was manufactured.

Required/optional:
Returns:	The manufacturer_date of this SFPType.
Return type:	int
	required

reserved1¶

Gets the reserved1 of this SFPType.

Required/optional:
Returns:	The reserved1 of this SFPType.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this SFPType.

Required/optional:
Returns:	The reserved2 of this SFPType.
Return type:	str
	optional

sfp_connect_type¶

Gets the sfp_connect_type of this SFPType. Information about the SFP connector type.

Required/optional:
Returns:	The sfp_connect_type of this SFPType.
Return type:	str
	required

sfp_ident_type¶

Gets the sfp_ident_type of this SFPType. Information about the SFP type.

Required/optional:
Returns:	The sfp_ident_type of this SFPType.
Return type:	str
	required

sfp_link_l_type¶

Gets the sfp_link_l_type of this SFPType. Information about the SFP link length.

Required/optional:
Returns:	The sfp_link_l_type of this SFPType.
Return type:	str
	required

sfp_speed¶

Gets the sfp_speed of this SFPType. Information about the SFP speed.

Required/optional:
Returns:	The sfp_speed of this SFPType.
Return type:	list[str]
	required

sfp_transmission_media¶

Gets the sfp_transmission_media of this SFPType. Information about the SFP transmission media.

Required/optional:
Returns:	The sfp_transmission_media of this SFPType.
Return type:	list[str]
	required

sfp_transmitter_type¶

Gets the sfp_transmitter_type of this SFPType. Information about the SFP transmitter type.

Required/optional:
Returns:	The sfp_transmitter_type of this SFPType.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

vendor_name¶

Gets the vendor_name of this SFPType. The vendor name of the SFP.

Required/optional:
Returns:	The vendor_name of this SFPType.
Return type:	str
	required

vendor_oui¶

Gets the vendor_oui of this SFPType. The vendor unique OUI field of the SFP.

Required/optional:
Returns:	The vendor_oui of this SFPType.
Return type:	str
	required

vendor_pn¶

Gets the vendor_pn of this SFPType. The vendor part name of the SFP.

Required/optional:
Returns:	The vendor_pn of this SFPType.
Return type:	str
	required

vendor_rev¶

Gets the vendor_rev of this SFPType. The vendor revision of the SFP

Required/optional:
Returns:	The vendor_rev of this SFPType.
Return type:	str
	required

vendor_sn¶

Gets the vendor_sn of this SFPType. The vendor serial number of the SFP.

Required/optional:
Returns:	The vendor_sn of this SFPType.
Return type:	str
	required

netapp.santricity.models.symbol.smart_battery_data module¶

SmartBatteryData.py

class netapp.santricity.models.symbol.smart_battery_data.SmartBatteryData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

battery_learn_cycle_interval¶

Gets the battery_learn_cycle_interval of this SmartBatteryData. The time between automatic learn cycles, expressed in weeks.

Required/optional:
Returns:	The battery_learn_cycle_interval of this SmartBatteryData.
Return type:	int
	required

last_battery_learn_cycle¶

Gets the last_battery_learn_cycle of this SmartBatteryData. The time of the last completed learn cycle, expressed in seconds since midnight GMT, January 1, 1970.

Required/optional:
Returns:	The last_battery_learn_cycle of this SmartBatteryData.
Return type:	int
	required

next_battery_learn_cycle¶

Gets the next_battery_learn_cycle of this SmartBatteryData. The time of the next scheduled learn cycle, expressed in seconds since midnight GMT, January 1, 1970.

Required/optional:
Returns:	The next_battery_learn_cycle of this SmartBatteryData.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.snapshot_conversion_descriptor module¶

SnapshotConversionDescriptor.py

class netapp.santricity.models.symbol.snapshot_conversion_descriptor.SnapshotConversionDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

base_volume¶

Gets the base_volume of this SnapshotConversionDescriptor. The base volume for the snapshots to be converted (will become the base volume for the newly created PiT groups).

Required/optional:
Returns:	The base_volume of this SnapshotConversionDescriptor.
Return type:	str
	required

conversion_labels¶

Gets the conversion_labels of this SnapshotConversionDescriptor. List of new PiT group and repository user labels (one pair for each snapshot being converted).

Required/optional:
Returns:	The conversion_labels of this SnapshotConversionDescriptor.
Return type:	list[SnapshotConversionLabel]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.snapshot_conversion_label module¶

SnapshotConversionLabel.py

class netapp.santricity.models.symbol.snapshot_conversion_label.SnapshotConversionLabel[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

new_pit_group_label¶

Gets the new_pit_group_label of this SnapshotConversionLabel. Label for new PiT group being created.

Required/optional:
Returns:	The new_pit_group_label of this SnapshotConversionLabel.
Return type:	str
	required

new_repository_label¶

Gets the new_repository_label of this SnapshotConversionLabel. New label for repository volume being converted from a snapshot repository to a PiT group repository.

Required/optional:
Returns:	The new_repository_label of this SnapshotConversionLabel.
Return type:	str
	required

snap_repository_ref¶

Gets the snap_repository_ref of this SnapshotConversionLabel. Reference to repository of snapshot being converted. This volume (old snapshot Repository, new PiT group repository) will be renamed using ‘newRepositoryLabel’ contained in this structure, and the associated PiT group created will be named using the “newPITGroupLabel” also contained in this structure. Note: The old snapshot label will be used for the read-only view that is created as part of the conversion process.

Required/optional:
Returns:	The snap_repository_ref of this SnapshotConversionLabel.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.snapshot_creation_descriptor module¶

SnapshotCreationDescriptor.py

class netapp.santricity.models.symbol.snapshot_creation_descriptor.SnapshotCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

base_volume¶

Gets the base_volume of this SnapshotCreationDescriptor. The base volume.

Required/optional:
Returns:	The base_volume of this SnapshotCreationDescriptor.
Return type:	str
	required

candidate¶

Gets the candidate of this SnapshotCreationDescriptor. The volume candidate for the repository.

Required/optional:
Returns:	The candidate of this SnapshotCreationDescriptor.
Return type:	VolumeCandidate
	required

create_in_stopped_state¶

Gets the create_in_stopped_state of this SnapshotCreationDescriptor. If true, the snapshot will be created in a stopped state, otherwise it will be started on creation.

Required/optional:
Returns:	The create_in_stopped_state of this SnapshotCreationDescriptor.
Return type:	bool
	required

extent_size¶

Gets the extent_size of this SnapshotCreationDescriptor. The size of the extent in bytes. Not used in this release of software.

Required/optional:
Returns:	The extent_size of this SnapshotCreationDescriptor.
Return type:	int
	required

extent_start¶

Gets the extent_start of this SnapshotCreationDescriptor. The start position of the extent in the base volume (bytes). Not used in this release of software.

Required/optional:
Returns:	The extent_start of this SnapshotCreationDescriptor.
Return type:	int
	required

no_mapping¶

Gets the no_mapping of this SnapshotCreationDescriptor. True tells the controller NOT to create a mapping. False causes the controller to create a default mapping for the new snapshot. (Note: A True value for noMapping when the SPM feature is disabled will cause a RETCODE_PARTITIONS_DISABLED from createSnapshot. This is because a host cannot access the snapshot if partitions are disabled and a default mapping was not created when the snapshot was created.

Required/optional:
Returns:	The no_mapping of this SnapshotCreationDescriptor.
Return type:	bool
	required

rep_full_policy¶

Gets the rep_full_policy of this SnapshotCreationDescriptor. The policy regarding what will happen when the repository is full.

Required/optional:
Returns:	The rep_full_policy of this SnapshotCreationDescriptor.
Return type:	str
	required

repository_capacity¶

Gets the repository_capacity of this SnapshotCreationDescriptor. The capacity size of the repository to create in bytes.

Required/optional:
Returns:	The repository_capacity of this SnapshotCreationDescriptor.
Return type:	int
	required

repository_label¶

Gets the repository_label of this SnapshotCreationDescriptor. The user assigned label for the repository volume.

Required/optional:
Returns:	The repository_label of this SnapshotCreationDescriptor.
Return type:	str
	required

snapshot_label¶

Gets the snapshot_label of this SnapshotCreationDescriptor. The user assigned snapshot label.

Required/optional:
Returns:	The snapshot_label of this SnapshotCreationDescriptor.
Return type:	str
	required

snapshot_schedule¶

Gets the snapshot_schedule of this SnapshotCreationDescriptor. The snapshot schedule. The targetObject in the structure is empty.

Required/optional:
Returns:	The snapshot_schedule of this SnapshotCreationDescriptor.
Return type:	OptionalScheduleCreationDescriptor
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_group_label¶

Gets the volume_group_label of this SnapshotCreationDescriptor. The label to assign to the new volume group for the repository, if any. This field is only used when the repository candidate selection type is CANDIDATE_SEL_MANUAL or CANDIDATE_SEL_COUNT.

Required/optional:
Returns:	The volume_group_label of this SnapshotCreationDescriptor.
Return type:	str
	required

warn_threshold¶

Gets the warn_threshold of this SnapshotCreationDescriptor. The repository utilization warning threshold.

Required/optional:
Returns:	The warn_threshold of this SnapshotCreationDescriptor.
Return type:	int
	required

netapp.santricity.models.symbol.snapshot_failure module¶

SnapshotFailure.py

class netapp.santricity.models.symbol.snapshot_failure.SnapshotFailure[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

repository_full¶

Gets the repository_full of this SnapshotFailure. The policy explaining the behavior when the repository is full.

Required/optional:
Returns:	The repository_full of this SnapshotFailure.
Return type:	bool
	required

repository_volume¶

Gets the repository_volume of this SnapshotFailure. The repository volume that failed.

Required/optional:
Returns:	The repository_volume of this SnapshotFailure.
Return type:	str
	required

snapshot_volume¶

Gets the snapshot_volume of this SnapshotFailure. The snapshot volume that failed.

Required/optional:
Returns:	The snapshot_volume of this SnapshotFailure.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.snapshot_params_update_descriptor module¶

SnapshotParamsUpdateDescriptor.py

class netapp.santricity.models.symbol.snapshot_params_update_descriptor.SnapshotParamsUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

extent_size¶

Gets the extent_size of this SnapshotParamsUpdateDescriptor. The size of the extent in bytes. Not used in this release of software.

Required/optional:
Returns:	The extent_size of this SnapshotParamsUpdateDescriptor.
Return type:	int
	required

extent_start¶

Gets the extent_start of this SnapshotParamsUpdateDescriptor. The start position of the extent in the base volume (bytes). Not used in this release of software.

Required/optional:
Returns:	The extent_start of this SnapshotParamsUpdateDescriptor.
Return type:	int
	required

rep_full_policy¶

Gets the rep_full_policy of this SnapshotParamsUpdateDescriptor. The policy concerning what will happen when the repository is full.

Required/optional:
Returns:	The rep_full_policy of this SnapshotParamsUpdateDescriptor.
Return type:	str
	required

rollback_priority¶

Gets the rollback_priority of this SnapshotParamsUpdateDescriptor. The importance of the rollback operation.

Required/optional:
Returns:	The rollback_priority of this SnapshotParamsUpdateDescriptor.
Return type:	int
	required

snap_ref¶

Gets the snap_ref of this SnapshotParamsUpdateDescriptor. The snapshot volume to be updated.

Required/optional:
Returns:	The snap_ref of this SnapshotParamsUpdateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

warn_threshold¶

Gets the warn_threshold of this SnapshotParamsUpdateDescriptor. The repository utilization warning threshold.

Required/optional:
Returns:	The warn_threshold of this SnapshotParamsUpdateDescriptor.
Return type:	int
	required

netapp.santricity.models.symbol.snapshot_ref_list module¶

SnapshotRefList.py

class netapp.santricity.models.symbol.snapshot_ref_list.SnapshotRefList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

snapshot_ref¶

Gets the snapshot_ref of this SnapshotRefList. A list of snapshot references.

Required/optional:
Returns:	The snapshot_ref of this SnapshotRefList.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.snapshot_rollback_operation module¶

SnapshotRollbackOperation.py

class netapp.santricity.models.symbol.snapshot_rollback_operation.SnapshotRollbackOperation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

pending¶

Gets the pending of this SnapshotRollbackOperation. If true, the operation has not started.

Required/optional:
Returns:	The pending of this SnapshotRollbackOperation.
Return type:	bool
	required

percent_complete¶

Gets the percent_complete of this SnapshotRollbackOperation. Completion percentage for the operation. If the operation is not currently running this value will be equal to PERCENT_COMPLETE_OP_NOT_RUNNING.

Required/optional:
Returns:	The percent_complete of this SnapshotRollbackOperation.
Return type:	int
	required

snapshot_ref¶

Gets the snapshot_ref of this SnapshotRollbackOperation. Reference to the snapshot.

Required/optional:
Returns:	The snapshot_ref of this SnapshotRollbackOperation.
Return type:	str
	required

time_to_completion¶

Gets the time_to_completion of this SnapshotRollbackOperation. Estimated time to completion in minutes. If the time is not known this value will be equal to TIME_TO_COMPLETION_UNKNOWN.

Required/optional:
Returns:	The time_to_completion of this SnapshotRollbackOperation.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.snapshot_volume module¶

SnapshotVolume.py

class netapp.santricity.models.symbol.snapshot_volume.SnapshotVolume[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

action¶

Gets the action of this SnapshotVolume. Long running action.

Required/optional:
Returns:	The action of this SnapshotVolume.
Return type:	str
	required

base_volume¶

Gets the base_volume of this SnapshotVolume. Base volume for this snapshot.

Required/optional:
Returns:	The base_volume of this SnapshotVolume.
Return type:	str
	required

children_inactive¶

Gets the children_inactive of this SnapshotVolume. True if all child volumes are offline or failed. Child volumes are the base volume and the REPOSITORY volume.

Required/optional:
Returns:	The children_inactive of this SnapshotVolume.
Return type:	bool
	required

current_manager¶

Gets the current_manager of this SnapshotVolume. Current owner of the snapshot.

Required/optional:
Returns:	The current_manager of this SnapshotVolume.
Return type:	str
	required

extent_size¶

Gets the extent_size of this SnapshotVolume. The size of the extent in bytes. Not used in this release of software.

Required/optional:
Returns:	The extent_size of this SnapshotVolume.
Return type:	int
	required

extent_start¶

Gets the extent_start of this SnapshotVolume. The start position of the extent in the base volume (bytes). Not used in this release of software.

Required/optional:
Returns:	The extent_start of this SnapshotVolume.
Return type:	int
	required

full_warn_threshold¶

Gets the full_warn_threshold of this SnapshotVolume. Repository utilization warning threshold.

Required/optional:
Returns:	The full_warn_threshold of this SnapshotVolume.
Return type:	int
	required

id¶

Gets the id of this SnapshotVolume.

Required/optional:
Returns:	The id of this SnapshotVolume.
Return type:	str
	optional

label¶

Gets the label of this SnapshotVolume. Name of the snapshot.

Required/optional:
Returns:	The label of this SnapshotVolume.
Return type:	str
	required

mgmt_client_attribute¶

Gets the mgmt_client_attribute of this SnapshotVolume. For use by management client.

Required/optional:
Returns:	The mgmt_client_attribute of this SnapshotVolume.
Return type:	int
	required

over_warn_threshold¶

Gets the over_warn_threshold of this SnapshotVolume. True if the repository utilization is over the warning threshold.

Required/optional:
Returns:	The over_warn_threshold of this SnapshotVolume.
Return type:	bool
	required

perms¶

Gets the perms of this SnapshotVolume. Permissions allowed on volume.

Required/optional:
Returns:	The perms of this SnapshotVolume.
Return type:	VolumePerms
	required

rep_full_policy¶

Gets the rep_full_policy of this SnapshotVolume. Indication of the volume behavior when the repository is full.

Required/optional:
Returns:	The rep_full_policy of this SnapshotVolume.
Return type:	str
	required

repository_full¶

Gets the repository_full of this SnapshotVolume. True, if the repository is full.

Required/optional:
Returns:	The repository_full of this SnapshotVolume.
Return type:	bool
	required

repository_volume¶

Gets the repository_volume of this SnapshotVolume. Repository volume for this snapshot.

Required/optional:
Returns:	The repository_volume of this SnapshotVolume.
Return type:	str
	required

rollback_priority¶

Gets the rollback_priority of this SnapshotVolume. The importance of the rollback operation (0-4). Not used in this release of software.

Required/optional:
Returns:	The rollback_priority of this SnapshotVolume.
Return type:	int
	required

rollback_status¶

Gets the rollback_status of this SnapshotVolume. Status of current action being performed on snapshot.

Required/optional:
Returns:	The rollback_status of this SnapshotVolume.
Return type:	str
	required

snapshot_ref¶

Gets the snapshot_ref of this SnapshotVolume. Reference (key) for the snapshot volume.

Required/optional:
Returns:	The snapshot_ref of this SnapshotVolume.
Return type:	str
	required

snapshot_time¶

Gets the snapshot_time of this SnapshotVolume. The controller time when the snapshot was created.

Required/optional:
Returns:	The snapshot_time of this SnapshotVolume.
Return type:	int
	required

status¶

Gets the status of this SnapshotVolume. Indicates status of the snapshot.

Required/optional:
Returns:	The status of this SnapshotVolume.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_handle¶

Gets the volume_handle of this SnapshotVolume. Volume SSID.

Required/optional:
Returns:	The volume_handle of this SnapshotVolume.
Return type:	int
	required

world_wide_name¶

Gets the world_wide_name of this SnapshotVolume. The World Wide Name of the snapshot.

Required/optional:
Returns:	The world_wide_name of this SnapshotVolume.
Return type:	str
	required

netapp.santricity.models.symbol.snmp_agent_bundle module¶

SNMPAgentBundle.py

class netapp.santricity.models.symbol.snmp_agent_bundle.SNMPAgentBundle[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

community¶

Gets the community of this SNMPAgentBundle. All configured SNMP communities

Required/optional:
Returns:	The community of this SNMPAgentBundle.
Return type:	list[SNMPCommunity]
	required

system_variables¶

Gets the system_variables of this SNMPAgentBundle. Current settings for SNMP “system” variables

Required/optional:
Returns:	The system_variables of this SNMPAgentBundle.
Return type:	SNMPSystemVariables
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

trap_destination¶

Gets the trap_destination of this SNMPAgentBundle. SNMP Trap Destinations. Traps will be delivered to these destinations when an alertable MEL event is generated.

Required/optional:
Returns:	The trap_destination of this SNMPAgentBundle.
Return type:	list[SNMPTrapDestination]
	required

netapp.santricity.models.symbol.snmp_community module¶

SNMPCommunity.py

class netapp.santricity.models.symbol.snmp_community.SNMPCommunity[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

community_name¶

Gets the community_name of this SNMPCommunity. Community name

Required/optional:
Returns:	The community_name of this SNMPCommunity.
Return type:	str
	required

community_permissions¶

Gets the community_permissions of this SNMPCommunity. Community permissions

Required/optional:
Returns:	The community_permissions of this SNMPCommunity.
Return type:	str
	required

community_ref¶

Gets the community_ref of this SNMPCommunity. A reference to the SNMP community.

Required/optional:
Returns:	The community_ref of this SNMPCommunity.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.snmp_community_add_descriptor module¶

SNMPCommunityAddDescriptor.py

class netapp.santricity.models.symbol.snmp_community_add_descriptor.SNMPCommunityAddDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

community_name¶

Gets the community_name of this SNMPCommunityAddDescriptor. community name

Required/optional:
Returns:	The community_name of this SNMPCommunityAddDescriptor.
Return type:	str
	required

community_permissions¶

Gets the community_permissions of this SNMPCommunityAddDescriptor. SNMP community permissions

Required/optional:
Returns:	The community_permissions of this SNMPCommunityAddDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.snmp_community_add_descriptor_list module¶

SNMPCommunityAddDescriptorList.py

class netapp.santricity.models.symbol.snmp_community_add_descriptor_list.SNMPCommunityAddDescriptorList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

community_add_descriptor¶

Gets the community_add_descriptor of this SNMPCommunityAddDescriptorList. SNMP community add descriptor.

Required/optional:
Returns:	The community_add_descriptor of this SNMPCommunityAddDescriptorList.
Return type:	list[SNMPCommunityAddDescriptor]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.snmp_community_params_update_descriptor module¶

SNMPCommunityParamsUpdateDescriptor.py

class netapp.santricity.models.symbol.snmp_community_params_update_descriptor.SNMPCommunityParamsUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

community_name¶

Gets the community_name of this SNMPCommunityParamsUpdateDescriptor. New community name.

Required/optional:
Returns:	The community_name of this SNMPCommunityParamsUpdateDescriptor.
Return type:	str
	required

community_permissions¶

Gets the community_permissions of this SNMPCommunityParamsUpdateDescriptor. New permissions to set

Required/optional:
Returns:	The community_permissions of this SNMPCommunityParamsUpdateDescriptor.
Return type:	str
	required

community_ref¶

Gets the community_ref of this SNMPCommunityParamsUpdateDescriptor. Community to update

Required/optional:
Returns:	The community_ref of this SNMPCommunityParamsUpdateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.snmp_community_params_update_descriptor_list module¶

SNMPCommunityParamsUpdateDescriptorList.py

class netapp.santricity.models.symbol.snmp_community_params_update_descriptor_list.SNMPCommunityParamsUpdateDescriptorList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

community_update_descriptor¶

Gets the community_update_descriptor of this SNMPCommunityParamsUpdateDescriptorList. SNMP community parameters update descriptor

Required/optional:
Returns:	The community_update_descriptor of this SNMPCommunityParamsUpdateDescriptorList.
Return type:	list[SNMPCommunityParamsUpdateDescriptor]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.snmp_community_ref_list module¶

SNMPCommunityRefList.py

class netapp.santricity.models.symbol.snmp_community_ref_list.SNMPCommunityRefList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

community_ref¶

Gets the community_ref of this SNMPCommunityRefList. An array of SNMPCommunity references

Required/optional:
Returns:	The community_ref of this SNMPCommunityRefList.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.snmp_system_variable_value module¶

SNMPSystemVariableValue.py

class netapp.santricity.models.symbol.snmp_system_variable_value.SNMPSystemVariableValue[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

new_sys_contact¶

Gets the new_sys_contact of this SNMPSystemVariableValue. This field is returned if the value of variable is equal to SNMP_SYSTEM_VARIABLE_SYSCONTACT.

Required/optional:
Returns:	The new_sys_contact of this SNMPSystemVariableValue.
Return type:	str
	optional

new_sys_location¶

Gets the new_sys_location of this SNMPSystemVariableValue. This field is returned if the value of variable is equal to SNMP_SYSTEM_VARIABLE_SYSLOCATION.

Required/optional:
Returns:	The new_sys_location of this SNMPSystemVariableValue.
Return type:	str
	optional

new_sys_name¶

Gets the new_sys_name of this SNMPSystemVariableValue. This field is returned if the value of variable is equal to SNMP_SYSTEM_VARIABLE_SYSNAME.

Required/optional:
Returns:	The new_sys_name of this SNMPSystemVariableValue.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

variable¶

Gets the variable of this SNMPSystemVariableValue. This enumeration represents possible SNMP system variables that can be set via SYMbol.

Required/optional:
Returns:	The variable of this SNMPSystemVariableValue.
Return type:	str
	required

netapp.santricity.models.symbol.snmp_system_variables module¶

SNMPSystemVariables.py

class netapp.santricity.models.symbol.snmp_system_variables.SNMPSystemVariables[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

sys_contact¶

Gets the sys_contact of this SNMPSystemVariables. Value to be returned for system.sysContact variable

Required/optional:
Returns:	The sys_contact of this SNMPSystemVariables.
Return type:	str
	required

sys_location¶

Gets the sys_location of this SNMPSystemVariables. Value to be returned for system.sysLocation variable

Required/optional:
Returns:	The sys_location of this SNMPSystemVariables.
Return type:	str
	required

sys_name¶

Gets the sys_name of this SNMPSystemVariables. Value to be returned for system.sysName variable

Required/optional:
Returns:	The sys_name of this SNMPSystemVariables.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.snmp_system_variables_update_descriptor module¶

SNMPSystemVariablesUpdateDescriptor.py

class netapp.santricity.models.symbol.snmp_system_variables_update_descriptor.SNMPSystemVariablesUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

new_values¶

Gets the new_values of this SNMPSystemVariablesUpdateDescriptor. SNMP system variable value object containing the new variables.

Required/optional:
Returns:	The new_values of this SNMPSystemVariablesUpdateDescriptor.
Return type:	list[SNMPSystemVariableValue]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.snmp_trap_destination module¶

SNMPTrapDestination.py

class netapp.santricity.models.symbol.snmp_trap_destination.SNMPTrapDestination[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

community_ref¶

Gets the community_ref of this SNMPTrapDestination. Community associated with the trap destination

Required/optional:
Returns:	The community_ref of this SNMPTrapDestination.
Return type:	str
	required

send_authentication_failure_traps¶

Gets the send_authentication_failure_traps of this SNMPTrapDestination. Send authentication failure traps to this destination.

Required/optional:
Returns:	The send_authentication_failure_traps of this SNMPTrapDestination.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

trap_destination_ref¶

Gets the trap_destination_ref of this SNMPTrapDestination. SNMP trap destination reference.

Required/optional:
Returns:	The trap_destination_ref of this SNMPTrapDestination.
Return type:	str
	required

trap_receiver_ip_address¶

Gets the trap_receiver_ip_address of this SNMPTrapDestination. IPVx address of the trap receiver

Required/optional:
Returns:	The trap_receiver_ip_address of this SNMPTrapDestination.
Return type:	IpVxAddress
	required

netapp.santricity.models.symbol.snmp_trap_destination_add_descriptor module¶

SNMPTrapDestinationAddDescriptor.py

class netapp.santricity.models.symbol.snmp_trap_destination_add_descriptor.SNMPTrapDestinationAddDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

community_ref¶

Gets the community_ref of this SNMPTrapDestinationAddDescriptor. Community associated with the trap destination

Required/optional:
Returns:	The community_ref of this SNMPTrapDestinationAddDescriptor.
Return type:	str
	required

send_authentication_failure_traps¶

Gets the send_authentication_failure_traps of this SNMPTrapDestinationAddDescriptor. Send authentication failure traps to this destination.

Required/optional:
Returns:	The send_authentication_failure_traps of this SNMPTrapDestinationAddDescriptor.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

trap_receiver_ip_address¶

Gets the trap_receiver_ip_address of this SNMPTrapDestinationAddDescriptor. IPVx address of the trap receiver

Required/optional:
Returns:	The trap_receiver_ip_address of this SNMPTrapDestinationAddDescriptor.
Return type:	IpVxAddress
	required

netapp.santricity.models.symbol.snmp_trap_destination_add_descriptor_list module¶

SNMPTrapDestinationAddDescriptorList.py

class netapp.santricity.models.symbol.snmp_trap_destination_add_descriptor_list.SNMPTrapDestinationAddDescriptorList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

trap_destination_add_descriptor¶

Gets the trap_destination_add_descriptor of this SNMPTrapDestinationAddDescriptorList. An array of trap destination add descriptors.

Required/optional:
Returns:	The trap_destination_add_descriptor of this SNMPTrapDestinationAddDescriptorList.
Return type:	list[SNMPTrapDestinationAddDescriptor]
	required

netapp.santricity.models.symbol.snmp_trap_destination_params_update_descriptor module¶

SNMPTrapDestinationParamsUpdateDescriptor.py

class netapp.santricity.models.symbol.snmp_trap_destination_params_update_descriptor.SNMPTrapDestinationParamsUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

community_ref¶

Gets the community_ref of this SNMPTrapDestinationParamsUpdateDescriptor. Community associated with the trap destination

Required/optional:
Returns:	The community_ref of this SNMPTrapDestinationParamsUpdateDescriptor.
Return type:	str
	required

send_authentication_failure_traps¶

Gets the send_authentication_failure_traps of this SNMPTrapDestinationParamsUpdateDescriptor. Send authentication failure traps to this destination.

Required/optional:
Returns:	The send_authentication_failure_traps of this SNMPTrapDestinationParamsUpdateDescriptor.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

trap_destination_ref¶

Gets the trap_destination_ref of this SNMPTrapDestinationParamsUpdateDescriptor. TrapDestination to change

Required/optional:
Returns:	The trap_destination_ref of this SNMPTrapDestinationParamsUpdateDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.snmp_trap_destination_params_update_descriptor_list module¶

SNMPTrapDestinationParamsUpdateDescriptorList.py

class netapp.santricity.models.symbol.snmp_trap_destination_params_update_descriptor_list.SNMPTrapDestinationParamsUpdateDescriptorList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

trap_destination_update_descriptor¶

Gets the trap_destination_update_descriptor of this SNMPTrapDestinationParamsUpdateDescriptorList. An array of SNMP trap destination parameters update descriptors

Required/optional:
Returns:	The trap_destination_update_descriptor of this SNMPTrapDestinationParamsUpdateDescriptorList.
Return type:	list[SNMPTrapDestinationParamsUpdateDescriptor]
	required

netapp.santricity.models.symbol.snmp_trap_destination_ref_list module¶

SNMPTrapDestinationRefList.py

class netapp.santricity.models.symbol.snmp_trap_destination_ref_list.SNMPTrapDestinationRefList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

trap_destination_ref¶

Gets the trap_destination_ref of this SNMPTrapDestinationRefList. An array of SNMP trap destination references

Required/optional:
Returns:	The trap_destination_ref of this SNMPTrapDestinationRefList.
Return type:	list[str]
	required

netapp.santricity.models.symbol.snmp_trap_destination_test_descriptor module¶

SNMPTrapDestinationTestDescriptor.py

class netapp.santricity.models.symbol.snmp_trap_destination_test_descriptor.SNMPTrapDestinationTestDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

community_name¶

Gets the community_name of this SNMPTrapDestinationTestDescriptor. Community to be sent in the test trap.

Required/optional:
Returns:	The community_name of this SNMPTrapDestinationTestDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

trap_receiver_ip_address¶

Gets the trap_receiver_ip_address of this SNMPTrapDestinationTestDescriptor. IPVx address of the trap receiver.

Required/optional:
Returns:	The trap_receiver_ip_address of this SNMPTrapDestinationTestDescriptor.
Return type:	IpVxAddress
	required

netapp.santricity.models.symbol.snmp_trap_destination_test_descriptor_list module¶

SNMPTrapDestinationTestDescriptorList.py

class netapp.santricity.models.symbol.snmp_trap_destination_test_descriptor_list.SNMPTrapDestinationTestDescriptorList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

trap_destination_test_descriptor¶

Gets the trap_destination_test_descriptor of this SNMPTrapDestinationTestDescriptorList. An array of SNMP trap destination test descriptors

Required/optional:
Returns:	The trap_destination_test_descriptor of this SNMPTrapDestinationTestDescriptorList.
Return type:	list[SNMPTrapDestinationTestDescriptor]
	required

netapp.santricity.models.symbol.soc_command_descriptor module¶

SocCommandDescriptor.py

class netapp.santricity.models.symbol.soc_command_descriptor.SocCommandDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

command¶

Gets the command of this SocCommandDescriptor. This enumeration object is used to indicate which type of statistics to return on a procedure call to get SOC error statistics.

Required/optional:
Returns:	The command of this SocCommandDescriptor.
Return type:	str
	required

local_controller¶

Gets the local_controller of this SocCommandDescriptor. This field identifies the controller that will return the SOC error statistics. It is only valid if the command field is equal to SOC_GET_CONTROLLER_TRAY.

Required/optional:
Returns:	The local_controller of this SocCommandDescriptor.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.soc_connected_device module¶

SocConnectedDevice.py

class netapp.santricity.models.symbol.soc_connected_device.SocConnectedDevice[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this SocConnectedDevice. The number of the channel where the SOC-connected device is located.

Required/optional:
Returns:	The channel of this SocConnectedDevice.
Return type:	int
	required

soc_connected_device_data¶

Gets the soc_connected_device_data of this SocConnectedDevice. This field contains, or is a reference to, data describing the SOC-connected device.

Required/optional:
Returns:	The soc_connected_device_data of this SocConnectedDevice.
Return type:	SocConnectedDeviceTypeData
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.soc_connected_device_type_data module¶

SocConnectedDeviceTypeData.py

class netapp.santricity.models.symbol.soc_connected_device_type_data.SocConnectedDeviceTypeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

alternate_controller¶

Gets the alternate_controller of this SocConnectedDeviceTypeData. This field identifies the alternate controller. It is present only if type is equal to SOC_PORT_CONTROLLER_ALTERNATE.

Required/optional:
Returns:	The alternate_controller of this SocConnectedDeviceTypeData.
Return type:	str
	optional

drawer¶

Gets the drawer of this SocConnectedDeviceTypeData. This field identifies the location of the drawer. It is only present if the type is set to SOC_PORT_DRAWER.

Required/optional:
Returns:	The drawer of this SocConnectedDeviceTypeData.
Return type:	str
	optional

drive¶

Gets the drive of this SocConnectedDeviceTypeData. This field identifies a drive. It is present only if type is equal to SOC_PORT_DRIVE.

Required/optional:
Returns:	The drive of this SocConnectedDeviceTypeData.
Return type:	str
	optional

esm¶

Gets the esm of this SocConnectedDeviceTypeData. This field identifies an ESM. It is only present if type is equal to SOC_PORT_ESM.

Required/optional:
Returns:	The esm of this SocConnectedDeviceTypeData.
Return type:	str
	optional

local_controller¶

Gets the local_controller of this SocConnectedDeviceTypeData. This field identifies the local controller. It is present only if type is equal to SOC_PORT_CONTROLLER_LOCAL.

Required/optional:
Returns:	The local_controller of this SocConnectedDeviceTypeData.
Return type:	str
	optional

physical_location¶

Gets the physical_location of this SocConnectedDeviceTypeData. This field identifies the location of an unknown device. It is only present if the type is set to SOC_PORT_UNKNOWN_DEVICE.

Required/optional:
Returns:	The physical_location of this SocConnectedDeviceTypeData.
Return type:	Location
	optional

sfp¶

Gets the sfp of this SocConnectedDeviceTypeData. This field identifies an SFP. It is only present if type is equal to SOC_PORT_SFP.

Required/optional:
Returns:	The sfp of this SocConnectedDeviceTypeData.
Return type:	str
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this SocConnectedDeviceTypeData. This enumeration object is used to identify the type of device attached to a SOC port.

Required/optional:
Returns:	The type of this SocConnectedDeviceTypeData.
Return type:	str
	required

netapp.santricity.models.symbol.soc_data module¶

SocData.py

class netapp.santricity.models.symbol.soc_data.SocData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

soc_device_data¶

Gets the soc_device_data of this SocData. Port-independent data about the SOC device.

Required/optional:
Returns:	The soc_device_data of this SocData.
Return type:	SocDeviceData
	required

soc_port_data¶

Gets the soc_port_data of this SocData. An array in which each element (one per port) contains port-dependent SOC device data.

Required/optional:
Returns:	The soc_port_data of this SocData.
Return type:	list[SocPortData]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

valid¶

Gets the valid of this SocData. Set to true if the information in this structure is valid.

Required/optional:
Returns:	The valid of this SocData.
Return type:	bool
	required

netapp.santricity.models.symbol.soc_device_data module¶

SocDeviceData.py

class netapp.santricity.models.symbol.soc_device_data.SocDeviceData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

collection_elapsed_time¶

Gets the collection_elapsed_time of this SocDeviceData. The length of the time interval, in seconds, during which the reported SOC statistics were collected.

Required/optional:
Returns:	The collection_elapsed_time of this SocDeviceData.
Return type:	int
	required

hub_mode¶

Gets the hub_mode of this SocDeviceData. Set to true if the SOC device is operating in hub mode. Otherwise it is operating in switch mode.

Required/optional:
Returns:	The hub_mode of this SocDeviceData.
Return type:	bool
	required

managed_mode¶

Gets the managed_mode of this SocDeviceData. Set to true if the SOC device is operating in managed mode. Otherwise it is operating in unmanaged mode.

Required/optional:
Returns:	The managed_mode of this SocDeviceData.
Return type:	bool
	required

parent¶

Gets the parent of this SocDeviceData. The parent (either controller or ESM) of the SOC device.

Required/optional:
Returns:	The parent of this SocDeviceData.
Return type:	SocParent
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.soc_location module¶

SocLocation.py

class netapp.santricity.models.symbol.soc_location.SocLocation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this SocLocation. The channel type.

Required/optional:
Returns:	The channel of this SocLocation.
Return type:	int
	required

channel_type¶

Gets the channel_type of this SocLocation. The channel type.

Required/optional:
Returns:	The channel_type of this SocLocation.
Return type:	str
	required

controller_slot¶

Gets the controller_slot of this SocLocation. The controller slot number, 1 or 2

Required/optional:
Returns:	The controller_slot of this SocLocation.
Return type:	int
	required

port¶

Gets the port of this SocLocation. The port number, 1-based

Required/optional:
Returns:	The port of this SocLocation.
Return type:	int
	required

soc¶

Gets the soc of this SocLocation. The SOC index, 0-based.

Required/optional:
Returns:	The soc of this SocLocation.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.soc_parent module¶

SocParent.py

class netapp.santricity.models.symbol.soc_parent.SocParent[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

parent_controller¶

Gets the parent_controller of this SocParent. A reference to the SOC device’s parent controller. This field is only present if socParentType is equal to SOC_PARENT_TYPE_CONTROLLER.

Required/optional:
Returns:	The parent_controller of this SocParent.
Return type:	str
	optional

parent_drawer¶

Gets the parent_drawer of this SocParent. A reference to the SOC device’s parent drawer. This field is only present if socParentType is equal to SOC_PARENT_TYPE_DRAWER.

Required/optional:
Returns:	The parent_drawer of this SocParent.
Return type:	str
	optional

parent_esm¶

Gets the parent_esm of this SocParent. A reference to the SOC device’s parent ESM. This field is only present if socParentType is equal to SOC_PARENT_TYPE_ESM.

Required/optional:
Returns:	The parent_esm of this SocParent.
Return type:	str
	optional

soc_parent_type¶

Gets the soc_parent_type of this SocParent. This enumeration is used to indicate the device type for the parent of a SOC device.

Required/optional:
Returns:	The soc_parent_type of this SocParent.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.soc_port_data module¶

SocPortData.py

class netapp.santricity.models.symbol.soc_port_data.SocPortData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

device¶

Gets the device of this SocPortData. Data for the Fibre Channel device connected to this SOC port.

Required/optional:
Returns:	The device of this SocPortData.
Return type:	SocConnectedDevice
	required

soc_port_diag_data¶

Gets the soc_port_diag_data of this SocPortData. The error statistics for this SOC port.

Required/optional:
Returns:	The soc_port_diag_data of this SocPortData.
Return type:	SocPortDiagnosticData
	required

soc_port_mode¶

Gets the soc_port_mode of this SocPortData. The operating mode of this SOC port.

Required/optional:
Returns:	The soc_port_mode of this SocPortData.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.soc_port_diagnostic_data module¶

SocPortDiagnosticData.py

class netapp.santricity.models.symbol.soc_port_diagnostic_data.SocPortDiagnosticData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

crc_error_count¶

Gets the crc_error_count of this SocPortDiagnosticData. The count of CRC errors.

Required/optional:
Returns:	The crc_error_count of this SocPortDiagnosticData.
Return type:	int
	required

loop_cycle_count¶

Gets the loop_cycle_count of this SocPortDiagnosticData. The number of LIPs seen by the referenced port. (valid in segmenting mode only)

Required/optional:
Returns:	The loop_cycle_count of this SocPortDiagnosticData.
Return type:	int
	required

loop_state¶

Gets the loop_state of this SocPortDiagnosticData. The state of the loop

Required/optional:
Returns:	The loop_state of this SocPortDiagnosticData.
Return type:	str
	required

loop_up_count¶

Gets the loop_up_count of this SocPortDiagnosticData. The number of times the referenced port has seen a loop-up event.

Required/optional:
Returns:	The loop_up_count of this SocPortDiagnosticData.
Return type:	int
	required

os_error_count¶

Gets the os_error_count of this SocPortDiagnosticData. The count of invalid FC transmit words seen at the receiver of the referenced port.

Required/optional:
Returns:	The os_error_count of this SocPortDiagnosticData.
Return type:	int
	required

port_connections_attempted_count¶

Gets the port_connections_attempted_count of this SocPortDiagnosticData. The number of times a port has attempted make a connection due to ARB connection requests. (valid in segmenting mode only)

Required/optional:
Returns:	The port_connections_attempted_count of this SocPortDiagnosticData.
Return type:	int
	required

port_connections_held_off_count¶

Gets the port_connections_held_off_count of this SocPortDiagnosticData. The count of times this port has attempted to make a connection and was held off by a busy port. (valid in segmenting mode only)

Required/optional:
Returns:	The port_connections_held_off_count of this SocPortDiagnosticData.
Return type:	int
	required

port_insertion_count¶

Gets the port_insertion_count of this SocPortDiagnosticData. The number of times the port has been inserted.

Required/optional:
Returns:	The port_insertion_count of this SocPortDiagnosticData.
Return type:	int
	required

port_state¶

Gets the port_state of this SocPortDiagnosticData. The current state of the port.

Required/optional:
Returns:	The port_state of this SocPortDiagnosticData.
Return type:	str
	required

port_utilization¶

Gets the port_utilization of this SocPortDiagnosticData. The port utilization seen on the referenced port. The value returned is either the percent of time that frames are seen on the port, or the percent of time that a port is used during switching mode operation when the SOC is operating in the switching mode. Range 0 to 200, 0.5% per bit scale. (valid in segmenting mode only)

Required/optional:
Returns:	The port_utilization of this SocPortDiagnosticData.
Return type:	int
	required

relative_frequency_drift_error_average¶

Gets the relative_frequency_drift_error_average of this SocPortDiagnosticData. The difference, in PPM, between the port received data rate and the internal clock of the SOC.

Required/optional:
Returns:	The relative_frequency_drift_error_average of this SocPortDiagnosticData.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.soc_statistics module¶

SocStatistics.py

class netapp.santricity.models.symbol.soc_statistics.SocStatistics[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

soc_data¶

Gets the soc_data of this SocStatistics. An array in which each element (one per SOC device) contains SOC error statistics information.

Required/optional:
Returns:	The soc_data of this SocStatistics.
Return type:	list[SocData]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.soc_statistics_returned module¶

SocStatisticsReturned.py

class netapp.santricity.models.symbol.soc_statistics_returned.SocStatisticsReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

return_code¶

Gets the return_code of this SocStatisticsReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this SocStatisticsReturned.
Return type:	str
	required

soc_statistics¶

Gets the soc_statistics of this SocStatisticsReturned. This field contains the SOC statistics. It is only valid if the returnCode field is equal to RETCODE_OK.

Required/optional:
Returns:	The soc_statistics of this SocStatisticsReturned.
Return type:	SocStatistics
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.specific_database_metadata module¶

SpecificDatabaseMetadata.py

class netapp.santricity.models.symbol.specific_database_metadata.SpecificDatabaseMetadata[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

controller_ref¶

Gets the controller_ref of this SpecificDatabaseMetadata. A reference to the controller. This is unused if the dbLocation field is DACSTORE_DISKS.

Required/optional:
Returns:	The controller_ref of this SpecificDatabaseMetadata.
Return type:	str
	required

db_access¶

Gets the db_access of this SpecificDatabaseMetadata. The database accessibility mode.

Required/optional:
Returns:	The db_access of this SpecificDatabaseMetadata.
Return type:	str
	required

db_gen_number¶

Gets the db_gen_number of this SpecificDatabaseMetadata. The database gen number.

Required/optional:
Returns:	The db_gen_number of this SpecificDatabaseMetadata.
Return type:	int
	required

db_id¶

Gets the db_id of this SpecificDatabaseMetadata. The database ID.

Required/optional:
Returns:	The db_id of this SpecificDatabaseMetadata.
Return type:	str
	required

db_location¶

Gets the db_location of this SpecificDatabaseMetadata. The physical location of the database image.

Required/optional:
Returns:	The db_location of this SpecificDatabaseMetadata.
Return type:	str
	required

db_revision¶

Gets the db_revision of this SpecificDatabaseMetadata. The database revision.

Required/optional:
Returns:	The db_revision of this SpecificDatabaseMetadata.
Return type:	str
	required

db_status¶

Gets the db_status of this SpecificDatabaseMetadata. The database status.

Required/optional:
Returns:	The db_status of this SpecificDatabaseMetadata.
Return type:	str
	required

disk_pool_id¶

Gets the disk_pool_id of this SpecificDatabaseMetadata. The disk pool ID (volume group WWN hash).

Required/optional:
Returns:	The disk_pool_id of this SpecificDatabaseMetadata.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.speed_neg_error module¶

SpeedNegError.py

class netapp.santricity.models.symbol.speed_neg_error.SpeedNegError[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

channel¶

Gets the channel of this SpeedNegError. The channel number.

Required/optional:
Returns:	The channel of this SpeedNegError.
Return type:	int
	required

parent_ref¶

Gets the parent_ref of this SpeedNegError. The controller reference.

Required/optional:
Returns:	The parent_ref of this SpeedNegError.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ssd_wear_life module¶

SSDWearLife.py

class netapp.santricity.models.symbol.ssd_wear_life.SSDWearLife[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

average_erase_count_percent¶

Gets the average_erase_count_percent of this SSDWearLife. The percentage of average erase count.

Required/optional:
Returns:	The average_erase_count_percent of this SSDWearLife.
Return type:	int
	required

is_wear_life_monitoring_supported¶

Gets the is_wear_life_monitoring_supported of this SSDWearLife. This field is set to true if wear life monitoring is supported on the drive. If true then the values in the other fields in this structure are valid, otherwise they are not valid.

Required/optional:
Returns:	The is_wear_life_monitoring_supported of this SSDWearLife.
Return type:	bool
	required

spare_blocks_remaining_percent¶

Gets the spare_blocks_remaining_percent of this SSDWearLife. The percentage of spare blocks remaining in the solid state drive. Controller firmware checks and updates this percentage approximately once per hour.

Required/optional:
Returns:	The spare_blocks_remaining_percent of this SSDWearLife.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.staged_firmware module¶

StagedFirmware.py

class netapp.santricity.models.symbol.staged_firmware.StagedFirmware[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

app_version¶

Gets the app_version of this StagedFirmware. The application code version number.

Required/optional:
Returns:	The app_version of this StagedFirmware.
Return type:	str
	required

boot_version¶

Gets the boot_version of this StagedFirmware. The boot code version number.

Required/optional:
Returns:	The boot_version of this StagedFirmware.
Return type:	str
	required

code_versions¶

Gets the code_versions of this StagedFirmware. Version descriptors for staged code modules

Required/optional:
Returns:	The code_versions of this StagedFirmware.
Return type:	list[VersionDescriptor]
	required

fw_version¶

Gets the fw_version of this StagedFirmware. The firmware package version identifier.

Required/optional:
Returns:	The fw_version of this StagedFirmware.
Return type:	str
	required

nvsram_version¶

Gets the nvsram_version of this StagedFirmware. The NVSRAM version number.

Required/optional:
Returns:	The nvsram_version of this StagedFirmware.
Return type:	str
	required

nvsram_version_string¶

Gets the nvsram_version_string of this StagedFirmware. The field is deprecated. The nvsramVersion field should be used instead.

Required/optional:
Returns:	The nvsram_version_string of this StagedFirmware.
Return type:	str
	required

staged_fw_valid¶

Gets the staged_fw_valid of this StagedFirmware. False, staged FW areas on the controllers are not valid and cannot be activated. True, the staged FW areas on the controllers are valid and can be activated.

Required/optional:
Returns:	The staged_fw_valid of this StagedFirmware.
Return type:	bool
	required

time_stamp¶

Gets the time_stamp of this StagedFirmware. Timestamp when the staged FW was downloaded

Required/optional:
Returns:	The time_stamp of this StagedFirmware.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.stat_stream_id_returned module¶

StatStreamIdReturned.py

class netapp.santricity.models.symbol.stat_stream_id_returned.StatStreamIdReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

return_code¶

Gets the return_code of this StatStreamIdReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this StatStreamIdReturned.
Return type:	str
	required

stream_id¶

Gets the stream_id of this StatStreamIdReturned. An unique identifier for the stream set that was activated. This field is only valid if returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The stream_id of this StatStreamIdReturned.
Return type:	int
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.statistical_container module¶

StatisticalContainer.py

class netapp.santricity.models.symbol.statistical_container.StatisticalContainer[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

qualifier¶

Gets the qualifier of this StatisticalContainer.

Required/optional:
Returns:	The qualifier of this StatisticalContainer.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

value¶

Gets the value of this StatisticalContainer.

Required/optional:
Returns:	The value of this StatisticalContainer.
Return type:	int
	required

netapp.santricity.models.symbol.statistical_time_data module¶

StatisticalTimeData.py

class netapp.santricity.models.symbol.statistical_time_data.StatisticalTimeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

current_time¶

Gets the current_time of this StatisticalTimeData. The time of reporting the statistics.

Required/optional:
Returns:	The current_time of this StatisticalTimeData.
Return type:	int
	required

start_time¶

Gets the start_time of this StatisticalTimeData. The most recent baseline time set for the reported statistics.

Required/optional:
Returns:	The start_time of this StatisticalTimeData.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.storage_array module¶

StorageArray.py

class netapp.santricity.models.symbol.storage_array.StorageArray[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

access_volume¶

Gets the access_volume of this StorageArray. Information about the access volume that is used to convey configuration commands (via the UTM protocol) to the controllers within the storage array.

Required/optional:
Returns:	The access_volume of this StorageArray.
Return type:	AccessVolume
	required

asup_enabled¶

Gets the asup_enabled of this StorageArray. True if Autosupport is enabled.

Required/optional:
Returns:	The asup_enabled of this StorageArray.
Return type:	bool
	required

asup_on_demand_enabled¶

Gets the asup_on_demand_enabled of this StorageArray. True if Autosupport On Demand is enabled.

Required/optional:
Returns:	The asup_on_demand_enabled of this StorageArray.
Return type:	bool
	required

asup_remote_diags_enabled¶

Gets the asup_remote_diags_enabled of this StorageArray. True if Autosupport On Demand Remote Diagnostics is enabled.

Required/optional:
Returns:	The asup_remote_diags_enabled of this StorageArray.
Return type:	bool
	required

auto_load_balancing_enabled¶

Gets the auto_load_balancing_enabled of this StorageArray. Auto Load Balancing is user-enabled on this array

Required/optional:
Returns:	The auto_load_balancing_enabled of this StorageArray.
Return type:	bool
	required

cache¶

Gets the cache of this StorageArray. Information about cache settings that apply to the storage array as a whole.

Required/optional:
Returns:	The cache of this StorageArray.
Return type:	SACache
	required

capabilities¶

Gets the capabilities of this StorageArray. A variable-length array that provides an enumeration of the high-level capabilities that are supported by the controllers that reside within the storage array.

Required/optional:
Returns:	The capabilities of this StorageArray.
Return type:	list[str]
	required

channel_port_locations¶

Gets the channel_port_locations of this StorageArray. A list of all channel ports in the storage array, including host channel ports, drive channel ports, and ESM channel ports.

Required/optional:
Returns:	The channel_port_locations of this StorageArray.
Return type:	list[ChannelPort]
	required

compatibility¶

Gets the compatibility of this StorageArray. A variable-length array of firmware compatibility specifiers. These values generally identify certain levels of firmware that are allowed for downgrading the current storage array firmware.

Required/optional:
Returns:	The compatibility of this StorageArray.
Return type:	list[CompatibleFirmware]
	required

ddc_tag¶

Gets the ddc_tag of this StorageArray. The tag value to be used in retrieving DDC log data. A value of DDC_NULL_TAG indicates there is no DDC log data to retrieve.

Required/optional:
Returns:	The ddc_tag of this StorageArray.
Return type:	int
	required

default_host_port_type_index¶

Gets the default_host_port_type_index of this StorageArray. The Host Port Type Index to use for undefined and newly created host ports. The defaultHostPortTypeIndex can only be set if Storage Partitions are disabled through the SYMbol Interface.

Required/optional:
Returns:	The default_host_port_type_index of this StorageArray.
Return type:	int
	required

default_host_type_index¶

Gets the default_host_type_index of this StorageArray. The Host Type Index to use for undefined and newly created host ports.

Required/optional:
Returns:	The default_host_type_index of this StorageArray.
Return type:	int
	required

defined_partition_count¶

Gets the defined_partition_count of this StorageArray. The number of partitions calculated from the user’s current mappings.

Required/optional:
Returns:	The defined_partition_count of this StorageArray.
Return type:	int
	required

direct_expansion_port_in_use¶

Gets the direct_expansion_port_in_use of this StorageArray. This boolean is true if direct expansion ports are in use by the controllers.

Required/optional:
Returns:	The direct_expansion_port_in_use of this StorageArray.
Return type:	bool
	required

dpl_core_dump_data¶

Gets the dpl_core_dump_data of this StorageArray. Information about a core dump in controller memory, if one exists.

Required/optional:
Returns:	The dpl_core_dump_data of this StorageArray.
Return type:	DPLCoreDumpData
	required

drive_channel_port_disabled¶

Gets the drive_channel_port_disabled of this StorageArray. True if one or more drive channel ports have been disabled by the controllers to protect against faulty expansion cabling. This could have been necessitated by a miswire condition or by a bad expansion cable. Check the Recovery Events for an indication of which connection(s) have been disabled and correct the cabling as required.

Required/optional:
Returns:	The drive_channel_port_disabled of this StorageArray.
Return type:	bool
	required

drive_channels¶

Gets the drive_channels of this StorageArray. A list of drive channel structures.

Required/optional:
Returns:	The drive_channels of this StorageArray.
Return type:	list[DriveChannel]
	required

fc_rvm_state¶

Gets the fc_rvm_state of this StorageArray. Indicator of whether fibre channel remote mirroring has been enabled, and if so, whether it is enabled for use by legacy (synchronous) mirroring or ARVM. If this is set to something other than FC_MIRROR_STATE_DISABLED or FC_MIRROR_STATE_UNKNOWN, then the rvmControllerHostChannel field can be used to determine the particular host channel reserved for remote mirroring.

Required/optional:
Returns:	The fc_rvm_state of this StorageArray.
Return type:	str
	required

feature_bundle¶

Gets the feature_bundle of this StorageArray. A structure describing the features and feature limits that are associated with this storage array product.

Required/optional:
Returns:	The feature_bundle of this StorageArray.
Return type:	FeatureBundle
	required

feature_parameters¶

Gets the feature_parameters of this StorageArray. An object that provides information about the parameters and limits of certain functions that are supported by the controllers that reside within the storage array.

Required/optional:
Returns:	The feature_parameters of this StorageArray.
Return type:	FeatureParams
	required

feature_state¶

Gets the feature_state of this StorageArray. An array describing the current state of the array feature set - one element in the array per feature. This array is used by host software to track feature licensing compliance. It is populated with all supported features having both a feature ID and a capability code, regardless of their enabled or compliance state. Features that are not supported because of gold key restrictions or because there is no way to enable them (i.e., both SHIPPED_ENABLED and KEY_ENABLED are false) are not in the list.

Required/optional:
Returns:	The feature_state of this StorageArray.
Return type:	list[FeatureState]
	required

high_resolution_statistics_enabled¶

Gets the high_resolution_statistics_enabled of this StorageArray. Cumulative Performance stats high resolution indicator

Required/optional:
Returns:	The high_resolution_statistics_enabled of this StorageArray.
Return type:	bool
	required

host_port_type¶

Gets the host_port_type of this StorageArray. This variable-length array has label values that provide descriptive strings for each supported index value that can appear in the HostPort object and its associated elements.

Required/optional:
Returns:	The host_port_type of this StorageArray.
Return type:	list[str]
	required

host_specific_vals¶

Gets the host_specific_vals of this StorageArray. The values from the heterogeneous host regions. Each element in this array corresponds to a type in the hostPortType array, and the ordering of the types in this array matches that of the hostPortType array, i.e., hostPortType[i] is equal to hostSpecificVals[i].hostPortType.

Required/optional:
Returns:	The host_specific_vals of this StorageArray.
Return type:	list[HostSpecificValues]
	required

host_type¶

Gets the host_type of this StorageArray. This variable-length array has label values that provide descriptive strings for each supported index value that can appear in the Host object. Zero-length strings are allowed and indicate that the associated host-specific NVSRAM regions have been cleared. This field should be used in place of the deprecated hostPortType field.

Required/optional:
Returns:	The host_type of this StorageArray.
Return type:	list[str]
	required

invalid_system_config¶

Gets the invalid_system_config of this StorageArray. True if the storage array has an invalid system configuration; otherwise false.

Required/optional:
Returns:	The invalid_system_config of this StorageArray.
Return type:	bool
	required

ioc_dump_data¶

Gets the ioc_dump_data of this StorageArray. Information about an IOC Dump in controller memory, if one exists.

Required/optional:
Returns:	The ioc_dump_data of this StorageArray.
Return type:	IOCDumpData
	required

iscsi_entity_data¶

Gets the iscsi_entity_data of this StorageArray. Information about the storage array pertaining to its role as an iSCSI entity.

Required/optional:
Returns:	The iscsi_entity_data of this StorageArray.
Return type:	IscsiEntityData
	required

lock_key_id_ref¶

Gets the lock_key_id_ref of this StorageArray. The lock key ID for the storage array.

Required/optional:
Returns:	The lock_key_id_ref of this StorageArray.
Return type:	str
	required

lock_key_needed_list¶

Gets the lock_key_needed_list of this StorageArray. Contains the lock key IDs of keys needed by the array controller.

Required/optional:
Returns:	The lock_key_needed_list of this StorageArray.
Return type:	list[str]
	required

media_scan_period¶

Gets the media_scan_period of this StorageArray. The current value of the media scan period parameter for the storage array. This value indicates the number of days over which a complete scan of the media will occur. The array controller(s) will attempt to achieve this configured period on a best-effort basis, but certain operational factors may cause slight deviations from the configured value.

Required/optional:
Returns:	The media_scan_period of this StorageArray.
Return type:	int
	required

new_key_sequence¶

Gets the new_key_sequence of this StorageArray. Sequence number used to serialize installNewKey requests from multiple proxy key management SYMbol servers.

Required/optional:
Returns:	The new_key_sequence of this StorageArray.
Return type:	int
	required

odxenabled¶

Gets the odxenabled of this StorageArray.

Required/optional:
Returns:	The odxenabled of this StorageArray.
Return type:	bool
	optional

port_locations¶

Gets the port_locations of this StorageArray. A list of drive channel port locations.

Required/optional:
Returns:	The port_locations of this StorageArray.
Return type:	list[DriveChannelPort]
	required

premium_features¶

Gets the premium_features of this StorageArray. An object that provides information about the premium features that are currently enabled. This field is deprecated. The featureBundle and featureState fields can be used in its place to obtain information about how features are defined and the state they are in.

Required/optional:
Returns:	The premium_features of this StorageArray.
Return type:	list[PremiumFeature]
	required

remote_access_id¶

Gets the remote_access_id of this StorageArray. Array-specific ID used for remote device discovery.

Required/optional:
Returns:	The remote_access_id of this StorageArray.
Return type:	str
	required

remote_mirroring_active¶

Gets the remote_mirroring_active of this StorageArray. True if RVM is activated.

Required/optional:
Returns:	The remote_mirroring_active of this StorageArray.
Return type:	bool
	required

reserved1¶

Gets the reserved1 of this StorageArray.

Required/optional:
Returns:	The reserved1 of this StorageArray.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this StorageArray.

Required/optional:
Returns:	The reserved2 of this StorageArray.
Return type:	str
	optional

rvm_controller_host_channel¶

Gets the rvm_controller_host_channel of this StorageArray. The number (in the range 1 through n, where n is the number of host ports on an individual controller) of the controller host channel that the firmware uses for remote volume mirroring. This field is set to zero when the data is unavailable or not applicable, including when the RVM feature is disabled,

Required/optional:
Returns:	The rvm_controller_host_channel of this StorageArray.
Return type:	int
	required

sa_data¶

Gets the sa_data of this StorageArray. General information and characteristics of the storage array.

Required/optional:
Returns:	The sa_data of this StorageArray.
Return type:	SAData
	required

safe_id¶

Gets the safe_id of this StorageArray. This field contains a unique identifier maintained by SAFE for use by storage management software. Storage management software uses this data to enable SAFE features and perform Feature Bundle migration.

Required/optional:
Returns:	The safe_id of this StorageArray.
Return type:	SAIdentifier
	required

security_external_kms_enable¶

Gets the security_external_kms_enable of this StorageArray. True if external key management is in effect and false if controller is using local key management.

Required/optional:
Returns:	The security_external_kms_enable of this StorageArray.
Return type:	bool
	required

security_external_kms_key_status¶

Gets the security_external_kms_key_status of this StorageArray. The controller’s current key status. If external key management not enabled, set to EXTERNAL_KMS_KEY_STATUS_OK.

Required/optional:
Returns:	The security_external_kms_key_status of this StorageArray.
Return type:	str
	required

security_lock_key¶

Gets the security_lock_key of this StorageArray. A boolean which describes the current state of the lock key. True if the array lock key has been set, otherwise false.

Required/optional:
Returns:	The security_lock_key of this StorageArray.
Return type:	bool
	required

smart_battery_data¶

Gets the smart_battery_data of this StorageArray. sub-structure of StorageArray contains info relating to smart battery configuration. Meaningful if the smartBatteryTechnology field in the featureParameters sub-structure is set to true. Moved to the Battery object instead to support per-battery reporting

Required/optional:
Returns:	The smart_battery_data of this StorageArray.
Return type:	SmartBatteryData
	required

staged_firmware¶

Gets the staged_firmware of this StorageArray. Information on possible staged controller firmware.

Required/optional:
Returns:	The staged_firmware of this StorageArray.
Return type:	StagedFirmware
	required

syslog_configuration¶

Gets the syslog_configuration of this StorageArray. This field contains the configuration information used by the storage array for writing MEL events to a syslog server.

Required/optional:
Returns:	The syslog_configuration of this StorageArray.
Return type:	SyslogConfiguration
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray_position_list¶

Gets the tray_position_list of this StorageArray. A list of tray positions that provides information to the client of the SYMbol interface about the relative physical positions of the trays (i.e. enclosures) that comprise the storage array. In the current implementation of the SYMbol interface, the client is responsible for providing this information to the controller for long-term storage, and also for retrieving it from the controller via this object. That is, the controller does not initially contain a valid tray position list; in fact, the default is an empty list. The client is responsible for obtaining any pertinent information about tray positions via an appropriate external mechanism, and then informing the controller about it via the setSATrayPositions procedure. Once this is done, the controller will always return the position information as part of the StorageArray object.

Required/optional:
Returns:	The tray_position_list of this StorageArray.
Return type:	TrayPositionList
	required

unreadable_sectors¶

Gets the unreadable_sectors of this StorageArray. Storage array unreadable sector count and max limit.

Required/optional:
Returns:	The unreadable_sectors of this StorageArray.
Return type:	UnreadableSectors
	required

usage_hints¶

Gets the usage_hints of this StorageArray. The recommended usage parameter combinations.

Required/optional:
Returns:	The usage_hints of this StorageArray.
Return type:	list[VolumeUsageHint]
	required

vaaienabled¶

Gets the vaaienabled of this StorageArray.

Required/optional:
Returns:	The vaaienabled of this StorageArray.
Return type:	bool
	optional

vol_xfer_alert_delay_period¶

Gets the vol_xfer_alert_delay_period of this StorageArray. Volume transfer alert delay period.

Required/optional:
Returns:	The vol_xfer_alert_delay_period of this StorageArray.
Return type:	int
	required

netapp.santricity.models.symbol.storage_array_changeable_properties module¶

StorageArrayChangeableProperties.py

class netapp.santricity.models.symbol.storage_array_changeable_properties.StorageArrayChangeableProperties[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

default_host_type_index¶

Gets the default_host_type_index of this StorageArrayChangeableProperties. The new value to set for the storage array default host type index.

Required/optional:
Returns:	The default_host_type_index of this StorageArrayChangeableProperties.
Return type:	list[int]
	required

next_battery_learn_cycle¶

Gets the next_battery_learn_cycle of this StorageArrayChangeableProperties. The new value to apply for the nextBatteryLearnCycle property in the StorageArray structure. This value is expressed as seconds since midnight GMT, January 1, 1970. This field is only applicable if the smartBatteryTechnology Boolean in FeatureParams is set to true. The array will return an error if an attempt is made to set this time more than seven days later than the current scheduled time.

Required/optional:
Returns:	The next_battery_learn_cycle of this StorageArrayChangeableProperties.
Return type:	list[int]
	required

syslog_enabled¶

Gets the syslog_enabled of this StorageArrayChangeableProperties. The new value for the storage array setting that controls whether or not syslog server notification of MEL events is enabled or not.

Required/optional:
Returns:	The syslog_enabled of this StorageArrayChangeableProperties.
Return type:	list[bool]
	required

syslog_server_ip_address¶

Gets the syslog_server_ip_address of this StorageArrayChangeableProperties. The new value to set for the IP address of the syslog server.

Required/optional:
Returns:	The syslog_server_ip_address of this StorageArrayChangeableProperties.
Return type:	list[IpVxAddress]
	required

syslog_server_port_number¶

Gets the syslog_server_port_number of this StorageArrayChangeableProperties. The new value to set for the UDP port number of the syslog server..

Required/optional:
Returns:	The syslog_server_port_number of this StorageArrayChangeableProperties.
Return type:	list[int]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.storage_array_properties_update_descriptor module¶

StorageArrayPropertiesUpdateDescriptor.py

class netapp.santricity.models.symbol.storage_array_properties_update_descriptor.StorageArrayPropertiesUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

settings¶

Gets the settings of this StorageArrayPropertiesUpdateDescriptor. The new settings for the storage array.

Required/optional:
Returns:	The settings of this StorageArrayPropertiesUpdateDescriptor.
Return type:	StorageArrayChangeableProperties
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.storage_pool_bundle module¶

StoragePoolBundle.py

class netapp.santricity.models.symbol.storage_pool_bundle.StoragePoolBundle[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cluster¶

Gets the cluster of this StoragePoolBundle. A variable-length array containing all defined Cluster objects for the storage array configuration.

Required/optional:
Returns:	The cluster of this StoragePoolBundle.
Return type:	list[Cluster]
	required

host¶

Gets the host of this StoragePoolBundle. A variable-length array containing all defined Host objects for the storage array configuration.

Required/optional:
Returns:	The host of this StoragePoolBundle.
Return type:	list[Host]
	required

host_port¶

Gets the host_port of this StoragePoolBundle. A variable-length array containing all defined HostPort objects for the storage array configuration.

Required/optional:
Returns:	The host_port of this StoragePoolBundle.
Return type:	list[HostPort]
	required

initiator¶

Gets the initiator of this StoragePoolBundle. A variable-length array containing all Initiator objects defined in the storage array configuration.

Required/optional:
Returns:	The initiator of this StoragePoolBundle.
Return type:	list[Initiator]
	required

lun_mapping¶

Gets the lun_mapping of this StoragePoolBundle. A variable-length array containing all defined LUNMapping objects for the storage array configuration.

Required/optional:
Returns:	The lun_mapping of this StoragePoolBundle.
Return type:	list[LUNMapping]
	required

remote_target¶

Gets the remote_target of this StoragePoolBundle. A variable-length array containing all Remote Target objects defined in the storage array configuration. Remote Target objects define the initiator/target on a remote array.

Required/optional:
Returns:	The remote_target of this StoragePoolBundle.
Return type:	list[RemoteTarget]
	required

sa_port¶

Gets the sa_port of this StoragePoolBundle. A variable-length array containing all SAPortGroup objects that are currently configured and available.

Required/optional:
Returns:	The sa_port of this StoragePoolBundle.
Return type:	list[SAPort]
	required

sa_port_group¶

Gets the sa_port_group of this StoragePoolBundle. A variable-length array containing all SAPortGroup objects that are currently configured and available.

Required/optional:
Returns:	The sa_port_group of this StoragePoolBundle.
Return type:	list[SAPortGroup]
	required

target¶

Gets the target of this StoragePoolBundle. A variable-length array containing all Target objects defined in the storage array configuration.

Required/optional:
Returns:	The target of this StoragePoolBundle.
Return type:	list[Target]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.support_cru module¶

SupportCRU.py

class netapp.santricity.models.symbol.support_cru.SupportCRU[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

configured_components¶

Gets the configured_components of this SupportCRU. A variable-length list of the types of components that occupy the support CRU.

Required/optional:
Returns:	The configured_components of this SupportCRU.
Return type:	list[str]
	required

fru_type¶

Gets the fru_type of this SupportCRU. VPD field replaceable unit type.

Required/optional:
Returns:	The fru_type of this SupportCRU.
Return type:	str
	required

id¶

Gets the id of this SupportCRU.

Required/optional:
Returns:	The id of this SupportCRU.
Return type:	str
	optional

manufacturer_date¶

Gets the manufacturer_date of this SupportCRU. VPD manufacture date.

Required/optional:
Returns:	The manufacturer_date of this SupportCRU.
Return type:	int
	required

physical_location¶

Gets the physical_location of this SupportCRU. The physical location of the support CRU. The parent reference in Location identifies the tray containing the CRU, and the position field is the parent-relative/like-component relative slot number of the CRU, starting at one.

Required/optional:
Returns:	The physical_location of this SupportCRU.
Return type:	Location
	required

ready_to_remove¶

Gets the ready_to_remove of this SupportCRU. When set to True, the component is ready to remove (and the Ready to Remove indicator light is turned on). This field is deprecated. The rtrAttributes field should be used instead.

Required/optional:
Returns:	The ready_to_remove of this SupportCRU.
Return type:	bool
	required

repair_policy¶

Gets the repair_policy of this SupportCRU. The repair policy for the support CRU component.

Required/optional:
Returns:	The repair_policy of this SupportCRU.
Return type:	RepairPolicy
	required

rtr_attributes¶

Gets the rtr_attributes of this SupportCRU. The CRU type of the support CRU plus its ready-to-remove attributes, which are based on the CRU type.

Required/optional:
Returns:	The rtr_attributes of this SupportCRU.
Return type:	RTRAttributes
	required

status¶

Gets the status of this SupportCRU. The operational status of the support CRU.

Required/optional:
Returns:	The status of this SupportCRU.
Return type:	str
	required

support_cru_ref¶

Gets the support_cru_ref of this SupportCRU. The reference for this physical support CRU.

Required/optional:
Returns:	The support_cru_ref of this SupportCRU.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this SupportCRU. The type of this support CRU (e.g., “power-fan” or “battery”)

Required/optional:
Returns:	The type of this SupportCRU.
Return type:	str
	required

vendor_name¶

Gets the vendor_name of this SupportCRU. VPD vendor name.

Required/optional:
Returns:	The vendor_name of this SupportCRU.
Return type:	str
	required

vendor_pn¶

Gets the vendor_pn of this SupportCRU. VPD part number.

Required/optional:
Returns:	The vendor_pn of this SupportCRU.
Return type:	str
	required

vendor_sn¶

Gets the vendor_sn of this SupportCRU. VPD serial number.

Required/optional:
Returns:	The vendor_sn of this SupportCRU.
Return type:	str
	required

netapp.santricity.models.symbol.sy_mbol_ref_pair module¶

SYMbolRefPair.py

class netapp.santricity.models.symbol.sy_mbol_ref_pair.SYMbolRefPair[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

container_ref¶

Gets the container_ref of this SYMbolRefPair. The SYMbol reference value of the container of the item identified by the itemRef field.

Required/optional:
Returns:	The container_ref of this SYMbolRefPair.
Return type:	str
	required

item_ref¶

Gets the item_ref of this SYMbolRefPair. The SYMbol reference value of the item in question.

Required/optional:
Returns:	The item_ref of this SYMbolRefPair.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.sy_mbol_ref_with_ual module¶

SYMbolRefWithUAL.py

class netapp.santricity.models.symbol.sy_mbol_ref_with_ual.SYMbolRefWithUAL[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

label¶

Gets the label of this SYMbolRefWithUAL. The user-assigned label (typically a modified one) for the object in question.

Required/optional:
Returns:	The label of this SYMbolRefWithUAL.
Return type:	str
	required

ref¶

Gets the ref of this SYMbolRefWithUAL. The SYMbol reference value of the object on which the operation is to be performed.

Required/optional:
Returns:	The ref of this SYMbolRefWithUAL.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.syslog_configuration module¶

SyslogConfiguration.py

class netapp.santricity.models.symbol.syslog_configuration.SyslogConfiguration[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

syslog_enabled¶

Gets the syslog_enabled of this SyslogConfiguration. This field is set to true if the writing of MEL events to a syslog server is enabled; otherwise it is false.

Required/optional:
Returns:	The syslog_enabled of this SyslogConfiguration.
Return type:	bool
	required

syslog_server_ip_address¶

Gets the syslog_server_ip_address of this SyslogConfiguration. This field holds the IPVx address of the syslog server. The default value of this field is zero (0.0.0.0).

Required/optional:
Returns:	The syslog_server_ip_address of this SyslogConfiguration.
Return type:	IpVxAddress
	required

syslog_server_port_number¶

Gets the syslog_server_port_number of this SyslogConfiguration. This field holds the UDP port number of the syslog server. The default value of this field is SYSLOG_DEFAULT_UDP_PORT.

Required/optional:
Returns:	The syslog_server_port_number of this SyslogConfiguration.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.system_attribute_defaults module¶

SystemAttributeDefaults.py

class netapp.santricity.models.symbol.system_attribute_defaults.SystemAttributeDefaults[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

arvm_default_attributes¶

Gets the arvm_default_attributes of this SystemAttributeDefaults. Default ARVM feature attributes.

Required/optional:
Returns:	The arvm_default_attributes of this SystemAttributeDefaults.
Return type:	ARVMDefaultAttributes
	required

concat_default_attributes¶

Gets the concat_default_attributes of this SystemAttributeDefaults. Default ConcatVolume feature attributes.

Required/optional:
Returns:	The concat_default_attributes of this SystemAttributeDefaults.
Return type:	ConcatVolumeDefaultAttributes
	required

disk_pool_default_attributes¶

Gets the disk_pool_default_attributes of this SystemAttributeDefaults. Default Disk Pool feature attributes.

Required/optional:
Returns:	The disk_pool_default_attributes of this SystemAttributeDefaults.
Return type:	DiskPoolDefaultAttributes
	required

pit_groups_default_attributes¶

Gets the pit_groups_default_attributes of this SystemAttributeDefaults. Default PiT Groups feature attributes.

Required/optional:
Returns:	The pit_groups_default_attributes of this SystemAttributeDefaults.
Return type:	PITGroupsDefaultAttributes
	required

snmp_agent_default_attributes¶

Gets the snmp_agent_default_attributes of this SystemAttributeDefaults. Default/maximum attributes for the embedded SNMP agent.

Required/optional:
Returns:	The snmp_agent_default_attributes of this SystemAttributeDefaults.
Return type:	EmbeddedSNMPAgentDefaultAttributes
	required

statistics_default_attributes¶

Gets the statistics_default_attributes of this SystemAttributeDefaults. Specifies the low and high statistical sampling attributes supported by this array.

Required/optional:
Returns:	The statistics_default_attributes of this SystemAttributeDefaults.
Return type:	CumulativeStatisticsDefaultAttributes
	required

thin_vol_default_attributes¶

Gets the thin_vol_default_attributes of this SystemAttributeDefaults. Default Thin Volume feature attributes.

Required/optional:
Returns:	The thin_vol_default_attributes of this SystemAttributeDefaults.
Return type:	ThinVolumeDefaultAttributes
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.system_attribute_defaults_returned module¶

SystemAttributeDefaultsReturned.py

class netapp.santricity.models.symbol.system_attribute_defaults_returned.SystemAttributeDefaultsReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

defaults¶

Gets the defaults of this SystemAttributeDefaultsReturned. The Disk Pool default attributes. This field is present only if the value of returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The defaults of this SystemAttributeDefaultsReturned.
Return type:	SystemAttributeDefaults
	optional

return_code¶

Gets the return_code of this SystemAttributeDefaultsReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this SystemAttributeDefaultsReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.target module¶

Target.py

class netapp.santricity.models.symbol.target.Target[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

alias¶

Gets the alias of this Target. An additional name that can be assigned to a target, which is usually “friendlier” than the node name.

Required/optional:
Returns:	The alias of this Target.
Return type:	ScsiAlias
	required

configured_auth_methods¶

Gets the configured_auth_methods of this Target. The authentication methods that have been configured for the target. Associated secrets are not exposed. instead the type field of the EncryptedPassword is set to ENCRYPT_UNSPECIFIED.

Required/optional:
Returns:	The configured_auth_methods of this Target.
Return type:	AuthenticationBundle
	required

node_name¶

Gets the node_name of this Target. The unique node name associated with the target.

Required/optional:
Returns:	The node_name of this Target.
Return type:	ScsiNodeName
	required

portals¶

Gets the portals of this Target. The set of configured (i.e., either in-use or listening for connections) portals associated with this target.

Required/optional:
Returns:	The portals of this Target.
Return type:	list[TargetPortal]
	required

target_ref¶

Gets the target_ref of this Target. The reference that uniquely identifies an instance of this object.

Required/optional:
Returns:	The target_ref of this Target.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.target_changeable_properties module¶

TargetChangeableProperties.py

class netapp.santricity.models.symbol.target_changeable_properties.TargetChangeableProperties[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

alias¶

Gets the alias of this TargetChangeableProperties. The alias name of the target.

Required/optional:
Returns:	The alias of this TargetChangeableProperties.
Return type:	list[ScsiAlias]
	required

configured_auth_methods¶

Gets the configured_auth_methods of this TargetChangeableProperties. The set of the authentication methods for the target. This field replaces all existing authentication methods; depending on how the caller populates the list, authentication methods may be added, deleted, or modified. Secrets associated with authentication methods may be modified in this manner. The way to indicate that there is no password is to set the length indicator on the field named secret within AuthMethodTypeData (which is the type of the individual elements of AuthenticationBundle) to zero.

Required/optional:
Returns:	The configured_auth_methods of this TargetChangeableProperties.
Return type:	list[AuthenticationBundle]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.target_location module¶

TargetLocation.py

class netapp.santricity.models.symbol.target_location.TargetLocation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

target_name¶

Gets the target_name of this TargetLocation. The iSCSI node name of the target, left-truncated if necessary. (Left-truncation preserves the part of the name most likely to vary.)

Required/optional:
Returns:	The target_name of this TargetLocation.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.target_portal module¶

TargetPortal.py

class netapp.santricity.models.symbol.target_portal.TargetPortal[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

group_tag¶

Gets the group_tag of this TargetPortal. A value identifying the portal group to which this portal belongs.

Required/optional:
Returns:	The group_tag of this TargetPortal.
Return type:	int
	required

ip_address¶

Gets the ip_address of this TargetPortal. The IP address of the portal.

Required/optional:
Returns:	The ip_address of this TargetPortal.
Return type:	IpVxAddress
	required

tcp_listen_port¶

Gets the tcp_listen_port of this TargetPortal. The number of the TCP port on which the target listens for incoming connections.

Required/optional:
Returns:	The tcp_listen_port of this TargetPortal.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.target_properties_update_descriptor module¶

TargetPropertiesUpdateDescriptor.py

class netapp.santricity.models.symbol.target_properties_update_descriptor.TargetPropertiesUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

settings¶

Gets the settings of this TargetPropertiesUpdateDescriptor. The property settings for the target.

Required/optional:
Returns:	The settings of this TargetPropertiesUpdateDescriptor.
Return type:	TargetChangeableProperties
	required

target¶

Gets the target of this TargetPropertiesUpdateDescriptor. A reference to the target to which the property changes apply.

Required/optional:
Returns:	The target of this TargetPropertiesUpdateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.tcp_protocol_endpoint module¶

TcpProtocolEndpoint.py

class netapp.santricity.models.symbol.tcp_protocol_endpoint.TcpProtocolEndpoint[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ip_address¶

Gets the ip_address of this TcpProtocolEndpoint. The IP address of the endpoint.

Required/optional:
Returns:	The ip_address of this TcpProtocolEndpoint.
Return type:	IpVxAddress
	required

tcp_port¶

Gets the tcp_port of this TcpProtocolEndpoint. The TCP port number of the endpoint.

Required/optional:
Returns:	The tcp_port of this TcpProtocolEndpoint.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.tcp_statistical_data module¶

TcpStatisticalData.py

class netapp.santricity.models.symbol.tcp_statistical_data.TcpStatisticalData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

interfaces¶

Gets the interfaces of this TcpStatisticalData. The interface(s) for which the statistics apply. In some cases, the statistics may be aggregated across multiple interfaces. Even though this is shown as an array, it will only be a single instance.

Required/optional:
Returns:	The interfaces of this TcpStatisticalData.
Return type:	list[str]
	required

received_segments¶

Gets the received_segments of this TcpStatisticalData. The total number of segments received.

Required/optional:
Returns:	The received_segments of this TcpStatisticalData.
Return type:	int
	required

received_segments_in_error¶

Gets the received_segments_in_error of this TcpStatisticalData. The total number of segments received in error.

Required/optional:
Returns:	The received_segments_in_error of this TcpStatisticalData.
Return type:	int
	required

retransmit_timer_expired_count¶

Gets the retransmit_timer_expired_count of this TcpStatisticalData. The number of times the retransmit timer expired and a frame was retransmitted.

Required/optional:
Returns:	The retransmit_timer_expired_count of this TcpStatisticalData.
Return type:	int
	required

rx_ack_count¶

Gets the rx_ack_count of this TcpStatisticalData. The number of pure ACKs received.

Required/optional:
Returns:	The rx_ack_count of this TcpStatisticalData.
Return type:	int
	required

rx_byte_count¶

Gets the rx_byte_count of this TcpStatisticalData. The number of data payload bytes received in TCP segments.

Required/optional:
Returns:	The rx_byte_count of this TcpStatisticalData.
Return type:	int
	required

rx_duplicate_ack_count¶

Gets the rx_duplicate_ack_count of this TcpStatisticalData. The number of duplicate ACKs received.

Required/optional:
Returns:	The rx_duplicate_ack_count of this TcpStatisticalData.
Return type:	int
	required

rx_segment_out_of_order_count¶

Gets the rx_segment_out_of_order_count of this TcpStatisticalData. The number of TCP segments received that were out of order.

Required/optional:
Returns:	The rx_segment_out_of_order_count of this TcpStatisticalData.
Return type:	int
	required

rx_window_probe_count¶

Gets the rx_window_probe_count of this TcpStatisticalData. The number of window probes received.

Required/optional:
Returns:	The rx_window_probe_count of this TcpStatisticalData.
Return type:	int
	required

rx_window_update_count¶

Gets the rx_window_update_count of this TcpStatisticalData. The number of window updates received.

Required/optional:
Returns:	The rx_window_update_count of this TcpStatisticalData.
Return type:	int
	required

sent_segments¶

Gets the sent_segments of this TcpStatisticalData. The total number of segments sent.

Required/optional:
Returns:	The sent_segments of this TcpStatisticalData.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tx_ack_count¶

Gets the tx_ack_count of this TcpStatisticalData. The number of pure ACKs transmitted.

Required/optional:
Returns:	The tx_ack_count of this TcpStatisticalData.
Return type:	int
	required

tx_byte_count¶

Gets the tx_byte_count of this TcpStatisticalData. The number of data payload bytes transmitted in TCP segments.

Required/optional:
Returns:	The tx_byte_count of this TcpStatisticalData.
Return type:	int
	required

tx_delayed_ack_count¶

Gets the tx_delayed_ack_count of this TcpStatisticalData. The number of delayed ACKs transmitted.

Required/optional:
Returns:	The tx_delayed_ack_count of this TcpStatisticalData.
Return type:	int
	required

netapp.santricity.models.symbol.thermal_sensor module¶

ThermalSensor.py

class netapp.santricity.models.symbol.thermal_sensor.ThermalSensor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

id¶

Gets the id of this ThermalSensor.

Required/optional:
Returns:	The id of this ThermalSensor.
Return type:	str
	optional

physical_location¶

Gets the physical_location of this ThermalSensor. The physical location of the thermal sensor. The parent reference in Location identifies the CRU that physically houses the thermal sensor, and the position field is the parent-relative/like-component relative number of the thermal sensor, starting at one.

Required/optional:
Returns:	The physical_location of this ThermalSensor.
Return type:	Location
	required

repair_policy¶

Gets the repair_policy of this ThermalSensor. The repair policy for the thermal sensor component.

Required/optional:
Returns:	The repair_policy of this ThermalSensor.
Return type:	RepairPolicy
	required

reserved1¶

Gets the reserved1 of this ThermalSensor.

Required/optional:
Returns:	The reserved1 of this ThermalSensor.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this ThermalSensor.

Required/optional:
Returns:	The reserved2 of this ThermalSensor.
Return type:	str
	optional

rtr_attributes¶

Gets the rtr_attributes of this ThermalSensor. The CRU type of the thermal sensor plus its ready-to-remove attributes, which are based on the CRU type

Required/optional:
Returns:	The rtr_attributes of this ThermalSensor.
Return type:	RTRAttributes
	required

status¶

Gets the status of this ThermalSensor. The operational status of the thermal sensor.

Required/optional:
Returns:	The status of this ThermalSensor.
Return type:	str
	required

thermal_sensor_ref¶

Gets the thermal_sensor_ref of this ThermalSensor. The reference for this physical thermal sensor.

Required/optional:
Returns:	The thermal_sensor_ref of this ThermalSensor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.thermal_sensor_data module¶

ThermalSensorData.py

class netapp.santricity.models.symbol.thermal_sensor_data.ThermalSensorData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

current_temp¶

Gets the current_temp of this ThermalSensorData. This value is the current temperature in degrees Celsius, if it is known, otherwise it will be set to a value in the ThermalSensorValue enumeration. Some sensors only report the temperature during an alarm condition. In that case, this field will normally be set to THERMAL_SENSOR_DATA_NOMINAL and will only contain the actual temperature when the alarm is active.

Required/optional:
Returns:	The current_temp of this ThermalSensorData.
Return type:	int
	required

thermal_sensor_ref¶

Gets the thermal_sensor_ref of this ThermalSensorData. A reference to a thermal sensor object.

Required/optional:
Returns:	The thermal_sensor_ref of this ThermalSensorData.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.thin_volume module¶

ThinVolume.py

class netapp.santricity.models.symbol.thin_volume.ThinVolume[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

allocation_granularity¶

Gets the allocation_granularity of this ThinVolume. The allocation cluster size for the Expandable Repository Volume.

Required/optional:
Returns:	The allocation_granularity of this ThinVolume.
Return type:	int
	required

application_tag_owned¶

Gets the application_tag_owned of this ThinVolume. True if application tag is owned by the storage array.

Required/optional:
Returns:	The application_tag_owned of this ThinVolume.
Return type:	bool
	required

capacity¶

Gets the capacity of this ThinVolume. The virtual capacity of the volume in bytes.

Required/optional:
Returns:	The capacity of this ThinVolume.
Return type:	int
	required

current_manager¶

Gets the current_manager of this ThinVolume. The controller that currently manages the volume.

Required/optional:
Returns:	The current_manager of this ThinVolume.
Return type:	str
	required

current_provisioned_capacity¶

Gets the current_provisioned_capacity of this ThinVolume. The current provisioned capacity of the Expandable Repository Volume (in bytes).

Required/optional:
Returns:	The current_provisioned_capacity of this ThinVolume.
Return type:	int
	required

expansion_policy¶

Gets the expansion_policy of this ThinVolume. The automatic Expandable Repository Volume expansion policy.

Required/optional:
Returns:	The expansion_policy of this ThinVolume.
Return type:	str
	required

growth_alert_threshold¶

Gets the growth_alert_threshold of this ThinVolume. The percent value at which an alert is generated.

Required/optional:
Returns:	The growth_alert_threshold of this ThinVolume.
Return type:	int
	required

id¶

Gets the id of this ThinVolume.

Required/optional:
Returns:	The id of this ThinVolume.
Return type:	str
	optional

initial_provisioned_capacity¶

Gets the initial_provisioned_capacity of this ThinVolume. The initial provisioned capacity for the Expandable Repository Volume for this thin volume (in bytes).

Required/optional:
Returns:	The initial_provisioned_capacity of this ThinVolume.
Return type:	int
	required

label¶

Gets the label of this ThinVolume. The name of the volume.

Required/optional:
Returns:	The label of this ThinVolume.
Return type:	str
	required

max_virtual_capacity¶

Gets the max_virtual_capacity of this ThinVolume. The maximum virtual capacity to which this thin volume can grow (in bytes).

Required/optional:
Returns:	The max_virtual_capacity of this ThinVolume.
Return type:	int
	required

mgmt_client_attribute¶

Gets the mgmt_client_attribute of this ThinVolume. For use by management client.

Required/optional:
Returns:	The mgmt_client_attribute of this ThinVolume.
Return type:	int
	required

offline¶

Gets the offline of this ThinVolume. The thin volume is offline due to the associated repository volume state.

Required/optional:
Returns:	The offline of this ThinVolume.
Return type:	bool
	required

perms¶

Gets the perms of this ThinVolume. Operations allowed on this volume.

Required/optional:
Returns:	The perms of this ThinVolume.
Return type:	VolumePerms
	required

pre_read_redundancy_check_enabled¶

Gets the pre_read_redundancy_check_enabled of this ThinVolume. If true, verify RAID redundancy on read operations.

Required/optional:
Returns:	The pre_read_redundancy_check_enabled of this ThinVolume.
Return type:	bool
	required

preferred_manager¶

Gets the preferred_manager of this ThinVolume. The controller that should manage the volume.

Required/optional:
Returns:	The preferred_manager of this ThinVolume.
Return type:	str
	required

protection_type¶

Gets the protection_type of this ThinVolume. The protection type of the volume.

Required/optional:
Returns:	The protection_type of this ThinVolume.
Return type:	str
	required

provisioned_capacity_quota¶

Gets the provisioned_capacity_quota of this ThinVolume. The maximum capacity of the Expandable Repository Volume (in bytes).

Required/optional:
Returns:	The provisioned_capacity_quota of this ThinVolume.
Return type:	int
	required

recon_priority¶

Gets the recon_priority of this ThinVolume. Importance of fixing the volume if failed (0-4).

Required/optional:
Returns:	The recon_priority of this ThinVolume.
Return type:	int
	required

reporting_policy¶

Gets the reporting_policy of this ThinVolume. Indicates how the thin volume is reported on the SCSI interface.

Required/optional:
Returns:	The reporting_policy of this ThinVolume.
Return type:	str
	required

repository_ref¶

Gets the repository_ref of this ThinVolume. The Expandable Repository Volume underlying this Thin Volume.

Required/optional:
Returns:	The repository_ref of this ThinVolume.
Return type:	str
	required

status¶

Gets the status of this ThinVolume. The operational status of the volume.

Required/optional:
Returns:	The status of this ThinVolume.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_cache¶

Gets the volume_cache of this ThinVolume. The cache parameters of the underlying repository.

Required/optional:
Returns:	The volume_cache of this ThinVolume.
Return type:	VolumeCache
	required

volume_handle¶

Gets the volume_handle of this ThinVolume. The volumeHandle (SSID) for this volume.

Required/optional:
Returns:	The volume_handle of this ThinVolume.
Return type:	int
	required

volume_ref¶

Gets the volume_ref of this ThinVolume. The reference (key) for this volume.

Required/optional:
Returns:	The volume_ref of this ThinVolume.
Return type:	str
	required

world_wide_name¶

Gets the world_wide_name of this ThinVolume. The World wide name of the volume.

Required/optional:
Returns:	The world_wide_name of this ThinVolume.
Return type:	str
	required

netapp.santricity.models.symbol.thin_volume_capacity_provisioning_details module¶

ThinVolumeCapacityProvisioningDetails.py

class netapp.santricity.models.symbol.thin_volume_capacity_provisioning_details.ThinVolumeCapacityProvisioningDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

capacity_quota¶

Gets the capacity_quota of this ThinVolumeCapacityProvisioningDetails. The maximum capacity to which the Expandable Repository Volume can grow (in bytes).

Required/optional:
Returns:	The capacity_quota of this ThinVolumeCapacityProvisioningDetails.
Return type:	int
	required

growth_alert_threshold¶

Gets the growth_alert_threshold of this ThinVolumeCapacityProvisioningDetails. The alert threshold percent value for the Expandable Repository Volume.

Required/optional:
Returns:	The growth_alert_threshold of this ThinVolumeCapacityProvisioningDetails.
Return type:	int
	required

repository_expansion_policy¶

Gets the repository_expansion_policy of this ThinVolumeCapacityProvisioningDetails. The expansion policy for the Expandable Repository Volume.

Required/optional:
Returns:	The repository_expansion_policy of this ThinVolumeCapacityProvisioningDetails.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.thin_volume_capacity_quota_update_descriptor module¶

ThinVolumeCapacityQuotaUpdateDescriptor.py

class netapp.santricity.models.symbol.thin_volume_capacity_quota_update_descriptor.ThinVolumeCapacityQuotaUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

quota¶

Gets the quota of this ThinVolumeCapacityQuotaUpdateDescriptor. The ERV’s maximum quota.

Required/optional:
Returns:	The quota of this ThinVolumeCapacityQuotaUpdateDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this ThinVolumeCapacityQuotaUpdateDescriptor. A reference to the thin volume to update.

Required/optional:
Returns:	The volume_ref of this ThinVolumeCapacityQuotaUpdateDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.thin_volume_consumed_capacity module¶

ThinVolumeConsumedCapacity.py

class netapp.santricity.models.symbol.thin_volume_consumed_capacity.ThinVolumeConsumedCapacity[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

repository_consumed_capacity¶

Gets the repository_consumed_capacity of this ThinVolumeConsumedCapacity. The capacity that is consumed.

Required/optional:
Returns:	The repository_consumed_capacity of this ThinVolumeConsumedCapacity.
Return type:	int
	required

repository_provisioned_capacity¶

Gets the repository_provisioned_capacity of this ThinVolumeConsumedCapacity. The total capacity of the repository.

Required/optional:
Returns:	The repository_provisioned_capacity of this ThinVolumeConsumedCapacity.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this ThinVolumeConsumedCapacity. The reference for this thin volume.

Required/optional:
Returns:	The volume_ref of this ThinVolumeConsumedCapacity.
Return type:	str
	required

netapp.santricity.models.symbol.thin_volume_consumed_capacity_returned module¶

ThinVolumeConsumedCapacityReturned.py

class netapp.santricity.models.symbol.thin_volume_consumed_capacity_returned.ThinVolumeConsumedCapacityReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

capacity¶

Gets the capacity of this ThinVolumeConsumedCapacityReturned. The consumed capacity of the thin volume. This field is present only if the value of returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The capacity of this ThinVolumeConsumedCapacityReturned.
Return type:	list[ThinVolumeConsumedCapacity]
	optional

return_code¶

Gets the return_code of this ThinVolumeConsumedCapacityReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this ThinVolumeConsumedCapacityReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.thin_volume_creation_descriptor module¶

ThinVolumeCreationDescriptor.py

class netapp.santricity.models.symbol.thin_volume_creation_descriptor.ThinVolumeCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

growth_alert_threshold¶

Gets the growth_alert_threshold of this ThinVolumeCreationDescriptor. The alert threshold percent value for the Expandable Repository Volume.

Required/optional:
Returns:	The growth_alert_threshold of this ThinVolumeCreationDescriptor.
Return type:	int
	required

manager¶

Gets the manager of this ThinVolumeCreationDescriptor. The controller that will manage the volume.

Required/optional:
Returns:	The manager of this ThinVolumeCreationDescriptor.
Return type:	str
	required

no_mapping¶

Gets the no_mapping of this ThinVolumeCreationDescriptor. If true, default mapping will not be created.

Required/optional:
Returns:	The no_mapping of this ThinVolumeCreationDescriptor.
Return type:	bool
	required

protection_type¶

Gets the protection_type of this ThinVolumeCreationDescriptor. Specifies which protection type should be used for the volume.

Required/optional:
Returns:	The protection_type of this ThinVolumeCreationDescriptor.
Return type:	str
	required

provisioned_capacity_quota¶

Gets the provisioned_capacity_quota of this ThinVolumeCreationDescriptor. The maximum capacity to which the Expandable Repository Volume can grow (in bytes).

Required/optional:
Returns:	The provisioned_capacity_quota of this ThinVolumeCreationDescriptor.
Return type:	int
	required

read_ahead¶

Gets the read_ahead of this ThinVolumeCreationDescriptor. If true (non-zero), automatic cache read-ahead is enabled. If false (zero), automatic cache read-ahead is disabled.

Required/optional:
Returns:	The read_ahead of this ThinVolumeCreationDescriptor.
Return type:	int
	required

repository_creation_descriptor¶

Gets the repository_creation_descriptor of this ThinVolumeCreationDescriptor. The repository creation type.

Required/optional:
Returns:	The repository_creation_descriptor of this ThinVolumeCreationDescriptor.
Return type:	ConcatVolumeCreationDescriptor
	required

repository_expansion_policy¶

Gets the repository_expansion_policy of this ThinVolumeCreationDescriptor. The expansion policy for the Expandable Repository Volume.

Required/optional:
Returns:	The repository_expansion_policy of this ThinVolumeCreationDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

virtual_capacity¶

Gets the virtual_capacity of this ThinVolumeCreationDescriptor. The thin volume capacity (in bytes).

Required/optional:
Returns:	The virtual_capacity of this ThinVolumeCreationDescriptor.
Return type:	int
	required

volume_label¶

Gets the volume_label of this ThinVolumeCreationDescriptor. The user assigned volume name.

Required/optional:
Returns:	The volume_label of this ThinVolumeCreationDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.thin_volume_default_attributes module¶

ThinVolumeDefaultAttributes.py

class netapp.santricity.models.symbol.thin_volume_default_attributes.ThinVolumeDefaultAttributes[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

default_alert_threshold¶

Gets the default_alert_threshold of this ThinVolumeDefaultAttributes. The default alert threshold as a percentage.

Required/optional:
Returns:	The default_alert_threshold of this ThinVolumeDefaultAttributes.
Return type:	int
	required

max_provisioned_capacity¶

Gets the max_provisioned_capacity of this ThinVolumeDefaultAttributes. The maximum provisioned capacity in bytes.

Required/optional:
Returns:	The max_provisioned_capacity of this ThinVolumeDefaultAttributes.
Return type:	int
	required

max_virtual_capacity¶

Gets the max_virtual_capacity of this ThinVolumeDefaultAttributes. The maximum virtual capacity in bytes.

Required/optional:
Returns:	The max_virtual_capacity of this ThinVolumeDefaultAttributes.
Return type:	int
	required

min_alert_threshold¶

Gets the min_alert_threshold of this ThinVolumeDefaultAttributes. The minimum alert threshold as a percentage.

Required/optional:
Returns:	The min_alert_threshold of this ThinVolumeDefaultAttributes.
Return type:	int
	required

min_provisioned_capacity¶

Gets the min_provisioned_capacity of this ThinVolumeDefaultAttributes. The minimum provisioned capacity in bytes.

Required/optional:
Returns:	The min_provisioned_capacity of this ThinVolumeDefaultAttributes.
Return type:	int
	required

min_virtual_capacity¶

Gets the min_virtual_capacity of this ThinVolumeDefaultAttributes. The minimum virtual capacity in bytes.

Required/optional:
Returns:	The min_virtual_capacity of this ThinVolumeDefaultAttributes.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.thin_volume_expansion_descriptor module¶

ThinVolumeExpansionDescriptor.py

class netapp.santricity.models.symbol.thin_volume_expansion_descriptor.ThinVolumeExpansionDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

capacity¶

Gets the capacity of this ThinVolumeExpansionDescriptor. The new capacity for the thin volume in bytes.

Required/optional:
Returns:	The capacity of this ThinVolumeExpansionDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this ThinVolumeExpansionDescriptor. A reference to the thin volume.

Required/optional:
Returns:	The volume_ref of this ThinVolumeExpansionDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.thin_volume_expansion_policy_update_descriptor module¶

ThinVolumeExpansionPolicyUpdateDescriptor.py

class netapp.santricity.models.symbol.thin_volume_expansion_policy_update_descriptor.ThinVolumeExpansionPolicyUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

policy¶

Gets the policy of this ThinVolumeExpansionPolicyUpdateDescriptor. The new repository expansion policy.

Required/optional:
Returns:	The policy of this ThinVolumeExpansionPolicyUpdateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this ThinVolumeExpansionPolicyUpdateDescriptor. A reference to the thin volume.

Required/optional:
Returns:	The volume_ref of this ThinVolumeExpansionPolicyUpdateDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.thin_volume_ref_list module¶

ThinVolumeRefList.py

class netapp.santricity.models.symbol.thin_volume_ref_list.ThinVolumeRefList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

thin_ref¶

Gets the thin_ref of this ThinVolumeRefList. A reference to the thin volume.

Required/optional:
Returns:	The thin_ref of this ThinVolumeRefList.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.thin_volume_reinitialize_descriptor module¶

ThinVolumeReinitializeDescriptor.py

class netapp.santricity.models.symbol.thin_volume_reinitialize_descriptor.ThinVolumeReinitializeDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

init_params¶

Gets the init_params of this ThinVolumeReinitializeDescriptor. Operation-specific parameters for the re-initialize.

Required/optional:
Returns:	The init_params of this ThinVolumeReinitializeDescriptor.
Return type:	ThinVolumeReinitializeParams
	required

thin_vol¶

Gets the thin_vol of this ThinVolumeReinitializeDescriptor. The thin volume to re-initialize.

Required/optional:
Returns:	The thin_vol of this ThinVolumeReinitializeDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.thin_volume_reinitialize_params module¶

ThinVolumeReinitializeParams.py

class netapp.santricity.models.symbol.thin_volume_reinitialize_params.ThinVolumeReinitializeParams[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

init_action¶

Gets the init_action of this ThinVolumeReinitializeParams. This enumeration defines the actions to take on a thin volume re-initialize request.

Required/optional:
Returns:	The init_action of this ThinVolumeReinitializeParams.
Return type:	str
	required

new_provisioned_capacity¶

Gets the new_provisioned_capacity of this ThinVolumeReinitializeParams. This field is present only if the value of initAction is equal to THIN_VOL_REINIT_AND_RESIZE.

Required/optional:
Returns:	The new_provisioned_capacity of this ThinVolumeReinitializeParams.
Return type:	int
	optional

new_repository_candidate¶

Gets the new_repository_candidate of this ThinVolumeReinitializeParams. This field is present only if the value of initAction is equal to THIN_VOL_REINIT_NEW_REPOSITORY.

Required/optional:
Returns:	The new_repository_candidate of this ThinVolumeReinitializeParams.
Return type:	ConcatVolumeCreationDescriptor
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.thin_volume_reporting_policy_update_descriptor module¶

ThinVolumeReportingPolicyUpdateDescriptor.py

class netapp.santricity.models.symbol.thin_volume_reporting_policy_update_descriptor.ThinVolumeReportingPolicyUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

policy¶

Gets the policy of this ThinVolumeReportingPolicyUpdateDescriptor. The new thin volume reporting policy.

Required/optional:
Returns:	The policy of this ThinVolumeReportingPolicyUpdateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this ThinVolumeReportingPolicyUpdateDescriptor. A reference to the thin volume.

Required/optional:
Returns:	The volume_ref of this ThinVolumeReportingPolicyUpdateDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.thin_volume_repository_expansion_history_data module¶

ThinVolumeRepositoryExpansionHistoryData.py

class netapp.santricity.models.symbol.thin_volume_repository_expansion_history_data.ThinVolumeRepositoryExpansionHistoryData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

post_expansion_capacity_in_bytes¶

Gets the post_expansion_capacity_in_bytes of this ThinVolumeRepositoryExpansionHistoryData. The repository capacity after expansion (in bytes).

Required/optional:
Returns:	The post_expansion_capacity_in_bytes of this ThinVolumeRepositoryExpansionHistoryData.
Return type:	int
	required

pre_expansion_capacity_in_bytes¶

Gets the pre_expansion_capacity_in_bytes of this ThinVolumeRepositoryExpansionHistoryData. The repository capacity before expansion (in bytes).

Required/optional:
Returns:	The pre_expansion_capacity_in_bytes of this ThinVolumeRepositoryExpansionHistoryData.
Return type:	int
	required

start_time¶

Gets the start_time of this ThinVolumeRepositoryExpansionHistoryData. The start timestamp of expansion operation, in seconds since January 1, 1970.

Required/optional:
Returns:	The start_time of this ThinVolumeRepositoryExpansionHistoryData.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this ThinVolumeRepositoryExpansionHistoryData. The type of expansion.

Required/optional:
Returns:	The type of this ThinVolumeRepositoryExpansionHistoryData.
Return type:	str
	required

volume_ref¶

Gets the volume_ref of this ThinVolumeRepositoryExpansionHistoryData. A reference to the thin volume.

Required/optional:
Returns:	The volume_ref of this ThinVolumeRepositoryExpansionHistoryData.
Return type:	str
	required

netapp.santricity.models.symbol.thin_volume_repository_expansion_history_list_returned module¶

ThinVolumeRepositoryExpansionHistoryListReturned.py

class netapp.santricity.models.symbol.thin_volume_repository_expansion_history_list_returned.ThinVolumeRepositoryExpansionHistoryListReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

data¶

Gets the data of this ThinVolumeRepositoryExpansionHistoryListReturned. This field is present only if the value of returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The data of this ThinVolumeRepositoryExpansionHistoryListReturned.
Return type:	list[ThinVolumeRepositoryExpansionHistoryData]
	optional

return_code¶

Gets the return_code of this ThinVolumeRepositoryExpansionHistoryListReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this ThinVolumeRepositoryExpansionHistoryListReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.thin_volume_threshold_update_descriptor module¶

ThinVolumeThresholdUpdateDescriptor.py

class netapp.santricity.models.symbol.thin_volume_threshold_update_descriptor.ThinVolumeThresholdUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

threshold¶

Gets the threshold of this ThinVolumeThresholdUpdateDescriptor. The thin volume’s warning threshold.

Required/optional:
Returns:	The threshold of this ThinVolumeThresholdUpdateDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this ThinVolumeThresholdUpdateDescriptor. A reference to the thin volume.

Required/optional:
Returns:	The volume_ref of this ThinVolumeThresholdUpdateDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.time_to_live_tlv module¶

TimeToLiveTLV.py

class netapp.santricity.models.symbol.time_to_live_tlv.TimeToLiveTLV[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

time¶

Gets the time of this TimeToLiveTLV. This field contains the value of the time to live in seconds.

Required/optional:
Returns:	The time of this TimeToLiveTLV.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.time_zone_description module¶

TimeZoneDescription.py

class netapp.santricity.models.symbol.time_zone_description.TimeZoneDescription[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

dst_adjust¶

Gets the dst_adjust of this TimeZoneDescription. The number of seconds to adjust the clock during DST

Required/optional:
Returns:	The dst_adjust of this TimeZoneDescription.
Return type:	int
	required

dst_end¶

Gets the dst_end of this TimeZoneDescription. The DST end date and time.

Required/optional:
Returns:	The dst_end of this TimeZoneDescription.
Return type:	DaylightSavingsTime
	required

dst_start¶

Gets the dst_start of this TimeZoneDescription. The DST start date and time.

Required/optional:
Returns:	The dst_start of this TimeZoneDescription.
Return type:	DaylightSavingsTime
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tz_label¶

Gets the tz_label of this TimeZoneDescription. The time zone identifier (ASCII).

Required/optional:
Returns:	The tz_label of this TimeZoneDescription.
Return type:	str
	required

tz_offset¶

Gets the tz_offset of this TimeZoneDescription. The time zone offset measured in seconds +/- from GMT.

Required/optional:
Returns:	The tz_offset of this TimeZoneDescription.
Return type:	int
	required

netapp.santricity.models.symbol.tray module¶

Tray.py

class netapp.santricity.models.symbol.tray.Tray[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_layout¶

Gets the drive_layout of this Tray. If the tray contains drawers, this field specifies the layout within the drawer. Otherwise, this field specifies the layout for the tray.

Required/optional:
Returns:	The drive_layout of this Tray.
Return type:	DriveLayout
	required

drive_technologies¶

Gets the drive_technologies of this Tray. A list of drive technologies that are present in the tray.

Required/optional:
Returns:	The drive_technologies of this Tray.
Return type:	list[str]
	required

drv_mh_speed_mismatch¶

Gets the drv_mh_speed_mismatch of this Tray. True if this tray has a drive-side minihub speed mismatch.

Required/optional:
Returns:	The drv_mh_speed_mismatch of this Tray.
Return type:	bool
	required

esm_factory_defaults_mismatch¶

Gets the esm_factory_defaults_mismatch of this Tray. True, if the two ESMs in the tray are reporting different version information for their factory default settings.

Required/optional:
Returns:	The esm_factory_defaults_mismatch of this Tray.
Return type:	bool
	required

esm_group_error¶

Gets the esm_group_error of this Tray. True if SBOD ESM trays are not properly clustered.

Required/optional:
Returns:	The esm_group_error of this Tray.
Return type:	bool
	required

esm_hardware_mismatch¶

Gets the esm_hardware_mismatch of this Tray. True if the ESM hardware components in the tray are mismatched.

Required/optional:
Returns:	The esm_hardware_mismatch of this Tray.
Return type:	bool
	required

esm_miswire¶

Gets the esm_miswire of this Tray. True if this tray has an ESM join miswire.

Required/optional:
Returns:	The esm_miswire of this Tray.
Return type:	bool
	required

esm_version_mismatch¶

Gets the esm_version_mismatch of this Tray. True if the ESM firmware versions do not match.

Required/optional:
Returns:	The esm_version_mismatch of this Tray.
Return type:	bool
	required

factory_defaults_data¶

Gets the factory_defaults_data of this Tray. This field contains information about the version of the tray’s factory default settings.

Required/optional:
Returns:	The factory_defaults_data of this Tray.
Return type:	FactoryDefaultsVersionData
	required

front_end_interface_technology¶

Gets the front_end_interface_technology of this Tray. The front-end I/O interface technology of the tray.

Required/optional:
Returns:	The front_end_interface_technology of this Tray.
Return type:	str
	required

fru_type¶

Gets the fru_type of this Tray. The field replaceable unit type of the tray.

Required/optional:
Returns:	The fru_type of this Tray.
Return type:	str
	required

has_configurable_tray_id¶

Gets the has_configurable_tray_id of this Tray. True if the tray ID can be set using the updateTray procedure.

Required/optional:
Returns:	The has_configurable_tray_id of this Tray.
Return type:	bool
	required

has_tray_identity_indicator¶

Gets the has_tray_identity_indicator of this Tray. The device contains 7-segment indicators used to display the Tray Identity.

Required/optional:
Returns:	The has_tray_identity_indicator of this Tray.
Return type:	bool
	required

id¶

Gets the id of this Tray.

Required/optional:
Returns:	The id of this Tray.
Return type:	str
	optional

is_misconfigured¶

Gets the is_misconfigured of this Tray. True, if the tray has invalid configuration settings.

Required/optional:
Returns:	The is_misconfigured of this Tray.
Return type:	bool
	required

locate_in_progress¶

Gets the locate_in_progress of this Tray. Indicates that a locate operation for the device is currently active. The device will show a visual indication to aid an operator in locating the tray.

Required/optional:
Returns:	The locate_in_progress of this Tray.
Return type:	bool
	required

locate_tray¶

Gets the locate_tray of this Tray. True if this tray supports a locate operation.

Required/optional:
Returns:	The locate_tray of this Tray.
Return type:	bool
	required

manufacturer_date¶

Gets the manufacturer_date of this Tray. The date the tray was manufactured.

Required/optional:
Returns:	The manufacturer_date of this Tray.
Return type:	int
	required

max_speed¶

Gets the max_speed of this Tray. The maximum speed of the drive channels,

Required/optional:
Returns:	The max_speed of this Tray.
Return type:	str
	required

non_redundant_access¶

Gets the non_redundant_access of this Tray. True, if the tray does not have redundant access.

Required/optional:
Returns:	The non_redundant_access of this Tray.
Return type:	bool
	required

num_controller_slots¶

Gets the num_controller_slots of this Tray. The number of slots available for holding RAID controller boards (i.e., set to zero for a drive-only tray).

Required/optional:
Returns:	The num_controller_slots of this Tray.
Return type:	int
	required

num_drawers¶

Gets the num_drawers of this Tray. The total number of drawers available in the tray.

Required/optional:
Returns:	The num_drawers of this Tray.
Return type:	int
	required

num_drive_compartments¶

Gets the num_drive_compartments of this Tray. The number of drive compartments in the tray. Some drive trays are subdivided into “compartments,” each having the same number of drive slots. Looking at the front of such an enclosure, multiple compartments are arranged side by side along one dimension, while drives within a compartment are arranged side by side along the other dimension, allowing for greater overall drive density within the constraints of a given enclosure form factor. (Even when arranged as a series of compartments, drive slot numbering is still relative to the entire tray.)

Required/optional:
Returns:	The num_drive_compartments of this Tray.
Return type:	int
	required

num_drive_slots¶

Gets the num_drive_slots of this Tray. The total number of slots available for holding disk drives.

Required/optional:
Returns:	The num_drive_slots of this Tray.
Return type:	int
	required

num_drive_slots_per_compartment¶

Gets the num_drive_slots_per_compartment of this Tray. The number of drive slots within an individual drive compartment.

Required/optional:
Returns:	The num_drive_slots_per_compartment of this Tray.
Return type:	int
	required

orientation¶

Gets the orientation of this Tray. An indication of the physical orientation (horizontal or vertical) of the tray.

Required/optional:
Returns:	The orientation of this Tray.
Return type:	str
	required

part_number¶

Gets the part_number of this Tray. The part number of the tray from VPD data.

Required/optional:
Returns:	The part_number of this Tray.
Return type:	str
	required

physical_location¶

Gets the physical_location of this Tray. The physical location of the tray. The parent reference in Location identifies the storage array itself, and the position field is the tray position number as identified in setSATrayPositions procedure call, or the constant TRAY_POSITION_UNKNOWN.

Required/optional:
Returns:	The physical_location of this Tray.
Return type:	Location
	required

serial_number¶

Gets the serial_number of this Tray. The serial number of the tray.

Required/optional:
Returns:	The serial_number of this Tray.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray_attributes¶

Gets the tray_attributes of this Tray. The tray attribute data (see setTrayAttributes procedure).

Required/optional:
Returns:	The tray_attributes of this Tray.
Return type:	list[TrayAttribute]
	required

tray_id¶

Gets the tray_id of this Tray. The tray identifier value, which is typically set using physical switches on the tray itself.

Required/optional:
Returns:	The tray_id of this Tray.
Return type:	int
	required

tray_id_conflict¶

Gets the tray_id_conflict of this Tray. True if this tray ID conflicts with that of another tray.

Required/optional:
Returns:	The tray_id_conflict of this Tray.
Return type:	bool
	required

tray_id_mismatch¶

Gets the tray_id_mismatch of this Tray. True if the IDs on the ESMs do not match.

Required/optional:
Returns:	The tray_id_mismatch of this Tray.
Return type:	bool
	required

tray_ref¶

Gets the tray_ref of this Tray. The identifier value for this tray. Other objects may use this reference value to refer to the tray.

Required/optional:
Returns:	The tray_ref of this Tray.
Return type:	str
	required

tray_technology_type¶

Gets the tray_technology_type of this Tray. The interface technology. This field is deprecated. Equivalent information is available in the driveTechnologies and frontEndInterfaceTechnology fields.

Required/optional:
Returns:	The tray_technology_type of this Tray.
Return type:	str
	required

type¶

Gets the type of this Tray. An indication of the type of the tray.

Required/optional:
Returns:	The type of this Tray.
Return type:	str
	required

uncertified_tray¶

Gets the uncertified_tray of this Tray. True if this tray is an uncertified hardware type.

Required/optional:
Returns:	The uncertified_tray of this Tray.
Return type:	bool
	required

unsupported_tray¶

Gets the unsupported_tray of this Tray. True if this tray is an unrecognized/unsupported hardware type.

Required/optional:
Returns:	The unsupported_tray of this Tray.
Return type:	bool
	required

vendor_name¶

Gets the vendor_name of this Tray. The name of the manufacturer of the tray.

Required/optional:
Returns:	The vendor_name of this Tray.
Return type:	str
	required

working_channel¶

Gets the working_channel of this Tray. The channel to the tray that is still operational (if nonRedundantAccess is True).

Required/optional:
Returns:	The working_channel of this Tray.
Return type:	int
	required

netapp.santricity.models.symbol.tray_attribute module¶

TrayAttribute.py

class netapp.santricity.models.symbol.tray_attribute.TrayAttribute[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

attribute_id¶

Gets the attribute_id of this TrayAttribute. An indication of which attribute this is.

Required/optional:
Returns:	The attribute_id of this TrayAttribute.
Return type:	str
	required

attribute_value¶

Gets the attribute_value of this TrayAttribute. The value of the tray attribute.

Required/optional:
Returns:	The attribute_value of this TrayAttribute.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.tray_attribute_update_descriptor module¶

TrayAttributeUpdateDescriptor.py

class netapp.santricity.models.symbol.tray_attribute_update_descriptor.TrayAttributeUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray_attributes¶

Gets the tray_attributes of this TrayAttributeUpdateDescriptor. A variable-length list of attribute data to write.

Required/optional:
Returns:	The tray_attributes of this TrayAttributeUpdateDescriptor.
Return type:	list[TrayAttribute]
	required

tray_ref¶

Gets the tray_ref of this TrayAttributeUpdateDescriptor. The reference to the tray.

Required/optional:
Returns:	The tray_ref of this TrayAttributeUpdateDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.tray_lost_redundancy_failure module¶

TrayLostRedundancyFailure.py

class netapp.santricity.models.symbol.tray_lost_redundancy_failure.TrayLostRedundancyFailure[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

failed_esm¶

Gets the failed_esm of this TrayLostRedundancyFailure. This object uniquely identifies the failed ESM within the storage array.

Required/optional:
Returns:	The failed_esm of this TrayLostRedundancyFailure.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray_lost_redundancy¶

Gets the tray_lost_redundancy of this TrayLostRedundancyFailure. This object uniquely identifies the particular tray within the storage array that has lost redundancy.

Required/optional:
Returns:	The tray_lost_redundancy of this TrayLostRedundancyFailure.
Return type:	str
	required

working_channel¶

Gets the working_channel of this TrayLostRedundancyFailure. The channel to the tray that is still operational.

Required/optional:
Returns:	The working_channel of this TrayLostRedundancyFailure.
Return type:	int
	required

netapp.santricity.models.symbol.tray_position module¶

TrayPosition.py

class netapp.santricity.models.symbol.tray_position.TrayPosition[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

rack_id¶

Gets the rack_id of this TrayPosition. An identifier of the enclosure (i.e. rack) in which the tray resides. This is not supported in the current release of the firmware.

Required/optional:
Returns:	The rack_id of this TrayPosition.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray_id¶

Gets the tray_id of this TrayPosition. The tray ID of the tray.

Required/optional:
Returns:	The tray_id of this TrayPosition.
Return type:	int
	required

netapp.santricity.models.symbol.tray_position_list module¶

TrayPositionList.py

class netapp.santricity.models.symbol.tray_position_list.TrayPositionList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray_position¶

Gets the tray_position of this TrayPositionList. A variable-length array of TrayPosition objects.

Required/optional:
Returns:	The tray_position of this TrayPositionList.
Return type:	list[TrayPosition]
	required

netapp.santricity.models.symbol.tray_power module¶

TrayPower.py

class netapp.santricity.models.symbol.tray_power.TrayPower[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

input_power¶

Gets the input_power of this TrayPower. List of power measurements for each power supply measured in watts.

Required/optional:
Returns:	The input_power of this TrayPower.
Return type:	list[int]
	required

number_of_power_supplies¶

Gets the number_of_power_supplies of this TrayPower. The number of power supplies in the tray.

Required/optional:
Returns:	The number_of_power_supplies of this TrayPower.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray_id¶

Gets the tray_id of this TrayPower. The tray ID.

Required/optional:
Returns:	The tray_id of this TrayPower.
Return type:	int
	required

netapp.santricity.models.symbol.tray_ref_list module¶

TrayRefList.py

class netapp.santricity.models.symbol.tray_ref_list.TrayRefList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray_ref¶

Gets the tray_ref of this TrayRefList. A variable-length array of TrayRef objects.

Required/optional:
Returns:	The tray_ref of this TrayRefList.
Return type:	list[str]
	required

netapp.santricity.models.symbol.tray_slot module¶

TraySlot.py

class netapp.santricity.models.symbol.tray_slot.TraySlot[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

slot¶

Gets the slot of this TraySlot. The slot number, or ordinal identifier, of the component within its tray.

Required/optional:
Returns:	The slot of this TraySlot.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray¶

Gets the tray of this TraySlot. The tray ID of the tray in which the component resides. Note that a Tray ID of -1 means “the controller tray.”

Required/optional:
Returns:	The tray of this TraySlot.
Return type:	int
	required

netapp.santricity.models.symbol.tray_temperature_returned module¶

TrayTemperatureReturned.py

class netapp.santricity.models.symbol.tray_temperature_returned.TrayTemperatureReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

return_code¶

Gets the return_code of this TrayTemperatureReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this TrayTemperatureReturned.
Return type:	str
	required

thermal_sensor_data¶

Gets the thermal_sensor_data of this TrayTemperatureReturned. An array of thermal sensor data. This field is only valid if returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The thermal_sensor_data of this TrayTemperatureReturned.
Return type:	list[ThermalSensorData]
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.tray_update_descriptor module¶

TrayUpdateDescriptor.py

class netapp.santricity.models.symbol.tray_update_descriptor.TrayUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ref¶

Gets the ref of this TrayUpdateDescriptor. The tray reference for this physical object

Required/optional:
Returns:	The ref of this TrayUpdateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray_id¶

Gets the tray_id of this TrayUpdateDescriptor. The ID to set the tray to: 00-99

Required/optional:
Returns:	The tray_id of this TrayUpdateDescriptor.
Return type:	int
	required

netapp.santricity.models.symbol.typed_sy_mbol_reference module¶

TypedSYMbolReference.py

class netapp.santricity.models.symbol.typed_sy_mbol_reference.TypedSYMbolReference[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

component_type¶

Gets the component_type of this TypedSYMbolReference. An enumeration value indicating the type of component that the reference refers to.

Required/optional:
Returns:	The component_type of this TypedSYMbolReference.
Return type:	str
	required

symbol_ref¶

Gets the symbol_ref of this TypedSYMbolReference. A SYMbol reference that refers to an instance of an object of the type identified by componentType. If the component type is “storage array,” this field is a null reference. This is because an object graph describes a single instance of a storage array, so there is no need to uniquely identify instances.

Required/optional:
Returns:	The symbol_ref of this TypedSYMbolReference.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.unconfigured_initiators_returned module¶

UnconfiguredInitiatorsReturned.py

class netapp.santricity.models.symbol.unconfigured_initiators_returned.UnconfiguredInitiatorsReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

return_code¶

Gets the return_code of this UnconfiguredInitiatorsReturned. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this UnconfiguredInitiatorsReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

unconfigured_initiators¶

Gets the unconfigured_initiators of this UnconfiguredInitiatorsReturned. The array of names of unconfigured initiators.

Required/optional:
Returns:	The unconfigured_initiators of this UnconfiguredInitiatorsReturned.
Return type:	list[ScsiNodeName]
	optional

netapp.santricity.models.symbol.unmatched_pending_host module¶

UnmatchedPendingHost.py

class netapp.santricity.models.symbol.unmatched_pending_host.UnmatchedPendingHost[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

conflicting_initiators¶

Gets the conflicting_initiators of this UnmatchedPendingHost. A list of ScsiNodeRef elements representing initiators belonging to the pending host that conflict with initiators in the configured topology. The definition of an initiator conflict for an unmatched pending host is any initiator belonging to the pending host that matches an initiator in the configured topology.

Required/optional:
Returns:	The conflicting_initiators of this UnmatchedPendingHost.
Return type:	list[str]
	required

conflicting_ports¶

Gets the conflicting_ports of this UnmatchedPendingHost. A list of HostPortRef structures representing ports belonging to the pending host that conflict with ports in the configured topology. The definition of a conflict for an unmatched pending host is any port belonging to the pending host that matches a port in the configured topology.

Required/optional:
Returns:	The conflicting_ports of this UnmatchedPendingHost.
Return type:	list[str]
	required

pending_host¶

Gets the pending_host of this UnmatchedPendingHost. A description of the pending host as it was submitted by the host context agent.

Required/optional:
Returns:	The pending_host of this UnmatchedPendingHost.
Return type:	PendingHost
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

unconfigured_ports¶

Gets the unconfigured_ports of this UnmatchedPendingHost. yet been created in the configured topology

Required/optional:
Returns:	The unconfigured_ports of this UnmatchedPendingHost.
Return type:	list[SCSIInitiatorPortId]
	required

netapp.santricity.models.symbol.unreadable_sector_table_entry module¶

UnreadableSectorTableEntry.py

class netapp.santricity.models.symbol.unreadable_sector_table_entry.UnreadableSectorTableEntry[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_lba¶

Gets the drive_lba of this UnreadableSectorTableEntry. 8 bytes - unsigned long long

Required/optional:
Returns:	The drive_lba of this UnreadableSectorTableEntry.
Return type:	int
	required

record_type¶

Gets the record_type of this UnreadableSectorTableEntry. 4 bytes - enumeration

Required/optional:
Returns:	The record_type of this UnreadableSectorTableEntry.
Return type:	str
	required

slot_no¶

Gets the slot_no of this UnreadableSectorTableEntry. The slot number.

Required/optional:
Returns:	The slot_no of this UnreadableSectorTableEntry.
Return type:	int
	required

time_stamp¶

Gets the time_stamp of this UnreadableSectorTableEntry. 8 bytes

Required/optional:
Returns:	The time_stamp of this UnreadableSectorTableEntry.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray_no¶

Gets the tray_no of this UnreadableSectorTableEntry. The tray number.

Required/optional:
Returns:	The tray_no of this UnreadableSectorTableEntry.
Return type:	int
	required

volume_lba¶

Gets the volume_lba of this UnreadableSectorTableEntry. The volume LBA.

Required/optional:
Returns:	The volume_lba of this UnreadableSectorTableEntry.
Return type:	int
	required

volume_ref¶

Gets the volume_ref of this UnreadableSectorTableEntry. The reference for the volume.

Required/optional:
Returns:	The volume_ref of this UnreadableSectorTableEntry.
Return type:	str
	required

netapp.santricity.models.symbol.unreadable_sector_table_info module¶

UnreadableSectorTableInfo.py

class netapp.santricity.models.symbol.unreadable_sector_table_info.UnreadableSectorTableInfo[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

database¶

Gets the database of this UnreadableSectorTableInfo. List of unreadable sectors.

Required/optional:
Returns:	The database of this UnreadableSectorTableInfo.
Return type:	list[UnreadableSectorTableEntry]
	required

max_limit¶

Gets the max_limit of this UnreadableSectorTableInfo. The maximum size of the table.

Required/optional:
Returns:	The max_limit of this UnreadableSectorTableInfo.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.unreadable_sectors module¶

UnreadableSectors.py

class netapp.santricity.models.symbol.unreadable_sectors.UnreadableSectors[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

count¶

Gets the count of this UnreadableSectors. The current number of unreadable sectors persisted.

Required/optional:
Returns:	The count of this UnreadableSectors.
Return type:	int
	required

max_limit¶

Gets the max_limit of this UnreadableSectors. The maximum number of unreadable sectors allowed.

Required/optional:
Returns:	The max_limit of this UnreadableSectors.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.ups module¶

Ups.py

class netapp.santricity.models.symbol.ups.Ups[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

physical_location¶

Gets the physical_location of this Ups. The physical location of the UPS. Note that the tray reference identifies the enclosure containing the UPS, but the slot information does not apply to this component.

Required/optional:
Returns:	The physical_location of this Ups.
Return type:	Location
	required

reserved1¶

Gets the reserved1 of this Ups.

Required/optional:
Returns:	The reserved1 of this Ups.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this Ups.

Required/optional:
Returns:	The reserved2 of this Ups.
Return type:	str
	optional

status¶

Gets the status of this Ups. The operational status of the UPS.

Required/optional:
Returns:	The status of this Ups.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

ups_ref¶

Gets the ups_ref of this Ups. The reference for this physical UPS.

Required/optional:
Returns:	The ups_ref of this Ups.
Return type:	str
	required

netapp.santricity.models.symbol.usm_error module¶

UsmError.py

class netapp.santricity.models.symbol.usm_error.UsmError[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

database_count¶

Gets the database_count of this UsmError. This field is used to report the following errors:

Required/optional:
Returns:	The database_count of this UsmError.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.vendor_part_data module¶

VendorPartData.py

class netapp.santricity.models.symbol.vendor_part_data.VendorPartData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

part_number¶

Gets the part_number of this VendorPartData. The part number.

Required/optional:
Returns:	The part_number of this VendorPartData.
Return type:	str
	required

revision_number¶

Gets the revision_number of this VendorPartData. The part revision number.

Required/optional:
Returns:	The revision_number of this VendorPartData.
Return type:	str
	required

serial_number¶

Gets the serial_number of this VendorPartData. The part serial number.

Required/optional:
Returns:	The serial_number of this VendorPartData.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

vendor_name¶

Gets the vendor_name of this VendorPartData. The name of the vendor.

Required/optional:
Returns:	The vendor_name of this VendorPartData.
Return type:	str
	required

netapp.santricity.models.symbol.version_descriptor module¶

VersionDescriptor.py

class netapp.santricity.models.symbol.version_descriptor.VersionDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

code_module¶

Gets the code_module of this VersionDescriptor. The code module described

Required/optional:
Returns:	The code_module of this VersionDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

version_string¶

Gets the version_string of this VersionDescriptor. Textual representation of version

Required/optional:
Returns:	The version_string of this VersionDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.volume module¶

Volume.py

class netapp.santricity.models.symbol.volume.Volume[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

action¶

Gets the action of this Volume. An indication of what current long-running activity, if any, is currently in progress on the volume.

Required/optional:
Returns:	The action of this Volume.
Return type:	str
	required

application_tag_owned¶

Gets the application_tag_owned of this Volume. True if application tag is owned by the storage array.

Required/optional:
Returns:	The application_tag_owned of this Volume.
Return type:	bool
	required

blk_size¶

Gets the blk_size of this Volume. The block size (in bytes) of the volume.

Required/optional:
Returns:	The blk_size of this Volume.
Return type:	int
	required

cache¶

Gets the cache of this Volume. The volume-specific caching parameters currently in effect for the volume.

Required/optional:
Returns:	The cache of this Volume.
Return type:	VolumeCache
	required

capacity¶

Gets the capacity of this Volume. The capacity (in bytes) of the volume.

Required/optional:
Returns:	The capacity of this Volume.
Return type:	int
	required

current_manager¶

Gets the current_manager of this Volume. The reference value of the controller that currently owns (i.e. manages) this volume. In non-AVT (Auto Volume Transfer) mode, host I/O access to the blocks in this volume is permitted only through the controller that is the current manager. In AVT mode, an I/O access to the controller that is not the current manager causes it to automatically become the current manager.

Required/optional:
Returns:	The current_manager of this Volume.
Return type:	str
	required

dss_max_segment_size¶

Gets the dss_max_segment_size of this Volume. The maximum segment size (in bytes) that this volume could assume with the dynamic segment sizing feature. This field is only meaningful if dssPreallocEnabled is true.

Required/optional:
Returns:	The dss_max_segment_size of this Volume.
Return type:	int
	required

dss_prealloc_enabled¶

Gets the dss_prealloc_enabled of this Volume. True if dynamic segment sizing pre-allocation is enabled for the volume.

Required/optional:
Returns:	The dss_prealloc_enabled of this Volume.
Return type:	bool
	required

extreme_protection¶

Gets the extreme_protection of this Volume. An indication of whether the volume is configured for extreme protection. Such configurations generally call for extensive consistency checks and parity validations with each I/O request to the volume.

Required/optional:
Returns:	The extreme_protection of this Volume.
Return type:	bool
	required

id¶

Gets the id of this Volume.

Required/optional:
Returns:	The id of this Volume.
Return type:	str
	optional

label¶

Gets the label of this Volume. The user-assigned symbol label associated with the volume.

Required/optional:
Returns:	The label of this Volume.
Return type:	str
	required

media_scan¶

Gets the media_scan of this Volume. The volume-specific media scan settings currently in effect for the volume.

Required/optional:
Returns:	The media_scan of this Volume.
Return type:	VolumeMediaScanParams
	required

mgmt_client_attribute¶

Gets the mgmt_client_attribute of this Volume. For use by management client.

Required/optional:
Returns:	The mgmt_client_attribute of this Volume.
Return type:	int
	required

name¶

Gets the name of this Volume.

Required/optional:
Returns:	The name of this Volume.
Return type:	str
	optional

offline¶

Gets the offline of this Volume. An indication of whether the volume is currently offline.

Required/optional:
Returns:	The offline of this Volume.
Return type:	bool
	required

perms¶

Gets the perms of this Volume. Operations allowed on this volume.

Required/optional:
Returns:	The perms of this Volume.
Return type:	VolumePerms
	required

pre_read_redundancy_check_enabled¶

Gets the pre_read_redundancy_check_enabled of this Volume. If set to true, then the storage controller will, on READ operations, verify the consistency of RAID redundancy data for the stripe(s) containing the READ data.

Required/optional:
Returns:	The pre_read_redundancy_check_enabled of this Volume.
Return type:	bool
	required

preferred_manager¶

Gets the preferred_manager of this Volume. The reference value of the controller that is the preferred manager of the volume. The preferred manager is tracked independent of the current manager, since the current manager may be switched dynamically as a result of host-base multi-path transitions. Later, when the error conditions that cause a multi-path transition have been corrected it is still possible to determine the preferred manager and switch ownership back to it.

Required/optional:
Returns:	The preferred_manager of this Volume.
Return type:	str
	required

protection_information_capable¶

Gets the protection_information_capable of this Volume. This field is no longer used.

Required/optional:
Returns:	The protection_information_capable of this Volume.
Return type:	bool
	required

protection_type¶

Gets the protection_type of this Volume. The protection type of the volume.

Required/optional:
Returns:	The protection_type of this Volume.
Return type:	str
	required

raid_level¶

Gets the raid_level of this Volume. The RAID level for which this volume is configured.

Required/optional:
Returns:	The raid_level of this Volume.
Return type:	str
	required

recon_priority¶

Gets the recon_priority of this Volume. The reconstruction priority value for the volume. This value is in the range 0-4, with 0 indicating that reconstruction is favored over any I/O, and 4 indicating that reconstruction should be performed with minimal impact to I/O. Intermediate values indicate various levels of compromise between these two extremes.

Required/optional:
Returns:	The recon_priority of this Volume.
Return type:	int
	required

repaired_block_count¶

Gets the repaired_block_count of this Volume. This element contains a count of the number of blocks in the volume that have had data assurance errors repaired.

Required/optional:
Returns:	The repaired_block_count of this Volume.
Return type:	int
	required

sector_offset¶

Gets the sector_offset of this Volume. The sector offset of this volume within its volume group. This value is provided only to allow the client application to determine the relative positions of multiple volumes within a given volume group. No other assumptions or computations should be made with this value.

Required/optional:
Returns:	The sector_offset of this Volume.
Return type:	int
	required

segment_size¶

Gets the segment_size of this Volume. The segment size (in bytes) of the volume. The segment size is, for the most part, an indication of the stripe depth used to lay out the volume’s block addresses.

Required/optional:
Returns:	The segment_size of this Volume.
Return type:	int
	required

status¶

Gets the status of this Volume. The current operational state of the volume.

Required/optional:
Returns:	The status of this Volume.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_group_ref¶

Gets the volume_group_ref of this Volume. The volume group reference value of the volume group on which this volume resides.

Required/optional:
Returns:	The volume_group_ref of this Volume.
Return type:	str
	required

volume_handle¶

Gets the volume_handle of this Volume. The internal identifier value associated with this volume. When the Storage Partitions feature is NOT present, this value represents the logical unit number (LUN) that is used to access the volume via the host I/O path. If the Storage Partitions feature IS enabled, this field has no external meaning.

Required/optional:
Returns:	The volume_handle of this Volume.
Return type:	int
	required

volume_ref¶

Gets the volume_ref of this Volume. The unique identification value for this volume. Other objects may use this reference value to refer to the volume.

Required/optional:
Returns:	The volume_ref of this Volume.
Return type:	str
	required

world_wide_name¶

Gets the world_wide_name of this Volume. A variable-length opaque field that provides the volume’s worldwide unique identification value.

Required/optional:
Returns:	The world_wide_name of this Volume.
Return type:	str
	required

netapp.santricity.models.symbol.volume_action_progress module¶

VolumeActionProgress.py

class netapp.santricity.models.symbol.volume_action_progress.VolumeActionProgress[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

percent_complete¶

Gets the percent_complete of this VolumeActionProgress. The completion percentage of a “long-running” operation on a volume.

Required/optional:
Returns:	The percent_complete of this VolumeActionProgress.
Return type:	int
	required

time_to_completion¶

Gets the time_to_completion of this VolumeActionProgress. The estimated elapsed time to completion in minutes. Note that this field is always set to -1 for basic RAID volumes.

Required/optional:
Returns:	The time_to_completion of this VolumeActionProgress.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.volume_attribute_update_descriptor module¶

VolumeAttributeUpdateDescriptor.py

class netapp.santricity.models.symbol.volume_attribute_update_descriptor.VolumeAttributeUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

mgmt_client_attribute¶

Gets the mgmt_client_attribute of this VolumeAttributeUpdateDescriptor. Used to store a 4-byte value for use by the management client. This is not used by SANtricity.

Required/optional:
Returns:	The mgmt_client_attribute of this VolumeAttributeUpdateDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this VolumeAttributeUpdateDescriptor. The reference value that identifies the volume.

Required/optional:
Returns:	The volume_ref of this VolumeAttributeUpdateDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.volume_cache module¶

VolumeCache.py

class netapp.santricity.models.symbol.volume_cache.VolumeCache[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cache_flush_modifier¶

Gets the cache_flush_modifier of this VolumeCache. The cache flush modifier value, which is used to specify the maximum amount of time that dirty data for this volume may be retained in the controller’s write cache prior to being flushed to disk.

Required/optional:
Returns:	The cache_flush_modifier of this VolumeCache.
Return type:	str
	required

cwob¶

Gets the cwob of this VolumeCache. A true value means that the controller is allowed to use write-back caching of dirty data even when the cache memory’s battery-backup protection is not available or not operational. A false value means that any problems with the battery-backup protection of the write cache will cause the controller to suspend all write-back caching operations for the volume.

Required/optional:
Returns:	The cwob of this VolumeCache.
Return type:	bool
	required

enterprise_cache_dump¶

Gets the enterprise_cache_dump of this VolumeCache. A true value means that all dirty data in the write cache will be flushed immediately and further write-back caching will be disabled if the controller detects that a UPS unit has switched from standard power to battery backup. A false value means that write-back caching is not impacted by the state of the UPS.

Required/optional:
Returns:	The enterprise_cache_dump of this VolumeCache.
Return type:	bool
	required

mirror_active¶

Gets the mirror_active of this VolumeCache. An indication of whether the cache mirroring option is active for the volume’s data.

Required/optional:
Returns:	The mirror_active of this VolumeCache.
Return type:	bool
	required

mirror_enable¶

Gets the mirror_enable of this VolumeCache. An indication of whether the cache mirroring feature is currently enabled for this volume. It is possible that the mirrorEnable and mirrorActive values differ; this may occur, for example, if the alternate controller is removed or failed.

Required/optional:
Returns:	The mirror_enable of this VolumeCache.
Return type:	bool
	required

read_ahead_multiplier¶

Gets the read_ahead_multiplier of this VolumeCache. A true (non-zero) / false (zero) indicator of whether or not automatic cache read-ahead is enabled.

Required/optional:
Returns:	The read_ahead_multiplier of this VolumeCache.
Return type:	int
	required

read_cache_active¶

Gets the read_cache_active of this VolumeCache. An indication of whether read caching is active for the volume.

Required/optional:
Returns:	The read_cache_active of this VolumeCache.
Return type:	bool
	required

read_cache_enable¶

Gets the read_cache_enable of this VolumeCache. An indication of whether read caching is enabled for the volume. Note that this value may not match the readCacheActive setting in cases where problems with the controller cache or its battery back-up have been detected.

Required/optional:
Returns:	The read_cache_enable of this VolumeCache.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

write_cache_active¶

Gets the write_cache_active of this VolumeCache. An indication of whether write-back caching is active for the volume.

Required/optional:
Returns:	The write_cache_active of this VolumeCache.
Return type:	bool
	required

write_cache_enable¶

Gets the write_cache_enable of this VolumeCache. An indication of whether write-back caching is enabled for the volume. Note that this value may not match the writeCacheActive setting in cases where problems with the controller cache or its battery back-up have been detected.

Required/optional:
Returns:	The write_cache_enable of this VolumeCache.
Return type:	bool
	required

netapp.santricity.models.symbol.volume_cache_params_update_descriptor module¶

VolumeCacheParamsUpdateDescriptor.py

class netapp.santricity.models.symbol.volume_cache_params_update_descriptor.VolumeCacheParamsUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

cache_flush_modifier¶

Gets the cache_flush_modifier of this VolumeCacheParamsUpdateDescriptor. The cache flush modifier value, which is used to specify the maximum amount of time that dirty data for this volume may be retained in the controller’s write cache prior to being flushed to disk.

Required/optional:
Returns:	The cache_flush_modifier of this VolumeCacheParamsUpdateDescriptor.
Return type:	str
	required

cwob¶

Gets the cwob of this VolumeCacheParamsUpdateDescriptor. A true/false indication of whether caching without batteries should be allowed for this volume. Note that setting this attribute to true may result in data loss if the array’s cache hold-up battery fails, and then a disorderly power-down of the array occurs. This feature should be used only with extreme caution.

Required/optional:
Returns:	The cwob of this VolumeCacheParamsUpdateDescriptor.
Return type:	bool
	required

mirror_enable¶

Gets the mirror_enable of this VolumeCacheParamsUpdateDescriptor. A true/false indication of whether cache mirroring should be enabled for this volume. If enabled, all cache data will be mirrored across controllers to provide increased resilience to potential controller failures.

Required/optional:
Returns:	The mirror_enable of this VolumeCacheParamsUpdateDescriptor.
Return type:	bool
	required

read_ahead_multiplier¶

Gets the read_ahead_multiplier of this VolumeCacheParamsUpdateDescriptor. A true (non-zero) / false (zero) indicator of whether or not automatic cache read-ahead is enabled.

Required/optional:
Returns:	The read_ahead_multiplier of this VolumeCacheParamsUpdateDescriptor.
Return type:	int
	required

read_cache_enable¶

Gets the read_cache_enable of this VolumeCacheParamsUpdateDescriptor. A true/false indication of whether read caching should be enabled for the volume.

Required/optional:
Returns:	The read_cache_enable of this VolumeCacheParamsUpdateDescriptor.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this VolumeCacheParamsUpdateDescriptor. The reference value that identifies the volume whose cache parameters are to be updated.

Required/optional:
Returns:	The volume_ref of this VolumeCacheParamsUpdateDescriptor.
Return type:	str
	required

write_cache_enable¶

Gets the write_cache_enable of this VolumeCacheParamsUpdateDescriptor. A true/false indication of whether write-back caching should be enabled for the volume.

Required/optional:
Returns:	The write_cache_enable of this VolumeCacheParamsUpdateDescriptor.
Return type:	bool
	required

netapp.santricity.models.symbol.volume_candidate module¶

VolumeCandidate.py

class netapp.santricity.models.symbol.volume_candidate.VolumeCandidate[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

allocate_reserved_space¶

Gets the allocate_reserved_space of this VolumeCandidate. Determines whether or not reserved space is allocated on the drives in the volume group.

Required/optional:
Returns:	The allocate_reserved_space of this VolumeCandidate.
Return type:	bool
	required

candidate_selection_type¶

Gets the candidate_selection_type of this VolumeCandidate. The type of candidate selection that was used to obtain this volume candidate.

Required/optional:
Returns:	The candidate_selection_type of this VolumeCandidate.
Return type:	str
	required

drawer_loss_protection¶

Gets the drawer_loss_protection of this VolumeCandidate. This field is set to true when the volume group has drawer loss protection; otherwise it is set to false

Required/optional:
Returns:	The drawer_loss_protection of this VolumeCandidate.
Return type:	bool
	required

drive_block_format¶

Gets the drive_block_format of this VolumeCandidate. Identifies the drive block format of the volume candidate.

Required/optional:
Returns:	The drive_block_format of this VolumeCandidate.
Return type:	str
	required

drive_count¶

Gets the drive_count of this VolumeCandidate. The number of drives in the potential volume’s volume group.

Required/optional:
Returns:	The drive_count of this VolumeCandidate.
Return type:	int
	required

drive_media_type¶

Gets the drive_media_type of this VolumeCandidate. Drive media type (HDD or SSD) of the volume candidate.

Required/optional:
Returns:	The drive_media_type of this VolumeCandidate.
Return type:	str
	required

drive_ref_list¶

Gets the drive_ref_list of this VolumeCandidate. A list of the reference values of the drives on which the volume group for the potential volume would be created. This field will be valid only if the volume candidate was obtained using a candidate selection type of CANDIDATE_SEL_MANUAL.

Required/optional:
Returns:	The drive_ref_list of this VolumeCandidate.
Return type:	DriveRefList
	required

dss_prealloc_enabled¶

Gets the dss_prealloc_enabled of this VolumeCandidate. True if dynamic segment sizing pre-allocation will be enabled for the volume created from this candidate, otherwise false.

Required/optional:
Returns:	The dss_prealloc_enabled of this VolumeCandidate.
Return type:	bool
	required

free_extent_ref¶

Gets the free_extent_ref of this VolumeCandidate. The reference value of the free extent on which the potential volume would be created. This field will be valid only if the volume candidate was obtained using a candidate selection type of CANDIDATE_SEL_FREE_EXTENT.

Required/optional:
Returns:	The free_extent_ref of this VolumeCandidate.
Return type:	str
	required

phy_drive_type¶

Gets the phy_drive_type of this VolumeCandidate. The physical drive type.

Required/optional:
Returns:	The phy_drive_type of this VolumeCandidate.
Return type:	str
	required

protection_information_capabilities¶

Gets the protection_information_capabilities of this VolumeCandidate. This structure contains a protectionInformationCapable field which is set to true if all drives in the volume group where the volume candidate resides are Protection Information (PI) capable. It also contains the protection type for the volume group.

Required/optional:
Returns:	The protection_information_capabilities of this VolumeCandidate.
Return type:	ProtectionInformationCapabilities
	required

protection_information_capable¶

Gets the protection_information_capable of this VolumeCandidate. This field is no longer used.

Required/optional:
Returns:	The protection_information_capable of this VolumeCandidate.
Return type:	bool
	required

raid_level¶

Gets the raid_level of this VolumeCandidate. The RAID level of the potential volume.

Required/optional:
Returns:	The raid_level of this VolumeCandidate.
Return type:	str
	required

raw_size¶

Gets the raw_size of this VolumeCandidate. This value is the maximum allowed user data storage capacity for the volume if the smallest possible segment is used in creating the volume.

Required/optional:
Returns:	The raw_size of this VolumeCandidate.
Return type:	int
	required

security_level¶

Gets the security_level of this VolumeCandidate. Describes the overall security level of the drive set. Values can include: FDE only, FIPS only, mixed, or no security. Used along with the SecurityType field.

Required/optional:
Returns:	The security_level of this VolumeCandidate.
Return type:	str
	required

security_type¶

Gets the security_type of this VolumeCandidate. The desired security level of the drive group.

Required/optional:
Returns:	The security_type of this VolumeCandidate.
Return type:	str
	required

spindle_speed¶

Gets the spindle_speed of this VolumeCandidate. True, if all drives have matching spindle speed.

Required/optional:
Returns:	The spindle_speed of this VolumeCandidate.
Return type:	int
	required

spindle_speed_match¶

Gets the spindle_speed_match of this VolumeCandidate. True, if all drives have matching spindle speed.

Required/optional:
Returns:	The spindle_speed_match of this VolumeCandidate.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray_loss_protection¶

Gets the tray_loss_protection of this VolumeCandidate. This field is set to true if the candidate has tray loss protection.

Required/optional:
Returns:	The tray_loss_protection of this VolumeCandidate.
Return type:	bool
	required

usable_size¶

Gets the usable_size of this VolumeCandidate. This value is the maximum allowed user data storage capacity for the volume if the largest possible segment is used in creating the volume.

Required/optional:
Returns:	The usable_size of this VolumeCandidate.
Return type:	int
	required

volume_candidate_data¶

Gets the volume_candidate_data of this VolumeCandidate. Information about the Volume Candidate.

Required/optional:
Returns:	The volume_candidate_data of this VolumeCandidate.
Return type:	VolumeCandidateTypeData
	required

netapp.santricity.models.symbol.volume_candidate_list module¶

VolumeCandidateList.py

class netapp.santricity.models.symbol.volume_candidate_list.VolumeCandidateList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

return_code¶

Gets the return_code of this VolumeCandidateList. The return code.

Required/optional:
Returns:	The return_code of this VolumeCandidateList.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_candidate¶

Gets the volume_candidate of this VolumeCandidateList. A variable-length array of VolumeCandidate objects.

Required/optional:
Returns:	The volume_candidate of this VolumeCandidateList.
Return type:	list[VolumeCandidate]
	required

netapp.santricity.models.symbol.volume_candidate_request module¶

VolumeCandidateRequest.py

class netapp.santricity.models.symbol.volume_candidate_request.VolumeCandidateRequest[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

allocate_reserved_space¶

Gets the allocate_reserved_space of this VolumeCandidateRequest. If true, allocate reserved space when creating a new volume group. Ignore when creating a volume in an existing volume group

Required/optional:
Returns:	The allocate_reserved_space of this VolumeCandidateRequest.
Return type:	bool
	required

candidate_selection_type¶

Gets the candidate_selection_type of this VolumeCandidateRequest. This field contains the specification of the type of volume candidates that are desired, along with ancillary information that depends on the type of candidates.

Required/optional:
Returns:	The candidate_selection_type of this VolumeCandidateRequest.
Return type:	CandidateSelectionTypeData
	required

drive_media_type¶

Gets the drive_media_type of this VolumeCandidateRequest. Drive media type (HDD or SSD) of the volume candidate.

Required/optional:
Returns:	The drive_media_type of this VolumeCandidateRequest.
Return type:	str
	required

dss_prealloc_enabled¶

Gets the dss_prealloc_enabled of this VolumeCandidateRequest. This field indicates whether or not the firmware should base the search for candidates on the DSS preallocation calculation.

Required/optional:
Returns:	The dss_prealloc_enabled of this VolumeCandidateRequest.
Return type:	bool
	required

only_protection_information_capable¶

Gets the only_protection_information_capable of this VolumeCandidateRequest. If true, only PI-capable drives considered for volume candidates.

Required/optional:
Returns:	The only_protection_information_capable of this VolumeCandidateRequest.
Return type:	bool
	required

phy_drive_type¶

Gets the phy_drive_type of this VolumeCandidateRequest. The desired physical drive type.

Required/optional:
Returns:	The phy_drive_type of this VolumeCandidateRequest.
Return type:	str
	required

raid_level¶

Gets the raid_level of this VolumeCandidateRequest. This field indicates that RAID level in which the caller is interested. It may be set to RAID_ALL if the client wishes to obtain volume candidate information about all possible RAID levels.

Required/optional:
Returns:	The raid_level of this VolumeCandidateRequest.
Return type:	str
	required

security_level¶

Gets the security_level of this VolumeCandidateRequest. The security level describes whether a set of drives should be comprised of FDE only, FIPS only, Mixed, or no security. This field is used along with the SecurityType filed to fully define the drive set.

Required/optional:
Returns:	The security_level of this VolumeCandidateRequest.
Return type:	str
	required

security_type¶

Gets the security_type of this VolumeCandidateRequest. Desired security type of the drive group (i.e. secure vs. not secure).

Required/optional:
Returns:	The security_type of this VolumeCandidateRequest.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_candidate_request_data¶

Gets the volume_candidate_request_data of this VolumeCandidateRequest. Information about the Volume Candidate Request.

Required/optional:
Returns:	The volume_candidate_request_data of this VolumeCandidateRequest.
Return type:	VolumeCandidateRequestTypeData
	required

netapp.santricity.models.symbol.volume_candidate_request_type_data module¶

VolumeCandidateRequestTypeData.py

class netapp.santricity.models.symbol.volume_candidate_request_type_data.VolumeCandidateRequestTypeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

disk_pool_volume_candidate_request_data¶

Gets the disk_pool_volume_candidate_request_data of this VolumeCandidateRequestTypeData. This field is present only if the value of type is equal to VG_TYPE_DISK_POOL.

Required/optional:
Returns:	The disk_pool_volume_candidate_request_data of this VolumeCandidateRequestTypeData.
Return type:	DiskPoolVolumeCandidateRequestData
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this VolumeCandidateRequestTypeData. This enumeration is used to indicate the type of the volume group.

Required/optional:
Returns:	The type of this VolumeCandidateRequestTypeData.
Return type:	str
	required

netapp.santricity.models.symbol.volume_candidate_type_data module¶

VolumeCandidateTypeData.py

class netapp.santricity.models.symbol.volume_candidate_type_data.VolumeCandidateTypeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

disk_pool_volume_candidate_data¶

Gets the disk_pool_volume_candidate_data of this VolumeCandidateTypeData. This field is present only if the value of type is equal to VG_TYPE_DISK_POOL.

Required/optional:
Returns:	The disk_pool_volume_candidate_data of this VolumeCandidateTypeData.
Return type:	DiskPoolVolumeCandidateData
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this VolumeCandidateTypeData. This enumeration is used to indicate the type of the volume group.

Required/optional:
Returns:	The type of this VolumeCandidateTypeData.
Return type:	str
	required

netapp.santricity.models.symbol.volume_changeable_properties module¶

VolumeChangeableProperties.py

class netapp.santricity.models.symbol.volume_changeable_properties.VolumeChangeableProperties[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

pre_read_redundancy_check_enabled¶

Gets the pre_read_redundancy_check_enabled of this VolumeChangeableProperties. The new value of the preReadRedundancyCheckEnabled property to set for the volume. If set to true, the storage controller will, on READ operations, verify RAID redundancy data for the stripe(s) containing the READ data.

Required/optional:
Returns:	The pre_read_redundancy_check_enabled of this VolumeChangeableProperties.
Return type:	list[bool]
	required

recon_priority¶

Gets the recon_priority of this VolumeChangeableProperties. The new reconstruction priority value to be set for the volume. This value must be in the range 0-4, with 0 indicating that reconstruction is favored over any I/O, and 4 indicating that reconstruction should be performed with minimal impact to I/O. Intermediate values indicate various levels of compromise between these two extremes.

Required/optional:
Returns:	The recon_priority of this VolumeChangeableProperties.
Return type:	list[int]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.volume_copy module¶

VolumeCopy.py

class netapp.santricity.models.symbol.volume_copy.VolumeCopy[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

clone_copy¶

Gets the clone_copy of this VolumeCopy. The volume copy is a clone.

Required/optional:
Returns:	The clone_copy of this VolumeCopy.
Return type:	bool
	required

copy_complete_time¶

Gets the copy_complete_time of this VolumeCopy. Time copy operation completed.

Required/optional:
Returns:	The copy_complete_time of this VolumeCopy.
Return type:	int
	required

copy_priority¶

Gets the copy_priority of this VolumeCopy. Importance of copy operation.

Required/optional:
Returns:	The copy_priority of this VolumeCopy.
Return type:	str
	required

copy_start_time¶

Gets the copy_start_time of this VolumeCopy. Time copy operation began.

Required/optional:
Returns:	The copy_start_time of this VolumeCopy.
Return type:	int
	required

current_manager¶

Gets the current_manager of this VolumeCopy. Current owner of copy.

Required/optional:
Returns:	The current_manager of this VolumeCopy.
Return type:	str
	required

id¶

Gets the id of this VolumeCopy.

Required/optional:
Returns:	The id of this VolumeCopy.
Return type:	str
	optional

idle_target_write_prot¶

Gets the idle_target_write_prot of this VolumeCopy. Apply write protection to target volume when copy is idle (true/false).

Required/optional:
Returns:	The idle_target_write_prot of this VolumeCopy.
Return type:	bool
	required

pg_ref¶

Gets the pg_ref of this VolumeCopy. For clones based on PiT Groups, this will identify the PiT Group.

Required/optional:
Returns:	The pg_ref of this VolumeCopy.
Return type:	str
	required

reserved1¶

Gets the reserved1 of this VolumeCopy.

Required/optional:
Returns:	The reserved1 of this VolumeCopy.
Return type:	str
	optional

source_volume¶

Gets the source_volume of this VolumeCopy. Source volume reference.

Required/optional:
Returns:	The source_volume of this VolumeCopy.
Return type:	str
	required

status¶

Gets the status of this VolumeCopy. Indicates status of copy.

Required/optional:
Returns:	The status of this VolumeCopy.
Return type:	str
	required

target_volume¶

Gets the target_volume of this VolumeCopy. Target volume reference.

Required/optional:
Returns:	The target_volume of this VolumeCopy.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volcopy_handle¶

Gets the volcopy_handle of this VolumeCopy. The Volume Copy ID(ssid of proxy).

Required/optional:
Returns:	The volcopy_handle of this VolumeCopy.
Return type:	int
	required

volcopy_ref¶

Gets the volcopy_ref of this VolumeCopy. Reference (key) for copy.

Required/optional:
Returns:	The volcopy_ref of this VolumeCopy.
Return type:	str
	required

world_wide_name¶

Gets the world_wide_name of this VolumeCopy. The World Wide Name of the volume copy.

Required/optional:
Returns:	The world_wide_name of this VolumeCopy.
Return type:	str
	required

netapp.santricity.models.symbol.volume_copy_candidate module¶

VolumeCopyCandidate.py

class netapp.santricity.models.symbol.volume_copy_candidate.VolumeCopyCandidate[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this VolumeCopyCandidate. Reference to the volume

Required/optional:
Returns:	The volume_ref of this VolumeCopyCandidate.
Return type:	str
	required

netapp.santricity.models.symbol.volume_copy_candidate_list module¶

VolumeCopyCandidateList.py

class netapp.santricity.models.symbol.volume_copy_candidate_list.VolumeCopyCandidateList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

return_code¶

Gets the return_code of this VolumeCopyCandidateList. The return code from either the getVolumeCopySourceCandidates() or getVolumeCopyTargetCandidates() APIs.

Required/optional:
Returns:	The return_code of this VolumeCopyCandidateList.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_copy_candidate¶

Gets the volume_copy_candidate of this VolumeCopyCandidateList. List of target or source candidates.

Required/optional:
Returns:	The volume_copy_candidate of this VolumeCopyCandidateList.
Return type:	list[VolumeCopyCandidate]
	required

netapp.santricity.models.symbol.volume_copy_creation_descriptor module¶

VolumeCopyCreationDescriptor.py

class netapp.santricity.models.symbol.volume_copy_creation_descriptor.VolumeCopyCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

copy_priority¶

Gets the copy_priority of this VolumeCopyCreationDescriptor. Importance of copy operation.

Required/optional:
Returns:	The copy_priority of this VolumeCopyCreationDescriptor.
Return type:	str
	required

disable_snapshot¶

Gets the disable_snapshot of this VolumeCopyCreationDescriptor. When true, this indicates that the source snapshot should be disabled when the physical copy operation is complete. This field is only set to true when the volume copy is a clone.

Required/optional:
Returns:	The disable_snapshot of this VolumeCopyCreationDescriptor.
Return type:	bool
	required

idle_target_write_prot¶

Gets the idle_target_write_prot of this VolumeCopyCreationDescriptor. Apply write protection to target volume when copy is idle (true/false).

Required/optional:
Returns:	The idle_target_write_prot of this VolumeCopyCreationDescriptor.
Return type:	bool
	required

pg_ref¶

Gets the pg_ref of this VolumeCopyCreationDescriptor. For clones based on PiT Groups, this will identify the PiT Group.

Required/optional:
Returns:	The pg_ref of this VolumeCopyCreationDescriptor.
Return type:	str
	required

source_volume¶

Gets the source_volume of this VolumeCopyCreationDescriptor. The source volume reference.

Required/optional:
Returns:	The source_volume of this VolumeCopyCreationDescriptor.
Return type:	str
	required

target_volume¶

Gets the target_volume of this VolumeCopyCreationDescriptor. The target volume reference.

Required/optional:
Returns:	The target_volume of this VolumeCopyCreationDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.volume_copy_operation module¶

VolumeCopyOperation.py

class netapp.santricity.models.symbol.volume_copy_operation.VolumeCopyOperation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

pending¶

Gets the pending of this VolumeCopyOperation. If true, the operation has not started.

Required/optional:
Returns:	The pending of this VolumeCopyOperation.
Return type:	bool
	required

percent_complete¶

Gets the percent_complete of this VolumeCopyOperation. Completion percentage for the operation. If the operation is not currently running this value will be equal to PERCENT_COMPLETE_OP_NOT_RUNNING

Required/optional:
Returns:	The percent_complete of this VolumeCopyOperation.
Return type:	int
	required

time_to_completion¶

Gets the time_to_completion of this VolumeCopyOperation. Estimated time to completion in minutes. If the time is not known this value will be equal to TIME_TO_COMPLETION_UNKNOWN.

Required/optional:
Returns:	The time_to_completion of this VolumeCopyOperation.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volcopy_ref¶

Gets the volcopy_ref of this VolumeCopyOperation. Reference to the volume copy.

Required/optional:
Returns:	The volcopy_ref of this VolumeCopyOperation.
Return type:	str
	required

netapp.santricity.models.symbol.volume_copy_params_update_descriptor module¶

VolumeCopyParamsUpdateDescriptor.py

class netapp.santricity.models.symbol.volume_copy_params_update_descriptor.VolumeCopyParamsUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

copy_priority¶

Gets the copy_priority of this VolumeCopyParamsUpdateDescriptor. Importance of copy operation.

Required/optional:
Returns:	The copy_priority of this VolumeCopyParamsUpdateDescriptor.
Return type:	str
	required

idle_target_write_prot¶

Gets the idle_target_write_prot of this VolumeCopyParamsUpdateDescriptor. Apply write protection to target volume when copy is idle (true/false).

Required/optional:
Returns:	The idle_target_write_prot of this VolumeCopyParamsUpdateDescriptor.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

vol_copy_ref¶

Gets the vol_copy_ref of this VolumeCopyParamsUpdateDescriptor. The volume copy to be updated.

Required/optional:
Returns:	The vol_copy_ref of this VolumeCopyParamsUpdateDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.volume_counter_group module¶

VolumeCounterGroup.py

class netapp.santricity.models.symbol.volume_counter_group.VolumeCounterGroup[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

base_time¶

Gets the base_time of this VolumeCounterGroup. The time that the counters were last reset. Time is the number of seconds since midnight, January 1, 1970.

Required/optional:
Returns:	The base_time of this VolumeCounterGroup.
Return type:	int
	required

cache_blks_in_use¶

Gets the cache_blks_in_use of this VolumeCounterGroup. Number of cache blocks in use by this volume.

Required/optional:
Returns:	The cache_blks_in_use of this VolumeCounterGroup.
Return type:	int
	required

cache_write_wait_hit_bytes¶

Gets the cache_write_wait_hit_bytes of this VolumeCounterGroup. The number of bytes in write operations that were delayed waiting for cache flush.

Required/optional:
Returns:	The cache_write_wait_hit_bytes of this VolumeCounterGroup.
Return type:	int
	required

cache_write_wait_hit_ops¶

Gets the cache_write_wait_hit_ops of this VolumeCounterGroup. The number of write operations that are delayed, waiting for cache flush.

Required/optional:
Returns:	The cache_write_wait_hit_ops of this VolumeCounterGroup.
Return type:	int
	required

controller_ref¶

Gets the controller_ref of this VolumeCounterGroup. A reference to the controller that accumulated the counters for this group.

Required/optional:
Returns:	The controller_ref of this VolumeCounterGroup.
Return type:	str
	required

err_redundancy_chk_indeterminate_reads¶

Gets the err_redundancy_chk_indeterminate_reads of this VolumeCounterGroup. The number of read requests for which the consistency of the redundancy data could not be determined, but for which the read was carried out to completion.

Required/optional:
Returns:	The err_redundancy_chk_indeterminate_reads of this VolumeCounterGroup.
Return type:	int
	required

err_redundancy_chk_recovered_reads¶

Gets the err_redundancy_chk_recovered_reads of this VolumeCounterGroup. The number of read requests that have experienced a redundancy group inconsistency that was subsequently recovered by retrying the consistency check.

Required/optional:
Returns:	The err_redundancy_chk_recovered_reads of this VolumeCounterGroup.
Return type:	int
	required

err_redundancy_chk_unrecovered_reads¶

Gets the err_redundancy_chk_unrecovered_reads of this VolumeCounterGroup. The number of read requests that have failed due to redundancy group inconsistencies.

Required/optional:
Returns:	The err_redundancy_chk_unrecovered_reads of this VolumeCounterGroup.
Return type:	int
	required

flash_cache_read_hit_bytes¶

Gets the flash_cache_read_hit_bytes of this VolumeCounterGroup. The number of flash cache read hit bytes.

Required/optional:
Returns:	The flash_cache_read_hit_bytes of this VolumeCounterGroup.
Return type:	int
	required

flash_cache_read_hit_ops¶

Gets the flash_cache_read_hit_ops of this VolumeCounterGroup. The number of flash cache read hit operations.

Required/optional:
Returns:	The flash_cache_read_hit_ops of this VolumeCounterGroup.
Return type:	int
	required

flash_cache_read_hit_time_max¶

Gets the flash_cache_read_hit_time_max of this VolumeCounterGroup. Maximum I/O time in microseconds for any one read I/O that has a cache hit

Required/optional:
Returns:	The flash_cache_read_hit_time_max of this VolumeCounterGroup.
Return type:	int
	required

flash_cache_read_hit_time_total¶

Gets the flash_cache_read_hit_time_total of this VolumeCounterGroup. The sum of all response times for all reads that have cache hits, in microseconds

Required/optional:
Returns:	The flash_cache_read_hit_time_total of this VolumeCounterGroup.
Return type:	int
	required

flash_cache_read_hit_time_total_sq¶

Gets the flash_cache_read_hit_time_total_sq of this VolumeCounterGroup. The sum of the squares of the response times for all reads that have cache hits, in microseconds (used for standard deviation).

Required/optional:
Returns:	The flash_cache_read_hit_time_total_sq of this VolumeCounterGroup.
Return type:	int
	required

full_stripe_writes_bytes¶

Gets the full_stripe_writes_bytes of this VolumeCounterGroup. Bytes written that are categorized as Full stripe writes.

Required/optional:
Returns:	The full_stripe_writes_bytes of this VolumeCounterGroup.
Return type:	int
	required

idle_time¶

Gets the idle_time of this VolumeCounterGroup. The total time in microseconds spent idle since baseTime.

Required/optional:
Returns:	The idle_time of this VolumeCounterGroup.
Return type:	int
	required

observed_time¶

Gets the observed_time of this VolumeCounterGroup. End time for this collection as measured by the number of seconds since baseTime.

Required/optional:
Returns:	The observed_time of this VolumeCounterGroup.
Return type:	int
	required

other_ops¶

Gets the other_ops of this VolumeCounterGroup. The number of non-read-write operations.

Required/optional:
Returns:	The other_ops of this VolumeCounterGroup.
Return type:	int
	required

other_time_max¶

Gets the other_time_max of this VolumeCounterGroup. The maximum time in microseconds spent in any one non-read-write operation.

Required/optional:
Returns:	The other_time_max of this VolumeCounterGroup.
Return type:	int
	required

other_time_total¶

Gets the other_time_total of this VolumeCounterGroup. The total time in microseconds spent in non-read-write operations.

Required/optional:
Returns:	The other_time_total of this VolumeCounterGroup.
Return type:	int
	required

other_time_total_sq¶

Gets the other_time_total_sq of this VolumeCounterGroup. The sum of the squares of microseconds spent in non read-write operations.

Required/optional:
Returns:	The other_time_total_sq of this VolumeCounterGroup.
Return type:	int
	required

prefetch_hit_bytes¶

Gets the prefetch_hit_bytes of this VolumeCounterGroup. The number of pre-fetched bytes that are ultimately read by the host.

Required/optional:
Returns:	The prefetch_hit_bytes of this VolumeCounterGroup.
Return type:	int
	required

prefetch_miss_bytes¶

Gets the prefetch_miss_bytes of this VolumeCounterGroup. The number of pre-fetched bytes that are evicted from cache without being read by the host.

Required/optional:
Returns:	The prefetch_miss_bytes of this VolumeCounterGroup.
Return type:	int
	required

queue_depth_max¶

Gets the queue_depth_max of this VolumeCounterGroup. Maximum queue depth.

Required/optional:
Returns:	The queue_depth_max of this VolumeCounterGroup.
Return type:	int
	required

queue_depth_total¶

Gets the queue_depth_total of this VolumeCounterGroup. Total drive queue depth.

Required/optional:
Returns:	The queue_depth_total of this VolumeCounterGroup.
Return type:	int
	required

random_bytes_total¶

Gets the random_bytes_total of this VolumeCounterGroup. Total number of Bytes that are categorized as random.

Required/optional:
Returns:	The random_bytes_total of this VolumeCounterGroup.
Return type:	int
	required

random_ios_total¶

Gets the random_ios_total of this VolumeCounterGroup. Total number of IOs that are categorized as random.

Required/optional:
Returns:	The random_ios_total of this VolumeCounterGroup.
Return type:	int
	required

read_bytes¶

Gets the read_bytes of this VolumeCounterGroup. The number of bytes read.

Required/optional:
Returns:	The read_bytes of this VolumeCounterGroup.
Return type:	int
	required

read_hit_bytes¶

Gets the read_hit_bytes of this VolumeCounterGroup. The number of bytes read that hit cache.

Required/optional:
Returns:	The read_hit_bytes of this VolumeCounterGroup.
Return type:	int
	required

read_hit_ops¶

Gets the read_hit_ops of this VolumeCounterGroup. The number of read operations that hit cache.

Required/optional:
Returns:	The read_hit_ops of this VolumeCounterGroup.
Return type:	int
	required

read_hit_time_max¶

Gets the read_hit_time_max of this VolumeCounterGroup. The maximum time in microseconds spent in any one read operation that hit cache.

Required/optional:
Returns:	The read_hit_time_max of this VolumeCounterGroup.
Return type:	int
	required

read_hit_time_total¶

Gets the read_hit_time_total of this VolumeCounterGroup. The total time in microseconds spent in read operations that hit cache.

Required/optional:
Returns:	The read_hit_time_total of this VolumeCounterGroup.
Return type:	int
	required

read_hit_time_total_sq¶

Gets the read_hit_time_total_sq of this VolumeCounterGroup. The sum of the squares of microseconds spent in read operations that hit cache.

Required/optional:
Returns:	The read_hit_time_total_sq of this VolumeCounterGroup.
Return type:	int
	required

read_ops¶

Gets the read_ops of this VolumeCounterGroup. The number of read operations.

Required/optional:
Returns:	The read_ops of this VolumeCounterGroup.
Return type:	int
	required

read_time_max¶

Gets the read_time_max of this VolumeCounterGroup. The maximum time in microseconds spent in any one read operation.

Required/optional:
Returns:	The read_time_max of this VolumeCounterGroup.
Return type:	int
	required

read_time_total¶

Gets the read_time_total of this VolumeCounterGroup. The total time in microseconds spent in read operations.

Required/optional:
Returns:	The read_time_total of this VolumeCounterGroup.
Return type:	int
	required

read_time_total_sq¶

Gets the read_time_total_sq of this VolumeCounterGroup. The sum of the squares of microseconds spent in read operations.

Required/optional:
Returns:	The read_time_total_sq of this VolumeCounterGroup.
Return type:	int
	required

start_time¶

Gets the start_time of this VolumeCounterGroup. Start time for this collection as measured by the number of seconds since baseTime.

Required/optional:
Returns:	The start_time of this VolumeCounterGroup.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

total_blks_evicted¶

Gets the total_blks_evicted of this VolumeCounterGroup. Total number of cache blocks evicted by this volume.

Required/optional:
Returns:	The total_blks_evicted of this VolumeCounterGroup.
Return type:	int
	required

total_ios_shipped¶

Gets the total_ios_shipped of this VolumeCounterGroup. Total number of IOs shipped to this volume.

Required/optional:
Returns:	The total_ios_shipped of this VolumeCounterGroup.
Return type:	int
	required

write_bytes¶

Gets the write_bytes of this VolumeCounterGroup. The number of bytes written.

Required/optional:
Returns:	The write_bytes of this VolumeCounterGroup.
Return type:	int
	required

write_hit_bytes¶

Gets the write_hit_bytes of this VolumeCounterGroup. The number of bytes written that hit cache.

Required/optional:
Returns:	The write_hit_bytes of this VolumeCounterGroup.
Return type:	int
	required

write_hit_ops¶

Gets the write_hit_ops of this VolumeCounterGroup. The number of write operations that hit cache.

Required/optional:
Returns:	The write_hit_ops of this VolumeCounterGroup.
Return type:	int
	required

write_hit_time_max¶

Gets the write_hit_time_max of this VolumeCounterGroup. The maximum time in microseconds spent in any one write operation that hit cache.

Required/optional:
Returns:	The write_hit_time_max of this VolumeCounterGroup.
Return type:	int
	required

write_hit_time_total¶

Gets the write_hit_time_total of this VolumeCounterGroup. The total time in microseconds spent in write operations that hit cache.

Required/optional:
Returns:	The write_hit_time_total of this VolumeCounterGroup.
Return type:	int
	required

write_hit_time_total_sq¶

Gets the write_hit_time_total_sq of this VolumeCounterGroup. The sum of the squares of microseconds spent in write operations that hit cache.

Required/optional:
Returns:	The write_hit_time_total_sq of this VolumeCounterGroup.
Return type:	int
	required

write_ops¶

Gets the write_ops of this VolumeCounterGroup. The number of write operations.

Required/optional:
Returns:	The write_ops of this VolumeCounterGroup.
Return type:	int
	required

write_time_max¶

Gets the write_time_max of this VolumeCounterGroup. The maximum time in microseconds spent in any one write operation.

Required/optional:
Returns:	The write_time_max of this VolumeCounterGroup.
Return type:	int
	required

write_time_total¶

Gets the write_time_total of this VolumeCounterGroup. The total time in microseconds spent in write operations.

Required/optional:
Returns:	The write_time_total of this VolumeCounterGroup.
Return type:	int
	required

write_time_total_sq¶

Gets the write_time_total_sq of this VolumeCounterGroup. The sum of the squares of microseconds spent in write operations.

Required/optional:
Returns:	The write_time_total_sq of this VolumeCounterGroup.
Return type:	int
	required

netapp.santricity.models.symbol.volume_creation_descriptor module¶

VolumeCreationDescriptor.py

class netapp.santricity.models.symbol.volume_creation_descriptor.VolumeCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

candidate¶

Gets the candidate of this VolumeCreationDescriptor. The volume candidate object that is to be used as the basis for the new volume.

Required/optional:
Returns:	The candidate of this VolumeCreationDescriptor.
Return type:	VolumeCandidate
	required

capacity¶

Gets the capacity of this VolumeCreationDescriptor. The desired capacity of the new volume. Note that the controller may be forced to make the actual volume slightly larger than the requested size to account for arrangement of parity data, etc. If the resulting size is still smaller than the size of the volume candidate, then a new free extent will be created in addition to the new volume to account for the unused capacity.

Required/optional:
Returns:	The capacity of this VolumeCreationDescriptor.
Return type:	int
	required

label¶

Gets the label of this VolumeCreationDescriptor. The user-assigned label to be used as the name of the new volume.

Required/optional:
Returns:	The label of this VolumeCreationDescriptor.
Return type:	str
	required

manager¶

Gets the manager of this VolumeCreationDescriptor. The controller reference value of the controller that will be assigned as the owner of the newly-created volume.

Required/optional:
Returns:	The manager of this VolumeCreationDescriptor.
Return type:	str
	required

no_mapping¶

Gets the no_mapping of this VolumeCreationDescriptor. A true value indicates that the volume should not have a LUN mapping automatically created for it. Rather, a subsequent Storage Partitions operation will be required to establish such a mapping and allow host I/O accesses to be conveyed to the new volume. A false value indicates that a default mapping should be created for the new volume.

Required/optional:
Returns:	The no_mapping of this VolumeCreationDescriptor.
Return type:	bool
	required

protection_type¶

Gets the protection_type of this VolumeCreationDescriptor. This field specifies which protection type should be used for the volume being created.

Required/optional:
Returns:	The protection_type of this VolumeCreationDescriptor.
Return type:	str
	required

read_ahead¶

Gets the read_ahead of this VolumeCreationDescriptor. A true (non-zero) / false (zero) indicator of whether or not automatic cache read-ahead is enabled.

Required/optional:
Returns:	The read_ahead of this VolumeCreationDescriptor.
Return type:	int
	required

segment_size¶

Gets the segment_size of this VolumeCreationDescriptor. The desired segment size for the new volume in bytes. This must be one of the supported segment sizes, as specified in the FeatureParameters object returned by the controller. Alternatively, a value of zero can be specified to indicate that the controller should select a reasonable segment size based on the usage hint provided in the volume creation request.

Required/optional:
Returns:	The segment_size of this VolumeCreationDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_group_label¶

Gets the volume_group_label of this VolumeCreationDescriptor. The label to assign to the new volume group, if any. This field is only used when the candidate selection type is CANDIDATE_SEL_MANUAL or CANDIDATE_SEL_COUNT.

Required/optional:
Returns:	The volume_group_label of this VolumeCreationDescriptor.
Return type:	str
	required

write_zeros¶

Gets the write_zeros of this VolumeCreationDescriptor. A true value is an indication that the client wants the controller to initialize the new volume with all zeros. If this option is selected, the volume will be created and immediately transitioned to the formatting state. This operation can take an extended period of time to complete, and the volume will not be available during the process. A false value indicates that no zeroing is required; the volume will become available immediately, although a background initialization process will be running at the same time.

Required/optional:
Returns:	The write_zeros of this VolumeCreationDescriptor.
Return type:	bool
	required

netapp.santricity.models.symbol.volume_deletion_descriptor module¶

VolumeDeletionDescriptor.py

class netapp.santricity.models.symbol.volume_deletion_descriptor.VolumeDeletionDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

delete_group_on_last_vol_deletion¶

Gets the delete_group_on_last_vol_deletion of this VolumeDeletionDescriptor. An indication of how the procedure is to behave when the last volume in the group is deleted. If set to true, the volume group is also deleted; otherwise the volume group is retained.

Required/optional:
Returns:	The delete_group_on_last_vol_deletion of this VolumeDeletionDescriptor.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this VolumeDeletionDescriptor. A reference indicating which volume to delete.

Required/optional:
Returns:	The volume_ref of this VolumeDeletionDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.volume_expansion_descriptor module¶

VolumeExpansionDescriptor.py

class netapp.santricity.models.symbol.volume_expansion_descriptor.VolumeExpansionDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_ref¶

Gets the drive_ref of this VolumeExpansionDescriptor. The drives to be used for the DCE/DVE operation.

Required/optional:
Returns:	The drive_ref of this VolumeExpansionDescriptor.
Return type:	list[str]
	required

new_capacity¶

Gets the new_capacity of this VolumeExpansionDescriptor. The total new capacity requested for the volume.

Required/optional:
Returns:	The new_capacity of this VolumeExpansionDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this VolumeExpansionDescriptor. The volume that is being expanded.

Required/optional:
Returns:	The volume_ref of this VolumeExpansionDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.volume_flash_cache_descriptor module¶

VolumeFlashCacheDescriptor.py

class netapp.santricity.models.symbol.volume_flash_cache_descriptor.VolumeFlashCacheDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

flash_cache_ref¶

Gets the flash_cache_ref of this VolumeFlashCacheDescriptor. The high level flash cache volume to be linked to the flash cache proxy.

Required/optional:
Returns:	The flash_cache_ref of this VolumeFlashCacheDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this VolumeFlashCacheDescriptor. The user volume to link to the flash cache proxy.

Required/optional:
Returns:	The volume_ref of this VolumeFlashCacheDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.volume_group module¶

VolumeGroup.py

class netapp.santricity.models.symbol.volume_group.VolumeGroup[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drawer_loss_protection¶

Gets the drawer_loss_protection of this VolumeGroup. This field is set to true when the volume group has drawer loss protection; otherwise it is set to false

Required/optional:
Returns:	The drawer_loss_protection of this VolumeGroup.
Return type:	bool
	required

drive_block_format¶

Gets the drive_block_format of this VolumeGroup. Identifies the drive block format of the volume candidate.

Required/optional:
Returns:	The drive_block_format of this VolumeGroup.
Return type:	str
	required

id¶

Gets the id of this VolumeGroup.

Required/optional:
Returns:	The id of this VolumeGroup.
Return type:	str
	optional

is_inaccessible¶

Gets the is_inaccessible of this VolumeGroup. True if the volume group contains incompatible drives that have been locked out.

Required/optional:
Returns:	The is_inaccessible of this VolumeGroup.
Return type:	bool
	required

label¶

Gets the label of this VolumeGroup. The volume group label, which can be set by the user.

Required/optional:
Returns:	The label of this VolumeGroup.
Return type:	str
	required

name¶

Gets the name of this VolumeGroup.

Required/optional:
Returns:	The name of this VolumeGroup.
Return type:	str
	optional

offline¶

Gets the offline of this VolumeGroup. An indication of whether the volume group is currently offline. A volume group can be taken offline by the operator in preparation for removing its drives and transporting them to another storage array.

Required/optional:
Returns:	The offline of this VolumeGroup.
Return type:	bool
	required

protection_information_capabilities¶

Gets the protection_information_capabilities of this VolumeGroup. This structure contains a protectionInformationCapable field which is set to true if all drives in the volume group are Protection Information (PI) capable. It also contains a field that is set to the protection type for the volume group.

Required/optional:
Returns:	The protection_information_capabilities of this VolumeGroup.
Return type:	ProtectionInformationCapabilities
	required

protection_information_capable¶

Gets the protection_information_capable of this VolumeGroup. This field is no longer used.

Required/optional:
Returns:	The protection_information_capable of this VolumeGroup.
Return type:	bool
	required

raid_level¶

Gets the raid_level of this VolumeGroup. The RAID level associated with this volume group. If the storage array supports multiple RAID levels per volume group, this value will be set to RAID_ALL. Otherwise, it will indicate the precise RAID level defined for the volume group.

Required/optional:
Returns:	The raid_level of this VolumeGroup.
Return type:	str
	required

reserved1¶

Gets the reserved1 of this VolumeGroup.

Required/optional:
Returns:	The reserved1 of this VolumeGroup.
Return type:	str
	optional

reserved2¶

Gets the reserved2 of this VolumeGroup.

Required/optional:
Returns:	The reserved2 of this VolumeGroup.
Return type:	str
	optional

reserved_space_allocated¶

Gets the reserved_space_allocated of this VolumeGroup. This field will be used to report whether or not reserved space has been claimed on all drives in the volume group. The recovery-volume script will include this field for each volume group record it creates, so that during volume recovery the volume group is recreated correctly.

Required/optional:
Returns:	The reserved_space_allocated of this VolumeGroup.
Return type:	bool
	required

security_level¶

Gets the security_level of this VolumeGroup. Refines the information in the securityType field to describe the set of drives.

Required/optional:
Returns:	The security_level of this VolumeGroup.
Return type:	str
	required

security_type¶

Gets the security_type of this VolumeGroup. security status of the drive group

Required/optional:
Returns:	The security_type of this VolumeGroup.
Return type:	str
	required

sequence_num¶

Gets the sequence_num of this VolumeGroup. A sequence number that uniquely identifies this volume group within the array in which it resides. Sequence numbers are assigned to volume groups when they are created or imported into a storage array. The controller assigns the lowest unused sequence number during a creation or import operation.

Required/optional:
Returns:	The sequence_num of this VolumeGroup.
Return type:	int
	required

spindle_speed¶

Gets the spindle_speed of this VolumeGroup. Set to true if all of the drives in the group have matching normalized spindle speeds. (Normalized spindle speeds are standardized norms (e.g., 5400, 7200, etc.) that are used for spindle speed matching, even though actual spindle speeds may be within a designated delta of the normalized speed.)

Required/optional:
Returns:	The spindle_speed of this VolumeGroup.
Return type:	int
	required

spindle_speed_match¶

Gets the spindle_speed_match of this VolumeGroup. Set to true if all of the drives in the group have matching normalized spindle speeds. (Normalized spindle speeds are standardized norms (e.g., 5400, 7200, etc.) that are used for spindle speed matching, even though actual spindle speeds may be within a designated delta of the normalized speed.)

Required/optional:
Returns:	The spindle_speed_match of this VolumeGroup.
Return type:	bool
	required

state¶

Gets the state of this VolumeGroup. The state of the volume group.

Required/optional:
Returns:	The state of this VolumeGroup.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray_loss_protection¶

Gets the tray_loss_protection of this VolumeGroup. An indication as to whether the volume group has tray loss protection.

Required/optional:
Returns:	The tray_loss_protection of this VolumeGroup.
Return type:	bool
	required

usage¶

Gets the usage of this VolumeGroup. the volume group usage.

Required/optional:
Returns:	The usage of this VolumeGroup.
Return type:	str
	required

volume_group_data¶

Gets the volume_group_data of this VolumeGroup. Information about the Volume Group.

Required/optional:
Returns:	The volume_group_data of this VolumeGroup.
Return type:	VolumeGroupTypeData
	required

volume_group_ref¶

Gets the volume_group_ref of this VolumeGroup. The unique identification value for this volume group. Other objects may use this reference value to refer to the volume group.

Required/optional:
Returns:	The volume_group_ref of this VolumeGroup.
Return type:	str
	required

world_wide_name¶

Gets the world_wide_name of this VolumeGroup. A variable-length opaque field that provides the volume group’s worldwide unique identification value.

Required/optional:
Returns:	The world_wide_name of this VolumeGroup.
Return type:	str
	required

netapp.santricity.models.symbol.volume_group_creation_descriptor module¶

VolumeGroupCreationDescriptor.py

class netapp.santricity.models.symbol.volume_group_creation_descriptor.VolumeGroupCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

candidate¶

Gets the candidate of this VolumeGroupCreationDescriptor. A volume candidate returned by getVolumeCandidates. The candidateSelectionType field must be set to either CANDIDATE_SEL_MANUAL or CANDIDATE_SEL_COUNT.

Required/optional:
Returns:	The candidate of this VolumeGroupCreationDescriptor.
Return type:	VolumeCandidate
	required

label¶

Gets the label of this VolumeGroupCreationDescriptor. The label string for the volume group

Required/optional:
Returns:	The label of this VolumeGroupCreationDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.volume_group_expansion_candidate module¶

VolumeGroupExpansionCandidate.py

class netapp.santricity.models.symbol.volume_group_expansion_candidate.VolumeGroupExpansionCandidate[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drawer_loss_protection¶

Gets the drawer_loss_protection of this VolumeGroupExpansionCandidate. Set to true if the expanded volume group will have drawer loss protection.

Required/optional:
Returns:	The drawer_loss_protection of this VolumeGroupExpansionCandidate.
Return type:	bool
	required

drive_block_format¶

Gets the drive_block_format of this VolumeGroupExpansionCandidate. Identifies the drive block format of the volume candidate.

Required/optional:
Returns:	The drive_block_format of this VolumeGroupExpansionCandidate.
Return type:	str
	required

drives¶

Gets the drives of this VolumeGroupExpansionCandidate. An array of references to drives comprising the set that can be used to expand the volume group.

Required/optional:
Returns:	The drives of this VolumeGroupExpansionCandidate.
Return type:	list[str]
	required

spindle_speed_match¶

Gets the spindle_speed_match of this VolumeGroupExpansionCandidate. Set to true if the expanded volume group will have uniform spindle speed across its drives.

Required/optional:
Returns:	The spindle_speed_match of this VolumeGroupExpansionCandidate.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray_loss_protection¶

Gets the tray_loss_protection of this VolumeGroupExpansionCandidate. Set to true if the expanded volume group will have tray loss protection.

Required/optional:
Returns:	The tray_loss_protection of this VolumeGroupExpansionCandidate.
Return type:	bool
	required

usable_capacity¶

Gets the usable_capacity of this VolumeGroupExpansionCandidate. The total usable capacity of the expansion candidate in bytes.

Required/optional:
Returns:	The usable_capacity of this VolumeGroupExpansionCandidate.
Return type:	int
	required

wasted_capacity¶

Gets the wasted_capacity of this VolumeGroupExpansionCandidate. The number of bytes of wasted capacity in the given drive set if is used to expand the volume. Wasting of capacity occurs when the drives in the set are larger than the drives in the volume group being expanded.

Required/optional:
Returns:	The wasted_capacity of this VolumeGroupExpansionCandidate.
Return type:	int
	required

netapp.santricity.models.symbol.volume_group_expansion_descriptor module¶

VolumeGroupExpansionDescriptor.py

class netapp.santricity.models.symbol.volume_group_expansion_descriptor.VolumeGroupExpansionDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drive_ref¶

Gets the drive_ref of this VolumeGroupExpansionDescriptor. A variable-length array of drive references that identifies the drives to be added to the volume group to expand its capacity.

Required/optional:
Returns:	The drive_ref of this VolumeGroupExpansionDescriptor.
Return type:	list[str]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_group_ref¶

Gets the volume_group_ref of this VolumeGroupExpansionDescriptor. The reference value that identifies the volume group being expanded.

Required/optional:
Returns:	The volume_group_ref of this VolumeGroupExpansionDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.volume_group_label_update_descriptor module¶

VolumeGroupLabelUpdateDescriptor.py

class netapp.santricity.models.symbol.volume_group_label_update_descriptor.VolumeGroupLabelUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

label¶

Gets the label of this VolumeGroupLabelUpdateDescriptor. The value of the user label to set on the volume group.

Required/optional:
Returns:	The label of this VolumeGroupLabelUpdateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_group_ref¶

Gets the volume_group_ref of this VolumeGroupLabelUpdateDescriptor. A reference to the volume group that is to have its user label updated.

Required/optional:
Returns:	The volume_group_ref of this VolumeGroupLabelUpdateDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.volume_group_operation module¶

VolumeGroupOperation.py

class netapp.santricity.models.symbol.volume_group_operation.VolumeGroupOperation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

group_percent_complete¶

Gets the group_percent_complete of this VolumeGroupOperation. Completion percentage for volume group. If the operation is not currently running this value will be equal to PERCENT_COMPLETE_OP_NOT_RUNNING.

Required/optional:
Returns:	The group_percent_complete of this VolumeGroupOperation.
Return type:	int
	required

group_time_to_completion¶

Gets the group_time_to_completion of this VolumeGroupOperation. Estimated time in minutes to complete the volume group. If the time is not known this value will be equal to TIME_TO_COMPLETION_UNKNOWN.

Required/optional:
Returns:	The group_time_to_completion of this VolumeGroupOperation.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_group_ref¶

Gets the volume_group_ref of this VolumeGroupOperation. Reference to the volume group.

Required/optional:
Returns:	The volume_group_ref of this VolumeGroupOperation.
Return type:	str
	required

volume_percent_complete¶

Gets the volume_percent_complete of this VolumeGroupOperation. Completion percentage for volume currently being processed. If the operation is not currently running this value will be equal to PERCENT_COMPLETE_OP_NOT_RUNNING.

Required/optional:
Returns:	The volume_percent_complete of this VolumeGroupOperation.
Return type:	int
	required

volume_ref¶

Gets the volume_ref of this VolumeGroupOperation. Reference to the volume currently being processed.

Required/optional:
Returns:	The volume_ref of this VolumeGroupOperation.
Return type:	str
	required

volume_time_to_completion¶

Gets the volume_time_to_completion of this VolumeGroupOperation. Estimated time in minutes to complete the volume currently being processed. If the time is not known this value will be equal to TIME_TO_COMPLETION_UNKNOWN.

Required/optional:
Returns:	The volume_time_to_completion of this VolumeGroupOperation.
Return type:	int
	required

netapp.santricity.models.symbol.volume_group_ownership_update_descriptor module¶

VolumeGroupOwnershipUpdateDescriptor.py

class netapp.santricity.models.symbol.volume_group_ownership_update_descriptor.VolumeGroupOwnershipUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

manager¶

Gets the manager of this VolumeGroupOwnershipUpdateDescriptor. The controller reference value of the controller that is to be instituted as the new manager, or owner, of the volume group.

Required/optional:
Returns:	The manager of this VolumeGroupOwnershipUpdateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_group_ref¶

Gets the volume_group_ref of this VolumeGroupOwnershipUpdateDescriptor. The reference value that identifies the volume group whose ownership is to be updated.

Required/optional:
Returns:	The volume_group_ref of this VolumeGroupOwnershipUpdateDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.volume_group_ref_list module¶

VolumeGroupRefList.py

class netapp.santricity.models.symbol.volume_group_ref_list.VolumeGroupRefList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_group_ref¶

Gets the volume_group_ref of this VolumeGroupRefList. The reference value that identifies the volume group.

Required/optional:
Returns:	The volume_group_ref of this VolumeGroupRefList.
Return type:	list[str]
	required

netapp.santricity.models.symbol.volume_group_summary module¶

VolumeGroupSummary.py

class netapp.santricity.models.symbol.volume_group_summary.VolumeGroupSummary[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

drawer_loss_protection¶

Gets the drawer_loss_protection of this VolumeGroupSummary. This field is set to true when the volume group has drawer loss protection; otherwise it is set to false

Required/optional:
Returns:	The drawer_loss_protection of this VolumeGroupSummary.
Return type:	bool
	required

drive_block_format¶

Gets the drive_block_format of this VolumeGroupSummary. Identifies the drive block format of the volume candidate.

Required/optional:
Returns:	The drive_block_format of this VolumeGroupSummary.
Return type:	str
	required

drive_media_type¶

Gets the drive_media_type of this VolumeGroupSummary. This field is set to the desired drive media type of the drive.

Required/optional:
Returns:	The drive_media_type of this VolumeGroupSummary.
Return type:	str
	required

protection_information_capable¶

Gets the protection_information_capable of this VolumeGroupSummary. True when all drives in the volume group are PI capable.

Required/optional:
Returns:	The protection_information_capable of this VolumeGroupSummary.
Return type:	bool
	required

spindle_speed¶

Gets the spindle_speed of this VolumeGroupSummary. True, if all drives have matching spindle speed.

Required/optional:
Returns:	The spindle_speed of this VolumeGroupSummary.
Return type:	int
	required

spindle_speed_match¶

Gets the spindle_speed_match of this VolumeGroupSummary. True, if all drives have matching spindle speed.

Required/optional:
Returns:	The spindle_speed_match of this VolumeGroupSummary.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

tray_loss_protection¶

Gets the tray_loss_protection of this VolumeGroupSummary. True, if volume group has tray loss protection.

Required/optional:
Returns:	The tray_loss_protection of this VolumeGroupSummary.
Return type:	bool
	required

volume_capacity¶

Gets the volume_capacity of this VolumeGroupSummary. The total usable capacity of volume(s).

Required/optional:
Returns:	The volume_capacity of this VolumeGroupSummary.
Return type:	int
	required

volume_count¶

Gets the volume_count of this VolumeGroupSummary. The number of volumes in the volume group.

Required/optional:
Returns:	The volume_count of this VolumeGroupSummary.
Return type:	int
	required

volume_group_capacity¶

Gets the volume_group_capacity of this VolumeGroupSummary. The total usable capacity of the volume group.

Required/optional:
Returns:	The volume_group_capacity of this VolumeGroupSummary.
Return type:	int
	required

volume_group_security_level¶

Gets the volume_group_security_level of this VolumeGroupSummary. Refines the information in the securityType field to describe the set of drives.

Required/optional:
Returns:	The volume_group_security_level of this VolumeGroupSummary.
Return type:	str
	required

volume_group_security_type¶

Gets the volume_group_security_type of this VolumeGroupSummary. This field is used to specify the volume group security type.

Required/optional:
Returns:	The volume_group_security_type of this VolumeGroupSummary.
Return type:	str
	required

netapp.santricity.models.symbol.volume_group_type_data module¶

VolumeGroupTypeData.py

class netapp.santricity.models.symbol.volume_group_type_data.VolumeGroupTypeData[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

disk_pool_data¶

Gets the disk_pool_data of this VolumeGroupTypeData. This field is present only if the value of type is equal to VG_TYPE_DISK_POOL.

Required/optional:
Returns:	The disk_pool_data of this VolumeGroupTypeData.
Return type:	DiskPoolData
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this VolumeGroupTypeData. This enumeration is used to indicate the type of the volume group.

Required/optional:
Returns:	The type of this VolumeGroupTypeData.
Return type:	str
	required

netapp.santricity.models.symbol.volume_label_update_descriptor module¶

VolumeLabelUpdateDescriptor.py

class netapp.santricity.models.symbol.volume_label_update_descriptor.VolumeLabelUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

label¶

Gets the label of this VolumeLabelUpdateDescriptor. The new label for the volume.

Required/optional:
Returns:	The label of this VolumeLabelUpdateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this VolumeLabelUpdateDescriptor. The reference value that identifies the volume whose user-assigned label is to be updated.

Required/optional:
Returns:	The volume_ref of this VolumeLabelUpdateDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.volume_list_returned module¶

VolumeListReturned.py

class netapp.santricity.models.symbol.volume_list_returned.VolumeListReturned[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ret_code¶

Gets the ret_code of this VolumeListReturned. The return code from the procedure.

Required/optional:
Returns:	The ret_code of this VolumeListReturned.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_list_response¶

Gets the volume_list_response of this VolumeListReturned. The list of responses.

Required/optional:
Returns:	The volume_list_response of this VolumeListReturned.
Return type:	list[VolumeResponse]
	required

netapp.santricity.models.symbol.volume_media_scan_params module¶

VolumeMediaScanParams.py

class netapp.santricity.models.symbol.volume_media_scan_params.VolumeMediaScanParams[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

enable¶

Gets the enable of this VolumeMediaScanParams. A true value means that the controller should perform a media scan for this volume as part of its background processing. A false value means that the volume should not participate in media scans.

Required/optional:
Returns:	The enable of this VolumeMediaScanParams.
Return type:	bool
	required

parity_validation_enable¶

Gets the parity_validation_enable of this VolumeMediaScanParams. A true value means that, in addition to ensuring that the volume’s media blocks are fully accessible, the controller should also compute and validate all parity blocks for the volume during the media scan. A false value means that parity validation should not occur in conjunction with media checking. Note that this field has no significance unless the enable field is set to true.

Required/optional:
Returns:	The parity_validation_enable of this VolumeMediaScanParams.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.volume_media_scan_params_update_descriptor module¶

VolumeMediaScanParamsUpdateDescriptor.py

class netapp.santricity.models.symbol.volume_media_scan_params_update_descriptor.VolumeMediaScanParamsUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

new_params¶

Gets the new_params of this VolumeMediaScanParamsUpdateDescriptor. The new media scan parameters to be instituted for the volume.

Required/optional:
Returns:	The new_params of this VolumeMediaScanParamsUpdateDescriptor.
Return type:	VolumeMediaScanParams
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this VolumeMediaScanParamsUpdateDescriptor. The reference value that identifies the volume whose media scan parameters are to be updated.

Required/optional:
Returns:	The volume_ref of this VolumeMediaScanParamsUpdateDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.volume_operation module¶

VolumeOperation.py

class netapp.santricity.models.symbol.volume_operation.VolumeOperation[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

pending¶

Gets the pending of this VolumeOperation. If true, the operation has not started.

Required/optional:
Returns:	The pending of this VolumeOperation.
Return type:	bool
	required

percent_complete¶

Gets the percent_complete of this VolumeOperation. Completion percentage for the operation. If the operation is not currently running this value will be equal to PERCENT_COMPLETE_OP_NOT_RUNNING.

Required/optional:
Returns:	The percent_complete of this VolumeOperation.
Return type:	int
	required

time_to_completion¶

Gets the time_to_completion of this VolumeOperation. Estimated time to completion in minutes. If the time is not known this value will be equal to TIME_TO_COMPLETION_UNKNOWN.

Required/optional:
Returns:	The time_to_completion of this VolumeOperation.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this VolumeOperation. Reference to the volume.

Required/optional:
Returns:	The volume_ref of this VolumeOperation.
Return type:	str
	required

netapp.santricity.models.symbol.volume_ownership_fail_back_request_descriptor module¶

VolumeOwnershipFailBackRequestDescriptor.py

class netapp.santricity.models.symbol.volume_ownership_fail_back_request_descriptor.VolumeOwnershipFailBackRequestDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

both_controllers¶

Gets the both_controllers of this VolumeOwnershipFailBackRequestDescriptor. If true, the fail back operation will apply to volumes whose preferred owner is either controller, othewise the fail-back operation will apply only to those volumes with a preferred owner on the controller receiving the request.

Required/optional:
Returns:	The both_controllers of this VolumeOwnershipFailBackRequestDescriptor.
Return type:	bool
	required

ignore_connectivity¶

Gets the ignore_connectivity of this VolumeOwnershipFailBackRequestDescriptor. If true, controller will perform fail back operation of current ownership to preferred owner regardless of current host connectivity.

Required/optional:
Returns:	The ignore_connectivity of this VolumeOwnershipFailBackRequestDescriptor.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.volume_ownership_update_descriptor module¶

VolumeOwnershipUpdateDescriptor.py

class netapp.santricity.models.symbol.volume_ownership_update_descriptor.VolumeOwnershipUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

manager¶

Gets the manager of this VolumeOwnershipUpdateDescriptor. The new volume group manager.

Required/optional:
Returns:	The manager of this VolumeOwnershipUpdateDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this VolumeOwnershipUpdateDescriptor. The reference value that identifies the volume being changed.

Required/optional:
Returns:	The volume_ref of this VolumeOwnershipUpdateDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.volume_params_update_descriptor module¶

VolumeParamsUpdateDescriptor.py

class netapp.santricity.models.symbol.volume_params_update_descriptor.VolumeParamsUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

recon_priority¶

Gets the recon_priority of this VolumeParamsUpdateDescriptor. The new reconstruction priority value to be set for the volume. This value must be in the range 0-4, with 0 indicating that reconstruction is favored over any I/O, and 4 indicating that reconstruction should be performed with minimal impact to I/O. Intermediate values indicate various levels of compromise between these two extremes.

Required/optional:
Returns:	The recon_priority of this VolumeParamsUpdateDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this VolumeParamsUpdateDescriptor. The reference value that identifies the volume whose general parameters are to be updated.

Required/optional:
Returns:	The volume_ref of this VolumeParamsUpdateDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.volume_performance module¶

VolumePerformance.py

class netapp.santricity.models.symbol.volume_performance.VolumePerformance[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

average_blocks_requested¶

Gets the average_blocks_requested of this VolumePerformance. Average number of blocks requested.

Required/optional:
Returns:	The average_blocks_requested of this VolumePerformance.
Return type:	int
	required

percent_read_requests¶

Gets the percent_read_requests of this VolumePerformance. The percentReadRequests is computed directly as: (totalReadRequests * 100) / totalRequests.

Required/optional:
Returns:	The percent_read_requests of this VolumePerformance.
Return type:	int
	required

time¶

Gets the time of this VolumePerformance. Timestamp returned by controller with performance metrics.

Required/optional:
Returns:	The time of this VolumePerformance.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

total_blocks_requested¶

Gets the total_blocks_requested of this VolumePerformance. Total number of blocks requested.

Required/optional:
Returns:	The total_blocks_requested of this VolumePerformance.
Return type:	int
	required

total_cache_read_check_hits¶

Gets the total_cache_read_check_hits of this VolumePerformance. Number of cache read check hits.

Required/optional:
Returns:	The total_cache_read_check_hits of this VolumePerformance.
Return type:	int
	required

total_cache_read_checks¶

Gets the total_cache_read_checks of this VolumePerformance. This field tracks the number of calls to the cache manager to check if a host-initiated read request can be fully satisfied out of cache.

Required/optional:
Returns:	The total_cache_read_checks of this VolumePerformance.
Return type:	int
	required

total_cache_write_hits¶

Gets the total_cache_write_hits of this VolumePerformance. The number of flash cache write hits.

Required/optional:
Returns:	The total_cache_write_hits of this VolumePerformance.
Return type:	int
	required

total_cache_write_requests¶

Gets the total_cache_write_requests of this VolumePerformance. Number of cache write requests. (This field is always set to zero by firmware releases prior to 7.10.)

Required/optional:
Returns:	The total_cache_write_requests of this VolumePerformance.
Return type:	int
	required

total_flash_cache_read_hits¶

Gets the total_flash_cache_read_hits of this VolumePerformance. The total number of flash cache read hits.

Required/optional:
Returns:	The total_flash_cache_read_hits of this VolumePerformance.
Return type:	int
	required

total_large_read_blocks_requested¶

Gets the total_large_read_blocks_requested of this VolumePerformance. Total requested blocks for large reads.

Required/optional:
Returns:	The total_large_read_blocks_requested of this VolumePerformance.
Return type:	int
	required

total_large_reads¶

Gets the total_large_reads of this VolumePerformance. Total number of reads considered large.

Required/optional:
Returns:	The total_large_reads of this VolumePerformance.
Return type:	int
	required

total_large_write_blocks_requested¶

Gets the total_large_write_blocks_requested of this VolumePerformance. Total requested blocks for large writes.

Required/optional:
Returns:	The total_large_write_blocks_requested of this VolumePerformance.
Return type:	int
	required

total_large_writes¶

Gets the total_large_writes of this VolumePerformance. Total number of writes considered large.

Required/optional:
Returns:	The total_large_writes of this VolumePerformance.
Return type:	int
	required

total_read_blocks_requested¶

Gets the total_read_blocks_requested of this VolumePerformance. Total number of read blocks requested.

Required/optional:
Returns:	The total_read_blocks_requested of this VolumePerformance.
Return type:	int
	required

total_read_requests¶

Gets the total_read_requests of this VolumePerformance. Total number of read requests.

Required/optional:
Returns:	The total_read_requests of this VolumePerformance.
Return type:	int
	required

total_requests_serviced¶

Gets the total_requests_serviced of this VolumePerformance. Total number of requests.

Required/optional:
Returns:	The total_requests_serviced of this VolumePerformance.
Return type:	int
	required

total_write_blocks_requested¶

Gets the total_write_blocks_requested of this VolumePerformance. Total number of write blocks requested.

Required/optional:
Returns:	The total_write_blocks_requested of this VolumePerformance.
Return type:	int
	required

total_write_requests¶

Gets the total_write_requests of this VolumePerformance. Total number of write requests.

Required/optional:
Returns:	The total_write_requests of this VolumePerformance.
Return type:	int
	required

volume_ref¶

Gets the volume_ref of this VolumePerformance. The volume for which this information applies.

Required/optional:
Returns:	The volume_ref of this VolumePerformance.
Return type:	str
	required

netapp.santricity.models.symbol.volume_performance_list module¶

VolumePerformanceList.py

class netapp.santricity.models.symbol.volume_performance_list.VolumePerformanceList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_perf¶

Gets the volume_perf of this VolumePerformanceList. A variable-length array of VolumePerformance objects.

Required/optional:
Returns:	The volume_perf of this VolumePerformanceList.
Return type:	list[VolumePerformance]
	required

netapp.santricity.models.symbol.volume_perms module¶

VolumePerms.py

class netapp.santricity.models.symbol.volume_perms.VolumePerms[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

allow_dss¶

Gets the allow_dss of this VolumePerms. If true, this volume can undergo a segment size change (DSS). If false, this will still allow general reconfigures (providing the ‘reconfigure’ field is true), but disallow DSS specifically.

Required/optional:
Returns:	The allow_dss of this VolumePerms.
Return type:	bool
	required

allow_dve¶

Gets the allow_dve of this VolumePerms. If true, this volume can be expanded via DVE. If false, this will still allow general reconfigures (providing the ‘reconfigure’ field is true), but disallow DVE specifically.

Required/optional:
Returns:	The allow_dve of this VolumePerms.
Return type:	bool
	required

allow_thin_growth_parameters_change¶

Gets the allow_thin_growth_parameters_change of this VolumePerms. If true, changes to the growth parameters (quota or warning threshold values) while the thin volume is in an Asynchronous Mirror Group (AMG) are allowed.

Required/optional:
Returns:	The allow_thin_growth_parameters_change of this VolumePerms.
Return type:	bool
	required

allow_thin_manual_expansion¶

Gets the allow_thin_manual_expansion of this VolumePerms. If true, changes to manual mode while the thin volume is in an Asynchronous Mirror Group (AMG) are allowed.

Required/optional:
Returns:	The allow_thin_manual_expansion of this VolumePerms.
Return type:	bool
	required

async_mirror_primary¶

Gets the async_mirror_primary of this VolumePerms. If true, this volume can be an Async RVM primary.

Required/optional:
Returns:	The async_mirror_primary of this VolumePerms.
Return type:	bool
	required

async_mirror_secondary¶

Gets the async_mirror_secondary of this VolumePerms. If true, this volume can be an Async RVM primary.

Required/optional:
Returns:	The async_mirror_secondary of this VolumePerms.
Return type:	bool
	required

cache_parameters_changeable¶

Gets the cache_parameters_changeable of this VolumePerms. If true, cache parameters may be changed on this volume.

Required/optional:
Returns:	The cache_parameters_changeable of this VolumePerms.
Return type:	bool
	required

concat_volume_member¶

Gets the concat_volume_member of this VolumePerms. If true, this volume can be a member of a ConcatVolume.

Required/optional:
Returns:	The concat_volume_member of this VolumePerms.
Return type:	bool
	required

copy_source¶

Gets the copy_source of this VolumePerms. This is true if the volume can be the source for a copy.

Required/optional:
Returns:	The copy_source of this VolumePerms.
Return type:	bool
	required

copy_target¶

Gets the copy_target of this VolumePerms. This is true if the volume can be the target for a copy.

Required/optional:
Returns:	The copy_target of this VolumePerms.
Return type:	bool
	required

flash_read_cache¶

Gets the flash_read_cache of this VolumePerms. If true, this volume can have flash read cache enabled.

Required/optional:
Returns:	The flash_read_cache of this VolumePerms.
Return type:	bool
	required

format¶

Gets the format of this VolumePerms. This is true if the volume can be formatted.

Required/optional:
Returns:	The format of this VolumePerms.
Return type:	bool
	required

map_to_lun¶

Gets the map_to_lun of this VolumePerms. Can this volume be mapped to a LUN

Required/optional:
Returns:	The map_to_lun of this VolumePerms.
Return type:	bool
	required

mirror_primary¶

Gets the mirror_primary of this VolumePerms. This is true if the volume can be a primary mirror.

Required/optional:
Returns:	The mirror_primary of this VolumePerms.
Return type:	bool
	required

mirror_secondary¶

Gets the mirror_secondary of this VolumePerms. This is true if the volume can be a secondary mirror.

Required/optional:
Returns:	The mirror_secondary of this VolumePerms.
Return type:	bool
	required

mirror_sync¶

Gets the mirror_sync of this VolumePerms. Set to true if a remote volume mirror can actively synchronize this volume’s data

Required/optional:
Returns:	The mirror_sync of this VolumePerms.
Return type:	bool
	required

new_image¶

Gets the new_image of this VolumePerms. Set to true when a new point-in-time image can be taken of this volume, either by creating a new snapshot or re-creating an existing snapshot.

Required/optional:
Returns:	The new_image of this VolumePerms.
Return type:	bool
	required

pit_group¶

Gets the pit_group of this VolumePerms. If true, a PiT group can be created on this volume.

Required/optional:
Returns:	The pit_group of this VolumePerms.
Return type:	bool
	required

readable¶

Gets the readable of this VolumePerms. This is true if the volume can be read by a host.

Required/optional:
Returns:	The readable of this VolumePerms.
Return type:	bool
	required

reconfigure¶

Gets the reconfigure of this VolumePerms. This is true if the volume can be reconfigured (DVE, DCE, DRM, etc.).

Required/optional:
Returns:	The reconfigure of this VolumePerms.
Return type:	bool
	required

rollback¶

Gets the rollback of this VolumePerms. Set to true if a snapshot rollback can be applied to this volume.

Required/optional:
Returns:	The rollback of this VolumePerms.
Return type:	bool
	required

snap_shot¶

Gets the snap_shot of this VolumePerms. This is true if the volume can have a snapshot.

Required/optional:
Returns:	The snap_shot of this VolumePerms.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

writable¶

Gets the writable of this VolumePerms. Can this volume be written by a host

Required/optional:
Returns:	The writable of this VolumePerms.
Return type:	bool
	required

netapp.santricity.models.symbol.volume_properties_update_descriptor module¶

VolumePropertiesUpdateDescriptor.py

class netapp.santricity.models.symbol.volume_properties_update_descriptor.VolumePropertiesUpdateDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

settings¶

Gets the settings of this VolumePropertiesUpdateDescriptor. The new property settings for the volume.

Required/optional:
Returns:	The settings of this VolumePropertiesUpdateDescriptor.
Return type:	VolumeChangeableProperties
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this VolumePropertiesUpdateDescriptor. The reference value that identifies the volume being changed.

Required/optional:
Returns:	The volume_ref of this VolumePropertiesUpdateDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.volume_raid_migration_descriptor module¶

VolumeRAIDMigrationDescriptor.py

class netapp.santricity.models.symbol.volume_raid_migration_descriptor.VolumeRAIDMigrationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

new_raid_level¶

Gets the new_raid_level of this VolumeRAIDMigrationDescriptor. The new RAID level to be assigned to the volumes in the volume group.

Required/optional:
Returns:	The new_raid_level of this VolumeRAIDMigrationDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_group_ref¶

Gets the volume_group_ref of this VolumeRAIDMigrationDescriptor. The reference value that identifies the volume group whose RAID level is to be changed.

Required/optional:
Returns:	The volume_group_ref of this VolumeRAIDMigrationDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.volume_response module¶

VolumeResponse.py

class netapp.santricity.models.symbol.volume_response.VolumeResponse[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ret_code¶

Gets the ret_code of this VolumeResponse. The return code.

Required/optional:
Returns:	The ret_code of this VolumeResponse.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this VolumeResponse. The volume.

Required/optional:
Returns:	The volume_ref of this VolumeResponse.
Return type:	str
	required

netapp.santricity.models.symbol.volume_scan_descriptor module¶

VolumeScanDescriptor.py

class netapp.santricity.models.symbol.volume_scan_descriptor.VolumeScanDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ending_lba¶

Gets the ending_lba of this VolumeScanDescriptor. The ending LBA of the scan/repair.

Required/optional:
Returns:	The ending_lba of this VolumeScanDescriptor.
Return type:	int
	required

priority¶

Gets the priority of this VolumeScanDescriptor. Scan priority

Required/optional:
Returns:	The priority of this VolumeScanDescriptor.
Return type:	str
	required

repair_media¶

Gets the repair_media of this VolumeScanDescriptor. When this parameter is set to true(1) the controller will automatically repair any media errors detected during the scan. When it is set to false(0) the scan will stop on any media error detected and report the error in the ParityScanResponse.

Required/optional:
Returns:	The repair_media of this VolumeScanDescriptor.
Return type:	bool
	required

repair_parity¶

Gets the repair_parity of this VolumeScanDescriptor. When this parameter is set to true(1) the parity for the data stripe containing startingLBA will be repaired. When this parameter is set to false(0) the controller performs a volume parity scan on the data from startingLBA to endingLBA.

Required/optional:
Returns:	The repair_parity of this VolumeScanDescriptor.
Return type:	bool
	required

starting_lba¶

Gets the starting_lba of this VolumeScanDescriptor. The starting LBA of the scan/repair.

Required/optional:
Returns:	The starting_lba of this VolumeScanDescriptor.
Return type:	int
	required

timeout¶

Gets the timeout of this VolumeScanDescriptor. Volume scan timeout, in seconds.

Required/optional:
Returns:	The timeout of this VolumeScanDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this VolumeScanDescriptor. The reference value that identifies the volume to be scanned/repaired.

Required/optional:
Returns:	The volume_ref of this VolumeScanDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.volume_segment_sizing_descriptor module¶

VolumeSegmentSizingDescriptor.py

class netapp.santricity.models.symbol.volume_segment_sizing_descriptor.VolumeSegmentSizingDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

new_segment_size¶

Gets the new_segment_size of this VolumeSegmentSizingDescriptor. The new segment size, expressed in bytes, to be used for the volume. This must be one of the supported segment sizes, as specified in the FeatureParameters object returned by the controller.

Required/optional:
Returns:	The new_segment_size of this VolumeSegmentSizingDescriptor.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this VolumeSegmentSizingDescriptor. The reference value that identifies the volume whose segment size is to be changed.

Required/optional:
Returns:	The volume_ref of this VolumeSegmentSizingDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.volume_type_parameters module¶

VolumeTypeParameters.py

class netapp.santricity.models.symbol.volume_type_parameters.VolumeTypeParameters[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

capacity_provisioning_details¶

Gets the capacity_provisioning_details of this VolumeTypeParameters. This field is returned if the value of returnCode is equal to RETCODE_OK.

Required/optional:
Returns:	The capacity_provisioning_details of this VolumeTypeParameters.
Return type:	ThinVolumeCapacityProvisioningDetails
	optional

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_type¶

Gets the volume_type of this VolumeTypeParameters. This enumeration is used to identify the capacity provisioning of a volume.

Required/optional:
Returns:	The volume_type of this VolumeTypeParameters.
Return type:	str
	required

netapp.santricity.models.symbol.volume_usage_hint module¶

VolumeUsageHint.py

class netapp.santricity.models.symbol.volume_usage_hint.VolumeUsageHint[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

read_ahead¶

Gets the read_ahead of this VolumeUsageHint. A true (non-zero) / false (zero) indicator of whether or not automatic cache read-ahead is enabled.

Required/optional:
Returns:	The read_ahead of this VolumeUsageHint.
Return type:	int
	required

segment_size¶

Gets the segment_size of this VolumeUsageHint. The volume segment size.

Required/optional:
Returns:	The segment_size of this VolumeUsageHint.
Return type:	int
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

usage_hint¶

Gets the usage_hint of this VolumeUsageHint. How the volume will be used (e.g. multimedia, transactional, file system).

Required/optional:
Returns:	The usage_hint of this VolumeUsageHint.
Return type:	str
	required

netapp.santricity.models.symbol.wlc_analytics_chunk_details module¶

WlcAnalyticsChunkDetails.py

class netapp.santricity.models.symbol.wlc_analytics_chunk_details.WlcAnalyticsChunkDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

wlc_analytics_data¶

Gets the wlc_analytics_data of this WlcAnalyticsChunkDetails. This element contains the raw workload capture data.

Required/optional:
Returns:	The wlc_analytics_data of this WlcAnalyticsChunkDetails.
Return type:	str
	required

netapp.santricity.models.symbol.wlc_analytics_start_details module¶

WlcAnalyticsStartDetails.py

class netapp.santricity.models.symbol.wlc_analytics_start_details.WlcAnalyticsStartDetails[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

clear¶

Gets the clear of this WlcAnalyticsStartDetails. This flag indicates whether the workload capture data should be cleared after it is retrieved.

Required/optional:
Returns:	The clear of this WlcAnalyticsStartDetails.
Return type:	bool
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.workload module¶

Workload.py

class netapp.santricity.models.symbol.workload.Workload[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

description¶

Gets the description of this Workload. The workload description describes the workload (not the workload type).

Required/optional:
Returns:	The description of this Workload.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

workload_ref¶

Gets the workload_ref of this Workload. The unique handle for the object contained within this structure (a 1st class object).

Required/optional:
Returns:	The workload_ref of this Workload.
Return type:	str
	required

netapp.santricity.models.symbol.workload_creation_descriptor module¶

WorkloadCreationDescriptor.py

class netapp.santricity.models.symbol.workload_creation_descriptor.WorkloadCreationDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

description¶

Gets the description of this WorkloadCreationDescriptor. Application awareness workloads.

Required/optional:
Returns:	The description of this WorkloadCreationDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.workload_creation_descriptor_list module¶

WorkloadCreationDescriptorList.py

class netapp.santricity.models.symbol.workload_creation_descriptor_list.WorkloadCreationDescriptorList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

descriptor¶

Gets the descriptor of this WorkloadCreationDescriptorList. Contains the AppAwareWorkload descriptor objects.

Required/optional:
Returns:	The descriptor of this WorkloadCreationDescriptorList.
Return type:	list[WorkloadCreationDescriptor]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.workload_ref_list module¶

WorkloadRefList.py

class netapp.santricity.models.symbol.workload_ref_list.WorkloadRefList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

workload_ref¶

Gets the workload_ref of this WorkloadRefList. An array of references for the key-value tags used for application awareness.

Required/optional:
Returns:	The workload_ref of this WorkloadRefList.
Return type:	list[str]
	required

netapp.santricity.models.symbol.workload_volume_create_mapping_descriptor module¶

WorkloadVolumeCreateMappingDescriptor.py

class netapp.santricity.models.symbol.workload_volume_create_mapping_descriptor.WorkloadVolumeCreateMappingDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this WorkloadVolumeCreateMappingDescriptor. The unique identifier for the volume that is to be mapped to the workload.

Required/optional:
Returns:	The volume_ref of this WorkloadVolumeCreateMappingDescriptor.
Return type:	str
	required

workload_ref¶

Gets the workload_ref of this WorkloadVolumeCreateMappingDescriptor. The unique identifier for the workload to be mapped to the volume.

Required/optional:
Returns:	The workload_ref of this WorkloadVolumeCreateMappingDescriptor.
Return type:	str
	required

netapp.santricity.models.symbol.workload_volume_create_mapping_descriptor_list module¶

WorkloadVolumeCreateMappingDescriptorList.py

class netapp.santricity.models.symbol.workload_volume_create_mapping_descriptor_list.WorkloadVolumeCreateMappingDescriptorList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

create_descriptor¶

Gets the create_descriptor of this WorkloadVolumeCreateMappingDescriptorList. The list of workloads and volumes to be associated to each other.

Required/optional:
Returns:	The create_descriptor of this WorkloadVolumeCreateMappingDescriptorList.
Return type:	list[WorkloadVolumeCreateMappingDescriptor]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.workload_volume_delete_mapping_descriptor module¶

WorkloadVolumeDeleteMappingDescriptor.py

class netapp.santricity.models.symbol.workload_volume_delete_mapping_descriptor.WorkloadVolumeDeleteMappingDescriptor[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

mapping_ref¶

Gets the mapping_ref of this WorkloadVolumeDeleteMappingDescriptor. The unique identifier for the mapping to be deleted.

Required/optional:
Returns:	The mapping_ref of this WorkloadVolumeDeleteMappingDescriptor.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.workload_volume_delete_mapping_descriptor_list module¶

WorkloadVolumeDeleteMappingDescriptorList.py

class netapp.santricity.models.symbol.workload_volume_delete_mapping_descriptor_list.WorkloadVolumeDeleteMappingDescriptorList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

delete_descriptor¶

Gets the delete_descriptor of this WorkloadVolumeDeleteMappingDescriptorList. The list of mappings between workloads and volumes to be deleted.

Required/optional:
Returns:	The delete_descriptor of this WorkloadVolumeDeleteMappingDescriptorList.
Return type:	list[WorkloadVolumeDeleteMappingDescriptor]
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

netapp.santricity.models.symbol.workload_volume_mapping module¶

WorkloadVolumeMapping.py

class netapp.santricity.models.symbol.workload_volume_mapping.WorkloadVolumeMapping[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

mapping_ref¶

Gets the mapping_ref of this WorkloadVolumeMapping. This field is the unique identifier for the mapping between the workload and the volume.

Required/optional:
Returns:	The mapping_ref of this WorkloadVolumeMapping.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

volume_ref¶

Gets the volume_ref of this WorkloadVolumeMapping. This field is the unique identifier for the volume.

Required/optional:
Returns:	The volume_ref of this WorkloadVolumeMapping.
Return type:	str
	required

workload_ref¶

Gets the workload_ref of this WorkloadVolumeMapping. This field is the unique identifier for the Workload.

Required/optional:
Returns:	The workload_ref of this WorkloadVolumeMapping.
Return type:	str
	required

netapp.santricity.models.symbol.wrapped_lock_key module¶

WrappedLockKey.py

class netapp.santricity.models.symbol.wrapped_lock_key.WrappedLockKey[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

lock_key_id¶

Gets the lock_key_id of this WrappedLockKey. Lock Key Identifier, or a Lock Key ID.

Required/optional:
Returns:	The lock_key_id of this WrappedLockKey.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

wrapped_lock_key¶

Gets the wrapped_lock_key of this WrappedLockKey. The 40Byte encrypted wrappedLockKey string that originates from a user specified passPhrase.

Required/optional:
Returns:	The wrapped_lock_key of this WrappedLockKey.
Return type:	str
	required

netapp.santricity.models.symbol.wrapped_lock_key_list module¶

WrappedLockKeyList.py

class netapp.santricity.models.symbol.wrapped_lock_key_list.WrappedLockKeyList[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

wrapped_lock_key¶

Gets the wrapped_lock_key of this WrappedLockKeyList. Contains the wrapped lock key.

Required/optional:
Returns:	The wrapped_lock_key of this WrappedLockKeyList.
Return type:	list[WrappedLockKey]
	required

netapp.santricity.models.symbol.wrapped_lock_key_return module¶

WrappedLockKeyReturn.py

class netapp.santricity.models.symbol.wrapped_lock_key_return.WrappedLockKeyReturn[source]¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

lock_key¶

Gets the lock_key of this WrappedLockKeyReturn. This WrappedLockKey contains the lockKeyID and the associated encrypted wrappedLockKey string.

Required/optional:
Returns:	The lock_key of this WrappedLockKeyReturn.
Return type:	WrappedLockKey
	optional

return_code¶

Gets the return_code of this WrappedLockKeyReturn. An enumeration used to determine the return status of a SYMbol function call.

Required/optional:
Returns:	The return_code of this WrappedLockKeyReturn.
Return type:	str
	required

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model