Skip to content

Commit

Permalink
Add: alive test
Browse files Browse the repository at this point in the history
  • Loading branch information
jjnicola committed Mar 21, 2023
1 parent 11b1121 commit ea85f40
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions rust/doc/openapi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -278,10 +278,30 @@ components:
type: "array"
items:
$ref: "#/components/schemas/Credential"
alive_test_ports:
description: "Dedicated port list for alive detection. Used for TCP-SYN and TCP-ACK ping when Boreas is enabled."
type: "array"
items:
$ref: "#/components/schemas/PortRange"
alive_test_methods:
description: "List of alive test to be performed against the target. Can be one or a combination of icmp, tcp_syn, tcp_ack, arp, consider_alive methods"
type: "array"
items:
$ref: "#/components/schemas/AliveTestMethod"
required:
- hosts
- ports

AliveTestMethod:
description: "Alive test method to be performed against the target"
type: "string"
enum:
- icmp
- tcp_syn
- tcp_ack
- arp
- consider_alive

PortRange:
description: "A port range for either UDP or TCP ports"
type: "object"
Expand Down

0 comments on commit ea85f40

Please sign in to comment.