{
    backgroundGenerationAnnotation: string
    When the report is being generated in the background, an optional annotation or description that helps identify this particular report; will be truncated to 255 characters if this is too long
 
    backgroundGenerationNotifyViaEmailFlag: boolean
    When the report is being generated in the background, whether or not a notification is emailed to the requesting user when the report generation is finished and the report is ready for retrieval; note that the requesting user must be configured with an email address and system parameters must be configured with an SMTP gateway
 
    foregroundGenerationFlag: boolean
    Whether or not the report is to be generated in the foreground; when false, the report is generated in the background and stored to the database for later retrieval; when true, the report is generated in the foreground and returned to the caller immediately; ignored for details type reports and the license usage report (which are always foregrounded)
}

{
    id: string
    A GUID that is a hook for aborting the report generation request, and for retrieving the completed report content
}

{
    id: string
    The database key of the component; an incoming component can be identified either by its database key, or by its unique name, or by its name with qualifiers which are unique when combined; when this database key is present, it takes precedence and componentName and qualifiers(when present) are used to verify the retrieved component
 
    componentName: string
    The name of the component; an incoming component can be identified either by its database key, or by its unique name, or by its name with qualifiers which are unique when combined; this name is used to verify any component retrieved by database key, and is used if there is no database key or if the database key fails to resolve
 
    componentType: string*
    The type of the component, used to verify what is retrieved by key/name; valid values are: Combogroup, Condition, Configuration, Device, DynamicField, EmailDistributionList, Group, Keyword, Model, OsImage, Realm, Role, Rule, RuleSet, SecurityVulnerability, SnmpManagerStation, Template, and User
 
    qualifiers: {
      Any additional single qualifier needed to identify the component uniquely, when the name alone is not sufficient; the map key is the extra attribute name string; the map value string completes the identification of the component; for componentType Configuration: key=deviceName, value=name of the device the configuration belongs to; for componentType DynamicField: key=type, value=base class name of the component associated with the dynamic field; for componentType Group, ComboGroup: key=realmName, value=name of the realm the group belongs to; for componentType Model: key=vendorGuid, value=the vendor GUID; for componentType OsImage: key=filename, value=name of the file(s) making up the image; for componentType SecurityVulnerability: key=vendorGuid, value=the vendor GUID
    }
}

{
    id: #ComponentId
   Identifies the network span, giving its database key, name, and type
 
    deviceAddress: string
    When the network span is a device, the device's primary host name or IP address
 
    realmId: #ComponentId
   When the network span is a group or a device, and when there are multiple realms in the system, identifies the owning realm
 
    eventCount: integer
    Number of events related to this device that have occurred since the first discrepancy was discovered
 
    osImageDiscrepancyTimestamp: string
    When a discrepancy between the current OS image version and the trusted running OS image version was discovered, in the system's display format; a null indicates there is no such discrepancy
 
    overallDiscrepancyTimestamp: date-time
    When a discrepancy was first discovered on this device; a null indicates there are no discrepancies
     Example: 2017-01-31T13:45:00.000+0000
 
    runningVsStartupDiscrepancyTimestamp: string
    When a discrepancy between the current running configuration and the current startup configuration was discovered, in the system's display format; a null indicates there is no such discrepancy
 
    runningVsTrustedDiscrepancyTimestamp: string
    When a discrepancy between the current running configuration and the trusted running configuration was discovered, in the system's display format; a null indicates there is no such discrepancy
 
    startupVsTrustedDiscrepancyTimestamp: string
    When a discrepancy between the current startup configuration and the trusted startup configuration was discovered, in the system's display format; a null indicates there is no such discrepancy
}

