Skip to content

Commit a421bfa

Browse files
author
CI bot
committed
Definitions Update otis
2 parents 9776860 + c8f54ef commit a421bfa

File tree

1 file changed

+52
-5
lines changed

1 file changed

+52
-5
lines changed

alsdkdefs/apis/otis/otis.v3.yaml

Lines changed: 52 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@ info:
44
version: 3.0.0
55
description: |-
66
# Otis
7-
8-
**Note:** The previous v2 API of this service has been deprecated.
9-
7+
108
The **Otis** service manages tuning options specified by a customer. The defined
119
options are consumed by various services to operate in accordance with the
1210
customer's preferences.
@@ -15,7 +13,7 @@ info:
1513
* [Scope Resolving Algorithm](#scope-resolving-algorithm)
1614
* [Supported Options](#supported-options)
1715
18-
<a name="option-representation"/>
16+
<a name="option-representation"></a>
1917
2018
## Option Representation
2119
@@ -61,7 +59,7 @@ info:
6159
```
6260
6361
A value depends on the option name and can contain arbitrary JSON data. Please
64-
see the section [Supported Option](#supported-options) for information about
62+
see the section [Supported Options](#supported-options) for information about
6563
valid option values.
6664
6765
<a name="scope-resolving-algorithm"/>
@@ -115,6 +113,7 @@ info:
115113
116114
A client is allowed to specify the following options:
117115
116+
* [abs_follow_internal_scan_schedules](#abs_follow_internal_scan_schedules)
118117
* [cross_network_protection](#cross_network_protection)
119118
* [discovery_scan_frequency](#discovery_scan_frequency)
120119
* [external_scan_frequency](#external_scan_frequency)
@@ -133,6 +132,30 @@ info:
133132
* [span_port_enabled](#span_port_enabled)
134133
* [vulnerability_scan_frequency](#vulnerability_scan_frequency)
135134
135+
<a name="abs_follow_internal_scan_schedules"/>
136+
137+
### abs_follow_internal_scan_schedules
138+
139+
This option tells an ABS agent to follow either internal-network scanning
140+
schedules or agent-based scanning schedules configured.
141+
142+
For example, a deployment may be configured to apply the same set of schedules
143+
defined for internal network scanning. In this case any existing agent-based
144+
scanning schedules are ignored.
145+
146+
```
147+
{
148+
"name": "abs_follow_internal_scan_schedules",
149+
"scope": {
150+
"deployment_id": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA"
151+
},
152+
"value": true
153+
}
154+
```
155+
156+
By default, agent configurations are generated out of agent-based scanning
157+
schedules, and the assumed value is `false` if the option is undefined.
158+
136159
<a name="cross_network_protection"/>
137160
138161
### cross_network_protection
@@ -1003,6 +1026,30 @@ components:
10031026
OptionsReqBody:
10041027
type: object
10051028
oneOf:
1029+
- type: object
1030+
title: abs_follow_internal_scan_schedules
1031+
description: >
1032+
This option tells an ABS agent to follow internal-network scanning
1033+
schedules instead of any agent-based scanning schedules configured.
1034+
properties:
1035+
name:
1036+
type: string
1037+
enum:
1038+
- abs_follow_internal_scan_schedules
1039+
value:
1040+
type: boolean
1041+
scope:
1042+
type: object
1043+
properties:
1044+
deployment_id:
1045+
$ref: '#/components/schemas/DeploymentId'
1046+
required:
1047+
- deployment_id
1048+
additionalProperties: false
1049+
required:
1050+
- value
1051+
- scope
1052+
additionalProperties: false
10061053
- type: object
10071054
title: custom_routing
10081055
description: Indicates whether custom routing is enabled.

0 commit comments

Comments
 (0)