@@ 1986-2126 (lines=141) @@ | ||
1983 | cmd.add_element("copy", target_id) |
|
1984 | return self._send_xml_command(cmd) |
|
1985 | ||
1986 | def create_task( |
|
1987 | self, |
|
1988 | name: str, |
|
1989 | config_id: str, |
|
1990 | target_id: str, |
|
1991 | scanner_id: str, |
|
1992 | *, |
|
1993 | alterable: Optional[bool] = None, |
|
1994 | hosts_ordering: Optional[HostsOrdering] = None, |
|
1995 | schedule_id: Optional[str] = None, |
|
1996 | alert_ids: Optional[List[str]] = None, |
|
1997 | comment: Optional[str] = None, |
|
1998 | schedule_periods: Optional[int] = None, |
|
1999 | observers: Optional[List[str]] = None, |
|
2000 | preferences: Optional[dict] = None |
|
2001 | ) -> Any: |
|
2002 | """Create a new task |
|
2003 | ||
2004 | Arguments: |
|
2005 | name: Name of the task |
|
2006 | config_id: UUID of scan config to use by the task |
|
2007 | target_id: UUID of target to be scanned |
|
2008 | scanner_id: UUID of scanner to use for scanning the target |
|
2009 | comment: Comment for the task |
|
2010 | alterable: Whether the task should be alterable |
|
2011 | alert_ids: List of UUIDs for alerts to be applied to the task |
|
2012 | hosts_ordering: The order hosts are scanned in |
|
2013 | schedule_id: UUID of a schedule when the task should be run. |
|
2014 | schedule_periods: A limit to the number of times the task will be |
|
2015 | scheduled, or 0 for no limit |
|
2016 | observers: List of names or ids of users which should be allowed to |
|
2017 | observe this task |
|
2018 | preferences: Name/Value pairs of scanner preferences. |
|
2019 | ||
2020 | Returns: |
|
2021 | The response. See :py:meth:`send_command` for details. |
|
2022 | """ |
|
2023 | if not name: |
|
2024 | raise RequiredArgument( |
|
2025 | function=self.create_task.__name__, argument='name' |
|
2026 | ) |
|
2027 | ||
2028 | if not config_id: |
|
2029 | raise RequiredArgument( |
|
2030 | function=self.create_task.__name__, argument='config_id' |
|
2031 | ) |
|
2032 | ||
2033 | if not target_id: |
|
2034 | raise RequiredArgument( |
|
2035 | function=self.create_task.__name__, argument='target_id' |
|
2036 | ) |
|
2037 | ||
2038 | if not scanner_id: |
|
2039 | raise RequiredArgument( |
|
2040 | function=self.create_task.__name__, argument='scanner_id' |
|
2041 | ) |
|
2042 | ||
2043 | # don't allow to create a container task with create_task |
|
2044 | if target_id == '0': |
|
2045 | raise InvalidArgument( |
|
2046 | 'Invalid argument {} for target_id'.format(target_id) |
|
2047 | ) |
|
2048 | ||
2049 | cmd = XmlCommand("create_task") |
|
2050 | cmd.add_element("name", name) |
|
2051 | cmd.add_element("config", attrs={"id": config_id}) |
|
2052 | cmd.add_element("target", attrs={"id": target_id}) |
|
2053 | cmd.add_element("scanner", attrs={"id": scanner_id}) |
|
2054 | ||
2055 | if comment: |
|
2056 | cmd.add_element("comment", comment) |
|
2057 | ||
2058 | if alterable is not None: |
|
2059 | cmd.add_element("alterable", _to_bool(alterable)) |
|
2060 | ||
2061 | if hosts_ordering: |
|
2062 | if not isinstance(hosts_ordering, HostsOrdering): |
|
2063 | raise InvalidArgumentType( |
|
2064 | function=self.create_task.__name__, |
|
2065 | argument='hosts_ordering', |
|
2066 | arg_type=HostsOrdering.__name__, |
|
2067 | ) |
|
2068 | cmd.add_element("hosts_ordering", hosts_ordering.value) |
|
2069 | ||
2070 | if alert_ids: |
|
2071 | if isinstance(alert_ids, str): |
|
2072 | deprecation( |
|
2073 | "Please pass a list as alert_ids parameter to create_task. " |
|
2074 | "Passing a string is deprecated and will be removed in " |
|
2075 | "future." |
|
2076 | ) |
|
2077 | ||
2078 | # if a single id is given as a string wrap it into a list |
|
2079 | alert_ids = [alert_ids] |
|
2080 | if _is_list_like(alert_ids): |
|
2081 | # parse all given alert id's |
|
2082 | for alert in alert_ids: |
|
2083 | cmd.add_element("alert", attrs={"id": str(alert)}) |
|
2084 | ||
2085 | if schedule_id: |
|
2086 | cmd.add_element("schedule", attrs={"id": schedule_id}) |
|
2087 | ||
2088 | if schedule_periods is not None: |
|
2089 | if ( |
|
2090 | not isinstance(schedule_periods, numbers.Integral) |
|
2091 | or schedule_periods < 0 |
|
2092 | ): |
|
2093 | raise InvalidArgument( |
|
2094 | "schedule_periods must be an integer greater or equal " |
|
2095 | "than 0" |
|
2096 | ) |
|
2097 | cmd.add_element("schedule_periods", str(schedule_periods)) |
|
2098 | ||
2099 | if observers is not None: |
|
2100 | if not _is_list_like(observers): |
|
2101 | raise InvalidArgumentType( |
|
2102 | function=self.create_task.__name__, |
|
2103 | argument='observers', |
|
2104 | arg_type='list', |
|
2105 | ) |
|
2106 | ||
2107 | # gvmd splits by comma and space |
|
2108 | # gvmd tries to lookup each value as user name and afterwards as |
|
2109 | # user id. So both user name and user id are possible |
|
2110 | cmd.add_element("observers", _to_comma_list(observers)) |
|
2111 | ||
2112 | if preferences is not None: |
|
2113 | if not isinstance(preferences, collections.abc.Mapping): |
|
2114 | raise InvalidArgumentType( |
|
2115 | function=self.create_task.__name__, |
|
2116 | argument='preferences', |
|
2117 | arg_type=collections.abc.Mapping.__name__, |
|
2118 | ) |
|
2119 | ||
2120 | _xmlprefs = cmd.add_element("preferences") |
|
2121 | for pref_name, pref_value in preferences.items(): |
|
2122 | _xmlpref = _xmlprefs.add_element("preference") |
|
2123 | _xmlpref.add_element("scanner_name", pref_name) |
|
2124 | _xmlpref.add_element("value", str(pref_value)) |
|
2125 | ||
2126 | return self._send_xml_command(cmd) |
|
2127 | ||
2128 | def create_container_task( |
|
2129 | self, name: str, *, comment: Optional[str] = None |
@@ 1169-1279 (lines=111) @@ | ||
1166 | ||
1167 | return self._send_xml_command(cmd) |
|
1168 | ||
1169 | def __create_task( |
|
1170 | self, |
|
1171 | name: str, |
|
1172 | config_id: str, |
|
1173 | target_id: str, |
|
1174 | scanner_id: str, |
|
1175 | usage_type: UsageType, |
|
1176 | function: str, |
|
1177 | *, |
|
1178 | alterable: Optional[bool] = None, |
|
1179 | hosts_ordering: Optional[HostsOrdering] = None, |
|
1180 | schedule_id: Optional[str] = None, |
|
1181 | alert_ids: Optional[List[str]] = None, |
|
1182 | comment: Optional[str] = None, |
|
1183 | schedule_periods: Optional[int] = None, |
|
1184 | observers: Optional[List[str]] = None, |
|
1185 | preferences: Optional[dict] = None |
|
1186 | ) -> Any: |
|
1187 | if not name: |
|
1188 | raise RequiredArgument(function=function, argument='name') |
|
1189 | ||
1190 | if not config_id: |
|
1191 | raise RequiredArgument(function=function, argument='config_id') |
|
1192 | ||
1193 | if not target_id: |
|
1194 | raise RequiredArgument(function=function, argument='target_id') |
|
1195 | ||
1196 | if not scanner_id: |
|
1197 | raise RequiredArgument(function=function, argument='scanner_id') |
|
1198 | ||
1199 | # don't allow to create a container task with create_task |
|
1200 | if target_id == '0': |
|
1201 | raise InvalidArgument(function=function, argument='target_id') |
|
1202 | ||
1203 | cmd = XmlCommand("create_task") |
|
1204 | cmd.add_element("name", name) |
|
1205 | cmd.add_element("usage_type", usage_type.value) |
|
1206 | cmd.add_element("config", attrs={"id": config_id}) |
|
1207 | cmd.add_element("target", attrs={"id": target_id}) |
|
1208 | cmd.add_element("scanner", attrs={"id": scanner_id}) |
|
1209 | ||
1210 | if comment: |
|
1211 | cmd.add_element("comment", comment) |
|
1212 | ||
1213 | if alterable is not None: |
|
1214 | cmd.add_element("alterable", _to_bool(alterable)) |
|
1215 | ||
1216 | if hosts_ordering: |
|
1217 | if not isinstance(hosts_ordering, self.types.HostsOrdering): |
|
1218 | raise InvalidArgumentType( |
|
1219 | function=function, |
|
1220 | argument='hosts_ordering', |
|
1221 | arg_type=HostsOrdering.__name__, |
|
1222 | ) |
|
1223 | cmd.add_element("hosts_ordering", hosts_ordering.value) |
|
1224 | ||
1225 | if alert_ids: |
|
1226 | if isinstance(alert_ids, str): |
|
1227 | deprecation( |
|
1228 | "Please pass a list as alert_ids parameter to {}. " |
|
1229 | "Passing a string is deprecated and will be removed in " |
|
1230 | "future.".format(function) |
|
1231 | ) |
|
1232 | ||
1233 | # if a single id is given as a string wrap it into a list |
|
1234 | alert_ids = [alert_ids] |
|
1235 | if _is_list_like(alert_ids): |
|
1236 | # parse all given alert id's |
|
1237 | for alert in alert_ids: |
|
1238 | cmd.add_element("alert", attrs={"id": str(alert)}) |
|
1239 | ||
1240 | if schedule_id: |
|
1241 | cmd.add_element("schedule", attrs={"id": schedule_id}) |
|
1242 | ||
1243 | if schedule_periods is not None: |
|
1244 | if ( |
|
1245 | not isinstance(schedule_periods, numbers.Integral) |
|
1246 | or schedule_periods < 0 |
|
1247 | ): |
|
1248 | raise InvalidArgument( |
|
1249 | "schedule_periods must be an integer greater or equal " |
|
1250 | "than 0" |
|
1251 | ) |
|
1252 | cmd.add_element("schedule_periods", str(schedule_periods)) |
|
1253 | ||
1254 | if observers is not None: |
|
1255 | if not _is_list_like(observers): |
|
1256 | raise InvalidArgumentType( |
|
1257 | function=function, argument='observers', arg_type='list' |
|
1258 | ) |
|
1259 | ||
1260 | # gvmd splits by comma and space |
|
1261 | # gvmd tries to lookup each value as user name and afterwards as |
|
1262 | # user id. So both user name and user id are possible |
|
1263 | cmd.add_element("observers", _to_comma_list(observers)) |
|
1264 | ||
1265 | if preferences is not None: |
|
1266 | if not isinstance(preferences, collections.abc.Mapping): |
|
1267 | raise InvalidArgumentType( |
|
1268 | function=function, |
|
1269 | argument='preferences', |
|
1270 | arg_type=collections.abc.Mapping.__name__, |
|
1271 | ) |
|
1272 | ||
1273 | _xmlprefs = cmd.add_element("preferences") |
|
1274 | for pref_name, pref_value in preferences.items(): |
|
1275 | _xmlpref = _xmlprefs.add_element("preference") |
|
1276 | _xmlpref.add_element("scanner_name", pref_name) |
|
1277 | _xmlpref.add_element("value", str(pref_value)) |
|
1278 | ||
1279 | return self._send_xml_command(cmd) |
|
1280 | ||
1281 | def __create_config( |
|
1282 | self, |