System

This section gives examples of the following system functionality:

• Health Checks

• Audit Logs

• Download & Upload Settings

Health Checks

This example of system calls demonstrates performing a system health check, retrieving information from the last health check, querying for all installed disk IDs in an array and outputting information about each.

"""docs/source/programmers_guide_src/code/system-health_check.py."""

import PyU4V

# Initialise PyU4V connection to Unisphere
conn = PyU4V.U4VConn()

# Perform a system health check, this call can take 15-20 minutes to
# complete in Unisphere due to the nature of the checks performed
conn.system.perform_health_check(description='test-hc-dec19')

# Get details of the last system health check
health_check = conn.system.get_system_health()

# Get a list of physical disks installed in the array
disk_list = conn.system.get_disk_id_list()
# Get disk information for each disk installed
for disk in disk_list.get('disk_ids'):
    disk_info = conn.system.get_disk_details(disk_id=disk)

# Close the session
conn.close_session()

Audit Logs

The storage system audit records include all actions that are taken on that storage system. The storage system audit records come from the SYMAPI database and include all actions that are taken on that storage system. The audit log resides on the storage system and currently has a maximum size of 40 MB. Once the 40 MB limit is reached, the log begins to overwrite itself. Beginning in Unisphere release 9.2, operations that are executed through Unisphere UI have been added to the audit log.

Warning

Audit logs can be very large. You are warned that the operation may take a long time if you attempt to retrieved audit log records for a time period of greater than 7 days.

In the example below a query is made to return audit logs for the last hour which match a provided user name and client host name. A sample audit log record is then queried to return more detailed information.

"""docs/source/programmers_guide_src/code/system-audit_log_query.py."""

import random
import time

import PyU4V

# Initialise PyU4V connection to Unisphere
conn = PyU4V.U4VConn()

# Get a list of audit logs for the last ten minutes where the user name and
# host name are defined as filters to return only matching results. Note, the
# time interval here, similar to performance calls, is also in milliseconds
# since epoch
current_time = int(time.time()) * 1000
start_time = current_time - (60 * 10 * 1000)
audit_log_list = conn.system.get_audit_log_list(
    start_time=start_time, end_time=current_time, user_name='PyU4V',
    host_name='PyU4V-Host')

# Select an audit log record from the list of audit logs and get the
# associated audit log record ID
audit_log_record = random.choice(audit_log_list)
audit_log_record_id = audit_log_record.get('record_id')

# Retrieve detailed information on a record returned in the audit log list
audit_log_detailed = conn.system.get_audit_log_record(
    record_id=audit_log_record_id)

# Close the session
conn.close_session()

In addition to querying audit logs via REST it is possible to download a PDF audit log record for the previous week. The example below demonstrates this.

Note

When providing a file_name there is no need to add the .pdf extension, PyU4V will do this automatically.

Note

When downloading an audit log record, it is possible to return the binary data instead of writing to pdf automatically, this allows you to handle the file writing process yourself. To do so just set return_binary=True. The data will be stored in the response dict under the key binary_data.

"""docs/source/programmers_guide_src/code/system-audit_log_download.py."""

import PyU4V

# Initialise PyU4V connection to Unisphere
conn = PyU4V.U4VConn()

# Download PDF audit log record for the last week for primary array
audit_log_details = conn.system.download_audit_log_record(
    return_binary=False, dir_path='~/datastore/audit_records',
    file_name='audit-log-sept2020')

# Assert the download operation was successful
assert audit_log_details.get('success') is True
print('The audit log has been downloaded to: {loc}'.format(
    loc=audit_log_details.get('audit_record_path')))

# Close the session
conn.close_session()

Download & Upload Settings

Unisphere allows an authorized user with appropriate access to manage system settings. Settings can also be cloned, that is, settings can be copied from one array and applied to one or more target arrays subject to compatibility checks. In addition to cloning system settings from one array to another, it is also possible to clone Unisphere settings from one instance to another.

The exported settings have a generic format and do not contain any specific information regarding particular storage array or Unisphere instance, thus making it applicable in any environment.

The intention is to help users to port the system wide settings to another instance of Unisphere, and also to capture single array settings so that they can be applied to another storage array within single instance or another instance of Unisphere at any point of time.

The example below downloading system settings for the primary array and applying those same settings to another array registered to the same instance of Unisphere.

Note

A file_password is required not to protect the file when it is downloaded to a local computer, it is to verify the settings when they are being applied to another system or instance of Unisphere. This prevents unauthorised settings changes by people who have access to the data file.

"""docs/source/programmers_guide_src/code/system-settings_management.py."""

import PyU4V

# Initialise PyU4V connection to Unisphere
conn = PyU4V.U4VConn()

# Download system settings for primary array defined in PyU4V.conf, exclude the
# system thresholds settings
settings_info = conn.system.download_system_settings(
    file_password='PyU4V', dir_path='~/datastore/system_settings',
    file_name='settings_gold_master', exclude_system_threshold_settings=True)

# Assert the download operation was successful and print the location of the
# downloaded file
assert settings_info.get('success') is True
print('The system settings for {array} are saved to: {loc}'.format(
    array=conn.array_id, loc=settings_info.get('settings_path')))

# Upload the settings and apply to target array
upload_details = conn.system.upload_settings(
    file_password='PyU4V', file_path=settings_info.get('settings_path'),
    array_id='000111222333')

# Close the session
conn.close_session()