{
    dynamicFieldFilters: {
      Any filters on dynamic fields; this is a map where the map key is the filter string (the value to be matched) and the map value is a ComponentId that identifies the dynamic field; menu-type dynamic fields support only exact matching; the filter string must be formatted properly when the dynamic field is a Date or Integer type
    }
 
    containsUnresolvableDynamicFieldFiltersFlag: boolean
    Indicates that one or more of the dynamic fields being filtered on no longer exists and thus re-using this filter may not result in the same outcome (read-only)
 
    accessModeId: integer
    Search for devices with this access mode
 
    addressMatch: string
    Search for devices matching this wildcard-enabled IP address or host name
 
    autoDspFlag: boolean
    Search for devices set for device security profile auto-discovery (true) or set to an explicit profile (false); null means do no auto-discovery mode filtering
 
    categoryId: integer
    Search for devices in this category
 
    createdTimePeriod: string
    Search for devices created within this time period
 
    deviceAgentName: string
    Search for devices whose device agent equals this name
 
    deviceAgentNICName: string
    Search for devices whose NIC equals this name, within the device agent specified by the deviceAgentName field; use "(Default)" to filter for devices using the default NIC
 
    deviceSecurityProfileName: string
    Search for devices whose device security profile equals this name
 
    deviceTypeGuid: string
    Search for devices whose device type equals this GUID
 
    filterAuxiliaryInterfaceFlag: boolean
    Whether or not to examine the auxiliary interface settings when matching on the interface-related fields (access mode, transfer mode, address, NAT address, device agent, NIC, and device security profile)
 
    filterPrimaryInterfaceFlag: boolean
    Whether or not to examine the primary interface settings when matching on the interface-related fields (access mode, transfer mode, address, NAT address, device agent, NIC, and device security profile)
 
    managerDeviceName: string
    Search for devices whose manager name equals this name
 
    modelNameMatch: string
    Search for devices whose model name matches this wildcard-enabled string
 
    nameMatch: string
    Search for devices whose name matches this wildcard-enabled string
 
    natAddressMatch: string
    Search for devices whose NAT address matches this wildcard-enabled string
 
    onlineFlag: boolean
    Search for either online devices (true) or offline devices (false); null means do not filter on the online/offline state
 
    osImageNameMatch: string
    Search for devices whose OS image name matches this wildcard-enabled string
 
    securityContextTypeId: integer
    Search for devices set to this type of security context
 
    transferModeId: integer
    Search for devices with this file transfer mode
 
    vendorGuid: string
    Search for devices whose device type belongs to this vendor
 
    noDiscrepanciesFlag: boolean
    Search for devices that have no discrepancies at all
 
    noDiscrepanciesIncludeFlag: boolean
    Whether to include (true) or exclude (false) devices that have no discrepancies
 
    osImageDiscrepancyFlag: boolean
    Search for devices that have an OS image discrepancy
 
    osImageDiscrepancyIncludeFlag: boolean
    Whether to include (true) or exclude (false) devices that have an OS image discrepancy
 
    runningStartupDiscrepancyFlag: boolean
    Search for devices that have a Running vs Startup discrepancy
 
    runningStartupDiscrepancyIncludeFlag: boolean
    Whether to include (true) or exclude (false) devices that have a Running vs Startup discrepancy
 
    runningTrustedDiscrepancyFlag: boolean
    Search for devices that have a Running vs Trusted Running discrepancy
 
    runningTrustedDiscrepancyIncludeFlag: boolean
    Whether to include (true) or exclude (false) devices that have a Running vs trusted Running discrepancy
 
    startupTrustedDiscrepancyFlag: boolean
    Search for devices that have a Startup vs Trusted Startup discrepancy
 
    startupTrustedDiscrepancyIncludeFlag: boolean
    Whether to include (true) or exclude (false) devices that have a Startup vs trusted Startup discrepancy
 
    noViolationsFlag: boolean
    Search for devices that have no compliance violations
 
    noViolationsIncludeFlag: boolean
    Whether to include (true) or exclude (false) devices that have no compliance violations
 
    includedViolationTrailGuids: [
      Include devices in the results that have a compliance violation in one of these trails
 
      string
    ]
 
    excludedViolationTrailGuids: [
      Exclude devices from the results that have a compliance violation in one of these trails
 
      string
    ]
 
    lastAttemptedSpanActionFlag: boolean
    Search for devices whose last attempted span action matches a particular completion status
 
    lastAttemptedSpanActionGuid: string
    When lastAttemptedSpanActionFlag is true, specifies which span action to examine
 
    lastAttemptedSpanActionStatusId: integer
    When lastAttemptedSpanActionFlag is true, specifies which completion status to search for
 
    lastAttemptedSpanActionErrorMatch: string
    When lastAttemptedSpanActionFlag is true, specifies which completion error message to search for, wildcards allowed
 
    lastSuccessfulSpanActionFlag: boolean
    Search for devices whose last successful span action occurred within a selected time period
 
    lastSuccessfulSpanActionGuid: string
    When lastSuccessfulSpanActionFlag is true, specifies which span action to examine
 
    lastSuccessfulSpanActionTimePeriod: string
    When lastSuccessfulSpanActionFlag is true, specifies when the action is to have succeeded
 
    noAttemptedSpanActionFlag: boolean
    Searches for devices that have not attempted a span action within a specified number of days
 
    noAttemptedSpanActionGuid: string
    When noAttemptedSpanActionFlag is true, specifies which span action to examine
 
    noAttemptedSpanActionDays: integer
    When noAttemptedSpanActionFlag is true, specifies when the action is to have been attempted
 
    noSuccessfulSpanActionFlag: boolean
    Searches for devices that have not succeeded executing a span action within a specified number of days
 
    noSuccessfulSpanActionGuid: string
    When noSuccessfulSpanActionFlag is true, specifies which span action to examine
 
    noSuccessfulSpanActionDays: integer
    When noSuccessfulSpanActionFlag is true, specifies when the action is to have succeeded
 
    iosHwFilter: #IOSHardwareInventoryFilterDTO
   Options for filtering on hardware inventory information obtained from Cisco IOS or IOS-like devices
}

