Updates basic parameters for the configuration archive, such as protocol, timeout value, number of configuration versions to store, and so forth.
Since Product Version: 3.2
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
API version v1 is deprecated
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/settings/inventory/configArchiveBasic
Request Payload Parameters
inventoryIntegration
boolean
|
Do you want the application to archive configuration after Inventory Sync?
|
inventoryTriggered
boolean
|
Trigger inventory collection before config archive?
|
maskAuthInfo
boolean
|
Do you want to mask security content while exporting configuration to a file?
|
noOfParallelThreads
int
|
|
numberOfDays
Integer
|
Maximum number of days for which configuration versions should be retained for each device. Turn off this property as well as "Number of versions to retain" property to maintain unlimited number of versions. In case both the retention policies are enabled, application will use the widest retained versions from both the policies.
|
numberOfVersions
Integer
|
Maximum number of configuration versions to be retained for each device. Turn off this property as well as "Number of days to retain" property to maintain unlimited number of versions. In case both the retention policies are enabled, application will use the widest retained versions from both the policies.
|
outofboxArchiveIntegration
boolean
|
Do you want the application to archive configuration out-of-box? Turn off this property to disable automatic configuration archive through all the flows. To control archive on inventory sync and change events etc, use individual settings by keeping this setting on. Turning on this setting alone means, archive on initial inventory will be enabled.
|
syslogHoldOffTimer
Integer
|
Do you want the application to archive configuration after receiving configuration change events? Turn off (do not pass value) this property to stop processing configuration change events. The events that are already received and waiting for their hold off timer period, will still get processed immediately. Hold-off timer controls when the application should trigger archive, after the first indication of a configuration change event. Measurement unit is minute.
|
timeout
int
|
Maximum time in milliseconds to wait while performing any configuration operation like fetch, archive and rollback.
|
viewUpdateTimeout
int
|
Maximum time in minutes to wait before updating configuration archive summary data.
|
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://10.56.58.149/webacs/api/v1/op/settings/inventory/configArchiveBasic
<?xml version="1.0" ?>
<inventoryConfigArchiveBasicSettingsDto>
<inventoryIntegration>true</inventoryIntegration>
<inventoryTriggered>true</inventoryTriggered>
<maskAuthInfo>true</maskAuthInfo>
<noOfParallelThreads>1</noOfParallelThreads>
<numberOfDays>15</numberOfDays>
<numberOfVersions>15</numberOfVersions>
<outofboxArchiveIntegration>true</outofboxArchiveIntegration>
<syslogHoldOffTimer>15</syslogHoldOffTimer>
<timeout>1</timeout>
<viewUpdateTimeout>1</viewUpdateTimeout>
</inventoryConfigArchiveBasicSettingsDto>
Sample JSON Request Payload
https://10.56.58.149/webacs/api/v1/op/settings/inventory/configArchiveBasic.json
{
"inventoryConfigArchiveBasicSettingsDto" : {
"inventoryIntegration" : true,
"inventoryTriggered" : true,
"maskAuthInfo" : true,
"noOfParallelThreads" : 1,
"numberOfDays" : 15,
"numberOfVersions" : 15,
"outofboxArchiveIntegration" : true,
"syslogHoldOffTimer" : 15,
"timeout" : 1,
"viewUpdateTimeout" : 1
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/settings/inventory/configArchiveBasic
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
inventoryIntegration
boolean
|
Do you want the application to archive configuration after Inventory Sync?
|
inventoryTriggered
boolean
|
Trigger inventory collection before config archive?
|
maskAuthInfo
boolean
|
Do you want to mask security content while exporting configuration to a file?
|
noOfParallelThreads
int
|
|
numberOfDays
Integer
|
Maximum number of days for which configuration versions should be retained for each device. Turn off this property as well as "Number of versions to retain" property to maintain unlimited number of versions. In case both the retention policies are enabled, application will use the widest retained versions from both the policies.
|
numberOfVersions
Integer
|
Maximum number of configuration versions to be retained for each device. Turn off this property as well as "Number of days to retain" property to maintain unlimited number of versions. In case both the retention policies are enabled, application will use the widest retained versions from both the policies.
|
outofboxArchiveIntegration
boolean
|
Do you want the application to archive configuration out-of-box? Turn off this property to disable automatic configuration archive through all the flows. To control archive on inventory sync and change events etc, use individual settings by keeping this setting on. Turning on this setting alone means, archive on initial inventory will be enabled.
|
syslogHoldOffTimer
Integer
|
Do you want the application to archive configuration after receiving configuration change events? Turn off (do not pass value) this property to stop processing configuration change events. The events that are already received and waiting for their hold off timer period, will still get processed immediately. Hold-off timer controls when the application should trigger archive, after the first indication of a configuration change event. Measurement unit is minute.
|
timeout
int
|
Maximum time in milliseconds to wait while performing any configuration operation like fetch, archive and rollback.
|
viewUpdateTimeout
int
|
Maximum time in minutes to wait before updating configuration archive summary data.
|
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://10.56.58.149/webacs/api/v2/op/settings/inventory/configArchiveBasic
<?xml version="1.0" ?>
<inventoryConfigArchiveBasicSettingsDto>
<inventoryIntegration>true</inventoryIntegration>
<inventoryTriggered>true</inventoryTriggered>
<maskAuthInfo>true</maskAuthInfo>
<noOfParallelThreads>1</noOfParallelThreads>
<numberOfDays>15</numberOfDays>
<numberOfVersions>15</numberOfVersions>
<outofboxArchiveIntegration>true</outofboxArchiveIntegration>
<syslogHoldOffTimer>15</syslogHoldOffTimer>
<timeout>1</timeout>
<viewUpdateTimeout>1</viewUpdateTimeout>
</inventoryConfigArchiveBasicSettingsDto>
Sample JSON Request Payload
https://10.56.58.149/webacs/api/v2/op/settings/inventory/configArchiveBasic.json
{
"inventoryConfigArchiveBasicSettingsDto" : {
"inventoryIntegration" : true,
"inventoryTriggered" : true,
"maskAuthInfo" : true,
"noOfParallelThreads" : 1,
"numberOfDays" : 15,
"numberOfVersions" : 15,
"outofboxArchiveIntegration" : true,
"syslogHoldOffTimer" : 15,
"timeout" : 1,
"viewUpdateTimeout" : 1
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/settings/inventory/configArchiveBasic
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
inventoryIntegration
boolean
|
Do you want the application to archive configuration after Inventory Sync?
|
inventoryTriggered
boolean
|
Trigger inventory collection before config archive?
|
maskAuthInfo
boolean
|
Do you want to mask security content while exporting configuration to a file?
|
noOfParallelThreads
int
|
|
numberOfDays
Integer
|
Maximum number of days for which configuration versions should be retained for each device. Turn off this property as well as "Number of versions to retain" property to maintain unlimited number of versions. In case both the retention policies are enabled, application will use the widest retained versions from both the policies.
|
numberOfVersions
Integer
|
Maximum number of configuration versions to be retained for each device. Turn off this property as well as "Number of days to retain" property to maintain unlimited number of versions. In case both the retention policies are enabled, application will use the widest retained versions from both the policies.
|
outofboxArchiveIntegration
boolean
|
Do you want the application to archive configuration out-of-box? Turn off this property to disable automatic configuration archive through all the flows. To control archive on inventory sync and change events etc, use individual settings by keeping this setting on. Turning on this setting alone means, archive on initial inventory will be enabled.
|
syslogHoldOffTimer
Integer
|
Do you want the application to archive configuration after receiving configuration change events? Turn off (do not pass value) this property to stop processing configuration change events. The events that are already received and waiting for their hold off timer period, will still get processed immediately. Hold-off timer controls when the application should trigger archive, after the first indication of a configuration change event. Measurement unit is minute.
|
timeout
int
|
Maximum time in milliseconds to wait while performing any configuration operation like fetch, archive and rollback.
|
viewUpdateTimeout
int
|
Maximum time in minutes to wait before updating configuration archive summary data.
|
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://10.56.58.149/webacs/api/v3/op/settings/inventory/configArchiveBasic
<?xml version="1.0" ?>
<inventoryConfigArchiveBasicSettingsDto>
<inventoryIntegration>true</inventoryIntegration>
<inventoryTriggered>true</inventoryTriggered>
<maskAuthInfo>true</maskAuthInfo>
<noOfParallelThreads>1</noOfParallelThreads>
<numberOfDays>15</numberOfDays>
<numberOfVersions>15</numberOfVersions>
<outofboxArchiveIntegration>true</outofboxArchiveIntegration>
<syslogHoldOffTimer>15</syslogHoldOffTimer>
<timeout>1</timeout>
<viewUpdateTimeout>1</viewUpdateTimeout>
</inventoryConfigArchiveBasicSettingsDto>
Sample JSON Request Payload
https://10.56.58.149/webacs/api/v3/op/settings/inventory/configArchiveBasic.json
{
"inventoryConfigArchiveBasicSettingsDto" : {
"inventoryIntegration" : true,
"inventoryTriggered" : true,
"maskAuthInfo" : true,
"noOfParallelThreads" : 1,
"numberOfDays" : 15,
"numberOfVersions" : 15,
"outofboxArchiveIntegration" : true,
"syslogHoldOffTimer" : 15,
"timeout" : 1,
"viewUpdateTimeout" : 1
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/settings/inventory/configArchiveBasic
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
inventoryIntegration
boolean
|
Do you want the application to archive configuration after Inventory Sync?
|
inventoryTriggered
boolean
|
Trigger inventory collection before config archive?
|
maskAuthInfo
boolean
|
Do you want to mask security content while exporting configuration to a file?
|
noOfParallelThreads
int
|
|
numberOfDays
Integer
|
Maximum number of days for which configuration versions should be retained for each device. Turn off this property as well as "Number of versions to retain" property to maintain unlimited number of versions. In case both the retention policies are enabled, application will use the widest retained versions from both the policies.
|
numberOfVersions
Integer
|
Maximum number of configuration versions to be retained for each device. Turn off this property as well as "Number of days to retain" property to maintain unlimited number of versions. In case both the retention policies are enabled, application will use the widest retained versions from both the policies.
|
outofboxArchiveIntegration
boolean
|
Do you want the application to archive configuration out-of-box? Turn off this property to disable automatic configuration archive through all the flows. To control archive on inventory sync and change events etc, use individual settings by keeping this setting on. Turning on this setting alone means, archive on initial inventory will be enabled.
|
syslogHoldOffTimer
Integer
|
Do you want the application to archive configuration after receiving configuration change events? Turn off (do not pass value) this property to stop processing configuration change events. The events that are already received and waiting for their hold off timer period, will still get processed immediately. Hold-off timer controls when the application should trigger archive, after the first indication of a configuration change event. Measurement unit is minute.
|
timeout
int
|
Maximum time in milliseconds to wait while performing any configuration operation like fetch, archive and rollback.
|
viewUpdateTimeout
int
|
Maximum time in minutes to wait before updating configuration archive summary data.
|
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://10.56.58.149/webacs/api/v4/op/settings/inventory/configArchiveBasic
<?xml version="1.0" ?>
<inventoryConfigArchiveBasicSettingsDto>
<inventoryIntegration>true</inventoryIntegration>
<inventoryTriggered>true</inventoryTriggered>
<maskAuthInfo>true</maskAuthInfo>
<noOfParallelThreads>1</noOfParallelThreads>
<numberOfDays>15</numberOfDays>
<numberOfVersions>15</numberOfVersions>
<outofboxArchiveIntegration>true</outofboxArchiveIntegration>
<syslogHoldOffTimer>15</syslogHoldOffTimer>
<timeout>1</timeout>
<viewUpdateTimeout>1</viewUpdateTimeout>
</inventoryConfigArchiveBasicSettingsDto>
Sample JSON Request Payload
https://10.56.58.149/webacs/api/v4/op/settings/inventory/configArchiveBasic.json
{
"inventoryConfigArchiveBasicSettingsDto" : {
"inventoryIntegration" : true,
"inventoryTriggered" : true,
"maskAuthInfo" : true,
"noOfParallelThreads" : 1,
"numberOfDays" : 15,
"numberOfVersions" : 15,
"outofboxArchiveIntegration" : true,
"syslogHoldOffTimer" : 15,
"timeout" : 1,
"viewUpdateTimeout" : 1
}
}