Project

General

Profile

Bug #42006

Update APIv1 documentation for unlocking volume

Added by Erin Clark about 2 years ago. Updated about 2 years ago.

Status:
Done
Priority:
No priority
Assignee:
Waqar Ahmed
Category:
Middleware
Target version:
Severity:
Medium
Reason for Closing:
Reason for Blocked:
Needs QA:
No
Needs Doc:
No
Needs Merging:
No
Needs Automation:
No
Support Suite Ticket:
n/a
Hardware Configuration:
ChangeLog Required:
No

Description

Testing with a FreeNAS system updated to FreeNAS-11.2-MASTER-201807261941:

The legacy UI has options to choose which services are restarted when a locked pool is unlocked. The new UI is missing these options.

This ticket is for the middleware API side portion of this, restarting the services should be done there and not in the UI as discussed with William

newui-unlock-pool.png (81.1 KB) newui-unlock-pool.png Timothy Moore II, 07/27/2018 06:55 AM
oldui-unlock-volume.png (174 KB) oldui-unlock-volume.png Timothy Moore II, 07/27/2018 06:55 AM
Screen Shot 2018-08-31 at 2.26.08 PM.png (56.2 KB) Screen Shot 2018-08-31 at 2.26.08 PM.png Bonnie Follweiler, 08/31/2018 11:29 AM
24636
24642
27938

Related issues

Blocks FreeNAS - Bug #39852: Add multi-select dropdown to new UI for restarting services upon pool unlockDone

History

#1 Updated by Erin Clark about 2 years ago

  • Copied from Bug #39852: Add multi-select dropdown to new UI for restarting services upon pool unlock added

#2 Updated by Erin Clark about 2 years ago

  • Copied from deleted (Bug #39852: Add multi-select dropdown to new UI for restarting services upon pool unlock)

#3 Updated by Erin Clark about 2 years ago

  • Blocks Bug #39852: Add multi-select dropdown to new UI for restarting services upon pool unlock added

#4 Updated by Erin Clark about 2 years ago

  • Subject changed from Storage/Pools: Missing service restart options in "Unlock Pool" window: to Need API for service restart checkboxes on unlock pool window

#5 Updated by Erin Clark about 2 years ago

  • Assignee changed from Erin Clark to William Grzybowski

#6 Updated by William Grzybowski about 2 years ago

  • Category changed from GUI (new) to Middleware
  • Assignee changed from William Grzybowski to Waqar Ahmed
  • Severity changed from New to Medium

Waqar, can we implement the services selection for API 1.0 on unlock?

#7 Updated by Waqar Ahmed about 2 years ago

  • Status changed from Unscreened to In Progress

#8 Updated by Bug Clerk about 2 years ago

  • Status changed from In Progress to Ready for Testing
  • Target version changed from 11.2-RC1 to 11.2-BETA3

#9 Updated by Dru Lavigne about 2 years ago

  • Subject changed from Need API for service restart checkboxes on unlock pool window to Update APIv1 documentation for unlocking volume
  • Needs Doc changed from Yes to No
  • Needs Merging changed from Yes to No

#10 Updated by Bonnie Follweiler about 2 years ago

27938

Tested in FreeNAS-11.2-MASTER-201808310859
There is no areas in the Pools ->unlock screen to check/uncheck (screenshot provided)

#11 Updated by Waqar Ahmed about 2 years ago

So the test case which has been done for this ticket should be done for ticket #39852. This ticket only adds the ability for the user to use api v1 to specify which services should be restarted on unlock.
An api v1 call should be made to

/api/v1.0/storage/volume/(int:id|string:name)/unlock/

with the payload

        {
                "passphrase": "mypassphrase",
                "recovery_key": "Ik9mXRNr2zj9CZF8kFoC9w7sUyQxo5kAAgWjeVtNDfTgFm0tERqS90OdJYzCaCr75V9LnKgLlRBmzJ0oj7F3nw==",
                "services": ["iscsitarget", "webdav"]
        }

passphrase/recovery_key should be updated accordingly.

If the call is successful and the services are restarted, we can declare this a success

#12 Updated by Dru Lavigne about 2 years ago

  • Status changed from Failed Testing to Ready for Testing

#13 Updated by Michael Reynolds about 2 years ago

  • Needs QA changed from Yes to No

I created a new pool
locked the pool and added a passphrase
Ran a python script that uses apiv1 calls to unlock the pool
Script retunred
'Volume has been unlocked.'
Checked the WebUI and the pool is now unlocked.

#14 Updated by Michael Reynolds about 2 years ago

  • Status changed from Ready for Testing to Passed Testing

#15 Updated by Dru Lavigne about 2 years ago

  • Status changed from Passed Testing to Done

Also available in: Atom PDF