{
    lineIsIgnoredFlag: boolean
    Whether or not the contents of this line are ignored when making comparisons
 
    lineType: string
    What sort of line this represents, which indicates when sideOne and/or sideTwo are present and what their contents mean; EQUAL means there is data on both sides that are the same; CHANGED means there is data on both sides that are different; DELETED_FROM_LEFT means the data on side one (the left side) has no equivalent on side two; ADDED_TO_RIGHT means the data on side two (the right side) has no equivalent on side one; SKIPPED means both sides represent a range of skipped lines where no differences are present; HIDDEN means a side represents a range of lines not present in the template on the other side; BLOCK_CONTEXT means a side represents a line that is a block header that provides context; BINARY_CHANGE means binary data was involved and only file sizes are presented in the two sides
 
    sideOne: #DifferenceReportLineSideDTO
   The data from the first item being compared, or the data on the left side of the side-by-side comparison
 
    sideTwo: #DifferenceReportLineSideDTO
   The data from the second item being compared, or the data on the right side of the side-by-side comparison
}

{
    binaryFileSize: integer
    The size of the binary file on this side of the comparison; null when a binary file is not involved
 
    binaryFileChecksum: string
    The MD5 checksum of the binary file on this side of the comparison; null when a binary file is not involved
 
    data: string
    The one line of text or a configuration line on this side of the comparison
 
    dataIsIgnoredFlag: boolean
    Whether or not the data is ignored when making comparisons
 
    dataLineNumber: integer
    The line number where the data line appears
 
    firstLineNumber: integer
    The line number that starts a range of skipped or hidden lines; zero when this side is not within a skipped or hidden range
 
    lastLineNumber: integer
    The line number that ends a range of skipped or hidden lines; zero when this side is not within a skipped or hidden range
}

