Schedules a Compliance Check Job
Since Product Version: 3.1
-
Jump To
- AAA/TACACS+ Servers Operations Service (4)
- AP Onboarding Profile Management Service (4)
- API Health Service (6)
- Access Point Operations (5)
- Alarms Management Service (5)
- Application Visibility and Control Service (1)
- CLI Template Configuration (12)
- Clients (7)
- Compliance Service (5)
- Configuration Archive Service (7)
- Credential Profile Management Service (5)
- Credentials Service (1)
- Device Details (9)
- Device Operations (9)
- Group Management Service (8)
- Group Summary Service (8)
- Guest User Management Service (6)
- Job Operations (6)
- MAC Filters Management Service (5)
- Manage and Monitor Info Service (5)
- Plug and Play (11)
- Rate Limits Management Service (2)
- Report Service (4)
- Software Updates (2)
- Statistics (91)
- System Settings (26)
- Trap Receivers (4)
- User Defined Field Management (3)
- User Management Service (5)
- VNF Provisioning (16)
- Virtual Domains Management Service (10)
- Virtual Image Repository (8)
- WLAN Provisioning (16)
- Wireless Device Details (22)
- v1
- v2
- v3
- v4
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Write |
HTTP Methods |
POST |
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/compliance/runRequest Payload Parameters
Attribute | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
configFileFrom String |
One of LATEST_FROM_DEVICE (collects the config from Device), LATEST_FROM_ARCHIVE (collects the config from Database which already collected). By default LATEST_FROM_DEVICE. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Job details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
policyProfileName String |
Profile name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Targets to check, devices or groups. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response Parameters
Attribute | Description |
---|---|
isSuccess boolean |
If true, the action was successfully performed. If false, it ended in some failure condition. |
message String |
The action status message. |
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Request Payload
https://localhost/webacs/api/v1/op/compliance/run
<?xml version="1.0" ?>
<complianceJobRun>
<configFileFrom>String value</configFileFrom>
<jobDto>
<description>String value</description>
<jobName>String value</jobName>
<jobSchedule>
<daily>true</daily>
<dayOfWeek>String value</dayOfWeek>
<dayRepetition>String value</dayRepetition>
<fortnight>true</fortnight>
<hourRepetition>String value</hourRepetition>
<hourly>true</hourly>
<jobScheduleTime>
<day>String value</day>
<endDate>String value</endDate>
<hour>String value</hour>
<minute>String value</minute>
<month>String value</month>
<startDate>String value</startDate>
<year>String value</year>
</jobScheduleTime>
<minute>true</minute>
<monthly>true</monthly>
<monthlyDay>String value</monthlyDay>
<monthlyMonth>String value</monthlyMonth>
<monthlyWeek>String value</monthlyWeek>
<monthlyWeekDay>String value</monthlyWeekDay>
<noOfRepetitions>String value</noOfRepetitions>
<now>true</now>
<weekly>true</weekly>
<yearly>true</yearly>
</jobSchedule>
<jobType>String value</jobType>
</jobDto>
<policyProfileName>String value</policyProfileName>
<targets>
<targets>
<groupHierarchy>String value</groupHierarchy>
<groupId>String value</groupId>
<groupName>String value</groupName>
<ipAddress>String value</ipAddress>
<type>DEVICE</type>
</targets>
</targets>
</complianceJobRun>
Sample JSON Request Payload
https://localhost/webacs/api/v1/op/compliance/run.json
{
"complianceJobRun" : {
"configFileFrom" : "String value",
"jobDto" : {
"description" : "String value",
"jobName" : "String value",
"jobSchedule" : {
"daily" : true,
"dayOfWeek" : "String value",
"dayRepetition" : "String value",
"fortnight" : true,
"hourRepetition" : "String value",
"hourly" : true,
"jobScheduleTime" : {
"day" : "String value",
"endDate" : "String value",
"hour" : "String value",
"minute" : "String value",
"month" : "String value",
"startDate" : "String value",
"year" : "String value"
},
"minute" : true,
"monthly" : true,
"monthlyDay" : "String value",
"monthlyMonth" : "String value",
"monthlyWeek" : "String value",
"monthlyWeekDay" : "String value",
"noOfRepetitions" : "String value",
"now" : true,
"weekly" : true,
"yearly" : true
},
"jobType" : "String value"
},
"policyProfileName" : "String value",
"targets" : {
"targets" : {
"groupHierarchy" : "String value",
"groupId" : "String value",
"groupName" : "String value",
"ipAddress" : "String value",
"type" : "DEVICE"
}
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v1/op/compliance/run
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/compliance/run" rootUrl="https://localhost/webacs/api/v1/op">
<complianceResult>
<isSuccess>true</isSuccess>
<message>String value</message>
</complianceResult>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/compliance/run.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/compliance\/run",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"complianceResult" : {
"isSuccess" : true,
"message" : "String value"
}
}
}
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Write |
HTTP Methods |
POST |
Resource URL
/webacs/api/v2/op/compliance/run UnmodifiedThis resource has not been modified since the previous API version.
Request Payload Parameters
Attribute | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
configFileFrom String |
One of LATEST_FROM_DEVICE (collects the config from Device), LATEST_FROM_ARCHIVE (collects the config from Database which already collected). By default LATEST_FROM_DEVICE. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Job details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
policyProfileName String |
Profile name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Targets to check, devices or groups. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response Parameters
Attribute | Description |
---|---|
isSuccess boolean |
If true, the action was successfully performed. If false, it ended in some failure condition. |
message String |
The action status message. |
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Request Payload
https://localhost/webacs/api/v2/op/compliance/run
<?xml version="1.0" ?>
<complianceJobRun>
<configFileFrom>String value</configFileFrom>
<jobDto>
<description>String value</description>
<jobName>String value</jobName>
<jobSchedule>
<daily>true</daily>
<dayOfWeek>String value</dayOfWeek>
<dayRepetition>String value</dayRepetition>
<fortnight>true</fortnight>
<hourRepetition>String value</hourRepetition>
<hourly>true</hourly>
<jobScheduleTime>
<day>String value</day>
<endDate>String value</endDate>
<hour>String value</hour>
<minute>String value</minute>
<month>String value</month>
<startDate>String value</startDate>
<year>String value</year>
</jobScheduleTime>
<minute>true</minute>
<monthly>true</monthly>
<monthlyDay>String value</monthlyDay>
<monthlyMonth>String value</monthlyMonth>
<monthlyWeek>String value</monthlyWeek>
<monthlyWeekDay>String value</monthlyWeekDay>
<noOfRepetitions>String value</noOfRepetitions>
<now>true</now>
<weekly>true</weekly>
<yearly>true</yearly>
</jobSchedule>
<jobType>String value</jobType>
</jobDto>
<policyProfileName>String value</policyProfileName>
<targets>
<targets>
<groupHierarchy>String value</groupHierarchy>
<groupId>String value</groupId>
<groupName>String value</groupName>
<ipAddress>String value</ipAddress>
<type>DEVICE</type>
</targets>
</targets>
</complianceJobRun>
Sample JSON Request Payload
https://localhost/webacs/api/v2/op/compliance/run.json
{
"complianceJobRun" : {
"configFileFrom" : "String value",
"jobDto" : {
"description" : "String value",
"jobName" : "String value",
"jobSchedule" : {
"daily" : true,
"dayOfWeek" : "String value",
"dayRepetition" : "String value",
"fortnight" : true,
"hourRepetition" : "String value",
"hourly" : true,
"jobScheduleTime" : {
"day" : "String value",
"endDate" : "String value",
"hour" : "String value",
"minute" : "String value",
"month" : "String value",
"startDate" : "String value",
"year" : "String value"
},
"minute" : true,
"monthly" : true,
"monthlyDay" : "String value",
"monthlyMonth" : "String value",
"monthlyWeek" : "String value",
"monthlyWeekDay" : "String value",
"noOfRepetitions" : "String value",
"now" : true,
"weekly" : true,
"yearly" : true
},
"jobType" : "String value"
},
"policyProfileName" : "String value",
"targets" : {
"targets" : [ {
"groupHierarchy" : "String value",
"groupId" : "String value",
"groupName" : "String value",
"ipAddress" : "String value",
"type" : "DEVICE"
} ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v2/op/compliance/run
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/compliance/run" rootUrl="https://localhost/webacs/api/v2/op">
<complianceResult>
<isSuccess>true</isSuccess>
<message>String value</message>
</complianceResult>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/compliance/run.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/compliance/run",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"complianceResult" : [ {
"isSuccess" : true,
"message" : "String value"
} ]
}
}
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Write |
HTTP Methods |
POST |
Resource URL
/webacs/api/v3/op/compliance/run UnmodifiedThis resource has not been modified since the previous API version.
Request Payload Parameters
Attribute | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
configFileFrom String |
One of LATEST_FROM_DEVICE (collects the config from Device), LATEST_FROM_ARCHIVE (collects the config from Database which already collected). By default LATEST_FROM_DEVICE. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Job details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
policyProfileName String |
Profile name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Targets to check, devices or groups. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response Parameters
Attribute | Description |
---|---|
isSuccess boolean |
If true, the action was successfully performed. If false, it ended in some failure condition. |
message String |
The action status message. |
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Request Payload
https://localhost/webacs/api/v3/op/compliance/run
<?xml version="1.0" ?>
<complianceJobRun>
<configFileFrom>String value</configFileFrom>
<jobDto>
<description>String value</description>
<jobName>String value</jobName>
<jobSchedule>
<daily>true</daily>
<dayOfWeek>String value</dayOfWeek>
<dayRepetition>String value</dayRepetition>
<fortnight>true</fortnight>
<hourRepetition>String value</hourRepetition>
<hourly>true</hourly>
<jobScheduleTime>
<day>String value</day>
<endDate>String value</endDate>
<hour>String value</hour>
<minute>String value</minute>
<month>String value</month>
<startDate>String value</startDate>
<year>String value</year>
</jobScheduleTime>
<minute>true</minute>
<monthly>true</monthly>
<monthlyDay>String value</monthlyDay>
<monthlyMonth>String value</monthlyMonth>
<monthlyWeek>String value</monthlyWeek>
<monthlyWeekDay>String value</monthlyWeekDay>
<noOfRepetitions>String value</noOfRepetitions>
<now>true</now>
<weekly>true</weekly>
<yearly>true</yearly>
</jobSchedule>
<jobType>String value</jobType>
</jobDto>
<policyProfileName>String value</policyProfileName>
<targets>
<targets>
<groupHierarchy>String value</groupHierarchy>
<groupId>String value</groupId>
<groupName>String value</groupName>
<ipAddress>String value</ipAddress>
<type>DEVICE</type>
</targets>
<targets>
<groupHierarchy>Another string value</groupHierarchy>
<groupId>Another string value</groupId>
<groupName>Another string value</groupName>
<ipAddress>Another string value</ipAddress>
<type>GROUP</type>
</targets>
</targets>
</complianceJobRun>
Sample JSON Request Payload
https://localhost/webacs/api/v3/op/compliance/run.json
{
"complianceJobRun" : {
"configFileFrom" : "String value",
"jobDto" : {
"description" : "String value",
"jobName" : "String value",
"jobSchedule" : {
"daily" : true,
"dayOfWeek" : "String value",
"dayRepetition" : "String value",
"fortnight" : true,
"hourRepetition" : "String value",
"hourly" : true,
"jobScheduleTime" : {
"day" : "String value",
"endDate" : "String value",
"hour" : "String value",
"minute" : "String value",
"month" : "String value",
"startDate" : "String value",
"year" : "String value"
},
"minute" : true,
"monthly" : true,
"monthlyDay" : "String value",
"monthlyMonth" : "String value",
"monthlyWeek" : "String value",
"monthlyWeekDay" : "String value",
"noOfRepetitions" : "String value",
"now" : true,
"weekly" : true,
"yearly" : true
},
"jobType" : "String value"
},
"policyProfileName" : "String value",
"targets" : {
"targets" : [ {
"groupHierarchy" : "String value",
"groupId" : "String value",
"groupName" : "String value",
"ipAddress" : "String value",
"type" : "DEVICE"
}, {
"groupHierarchy" : "Another string value",
"groupId" : "Another string value",
"groupName" : "Another string value",
"ipAddress" : "Another string value",
"type" : "GROUP"
} ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v3/op/compliance/run
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/compliance/run" rootUrl="https://localhost/webacs/api/v3/op">
<complianceResult>
<isSuccess>true</isSuccess>
<message>String value</message>
</complianceResult>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/compliance/run.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/compliance/run",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"complianceResult" : [ {
"isSuccess" : true,
"message" : "String value"
} ]
}
}
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Write |
HTTP Methods |
POST |
Resource URL
/webacs/api/v4/op/compliance/run UnmodifiedThis resource has not been modified since the previous API version.
Request Payload Parameters
Attribute | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
configFileFrom String |
One of LATEST_FROM_DEVICE (collects the config from Device), LATEST_FROM_ARCHIVE (collects the config from Database which already collected). By default LATEST_FROM_DEVICE. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Job details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
policyProfileName String |
Profile name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Targets to check, devices or groups. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response Parameters
Attribute | Description |
---|---|
isSuccess boolean |
If true, the action was successfully performed. If false, it ended in some failure condition. |
message String |
The action status message. |
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Request Payload
https://localhost/webacs/api/v4/op/compliance/run
<?xml version="1.0" ?>
<complianceJobRun>
<configFileFrom>String value</configFileFrom>
<jobDto>
<description>String value</description>
<jobName>String value</jobName>
<jobSchedule>
<daily>true</daily>
<dayOfWeek>String value</dayOfWeek>
<dayRepetition>String value</dayRepetition>
<fortnight>true</fortnight>
<hourRepetition>String value</hourRepetition>
<hourly>true</hourly>
<jobScheduleTime>
<day>String value</day>
<endDate>String value</endDate>
<hour>String value</hour>
<minute>String value</minute>
<month>String value</month>
<startDate>String value</startDate>
<year>String value</year>
</jobScheduleTime>
<minute>true</minute>
<monthly>true</monthly>
<monthlyDay>String value</monthlyDay>
<monthlyMonth>String value</monthlyMonth>
<monthlyWeek>String value</monthlyWeek>
<monthlyWeekDay>String value</monthlyWeekDay>
<noOfRepetitions>String value</noOfRepetitions>
<now>true</now>
<weekly>true</weekly>
<yearly>true</yearly>
</jobSchedule>
<jobType>String value</jobType>
</jobDto>
<policyProfileName>String value</policyProfileName>
<targets>
<targets>
<groupHierarchy>String value</groupHierarchy>
<groupId>String value</groupId>
<groupName>String value</groupName>
<ipAddress>String value</ipAddress>
<type>DEVICE</type>
</targets>
<targets>
<groupHierarchy>Another string value</groupHierarchy>
<groupId>Another string value</groupId>
<groupName>Another string value</groupName>
<ipAddress>Another string value</ipAddress>
<type>GROUP</type>
</targets>
</targets>
</complianceJobRun>
Sample JSON Request Payload
https://localhost/webacs/api/v4/op/compliance/run.json
{
"complianceJobRun" : {
"configFileFrom" : "String value",
"jobDto" : {
"description" : "String value",
"jobName" : "String value",
"jobSchedule" : {
"daily" : true,
"dayOfWeek" : "String value",
"dayRepetition" : "String value",
"fortnight" : true,
"hourRepetition" : "String value",
"hourly" : true,
"jobScheduleTime" : {
"day" : "String value",
"endDate" : "String value",
"hour" : "String value",
"minute" : "String value",
"month" : "String value",
"startDate" : "String value",
"year" : "String value"
},
"minute" : true,
"monthly" : true,
"monthlyDay" : "String value",
"monthlyMonth" : "String value",
"monthlyWeek" : "String value",
"monthlyWeekDay" : "String value",
"noOfRepetitions" : "String value",
"now" : true,
"weekly" : true,
"yearly" : true
},
"jobType" : "String value"
},
"policyProfileName" : "String value",
"targets" : {
"targets" : [ {
"groupHierarchy" : "String value",
"groupId" : "String value",
"groupName" : "String value",
"ipAddress" : "String value",
"type" : "DEVICE"
}, {
"groupHierarchy" : "Another string value",
"groupId" : "Another string value",
"groupName" : "Another string value",
"ipAddress" : "Another string value",
"type" : "GROUP"
} ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v4/op/compliance/run
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/compliance/run" rootUrl="https://localhost/webacs/api/v4/op">
<complianceResult>
<isSuccess>true</isSuccess>
<message>String value</message>
</complianceResult>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/compliance/run.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/compliance/run",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/op",
"complianceResult" : [ {
"isSuccess" : true,
"message" : "String value"
} ]
}
}