{
    dynamicFieldFilters: [
      Any filters on dynamic fields
 
       DynamicFieldFilterDTO
   ]
 
    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)
 
    nameMatch: string
    Search for combo groups whose name matches this wildcard-enabled string
 
    realmName: string
    Search for combo groups that belong to this exact realm
}

{
    dynamicFieldFilters: [
      Any filters on dynamic fields
 
       DynamicFieldFilterDTO
   ]
 
    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)
}

{
    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; for componentType Configuration and HardwareInventory, componentName is the created timestamp (in milliseconds); for componentType SecurityVulnerability, componentName is the securityVulnerabilityID; for componentType SnmpManagerStation, componentName is the address
 
    componentType: string*
    The type of the component, used to verify what is retrieved by key/name; valid values are: Combogroup, Condition, Configuration, Device, DeviceAdapter, DeviceAgent, DeviceSecurityProfile DynamicField, EmailDistributionList, Group, HardwareInventory, JobApprovalType, Keyword, Model, OsImage, PredefinedJob, Realm, RemoteFileServer, 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 and HardwareInventory: key=deviceKey, value=database key of the device the item belongs to, key=deviceName, value=name of the device the item belongs to, key=timestamp, value=creation date/time in server display format; for componentType DeviceAdapter: key=adapterType, value=type of the device adapter, key=parent, value=parent or owner used for organizing certain types of adapters, key=vendorName, value=name of the vendor that owns a device type; 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
    }
}

{
    dynamicFieldFilters: [
      Any filters on dynamic fields
 
       DynamicFieldFilterDTO
   ]
 
    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
 
    defaultDeviceAgentNICFlag: boolean
    Whether or not to search for devices whose interface is set to use the default NIC of its selected device agent; when true, the deviceAgentNICName field is ignored
 
    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; to search for devices using the "(Default)" NIC, use the defaultDeviceAgentNICFlag field instead
 
    deviceSecurityProfileName: string
    Search for devices whose device security profile equals this name
 
    deviceTypeId: ComponentId
   Search for devices whose device type equals this device type
 
    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 or secondary 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 exact realm
 
    securityContextTypeId: integer
    Search for devices set to this type of security context
 
    transferModeId: integer
    Search for devices with this file transfer mode
 
    vendorId: ComponentId
   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
 
    includedViolationTrailIds: [
      Include devices in the results that have a compliance violation in one of these trails
 
       ComponentId
   ]
 
    excludedViolationTrailIds: [
      Exclude devices from the results that have a compliance violation in one of these trails
 
       ComponentId
   ]
 
    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
}

{
    dynamicField: ComponentId*
    The dynamic field whose value is being searched for
 
    value: string*
    The filter string (the value to be matched); if this value is null or empty, no filtering is done on the specified 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
}

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

{
    dynamicFieldFilters: [
      Any filters on dynamic fields
 
       DynamicFieldFilterDTO
   ]
 
    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)
 
    nameMatch: string
    Search for groups whose name matches this wildcard-enabled string
 
    realmName: string
    Search for groups that belong to this exact realm
 
    showAutoGroupsFlag: boolean
    Whether or not to include auto-groups in the results
 
    showSimpleGroupsFlag: boolean
    Whether or not to include manually-created groups in the results
 
    showEmptyAutoGroupsFlag: boolean
    Whether or not to include empty auto-groups in the results
}

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