{
    device: #ReportNetworkSpanDTO
   The device being reported on
 
    inputParameters: #DiscrepancyDetailsReportParametersDTO
   The input report selections
 
    osImageDifferences: #ScriptDifferencesReportDTO
   When asked for, contains the differences found between the OS image versions of the current running configuration versus the trusted running configuration
 
    runningVsStartupDifferences: #ScriptDifferencesReportDTO
   When asked for, contains the differences found between the current running configuration versus the current startup configuration
 
    runningVsTrustedRunningDifferences: #ScriptDifferencesReportDTO
   When asked for, contains the differences found between the current running configuration versus the trusted running configuration
 
    startupVsTrustedStartupDifferences: #ScriptDifferencesReportDTO
   When asked for, contains the differences found between the current startup configuration versus the trusted startup configuration
}

{
    device: #ComponentId *
    The device to be reported on
 
    showFullViewFlag: boolean
    Whether or not to show a full view of the configurations; when true, the report shows the entire configuration with the discrepancies flagged; when false, the report shows just the lines causing a discrepancy, with a few lines of surrounding context
 
    showOsImageDiscrepancyFlag: boolean
    Whether or not to report on any OS image discrepancy
 
    showRunningVsStartupDiscrepancyFlag: boolean
    Whether or not to report on any running versus startup discrepancy
 
    showRunningVsTrustedDiscrepancyFlag: boolean
    Whether or not to report on any running versus trusted running discrepancy
 
    showStartupVsTrustedDiscrepancyFlag: boolean
    Whether or not to report on any startup versus trusted startup discrepancy
}

{
    deviceFilterDisplayString: string
    When the network span is filtered, the displayable version of the device filtering selections
 
    devices: [
      The devices in the selected network span and their discrepancy information; can be null when the selected span has no accessible devices or the device filter matches nothing; contains a single page of devices when this report is fetched from a stored report; contains all devices when this report is generated in the foreground
 
       #DeviceDiscrepancyReportDTO
    ]
 
    selectedNetworkSpan: #ReportNetworkSpanDTO
   The network span being reported on; a null means the network span is the entire network
 
    totalAvailableDevices: integer
    The number of devices available in the report, when you ignore paging, to help with pagination controls
 
    totalDevices: integer
    The number of accessible devices in the network span, when you ignore filtering
 
    totalOsImageDiscrepancies: integer
    The number of devices exhibiting an OS image version discrepancy
 
    totalRunningVsStartupDiscrepancies: integer
    The number of devices exhibiting a running versus startup discrepancy
 
    totalRunningVsTrustedDiscrepancies: integer
    The number of devices exhibiting a running versus trusted running discrepancy
 
    totalStartupVsTrustedDiscrepancies: integer
    The number of devices exhibiting a startup versus trusted startup discrepancy
}

{
    backgroundGenerationAnnotation: string
    When the report is being generated in the background, an optional annotation or description that helps identify this particular report; will be truncated to 255 characters if this is too long
 
    backgroundGenerationNotifyViaEmailFlag: boolean
    When the report is being generated in the background, whether or not a notification is emailed to the requesting user when the report generation is finished and the report is ready for retrieval; note that the requesting user must be configured with an email address and system parameters must be configured with an SMTP gateway
 
    foregroundGenerationFlag: boolean
    Whether or not the report is to be generated in the foreground; when false, the report is generated in the background and stored to the database for later retrieval; when true, the report is generated in the foreground and returned to the caller immediately; ignored for details type reports and the license usage report (which are always foregrounded)
 
    deviceFilter: #DeviceFilterDTO
   Specifies which devices are included in the network span; ignored when the networkSpan refers to a device
 
    networkSpan: #ComponentId
   Selects the devices to be reported on; a null means to report on all accessible devices in the system
}

