v4.0 Device Import Tasks API


TrueSight Network Automation REST API – DeviceImportTaskService
The base URL for the API is:

https://serverName:portNumber/bca-networks/api

device_import_tasks

{{status subtle="false" colour="Blue" title="GET"/}}

 /v4.0/device_import_tasks
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

orderBy

query

Sort by the specified attribute (enabledFlag, executionStatus, format, lastExecutedTimestamp, name, recurring, or schedule) in the specified order (prefix with a '+' for ascending or a '-' for descending)

"+name"

string 
Enum: [
 "+enabledFlag",
 "-enabledFlag",
 "+executionStatus",
 "-executionStatus",
 "+format",
 "-format",
 "+lastExecutedTimestamp",
 "-lastExecutedTimestamp",
 "+name",
 "-name",
 "+recurring",
 "-recurring",
 "+schedule",
 "-schedule"
]

offset

query

Return the specified page number

1

integer

limit

query

Define the number of rows in a page or the maximum number of device import tasks to return

25

integer

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in


403

Forbidden: Not allowed to access device import tasks


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Green" title="POST"/}}

 /v4.0/device_import_tasks
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

body

body

Complete attributes of the new device import task


Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

201

Created: New device import task successfully added


400

Bad request: Input device import task DTO is missing or new device import task is invalid


401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in


403

Forbidden: Not allowed to add a new device import task


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Blue" title="GET"/}}

 /v4.0/device_import_tasks/{nameOrKey
}
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the device import task of interest


string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in


403

Forbidden: Not allowed to access device import tasks


404

Not found: No single matching device import task found


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Yellow" title="PUT"/}}

 /v4.0/device_import_tasks/{nameOrKey
}
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the device import task to be modified


string *

body

body

Complete new attribute values for the device import task; anything left out will be considered to be null and will be nulled out in the device import task


Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

400

Bad request: Input device import task DTO is missing or modified device import task is invalid


401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in


403

Forbidden: Not allowed to modify the device import task


404

Not found: No single matching device import task found


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Red" title="DELETE"/}}

 /v4.0/device_import_tasks/{nameOrKey
}
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the device import task to be deleted


string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

string

401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in


403

Forbidden: Not allowed to delete the device import task


404

Not found: No single matching device import task found


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Blue" title="GET"/}}

 /v4.0/device_import_tasks/{nameOrKey}/results
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the device import task of interest


string *

filter.status

query

Filter for individual results with this execution status


integer

orderBy

query

Sort by the specified attribute (name, message, or status) in the specified order (prefix with a '+' for ascending or a '-' for descending)

"+status"

string 
Enum: [
 "+name",
 "-name",
 "+message",
 "-message",
 "+status",
 "-status"
]

offset

query

Return the specified page number

1

integer

limit

query

Define the number of rows in a page or the maximum number of individual device import results to return

25

integer

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in


403

Forbidden: Not allowed to access device import tasks


404

Not found: No single matching device import task found, or no execution results are currently present in the task


500

Internal server error: Unexpected exception occurred



Object Definitions

Object

Schema

ComboGroupFilterDTO


Click here to expand...


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

ComponentFilterDTO


Click here to expand...

Subclasses:
OsImageFilterDTO
GroupFilterDTO
PredefinedJobFilterDTO
RuleFilterDTO
JobFilterDTO
ComboGroupFilterDTO
RuleSetFilterDTO
DeviceFilterDTO
TemplateFilterDTO

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

ComponentId


Click here to expand...


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

ConfigurationExportTaskDTO


Click here to expand...