{
    dynamicFieldFilters: [
      Any filters on dynamic fields
 
       DynamicFieldFilterDTO
   ]
 
    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)
 
    actionGuids: [
      Search for jobs that include one of these actions
 
      string
    ]
 
    changeIdMatch: string
    Search for jobs whose change ID matches this wildcard-enabled string
 
    creationTime: TimePeriodDTO
   Search for jobs whose creation date/time falls within this date/time range
 
    editorNameMatch: string
    Search for jobs with a creator or an editor matching this wildcard-enabled string
 
    jobIdMatch: string
    Search for jobs whose job ID matches this wildcard-enabled string
 
    jobApprovalModeId: integer
    Search for jobs with this job approval mode
 
    jobApprovalTypeName: string
    Search for jobs whose job approval type matches this exact name
 
    networkSpanNameMatch: string
    Search for jobs that have actions acting on a network span whose name matches this wildcard-enabled string
 
    originatorMatch: string
    Search for jobs whose originator matches this wildcard-enabled string
 
    originatorTypeId: integer
    Search for jobs with this type of originator
 
    preparedFromPredefinedJobNameMatch: string
    Search for jobs which were prepared from a predefined job whose name matches this wildcard-enabled string
 
    reconciliationStatusId: integer
    Search for jobs with this reconciliation status
 
    showOnlyJobsICanApproveFlag: boolean
    When searching for jobs with status "waiting for approval", whether or not to only include jobs that the user for this session can approve
 
    statusIds: [
      Search for jobs whose current status matches one of these statuses
 
      integer
    ]
 
    taskIdMatch: string
    Search for jobs whose task ID matches this wildcard-enabled string
}

{
    id: string
    The OS image's unique database key (read-only)
 
    name: string
    The OS image's display name; null/empty when this image has not been verified as having run on a device (read-only)
 
    activationKey: string
    License key to activate features in the binary image on the device
 
    annotation: string
    Notes, comments, description, explanation
 
    applicableModelIds: [
      The models where this image can be deployed
 
       ComponentId
   ]
 
    deviceTypeId: ComponentId
   Which device type and vendor this OS image applies to; device type is required when creating a new OS image but it cannot be modified
 
    filenames: string
    The combined filenames of the binary files (read-only)
 
    footprintInBytes: integer
    Bytes of device memory this image consumes; a null indicates this value is not used by the device
 
    forbidDeploymentFlag: boolean
    Whether or not this OS image is allowed to be deployed
 
    members: [
      The members or binary files that make up this OS image; there must be at least one
 
       OsImageMemberDTO
   ]*
 
    primaryImageName: string
    Full name of the primary OS image (read-only)
 
    shortImageName: string
    Short name of the OS image (read-only)
 
    dynamicFields: [
      The dynamic fields
 
       DynamicFieldValueDTO
   ]
}

{
    dynamicFieldFilters: [
      Any filters on dynamic fields
 
       DynamicFieldFilterDTO
   ]
 
    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)
 
    deviceTypeId: ComponentId
   Search for OS images associated with this device type
 
    fileNameMatch: string
    Search for OS images with filenames that match this wildcard-enabled string
 
    modelNameMatch: string
    Search for OS images associated with a model whose name matches this wildcard-enabled string
 
    nameMatch: string
    Search for OS images whose name matches this wildcard-enabled string
 
    vendorId: ComponentId
   Search for OS images whose device type belongs to this vendor
}

{
    copiedFromDeviceFlag: boolean
    Whether or not the binary data was copied or snapshot from the running image of a device
 
    fileContentDigest: string
    The MD5 checksum or digest on the binary contents; required on update when referring to an existing file within an existing OsImageDTO
 
    fileName: string
    The name of the binary file; required on update when referring to an existing file within an existing OsImageDTO
 
    fileSizeInBytes: integer
    The size of the binary file in bytes; required on update when referring to an existing file within an existing OsImageDTO
 
    fullName: string
    The full name of the image, as discovered from the device (read-only)
 
    osImageTypeName: string*
    What type of binary file this is, when a device supports multi-file images, as defined in the device type; 'system' is the default image type for those devices with single-file images
 
    release: string
    The version (read-only)
 
    shortName: string
    The short name (read-only)
}

{
    dynamicFieldFilters: [
      Any filters on dynamic fields
 
       DynamicFieldFilterDTO
   ]
 
    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)
 
    actionGuids: [
      Search for predefined jobs that include one of these actions
 
      string
    ]
 
    nameMatch: string
    Search for predefined jobs whose name matches this wildcard-enabled string
 
    networkSpanNameMatch: string
    Search for predefined jobs that have actions acting on a network span whose name matches this wildcard-enabled string
}

