vscan
Suggest changes
PDFs
vscan-active-scanner-pool-get-iter
This ONTAPI call does not have an equivalent REST API call.
vscan-connection-extended-stats-get-iter
This ONTAPI call does not have an equivalent REST API call.
vscan-connection-status-all-get-iter
GET /api/protocols/vscan/server-status
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
connected-since |
update_time |
|
disconnect-reason |
disconnected_reason |
|
disconnected-since |
update_time |
|
lif |
interface.ip.address |
|
node |
node.name |
|
privileged-user |
No REST Equivalent |
|
server |
ip |
|
server-status |
state |
|
server-type |
type |
|
vendor |
vendor |
|
version |
version |
|
vserver |
svm.name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
vscan-events-get-iter
GET /api/protocols/vscan/{svm.uuid}/events
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
consecutive-occurrence-count |
No REST Equivalent |
|
disconnect-reason |
disconnect_reason |
|
event-time |
event_time |
|
event-type |
type |
|
file-path |
file_path |
|
lif |
interface |
|
node |
node |
|
scan-engine-status |
No REST Equivalent |
|
server |
server |
|
vendor |
vendor |
|
version |
version |
|
vserver |
svm |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
vscan-on-access-policy-create
POST /api/protocols/vscan/{svm.uuid}/on-access-policies
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
file-ext-to-exclude |
scope.exclude_extensions |
|
file-ext-to-include |
scope.include_extensions |
|
filters |
No REST Equivalent |
You can find filter options under scope.only_execute_access and scope.scan_readonly_volumes REST API options |
is-scan-mandatory |
mandatory |
|
max-file-size |
scope.max_file_size |
|
paths-to-exclude |
scope.exclude_paths |
|
policy-name |
name |
|
protocol |
No REST Equivalent |
|
return-record |
No REST Equivalent |
|
scan-files-with-no-ext |
scope.scan_without_extension |
vscan-on-access-policy-delete
DELETE /api/protocols/vscan/{svm.uuid}/on-access-policies/{name}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
policy-name |
name |
vscan-on-access-policy-get-iter
GET /api/protocols/vscan/{svm.uuid}/on-access-policies
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
admin-owner |
No REST Equivalent |
|
file-ext-to-exclude |
scope.exclude_extensions |
|
file-ext-to-include |
scope.include_extensions |
|
filters |
No REST Equivalent |
You can find filter options under scope.only_execute_access and scope.scan_readonly_volumes REST API options |
is-policy-enabled |
enabled |
|
is-scan-mandatory |
mandatory |
|
max-file-size |
scope.max_file_size |
|
paths-to-exclude |
scope.exclude_paths |
|
policy-name |
name |
|
protocol |
No REST Equivalent |
|
scan-files-with-no-ext |
scope.scan_without_extension |
|
vserver |
No REST Equivalent |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
vscan-on-access-policy-modify
PATCH /api/protocols/vscan/{svm.uuid}/on-access-policies/{name}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
file-ext-to-exclude |
scope.exclude_extensions |
|
file-ext-to-include |
scope.include_extensions |
|
filters |
No REST Equivalent |
You can find filter options under scope.only_execute_access and scope.scan_readonly_volumes REST API options |
is-scan-mandatory |
mandatory |
|
max-file-size |
scope.max_file_size |
|
paths-to-exclude |
scope.exclude_paths |
|
policy-name |
name |
|
scan-files-with-no-ext |
scope.scan_without_extension |
vscan-on-access-policy-status-modify
PATCH /api/protocols/vscan/{svm.uuid}/on-access-policies/{name}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
policy-name |
name |
|
policy-status |
enabled |
vscan-on-demand-report-delete
This ONTAPI call does not have an equivalent REST API call.
vscan-on-demand-report-get-iter
This ONTAPI call does not have an equivalent REST API call.
vscan-on-demand-task-create
POST /api/protocols/vscan/{svm.uuid}/on-demand-policies
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
cross-junction |
No REST Equivalent |
|
directory-recursion |
No REST Equivalent |
|
file-ext-to-exclude |
scope.exclude_extensions |
|
file-ext-to-include |
scope.include_extensions |
|
max-file-size |
scope.max_file_size |
|
paths-to-exclude |
scope.exclude_paths |
|
report-directory |
log_path |
|
report-expiry-time |
No REST Equivalent |
|
report-log-level |
No REST Equivalent |
|
request-timeout |
No REST Equivalent |
|
return-record |
No REST Equivalent |
|
scan-files-with-no-ext |
scope.scan_without_extension |
|
scan-paths |
scan_paths |
|
scan-priority |
No REST Equivalent |
|
schedule |
schedule.name |
|
task-name |
name |
vscan-on-demand-task-delete
DELETE /api/protocols/vscan/{svm.uuid}/on-demand-policies/{name}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
task-name |
name |
vscan-on-demand-task-get-iter
GET /api/protocols/vscan/{svm.uuid}/on-demand-policies
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
cross-junction |
No REST Equivalent |
|
directory-recursion |
No REST Equivalent |
|
file-ext-to-exclude |
scope.exclude_extensions |
|
file-ext-to-include |
scope.include_extensions |
|
max-file-size |
scope.max_file_size |
|
paths-to-exclude |
scope.exclude_paths |
|
report-directory |
log_path |
|
report-expiry-time |
No REST Equivalent |
|
report-log-level |
No REST Equivalent |
|
request-timeout |
No REST Equivalent |
|
scan-files-with-no-ext |
scope.scan_without_extension |
|
scan-paths |
scan_paths |
|
scan-priority |
No REST Equivalent |
|
schedule |
schedule.name |
|
task-name |
name |
|
vserver |
No REST Equivalent |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
vscan-on-demand-task-modify
PATCH /api/protocols/vscan/{svm.uuid}/on-demand-policies/{name}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
cross-junction |
No REST Equivalent |
|
directory-recursion |
No REST Equivalent |
|
file-ext-to-exclude |
scope.exclude_extensions |
|
file-ext-to-include |
scope.include_extensions |
|
max-file-size |
scope.max_file_size |
|
paths-to-exclude |
scope.exclude_paths |
|
report-directory |
log_path |
|
report-expiry-time |
No REST Equivalent |
|
report-log-level |
No REST Equivalent |
|
request-timeout |
No REST Equivalent |
|
scan-files-with-no-ext |
scope.scan_without_extension |
|
scan-paths |
scan_paths |
|
scan-priority |
No REST Equivalent |
|
schedule |
schedule.name |
|
task-name |
name |
vscan-on-demand-task-run
This ONTAPI call does not have an equivalent REST API call.
vscan-reset
PATCH /api/protocols/vscan/{svm.uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
There are no attributes defined for this ONTAPI call.
vscan-resolve-hostnames
This ONTAPI call does not have an equivalent REST API call.
vscan-scanner-pool-apply-policy
PATCH /api/protocols/vscan/{svm.uuid}/scanner-pools/{name}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
cluster |
cluster.name |
|
scanner-policy |
role |
|
scanner-pool |
name |
vscan-scanner-pool-create
POST /api/protocols/vscan/{svm.uuid}/scanner-pools
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
hostnames |
servers |
|
max-session-setup-retries |
No REST Equivalent |
|
privileged-users |
privileged_users |
|
request-timeout |
No REST Equivalent |
|
return-record |
No REST Equivalent |
|
scan-queue-timeout |
No REST Equivalent |
|
scanner-pool |
name |
|
session-setup-timeout |
No REST Equivalent |
|
session-teardown-timeout |
No REST Equivalent |
vscan-scanner-pool-delete
DELETE /api/protocols/vscan/{svm.uuid}/scanner-pools/{name}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
scanner-pool |
name |
vscan-scanner-pool-get-iter
GET /api/protocols/vscan/{svm.uuid}/scanner-pools
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
admin-owner |
No REST Equivalent |
|
cluster |
cluster.name |
|
hostnames |
servers |
|
is-currently-active |
No REST Equivalent |
|
max-session-setup-retries |
No REST Equivalent |
|
privileged-users |
privileged_users |
|
request-timeout |
No REST Equivalent |
|
scan-queue-timeout |
No REST Equivalent |
|
scanner-policy |
role |
|
scanner-pool |
name |
|
servers |
servers |
|
session-setup-timeout |
No REST Equivalent |
|
session-teardown-timeout |
No REST Equivalent |
|
vserver |
No REST Equivalent |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
vscan-scanner-pool-modify
PATCH /api/protocols/vscan/{svm.uuid}/scanner-pools/{name}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
hostnames |
servers |
|
max-session-setup-retries |
No REST Equivalent |
|
privileged-users |
privileged_users |
|
request-timeout |
No REST Equivalent |
|
scan-queue-timeout |
No REST Equivalent |
|
scanner-pool |
name |
|
session-setup-timeout |
No REST Equivalent |
|
session-teardown-timeout |
No REST Equivalent |
vscan-status-get-iter
GET /api/protocols/vscan
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
is-vscan-enabled |
enabled |
|
vserver |
svm.name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
vscan-status-modify
PATCH /api/protocols/vscan/{svm.uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
is-vscan-enabled |
enabled |