{ 
    id: string 
    The unique database key of the task (read-only) 

     name: string * 
    The unique display name of the task 

     annotation: string 
    Notes, comments, description, explanation 

     autoPurgeFlag: boolean 
    Whether or not the task is automatically deleted when it is non-recurring and its execution date/time has passed 

     enabledFlag: boolean 
    Whether or not the task is enabled for execution 

     executionSchedule: ImportExportTaskScheduleDTO*
    When the task is scheduled to execute 

     executionStatus: string 
    Information about the most recent execution of the task (read-only) 

     lastExecutedTimestamp: date-time 
    When this task most recently completed executing (read-only) 
    Example: 2017-01-31T13:45:00.000+0000

     schedule: string 
    A readable representation of the task's schedule (read-only) 

     canCopyFlag: boolean 
    Whether or not the user is allowed to copy this task (read-only) 

     canDeleteFlag: boolean 
    Whether or not the user is allowed to delete this task (read-only) 

     canEditFlag: boolean 
    Whether or not the user is allowed to edit this task (read-only) 

     destinationDirectory: string * 
    The directory where the exported configurations are written 

     deviceFilter: DeviceFilterDTO 
    When the selected network span is a realm, group, or combo group, narrows down which devices in that span are included in the export; ignored when the selected network span is a single device 

     exportedResultFilenamePattern: string * 
    How the resulting files are named 

     historicalCfgAsOf: date-time 
    When the scriptTypeId selects a configuration active on a date/time, 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

     localServerFlag: boolean 
    Whether or not the configurations are written to files residing locally; when true, files are written to the destination directory on the server's file system; when false, files are written to a the remote file server using SCP 

     networkSpan: ComponentId*
    Which devices are to have their configurations exported 

     onlyCfgsChangedSinceLastExportFlag: boolean 
    Whether or not to export only changed configurations; when true, exports only configurations changed since the last time this export task was run; when false, exports all configurations 

     overwriteExistingFilesFlag: boolean 
    Whether or not to over-write existing files by the same name; when true, any existing files are over-written; when false, existing files are preserved and devices are flagged as skipped; applicable only when exporting to the local file system; must be set to true when exporting to a remote server 

     realmId: ComponentId
    Realm associated with the network span (read-only) 

     remoteHostname: string 
    When exporting to a remote server, the IP address or host name of the server 

     remotePassword: string 
    Password for logging in to the remote server 

     remotePasswordEncryptedFlag: boolean 
    Whether or not the remotePassword value is encrypted; when false, remotePassword is in clear text 

     remoteSshPort: integer 
    SSH port number on the remote server 

     remoteUsername: string 
    Username for logging in to the remote server 

     scriptTypeId: integer * 
    Which configuration is exported 

     scriptTypeName: string 
    The meaning of the numeric scriptTypeId (read-only) 

     whichTrailId: ComponentId
    When the selected configuration is Other Current or Other Historical, which trail is exported 

     zippedExportedFilename: string 
    When zipping up the exported files, the name of the zip file 

     zippedFlag: boolean 
    Whether or not the exported files are combined into a zip archive 
}

ConfigurationImportTaskDTO


Click here to expand...


{ 
    id: string 
    The unique database key of the task (read-only) 

     name: string * 
    The unique display name of the task 

     annotation: string 
    Notes, comments, description, explanation 

     autoPurgeFlag: boolean 
    Whether or not the task is automatically deleted when it is non-recurring and its execution date/time has passed 

     enabledFlag: boolean 
    Whether or not the task is enabled for execution 

     executionSchedule: ImportExportTaskScheduleDTO*
    When the task is scheduled to execute 

     executionStatus: string 
    Information about the most recent execution of the task (read-only) 

     lastExecutedTimestamp: date-time 
    When this task most recently completed executing (read-only) 
    Example: 2017-01-31T13:45:00.000+0000

     schedule: string 
    A readable representation of the task's schedule (read-only) 

     deleteSourceFilesAfterUseFlag: boolean 
    Whether or not to delete the file after it has been imported successfully 

     importAsTemplatesFlag: boolean 
    Whether or not the source files are imported into templates; when true, the file contents are imported into templates named by the file name; when false, the file contents are imported into the target configuration of devices named by the file name 

     matchingSourceFilenamesMask: string 
    Selects or filters which files are imported, by file name; supports asterisk wildcard; when null, all files in the sourceDirectory are imported 

     overwriteExistingContentsFlag: boolean 
    Whether or not existing template or target configuration contents are over-written by the contents of the source files; when false, existing contents are preserved 

     sourceDirectory: string * 
    Directory where the source files are located 
}

DeviceFilterDTO


Click here to expand...


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

DeviceImportDefaultInterfaceValuesDTO


Click here to expand...


{ 
    accessModeId: integer 
    The default protocol used to connect to the device 

     accessModeName: string 
    The name of the default protocol used to connect to the device) 

     autoDiscoverDspFlag: boolean 
    Whether or not the device security profile is to be discovered automatically at the next login attempt 

     deviceAgentId: ComponentId
    The default device agent that manages the device 

     deviceAgentNIC: string 
    The name of the NIC in the default device agent that manages the device 

     deviceAgentNICDetails: string 
    More detailed information about the device agent NIC 

     deviceSecurityProfileId: ComponentId
    The default login credentials for accessing the device 

     natAddress: string 
   {{The default NAT address for reaching the device agent from the device, either an IP address or a host name }}

     port: string 
    The default TCP port used to connect to the device 

     secondaryNatAddress: string 
    A default alternate or backup NAT address for reaching the device agent from the device, either an IP address or a host name, that is used when the 'Use Secondary NAT Address For Devices' system parameter is enabled 

     transferModeId: integer 
    The default protocol used to exchange files with the device 

     transferModeName: string 
    The name of the default protocol used to exchange files with the device (read-only) 
}