{
    entityNameMatch: string
    Search for devices matching this wildcard-enabled hardware entity name
 
    entityDescrMatch: string
    Search for devices matching this wildcard-enabled hardware entity descr
 
    entityPidMatch: string
    Search for devices matching this wildcard-enabled hardware entity PID
 
    entityVidMatch: string
    Search for devices matching this wildcard-enabled hardware entity VID
 
    entitySnMatch: string
    Search for devices matching this wildcard-enabled hardware entity SN
 
    fileSystemFreeSizeIntegerRange: string
    Search for devices with a file system free size matching this range specification
 
    fileSystemNameMatch: string
    Search for devices matching this wildcard-enabled file system name
 
    fileSystemTotalSizeIntegerRange: string
    Search for devices with a file system total size matching this range specification
 
    memoryNameMatch: string
    Search for devices matching this wildcard-enabled memory name
 
    memorySizeIntegerRange: string
    Search for devices with a memory size matching this range specification
}

{
    id: string
    Uniquely identifies this report, for use in making other requests
 
    abortableFlag: boolean
    Whether or not the user can abort an in-progress report
 
    details: string
    Summary information about the parameters used to generate the report
 
    exportedFlag: boolean
    Whether or not a stored report contains displayable summary report content (false) or an exported report file (true)
 
    failedFlag: boolean
    Whether or not report generation failed; no report data is available when it failed
 
    foregroundedFlag: boolean
    Whether or not an in-progress report is being generated in the foreground (true) or in the background (false)
 
    inProgressReportFlag: boolean
    Whether this is a report currently in the process of being generated (true) or is a completed and stored report available for viewing (false)
 
    originator: string
    The name of the user who asked for this report, or the job ID generating the report
 
    percentComplete: integer
    For an in-progress report, how much is completed, for filling in a progress bar; null if the report does not report progress tracking
 
    repeatableFlag: boolean
    Whether or not the report can be re-generated
 
    reportDataLink: string
    Link to retrieve the data for a completed report
 
    reportName: string
    What type of report this is
 
    startTimestamp: string
    When the report generation was initiated
 
    status: string
    Current state of the report generation process; for an in-progress report with progress tracking, contains the current progress towards completion; for a completed report, contains the completion status and completion timestamp
}

{
}

{
    formatId: integer*
    The format of the exported file (CSV, HTML, PDF, or RTF)
 
    hideHeaderAndFooterFlag: boolean
    When the format is CSV, whether or not to hide the report header and footer; when false, the header/title and footer/selections are included in the CSV file; when true, the header and footer are excluded from the CSV file, making the file more easily imported into a spreadsheet; ignored when the format is not CSV
 
    hideSensitiveDataFlag: boolean
    For those reports that carry configuration data, whether or not the exported file masks sensitive configuration data, when false, the exported file contains the same data as the viewed report (which may already have masked its sensitive data, if you are not granted the "Access Sensitive Data" system right); when true, the exported file masks sensitive configuration data
 
    includeAllDetailsFlag: boolean
    When exporting a base or summary type of report, whether or not the exported file contains all the details subreports; when false, the exported file contains only the base or summary report; when true, the exported file contains the base report and its associated details reports (up to the number of details reports defined buy the system parameter "Maximum Number of Details in Exported Reports"); ignored when the report supports no details subreports (such as system diagnostics, device inventory, and OS image History reports)
 
    orderBy: string
    Sort report details by the specified attribute in the specified order (prefix with a '+' for ascending order or a '-' for descending order); each type of report supports different attributes that can be sorted; not applicable to the system diagnostics report (which has no sortable details)
 
    subject: string
    The subject of the email message carrying the report
 
    toAdhocAddresses: [
      Any ad-hoc email addresses of the other interested recipients of the report
 
      string
    ]
 
    toEmailListIds: [
      Any email distribution lists to receive the report
 
       #ComponentId
    ]
 
    toUserIds: [
      Any users to receive the report
 
       #ComponentId
    ]
}

