more detailed info passed when raising an exception
[plcapi.git] / PLC / Methods / DeleteNetworkType.py
1 from PLC.Faults import *
2 from PLC.Method import Method
3 from PLC.Parameter import Parameter, Mixed
4 from PLC.NetworkTypes import NetworkType, NetworkTypes
5 from PLC.Auth import Auth
6
7 class DeleteNetworkType(Method):
8     """
9     Deletes a network type.
10
11     WARNING: This will cause the deletion of all network interfaces
12     that use this type.
13
14     Returns 1 if successful, faults otherwise.
15     """
16
17     roles = ['admin']
18
19     accepts = [
20         Auth(),
21         NetworkType.fields['type']
22         ]
23
24     returns = Parameter(int, '1 if successful')
25     
26     event_type = 'Delete'
27     object_type = 'NetworkType'
28
29     def call(self, auth, name):
30         network_types = NetworkTypes(self.api, [name])
31         if not network_types:
32             raise PLCInvalidArgument, "No such network type"
33         network_type = network_types[0]
34
35         network_type.delete()
36
37         return 1