DeviceImportDefaultValuesDTO


Click here to expand...


{ 
    auxiliaryInterface: DeviceImportDefaultInterfaceValuesDTO
    Default values for the fields in the auxiliary interface 

     categoryId: integer 
    The default category 

     categoryName: string 
    The meaning of the numeric categoryId (read-only) 

     deviceTypeGuid: string 
    The GUID of the default device type 

     deviceTypeName: string 
    The name of the device type (read-only) 

     dynamicFields: [ 
      The default values for the device dynamic fields 

       DynamicFieldValueDTO
    ] 

     onlineFlag: boolean 
    Default setting for whether or not the device is online 

     primaryInterface: DeviceImportDefaultInterfaceValuesDTO
    Default values for the fields in the primary interface 

     realmId: ComponentId
    The default realm 

     remoteImageFileServerId: ComponentId
    The default remote image file server 

     securityContextName: string 
    The default security context name 

     securityContextTypeId: integer 
    The default security context type 

     securityContextTypeName: string 
    The meaning of the numeric securityContextTypeId (read-only) 

     vendorGuid: string 
    The GUID of the vendor associated with the default device type (read-only) 

     vendorName: string 
    The name of the vendor associated with the default device type (read-only) 
}

DeviceImportTaskDTO


Click here to expand...


{ 
    id: string 
    The unique database key of the task (read-only) 

     name: string * 
    The unique display name of the task 

     annotation: string 
    Notes, comments, description, explanation 

     autoPurgeFlag: boolean 
    Whether or not the task is automatically deleted when it is non-recurring and its execution date/time has passed 

     enabledFlag: boolean 
    Whether or not the task is enabled for execution 

     executionSchedule: ImportExportTaskScheduleDTO*
    When the task is scheduled to execute 

     executionStatus: string 
    Information about the most recent execution of the task (read-only) 

     lastExecutedTimestamp: date-time 
    When this task most recently completed executing (read-only) 
    Example: 2017-01-31T13:45:00.000+0000

     schedule: string 
    A readable representation of the task's schedule (read-only) 

     businessServiceRelationshipRoleId: integer 
    When importing from Atrium CMDB, the business service relationship role; zero means source; one means target 

     businessServiceRelationshipRoleName: string 
    The meaning of the numeric businessServiceRelationshipRoleId (read-only) 

     canCopyFlag: boolean 
    Whether or not the user is allowed to copy this task (read-only) 

     canDeleteFlag: boolean 
    Whether or not the user is allowed to delete this task (read-only) 

     canEditFlag: boolean 
    Whether or not the user is allowed to edit this task (read-only) 

     csvGroupNameSeparator: string 
    When importing from a CSV file that includes a column for the group names, the separator used for parsing out the individual group names 

     defaultValues: DeviceImportDefaultValuesDTO
    The default values to be assigned to new and updated devices when no other value is available (such as from the import source or in an already existing value) 

     formatId: integer * 
    Where the data to be imported is found and how it is formatted 

     formatName: string 
    The meaning of the numeric formatId (read-only) 

     formatShortName: string 
    A shorter version of the meaning of the numeric formatId (read-only) 

     initialSnapshotFlag: boolean 
    Whether or not an initial snapshot is performed for any new devices that are added during the import process 

     jdbcDatabaseAccessDetails: JdbcDatabaseAccessDTO
    The parameters for making a JDBC connection to a remote database server; required when the formatId indicates a database is accessed via JDBC 

     matchingCriteriaId: integer 
    How to match the imported device data to devices already in the system 

     matchingCriteriaName: string 
    The meaning of the numeric matchingCriteriaId (read-only) 

     overwriteDeviceTypeFlag: boolean 
    Whether or not the device type setting for an existing device should be over-written with a new value from the import source 

     rejectUnknownDynamicFieldMenuOptionsFlag: boolean 
    Whether or not to reject unknown menu values for menu-type dynamic fields; menu-type dynamic fields usually have a fixed set of menu options, but these can be augmented automatically during an import to allow for new discovered values; set this to true to disable adding new menu options and to treat such values as invalid 

     replaceAllExistingGroupAssociationsFlag: boolean 
    Whether or not imported static group associations (when supported by the format) completely replace the device's existing static group associations (true), or augment the existing associations (false; taht is, only missing associations are added) 

     restApiAccessDetails: RestApiAccessDTO
    The parameters required to make an HTTP connection to a device data provider; required when the formatId indicates an application is accessed via REST API 

     processingScopeId: integer 
    Which devices to process from the import source 

     processingScopeName: string 
    The meaning of the numeric processingScopeId (read-only) 

     sourceFilename: string 
    When importing from a file, the path to the file on the server 
}

