{
    id: string
    The device's unique database key
 
    name: string
    The device's unique display name
 
    deviceDetailsLink: string
    Link to get complete details about this device
 
    realmId: string
    The database key of the realm this device belongs to
 
    realmName: string
    The name of the realm this device belongs to
 
    modelName: string
    The discovered model
 
    osImageName: string
    The discovered operating system version
 
    deviceTypeGuid: string
    The GUID of the device type
 
    deviceTypeName: string
    The name of the device type
 
    vendorGuid: string
    The GUID of the vendor
 
    vendorName: string
    The name of the vendor
 
    categoryId: integer
    The category
 
    categoryName: string
    The meaning of the numeric categoryId
 
    onlineFlag: boolean
    Whether or not this device is online
 
    discrepanciesFlag: boolean
    Whether or not this device has discrepancies
 
    violationsFlag: boolean
    Whether or not this device has compliance violations
 
    primaryInterfaceAddress: string
    The primary interface IP address, host name, or URL
 
    primaryInterfaceDeviceAgentId: string
    The database key of the primary interface device agent
 
    primaryInterfaceDeviceAgentName: string
    The name of the primary interface device agent
 
    primaryInterfaceDeviceAgentNIC: string
    The name of the primary interface device agent NIC
 
    primaryInterfaceAccessModeId: integer
    The primary interface access mode
 
    primaryInterfaceAccessModeName: string
    The meaning of the numeric primaryInterfaceAccessModeId
 
    primaryInterfaceTransferModeId: integer
    The primary interface transfer mode
 
    primaryInterfaceTransferModeName: string
    The meaning of the numeric primaryInterfaceTransferModeId
 
    primaryInterfaceDeviceSecurityProfileId: string
    The database key of the primary interface device security profile
 
    primaryInterfaceDeviceSecurityProfileName: string
    The name of the primary interface device security profile
 
    dynamicFields: [
      The dynamic fields
 
       #DynamicFieldValueDTO
    ]
}

{
    actionGuid: string
    The GUID of the device action that was executed
 
    actionName: string
    The action name
 
    statusId: integer
    The completion status of the device action
 
    date: date-time
    The last time this action was attempted
     Example: 2017-01-31T13:45:00.000+0000
 
    accessModeId: integer
    The access mode that was used to connect to the device
 
    transferModeId: integer
    The transfer mode that was used to exchange files with the device
 
    deviceAgentName: string
    The device agent that was used to communicate with the device
 
    deviceAgentNIC: string
    The device agent NIC that was used to communicate with the device
 
    deviceInterfaceName: string
    Which set of interface settings was used (primary or auxiliary)
 
    port: string
    The TCP port that was used to connect to the device
 
    deviceSecurityProfileName: string
    The credentials that were used to login to the device
 
    message: string
    Reason for a device action execution failure
 
    transcriptLink: string
    Link to get the recorded device interaction transcript, when there is such a transcript (may not have one on certain error conditions)
}

{
    passedRules: [
      The rules that are currently compliant
 
       #PassedRuleDTO
    ]
 
    violatedRules: [
      The rules that are currently in violation
 
       #FailedRuleDTO
    ]
}

{
    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: string
    The configuration's unique database key
 
    created: date-time
    Date/time this configuration was obtained from the device
     Example: 2017-01-31T13:45:00.000+0000
 
    trailGuid: string
    The GUID of the configuration trail
 
    osImageName: string
    The discovered operating system version
 
    annotation: string
    The user-defined notes or description about this configuration
 
    changeID: string
    The change ID from the job that generated this configuration, for mapping into any external change management system
 
    jobID: string
    The job ID of the job that generated this configuration
 
    externalFlag: boolean
    Whether this configuration resulted from an external change made to the device (true) or from an internal change made to the device (false); an internal change occurs when the system is used to make the change; an external change occurs when the device is changed by other means outside the system and detected via syslog
 
    historicalFlag: boolean
    Whether this is a historical configuration (true) or a current configuration (false)
 
    trustedFlag: boolean
    Whether or not this configuration is trusted
 
    trustedTimestamp: date-time
    Date/time this configuration was marked as trusted
     Example: 2017-01-31T13:45:00.000+0000
 
    filename: string
    The name of the file that any binary data was copied from
 
    dataLength: integer
    The length of the ASCII data in bytes; a zero indicates there is no ASCII data
 
    binaryDataLength: integer
    The length of the binary data in bytes; a zero indicates there is no binary data
 
    dataLink: string
    Link to retrieve the ASCII data
 
    binaryDataLink: string
    Link to retrieve the binary data
}

{
    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: #TimePeriodDTO
   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)
 
    groupName: string
    Search for devices that belong to this group in the realm specified by realmName
 
    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
 
    realmName: string
    Search for devices that belong to this realm
 
    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: #TimePeriodDTO
   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
}

{
    address: string*
    The IP address, host name, or URL of the device
 
    port: string
    The TCP port used to connect to the device
 
    natAddress: string
    The device agent's address as it is known to the device, either an IP address or a host name
 
    accessModeId: integer*
    The protocol used to connect to the device
 
    transferModeId: integer*
    The protocol used to exchange files with the device
 
    deviceAgentId: string*
    The database key of the device agent that manages this device
 
    deviceAgentNIC: string*
    The name of the device agent NIC that manages this device
 
    deviceAgentDetailsLink: string
    Link to get complete details about the device agent (read-only)
 
    deviceSecurityProfileId: string
    The login credentials for accessing the device
 
    deviceSecurityProfileDetailsLink: string
    Link to get complete details about the device security profile (read-only)
 
    autoDiscoverDspFlag: boolean
    Whether or not the device security profile is to be discovered automatically at the next login attempt
}

