| |
---|
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 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) subactions: [ Any sub-actions generated at execution time, ordered by sub-action number (read-only) #ActionDTO ] }
|
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 }
|
AssignTargetCfgActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_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 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) subactions: [ Any sub-actions generated at execution time, ordered by sub-action number (read-only) #ActionDTO ] 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.v3_0.ActionService$ChangeSummaryParametersDTO" { includeEventsFlag: boolean Whether or not events are shown in the report spanParams: #SpanParamsDTO * The network span to report on timePeriod: string* Which configuration changes are to be included in the report; that is, include the changes that occurred within this time period whichTrailGuid: string* Which configuration trail is to be reported on }
|
CommitActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_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 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) subactions: [ Any sub-actions generated at execution time, ordered by sub-action number (read-only) #ActionDTO ] 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.v3_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 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) subactions: [ Any sub-actions generated at execution time, ordered by sub-action number (read-only) #ActionDTO ] 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 ruleSetNames: [ The names of the rule sets to be reported on; when null/empty, then this action reports on all rule sets (read-only) string ] }
|
ComplianceSummaryParametersDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_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 whichTrailGuid: string When the script or configuration type is other current, specifies which other trail is to be reported on }
|
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 componentType: string* The type of the component, used to verify what is retrieved by key/name; valid values are: Combogroup, Condition, Configuration, Device, DynamicField, EmailDistributionList, Group, Keyword, Model, OsImage, Realm, Role, Rule, RuleSet, SecurityVulnerability, SnmpManagerStation, Template, and User qualifiers: { Any additional single qualifier needed to identify the component uniquely, when the name alone is not sufficient; the map key is the extra attribute name string; the map value string completes the identification of the component; for componentType Configuration: key=deviceName, value=name of the device the configuration belongs to; for componentType DynamicField: key=type, value=base class name of the component associated with the dynamic field; for componentType Group, ComboGroup: key=realmName, value=name of the realm the group belongs to; for componentType Model: key=vendorGuid, value=the vendor GUID; for componentType OsImage: key=filename, value=name of the file(s) making up the image; for componentType SecurityVulnerability: key=vendorGuid, value=the vendor GUID } }
|
ConfigCompareParametersDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_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 }
|
CustomActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_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 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) subactions: [ Any sub-actions generated at execution time, ordered by sub-action number (read-only) #ActionDTO ] 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 } }
|
DeployOsImageActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_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 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) subactions: [ Any sub-actions generated at execution time, ordered by sub-action number (read-only) #ActionDTO ] 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 When image source is from remote file server, 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 remote file server, which file (or files, for device with multi-file images) is to be deployed #OsFileDTO ] footprintKbytes: integer When image source is from remote file server, the memory footprint, in kilobytes, for the remote 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 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; note that you will not be able to create or update this action to deploy from a file (feature is not currently supported) 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.v3_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 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) subactions: [ Any sub-actions generated at execution time, ordered by sub-action number (read-only) #ActionDTO ] 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 }
|
DeployToStoredActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_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 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) subactions: [ Any sub-actions generated at execution time, ordered by sub-action number (read-only) #ActionDTO ] 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; this is a map where the map key is the filter string (the value to be matched) and the map value is a ComponentId that identifies the dynamic field; menu-type dynamic fields support only exact matching; the filter string must be formatted properly when the dynamic field is a Date or Integer type } containsUnresolvableDynamicFieldFiltersFlag: boolean Indicates that one or more of the dynamic fields being filtered on no longer exists and thus re-using this filter may not result in the same outcome (read-only) accessModeId: integer Search for devices with this access mode addressMatch: string Search for devices matching this wildcard-enabled IP address or host name autoDspFlag: boolean Search for devices set for device security profile auto-discovery (true) or set to an explicit profile (false); null means do no auto-discovery mode filtering categoryId: integer Search for devices in this category createdTimePeriod: #TimePeriodDTO Search for devices created within this time period deviceAgentName: string Search for devices whose device agent equals this name deviceAgentNICName: string Search for devices whose NIC equals this name, within the device agent specified by the deviceAgentName field; use "(Default)" to filter for devices using the default NIC deviceSecurityProfileName: string Search for devices whose device security profile equals this name deviceTypeGuid: string Search for devices whose device type equals this GUID filterAuxiliaryInterfaceFlag: boolean Whether or not to examine the auxiliary interface settings when matching on the interface-related fields (access mode, transfer mode, address, NAT address, device agent, NIC, and device security profile) filterPrimaryInterfaceFlag: boolean Whether or not to examine the primary interface settings when matching on the interface-related fields (access mode, transfer mode, address, NAT address, device agent, NIC, and device security profile) groupName: string Search for devices that belong to this group in the realm specified by realmName managerDeviceName: string Search for devices whose manager name equals this name modelNameMatch: string Search for devices whose model name matches this wildcard-enabled string nameMatch: string Search for devices whose name matches this wildcard-enabled string natAddressMatch: string Search for devices whose NAT address matches this wildcard-enabled string onlineFlag: boolean Search for either online devices (true) or offline devices (false); null means do not filter on the online/offline state osImageNameMatch: string Search for devices whose OS image name matches this wildcard-enabled string realmName: string Search for devices that belong to this realm securityContextTypeId: integer Search for devices set to this type of security context transferModeId: integer Search for devices with this file transfer mode vendorGuid: string Search for devices whose device type belongs to this vendor noDiscrepanciesFlag: boolean Search for devices that have no discrepancies at all noDiscrepanciesIncludeFlag: boolean Whether to include (true) or exclude (false) devices that have no discrepancies osImageDiscrepancyFlag: boolean Search for devices that have an OS image discrepancy osImageDiscrepancyIncludeFlag: boolean Whether to include (true) or exclude (false) devices that have an OS image discrepancy runningStartupDiscrepancyFlag: boolean Search for devices that have a Running vs Startup discrepancy runningStartupDiscrepancyIncludeFlag: boolean Whether to include (true) or exclude (false) devices that have a Running vs Startup discrepancy runningTrustedDiscrepancyFlag: boolean Search for devices that have a Running vs Trusted Running discrepancy runningTrustedDiscrepancyIncludeFlag: boolean Whether to include (true) or exclude (false) devices that have a Running vs trusted Running discrepancy startupTrustedDiscrepancyFlag: boolean Search for devices that have a Startup vs Trusted Startup discrepancy startupTrustedDiscrepancyIncludeFlag: boolean Whether to include (true) or exclude (false) devices that have a Startup vs trusted Startup discrepancy noViolationsFlag: boolean Search for devices that have no compliance violations noViolationsIncludeFlag: boolean Whether to include (true) or exclude (false) devices that have no compliance violations includedViolationTrailGuids: [ Include devices in the results that have a compliance violation in one of these trails string ] excludedViolationTrailGuids: [ Exclude devices from the results that have a compliance violation in one of these trails string ] lastAttemptedSpanActionFlag: boolean Search for devices whose last attempted span action matches a particular completion status lastAttemptedSpanActionGuid: string When lastAttemptedSpanActionFlag is true, specifies which span action to examine lastAttemptedSpanActionStatusId: integer When lastAttemptedSpanActionFlag is true, specifies which completion status to search for lastAttemptedSpanActionErrorMatch: string When lastAttemptedSpanActionFlag is true, specifies which completion error message to search for, wildcards allowed lastSuccessfulSpanActionFlag: boolean Search for devices whose last successful span action occurred within a selected time period lastSuccessfulSpanActionGuid: string When lastSuccessfulSpanActionFlag is true, specifies which span action to examine lastSuccessfulSpanActionTimePeriod: #TimePeriodDTO When lastSuccessfulSpanActionFlag is true, specifies when the action is to have succeeded noAttemptedSpanActionFlag: boolean Searches for devices that have not attempted a span action within a specified number of days noAttemptedSpanActionGuid: string When noAttemptedSpanActionFlag is true, specifies which span action to examine noAttemptedSpanActionDays: integer When noAttemptedSpanActionFlag is true, specifies when the action is to have been attempted noSuccessfulSpanActionFlag: boolean Searches for devices that have not succeeded executing a span action within a specified number of days noSuccessfulSpanActionGuid: string When noSuccessfulSpanActionFlag is true, specifies which span action to examine noSuccessfulSpanActionDays: integer When noSuccessfulSpanActionFlag is true, specifies when the action is to have succeeded iosHwFilter: #IOSHardwareInventoryFilterDTO Options for filtering on hardware inventory information obtained from Cisco IOS or IOS-like devices }
|
DeviceInventoryParametersDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_0.ActionService$DeviceInventoryParametersDTO" { attributeIds: [ Which selected attributes or device fields are to be displayed in the report; used only when showAllAttributesFlag is false integer ] 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 historyTrailGuids: [ Trails selected for display of their configuration history string ] 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: string When historyTrailGuids are selected, specifies which configurations are to be included in the report (those falling within this time period) violationTrailGuids: [ Trails selected for display of their violation status string ] }
|
DiscrepancySummaryParametersDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_0.ActionService$DiscrepancySummaryParametersDTO"
|
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.v3_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 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) subactions: [ Any sub-actions generated at execution time, ordered by sub-action number (read-only) #ActionDTO ] 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 ] }
|
EmailedReportParametersDTO | |
EventActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_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 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) subactions: [ Any sub-actions generated at execution time, ordered by sub-action number (read-only) #ActionDTO ] }
|
ExternalScriptActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_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 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) subactions: [ Any sub-actions generated at execution time, ordered by sub-action number (read-only) #ActionDTO ] 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 } spanParams: #SpanParamsDTO Any selected network span }
|
FindEndpointActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_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 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) subactions: [ Any sub-actions generated at execution time, ordered by sub-action number (read-only) #ActionDTO ] boundingSpanParams: #SpanParamsDTO * The bounding network span, within which the search is to be limited endpointAddress: string* The address to be located }
|
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 }
|
JobParametersDTO |
Click here to expand...
{ changeID: string The optional change ID, for mapping into any external change management system includeDebugInTranscriptsFlag: boolean Whether or not to include debug trace messages in the device communication transcripts generated by device actions executed by the job networkSpans: { The selected network spans, for those actions whose span selection is deferred until runtime; map key is the spanParams.promptForSpanAtRuntime string (case sensitive); map value is the database key string(s) of the selected network span (which can be a single realm/group/device or multiple devices) } networkSpanFilters: { Any device filters to be applied to the selected network spans; map key is the spanParams.promptForSpanAtRuntime string (case sensitive); map value is the DeviceFilterDTO containing the filter criteria; applicable to realms and groups only } runAtTimestamp: date-time When the job is to execute; null means now or when approved Example: 2017-01-31T13:45:00.000+0000 sharedRuntimeParameters: { The values for the predefined job's shared runtime parameters; map key is the shared runtime parameter name string; map value is a text string; must supply a value for every shared runtime parameter referenced by the actions (the system will not fill in defaults for you; a value can be null); note that password values should be provided in clear text } taskID: string The optional task ID, for mapping into any external change management system }
|
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.v3_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 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) subactions: [ Any sub-actions generated at execution time, ordered by sub-action number (read-only) #ActionDTO ] 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 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 name: string The name of the file sizeBytes: integer The size of the file in bytes messageDigest: string The MD5 checksum or digest }
|
PredefinedJobDTO |
Click here to expand...
{ id: string The predefined job's unique database key (read-only) name: string* The predefined job's unique display name skipRemainingActionsOnErrorFlag: boolean Whether or not remaining actions should be skipped once an action encounters an error in a prepared job jobIds: [ The jobs (by job ID) that have been prepared from this predefined job (read-only) string ] sharedRuntimeParameters: [ The shared runtime parameters #SharedRuntimeParameterDTO ] emailParams: #EmailNotificationParametersDTO Any parameters for sending an email as a notification that a prepared job has changed its state snmpTrapParams: #SnmpTrapNotificationParametersDTO Any parameters for sending an SNMP trap as a notification that a prepared job has changed its state dynamicFields: [ The dynamic fields #DynamicFieldValueDTO ] actions: [ The actions, ordered in execution order #ActionDTO ]* prepareJobLink: string Link to prepare a job from this predefined job (read-only) }
|
PredefinedJobFilterDTO |
Click here to expand...
{ dynamicFieldFilters: { Any filters on dynamic fields; this is a map where the map key is the filter string (the value to be matched) and the map value is a ComponentId that identifies the dynamic field; menu-type dynamic fields support only exact matching; the filter string must be formatted properly when the dynamic field is a Date or Integer type } containsUnresolvableDynamicFieldFiltersFlag: boolean Indicates that one or more of the dynamic fields being filtered on no longer exists and thus re-using this filter may not result in the same outcome (read-only) 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.v3_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 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) subactions: [ Any sub-actions generated at execution time, ordered by sub-action number (read-only) #ActionDTO ] 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.v3_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 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) subactions: [ Any sub-actions generated at execution time, ordered by sub-action number (read-only) #ActionDTO ] 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.v3_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 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) subactions: [ Any sub-actions generated at execution time, ordered by sub-action number (read-only) #ActionDTO ] 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 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.v3_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 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) subactions: [ Any sub-actions generated at execution time, ordered by sub-action number (read-only) #ActionDTO ] 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; this is a map where the map key is the filter string (the value to be matched) and the map value is a ComponentId that identifies the dynamic field; menu-type dynamic fields support only exact matching; the filter string must be formatted properly when the dynamic field is a Date or Integer type } containsUnresolvableDynamicFieldFiltersFlag: boolean Indicates that one or more of the dynamic fields being filtered on no longer exists and thus re-using this filter may not result in the same outcome (read-only) 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 deviceTypeGuid: string 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 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 ] vendorGuid: string Search for rules whose device type belongs to this vendor }
|
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 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 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 selectedTrailGuids: [ When the selected script type is other trails, this specifies the trails string ] 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 }
|
SharedRuntimeParameterDTO |
Click here to expand...
{ name: string* The shared runtime parameter's name, unique within the predefined job defaultValue: string The default value; note that Menu-type parameters have no default value; note that Password-type parameters have a clear text value menuOptions: [ When type is Menu, the menu options, in the order they are presented when preparing a job through the user interface; required when type is Menu string ] type: string* What type of data can be entered into the value for this parameter (Integer, Menu, Password, or Text) }
|
SnapshotActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_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 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) subactions: [ Any sub-actions generated at execution time, ordered by sub-action number (read-only) #ActionDTO ] 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.v3_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 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) subactions: [ Any sub-actions generated at execution time, ordered by sub-action number (read-only) #ActionDTO ] 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 | |
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 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 ] 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 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.v3_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 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) subactions: [ Any sub-actions generated at execution time, ordered by sub-action number (read-only) #ActionDTO ] 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 }
|
TelnetSshSessionActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_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 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) subactions: [ Any sub-actions generated at execution time, ordered by sub-action number (read-only) #ActionDTO ] 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 loginUsername: string Username for logging in to the device loginPassword: string Password for logging in to the device }
|
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 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 Example: 2017-01-31T13:45:00.000+0000 }
|
TrapActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_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 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) subactions: [ Any sub-actions generated at execution time, ordered by sub-action number (read-only) #ActionDTO ] 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 snmpTrapTypeId: integer* Which SNMP trap to emit }
|
UnquarantineEndpointActionDTO |
Click here to expand...
Discriminator: "@class" : "com.bmc.bcan.rest.services.v3_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 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) subactions: [ Any sub-actions generated at execution time, ordered by sub-action number (read-only) #ActionDTO ] 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 }
|