DynamicFieldFilterDTO


Click here to expand...


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

DynamicFieldValueDTO


Click here to expand...


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

EndorsedProgramBasedRuleImportFileTransformerDTO


Click here to expand...

Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.RuleImportTaskService$EndorsedProgramBasedRuleImportFileTransformerDTO"

{ 
    programName: string * 
    Name of the program or script in the endorsed directory 
}

GroupFilterDTO


Click here to expand...


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

IOSHardwareInventoryFilterDTO


Click here to expand...


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

ImportExportTaskDTO


Click here to expand...

Subclasses:
DeviceImportTaskDTO
RuleImportTaskDTO
ConfigurationExportTaskDTO
ConfigurationImportTaskDTO
RuleExportTaskDTO

{ 
    id: string 
    The unique database key of the task (read-only) 

     name: string * 
    The unique display name of the task 

     annotation: string 
    Notes, comments, description, explanation 

     autoPurgeFlag: boolean 
    Whether or not the task is automatically deleted when it is non-recurring and its execution date/time has passed 

     enabledFlag: boolean 
    Whether or not the task is enabled for execution 

     executionSchedule: ImportExportTaskScheduleDTO*
    When the task is scheduled to execute 

     executionStatus: string 
    Information about the most recent execution of the task (read-only) 

     lastExecutedTimestamp: date-time 
    When this task most recently completed executing (read-only) 
    Example: 2017-01-31T13:45:00.000+0000

     schedule: string 
    A readable representation of the task's schedule (read-only) 
}

ImportExportTaskResultsDTO


Click here to expand...


{ 
    lastExecutionCompletedTimestamp: date-time 
    When the task's last execution was completed 
    Example: 2017-01-31T13:45:00.000+0000

     lastExecutionStartedTimestamp: date-time 
    When the task's last execution was started 
    Example: 2017-01-31T13:45:00.000+0000

     lastExecutionStatus: string 
    Overall status of the task's last execution 

     overallErrorMessage: string 
    If the execution failed, the overall error message 

     perComponentResults: [ 
      Status of importing or exporting each individual component 

       IndividualImportExportResultDTO
    ] 
}

ImportExportTaskScheduleDTO


Click here to expand...


{ 
    dayOfMonth: integer 
    When the task is set for monthly execution, the day of the month the task runs 

     executionHour: integer 
    The hour of the day the task runs 

     executionMinute: integer 
    The minute within the hour the task runs 

     executionDays: [ 
      When the task is set for weekly execution, days of the week the task runs 

       integer 
    ] 

     executionTimestamp: date-time 
    When the task is set for a single execution, the exact date/time the task runs; when the timestamp is missing the timezone, the server local timezone is assumed 
    Example: 2017-01-31T13:45:00.000+0000

     repeatTypeId: integer 
    How often the task runs 

     repeatTypeName: string 
    The meaning of the numeric repeatTypeId (read-only) 
}

IndividualImportExportResultDTO


Click here to expand...


{ 
    name: string 
    The name of the component 

     message: string 
    More details about the status; that is, the exact error message for a failure, the reason for a skip, or the specific action taken on a success 

     statusId: integer 
    Specific action taken on the component during the import or export 

     statusName: string 
    The meaning of the numeric statusId 
}

JdbcDatabaseAccessDTO


Click here to expand...


{ 
    databaseTypeId: integer * 
    The JDBC driver used to connect to the remote database server 

     databaseTypeName: string 
    The meaning of the numeric databaseTypeId (read-only) 

     location: string * 
    URL to the JDBC service on the remote database server 

     password: string 
    Password for logging in to the remote database server 

     passwordEncryptedFlag: boolean 
    Whether or not the password value is encrypted; when false, password is in clear text 

     username: string 
    Username for logging in to the remote database server 
}

JobFilterDTO


Click here to expand...


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

OsImageFilterDTO


Click here to expand...


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

PredefinedJobFilterDTO


Click here to expand...


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

RestApiAccessDTO


Click here to expand...


