Dell EMC PowerStore Service Scripts Guide Version 2.x June 2021 Rev.
Notes, cautions, and warnings NOTE: A NOTE indicates important information that helps you make better use of your product. CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem. WARNING: A WARNING indicates a potential for property damage, personal injury, or death. © 2020 - 2021 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries.
Contents Additional Resources.....................................................................................................................5 Chapter 1: Introduction................................................................................................................. 6 Audience................................................................................................................................................................................ 6 Running the service scripts...........
Install the PowerStore system (svc_manufacturing)............................................................................................... 41 Retrieve information as a root user (svc_mgmt_operations)................................................................................43 Migrate a cluster or DVS to another vCenter (svc_migrate_to_vcenter)......................................................... 44 Migrate to vCenter (svc_migrate_to_vcenter migrate_to_vcenter).................................
Preface As part of an improvement effort, revisions of the software and hardware are periodically released. Some functions that are described in this document are not supported by all versions of the software or hardware currently in use. The product release notes provide the most up-to-date information about product features. Contact your service provider if a product does not function properly or does not function as described in this document.
1 Introduction PowerStore includes service scripts that enable you to diagnose issues, solve common problems, perform certain operational tasks, and recover your system from an error state. These scripts provide in-depth level of information and a lower level of system control than is available through other interfaces such as PowerStore Manager, CLI, and REST API. This document describes these service scripts and how you can use them.
2 Service Commands This chapter contains the following topics: Topics: • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • Shut down and reboot an appliance (svc_appliance) Provision an appliance (svc_appliance_provisioning) Capture array configuration data (svc_arrayconfig) Make space on the root partition (svc_cleanup) Clear firmware update (svc_clear_fw_update_alert) Shut down a SAN cluster (svc_cluster) Diagnose a create cluster failure (svc_cluster_diag) Cluster
Shut down and reboot an appliance (svc_appliance) This service script allows you to perform a managed shutdown and reboot of a single appliance in SAN mode.
Optional arguments Qualifier Description -h, --help Show the help message and exit. -d, --debug Initiate verbose logging for debugging purposes. -f, --force Ignore warnings when starting the action; force reboot, which may result in data becoming unavailable. -a, --async Run in asynchronous mode. Shut down an appliance (svc_appliance shutdown) This service script is used to shutdown an appliance.
Format svc_appliance_provisioning [-h] {enable,list,disable} Optional Arguments Qualifier Description -h, --help Show the help message and exit. Actions Action Description enable Enable provisioning on the appliance. list List provisioning on the appliance. disable Disable provisioning on the appliance. Usage Example The following example shows appliance provisioning being disabled for appliance A2.
Optional arguments Qualifier Description -h, --help Show the help message and exit. Actions Action Description run Capture the current cluster configuration. Capture current cluster configuration (svc_arrayconfig run) This service script captures the current cluster configuration.
Examples The following example shows the script being run from the service container as root: svc_arrayconfig run -f json --output /cyc_host/cyc_service/tmp1 --type full --config / cyc_host/cyc_service/conf/ConfigCaptureConfig.json svc_arrayconfig run -f json --output /cyc_host/cyc_service/tmp1 --type metrics --config /cyc_host/cyc_service/conf/MetricsCaptureConfig.
Qualifier Description -j, --journalFiles Clean up the journal files. -t, --tmpDataCollection Clean up the temporary data collection directory. Bypass confirmation messages. -y, --noConfirm Clear firmware update (svc_clear_fw_update_alert) This service script enables you to clear the firmware update alert on a given node.
Example The following example shows the firmware update alerts being cleared on nodes A and B: svc_clear_fw_update_alert clear_alert [-h] {A,B} Shut down a SAN cluster (svc_cluster) This service script enables you to shut down all the appliances in a SAN cluster. This operation can only be performed on SAN clusters.
Diagnose a create cluster failure (svc_cluster_diag) This service script is intended to be run in order to help troubleshoot issues that may happen during create cluster, adding an appliance, or removing an appliance. This script performs the following functions: 1. Search for a hardware check in the journal. This step looks for hardware faults that may have happened before the create cluster operation. 2. Run a current hardware check on this system using svc_diag list --icw_hardware.
Example The following output indicates that no logs are available and the system is running a support materials bundle after you have entered the svc_cluster_diag -w command: svc_cluster_diag -w The log statements that are needed to collect information for the command: 'journalctl --utc -t control-path | egrep "\[CC\]" | grep WARN' are no longer available Would you like to perform a data collection? Please enter 'yes' or 'no' yes Running data collection - This might take awhile data collection ID f10a1ebb-5
Optional arguments Qualifier Description -h, --help Show the help message and exit. Actions Action Description GetClusterStatus Display current cluster status. DetachFailedAppliance Detach a failed appliance. ReattachAppliance Reattach an appliance. PrepReattachAppliance Prepare an appliance for reattachment. MoveMasterAppliance Move the master role to a different appliance. Remove and reattach an appliance 1.
Remove and reattach an appliance If a two-appliance cluster has a failed appliance, you can use the svc_cluster_management script to detach the appliance and reattach it when the problem is resolved. Steps 1.
Usage Function System Operations Mode Service Usage Service Requires service user password? Yes Requires root privileges? No May cause data unavailability? Yes May cause data loss? No Scope Node Prerequisites None Format svc_commit_slic [-h] [-v] {status,reset,activate,replay} Optional arguments Qualifier Description -h, --help Show the help message and exit. -v,--verbose Output more details. Actions Qualifier Description activate Activate the commit procedure.
Usage Examples svc_commit_slic activate 1 Configure inserted SLICs with slot index 1 reboot) svc_commit_slic activate 0 --resume Resume commit procedure if it is interrupted by HA case (a component or node svc_commit_slic status 0 Show info about the SLICs, its children objects and activation state machine status for specific SLICs svc_commit_slic reset 0 Resets activation state machine, if there is no activation in progress.
Actions Action Description status Show the status of the container. restart Restart the container. Support materials (svc_dc) This service script generates a support materials bundle, or data collection (dc) bundle, for technical analysis. Depending on the option you choose, support materials can include system logs, configuration details, and other diagnostic information.
Action Description list_profiles List data collection profiles. download Download an existing support materials bundle. upload Upload an existing data collection. Generate a support materials bundle (svc_dc run) This service script is used to generate a new support materials bundle, or data collection, on the local appliance using the default profile. A support materials archive is generated for each appliance in a cluster and stored locally on the appliance.
Delete a support materials bundle (svc_dc delete) This service script is used to delete a support materials bundle. If no ID is specified, the script runs in interactive mode. All saved support materials bundles appear. Pick the bundle that you want to delete by using a short identifier. If an ID is specified, that support materials bundle is deleted. Format svc_dc delete [-h] [--debug] [-v] [--output {json}] [id] Optional arguments Qualifier Description -h, --help Show the help message and exit.
Format svc_dc list [-h] [--debug] [-v] [--output {json}] [id] Optional arguments Qualifier Description -h, --help Show the help message and exit. --debug Initiate verbose logging for debug. -v, --verbose Initiate verbose command output. --output {json} Specify the output format. JSON is the only available output format. Without JSON, the command fails. Positional arguments Qualifier Description id Specify the data collection index ID.
Qualifier Description --debug Initiate verbose logging for debug. -v, --verbose Initiate verbose command output. --output {json} Render the output in JSON format. Example Retrieve the support materials profiles using the svc_dc list_profiles script. The following example lists all the valid profile values: svc_dc list_profiles Name essential detailed hypervisor controlpathHeapDump nas Prompt Collect essential data. Collect detailed information.
Download an existing support materials bundle (svc_dc download) This service script is used to download a support materials bundle to the provided destination. If no ID is specified, the script runs in interactive mode. All saved support materials bundles appear, and you can pick the bundle that you want to download using a short identifier. If an ID is specified, that support materials bundle is downloaded.
--password=password 40bb350f-9924-4c3d-b982-ec3c61087442 Upload a support materials bundle (svc_dc upload) This service script is used to upload a data collection to CloudIQ through Secure Remote Services. If no data collection id is specified, the command runs in interactive mode. This script lists all collections and allows you to select the collection to upload using a short identifier. If you specify an ID for a collection, that collection is uploaded.
Scope Appliance Prerequisites None Format svc_diag [-h] [-v] {run,list} Optional arguments Qualifier Description -h, --help Show the help message and exit. -v, --verbose List additional content. Actions Action Description run Run a diagnostic check. For detailed subcommand usage, use the help flag (svc_diag run --help). list List diagnostic information. For detailed subcommand usage, use the help flag (svc_diag list --help).
Option Description ● ● ● ● ● ● --inventory—List the hardware inventory --sensors—List sensor information --sel—List serial log (SEL) information --firmware—List firmware information --local_drive—List local drive Smartdata information --dimm—List DIMM information --storage List all information that is related to the storage. To view information about the RAID configuration on the appliance, specify --raid as an additional argument.
Local Time is: Tue Apr 2 19:25:58 2019 UTC SMART support is: Available - device has SMART capability. SMART support is: Enabled Example Use the following command to list all the Energy Star-related information for the appliance: svc_diag list --energy_star ***** System Energy Star Information ***** Base Enclosure: Air Inlet Temperature (Celsius) : 22.00 (valid) Input Power (Watts) : 1360.
Collect flash and NVMe statistics (svc_drive_stats) This service script collects flash and NVME stats from each drive in an appliance and stores that data in a file. This data sent to Dell EMC support if SupportAssist has been enabled.
● svc_rescue_state set (on Node A and Node B) ● svc_node reboot (on Node A and Node B) ● svc_factory_reset (on Node A only) WARNING: ● This script starts a system-wide operation that resets both nodes in the system to their factory-delivered states. ● Only trained service personnel should run this script. For more information about resetting an appliance back to the factory-delivered state, see the PowerStore Security Configuration Guide.
Usage General use Requires service user password? No Requires root privileges? No May cause data unavailability? No May cause data loss? No Scope Appliance Prerequisites None Format svc_health_check [-h] {run,list,list-profiles,list-health_checks} Optional arguments Qualifier Description -h, --help Show the help message and exit. Positional arguments Qualifier Description run Start an appliance health check. list List the preview health checks.
Format svc_help [-h] [-a] [-s SCRIPT] Optional arguments Qualifier Description -h, --help Show the help message and exit. -a, --all Show all scripts. -s, --script Show the help message for the script. Hypervisor diagnostics (svc_hypervisor) This service script enables you to collect support materials from the hypervisor on the appliances. This script also enables you to take a snapshot of the current hypervisor installation so that your service provider can identify any changes to the installation.
Actions Action Description run Collect support materials from the hypervisor on the appliance. Use the -o or -output argument to specify a directory where you want to save the collected materials. Example The following command shows support materials being collected and saved: svc_hypervisor run --output /home/user32/hypervisor/download/ vm-support v3.
Optional arguments Qualifier Description -h, --help Show the help message and exit. Actions Action Description run Install the service tool or package you have specified or enable service escalation. delete Delete an injected service tool or package. info Display information about a specific package. generate-key Generate a root or SupportAssist recovery package key. deactivate Deactivate the service escalation. status Report the service escalation status.
Script svc_inject finished successfully Delete an injected service tool (svc_inject delete) This service script deletes an injected service tool. Format svc_inject delete [-h] tool_name Optional arguments Qualifier Description -h, --help Show the help message and exit. Positional arguments Qualifier Description tool_name Name of the injected tool. Example svc_inject delete test_esx_image-0.5.0.487325.tgz.
Generate a root or recovery package key (svc_inject generate-key) This service script generates a root or SupportAssist recovery package key. Format svc_inject generate-key [-h] [-s] [r] Optional Arguments Qualifier Description -h, --help Show the help message and exit. -s, --srs Specify this argument to generate a SupportAssist recovery package key. -r, --root Specify this argument to generate a root injection key.
Format svc_inject status [-h] Optional Arguments Qualifier Description -h, --help Show the help message and exit. Example svc_inject status INFO: Access is currently DISABLED INFO: Current attempt is: 0 (MAX: 3) Script svc_inject finished successfully Review system journal logs (svc_journalctl) This service script enables you to view log messages from the system journal in a consistent format. It also enables you to specify additional arguments and to filter or display additional information.
Qualifier Description -r, --reverse Show the newest entries first. -b, --boot Show current boot or the boot for the specified ID. -k, --dmesg Show the kernel message log from the current boot. -t, --identifier Show entries with the specified syslog identifier. -p, --priority Filter output by message priorities or priority range. -g, --grep Filter output to entries where the specified field matches the specified regular expression.
Field Value PRIORITY DEBUG MARKER CC COMPONENT CP SUB_COMPONENT bedrock.config.ConfigManagerVerticle THREAD_NAME vert.x-eventloop-thread-0 CONTEXT_ID no_ctx_id MESSAGE Starting to set injector. If you want to view additional fields in the output, specify them in the --output-fields argument. For example: svc_journalctl --output-fields=CODE_LINE,CODE_FUNC 2019 Mar 11 14:51:45 FNM00175000815-A DEBUG CC CP bedrock.config.ConfigManagerVerticle vert.
[--network_ip_and_gateway NETWORK_IP_AND_GATEWAY] [--run_all_triage] [--show_psus] [--verify_stack_up] [--hardware_report] [--eve_download] [--disable_network] [--verify_stack_down] [--stack_down] [--enable_network] Optional arguments Qualifier Description -h, --help Show the help message and exit. --health_check Perform a health check. --eve_args Show the arguments for the eve_download command. --firmware_report Show firmware information. --stack_up Bring the stack up.
Retrieve information as a root user (svc_mgmt_operations) This service script enables you to retrieve information using the service tool as a root user. The service tool retrieves information from the command table and the job_request table.
Action Description pending_locks Query for all pending locks. granted_locks_with_pending_locks Query all granted locks with pending locks.
Action Description --quiet Suppress any additional prompts or messages. Actions Action Description restore_on_vcenter Restore the vCenter configuration if access to the previous vCenter is lost. migrate_to_vcenter Migrate PowerStore from one vCenter to another. fix_restore_issues Remove empty proxy switches from ESXs if needed. Run this command if prompted by the restore_on_vcenter or migrate_to_vcenter commands.
Format usage: svc_migrate_to_vcenter restore_on_vcenter [-h] [--generate_config] config Optional arguments Action Description -h, --help Show the help message and exit. --generate_config Only generate the template configuration and finish. Positional arguments Action Description config The JSON config file that should have the following structure: {'data_center_name': '', 'provider_name': '
Positional arguments Action Description config The JSON config file that should have the following structure: {'cluster_name':'','vcenter': {'host':'','password':'','user':''},'data_center_name':''} Run service scripts using SSH tunneling (svc_nas) This service script enables you to run NAS service scripts from the service container to provide unified serviceability in addition to faster diagnosis and remediation.
Action Description run Run the specified NAS service script in the format: svc_nas run
