(most) all functions now take SessionAuth in addition to PasswordAuth
[plcapi.git] / PLC / Methods / DeleteBootState.py
1 from PLC.Faults import *
2 from PLC.Method import Method
3 from PLC.Parameter import Parameter, Mixed
4 from PLC.BootStates import BootState, BootStates
5 from PLC.Auth import Auth
6
7 class DeleteBootState(Method):
8     """
9     Deletes a node boot state.
10
11     WARNING: This will cause the deletion of all nodes in this boot
12     state.
13
14     Returns 1 if successful, faults otherwise.
15     """
16
17     roles = ['admin']
18
19     accepts = [
20         Auth(),
21         BootState.fields['boot_state']
22         ]
23
24     returns = Parameter(int, '1 if successful')
25
26     def call(self, auth, name):
27         boot_states = BootStates(self.api, [name])
28         if not boot_states:
29             raise PLCInvalidArgument, "No such boot state"
30         boot_state = boot_states.values()[0]
31
32         boot_state.delete()
33
34         return 1