{
    dynamicFieldFilters: [
      Any filters on dynamic fields
 
       DynamicFieldFilterDTO
   ]
 
    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)
 
    activationTimePeriod: TimePeriodDTO
   Search for rules whose activation date/time falls within this date/time range
 
    contentsMatch: string
    Search for rules whose trigger, subject, or domain contains text that matches this wildcard-enabled string
 
    cveIDs: [
      Search for rules whose associated CVE IDs include one of these CVE IDs
 
      string
    ]
 
    deactivationTimePeriod: TimePeriodDTO
   Search for rules whose deactivation date/time falls within this date/time range
 
    deviceTypeId: ComponentId
   Search for rules associated with this device type
 
    excludeRulesWithAllDeviceTypesFlag: boolean
    When searching for rules of a particular device type, whether or not rules associated with all device types are included in what matches or are excluded
 
    includeNonCorrectableRulesFlag: boolean
    Search for rules that cannot be corrected (that is, a rule that has no corrective actions, is in a disabled rule set, is not currently activated, or has a grammar whose violation cannot be automatically corrected); when all include*Flag values are false, then filtering based on correctability is skipped; note using the include*Flags is not allowed in jobs or predefined jobs
 
    includeRulesCorrectableViaDeployToActiveFlag: boolean
    Search for rules that can be corrected by running a Deploy to Active action; when all include*Flag values are false, then filtering based on correctability is skipped; note using the include*Flags is not allowed in jobs or predefined jobs
 
    includeRulesCorrectableViaDeployToStoredFlag: boolean
    Search for rules that can be corrected by running a Deploy to Stored action; when all include*Flag values are false, then filtering based on correctability is skipped; note using the include*Flags is not allowed in jobs or predefined jobs
 
    includeRulesCorrectableViaRemediateFlag: boolean
    Search for rules that can be corrected by running a Remediate action; when all include*Flag values are false, then filtering based on correctability is skipped; note using the include*Flags is not allowed in jobs or predefined jobs
 
    isNullSecurityVulnerabilityFlag: boolean
    Whether or not to search for rules that have no associated security vulnerability; when true, search only for such rules; when false or null, do not filter on associated security vulnerability; this flag cannot be used and must be null when this filter is used in a job, predefined job, policy, or view
 
    ruleNameMatch: string
    Search for rules whose name matches this wildcard-enabled string
 
    ruleSetNameMatch: string
    Search for rules whose parent rule set name matches this wildcard-enabled string
 
    severityIds: [
      Search for rules whose severity matches one of these severities
 
      integer
    ]
 
    vendorId: ComponentId
   Search for rules whose device type belongs to this vendor
}

{
    dynamicFieldFilters: [
      Any filters on dynamic fields
 
       DynamicFieldFilterDTO
   ]
 
    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)
 
    nameMatch: string
    Search for rule sets whose name matches this wildcard-enabled string
 
    enabledFlag: boolean
    Search for rule sets that are enabled (true) or disabled (false); null means do not filter on the enabled/disabled state
}

{
    dynamicFieldFilters: [
      Any filters on dynamic fields
 
       DynamicFieldFilterDTO
   ]
 
    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)
 
    containerBlueprintName: string
    Search for templates referenced by this exact container blueprint
 
    contentsMatch: string
    Search for templates whose content matches this wildcard-enabled string
 
    deviceTypeId: ComponentId
   Search for templates associated with this device type
 
    nameMatch: string
    Search for templates whose name matches this wildcard-enabled string
 
    vendorId: ComponentId
   Search for templates whose device type belongs to this vendor
}

{
    timePeriodTypeId: integer*
    What sort of time period this is
 
    timePeriodTypeName: string
    The meaning of the numeric timePeriodTypeId (read-only)
 
    startTimestamp: date-time
    The start date/time. Required only for certain user-defined time period types of After and Range; when the timestamp is missing the timezone, the server local timezone is assumed
     Example: 2017-01-31T13:45:00.000+0000
 
    endTimestamp: date-time
    The end date/time. Required only for certain user-defined time period types of Before and Range; when the timestamp is missing the timezone, the server local timezone is assumed
     Example: 2017-01-31T13:45:00.000+0000
}