{
    formatId: integer*
    The format of the exported file (CSV, HTML, PDF, or RTF)
 
    hideHeaderAndFooterFlag: boolean
    When the format is CSV, whether or not to hide the report header and footer; when false, the header/title and footer/selections are included in the CSV file; when true, the header and footer are excluded from the CSV file, making the file more easily imported into a spreadsheet; ignored when the format is not CSV
 
    hideSensitiveDataFlag: boolean
    For those reports that carry configuration data, whether or not the exported file masks sensitive configuration data, when false, the exported file contains the same data as the viewed report (which may already have masked its sensitive data, if you are not granted the "Access Sensitive Data" system right); when true, the exported file masks sensitive configuration data
 
    includeAllDetailsFlag: boolean
    When exporting a base or summary type of report, whether or not the exported file contains all the details subreports; when false, the exported file contains only the base or summary report; when true, the exported file contains the base report and its associated details reports (up to the number of details reports defined buy the system parameter "Maximum Number of Details in Exported Reports"); ignored when the report supports no details subreports (such as system diagnostics, device inventory, and OS image History reports)
 
    orderBy: string
    Sort report details by the specified attribute in the specified order (prefix with a '+' for ascending order or a '-' for descending order); each type of report supports different attributes that can be sorted; not applicable to the system diagnostics report (which has no sortable details)
}

{
    id: #ComponentId
   Identifies the network span, giving its database key, name, and type
 
    deviceAddress: string
    When the network span is a device, the device's primary host name or IP address
 
    realmId: #ComponentId
   When the network span is a group or a device, and when there are multiple realms in the system, identifies the owning realm
}

{
}

{
    id: string
    The database key of a script, when it is stored in the database
 
    configurationAnnotation: string
    The annotation associated with the configuration
 
    configurationBinaryFilename: string
    When the configuration contains binary data, the name of the binary file
 
    configurationCreationTimestamp: date-time
    The date and time the configuration was created
     Example: 2017-01-31T13:45:00.000+0000
 
    configurationExternalSourceFlag: boolean
    How the configuration originated; null means its origin is unknown; false means the configuration resulted from the system running a span action that made changes; true means the configuration resulted from a snapshot triggered by an external event
 
    configurationOriginatingChangeID: string
    The change ID associated with the job that created the configuration
 
    configurationOriginatingJobID: string
    The job ID associated with the job that created the configuration
 
    configurationOriginator: string
    The name of the user who ran the job that created the configuration or the external event that triggered that job
 
    configurationOsImageName: string
    The OS image version associated with the configuration
 
    configurationOwningDevice: #ComponentId
   Information about the device that owns the configuration
 
    configurationOwningRealmName: string
    The name of the realm the owning device belongs to, when there are multiple realms in the system
 
    configurationTrailGuid: string
    The GUID of the configuration trail
 
    configurationTrailName: string
    The name of the configuration trail
 
    configurationTrustedFlag: boolean
    Whether or not the configuration is a trusted configuration
 
    enforceableId: string
    The database key of the rule set or rule made compliant by this script
 
    enforceableLabel: string
    The name of the rule set or rule made compliant by this script
 
    scriptTypeId: integer
    What sort of script is being represented here
 
    scriptTypeName: string
    What sort of script is being represented here
 
    templateName: string
    The name of the template
 
    templateContentsNumber: string
    The number of the specific contents within the template
}

{
    fullViewModeFlag: boolean
    Whether or not all content lines are represented in the lines field; when false, indicates only changed snippets of the contents are included; when true, indicates all content lines are included
 
    lines: [
      Lines that make up the side-by-side differences or changes; when null in snippet view mode, indicates no differences exist in the compared contents
 
       #DifferenceReportLineDTO
    ]
 
    hasOsImageDifferenceFlag: boolean
    Whether or not there is a difference in the OS image versions between the two scripts
 
    hasScriptDifferenceFlag: boolean
    Whether or not there is a difference in the content between the two scripts
 
    imageNameOne: string
    The OS image version associated with the first script, when there is a difference in the OS image versions between the two scripts
 
    imageNameTwo: string
    The OS image version associated with the second script, when there is a difference in the OS image versions between the two scripts
 
    scriptOne: #ReportedScriptInformationDTO
   Information about the first script
 
    scriptTwo: #ReportedScriptInformationDTO
   Information about the second script
}