Plugin Rules¶

Methods described in this section relate to the plugin rules API. These methods can be accessed at Nessus.plugin_rules.

class PluginRulesAPI(api: APISession)[source]¶

create(plugin_id: int, type: Literal['recast_critical', 'recast_high', 'recast_medium', 'recast_low', 'recast_info', 'exclude'], host: str | None = None, date: int | None = None) → None[source]¶

Creates a new plugin rule

Parameters:

plugin_id (int) – The plugin id to modify
type – (str): The type of modification to perform
host (str, optional) – The host to apply this rule to
date (int, optional) – The unix date for this rule to expire

Example

>>> nessus.plugin_rules.create(
...     plugin_id=19506,
...     type='exclude',
...     host='192.168.0.1',
...     date=1645164000
... )

delete(rule_id: int) → None[source]¶

Deletes a plugin rule

Parameters:: rule_id (int) – The rule to delete

Example

>>> nessus.plugin_rules.delete(1)

delete_many(rule_ids: List[int]) → None[source]¶

Deletes multiple plugin rules

Parameters:: rule_ids (list[int]) – The rules to delete

Example

>>> nessus.plugin_rules.delete_many([1, 2, 3])

details(rule_id: int) → Dict[source]¶

Returns the details of a given plugin rule

Parameters:: rule_id (int) – The plugin rule id
Returns:: The plugin rule object requested
Return type:: Dict

Example

>>> nessus.plugin_rules.details(1)

edit(rule_id: int, plugin_id: int | None = None, type: Literal['recast_critical', 'recast_high', 'recast_medium', 'recast_low', 'recast_info', 'exclude'] | None = None, host: str | None = None, date: int | None = None) → None[source]¶

Creates a new plugin rule

Parameters:

rule_id (int) – The rule to modify
plugin_id (int, optional) – The plugin id to modify
type – (str, optional): The type of modification to perform
host (str, optional) – The host to apply this rule to
date (int, optional) – The unix date for this rule to expire

Example

>>> nessus.plugin_rules.edit(1, date=1645164000)

list() → List[Dict][source]¶

Lists the plugin rules

Returns:: List of plugin rule objects
Return type:: List[Dict]

Example

>>> for rule in nessus.plugin_rules.list():
...     print(rule)