system.scap
Description
Provides methods to schedule SCAP scans and access the results.
Namespace:
system.scap
Method: deleteXccdfScan
Description:
Delete OpenSCAP XCCDF Scan from the Uyuni database. Note that only those SCAP Scans can be deleted which have passed their retention period.
Parameters:
-
string sessionKey
-
int Id of XCCDF scan (xid).
Returns:
-
boolean status - indicates success of the operation
Method: getXccdfScanDetails
Description:
Get details of given OpenSCAP XCCDF scan.
Parameters:
-
string sessionKey
-
int Id of XCCDF scan (xid).
Returns:
-
* struct - OpenSCAP XCCDF Scan
-
int "xid" - XCCDF TestResult id
-
int "sid" - serverId
-
int "action_id" - Id of the parent action.
-
string "path" - Path to XCCDF document
-
string "ovalfiles" - Optional OVAL Files
-
string "oscap_parameters" - oscap command-line arguments.
-
string "test_result" - Identifier of XCCDF TestResult.
-
string "benchmark" - Identifier of XCCDF Benchmark.
-
string "benchmark_version" - Version of the Benchmark.
-
string "profile" - Identifier of XCCDF Profile.
-
string "profile_title" - Title of XCCDF Profile.
-
dateTime.iso8601 "start_time" - Client machine time of scan start.
-
dateTime.iso8601 "end_time" - Client machine time of scan completion.
-
string "errors" - Stderr output of scan.
-
boolean "deletable" - Indicates whether the scan can be deleted.
-
Method: getXccdfScanRuleResults
Description:
Return a full list of RuleResults for given OpenSCAP XCCDF scan.
Parameters:
-
string sessionKey
-
int Id of XCCDF scan (xid).
Returns:
-
array :
-
struct - OpenSCAP XCCDF RuleResult
-
string "idref" - idref from XCCDF document.
-
string "result" - Result of evaluation.
-
string "idents" - Comma separated list of XCCDF idents.
-
Method: listXccdfScans
Description:
Return a list of finished OpenSCAP scans for a given system.
Parameters:
-
string sessionKey
-
int serverId
Returns:
-
array :
-
struct - OpenSCAP XCCDF Scan
-
int "xid" - XCCDF TestResult ID
-
string "profile" - XCCDF Profile
-
string "path" - Path to XCCDF document
-
string "ovalfiles" - Optional OVAL files
-
dateTime.iso8601 "completed" - Scan completion time
-
Method: scheduleXccdfScan
Description:
Schedule OpenSCAP scan.
Parameters:
-
string sessionKey
-
array :
-
int - serverId
-
-
string Path to xccdf content on targeted systems.
-
string Additional parameters for oscap tool.
Returns:
-
int id - ID if SCAP action created
Method: scheduleXccdfScan
Description:
Schedule OpenSCAP scan.
Parameters:
-
string sessionKey
-
array :
-
int - serverId
-
-
string Path to xccdf content on targeted systems.
-
string Additional parameters for oscap tool.
-
dateTime.iso8601 date - The date to schedule the action
Returns:
-
int id - ID if SCAP action created
Method: scheduleXccdfScan
Description:
Schedule OpenSCAP scan.
Parameters:
-
string sessionKey
-
array :
-
int - serverId
-
-
string Path to xccdf content on targeted systems.
-
string Additional parameters for oscap tool.
-
string Additional OVAL files for oscap tool.
-
dateTime.iso8601 date - The date to schedule the action
Returns:
-
int id - ID if SCAP action created
Method: scheduleXccdfScan
Description:
Schedule Scap XCCDF scan.
Parameters:
-
string sessionKey
-
int serverId
-
string Path to xccdf content on targeted system.
-
string Additional parameters for oscap tool.
Returns:
-
int id - ID of the scap action created
Method: scheduleXccdfScan
Description:
Schedule Scap XCCDF scan.
Parameters:
-
string sessionKey
-
int serverId
-
string Path to xccdf content on targeted system.
-
string Additional parameters for oscap tool.
-
dateTime.iso8601 date - The date to schedule the action
Returns:
-
int id - ID of the scap action created