three.MF.V3.Tasks.ListNetworkInterfaces
1from MF.V3.Descriptors.Network import Interface as MF_V3_Descriptors_Network_Interface 2from MF.V3.Task import TaskState as MF_V3_Task_TaskState 3 4 5class ListNetworkInterfaces: 6 """* 7 List network interfaces. 8 9 > Request example: 10 11 ```json 12 { 13 "Task":{ 14 "Index":1, 15 "Type":"ListNetworkInterfaces" 16 } 17 } 18 ``` 19 20 > Response example: 21 22 ```json 23 { 24 "Task":{ 25 "Index":1, 26 "Type":"ListNetworkInterfaces", 27 "Output":[ 28 {"ip":"192.168.1.234","name":"eth0","ssid":""}, 29 {"ip":"127.0.0.1","name":"lo","ssid":""} 30 {"ip":"192.168.2.345","name":"wlan0","ssid":"Network1"} 31 ], 32 "State":"Completed" 33 } 34 } 35 ``` 36 """ 37 class Request: 38 39 """ 40 Client request for the `ListNetworkInterfaces` task. 41 """ 42 def __init__(self, Index: int, Type: str): 43 # A unique identifier generated by the client. 44 self.Index = Index 45 # "ListNetworkInterfaces" 46 self.Type = Type 47 48 class Response: 49 50 """ 51 Server response for the `ListNetworkInterfaces` task. 52 """ 53 def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Network_Interface = None, State: MF_V3_Task_TaskState = None, Error: str = None): 54 # The unique identifier generated by the client. 55 self.Index = Index 56 # "ListNetworkInterfaces" 57 self.Type = Type 58 # Network interface descriptors. 59 self.Output = Output 60 # The current state of the task. 61 self.State = State 62 # A string describing the error if the task has failed. 63 self.Error = Error 64 65 def __init__(self): 66 pass
class
ListNetworkInterfaces:
6class ListNetworkInterfaces: 7 """* 8 List network interfaces. 9 10 > Request example: 11 12 ```json 13 { 14 "Task":{ 15 "Index":1, 16 "Type":"ListNetworkInterfaces" 17 } 18 } 19 ``` 20 21 > Response example: 22 23 ```json 24 { 25 "Task":{ 26 "Index":1, 27 "Type":"ListNetworkInterfaces", 28 "Output":[ 29 {"ip":"192.168.1.234","name":"eth0","ssid":""}, 30 {"ip":"127.0.0.1","name":"lo","ssid":""} 31 {"ip":"192.168.2.345","name":"wlan0","ssid":"Network1"} 32 ], 33 "State":"Completed" 34 } 35 } 36 ``` 37 """ 38 class Request: 39 40 """ 41 Client request for the `ListNetworkInterfaces` task. 42 """ 43 def __init__(self, Index: int, Type: str): 44 # A unique identifier generated by the client. 45 self.Index = Index 46 # "ListNetworkInterfaces" 47 self.Type = Type 48 49 class Response: 50 51 """ 52 Server response for the `ListNetworkInterfaces` task. 53 """ 54 def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Network_Interface = None, State: MF_V3_Task_TaskState = None, Error: str = None): 55 # The unique identifier generated by the client. 56 self.Index = Index 57 # "ListNetworkInterfaces" 58 self.Type = Type 59 # Network interface descriptors. 60 self.Output = Output 61 # The current state of the task. 62 self.State = State 63 # A string describing the error if the task has failed. 64 self.Error = Error 65 66 def __init__(self): 67 pass
* List network interfaces.
Request example:
{
"Task":{
"Index":1,
"Type":"ListNetworkInterfaces"
}
}
Response example:
{
"Task":{
"Index":1,
"Type":"ListNetworkInterfaces",
"Output":[
{"ip":"192.168.1.234","name":"eth0","ssid":""},
{"ip":"127.0.0.1","name":"lo","ssid":""}
{"ip":"192.168.2.345","name":"wlan0","ssid":"Network1"}
],
"State":"Completed"
}
}
class
ListNetworkInterfaces.Request:
38 class Request: 39 40 """ 41 Client request for the `ListNetworkInterfaces` task. 42 """ 43 def __init__(self, Index: int, Type: str): 44 # A unique identifier generated by the client. 45 self.Index = Index 46 # "ListNetworkInterfaces" 47 self.Type = Type
Client request for the ListNetworkInterfaces
task.
class
ListNetworkInterfaces.Response:
49 class Response: 50 51 """ 52 Server response for the `ListNetworkInterfaces` task. 53 """ 54 def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Network_Interface = None, State: MF_V3_Task_TaskState = None, Error: str = None): 55 # The unique identifier generated by the client. 56 self.Index = Index 57 # "ListNetworkInterfaces" 58 self.Type = Type 59 # Network interface descriptors. 60 self.Output = Output 61 # The current state of the task. 62 self.State = State 63 # A string describing the error if the task has failed. 64 self.Error = Error
Server response for the ListNetworkInterfaces
task.
ListNetworkInterfaces.Response( Index: int, Type: str, Output: MF.V3.Descriptors.Network.Interface = None, State: MF.V3.Task.TaskState = None, Error: str = None)
54 def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Network_Interface = None, State: MF_V3_Task_TaskState = None, Error: str = None): 55 # The unique identifier generated by the client. 56 self.Index = Index 57 # "ListNetworkInterfaces" 58 self.Type = Type 59 # Network interface descriptors. 60 self.Output = Output 61 # The current state of the task. 62 self.State = State 63 # A string describing the error if the task has failed. 64 self.Error = Error