Current File : //opt/imunify360/venv/lib/python3.11/site-packages/imav/malwarelib/rpc/schema/malicious.yaml
malware malicious list:
return_type: MaliciousListAgentResponse
type: dict
cli:
users:
- root
schema:
since:
type: integer
coerce: int
default: 0
to:
type: integer
coerce: int
default_setter: now
limit:
type: integer
coerce: int
default: 50
offset:
type: integer
coerce: int
default: 0
search:
type: string
nullable: true
by_scan_id:
type: string
nullable: true
user:
type: string
nullable: true
by_status:
type: list
schema:
type: string
nullable: true
ids:
type: list
schema:
type: integer
coerce: int
nullable: true
order_by:
type: list
schema:
type: order_by
coerce: order_by
nullable: true
help: Show the list of malicious files
malware malicious remove-from-list:
type: dict
cli:
users:
- root
schema:
ids:
type: list
schema:
type: integer
coerce: int
required: true
positional: true
items:
rename: ids
user:
type: string
nullable: true
help: Remove entries from the list of malicious files without removing the files
malware malicious move-to-ignore:
type: dict
# why not SucceededFailedAgentResponse
return_type: NumberAgentResponse
cli:
users:
- root
schema:
ids:
type: list
schema:
type: integer
coerce: int
required: true
positional: true
items:
rename: ids
user:
type: string
nullable: true
help: Move the file to ignore list
# 2 more actions, request and response formats are the same as in others above
# initiate cleanup of selected files
# it would be nice to wait until cleanup is done here, and only then return the response
# user won't send more then 100 files from UI at once anyway
malware malicious cleanup:
type: dict
return_type: NullAgentResponse
cli:
users:
- root
schema:
ids:
type: list
schema:
type: integer
coerce: int
required: true
positional: true
items:
rename: ids
user:
type: string
nullable: true
standard_only:
type: boolean
help: Cleanup malicious files
# restore original copy that was created before cleanup attempt
malware malicious restore-original:
type: dict
return_type: SucceededFailedAgentResponse
cli:
users:
- root
schema:
ids:
type: list
schema:
type: integer
coerce: int
required: true
positional: true
items:
rename: ids
user:
type: string
nullable: true
help: Restore the original copy that was created before a cleanup attempt
# does not accept any params, initiates cleanup of all files
# no need to wait until cleanup is done
# return response as soon as the status of files in `malware malicious list` is changed to `cleanup_in_progress`
malware malicious cleanup-all:
type: dict
return_type: NullAgentResponse
cli:
users:
- root
schema:
user:
type: string
nullable: true
standard_only:
type: boolean
help: Cleanup all malicious files
malware cleanup status:
type: dict
cli:
users:
- root
help: Show the status of running cleanup
malware user cleanup:
type: dict
return_type: NullAgentResponse
cli:
users:
- root
schema:
user:
type: list
schema:
type: string
required: true
positional: true
standard_only:
type: boolean
help: Cleanup all files for selected users
malware user restore-original:
type: dict
return_type: SucceededFailedAgentResponse
# why? ui do not use it
cli:
users:
- root
schema:
user:
type: list
schema:
type: string
required: true
positional: true
help: Restore the original copy that was created before the cleanup for selected users
Mini Shell