three.MF.V3.Tasks.SystemInfo

 1from MF.V3.Descriptors.System import System as MF_V3_Descriptors_System_System
 2from MF.V3.Settings.Software import Software as MF_V3_Settings_Software_Software
 3from MF.V3.Task import TaskState as MF_V3_Task_TaskState
 4
 5
 6class SystemInfo:
 7    """*
 8    Get system information including the serial number, disk space and installed and available software versions.
 9
10    Request example:
11    ```
12    {
13    "Task":{
14    "Index":1,
15    "Type":"SystemInfo",
16    "Input":{
17    "installed":["server","frontend"],
18    "available":["server","frontend"]
19    }
20    }
21    }
22    ```
23    Response example:
24    ```
25    {
26    "Task":{
27    "Index":1,
28    "Type":"SystemInfo"
29    "Input":{
30    "installed":["server","frontend"],
31    "available":["server","frontend"]
32    }
33    "Output":{
34    "serialNumber":"1000000012345678",
35    "diskSpace":{"available":8523210752,"capacity":15082610688},
36    "software:{
37    "installed":[
38    {
39    "name":"server",
40    "version":{
41    "major":2,
42    "minor":21,
43    "patch":119,
44    "string":"2.21.119"
45    }
46    },
47    {
48    "name":"frontend",
49    "version":{
50    "major":2,
51    "minor":14,
52    "patch":39,
53    "string":"2.14.39"
54    }
55    }
56    },
57    ]
58    },
59    "State":"Completed"
60    }
61    }
62    ```
63    """
64    class Request:
65
66        """
67         Client request for the `SystemInfo` task.
68        """
69        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Software_Software = None):
70            # A unique identifier generated by the client.
71            self.Index = Index
72            # "SystemInfo"
73            self.Type = Type
74            # Software settings.
75            self.Input = Input
76
77    class Response:
78
79        """
80         Server response for the `SystemInfo` task.
81        """
82        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_System_System, Input: MF_V3_Settings_Software_Software = None, State: MF_V3_Task_TaskState = None, Error: str = None):
83            # The unique identifier generated by the client.
84            self.Index = Index
85            # "SystemInfo"
86            self.Type = Type
87            # The system descriptor.
88            self.Output = Output
89            # The requested software settings.
90            self.Input = Input
91            # The current state of the task.
92            self.State = State
93            # A string describing the error if the task has failed.
94            self.Error = Error
95
96    def __init__(self):
97        pass
class SystemInfo:
 7class SystemInfo:
 8    """*
 9    Get system information including the serial number, disk space and installed and available software versions.
10
11    Request example:
12    ```
13    {
14    "Task":{
15    "Index":1,
16    "Type":"SystemInfo",
17    "Input":{
18    "installed":["server","frontend"],
19    "available":["server","frontend"]
20    }
21    }
22    }
23    ```
24    Response example:
25    ```
26    {
27    "Task":{
28    "Index":1,
29    "Type":"SystemInfo"
30    "Input":{
31    "installed":["server","frontend"],
32    "available":["server","frontend"]
33    }
34    "Output":{
35    "serialNumber":"1000000012345678",
36    "diskSpace":{"available":8523210752,"capacity":15082610688},
37    "software:{
38    "installed":[
39    {
40    "name":"server",
41    "version":{
42    "major":2,
43    "minor":21,
44    "patch":119,
45    "string":"2.21.119"
46    }
47    },
48    {
49    "name":"frontend",
50    "version":{
51    "major":2,
52    "minor":14,
53    "patch":39,
54    "string":"2.14.39"
55    }
56    }
57    },
58    ]
59    },
60    "State":"Completed"
61    }
62    }
63    ```
64    """
65    class Request:
66
67        """
68         Client request for the `SystemInfo` task.
69        """
70        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Software_Software = None):
71            # A unique identifier generated by the client.
72            self.Index = Index
73            # "SystemInfo"
74            self.Type = Type
75            # Software settings.
76            self.Input = Input
77
78    class Response:
79
80        """
81         Server response for the `SystemInfo` task.
82        """
83        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_System_System, Input: MF_V3_Settings_Software_Software = None, State: MF_V3_Task_TaskState = None, Error: str = None):
84            # The unique identifier generated by the client.
85            self.Index = Index
86            # "SystemInfo"
87            self.Type = Type
88            # The system descriptor.
89            self.Output = Output
90            # The requested software settings.
91            self.Input = Input
92            # The current state of the task.
93            self.State = State
94            # A string describing the error if the task has failed.
95            self.Error = Error
96
97    def __init__(self):
98        pass

* Get system information including the serial number, disk space and installed and available software versions.

Request example:

{
"Task":{
"Index":1,
"Type":"SystemInfo",
"Input":{
"installed":["server","frontend"],
"available":["server","frontend"]
}
}
}

Response example:

{
"Task":{
"Index":1,
"Type":"SystemInfo"
"Input":{
"installed":["server","frontend"],
"available":["server","frontend"]
}
"Output":{
"serialNumber":"1000000012345678",
"diskSpace":{"available":8523210752,"capacity":15082610688},
"software:{
"installed":[
{
"name":"server",
"version":{
"major":2,
"minor":21,
"patch":119,
"string":"2.21.119"
}
},
{
"name":"frontend",
"version":{
"major":2,
"minor":14,
"patch":39,
"string":"2.14.39"
}
}
},
]
},
"State":"Completed"
}
}
class SystemInfo.Request:
65    class Request:
66
67        """
68         Client request for the `SystemInfo` task.
69        """
70        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Software_Software = None):
71            # A unique identifier generated by the client.
72            self.Index = Index
73            # "SystemInfo"
74            self.Type = Type
75            # Software settings.
76            self.Input = Input

Client request for the SystemInfo task.

SystemInfo.Request( Index: int, Type: str, Input: MF.V3.Settings.Software.Software = None)
70        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Software_Software = None):
71            # A unique identifier generated by the client.
72            self.Index = Index
73            # "SystemInfo"
74            self.Type = Type
75            # Software settings.
76            self.Input = Input
Index
Type
Input
class SystemInfo.Response:
78    class Response:
79
80        """
81         Server response for the `SystemInfo` task.
82        """
83        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_System_System, Input: MF_V3_Settings_Software_Software = None, State: MF_V3_Task_TaskState = None, Error: str = None):
84            # The unique identifier generated by the client.
85            self.Index = Index
86            # "SystemInfo"
87            self.Type = Type
88            # The system descriptor.
89            self.Output = Output
90            # The requested software settings.
91            self.Input = Input
92            # The current state of the task.
93            self.State = State
94            # A string describing the error if the task has failed.
95            self.Error = Error

Server response for the SystemInfo task.

SystemInfo.Response( Index: int, Type: str, Output: MF.V3.Descriptors.System.System, Input: MF.V3.Settings.Software.Software = None, State: MF.V3.Task.TaskState = None, Error: str = None)
83        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_System_System, Input: MF_V3_Settings_Software_Software = None, State: MF_V3_Task_TaskState = None, Error: str = None):
84            # The unique identifier generated by the client.
85            self.Index = Index
86            # "SystemInfo"
87            self.Type = Type
88            # The system descriptor.
89            self.Output = Output
90            # The requested software settings.
91            self.Input = Input
92            # The current state of the task.
93            self.State = State
94            # A string describing the error if the task has failed.
95            self.Error = Error
Index
Type
Output
Input
State
Error