How to Upload and Execute a Workflow on a ZFS Storage Appliance

Asset ID:	1-71-2359446.1
Update Date:	2018-02-26
Keywords:

Solution Type Technical Instruction Sure

Solution 2359446.1 : How to Upload and Execute a Workflow on a ZFS Storage Appliance

Applies to:

Oracle ZFS Storage ZS5-4 - Version All Versions to All Versions [Release All Releases]
Oracle ZFS Storage Appliance Racked System ZS5-2 - Version All Versions to All Versions [Release All Releases]
Oracle ZFS Storage ZS4-4 - Version All Versions to All Versions [Release All Releases]
Oracle ZFS Storage ZS3-4 - Version All Versions to All Versions [Release All Releases]
Oracle ZFS Storage ZS3-2 - Version All Versions to All Versions [Release All Releases]
7000 Appliance OS (Fishworks)

Goal

This document contains information on how to upload a workflow to a ZFS Storage Appliance and execute the workflow.

Solution

Uploading and Executing a Workflow Using the BUI

Uploading a workflow using the BUI:

Transfer the workflow to a system that has access to the ZFS Storage Appliance management interface.
Login to the ZFS Storage Appliance and navigate in the BUI to: Maintenance > WORKFLOWS.
Click on the (+) to the left of 'Workflows'.
Click 'Browse' then navigate to the location of the workflow on your local system and select the workflow.
Select 'Upload' and wait for the BUI to refresh.

Executing a workflow using the BUI:

Once the file is uploaded you will see it listed as an available workflow.
Click on the workflow name to start it.

Notes:
The workflows are ordered alphanumerically 0-9A-z so you may need to move forward in the list using the >> or >| buttons to locate your desired workflow.
The workflow name displayed in the appliance BUI is specified within the file and may not resemble the filename.
Set any parameters required and click 'Apply' to run the workflow.

Reference:

Oracle® ZFS Storage Appliance Administration Guide, Release OS8.7.x, Uploading and Executing Workflows Using the BUI

Downloading and Executing a Workflow Using the CLI

Download the Workflow Using the CLI

Store the workflow on a FTP or HTTP server accessible by the appliance.
Navigate to the 'maintenance workflows' submenu.
Issue the 'download' command.
Specify the URL where the workflow is stored.

Notes:
The URL can be either HTTP (beginning with "http://") or FTP (beginning with "ftp://").
If user authentication is required it can either be specified in the URL or set separately.
Issue the 'commit' command to download the workflow to the appliance.

zfssa_name:> maintenance workflows
zfssa_name::maintenance workflows> download
zfssa_name:maintenance workflows download (uncommitted)> set url=ftp://myusername:mypasswd@myserver/export/foo/example1.akwf
     url = ftp://myusername:mypasswd@myserver/export/foo/example1.akwf
zfssa_name:maintenance workflows download (uncommitted)> set url=ftp://myserver/foo/example1.akwf
     url = ftp://myserver/foo/example1.akwf
zfssa_name:maintenance workflows download (uncommitted)> set user=myusername
     user = myusername
zfssa_name:maintenance workflows download (uncommitted)> set password
Enter password:
     password = **********
zfssa_name:maintenance workflows download (uncommitted)> commit
Transferred 138 of 138 (100%) ... done

Reference:

Oracle® ZFS Storage Appliance Administration Guide, Release OS8.7.x, Downloading Workflows using the CLI

Executing a Workflow Using the CLI

From the 'maintenance workflows' submenu, use the 'show' command to display the workflows on the appliance.
Select the "workflow-xxx" entry for your desired workflow.
Issue the 'show' command to display the workflow details and confirm the description matches your desired action.
Use the 'run' command to initiate the workflow.
The 'show' command will list any parameters required by the workflow.
'Set' the parameters required for the workflow.

Tab completion can help when determining what to enter.
Issue the 'commit' command to execute the workflow.

zfssa_name:maintenance workflows> show
WORKFLOW NAME OWNER SETID ORIGIN VERSION
workflow-000 Configure for Oracle Solaris Cluster NFS root false Oracle Corporation 1.0.0
workflow-001 Unconfigure Oracle Solaris Cluster NFS root false Oracle Corporation 1.0.0
workflow-002 Configure for Oracle Enterprise Manager Monitoring root false Sun Microsystems, Inc. 1.1
workflow-003 Unconfigure Oracle Enterprise Manager Monitoring root false Sun Microsystems, Inc. 1.0
workflow-004 Scrub priority root false Oracle Corporation 1.6

zfssa_name:maintenance workflows> select workflow-004
zfssa_name:maintenance workflow-004> show
Properties:
            name = Scrub priority
     description = Get or set scrub priority from 1 to 40 in ms.
            uuid = fe4f5041-fc34-4dad-8591-afbfeaeb2330
        checksum = cbcc4f620b6c5c14c5221c3facfab79744ad357bec2c47818f880089071adba3
     installdate = 2018-2-8 14:27:22
           owner = root
          origin = Oracle Corporation
           setid = false
           alert = false
         version = 1.6
       scheduled = false

zfssa_name:maintenance workflow-004 run (uncommitted)> set setting=<tab>
get set
zfssa_name:maintenance workflow-004 run (uncommitted)> set setting=set
setting = set
zfssa_name:maintenance workflow-004 run (uncommitted)> set wait=30
wait = 30
zfssa_name:maintenance workflow-004 run (uncommitted)> commit
zfs_scrub_delay_ms: 30

Reference:

Oracle® ZFS Storage Appliance Administration Guide, Release OS8.7.x, Listing Workflows using the CLI

Oracle® ZFS Storage Appliance Administration Guide, Release OS8.7.x, Executing Workflows using the CLI

Attachments

This solution has no attachment