Software

Methods described in this section relate to the software API. These methods can be accessed at TenableOne.inventory.software.

class SoftwareAPI(api: APISession)

list(query_text: str | None = None, query_mode: QueryMode | None = None, filters: list[PropertyFilter] | None = None, extra_properties: list[str] | None = None, offset: int | None = None, limit: int | None = None, sort_by: str | None = None, sort_direction: SortDirection | None = None) → SoftwareValues

Retrieve software

Args:

query_text (str, optional):

The text to search for.

query_mode (QueryMode, optional):

The search mode. Defaults to QueryMode.SIMPLE.

filters (list, optional):

A list of filters to apply. Defaults to None.

extra_properties (list, optional):

Additional properties to include in the response. Defaults to None.

offset (int, optional):

Number of records to skip. Defaults to 0.

limit (int, optional):

Maximum number of records per page. Defaults to 1000.

sort_by (str, optional):

Field to sort by.

sort_direction (SortDirection, optional):

Sorting direction, either SortDirection.ASC or SortDirection.DESC.

Returns:

The request software.

Examples:

>>> tenable_inventory_software = tenable_inventory.software.list()
>>> for software in tenable_inventory_software:
...     pprint(software)

list_properties() → list[Field]

Retrieve software properties

Returns:

The software properties.

Examples:

>>> tenable_inventory_software_properties = tenable_inventory.software.list_properties()
>>> for software_property in software_properties:
...     pprint(software_property)