| |
|---|
AbbreviatedActionDTO |
Click here to expand...
{
actionNumber: integer
The number of this action within the list of actions in the owning job (or in the owning action, when this is a sub-action)
guid: string
The GUID that identifies the type of action
name: string
The type of action referred to by the GUID
summary: string
Brief summary of what this action does
annotation: string
Notes, comments, description, explanation
networkSpanTypeName: string
The type of network span (if any) that this action acts on
networkSpanId: string
The database key of the network span (if any) that this action acts on
networkSpanName: string
The network span (if any) that this action acts on
realmId: string
The database key of the realm that the network span belongs to
realmName: string
The realm that the network span belongs to
deviceFilter: string
Any device filter in a summarized format
statusId: integer
The current execution status of this action
statusName: string
The meaning of the numeric statusId
startTimestamp: date-time
When the action execution began
Example: 2017-01-31T13:45:00.000+0000
endTimestamp: date-time
When the action execution completed
Example: 2017-01-31T13:45:00.000+0000
errorMessage: string
Reason that a completed action failed
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
AbbreviatedActionDTO
]
} |
AbbreviatedDeviceResultDTO |
Click here to expand...
{
id: string
This device result's unique database key
deviceResultDetailsLink: string
Link to retrieve full details about the device result
deviceId: string
The unique database key of the device where this action ran
deviceName: string
The name of the device where this action ran
realmName: string
The name of the realm the device belonged to at execution time
actionNumber: integer
Which action within the job's list of actions
subactionNumber: integer
Which sub-action within the action; when null, does not refer to a sub-action
statusId: integer
The completion status of the device action
statusName: string
The meaning of the numeric statusId
startTimestamp: date-time
When the device action began execution
Example: 2017-01-31T13:45:00.000+0000
endTimestamp: date-time
When the device action completed execution
Example: 2017-01-31T13:45:00.000+0000
errorMessage: string
Reason for a device action execution failure
exception: string
Further details about a device action execution failure
canViewTranscript: boolean
Whether or not the user can view the recorded device interaction transcript; true when there is such a transcript (may not have one on certain error conditions) and when the user is allowed to view a transcript from this device
actionSpecificResults: string
When there is a merge script or a syntax scan result, the displayable title of that particular type of result
customActionCapturedResultProperties: {
Any result.* properties that were discovered or populated while executing a custom action, as name/value pairs; this is a map where the key is the property name string and the value is the property value string; this field is null when the action is not a custom action or when the custom action captured no result.* properties
}
inProgressSubState: string
When this device action is in progress and is interacting with the device, indicates what the device action is currently doing as it progresses through the interactions coded into the device type
} |
AbbreviatedJobApprovalStatusDTO |
Click here to expand...
{
approvals: [
The approvals that have been made; null means no approvals have been made
JobApprovalDTO
]
externalApprovalObtainedTimestamp: date-time
The time at which an external approval was obtained; null means no such approval is needed or it is still pending
Example: 2017-01-31T13:45:00.000+0000
jobApprovalTypeId: string
The job approval type's unique database key; note that it is possible for this job approval type to have been deleted since the job was submitted
jobApprovalTypeName: string
The name of the job approval type
} |
AbbreviatedJobDTO |
Click here to expand...
{
id: string
The job's unique database key
jobID: string
The job's unique ID
changeID: string
The optional change ID, for mapping into any external change management system
taskID: string
The optional task ID, for mapping into any external change management system
jobDetailsLink: string
Link to get complete details about this job
approvalStatus: AbbreviatedJobApprovalStatusDTO
The approvals that have been made
currentStatus: AbbreviatedJobStatusDTO
The current state of the job
inProgressState: InProgressJobStatusDTO
When the job is currently executing, information about which action it is on and progress through the devices in the selected network span
originatorTypeId: integer
The type of the originator
originatorTypeName: string
The meaning of the numeric originatorTypeId
originator: string
The originating user name or policy name
originatingPredefinedJob: ComponentId
When the originating user prepared this job from a predefined job, information about the predefined job
pendingExternalApprovalFlag: boolean
When the job is currently waiting for approval, whether or not it is waiting on approval from the external change manager, after all other approvals have been obtained
permissions: JobPermissionsDTO
What the user is allowed to do and is able to do with this job
reconcilableFlag: boolean
When external change management is enabled, whether or not this job can be reconciled with the external change manager; a job is reconcilable when it is completed, it has no changeID and no taskID (meaning it is not already associated with an external change), and it made changes to devices (meaning the changes should be tracked in the external change manager)
reconciliationStatusId: integer
When external change management is enabled, whether or not the job has been reconciled
requiresApprovalFlag: boolean
Whether or not the job must be approved prior to being submitted for execution
runAtTimestamp: date-time
When the job is to execute; null means now or when approved
Example: 2017-01-31T13:45:00.000+0000
dynamicFields: [
The dynamic fields
DynamicFieldValueDTO
]
actions: [
The actions, ordered by action number
AbbreviatedActionDTO
]
} |
AbbreviatedJobStatusDTO |
Click here to expand...
{
annotation: string
The annotation or reason, present only when the user approves, rejects, aborts, or cancels a job
originator: string
The name of the user or policy that caused the job to move into this state
timestamp: date-time
The time at which this state was initiated
Example: 2017-01-31T13:45:00.000+0000
stateId: integer
The state of the job at the timestamp
stateName: string
The meaning of the numeric stateId
} |
ActionDTO |
Click here to expand...
Subclasses:
TrapActionDTO
SpanActionDTO
FindEndpointActionDTO
EventActionDTO
UnquarantineEndpointActionDTO
ExternalScriptActionDTO
EmailActionDTO
QuarantineEndpointActionDTO {
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)
}
} |
ActionSpecificResultsDTO | |
AdhocTemplateDTO |
Click here to expand...
{
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
} |
ApprovalStepDTO |
Click here to expand...
{
jobApproverUserNames: [
The users who can approve the job in this step
string
]
jobApproverRoleNames: [
The roles who can approve the job in this step
string
]
numPending: integer
The number of approvals that remain to be obtained at this step
numRequired: integer
The number of approvals required at this step
} |
ApprovalTypeDTO |
Click here to expand...
{
name: string
The unique identifying name
accessibleToUserNames: [
The users allowed to use this job approval type on jobs they submit; when accessible users and roles are both null, this job approval type is accessible to all
string
]
accessibleToRoleNames: [
The roles allowed to use this job approval type on jobs they submit; when accessible users and roles are both null, this job approval type is accessible to all
string
]
approvalSteps: [
Who must approve and in what order
ApprovalStepDTO
]
methodName: string
What sort of approval process is required
sendEmailFlag: boolean
Whether or not to send an email to the users when their approval is pending for a job
externalApprovalRequiredFlag: boolean
Whether or not approval is required from an external change management system
dynamicFields: [
The dynamic fields
DynamicFieldValueDTO
]
} |
AssignTargetCfgActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$AssignTargetCfgActionDTO" {
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: ScriptParamsDTO*
Which script or configuration is to be copied into the target configuration, or selects to clear the target configuration
} |
ChangeSummaryParametersDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$ChangeSummaryParametersDTO" {
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
} |
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
} |
CommitActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$CommitActionDTO" {
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
} |
ComplianceStatusActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$ComplianceStatusActionDTO" {
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
]
} |
ComplianceStatusResultsDTO | |
ComplianceStatusRuleResultDTO |
Click here to expand...
Subclasses:
PerDeviceComplianceStatusRuleResultDTO {
annotation: string
The rule's annotation
category: string
The rule's category
ruleId: string
The rule's database key
ruleName: string
The rule's name
ruleSetName: string
The name of the rule's parent rule set
status: string
The compliance status
trailName: string
Which configuration trail this is a status for
violationSeverityId: integer
The rule's violation severity
} |
ComplianceSummaryParametersDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$ComplianceSummaryParametersDTO" {
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
} |
ComponentFilterDTO | |
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
}
} |
ConfigCompareParametersDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$ConfigCompareParametersDTO" {
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
} |
CopiedJobDTO |
Click here to expand...
{
errorMessage: string
Errors present in the copied job; a non-null error message indicates that the copy is missing one or more component references that were present when the original job was created but are no longer present; the copied job requires further editing to resolve these errors before the job can be saved
job: JobDTO
The copy of the selected job
} |
CorrectiveScriptPreviewDTO |
Click here to expand...
{
action: ActionDTO
The action or subaction being previewed
correctiveScript: string
The incremental merge or corrective script for the device; null when an error occurred
device: ComponentId
The device being previewed
deviceType: ComponentId
The device type of the device being previewed
errorMessage: string
The reason the corrective script could not be generated
osImageRelease: OsImageReleaseDTO
The current primary OS image version of the device being previewed
} |
CorrectiveScriptsPreviewTargetsDTO |
Click here to expand...
{
action: ActionDTO
The action being previewed
devicesPerSubaction: {
The devices anticipated to be affected by each subaction (when the action is set up to perform compliance rule remediation) or by the action (when the action is set up to perform some other type of configuration change); the map key is the subaction number (or zero when there are no subactions); the map value is the devices that will be acted on by the subaction (or by the action, when there are no subactions; can be an empty list)
}
subactions: [
The corrective actions created from the action, when the action is set up to perform compliance rule remediation; null when the action is set up to make some other type of configuration change
ActionDTO
]
} |
CustomActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$CustomActionDTO" {
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)
}
} |
CustomActionResultsDTO |
Click here to expand...
{
resultProperties: {
Any result.* properties that were discovered or populated while executing the custom action, as name/value pairs; this is a map where the key is the property name string and the value is the property value string
}
} |
DeployOsImageActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$DeployOsImageActionDTO" {
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)
} |
DeployToActiveActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$DeployToActiveActionDTO" {
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
} |
DeployToActiveResultsDTO |
Click here to expand...
{
scriptContents: string
The script that was deployed to the device
} |
DeployToStoredActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$DeployToStoredActionDTO" {
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
} |
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
} |
DeviceInventoryParametersDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$DeviceInventoryParametersDTO" {
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
]
} |
DeviceResultDTO |
Click here to expand...
{
id: string
This device result's unique database key
deviceId: string
The unique database key of the device where this action ran
deviceName: string
The name of the device where this action ran
realmName: string
The name of the realm the device belonged to at execution time
actionNumber: integer
Which action within the job's list of actions
subactionNumber: integer
Which sub-action within the action; when null, does not refer to a sub-action
statusId: integer
The completion status of the device action
startTimestamp: date-time
When the device action began execution
Example: 2017-01-31T13:45:00.000+0000
endTimestamp: date-time
When the device action completed execution
Example: 2017-01-31T13:45:00.000+0000
errorMessage: string
Reason for a device action execution failure
exception: string
Further details about a device action execution failure
accessModeId: integer
The access mode that was used to connect to the device
transferModeId: integer
The transfer mode that was used to exchange files with the device
deviceAgentName: string
The device agent that was used to communicate with the device
deviceAgentNIC: string
The device agent NIC that was used to communicate with the device
deviceInterfaceName: string
Which set of interface settings was used (primary or auxiliary)
deviceTypeName: string
Which device type was used to interact with the device
port: string
The TCP port that was used to connect to the device
deviceSecurityProfileName: string
The credentials that were used to login to the device
actionSpecificResults: ActionSpecificResultsDTO
Further detailed results
transcriptLink: string
Link to get the recorded device interaction transcript, when there is such a transcript (may not have one on certain error conditions) and when the user is allowed to view a transcript from this device
inProgressSubState: string
When this device action is in progress and is interacting with the device, indicates what the device action is currently doing as it progresses through the interactions coded into the device type
} |
DeviceResultFilterDTO |
Click here to expand...
{
actionNumber: integer
Include the results from this one action within the job; action numbers start with 1
errorMessageMatch: string
Include the results that failed with this error message, asterisk wildcards allowed
statusId: integer
Include the results with this numeric completion status
subactionNumber: integer
Include the results from this one sub-action within the action specified by the actionNumber field; sub-action numbers start with 1; this is ignored if you fail to specify an actionNumber
} |
DiscrepancySummaryParametersDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$DiscrepancySummaryParametersDTO" |
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)
} |
EmailActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$EmailActionDTO" {
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
]
} |
EmailNotificationParametersDTO |
Click here to expand...
{
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
]
} |
EmailParametersDTO |
Click here to expand...
Subclasses:
JobEmailParametersDTO
EventEmailParametersDTO {
formatId: integer *
The format of the exported file (CSV, HTML, PDF, or RTF)
hideHeaderAndFooterFlag: boolean
When the format is CSV, whether or not to hide the header and footer; when false, the header/title and footer/selections are included in the CSV file; when true, parts of the header and footer are excluded from the CSV file, making the file more easily imported into a spreadsheet; ignored when the format is not CSV
hideSensitiveDataFlag: boolean
For those exports that carry configuration data, whether or not the exported file masks sensitive configuration data, when false, the exported file contains the same data as the viewed data (which may already have masked its sensitive data, if you are not granted the "Access Sensitive Data" system right); when true, the exported file masks sensitive configuration data
includeAllDetailsFlag: boolean
Whether or not the exported file contains all the details associated with the main report or owned by the selected job; when false, the exported file contains only the selected report or job; when true, the exported file contains the selected report and its details subreports, or the selected job and its device transcripts; for reports, the number of details subreports is limited by the system parameter "Maximum Number of Details in Exported Reports"; ignored when the selected report supports no details (such as system diagnostics, device inventory, and OS image History reports)
orderBy: string
Sort details by the specified attribute in the specified order (prefix with a '+' for ascending order or a '-' for descending order); each type of export supports different attributes that can be sorted; not applicable to exports that lack sortable rows (such as configurations, transcripts, system diagnostics report, and all details-type reports); ignored when not applicable
subject: string
The subject of the email message carrying the exported content
toAdhocAddresses: [
Any ad-hoc email addresses of the other interested recipients of the exported content
string
]
toEmailListIds: [
Any email distribution lists to receive the exported content
ComponentId
]
toUserIds: [
Any users to receive the exported content
ComponentId
]
} |
EmailedReportParametersDTO | |
EventActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$EventActionDTO" {
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)
}
} |
EventEmailParametersDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.EventService$EventEmailParametersDTO" {
formatId: integer *
The format of the exported file (CSV, HTML, PDF, or RTF)
hideHeaderAndFooterFlag: boolean
When the format is CSV, whether or not to hide the header and footer; when false, the header/title and footer/selections are included in the CSV file; when true, parts of the header and footer are excluded from the CSV file, making the file more easily imported into a spreadsheet; ignored when the format is not CSV
hideSensitiveDataFlag: boolean
For those exports that carry configuration data, whether or not the exported file masks sensitive configuration data, when false, the exported file contains the same data as the viewed data (which may already have masked its sensitive data, if you are not granted the "Access Sensitive Data" system right); when true, the exported file masks sensitive configuration data
includeAllDetailsFlag: boolean
Whether or not the exported file contains all the details associated with the main report or owned by the selected job; when false, the exported file contains only the selected report or job; when true, the exported file contains the selected report and its details subreports, or the selected job and its device transcripts; for reports, the number of details subreports is limited by the system parameter "Maximum Number of Details in Exported Reports"; ignored when the selected report supports no details (such as system diagnostics, device inventory, and OS image History reports)
orderBy: string
Sort details by the specified attribute in the specified order (prefix with a '+' for ascending order or a '-' for descending order); each type of export supports different attributes that can be sorted; not applicable to exports that lack sortable rows (such as configurations, transcripts, system diagnostics report, and all details-type reports); ignored when not applicable
subject: string
The subject of the email message carrying the exported content
toAdhocAddresses: [
Any ad-hoc email addresses of the other interested recipients of the exported content
string
]
toEmailListIds: [
Any email distribution lists to receive the exported content
ComponentId
]
toUserIds: [
Any users to receive the exported content
ComponentId
]
filter: EventFilterDTO
Filter for events matching the various criteria specified in the EventFilterDTO; when null, no filtering occurs
viewNameForTitle: string *
The name of the view being exported, used only for display in the exported file's header
} |
EventExportParametersDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.EventService$EventExportParametersDTO" {
formatId: integer *
The format of the exported file (CSV, HTML, PDF, or RTF)
hideHeaderAndFooterFlag: boolean
When the format is CSV, whether or not to hide the header and footer; when false, the header/title and footer/selections are included in the CSV file; when true, parts of the header and footer are excluded from the CSV file, making the file more easily imported into a spreadsheet; ignored when the format is not CSV
hideSensitiveDataFlag: boolean
For those exports that carry configuration data, whether or not the exported file masks sensitive configuration data, when false, the exported file contains the same data as the viewed data (which may already have masked its sensitive data, if you are not granted the "Access Sensitive Data" system right); when true, the exported file masks sensitive configuration data
includeAllDetailsFlag: boolean
Whether or not the exported file contains all the details associated with the main report or owned by the selected job; when false, the exported file contains only the selected report or job; when true, the exported file contains the selected report and its details subreports, or the selected job and its device transcripts; for reports, the number of details subreports is limited by the system parameter "Maximum Number of Details in Exported Reports"; ignored when the selected report supports no details (such as system diagnostics, device inventory, and OS image History reports)
orderBy: string
Sort details by the specified attribute in the specified order (prefix with a '+' for ascending order or a '-' for descending order); each type of export supports different attributes that can be sorted; not applicable to exports that lack sortable rows (such as configurations, transcripts, system diagnostics report, and all details-type reports); ignored when not applicable
filter: EventFilterDTO
Filter for events matching the various criteria specified in the EventFilterDTO; when null, no filtering occurs
viewNameForTitle: string *
The name of the view being exported, used only for display in the exported file's header
} |
EventFilterDTO |
Click here to expand...
{
categoryId: integer
Search for events in this category; a null or a zero value means do not filter on this field
descriptionMatch: string
Search for events whose description matches this wildcard-enabled string; a null means do not filter on this field
groupId: string
Search for events related to the group or the combo group specified by this database key; this field can be used only in transient filters (not in any views), as it is an input-only field and is not persisted to the database
maxEvents: integer
The maximum number of events returned by a database query that uses this filter, from which a selected page is extracted; setting a value improves performance when there are many events in the database; a value of zero or less means an unlimited number of events are returned
realmNameMatch: string
Search for events whose realm matches this wildcard-enabled string; a null means do not filter on this field
rootThreadId: integer
Search for events that were logged in this parent or root database session; a null or a zero value means do not filter on this field
severityIds: [
Search for events of this severity; a null or an empty list means do not filter on this field
integer
]
sourceNameMatch: string
Search for events whose source matches this wildcard-enabled string; a null means do not filter on this field
targetNameMatch: string
Search for events whose target matches this wildcard-enabled string; a null means do not filter on this field
timestamp: TimePeriodDTO
Search for events that occurred within this time period; a null means do not filter on this field
typeId: integer
Search for events of this type; a null or a zero value means do not filter on this field
} |
ExportParametersDTO |
Click here to expand...
Subclasses:
EventExportParametersDTO
EmailParametersDTO
JobExportParametersDTO {
formatId: integer *
The format of the exported file (CSV, HTML, PDF, or RTF)
hideHeaderAndFooterFlag: boolean
When the format is CSV, whether or not to hide the header and footer; when false, the header/title and footer/selections are included in the CSV file; when true, parts of the header and footer are excluded from the CSV file, making the file more easily imported into a spreadsheet; ignored when the format is not CSV
hideSensitiveDataFlag: boolean
For those exports that carry configuration data, whether or not the exported file masks sensitive configuration data, when false, the exported file contains the same data as the viewed data (which may already have masked its sensitive data, if you are not granted the "Access Sensitive Data" system right); when true, the exported file masks sensitive configuration data
includeAllDetailsFlag: boolean
Whether or not the exported file contains all the details associated with the main report or owned by the selected job; when false, the exported file contains only the selected report or job; when true, the exported file contains the selected report and its details subreports, or the selected job and its device transcripts; for reports, the number of details subreports is limited by the system parameter "Maximum Number of Details in Exported Reports"; ignored when the selected report supports no details (such as system diagnostics, device inventory, and OS image History reports)
orderBy: string
Sort details by the specified attribute in the specified order (prefix with a '+' for ascending order or a '-' for descending order); each type of export supports different attributes that can be sorted; not applicable to exports that lack sortable rows (such as configurations, transcripts, system diagnostics report, and all details-type reports); ignored when not applicable
} |
ExternalScriptActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$ExternalScriptActionDTO" {
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
} |
FindEndpointActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$FindEndpointActionDTO" {
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)
} |
GetNextSwitchResultsDTO |
Click here to expand...
{
endpointMacAddress: string
Ethernet MAC address of the endpoint, in the form 'xxxx.xxxx.xxxx'; populated if the MAC address was first discovered by this device action; will be null if it was already known from a previous device action
endpointPortLocation: string
The port the endpoint was seen on within this switch
endpointPortType: string
For an IOS switch, the type of port that the endpoint was seen on (for example, Ethernet, FastEthernet, GigabitEthernet)
nextSwitchAddress: string
IP address of the next switch for reaching the endpoint; will be null/empty when this switch is the endpoint's closest managing switch
} |
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
} |
InProgressJobStatusDTO |
Click here to expand...
{
activeActionName: string
The name of the action currently being executed
activeActionNumber: integer
The number of the action currently being executed
activeSubactionName: string
The name of the sub-action currently being executed, when the action has sub-actions
activeSubactionNumber: integer
The number of the sub-action currently being executed, when the action has sub-actions
completedDeviceCount: integer
The number of devices that have been fully processed by the currently active action or sub-action; null when the active action does not process individual devices or when the totalDeviceCount is zero
inProgressDeviceCount: integer
The number of devices that are now being processed by the currently active action or sub-action; null when the active action does not process individual devices or when the totalDeviceCount is zero
networkSpan: string
The name of the network span being processed by the currently active action or sub-action; null when the active action does not process individual devices
pendingDeviceCount: integer
The number of devices that are waiting to be processed by the currently active action or sub-action; null when the active action does not process individual devices or when the totalDeviceCount is zero
percentComplete: integer
Portion of the total devices that have been fully processed
percentInProgress: integer
Portion of the total devices that are currently being processed
totalActionCount: integer
The number of actions in the job
totalDeviceCount: integer
The number of devices in the network span of the currently active action or sub-action; null when the active action does not process individual devices; can be zero when a filtered network span results in no devices
totalSubactionCount: integer
The number of sub-actions in the currently active action, when the action has sub-actions
} |
JobApprovalDTO |
Click here to expand...
{
message: string
The explanation, notes, or comments for this approval
stepNumber: integer
Which step this approval belongs to, within the steps of the job approval type; numbering starts at one; null in the abbreviated DTO
timestamp: date-time
The time at which this approval was made
Example: 2017-01-31T13:45:00.000+0000
username: string
The user who made this approval
} |
JobApprovalStatusDTO |
Click here to expand...
{
approvals: [
The approvals that have been made; null means no approvals have been made
JobApprovalDTO
]
externalApprovalObtainedTimestamp: date-time
The time at which an external approval was obtained; null means no such approval is needed or it is still pending
Example: 2017-01-31T13:45:00.000+0000
} |
JobDTO |
Click here to expand...
{
id: string
The job's unique database key (read-only)
jobID: string
The job's unique ID (read-only)
changeID: string
The optional change ID, for mapping into any external change management system
taskID: string
The optional task ID, for mapping into any external change management system
approvalStatus: JobApprovalStatusDTO
The approvals that have been made (read-only)
jobApprovalType: ApprovalTypeDTO
The approvals that are required (read-only)
statusHistory: [
The history of job state transitions; the last or most recent entry is the current state (read-only)
JobStatusDTO
]
includeDebugTraceFlag: boolean
Whether or not to include debugging or processing trace messages in device interaction transcripts
inProgressState: InProgressJobStatusDTO
When the job is currently executing, information about which action it is on and progress through the devices in the selected network span (read-only)
loginUsername: string
Username for logging in to devices, when system parameters are set for each job to provide login credentials; ignored when system parameters are set for jobs to use each device's associated device security profile
loginPassword: string
Password for logging in to devices
loginPasswordEncryptedFlag: boolean
Whether or not the loginPassword value is encrypted; when false, loginPassword is in clear text
privilegedUsername: string
Privileged username for logging in to devices
privilegedPassword: string
Privileged password for logging in to devices
privilegedPasswordEncryptedFlag: boolean
Whether or not the privilegedPassword value is encrypted; when false, privilegedPassword is in clear text
originatorTypeId: integer
The type of the originator (read-only)
originator: string
The originating user name or policy name (read-only)
originatingPredefinedJob: ComponentId
When the originating user prepared this job from a predefined job, information about the predefined job; this field is writable only when creating a job, and is ignored when updating a job
pendingExternalApprovalFlag: boolean
When the job is currently waiting for approval, whether or not it is waiting on approval from the external change manager, after all other approvals have been obtained (read-only)
hasCapturedResultsFlag: boolean
Whether or not this job has executed any custom actions that have captured results (read-only)
permissions: JobPermissionsDTO
What the user is allowed to do and is able to do with this job (read-only)
requiresApprovalFlag: boolean
Whether or not the job must be approved prior to being submitted for execution (read-only)
reconcilableFlag: boolean
When external change management is enabled, whether or not this job can be reconciled with the external change manager; a job is reconcilable when it is completed, it has no changeID and no taskID (meaning it is not already associated with an external change), and it made changes to devices (meaning the changes should be tracked in the external change manager) (read-only)
reconciliationTimestamp: date-time
When external change management is enabled, when the job was reconciled (read-only)
Example: 2017-01-31T13:45:00.000+0000
reconciliationErrorMsg: string
When external change management is enabled, any error message from a failed reconciliation (read-only)
reconciliationStatusId: integer
When external change management is enabled, whether or not the job has been reconciled (read-only)
runAtTimestamp: date-time
When the job is to execute; null means now or when approved; when the timestamp is missing the timezone, the server local timezone is assumed
Example: 2017-01-31T13:45:00.000+0000
skipRemainingActionsOnErrorFlag: boolean
Whether or not remaining actions should be skipped once an action encounters an error
triggeringEventSummary: string
Any event that caused this job to be created/executed by an event-based policy (read-only)
emailParams: EmailNotificationParametersDTO
Any parameters for sending an email as a notification that the job has changed its state
snmpTrapParams: SnmpTrapNotificationParametersDTO
Any parameters for sending an SNMP trap as a notification that the job has changed its state
dynamicFields: [
The dynamic fields
DynamicFieldValueDTO
]
actions: [
The actions, ordered in execution order
ActionDTO
] *
submissionLink: string
Link to submit a draft job for execution (read-only)
desubmissionLink: string
Link to cancel a scheduled execution and make the job editable again (that is, re-draft; read-only)
cancellationLink: string
Link to cancel a scheduled execution or abort an executing job (read-only)
approvalLink: string
Link to approve the job (read-only)
rejectionLink: string
Link to reject the job (read-only)
deviceResultsLink: string
Link to retrieve device results (read-only)
} |
JobEmailParametersDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.JobService$JobEmailParametersDTO" {
formatId: integer *
The format of the exported file (CSV, HTML, PDF, or RTF)
hideHeaderAndFooterFlag: boolean
When the format is CSV, whether or not to hide the header and footer; when false, the header/title and footer/selections are included in the CSV file; when true, parts of the header and footer are excluded from the CSV file, making the file more easily imported into a spreadsheet; ignored when the format is not CSV
hideSensitiveDataFlag: boolean
For those exports that carry configuration data, whether or not the exported file masks sensitive configuration data, when false, the exported file contains the same data as the viewed data (which may already have masked its sensitive data, if you are not granted the "Access Sensitive Data" system right); when true, the exported file masks sensitive configuration data
includeAllDetailsFlag: boolean
Whether or not the exported file contains all the details associated with the main report or owned by the selected job; when false, the exported file contains only the selected report or job; when true, the exported file contains the selected report and its details subreports, or the selected job and its device transcripts; for reports, the number of details subreports is limited by the system parameter "Maximum Number of Details in Exported Reports"; ignored when the selected report supports no details (such as system diagnostics, device inventory, and OS image History reports)
orderBy: string
Sort details by the specified attribute in the specified order (prefix with a '+' for ascending order or a '-' for descending order); each type of export supports different attributes that can be sorted; not applicable to exports that lack sortable rows (such as configurations, transcripts, system diagnostics report, and all details-type reports); ignored when not applicable
subject: string
The subject of the email message carrying the exported content
toAdhocAddresses: [
Any ad-hoc email addresses of the other interested recipients of the exported content
string
]
toEmailListIds: [
Any email distribution lists to receive the exported content
ComponentId
]
toUserIds: [
Any users to receive the exported content
ComponentId
]
filter: DeviceResultFilterDTO
Which device results are included in the emailed file
} |
JobExportParametersDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.JobService$JobExportParametersDTO" {
formatId: integer *
The format of the exported file (CSV, HTML, PDF, or RTF)
hideHeaderAndFooterFlag: boolean
When the format is CSV, whether or not to hide the header and footer; when false, the header/title and footer/selections are included in the CSV file; when true, parts of the header and footer are excluded from the CSV file, making the file more easily imported into a spreadsheet; ignored when the format is not CSV
hideSensitiveDataFlag: boolean
For those exports that carry configuration data, whether or not the exported file masks sensitive configuration data, when false, the exported file contains the same data as the viewed data (which may already have masked its sensitive data, if you are not granted the "Access Sensitive Data" system right); when true, the exported file masks sensitive configuration data
includeAllDetailsFlag: boolean
Whether or not the exported file contains all the details associated with the main report or owned by the selected job; when false, the exported file contains only the selected report or job; when true, the exported file contains the selected report and its details subreports, or the selected job and its device transcripts; for reports, the number of details subreports is limited by the system parameter "Maximum Number of Details in Exported Reports"; ignored when the selected report supports no details (such as system diagnostics, device inventory, and OS image History reports)
orderBy: string
Sort details by the specified attribute in the specified order (prefix with a '+' for ascending order or a '-' for descending order); each type of export supports different attributes that can be sorted; not applicable to exports that lack sortable rows (such as configurations, transcripts, system diagnostics report, and all details-type reports); ignored when not applicable
filter: DeviceResultFilterDTO
Which device results are included in the exported file
} |
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
} |
JobPermissionsDTO |
Click here to expand...
{
canAbortFlag: boolean
Whether or not the user is allowed to abort the job
canApproveFlag: boolean
Whether or not the user is allowed to approve the job
canCancelFlag: boolean
Whether or not the user is allowed to cancel the job
canCopyFlag: boolean
Whether or not the user is allowed to copy the job
canCopyFailedFlag: boolean
Whether or not the user is allowed to copy the failed job
canEditFlag: boolean
Whether or not the user is allowed to edit the job
canDeleteFlag: boolean
Whether or not the user is allowed to delete the job
canRedraftFlag: boolean
Whether or not the user is allowed to re-draft the job
canRejectFlag: boolean
Whether or not the user is allowed to reject the job
canSubmitFlag: boolean
Whether or not the user is allowed to submit the job for execution
} |
JobStatusDTO |
Click here to expand...
{
annotation: string
The annotation or reason, present only when the user approves, rejects, aborts, or cancels a job
originator: string
The name of the user or policy that caused the job to move into this state
timestamp: date-time
The time at which this state was initiated
Example: 2017-01-31T13:45:00.000+0000
stateId: integer
The state of the job at the timestamp
} |
JsonPatch | |
JsonPatch.OneOperation | |
JsonPatch.Pointer |
Click here to expand...
string
Pointer or path to an element or property |
JsonPatch.Add | |
JsonPatch.Remove | |
JsonPatch.Replace | |
JsonPatch.Move | |
JsonPatch.Copy | |
JsonPatch.Test | |
MarkAsTrustedActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$MarkAsTrustedActionDTO" {
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
} |
OsFileDTO |
Click here to expand...
{
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
} |
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
} |
OsImageReleaseDTO |
Click here to expand...
{
major: string *
The first element of a version number; asterisk wildcard is allowed
minor: string *
The second element of a version number; asterisk wildcard is allowed
build: string *
The rest of a version number; asterisk wildcard is allowed
} |
PerDeviceComplianceStatusRuleResultDTO |
Click here to expand...
{
annotation: string
The rule's annotation
category: string
The rule's category
ruleId: string
The rule's database key
ruleName: string
The rule's name
ruleSetName: string
The name of the rule's parent rule set
status: string
The compliance status
trailName: string
Which configuration trail this is a status for
violationSeverityId: integer
The rule's violation severity
deviceName: string
The device name
} |
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
} |
QuarantineEndpointActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$QuarantineEndpointActionDTO" {
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
} |
RebootActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$RebootActionDTO" {
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
} |
RefreshDeviceStatusActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$RefreshDeviceStatusActionDTO" {
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
offlineCheckDays: integer
Number of days a device must be offline before it is deleted, when performing the offline device check
parallelExecutionFlag: boolean
When true, runs this action on multiple devices concurrently; when false, runs this action on multiple devices one by one sequentially
runComplianceCheckFlag: boolean
Whether or not to refresh device compliance status
runDeviceAttributesGenerationFlag: boolean
Whether or not to generate fresh device attribute configurations
runDiscrepancyCheckFlag: boolean
Whether or not to refresh device discrepancy status
runOfflineCheckFlag: boolean
Whether or not to check for devices that have been offline for too long, and to delete those that exceed the offlineCheckDays
runProfileCheckFlag: boolean
Whether or not to refresh configuration attribute profiled dynamic fields
} |
|
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$RemediateActionDTO" {
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
collapseSubactionsFlag: boolean
Whether or not identical generated sub-actions are collapsed into a minimal set of unique sub-actions, to reduce device access overhead; true is the recommended value
scriptParams: ScriptParamsDTO*
Which rule(s) and/or rule set(s) are to be remediated
} |
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
} |
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
} |
ScriptParamsDTO |
Click here to expand...
{
adhocTemplate: AdhocTemplateDTO
When the selected script type is ad-hoc template, this is the template
cfgTimestamp: date-time
When the selected script type is historical, this selects the configuration active at this date/time; when the timestamp is missing the timezone, the server local timezone is assumed
Example: 2017-01-31T13:45:00.000+0000
componentIds: [
When the selected script type is template, this contains the identifier of the template; when the script type is 'remediate with...', this contains the identifiers of the rule(s) and/or rule set(s); when the script type is a selected single configuration, this contains the identifier of the configuration
ComponentId
]
ignoreRuleConflictsFlag: boolean
When remediating multiple rules, whether or not to ignore conflicts in the corrections made to the same device by different rules; ignored when not performing remediattion
ruleFilter: RuleFilterDTO
When remediating with all assigned, selects which rules are selected for remediation
ruleFilterDisplayString: string
Displayable version of the rule filtering selections (read-only)
runtimeProperties: {
When the selected script type is template, and the template contains runtime substitution parameters, this contains the name/value pairs for those parameters; 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
}
scriptTypeId: integer *
The selected script or configuration type
selectedComponentDisplayString: string
Displayable version of the component selection (read-only)
selectedTrailIds: [
When the selected script type is other trails, this specifies the trails
ComponentId
]
unresolvableComponents: string
Indicates that a selected template, configuration, rule, and/or rule set no longer exist; this field contains a summary of all the original selections; componentIds contains only the components still present in the database; re-using this action may not be possible or may not result in the same outcome
} |
SnapshotActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$SnapshotActionDTO" {
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
} |
SnapshotOsImageActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$SnapshotOsImageActionDTO" {
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
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)
transferModeId: integer
When using remote image file servers, selects which file transfer mode is used
useRemoteImageFileServerFlag: boolean
Whether or not to deposit the images to a remote file server; when false, saves images to the database; when true, saves images to the remote image file server associated with each device
} |
SnmpTrapNotificationParametersDTO |
Click here to expand...
{
annotation: string
Notes or comments to include in the SNMP trap
jobStateIds: [
The job states of interest; the SNMP trap is sent when the job enters any of these states
integer
] *
destinationSnmpManagerStationIds: [
The SNMP manager station(s) to be sent the job state change SNMP traps
ComponentId
] *
destinationSnmpManagerStationDetailsLinks: [
Link to get more detailed information about the SNMP manager stations (read-only)
string
]
jobDetailsLinkIncludedFlag: boolean
Whether or not the SNMP trap includes a link to access the job details web page
jobSummaryLinkIncludedFlag: boolean
Whether or not the SNMP trap includes a link to access the job summary report web page
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)
} |
SpanActionDTO |
Click here to expand...
Subclasses:
TelnetSshSessionActionDTO
AssignTargetCfgActionDTO
SyntaxScanActionDTO
ComplianceStatusActionDTO
DeployToStoredActionDTO
CustomActionDTO
CommitActionDTO
SnapshotActionDTO
DeployToActiveActionDTO
SnapshotOsImageActionDTO
MarkAsTrustedActionDTO
RefreshDeviceStatusActionDTO
RebootActionDTO
DeployOsImageActionDTO
RemediateActionDTO {
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
} |
SpanParamsDTO |
Click here to expand...
{
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 action; ignored when the selected network span is a single device or multiple devices
deviceFilterDisplayString: string
Displayable version of the device filtering selections (read-only)
policyTriggeringGroupFilter: string
When the policyTriggeringSpanType specifies triggering groups, selects which groups make up the set of triggering groups derived from the target of the triggering event; the triggering event can refer to a target that is a group or a combo group directly, or can refer to a target that is a device whose owning groups and combo groups are the candidate groups; when null, all the candidate groups make up the triggering groups; when set, only candidate groups whose name matches this case-insensitive wildcard-enabled filter make up the triggering groups
policyTriggeringSpanType: integer
In a condition or a policy, takes the network span from the target of the event that triggers a condition to be evaluated or a policy to be executed; when null, must specify a concrete network span in the spanIds; when set, then spanIds and deviceFilter are invalid; must be null when this SpanParamsDTO is used in a job or predefined job
promptForSpanAtRuntime: string
The text to be displayed when preparing a job from a predefined job that prompts the user to select a network span; when set, then spanIds and deviceFilter are invalid
realmId: ComponentId
The realm associated with the spanIds (read-only)
selectedSpanDisplayString: string
Displayable version of the network span selection (read-only)
spanIds: [
The database key and/or name of the single selected realm, group, combo group, or device; or the database keys and/or names of the multiple selected devices; or, in the case of emailed reports, null to indicate the report is to be generated for the entire network
ComponentId
]
unresolvableSpanSummary: string
When getting a job and the network span or one or more devices in a multi-device span have been deleted since the job was executed; contains the name of the network span or the names of all the devices in the multi-device span; re-using this action is not possible (read-only)
} |
SyntaxScanActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$SyntaxScanActionDTO" {
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
scriptParams: ScriptParamsDTO*
Which script or configuration is to be checked by the device
} |
SyntaxScanResultsDTO |
Click here to expand...
{
scriptLines: [
Results of checking each line in the configuration or template or script
SyntaxScanScriptLineDTO
]
} |
SyntaxScanScriptLineDTO |
Click here to expand...
{
commandLine: string
The command line from the configuration or template
errorMessage: string
The device's response to validating or checking the command line
scanned: boolean
Whether or not the command line was checked; some command lines are skipped, such as comments, lines inside multi-line commands (such as banners), and lines inside blocks whose header reported a syntax error
} |
TelnetSshSessionActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$TelnetSshSessionActionDTO" {
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
loginToPrivilegedModeFlag: boolean
Whether or not the user is automatically logged into the device's enabled or privileged mode as part of session initialization; when false, the system logs in to the device but does not enter privileged mode; when true, the system uses the device security profile to enter privileged mode and then begins the interactive session with the user; the user must be granted the 'Login to Privileged Mode' right on the device; used only when the system parameters are set for jobs to use each device's associated device security profile
} |
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
} |
TranscriptSectionDTO |
Click here to expand...
{
interactions: string
The commands and responses that make up this part of the overall conversation with the device; or a bit of information emitted by an external script execution
properties: string
Any properties that were discovered during this part of the conversation; formatted as name=value and with newlines separating the individual properties (not populated for external script executions)
propertiesTitle: string
The name of this group of properties
title: string
The name of this part of the overall conversation
} |
TrapActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$TrapActionDTO" {
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)
}
containsUnresolvableDestinationsFlag: boolean
Indicates that one or more selected SNMP manager stations no longer exist; re-using this action will result in fewer traps being sent (read-only)
destinationSnmpManagerStationIds: [
The database keys of the recipients of the SNMP trap
ComponentId
] *
deviceId: ComponentId
Identifies any related device to include in the SNMP trap
realmId: ComponentId
Identifies the realm that the device belongs to (read-only)
snmpTrapTypeId: integer *
Which SNMP trap to emit
} |
UnquarantineEndpointActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.ActionService$UnquarantineEndpointActionDTO" {
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)
}
commitFlag: boolean
Whether or not to commit changes after performing the unquarantine operation
endpointAddress: string *
The address to be unquarantined, that has previously been quarantined by the system
markAsTrustedFlag: boolean
Whether or not any changed configurations resulting from running this action should be marked as trusted
} |