{ 
    password: string 
    Password for logging in to the remote system 

     passwordEncryptedFlag: boolean 
    Whether or not the password value is encrypted; when false, password is in clear text 

     queryParameters: { 
      Query parameters for passing settings to the remote system in the URL; this is a map where the key is the query parameter name and the value is the query parameter value 
    } 

     url: string * 
    URL used to communicate with the remote system 

     username: string 
    Username for logging in to the remote system 
}

RuleExportTaskDTO


Click here to expand...


{ 
    id: string 
    The unique database key of the task (read-only) 

     name: string * 
    The unique display name of the task 

     annotation: string 
    Notes, comments, description, explanation 

     autoPurgeFlag: boolean 
    Whether or not the task is automatically deleted when it is non-recurring and its execution date/time has passed 

     enabledFlag: boolean 
    Whether or not the task is enabled for execution 

     executionSchedule: ImportExportTaskScheduleDTO*
    When the task is scheduled to execute 

     executionStatus: string 
    Information about the most recent execution of the task (read-only) 

     lastExecutedTimestamp: date-time 
    When this task most recently completed executing (read-only) 
    Example: 2017-01-31T13:45:00.000+0000

     schedule: string 
    A readable representation of the task's schedule (read-only) 

     canCopyFlag: boolean 
    Whether or not the user is allowed to copy this task (read-only) 

     canDeleteFlag: boolean 
    Whether or not the user is allowed to delete this task (read-only) 

     canEditFlag: boolean 
    Whether or not the user is allowed to edit this task (read-only) 

     itemsToExport: [ 
      The rules or rule sets to export; a null or empty list means all rules are exported 

       ComponentId
    ] 
}

RuleFilterDTO


Click here to expand...


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

RuleImportFileTransformerDTO

RuleImportTaskDTO


Click here to expand...


{ 
    id: string 
    The unique database key of the task (read-only) 

     name: string * 
    The unique display name of the task 

     annotation: string 
    Notes, comments, description, explanation 

     autoPurgeFlag: boolean 
    Whether or not the task is automatically deleted when it is non-recurring and its execution date/time has passed 

     enabledFlag: boolean 
    Whether or not the task is enabled for execution 

     executionSchedule: ImportExportTaskScheduleDTO*
    When the task is scheduled to execute 

     executionStatus: string 
    Information about the most recent execution of the task (read-only) 

     lastExecutedTimestamp: date-time 
    When this task most recently completed executing (read-only) 
    Example: 2017-01-31T13:45:00.000+0000

     schedule: string 
    A readable representation of the task's schedule (read-only) 

     createNewRuleSetFlag: boolean 
    Whether or not a new rule set is created automatically when an imported rule refers to a rule set that does not currently exist 

     defaultValues: [ 
      The default values for the rule dynamic fields 

       DynamicFieldValueDTO
    ] 

     destinationRuleSetId: ComponentId
    The rule set that the imported rules belong to; when null, the input XML must specify the rule set for each rule 

     inputFileTransformer: RuleImportFileTransformerDTO 
    How to convert or change the input XML file before it is imported 

     overwriteExistingRulesFlag: boolean 
    Whether or not imported rules replace all existing rules in their rule sets; when true, all existing rules are cleared from the rule set and all rules in the input XML are added to the rule set; When false, all existing rules are either left alone or modified per the input XML and new ones are appended to the rules in the rule set 

     rejectUnknownDynamicFieldMenuOptionsFlag: boolean 
    Whether or not to reject unknown menu values for menu-type dynamic fields; menu-type dynamic fields usually have a fixed set of menu options, but these can be augmented automatically during an import to allow for new discovered values; set this to true to disable adding new menu options and to treat such values as invalid 

     xmlInputFileContents: string * 
    The rules being imported, in XML format; left as null when this DTO is retrieved via the GET /rule_import_tasks request that retrieves a list of all tasks (where the file content is not expected to be useful) 

     xmlInputFileName: string * 
    The name of file from which the xmlInputFileContents were read; the file must be named with the .xml extension (case-insensitive). 
}

RuleSetFilterDTO


Click here to expand...


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

StylesheetBasedRuleImportFileTransformerDTO


Click here to expand...

Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.RuleImportTaskService$StylesheetBasedRuleImportFileTransformerDTO"

{ 
    stylesheetContent: string * 
    The XSL stylesheet 

     stylesheetFilename: string * 
    The stylesheet's file name, which must end in the .xsl extension (case-insensitive) 
}

TemplateFilterDTO


Click here to expand...


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

TimePeriodDTO


Click here to expand...


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

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*