Skip to content

Inventory models

AntaInventoryInput

Bases: BaseModel

User’s inventory model.

Attributes:

Name Type Description
networks (list[AntaInventoryNetwork], Optional)

List of AntaInventoryNetwork objects for networks.

hosts (list[AntaInventoryHost], Optional)

List of AntaInventoryHost objects for hosts.

range (list[AntaInventoryRange], Optional)

List of AntaInventoryRange objects for ranges.

AntaInventoryHost

Bases: BaseModel

Host definition for user’s inventory.

Attributes:

Name Type Description
host IPvAnyAddress

IPv4 or IPv6 address of the device

port int

(Optional) eAPI port to use Default is 443.

name str

(Optional) Name to display during tests report. Default is hostname:port

tags list[str]

List of attached tags read from inventory file.

disable_cache bool

Disable cache per host. Defaults to False.

AntaInventoryNetwork

Bases: BaseModel

Network definition for user’s inventory.

Attributes:

Name Type Description
network IPvAnyNetwork

Subnet to use for testing.

tags list[str]

List of attached tags read from inventory file.

disable_cache bool

Disable cache per network. Defaults to False.

AntaInventoryRange

Bases: BaseModel

IP Range definition for user’s inventory.

Attributes:

Name Type Description
start IPvAnyAddress

IPv4 or IPv6 address for the begining of the range.

stop IPvAnyAddress

IPv4 or IPv6 address for the end of the range.

tags list[str]

List of attached tags read from inventory file.

disable_cache bool

Disable cache per range of hosts. Defaults to False.


Last update: August 18, 2023