Cirrus.ConfigArchive
SolarWinds Information Service 2024.1 Schema Documentation
Data about downloaded configs. For valid Orion user with at least WebViewer NCM role.
Inheritance
Access control
everyone
Properties
| Name | Type | Summary | Access Control |
|---|---|---|---|
| ConfigID | System.Guid | Unique identifier of the config. | everyone |
| BaseConfigID | System.Guid | The base config ID. | everyone |
| NodeID | System.Guid | NCM node ID. | everyone |
| ConfigTitle | System.String | Config title. | everyone |
| DownloadTime | System.DateTime | Date and time when config was downloaded. | everyone |
| AttemptedDownloadTime | System.DateTime | Date and time when downloation was triggered. | everyone |
| ModifiedTime | System.DateTime | Date and time of the config modification. | everyone |
| ConfigType | System.String | Config type. | everyone |
| Config | System.String | Current config on device. | everyone |
| Comments | System.String | Comments to the config. | everyone |
| Baseline | System.Boolean | The baseline config of a device. | everyone |
| IsIndexed | System.Boolean | Is config indexed(true/false). | everyone |
| IsBinary | System.Boolean | Is config a binary file(true/false). | everyone |
| Hash | System.String | The hash for the config. | everyone |
Source Relationships
| Name | Type | Notes |
|---|---|---|
| TransferResults | NCM.TransferResults | Defined by relationship NCM.ConfigArchiveRefTransferResults (System.Reference) |
Verbs
Diff
Runs the comparer. Valid for Orion manage node users with at least WebViewer NCM role.First config ID.Second config ID.Difference between configs. Full type: System.Data.DataTable
Access control
everyone
CompareConfigs
Compares the configs.. Valid for Orion manage node users with at least WebDownloader NCM role.First config ID.Second config ID.Config search term.Comparison results. Full type: SolarWinds.Orion.DiffEngine.Contract.Models.TextDocumentDiff
Access control
everyone
GetPermissionsByRole
Gets all permissions for specified role. Valid for Orion manage node users with at least WebViewer NCM role.Role name.Array of permissions. Full type: array of System.String
Access control
everyone
DeleteConfigs
Removes the config. Valid for Orion manage node users with at least WebUploader NCM role.List of config IDs.Who requested the verb.
Access control
everyone
GetConfigTypes
Gets all available config types. Valid for Orion manage node users with at least WebViewer NCM role.Config types. Full type: System.String
Access control
everyone
CancelTransfers
Cancels transfers specified in parameter. Valid for Orion manage node users with at least WebDownloader NCM role.Array of the transfer IDs.
Access control
everyone
ExecuteScript
Executes script on the particular node. Valid for Orion manage node users with at least WebUploader NCM role.Array of NCM node IDs.Script to execute.Should a device be rebooted after script execution(true/false).Array of transfer IDs. Full type: array of System.Guid
Access control
everyone
ExecuteScriptPerNode
Executes scripts per nodes. Valid for Orion manage node users with at least WebUploader NCM role.Array of scripts and nodes.Should a device be rebooted after script execution(true/false).Array of transfer IDs. Full type: array of System.Guid
Access control
everyone
ReExecute
Re-executes script Valid for Orion manage node users with at least WebDownloader NCM role.Array of ticket ID.Array of transfer IDs. Full type: array of System.Guid
Access control
everyone
UploadConfig
Uploads config. Valid for Orion manage node users with at least WebUploader NCM role.NCM node ID.Config type.Config.Device should be rebooted after upload(true/false).Array of transfer IDs. Full type: array of System.Guid
Access control
everyone
UploadConfigPerNode
Uploads config. Valid for Orion manage node users with at least WebUploader NCM role.Array of script and node.Config type.Device should be rebooted after upload(true/false).Array of transfer IDs. Full type: array of System.Guid
Access control
everyone
DownloadConfig
Downloads config file for the particular node. Valid for Orion manage node users with at least WebDownloader NCM role.Array of NCM node IDs.Config type.Array of transfer IDs. Full type: array of System.Guid
Access control
everyone
ExecuteScriptOnNodes
Executes script on the particular nodes. Valid for Orion manage node users with at least WebUploader NCM role.The list of nodes.Device template.Script to execute.Array of transfer IDs. Full type: array of System.Guid
Access control
everyone
DownloadConfigOnNodes
Downloads config file for the particular nodes. Valid for Orion manage node users with at least WebDownloader NCM role. The list of nodes.Device template.Config type.Array of transfer IDs. Full type: array of System.Guid
Access control
everyone
ConfigSearch
Searches for the config (Verb ConfigSearch will be removed. Please use the ConfigSearch2 verb instead). Valid for Orion manage node users with at least WebViewer NCM role.Config search term.Array of config IDs. Full type: Array of System.Guid
Access control
everyone
ConfigSearch2
Searches for the config. Valid for Orion manage node users with at least WebViewer NCM role.Config search term.Array of config IDs. Full type: Array of System.Guid
Access control
everyone
RunIndexOptimization
Runs index optimization. Valid for Orion manage node users with at least WebViewer NCM role.Parent Config IDConfig titleConfig comments.ConfigWho requested the verb.
Access control
| Operations | Right |
|---|---|
| invoke | system |
UpdateConfig
Updates config. Valid for Orion manage node users with at least WebUploader NCM role.Config ID.Config title.Config comments.Config.Config text should be updated(true/false).Who requested the verb.
Access control
everyone
CloneConfig
Clones the config. Valid for Orion manage node users with at least WebUploader NCM role.Parent Config IDConfig titleConfig comments.Config
Access control
everyone
ImportConfig
Imports binary config. Valid for Orion manage node users with at least WebUploader NCM role.NCM node ID.The title of a config.The comments of a config.Config as text.
Access control
everyone
ImportBinaryConfig
Imports binary config. Valid for Orion manage node users with at least WebUploader NCM role.NCM node ID.The title of a config.The comments of a config.Config as binary.
Access control
everyone
SetClearBaseline
Sets clear baseline. Valid for Orion manage node users with at least WebUploader NCM role.List of config IDs.
Access control
everyone
ValidateBinaryConfigStorage
Validates binary config storage. Valid for Orion manage node users with at least Administrator NCM role.Path to the storage.Username to the network.Password to the network.The result of a validation. Full type: SolarWinds.NCM.Contracts.InformationService.ValidationResult
Access control
everyone
GetInterfaceConfigSnippets
Gets interface config snippets. Valid for Orion manage node users with at least WebViewer NCM role.The ID of the core node.Array of config snippets. Full type: array of System.String
Access control
everyone