greenbone /
python-gvm
| @@ 5100-5173 (lines=74) @@ | ||
| 5097 | ||
| 5098 | return self._send_xml_command(cmd) |
|
| 5099 | ||
| 5100 | def modify_note( |
|
| 5101 | self, |
|
| 5102 | note_id: str, |
|
| 5103 | text: str, |
|
| 5104 | *, |
|
| 5105 | days_active: Optional[int] = None, |
|
| 5106 | hosts: Optional[List[str]] = None, |
|
| 5107 | port: Optional[int] = None, |
|
| 5108 | result_id: Optional[str] = None, |
|
| 5109 | severity: Optional[Severity] = None, |
|
| 5110 | task_id: Optional[str] = None, |
|
| 5111 | threat: Optional[SeverityLevel] = None, |
|
| 5112 | ) -> Any: |
|
| 5113 | """Modifies an existing note. |
|
| 5114 | ||
| 5115 | Arguments: |
|
| 5116 | note_id: UUID of note to modify. |
|
| 5117 | text: The text of the note. |
|
| 5118 | days_active: Days note will be active. -1 on always, 0 off. |
|
| 5119 | hosts: A list of hosts addresses |
|
| 5120 | port: Port to which note applies. |
|
| 5121 | result_id: Result to which note applies. |
|
| 5122 | severity: Severity to which note applies. |
|
| 5123 | task_id: Task to which note applies. |
|
| 5124 | threat: Threat level to which note applies. Will be converted to |
|
| 5125 | severity. |
|
| 5126 | ||
| 5127 | Returns: |
|
| 5128 | The response. See :py:meth:`send_command` for details. |
|
| 5129 | """ |
|
| 5130 | if not note_id: |
|
| 5131 | raise RequiredArgument( |
|
| 5132 | function=self.modify_note.__name__, argument='note_id' |
|
| 5133 | ) |
|
| 5134 | ||
| 5135 | if not text: |
|
| 5136 | raise RequiredArgument( |
|
| 5137 | function=self.modify_note.__name__, argument='text' |
|
| 5138 | ) |
|
| 5139 | ||
| 5140 | cmd = XmlCommand("modify_note") |
|
| 5141 | cmd.set_attribute("note_id", note_id) |
|
| 5142 | cmd.add_element("text", text) |
|
| 5143 | ||
| 5144 | if days_active is not None: |
|
| 5145 | cmd.add_element("active", str(days_active)) |
|
| 5146 | ||
| 5147 | if hosts: |
|
| 5148 | cmd.add_element("hosts", _to_comma_list(hosts)) |
|
| 5149 | ||
| 5150 | if port: |
|
| 5151 | cmd.add_element("port", str(port)) |
|
| 5152 | ||
| 5153 | if result_id: |
|
| 5154 | cmd.add_element("result", attrs={"id": result_id}) |
|
| 5155 | ||
| 5156 | if severity: |
|
| 5157 | cmd.add_element("severity", str(severity)) |
|
| 5158 | ||
| 5159 | if task_id: |
|
| 5160 | cmd.add_element("task", attrs={"id": task_id}) |
|
| 5161 | ||
| 5162 | if threat is not None: |
|
| 5163 | ||
| 5164 | if not isinstance(threat, SeverityLevel): |
|
| 5165 | raise InvalidArgumentType( |
|
| 5166 | function=self.modify_note.__name__, |
|
| 5167 | argument='threat', |
|
| 5168 | arg_type=SeverityLevel.__name__, |
|
| 5169 | ) |
|
| 5170 | ||
| 5171 | cmd.add_element("threat", threat.value) |
|
| 5172 | ||
| 5173 | return self._send_xml_command(cmd) |
|
| 5174 | ||
| 5175 | def modify_override( |
|
| 5176 | self, |
|
| @@ 890-963 (lines=74) @@ | ||
| 887 | ||
| 888 | return self._send_xml_command(cmd) |
|
| 889 | ||
| 890 | def create_note( |
|
| 891 | self, |
|
| 892 | text: str, |
|
| 893 | nvt_oid: str, |
|
| 894 | *, |
|
| 895 | days_active: Optional[int] = None, |
|
| 896 | hosts: Optional[List[str]] = None, |
|
| 897 | port: Optional[int] = None, |
|
| 898 | result_id: Optional[str] = None, |
|
| 899 | severity: Optional[Severity] = None, |
|
| 900 | task_id: Optional[str] = None, |
|
| 901 | threat: Optional[SeverityLevel] = None, |
|
| 902 | ) -> Any: |
|
| 903 | """Create a new note |
|
| 904 | ||
| 905 | Arguments: |
|
| 906 | text: Text of the new note |
|
| 907 | nvt_id: OID of the nvt to which note applies |
|
| 908 | days_active: Days note will be active. -1 on |
|
| 909 | always, 0 off |
|
| 910 | hosts: A list of hosts addresses |
|
| 911 | port: Port to which the note applies |
|
| 912 | result_id: UUID of a result to which note applies |
|
| 913 | severity: Severity to which note applies |
|
| 914 | task_id: UUID of task to which note applies |
|
| 915 | threat: Severity level to which note applies. Will be converted to |
|
| 916 | severity. |
|
| 917 | ||
| 918 | Returns: |
|
| 919 | The response. See :py:meth:`send_command` for details. |
|
| 920 | """ |
|
| 921 | if not text: |
|
| 922 | raise RequiredArgument( |
|
| 923 | function=self.create_note.__name__, argument='text' |
|
| 924 | ) |
|
| 925 | ||
| 926 | if not nvt_oid: |
|
| 927 | raise RequiredArgument( |
|
| 928 | function=self.create_note.__name__, argument='nvt_oid' |
|
| 929 | ) |
|
| 930 | ||
| 931 | cmd = XmlCommand("create_note") |
|
| 932 | cmd.add_element("text", text) |
|
| 933 | cmd.add_element("nvt", attrs={"oid": nvt_oid}) |
|
| 934 | ||
| 935 | if days_active is not None: |
|
| 936 | cmd.add_element("active", str(days_active)) |
|
| 937 | ||
| 938 | if hosts: |
|
| 939 | cmd.add_element("hosts", _to_comma_list(hosts)) |
|
| 940 | ||
| 941 | if port: |
|
| 942 | cmd.add_element("port", str(port)) |
|
| 943 | ||
| 944 | if result_id: |
|
| 945 | cmd.add_element("result", attrs={"id": result_id}) |
|
| 946 | ||
| 947 | if severity: |
|
| 948 | cmd.add_element("severity", str(severity)) |
|
| 949 | ||
| 950 | if task_id: |
|
| 951 | cmd.add_element("task", attrs={"id": task_id}) |
|
| 952 | ||
| 953 | if threat is not None: |
|
| 954 | if not isinstance(threat, SeverityLevel): |
|
| 955 | raise InvalidArgumentType( |
|
| 956 | function="create_note", |
|
| 957 | argument="threat", |
|
| 958 | arg_type=SeverityLevel.__name__, |
|
| 959 | ) |
|
| 960 | ||
| 961 | cmd.add_element("threat", threat.value) |
|
| 962 | ||
| 963 | return self._send_xml_command(cmd) |
|
| 964 | ||
| 965 | def clone_note(self, note_id: str) -> Any: |
|
| 966 | """Clone an existing note |
|
| @@ 6413-6486 (lines=74) @@ | ||
| 6410 | ||
| 6411 | return self._send_xml_command(cmd) |
|
| 6412 | ||
| 6413 | def modify_note( |
|
| 6414 | self, |
|
| 6415 | note_id: str, |
|
| 6416 | text: str, |
|
| 6417 | *, |
|
| 6418 | days_active: Optional[int] = None, |
|
| 6419 | hosts: Optional[List[str]] = None, |
|
| 6420 | port: Optional[int] = None, |
|
| 6421 | result_id: Optional[str] = None, |
|
| 6422 | severity: Optional[Severity] = None, |
|
| 6423 | task_id: Optional[str] = None, |
|
| 6424 | threat: Optional[SeverityLevel] = None, |
|
| 6425 | ) -> Any: |
|
| 6426 | """Modifies an existing note. |
|
| 6427 | ||
| 6428 | Arguments: |
|
| 6429 | note_id: UUID of note to modify. |
|
| 6430 | text: The text of the note. |
|
| 6431 | days_active: Days note will be active. -1 on always, 0 off. |
|
| 6432 | hosts: A list of hosts addresses |
|
| 6433 | port: Port to which note applies. |
|
| 6434 | result_id: Result to which note applies. |
|
| 6435 | severity: Severity to which note applies. |
|
| 6436 | task_id: Task to which note applies. |
|
| 6437 | threat: Threat level to which note applies. Will be converted to |
|
| 6438 | severity. |
|
| 6439 | ||
| 6440 | Returns: |
|
| 6441 | The response. See :py:meth:`send_command` for details. |
|
| 6442 | """ |
|
| 6443 | if not note_id: |
|
| 6444 | raise RequiredArgument( |
|
| 6445 | function=self.modify_note.__name__, argument='note_id' |
|
| 6446 | ) |
|
| 6447 | ||
| 6448 | if not text: |
|
| 6449 | raise RequiredArgument( |
|
| 6450 | function=self.modify_note.__name__, argument='text' |
|
| 6451 | ) |
|
| 6452 | ||
| 6453 | cmd = XmlCommand("modify_note") |
|
| 6454 | cmd.set_attribute("note_id", note_id) |
|
| 6455 | cmd.add_element("text", text) |
|
| 6456 | ||
| 6457 | if days_active is not None: |
|
| 6458 | cmd.add_element("active", str(days_active)) |
|
| 6459 | ||
| 6460 | if hosts: |
|
| 6461 | cmd.add_element("hosts", _to_comma_list(hosts)) |
|
| 6462 | ||
| 6463 | if port: |
|
| 6464 | cmd.add_element("port", str(port)) |
|
| 6465 | ||
| 6466 | if result_id: |
|
| 6467 | cmd.add_element("result", attrs={"id": result_id}) |
|
| 6468 | ||
| 6469 | if severity: |
|
| 6470 | cmd.add_element("severity", str(severity)) |
|
| 6471 | ||
| 6472 | if task_id: |
|
| 6473 | cmd.add_element("task", attrs={"id": task_id}) |
|
| 6474 | ||
| 6475 | if threat is not None: |
|
| 6476 | ||
| 6477 | if not isinstance(threat, SeverityLevel): |
|
| 6478 | raise InvalidArgumentType( |
|
| 6479 | function=self.modify_note.__name__, |
|
| 6480 | argument='threat', |
|
| 6481 | arg_type=SeverityLevel.__name__, |
|
| 6482 | ) |
|
| 6483 | ||
| 6484 | cmd.add_element("threat", threat.value) |
|
| 6485 | ||
| 6486 | return self._send_xml_command(cmd) |
|
| 6487 | ||
| 6488 | def modify_override( |
|
| 6489 | self, |
|
| @@ 3471-3544 (lines=74) @@ | ||
| 3468 | ||
| 3469 | return self._send_xml_command(cmd) |
|
| 3470 | ||
| 3471 | def create_note( |
|
| 3472 | self, |
|
| 3473 | text: str, |
|
| 3474 | nvt_oid: str, |
|
| 3475 | *, |
|
| 3476 | days_active: Optional[int] = None, |
|
| 3477 | hosts: Optional[List[str]] = None, |
|
| 3478 | port: Optional[int] = None, |
|
| 3479 | result_id: Optional[str] = None, |
|
| 3480 | severity: Optional[Severity] = None, |
|
| 3481 | task_id: Optional[str] = None, |
|
| 3482 | threat: Optional[SeverityLevel] = None, |
|
| 3483 | ) -> Any: |
|
| 3484 | """Create a new note |
|
| 3485 | ||
| 3486 | Arguments: |
|
| 3487 | text: Text of the new note |
|
| 3488 | nvt_id: OID of the nvt to which note applies |
|
| 3489 | days_active: Days note will be active. -1 on |
|
| 3490 | always, 0 off |
|
| 3491 | hosts: A list of hosts addresses |
|
| 3492 | port: Port to which the note applies |
|
| 3493 | result_id: UUID of a result to which note applies |
|
| 3494 | severity: Severity to which note applies |
|
| 3495 | task_id: UUID of task to which note applies |
|
| 3496 | threat: Severity level to which note applies. Will be converted to |
|
| 3497 | severity. |
|
| 3498 | ||
| 3499 | Returns: |
|
| 3500 | The response. See :py:meth:`send_command` for details. |
|
| 3501 | """ |
|
| 3502 | if not text: |
|
| 3503 | raise RequiredArgument( |
|
| 3504 | function=self.create_note.__name__, argument='text' |
|
| 3505 | ) |
|
| 3506 | ||
| 3507 | if not nvt_oid: |
|
| 3508 | raise RequiredArgument( |
|
| 3509 | function=self.create_note.__name__, argument='nvt_oid' |
|
| 3510 | ) |
|
| 3511 | ||
| 3512 | cmd = XmlCommand("create_note") |
|
| 3513 | cmd.add_element("text", text) |
|
| 3514 | cmd.add_element("nvt", attrs={"oid": nvt_oid}) |
|
| 3515 | ||
| 3516 | if days_active is not None: |
|
| 3517 | cmd.add_element("active", str(days_active)) |
|
| 3518 | ||
| 3519 | if hosts: |
|
| 3520 | cmd.add_element("hosts", _to_comma_list(hosts)) |
|
| 3521 | ||
| 3522 | if port: |
|
| 3523 | cmd.add_element("port", str(port)) |
|
| 3524 | ||
| 3525 | if result_id: |
|
| 3526 | cmd.add_element("result", attrs={"id": result_id}) |
|
| 3527 | ||
| 3528 | if severity: |
|
| 3529 | cmd.add_element("severity", str(severity)) |
|
| 3530 | ||
| 3531 | if task_id: |
|
| 3532 | cmd.add_element("task", attrs={"id": task_id}) |
|
| 3533 | ||
| 3534 | if threat is not None: |
|
| 3535 | if not isinstance(threat, SeverityLevel): |
|
| 3536 | raise InvalidArgumentType( |
|
| 3537 | function="create_note", |
|
| 3538 | argument="threat", |
|
| 3539 | arg_type=SeverityLevel.__name__, |
|
| 3540 | ) |
|
| 3541 | ||
| 3542 | cmd.add_element("threat", threat.value) |
|
| 3543 | ||
| 3544 | return self._send_xml_command(cmd) |
|
| 3545 | ||
| 3546 | def clone_note(self, note_id: str) -> Any: |
|
| 3547 | """Clone an existing note |
|
