greenbone / python-gvm

        """

        return self._send_xml_command(XmlCommand("empty_trashcan"))

    def get_agents(

        self,

        *,

        filter: Optional[str] = None,

        filter_id: Optional[str] = None,

        trash: Optional[bool] = None,

        details: Optional[bool] = None,

        format: Optional[str] = None

    ) -> Any:

        """Request a list of agents

        Arguments:

            filter: Filter term to use for the query

            filter_id: UUID of an existing filter to use for the query

            trash: True to request the agents in the trashcan

            details: Whether to include agents packageinformation when no format

                was provided

            format: One of "installer", "howto_install" or "howto_use"

        Returns:

            The response. See :py:meth:`send_command` for details.

        """

        cmd = XmlCommand("get_agents")

        _add_filter(cmd, filter, filter_id)

        if not trash is None:

            cmd.set_attribute("trash", _to_bool(trash))

        if not details is None:

            cmd.set_attribute("details", _to_bool(details))

        if format:

            if not format in ("installer", "howto_install", "howto_use"):

                raise InvalidArgument(

                    "installer argument needs to be one of installer, "

                    "howto_install or howto_use"

                )

            cmd.set_attribute("format", format)

        return self._send_xml_command(cmd)

    def get_agent(self, agent_id: str) -> Any:

        """Request a single agent

        cmd.set_attribute("target_id", target_id)

        return self._send_xml_command(cmd)

    def get_tasks(

        self,

        *,

        filter: Optional[str] = None,

        filter_id: Optional[str] = None,

        trash: Optional[bool] = None,

        details: Optional[bool] = None,

        schedules_only: Optional[bool] = None

    ) -> Any:

        """Request a list of tasks

        Arguments:

            filter: Filter term to use for the query

            filter_id: UUID of an existing filter to use for the query

            trash: Whether to get the trashcan tasks instead

            details: Whether to include full task details

            schedules_only: Whether to only include id, name and schedule

                details

        Returns:

            The response. See :py:meth:`send_command` for details.

        """

        cmd = XmlCommand("get_tasks")

        _add_filter(cmd, filter, filter_id)

        if not trash is None:

            cmd.set_attribute("trash", _to_bool(trash))

        if not details is None:

            cmd.set_attribute("details", _to_bool(details))

        if not schedules_only is None:

            cmd.set_attribute("schedules_only", _to_bool(schedules_only))

        return self._send_xml_command(cmd)

    def get_task(self, task_id: str) -> Any:

        """Request a single task

        cmd.set_attribute("permission_id", permission_id)

        return self._send_xml_command(cmd)

    def get_port_lists(

        self,

        *,

        filter: Optional[str] = None,

        filter_id: Optional[str] = None,

        details: Optional[bool] = None,

        targets: Optional[bool] = None,

        trash: Optional[bool] = None

    ) -> Any:

        """Request a list of port lists

        Arguments:

            filter: Filter term to use for the query

            filter_id: UUID of an existing filter to use for the query

            details: Whether to include full port list details

            targets: Whether to include targets using this port list

            trash: Whether to get port lists in the trashcan instead

        Returns:

            The response. See :py:meth:`send_command` for details.

        """

        cmd = XmlCommand("get_port_lists")

        _add_filter(cmd, filter, filter_id)

        if not details is None:

            cmd.set_attribute("details", _to_bool(details))

        if not targets is None:

            cmd.set_attribute("targets", _to_bool(targets))

        if not trash is None:

            cmd.set_attribute("trash", _to_bool(trash))

        return self._send_xml_command(cmd)

    def get_port_list(self, port_list_id: str):

        """Request a single port list