{
    id: string
    The unique database key of this device status
 
    runningViolationTimestamp: date-time
    Date/time the earliest running compliancy violation occurred
     Example: 2017-01-31T13:45:00.000+0000
 
    startupViolationTimestamp: date-time
    Date/time the earliest startup compliancy violation occurred
     Example: 2017-01-31T13:45:00.000+0000
 
    otherTrailsViolationTimestamp: date-time
    Date/time the earliest other compliancy violation occurred
     Example: 2017-01-31T13:45:00.000+0000
 
    rvtDiscrepancyTimestamp: date-time
    Date/time the Running vs Trusted discrepancy occurred
     Example: 2017-01-31T13:45:00.000+0000
 
    svtDiscrepancyTimestamp: date-time
    Date/time the Startup vs Trusted discrepancy occurred
     Example: 2017-01-31T13:45:00.000+0000
 
    rvsDiscrepancyTimestamp: date-time
    Date/time the Running vs Startup discrepancy occurred
     Example: 2017-01-31T13:45:00.000+0000
 
    osImageDiscrepancyTimestamp: date-time
    Date/time the OS image discrepancy occurred
     Example: 2017-01-31T13:45:00.000+0000
 
    currentHardwareInventory: #HardwareInventoryDTO
   The current discovered or imported hardware inventory information
 
    osImageLoadHistory: [
      Which OS images have been discovered or deployed on the device
 
       #OsImageLoadHistoryDTO
    ]
 
    actionStatus: [
      Latest device action execution status
 
       #ActionStatusDTO
    ]
 
    complianceStatus: {
      Latest compliance status (rules passed and failed during the latest scan); the map key is the configuration trail GUID of the configuration that was examined; the map value is the ComplianceStatusDTO for that trail
    }
}

{
    id: string
    The database key of the dynamic field whose value this is (read-only)
 
    name: string
    The name of the dynamic field (read-only)
 
    values: [
      The value(s) for the dynamic field; for a single-value field, only the first entry is relevant; read-only for Auto Derived and Configuration Profiled types
 
      string
    ]
 
    dynamicFieldDetailsLink: string
    Link to get more detailed information about the dynamic field (read-only)
}

{
    name: string
    The name of the component
 
    descr: string
    {{ The description of the component}}
 
    pid: string
    The product id or part number
 
    vid: string
    The version id
 
    sid: string
    The serial number
}

{
    date: date-time
    Date/time when the rule was checked and found to be in violation
     Example: 2017-01-31T13:45:00.000+0000
 
    ruleId: string
    The rule's unique database key
 
    ruleDetailsLink: string
    Link to get complete details about the rule
 
    correctableFlag: boolean
    Whether or not the rule can be corrected
}

{
    created: date-time
    Time this inventory was created or last updated
     Example: 2017-01-31T13:45:00.000+0000
 
    importedInventory: string
    Inventory imported from an external element manager
 
    entities: [
      Hardware components reported in 'show inventory' command
 
       #EntityDTO
    ]
 
    fileSystems: [
      Data reported in 'dir all-filesystems' command
 
       #StorageDTO
    ]
 
    memories: [
      Data reported in 'show memory statistics' command
 
       #StorageDTO
    ]
}

{
    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
}

[
    A list of JSON Patch operations
 
     #JsonPatch.OneOperation
  ]

{
}

string
  Pointer or path to an element or property

{
    op: string*
    Enum: [
      "add"
    ]
    value: any*
    path: #JsonPatch.Pointer *
}

{
    op: string*
    Enum: [
      "remove"
    ]
    path: #JsonPatch.Pointer *
}

{
    op: string*
    Enum: [
      "replace"
    ]
    value: any*
    path: #JsonPatch.Pointer *
}

{
    op: string*
    Enum: [
      "move"
    ]
    path: #JsonPatch.Pointer *
    from: #JsonPatch.Pointer *
}

{
    op: string*
    Enum: [
      "copy"
    ]
    path: #JsonPatch.Pointer *
    from: #JsonPatch.Pointer *
}

{
    op: string*
    Enum: [
      "test"
    ]
    value: any*
    path: #JsonPatch.Pointer *
}

{
    date: date-time
    Date/time this OS image was discovered or deployed
     Example: 2017-01-31T13:45:00.000+0000
 
    filename: string
    The image file name
 
    imageName: string
    The image name
 
    username: string
    The user who deployed this image
}

{
    date: date-time
    Date/time when the rule was checked and found to be compliant
     Example: 2017-01-31T13:45:00.000+0000
 
    ruleId: string
    The rule's unique database key
 
    ruleDetailsLink: string
    Link to get complete details about the rule
}

{
    name: string
    The identifying name
 
    bytesFree: integer
    The number of bytes that are unused
 
    bytesTotal: integer
    The total size of the storage in bytes
 
    bytesUsed: integer
    The number of bytes that are filled up
}