{
    id: string
    The policy's unique database key
 
    name: string
    The policy's unique display name
 
    canCopyFlag: boolean
    Whether or not the user is allowed to copy this policy
 
    canDeleteFlag: boolean
    Whether or not the user is allowed to delete this policy
 
    canEditFlag: boolean
    Whether or not the user is allowed to edit this policy
 
    enabledFlag: boolean
    Whether or not the policy is enabled for execution
 
    lastExecutionTimestamp: date-time
    When this policy was last executed
     Example: 2017-01-31T13:45:00.000+0000
 
    type: string
    The type of policy; event-based or time-based
 
    whenDormantTimestamp: date-time
    When the policy went dormant and will not execute again
     Example: 2017-01-31T13:45:00.000+0000
 
    dynamicFields: [
      The dynamic fields
 
       DynamicFieldValueDTO
   ]
}

{
    actionNumber: integer
    The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
    guid: string
    The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
    name: string
    The type of action referred to by the GUID (read-only)
 
    annotation: string
    Notes, comments, description, explanation
 
    summary: string
    Brief summary of what this action does (read-only)
 
    statusId: integer
    The current execution status of this action (read-only)
 
    startTimestamp: date-time
    When the action execution began (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    endTimestamp: date-time
    When the action execution completed (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    errorMessage: string
    Reason that a completed action failed (read-only)
 
    hasActionLevelResultsFlag: boolean
    Whether or not this action has executed and has action-level results available for review (read-only)
 
    subactions: [
      Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       ActionDTO
   ]
 
    transcriptSections: {
      When this action accesses devices, which sections can appear in device interaction transcripts; the map key is the string name of the transcript section; the map value is the string GUID of the transcript section; when null, indicates that this type of action does not access devices (does not log in to devices nor make changes to their configurations)
    }
}

{
    contents: string*
    The text contents
 
    injectionFlag: boolean
    Whether or not the contents contain device type interaction XML code
 
    substitutionParameterCheckFlag: boolean
    Whether or not the contents should be validated for correct substitution parameter syntax
}

{
    actionNumber: integer
    The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
    guid: string
    The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
    name: string
    The type of action referred to by the GUID (read-only)
 
    annotation: string
    Notes, comments, description, explanation
 
    summary: string
    Brief summary of what this action does (read-only)
 
    statusId: integer
    The current execution status of this action (read-only)
 
    startTimestamp: date-time
    When the action execution began (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    endTimestamp: date-time
    When the action execution completed (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    errorMessage: string
    Reason that a completed action failed (read-only)
 
    hasActionLevelResultsFlag: boolean
    Whether or not this action has executed and has action-level results available for review (read-only)
 
    subactions: [
      Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       ActionDTO
   ]
 
    transcriptSections: {
      When this action accesses devices, which sections can appear in device interaction transcripts; the map key is the string name of the transcript section; the map value is the string GUID of the transcript section; when null, indicates that this type of action does not access devices (does not log in to devices nor make changes to their configurations)
    }
 
    useAuxiliaryInterfaceFlag: boolean
    Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
    spanParams: SpanParamsDTO*
    The selected network span
 
    replaceCurrentFlag: boolean
    When true, replaces any existing target configuration with the selected one; when false, only assigns new target configuration to devices that currently have none
 
    scriptParams: SpanParamsDTO*
    Which script or configuration is to be copied into the target configuration, or selects to clear the target configuration
}

{
    includeEventsFlag: boolean
    Whether or not events are shown in the report
 
    spanParams: SpanParamsDTO*
    The network span to report on
 
    timePeriod: TimePeriodDTO*
    Which configuration changes are to be included in the report; that is, include the changes that occurred within this time period
 
    whichTrailId: ComponentId*
    Which configuration trail is to be reported on
}

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

{
    actionNumber: integer
    The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
    guid: string
    The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
    name: string
    The type of action referred to by the GUID (read-only)
 
    annotation: string
    Notes, comments, description, explanation
 
    summary: string
    Brief summary of what this action does (read-only)
 
    statusId: integer
    The current execution status of this action (read-only)
 
    startTimestamp: date-time
    When the action execution began (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    endTimestamp: date-time
    When the action execution completed (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    errorMessage: string
    Reason that a completed action failed (read-only)
 
    hasActionLevelResultsFlag: boolean
    Whether or not this action has executed and has action-level results available for review (read-only)
 
    subactions: [
      Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       ActionDTO
   ]
 
    transcriptSections: {
      When this action accesses devices, which sections can appear in device interaction transcripts; the map key is the string name of the transcript section; the map value is the string GUID of the transcript section; when null, indicates that this type of action does not access devices (does not log in to devices nor make changes to their configurations)
    }
 
    useAuxiliaryInterfaceFlag: boolean
    Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
    spanParams: SpanParamsDTO*
    The selected network span
 
    commitAllContextsFlag: boolean
    When the device supports multiple security contexts, which contexts should be committed; false means just the context logged in to; true means all contexts
 
    markAsTrustedFlag: boolean
    Whether or not any changed configurations resulting from running this action should be marked as trusted
}

{
    actionNumber: integer
    The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
    guid: string
    The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
    name: string
    The type of action referred to by the GUID (read-only)
 
    annotation: string
    Notes, comments, description, explanation
 
    summary: string
    Brief summary of what this action does (read-only)
 
    statusId: integer
    The current execution status of this action (read-only)
 
    startTimestamp: date-time
    When the action execution began (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    endTimestamp: date-time
    When the action execution completed (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    errorMessage: string
    Reason that a completed action failed (read-only)
 
    hasActionLevelResultsFlag: boolean
    Whether or not this action has executed and has action-level results available for review (read-only)
 
    subactions: [
      Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       ActionDTO
   ]
 
    transcriptSections: {
      When this action accesses devices, which sections can appear in device interaction transcripts; the map key is the string name of the transcript section; the map value is the string GUID of the transcript section; when null, indicates that this type of action does not access devices (does not log in to devices nor make changes to their configurations)
    }
 
    useAuxiliaryInterfaceFlag: boolean
    Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
    spanParams: SpanParamsDTO*
    The selected network span
 
    ruleSets: [
      The rule sets to be reported on; when null/empty, then this action reports on all rule sets
 
       ComponentId
   ]
}

{
    categories: [
      Selects rules in these categories; null/empty means no filtering of rules by category is done
 
      string
    ]
 
    forceReevaluationFlag: boolean
    When enabling to report only on devices assigned to the selected rules/rule sets, whether to use stored compliance status (false) or r-evaluate or re-compute the status (true) in case the stored results may be stale (such as after adding new rules or changing rules such that no status is currently stored)
 
    onlyShowDevicesAssignedToSelectedFlag: boolean
    Whether or not to report only on devices assigned to the selected rules or rule sets; when true, this pulls results from stored compliance status, which is far more efficient than re-evaluating each rule's status
 
    ruleIds: [
      Identifies which rules are to be reported on; can specify rules or rule sets, but not both; when both are null/empty, reports on all rule sets
 
       ComponentId
   ]
 
    ruleSetIds: [
      Identifies which rule sets are to be reported on; can specify rules or rule sets, but not both; when both are null/empty, reports on all rule sets
 
       ComponentId
   ]
 
    scriptTypeId: integer*
    Which script or configuration is to be reported on; limited to current/trusted running and startup, and other current
 
    showAddressColumnFlag: boolean
    Whether or not the report includes a column showing the device's primary interface host name/IP address/URL
 
    showBaseScoreColumnFlag: boolean
    Whether or not the report includes a column showing the rule's associated security vulnerability base score
 
    showFailedStatusFlag: boolean
    Whether or not the report includes rows where the result is 'Failed'
 
    showSuccessfulStatusFlag: boolean
    Whether or not the report includes rows where the result is 'Passed'
 
    showNonApplicableStatusFlag: boolean
    Whether or not the report includes rows where the result is 'N/A'
 
    spanParams: SpanParamsDTO*
    The network span to report on
 
    whichTrailId: ComponentId
   When the script or configuration type is other current, specifies which other trail is to be reported on
}

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

{
    notFlag: boolean
    Whether or not the opposite of the operand is to be computed
 
    conditionId: ComponentId
   Identifies the single condition that makes up this term; must specify either 'conditionId' or 'conditions' as an operand in a boolean expression
 
    conditions: ConditionsBooleanExpressionDTO
   Complex combination of conditions that make up this term
}

{
    leftParenFlag: boolean
    Whether or not this expression begins with a left parenthesis
 
    rightParenFlag: boolean
    Whether or not this expression ends with a right parenthesis
 
    booleanExpressionOperatorId: integer*
    How the left and right terms are joined together; when there is only a single term, this should be no operator; when there are two terms, this should be either the AND or the OR operator
 
    left: ConditionTermDTO
   The term or operand to the left of the operator
 
    right: ConditionTermDTO
   The term or operand to the right of the operator
}

{
    compareScriptTypeId: integer*
    Which script or configuration is to be compared, appearing on the left side of the report; limited to current running and current startup
 
    compareToScriptTypeId: integer*
    Which script or configuration is to be compared, appearing on the right side of the report; limited to current/trusted running and startup, target, and template
 
    runtimeProperties: {
      When the script being compared to is a template and the template contains runtime substitution parameters, provides the values for those parameters; this is a map where the key is the property name string and the value is the property value string
    }
 
    spanParams: SpanParamsDTO*
    The network span to report on
 
    templateId: ComponentId
   When the script being compared to is a template, identifies the selected template
}

{
    actionNumber: integer
    The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
    guid: string
    The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
    name: string
    The type of action referred to by the GUID (read-only)
 
    annotation: string
    Notes, comments, description, explanation
 
    summary: string
    Brief summary of what this action does (read-only)
 
    statusId: integer
    The current execution status of this action (read-only)
 
    startTimestamp: date-time
    When the action execution began (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    endTimestamp: date-time
    When the action execution completed (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    errorMessage: string
    Reason that a completed action failed (read-only)
 
    hasActionLevelResultsFlag: boolean
    Whether or not this action has executed and has action-level results available for review (read-only)
 
    subactions: [
      Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       ActionDTO
   ]
 
    transcriptSections: {
      When this action accesses devices, which sections can appear in device interaction transcripts; the map key is the string name of the transcript section; the map value is the string GUID of the transcript section; when null, indicates that this type of action does not access devices (does not log in to devices nor make changes to their configurations)
    }
 
    useAuxiliaryInterfaceFlag: boolean
    Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
    spanParams: SpanParamsDTO*
    The selected network span
 
    commitFlag: boolean
    Whether or not to commit changes after running the commands in the custom action
 
    markAsTrustedFlag: boolean
    Whether or not any changed configurations resulting from running this action should be marked as trusted
 
    rebootFlag: boolean
    Whether or not the device should be rebooted after running the commands in the custom action
 
    runtimeProperties: {
      Name/value pairs for any runtime parameters, for substitution into device commands; this is a map where the key is the property name string and the value is the property value string; the use of a shared runtime parameter (in a predefined job) is indicated by a value in the form "sharedRuntimeParam." followed by the name of the shared runtime parameter
    }
 
    runtimePropertiesMasked: {
      Name/value pairs for any runtime parameters, with passwords masked for display; this is a map where the key is the property name string and the value is the property value string (masked if it is a password; read-only)
    }
}

{
    actionNumber: integer
    The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
    guid: string
    The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
    name: string
    The type of action referred to by the GUID (read-only)
 
    annotation: string
    Notes, comments, description, explanation
 
    summary: string
    Brief summary of what this action does (read-only)
 
    statusId: integer
    The current execution status of this action (read-only)
 
    startTimestamp: date-time
    When the action execution began (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    endTimestamp: date-time
    When the action execution completed (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    errorMessage: string
    Reason that a completed action failed (read-only)
 
    hasActionLevelResultsFlag: boolean
    Whether or not this action has executed and has action-level results available for review (read-only)
 
    subactions: [
      Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       ActionDTO
   ]
 
    transcriptSections: {
      When this action accesses devices, which sections can appear in device interaction transcripts; the map key is the string name of the transcript section; the map value is the string GUID of the transcript section; when null, indicates that this type of action does not access devices (does not log in to devices nor make changes to their configurations)
    }
 
    useAuxiliaryInterfaceFlag: boolean
    Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
    spanParams: SpanParamsDTO*
    The selected network span
 
    activationKey: string
    License key to activate features in the binary image on the device
 
    deleteCurrentImageId: integer*
    How to handle the current image file, when the device supports file management of its binary files
 
    files: [
      When image source is from local file or from remote file server, which file (or files, for device with multi-file images) is to be deployed
 
       OsFileDTO
   ]
 
    footprintKbytes: integer
    The memory footprint, in kilobytes, for the image, to verify the new image can run in the device (for those devices that support memory size discovery)
 
    imageActiveOnTimestamp: date-time
    When image source is image active on date, specifies the date/time; when the timestamp is missing the timezone, the server local timezone is assumed
     Example: 2017-01-31T13:45:00.000+0000
 
    imageFromLibraryId: ComponentId
   When image source is image from library, identifies the OS image to be deployed from the library
 
    imageSourceId: integer*
    Which OS image is to be deployed
 
    markAsTrustedFlag: boolean
    Whether or not any changed configurations resulting from running this action should be marked as trusted
 
    parallelExecutionFlag: boolean
    When true, runs this action on multiple devices concurrently; when false, runs this action on multiple devices one by one sequentially (to reduce memory overhead due to large or identical images)
 
    rebootTypeId: integer*
    Whether or not to reboot after the image is deployed, and how to handle unsaved changes prior to rebooting
 
    restoreAssociatedStartupFlag: boolean
    Whether or not to restore the startup configuration active when an image from the library was active, or active at the selected date/time
 
    targetImageFilesystem: string*
    Where the binary file is to be placed on the device's file systems
 
    transferModeId: integer
    When image source is from remote file server, which file transfer mode is to be used to copy files from the remote server to the device
 
    unresolvableOsImage: string
    Indicates that the selected OS image no longer exists in the library and thus re-using this action is not possible (read-only)
}

{
    actionNumber: integer
    The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
    guid: string
    The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
    name: string
    The type of action referred to by the GUID (read-only)
 
    annotation: string
    Notes, comments, description, explanation
 
    summary: string
    Brief summary of what this action does (read-only)
 
    statusId: integer
    The current execution status of this action (read-only)
 
    startTimestamp: date-time
    When the action execution began (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    endTimestamp: date-time
    When the action execution completed (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    errorMessage: string
    Reason that a completed action failed (read-only)
 
    hasActionLevelResultsFlag: boolean
    Whether or not this action has executed and has action-level results available for review (read-only)
 
    subactions: [
      Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       ActionDTO
   ]
 
    transcriptSections: {
      When this action accesses devices, which sections can appear in device interaction transcripts; the map key is the string name of the transcript section; the map value is the string GUID of the transcript section; when null, indicates that this type of action does not access devices (does not log in to devices nor make changes to their configurations)
    }
 
    useAuxiliaryInterfaceFlag: boolean
    Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
    spanParams: SpanParamsDTO*
    The selected network span
 
    commitFlag: boolean
    Whether or not to commit changes after deploying the script or configuration
 
    forceTunneledTransferFlag: boolean
    Whether or not to deploy the script in tunneled mode, overriding the transfer mode set in the device
 
    markAsTrustedFlag: boolean
    Whether or not any changed configurations resulting from running this action should be marked as trusted
 
    overrideCorrectiveActionOptionsFlag: boolean
    When remediating, whether or not to use various options as defined in the rule corrective actions, or to use options as defined here as an override; when false, the commitFlag, forceTunneledTransferFlag, markAsTrustedFlag, smartMergeModeId,stopOnSyntaxErrorFlag, and syntaxScanFlag included here are ignored
 
    scriptParams: ScriptParamsDTO*
    Which script or configuration is to be deployed to the device
 
    smartMergeModeId: integer
    Selects to build an incremental merge script or a full merge script
 
    stopOnSyntaxErrorFlag: boolean
    When deploying in tunneled mode, whether or not to stop pushing commands from the script once a syntax error is detected
 
    syntaxScanFlag: boolean
    Whether or not to validate the command line syntax in the script prior to deploying it
}

{
    actionNumber: integer
    The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
    guid: string
    The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
    name: string
    The type of action referred to by the GUID (read-only)
 
    annotation: string
    Notes, comments, description, explanation
 
    summary: string
    Brief summary of what this action does (read-only)
 
    statusId: integer
    The current execution status of this action (read-only)
 
    startTimestamp: date-time
    When the action execution began (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    endTimestamp: date-time
    When the action execution completed (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    errorMessage: string
    Reason that a completed action failed (read-only)
 
    hasActionLevelResultsFlag: boolean
    Whether or not this action has executed and has action-level results available for review (read-only)
 
    subactions: [
      Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       ActionDTO
   ]
 
    transcriptSections: {
      When this action accesses devices, which sections can appear in device interaction transcripts; the map key is the string name of the transcript section; the map value is the string GUID of the transcript section; when null, indicates that this type of action does not access devices (does not log in to devices nor make changes to their configurations)
    }
 
    useAuxiliaryInterfaceFlag: boolean
    Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
    spanParams: SpanParamsDTO*
    The selected network span
 
    markAsTrustedFlag: boolean
    Whether or not any changed configurations resulting from running this action should be marked as trusted
 
    overrideCorrectiveActionOptionsFlag: boolean
    When remediating, whether or not to use various options as defined in the rule corrective actions, or to use options as defined here as an override; when false, the markAsTrustedFlag and rebootFlag included here are ignored
 
    rebootFlag: boolean
    Whether or not the device should be rebooted after deploying the script or configuration
 
    scriptParams: ScriptParamsDTO*
    Which script or configuration is to be deployed to the device
}

{
    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:
   Options for filtering on hardware inventory information obtained from Cisco IOS or IOS-like devices
}

{
    attributeIds: [
      Which selected attributes or device fields are to be displayed in the report; used only when showAllAttributesFlag is false
 
      integer
    ]
 
    attributesDisplayString: string
    Displayable version of the selected attributes and related fields (span actions, dynamic fields, and trails; read-only
 
    dynamicFieldIds: [
      Which dynamic fields are to be displayed in the report
 
       ComponentId
   ]
 
    forceLinearFormatFlag: boolean
    How the report is to be formatted; true means in linear format, false means in tabular format; tabular format selection is ignored when multiple complex attributes are selected
 
    historyTrailIds: [
      Trails selected for display of their configuration history
 
       ComponentId
   ]
 
    showAllAttributesFlag: boolean
    Whether or not all attributes are to be shown in the report; false indicates display of selected device information as listed in attributeIds
 
    spanActionGuids: [
      Which span action status is to be displayed in the report
 
      string
    ]
 
    spanParams: SpanParamsDTO*
    The network span to report on
 
    timePeriod: TimePeriodDTO
   When historyTrailGuids are selected, specifies which configurations are to be included in the report (those falling within this time period)
 
    violationTrailIds: [
      Trails selected for display of their violation status
 
       ComponentId
   ]
}

{
    spanParams: SpanParamsDTO*
    The network span to report on
}

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

{
    actionNumber: integer
    The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
    guid: string
    The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
    name: string
    The type of action referred to by the GUID (read-only)
 
    annotation: string
    Notes, comments, description, explanation
 
    summary: string
    Brief summary of what this action does (read-only)
 
    statusId: integer
    The current execution status of this action (read-only)
 
    startTimestamp: date-time
    When the action execution began (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    endTimestamp: date-time
    When the action execution completed (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    errorMessage: string
    Reason that a completed action failed (read-only)
 
    hasActionLevelResultsFlag: boolean
    Whether or not this action has executed and has action-level results available for review (read-only)
 
    subactions: [
      Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       ActionDTO
   ]
 
    transcriptSections: {
      When this action accesses devices, which sections can appear in device interaction transcripts; the map key is the string name of the transcript section; the map value is the string GUID of the transcript section; when null, indicates that this type of action does not access devices (does not log in to devices nor make changes to their configurations)
    }
 
    attachedReportParameters: EmailedReportParametersDTO
   When attaching a report, parameters specific to the type of report
 
    attachmentFormatId: integer
    The format of an attached report (CSV, HTML, PDF, or RTF)
 
    attachmentIncludedFlag: boolean
    Whether or not a report is attached to the email
 
    containsUnresolvableRecipientsFlag: boolean
    Indicates that one or more email distribution lists and/or users no longer exist; re-using this action will result in fewer email recipients (read-only)
 
    detailsIncludedFlag: boolean
    Whether or not an attached report includes additional sub-reports for all its details
 
    hideCsvHeaderFooterFlag: boolean
    Whether or not an attached CSV-formatted report includes headers and footers that are not strictly part of the column-oriented report data
 
    linkIncludedFlag: boolean
    Whether or not the email includes a link to a report
 
    sensitiveDataHiddenFlag: boolean
    Whether or not sensitive data is hidden in any attached report
 
    subject: string*
    The subject of the email message
 
    text: string*
    The text that appears in the body of the email message
 
    toAdhocAddresses: [
      Any ad-hoc email addresses of the other interested recipients of the email
 
      string
    ]
 
    toEmailListIds: [
      Any email distribution lists to receive the email
 
       ComponentId
   ]
 
    toUserIds: [
      Any users to receive the email
 
       ComponentId
   ]
}

{
    jobStateIds: [
      The job states of interest; the trap is sent when the job enters any of these states
 
      integer
    ]*
 
    emailApproverFlag: boolean
    Whether or not the job state change email should be sent to the user(s) who can approve the job
 
    emailCreatorFlag: boolean
    Whether or not the job state change email should be sent to the user who created the job
 
    emailOtherFlag: boolean
    Whether or not the job state change email should be sent to users other than the creator or approvers
 
    jobDetailsAttachmentIncludedFlag: boolean
    Whether or not the email includes an attached job details
 
    jobDetailsLinkIncludedFlag: boolean
    Whether or not the email includes a link to access the job details web page
 
    jobDetailsAllDetailsIncludedFlag: boolean
    Whether or not an attached job details includes all details (that is, device interaction transcripts)
 
    emailedJobDetailsAttachmentFormatId: integer
    The format of an attached job details (HTML, PDF, or RTF)
 
    jobSummaryAttachmentIncludedFlag: boolean
    Whether or not the email includes an attached job summary report
 
    jobSummaryLinkIncludedFlag: boolean
    Whether or not the email includes a link to access the job summary report web page
 
    emailedJobSummaryAttachmentFormatId: integer
    The format of an attached job summary report (HTML, PDF, or RTF)
 
    showJobSummaryById: integer
    When including the link to a job summary report, how the generated report is to be oriented (by job ID, by change ID, or by task ID)
 
    toAdhocAddresses: [
      When emailing to others, any ad-hoc email addresses of the other interested recipients of the email
 
      string
    ]
 
    toEmailListIds: [
      When emailing to others, any email distribution lists to receive the email
 
       ComponentId
   ]
 
    toEmailListsDetailsLinks: [
      When emailing to others, links to get more detailed information about the email distribution lists (read-only)
 
      string
    ]
 
    toUserIds: [
      When emailing to others, any users to receive the email
 
       ComponentId
   ]
 
    toUsersDetailsLinks: [
      When emailing to others, links to get more detailed information about the users (read-only)
 
      string
    ]
}

{
}

{
    actionNumber: integer
    The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
    guid: string
    The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
    name: string
    The type of action referred to by the GUID (read-only)
 
    annotation: string
    Notes, comments, description, explanation
 
    summary: string
    Brief summary of what this action does (read-only)
 
    statusId: integer
    The current execution status of this action (read-only)
 
    startTimestamp: date-time
    When the action execution began (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    endTimestamp: date-time
    When the action execution completed (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    errorMessage: string
    Reason that a completed action failed (read-only)
 
    hasActionLevelResultsFlag: boolean
    Whether or not this action has executed and has action-level results available for review (read-only)
 
    subactions: [
      Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       ActionDTO
   ]
 
    transcriptSections: {
      When this action accesses devices, which sections can appear in device interaction transcripts; the map key is the string name of the transcript section; the map value is the string GUID of the transcript section; when null, indicates that this type of action does not access devices (does not log in to devices nor make changes to their configurations)
    }
}

{
    id: string
    The policy's unique database key (read-only)
 
    name: string*
    The policy's unique display name
 
    actions: [
      The actions to be executed, ordered in execution order
 
       ActionDTO
   ]*
 
    autoPurgeFlag: boolean
    Whether or not the policy is deleted automatically after it has gone dormant
 
    canCopyFlag: boolean
    Whether or not the user is allowed to copy this policy (read-only)
 
    canDeleteFlag: boolean
    Whether or not the user is allowed to delete this policy (read-only)
 
    canEditFlag: boolean
    Whether or not the user is allowed to edit this policy (read-only)
 
    conditions: ConditionsBooleanExpressionDTO
   What conditions must be met in order for the policy to execute; made up of non-triggering conditions that look into past events and changes; required for a time-based policy
 
    conditionsExpression: string
    A readable representation of the conditions field (read-only)
 
    emailParams: EmailNotificationParametersDTO
   Any parameters for sending an email as a notification that a job created by this policy has changed its state
 
    enabledFlag: boolean
    Whether or not the policy is enabled for execution
 
    executionEndTimestamp: date-time
    When the policy stops running; when non-null, the policy does not execute past this date/time; when null, the policy never stops executing; when the timestamp is missing the timezone, the server local timezone is assumed
     Example: 2017-01-31T13:45:00.000+0000
 
    executionStartTimestamp: date-time
    When the policy starts running; when non-null, the policy does not execute until this date/time; when null, the policy is active for execution now; when the timestamp is missing the timezone, the server local timezone is assumed
     Example: 2017-01-31T13:45:00.000+0000
 
    jobApprovalTypeId: ComponentId
   When the actions in the policy require approval (as defined by the system parameters), specifies who must approve the job generated by the policy before the job can start execution; ignored when the actions do not require approval
 
    jobDynamicFields: [
      Dynamic field values to be used on jobs created by this policy
 
       DynamicFieldValueDTO
   ]
 
    jobExecutionHistory: [
      A history of when this policy has executed and the jobs that it created (read-only)
 
       JobExecutionDTO
   ]
 
    lastExecutionTimestamp: date-time
    When this policy was last execution (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    snmpTrapParams: SnmpTrapNotificationParametersDTO
   Any parameters for sending an SNMP trap as a notification that a job created by this policy has changed its state
 
    skipRemainingActionsOnErrorFlag: boolean
    Whether or not remaining actions in a generated job should be skipped once an action encounters an error
 
    whenDisabledTimestamp: date-time
    When this policy was disabled (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    whenDormantTimestamp: date-time
    When the policy went dormant and will not execute again (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    dynamicFields: [
      The dynamic fields
 
       DynamicFieldValueDTO
   ]
 
    activeDaysOfWeek: [
      When the policy is set for weekly execution, the days of the week the policy runs
 
      integer
    ]
 
    activeIntervalEndHour: integer
    {{The hour of the end of the daily active interval; hour of the day when the policy stops monitoring the system for new triggers; the policy does not generate jobs outside the active interval; when null, the policy monitors triggers all the time }}
 
    activeIntervalEndMinute: integer
    The minute of the end of the daily active interval; minute of the hour when the policy stops monitoring the system for new triggers
 
    activeIntervalStartHour: integer
    The hour of the start of the daily active interval; hour of the day when the policy starts monitoring the system for new triggers; the policy does not generate jobs outside the active interval; when null, the policy monitors triggers all the time
 
    activeIntervalStartMinute: integer
    The minute of the start of the daily active interval; minute of the hour when the policy starts monitoring the system for new triggers
 
    executionDelaySeconds: integer
    Delay between the time the policy is triggered and the time the generated job executes; during this delay, similar triggers are ignored, which can reduce the volume of identical jobs triggered by bursts of syslog messages
 
    triggeringConditionId: ComponentId*
    The condition that must occur in order for this policy to execute
}

{
    actionNumber: integer
    The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
    guid: string
    The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
    name: string
    The type of action referred to by the GUID (read-only)
 
    annotation: string
    Notes, comments, description, explanation
 
    summary: string
    Brief summary of what this action does (read-only)
 
    statusId: integer
    The current execution status of this action (read-only)
 
    startTimestamp: date-time
    When the action execution began (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    endTimestamp: date-time
    When the action execution completed (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    errorMessage: string
    Reason that a completed action failed (read-only)
 
    hasActionLevelResultsFlag: boolean
    Whether or not this action has executed and has action-level results available for review (read-only)
 
    subactions: [
      Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       ActionDTO
   ]
 
    transcriptSections: {
      When this action accesses devices, which sections can appear in device interaction transcripts; the map key is the string name of the transcript section; the map value is the string GUID of the transcript section; when null, indicates that this type of action does not access devices (does not log in to devices nor make changes to their configurations)
    }
 
    adhocTemplate: AdhocTemplateDTO
   Any template that is passed to the script as a file
 
    continueOnFailureFlag: boolean
    Whether or not to continue sequential execution per device when script execution encounters an error
 
    runtimeProperties: {
      Name/value pairs for any runtime parameters, for substitution into the script execution command line; this is a map where the key is the property name string and the value is the property value string; the use of a shared runtime parameter (in a predefined job) is indicated by a value in the form "sharedRuntimeParam." followed by the name of the shared runtime parameter
    }
 
    runtimePropertiesMasked: {
      Name/value pairs for any runtime parameters, with passwords masked for display; this is a map where the key is the property name string and the value is the property value string (masked if it is a password; read-only)
    }
 
    spanParams: SpanParamsDTO
   Any selected network span
}

{
    actionNumber: integer
    The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
    guid: string
    The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
    name: string
    The type of action referred to by the GUID (read-only)
 
    annotation: string
    Notes, comments, description, explanation
 
    summary: string
    Brief summary of what this action does (read-only)
 
    statusId: integer
    The current execution status of this action (read-only)
 
    startTimestamp: date-time
    When the action execution began (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    endTimestamp: date-time
    When the action execution completed (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    errorMessage: string
    Reason that a completed action failed (read-only)
 
    hasActionLevelResultsFlag: boolean
    Whether or not this action has executed and has action-level results available for review (read-only)
 
    subactions: [
      Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       ActionDTO
   ]
 
    transcriptSections: {
      When this action accesses devices, which sections can appear in device interaction transcripts; the map key is the string name of the transcript section; the map value is the string GUID of the transcript section; when null, indicates that this type of action does not access devices (does not log in to devices nor make changes to their configurations)
    }
 
    boundingSpanParams: SpanParamsDTO*
    The bounding network span, within which the search is to be limited
 
    endpointAddress: string*
    The address to be located
 
    managingSwitchName: string
    For an action that has executed successfully, the name of the device that was found to be the selected endpoint's managing switch (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
}

{
    jobID: string
    The unique ID of the job that was created (and then scheduled for execution or suspended for approval); null when the created job was invalid
 
    timestamp: date-time
    When the policy executed, creating the job
     Example: 2017-01-31T13:45:00.000+0000
 
    validationErrors: string
    Validation errors found in the created job; validation errors can occur when job dynamic fields have changed since the policy was last edited; null when the job was valid
}

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

{
    actionNumber: integer
    The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
    guid: string
    The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
    name: string
    The type of action referred to by the GUID (read-only)
 
    annotation: string
    Notes, comments, description, explanation
 
    summary: string
    Brief summary of what this action does (read-only)
 
    statusId: integer
    The current execution status of this action (read-only)
 
    startTimestamp: date-time
    When the action execution began (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    endTimestamp: date-time
    When the action execution completed (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    errorMessage: string
    Reason that a completed action failed (read-only)
 
    hasActionLevelResultsFlag: boolean
    Whether or not this action has executed and has action-level results available for review (read-only)
 
    subactions: [
      Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       ActionDTO
   ]
 
    transcriptSections: {
      When this action accesses devices, which sections can appear in device interaction transcripts; the map key is the string name of the transcript section; the map value is the string GUID of the transcript section; when null, indicates that this type of action does not access devices (does not log in to devices nor make changes to their configurations)
    }
 
    useAuxiliaryInterfaceFlag: boolean
    Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
    spanParams: SpanParamsDTO*
    The selected network span
 
    cfgTimestamp: date-time
    Selects the configuration(s) active at this date and time to be the new trusted configuration(s); null when cfgId is set; when the timestamp is missing the timezone, the server local timezone is assumed
     Example: 2017-01-31T13:45:00.000+0000
 
    cfgId: ComponentId
   Identifies Which one running or startup configuration is to be marked as the trusted configuration; null when cfgTimestamp is set; note that this identifier is not portable across different TrueSight Network Automation servers
 
    containsUnresolvableConfigurationFlag: boolean
    Indicates that the selected single configuration no longer exists and thus re-using this action is not possible (read-only)
 
    currentFlag: boolean
    Whether or not the current running and/or startup configuration is to be marked as trusted; when false, a cfgTimestamp or cfgId must be provided to select the configuration(s)
 
    runningTrailFlag: boolean
    Whether or not a running configuration is to be marked as trusted
 
    startupTrailFlag: boolean
    Whether or not a startup configuration is to be marked as trusted
}

{
    imageTypeName: string
    What type of binary file this is, when a device supports multi-file images; required on update when referring to an existing file within an existing DeployOsImageActionDTO
 
    name: string
    The name of the file; required on update when referring to an existing file within an existing DeployOsImageActionDTO
 
    sizeBytes: integer
    The size of the file in bytes; required on update when referring to an existing file within an existing DeployOsImageActionDTO
 
    messageDigest: string
    The MD5 checksum or digest; required on update when referring to an existing file within an existing DeployOsImageActionDTO
}

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

{
    id: string
    The policy's unique database key (read-only)
 
    name: string*
    The policy's unique display name
 
    actions: [
      The actions to be executed, ordered in execution order
 
       ActionDTO
   ]*
 
    autoPurgeFlag: boolean
    Whether or not the policy is deleted automatically after it has gone dormant
 
    canCopyFlag: boolean
    Whether or not the user is allowed to copy this policy (read-only)
 
    canDeleteFlag: boolean
    Whether or not the user is allowed to delete this policy (read-only)
 
    canEditFlag: boolean
    Whether or not the user is allowed to edit this policy (read-only)
 
    conditions: ConditionsBooleanExpressionDTO
   What conditions must be met in order for the policy to execute; made up of non-triggering conditions that look into past events and changes; required for a time-based policy
 
    conditionsExpression: string
    A readable representation of the conditions field (read-only)
 
    emailParams: EmailNotificationParametersDTO
   Any parameters for sending an email as a notification that a job created by this policy has changed its state
 
    enabledFlag: boolean
    Whether or not the policy is enabled for execution
 
    executionEndTimestamp: date-time
    When the policy stops running; when non-null, the policy does not execute past this date/time; when null, the policy never stops executing; when the timestamp is missing the timezone, the server local timezone is assumed
     Example: 2017-01-31T13:45:00.000+0000
 
    executionStartTimestamp: date-time
    When the policy starts running; when non-null, the policy does not execute until this date/time; when null, the policy is active for execution now; when the timestamp is missing the timezone, the server local timezone is assumed
     Example: 2017-01-31T13:45:00.000+0000
 
    jobApprovalTypeId: ComponentId
   When the actions in the policy require approval (as defined by the system parameters), specifies who must approve the job generated by the policy before the job can start execution; ignored when the actions do not require approval
 
    jobDynamicFields: [
      Dynamic field values to be used on jobs created by this policy
 
       DynamicFieldValueDTO
   ]
 
    jobExecutionHistory: [
      A history of when this policy has executed and the jobs that it created (read-only)
 
       JobExecutionDTO
   ]
 
    lastExecutionTimestamp: date-time
    When this policy was last execution (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    snmpTrapParams: SnmpTrapNotificationParametersDTO
   Any parameters for sending an SNMP trap as a notification that a job created by this policy has changed its state
 
    skipRemainingActionsOnErrorFlag: boolean
    Whether or not remaining actions in a generated job should be skipped once an action encounters an error
 
    whenDisabledTimestamp: date-time
    When this policy was disabled (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    whenDormantTimestamp: date-time
    When the policy went dormant and will not execute again (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    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)
 
    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
}

{
    actionNumber: integer
    The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
    guid: string
    The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
    name: string
    The type of action referred to by the GUID (read-only)
 
    annotation: string
    Notes, comments, description, explanation
 
    summary: string
    Brief summary of what this action does (read-only)
 
    statusId: integer
    The current execution status of this action (read-only)
 
    startTimestamp: date-time
    When the action execution began (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    endTimestamp: date-time
    When the action execution completed (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    errorMessage: string
    Reason that a completed action failed (read-only)
 
    hasActionLevelResultsFlag: boolean
    Whether or not this action has executed and has action-level results available for review (read-only)
 
    subactions: [
      Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       ActionDTO
   ]
 
    transcriptSections: {
      When this action accesses devices, which sections can appear in device interaction transcripts; the map key is the string name of the transcript section; the map value is the string GUID of the transcript section; when null, indicates that this type of action does not access devices (does not log in to devices nor make changes to their configurations)
    }
 
    boundingSpanParams: SpanParamsDTO*
    The bounding network span, within which the search for the endpoint is to be limited
 
    changeVlanOfSharedPortFlag: boolean
    Whether or not to proceed with changing VLAN membership of the endpoint's switch port when the switch has seen traffic with other endpoints on the same port; when false, changing VLAN membership of the shared port is skipped
 
    commitFlag: boolean
    Whether or not to commit changes after performing the quarantine operation
 
    disableSharedPortFlag: boolean
    Whether or not to proceed with disabling of the endpoint's switch port when the switch has seen traffic with other endpoints on the same port when false, the disabling of the shared port is skipped
 
    endpointAddress: string*
    The address to be located and quarantined
 
    markAsTrustedFlag: boolean
    Whether or not any changed configurations resulting from running this action should be marked as trusted
 
    quarantineIsolationLevelId: integer*
    How the quarantine is to be effected
 
    remediationAddress: string
    IP address or host name of a server that will be allowed to talk to the endpoint after it is quarantined, for remediation purposes
 
    remediationVlan: string
    A network from which the endpoint can be accessed after it is quarantined, for remediation purposes
}

{
    actionNumber: integer
    The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
    guid: string
    The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
    name: string
    The type of action referred to by the GUID (read-only)
 
    annotation: string
    Notes, comments, description, explanation
 
    summary: string
    Brief summary of what this action does (read-only)
 
    statusId: integer
    The current execution status of this action (read-only)
 
    startTimestamp: date-time
    When the action execution began (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    endTimestamp: date-time
    When the action execution completed (read-only)
     Example: 2017-01-31T13:45:00.000+0000
 
    errorMessage: string
    Reason that a completed action failed (read-only)
 
    hasActionLevelResultsFlag: boolean
    Whether or not this action has executed and has action-level results available for review (read-only)
 
    subactions: [
      Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       ActionDTO
   ]
 
    transcriptSections: {
      When this action accesses devices, which sections can appear in device interaction transcripts; the map key is the string name of the transcript section; the map value is the string GUID of the transcript section; when null, indicates that this type of action does not access devices (does not log in to devices nor make changes to their configurations)
    }
 
    useAuxiliaryInterfaceFlag: boolean
    Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
    spanParams: SpanParamsDTO*
    The selected network span
 
    markAsTrustedFlag: boolean
    Whether or not any changed configurations resulting from running this action should be marked as trusted
 
    rebootTypeId: integer*
    How to handle unsaved changes prior to rebooting
}