v4.0 Device Adapters API


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

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

device_adapters

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

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


Parameters

Name

Located in

Description

Default

Schema

body

body

Attributes of the new device adapter


Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

201

Created: New device adapter successfully added


400

Bad request: Input device adapter DTO is missing or new device adapter is invalid


401

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


403

Forbidden: Not allowed to import a new device adapter


500

Internal server error: Unexpected exception occurred


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

 /v4.0/device_adapters/active_enabled_device_adapters_as_xml
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

401

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


403

Forbidden: Not allowed to export device adapter XML source code


500

Internal server error: Unexpected exception occurred


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

 /v4.0/device_adapters/all_baseline_device_adapters_as_xml
Click here to expand...


Description

Exports the baseline XML source code for all device adapters delivered with the system; these adapters may be in the Baseline or the Modified state, and they may be enabled or disabled

Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

401

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


403

Forbidden: Not allowed to export device adapter XML source code


500

Internal server error: Unexpected exception occurred


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

 /v4.0/device_adapters/all_modified_device_adapters_as_xml
Click here to expand...


Description

Exports all XML source code for device adapters delivered with the system that are currently in the Modified state, to facilitate a post-upgrade three-way merge between baseline, modified, and previous baseline content; these adapters may be enabled or disabled; the resulting ZIP file contains three AML files: one file for the baseline content, one file for the modified content, and one file for the previous baseline content

Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

401

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


403

Forbidden: Not allowed to export device adapter XML source code


500

Internal server error: Unexpected exception occurred


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

 /v4.0/device_adapters/all_new_device_adapters_as_xml
Click here to expand...


Description

Exports the XML source code for all device adapters that have been added to the system; these adapters may be enabled or disabled

Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

401

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


403

Forbidden: Not allowed to export device adapter XML source code


500

Internal server error: Unexpected exception occurred


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

 /v4.0/device_adapters/device_adapters_imported_from_xml
Click here to expand...


Description

Imports device adapters from the XML source code supplied in the request body, adding new adapters and updating existing adapters, as matched by GUID

Parameters

Name

Located in

Description

Default

Schema

enableNewAdapters

query

Whether or not to enable new adapters found in the XML source code

false

boolean

body

body

The device adapter XML source code to be imported; new adapters will be added and existing ones will be updated


string

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

400

Bad request: Device adapter XML source code is missing or invalid


401

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


403

Forbidden: Not allowed to access device adapters or not allowed to import their XML source code


500

Internal server error: Unexpected exception occurred


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

 /v4.0/device_adapters/filtered
Click here to expand...


Description

Retrieves device adapters, matching any filter criteria passed in the request body, with the returned result being abbreviated or partially-detailed device adapters.

Parameters

Name

Located in

Description

Default

Schema

body

body

Filter for device adapters matching the various criteria specified in the DeviceAdapterFilterDTO; when null, no filtering occurs


orderBy

query

Sort by the specified attribute (name, enabledFlag, state, lastModifiedTimestamp, or lastModifiedUsername, in the specified order (prefix with a '+' for ascending or a '-' for descending)

"+name"

string 
Enum: [
 "+name",
 "-name",
 "+enabledFlag",
 "-enabledFlag",
 "+state",
 "-state",
 "+lastModifiedTimestamp",
 "-lastModifiedTimestamp",
 "+lastModifiedUsername",
 "-lastModifiedUsername"
]

offset

query

Return the specified page number

1

integer

limit

query

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

25

integer

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

400

Bad request: Input filter is invalid


401

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


403

Forbidden: Not allowed to access device adapters


500

Internal server error: Unexpected exception occurred


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

 /v4.0/device_adapters/formatted_xml
Click here to expand...


Description

Retrieves XML re-formatted per the server's formatting rules, to match the format of how device adapter XML content is stored in the database.

Parameters

Name

Located in

Description

Default

Schema

body

body

The device adapter XML string to be formatted


string

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

400

Bad request: Device adapter XML source code is missing or invalid


401

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


500

Internal server error: Unexpected exception occurred


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

 /v4.0/device_adapters/guid
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

401

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


500

Internal server error: Unexpected exception occurred


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

 /v4.0/device_adapters/{nameOrKeyOrGuid
}
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

nameOrKeyOrGuid

path

Name or database key or GUID of the device adapter of interest


string *

includeXmlSource

query

Whether or not to include the XML source code in the returned adapter; access to the XML source code is controlled by the Export Device Adapter system right

false

boolean

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

401

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


403

Forbidden: Not allowed to access device adapters or not allowed to export their XML source code


404

Not found: No single matching device adapter found


500

Internal server error: Unexpected exception occurred


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

 /v4.0/device_adapters/{nameOrKeyOrGuid
}
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

nameOrKeyOrGuid

path

Name or database key or GUID of the device adapter to be modified


string *

body

body

New values for the annotation and/or the enabledFlag


Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

400

Bad request: Input device adapter DTO is missing or the modification attempt is invalid


401

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


403

Forbidden: Not allowed to modify the device adapter


404

Not found: No single matching device adapter found


500

Internal server error: Unexpected exception occurred


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

 /v4.0/device_adapters/{nameOrKeyOrGuid
}
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

nameOrKeyOrGuid

path

Name or database key or GUID of the device adapter to be deleted


string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

string

400

Bad request: Device adapter is not disabled or it is currently in use


401

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


403

Forbidden: Not allowed to delete the device adapter


404

Not found: No single matching device adapter found


500

Internal server error: Unexpected exception occurred


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

 /v4.0/device_adapters/{nameOrKeyOrGuid}/device_adapter_as_xml
Click here to expand...


Description

Exports the selected XML source code for one device adapter, identified by its name, database key, or GUID; can export the baseline content for an adapter provided with the system; the modified content for a changed adapter; the previousBaseline content for an adapter upgraded during a software upgrade; or all content that is present (baseline, modified/new, and/or previous baseline); when a single content is exported, it is returned in an XML file; when more than one content is exported, it is returned in a ZIP file

Parameters

Name

Located in

Description

Default

Schema

nameOrKeyOrGuid

path

Name or database key or GUID of the device adapter of interest


string *

selectedContent

query

Selects the content to be exported, from, baseline, modified, previousBaseline, or all; when baseline, the baseline XML code is exported; when modified, the current custom XML code for a modified or new adapter is exported; when previousBaseline, the pre-upgrade baseline XML code is exported; when all, all XML code that is present is exported

"all"

string * 
Enum: [
 "all",
 "baseline",
 "modified",
 "previousBaseline"
]

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

400

Bad request: Input selectedContent parameter is missing or invalid


401

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


403

Forbidden: Not allowed to access device adapters or not allowed to export their XML source code


404

Not found: No single matching device adapter found, or selected content not found in the adapter


500

Internal server error: Unexpected exception occurred


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

 /v4.0/device_adapters/{nameOrKeyOrGuid}/original_baseline_content
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

nameOrKeyOrGuid

path

Name or database key or GUID of the device adapter to be reverted


string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

string

400

Bad request: Device adapter is not a baseline adapter that has been modified


401

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


403

Forbidden: Not allowed to revert the device adapter


404

Not found: No single matching device adapter found


500

Internal server error: Unexpected exception occurred


Object Definitions

Object

Schema

AbbreviatedDeviceAdapterDTO


Click here to expand...

Subclasses:
DeviceAdapterDTO

{ 
    id: string 
    The adapter's unique database key 

     name: string 
    The adapter's display name 

     annotation: string 
    Annotation with reasons for modification, formatted as HTML; applicable only to baseline adapters that have been modified; not applicable to baseline adapters nor to new adapters 

     enabledFlag: boolean 
    Whether or not this adapter is enabled; when disabled, the details derived from its XML cannot be determined and are left as null 

     guid: string 
    The adapter's GUID 

     lastModifiedTimestamp: date-time 
    When this adapter was last modified 
    Example: 2017-01-31T13:45:00.000+0000

     lastModifiedUsername: string 
    The name of the user who last modified this adapter 

     parent: string 
    Identifies the parent of this device adapter, to help organize the adapters; a device type has a parent containing the GUID of the vendor it belongs to; a custom action or an external script action has a parent containing the name of the menu group it belongs to (which can be null) 

     requiresMergeFlag: boolean 
    Whether or not the adapter requires a manual three-way merge, caused by a software upgrade 

     stateId: integer 
    Whether an adapter is currently in the new, modified, or baseline state 

     stateName: string 
    The meaning of the numeric stateId 

     typeId: integer 
    The type of device adapter 

     typeName: string 
    The meaning of the numeric typeId 
}

ActionAdapterDTO


Click here to expand...

Subclasses:
ExternalScriptActionAdapterDTO
CustomActionAdapterDTO

{ 
    id: string 
    The adapter's unique database key 

     name: string 
    The adapter's display name 

     annotation: string 
    Annotation with reasons for modification, formatted as HTML; applicable only to baseline adapters that have been modified; not applicable to baseline adapters nor to new adapters 

     enabledFlag: boolean 
    Whether or not this adapter is enabled; when disabled, the details derived from its XML cannot be determined and are left as null 

     guid: string 
    The adapter's GUID 

     lastModifiedTimestamp: date-time 
    When this adapter was last modified 
    Example: 2017-01-31T13:45:00.000+0000

     lastModifiedUsername: string 
    The name of the user who last modified this adapter 

     parent: string 
    Identifies the parent of this device adapter, to help organize the adapters; a device type has a parent containing the GUID of the vendor it belongs to; a custom action or an external script action has a parent containing the name of the menu group it belongs to (which can be null) 

     requiresMergeFlag: boolean 
    Whether or not the adapter requires a manual three-way merge, caused by a software upgrade 

     stateId: integer 
    Whether an adapter is currently in the new, modified, or baseline state 

     stateName: string 
    The meaning of the numeric stateId 

     typeId: integer 
    The type of device adapter 

     typeName: string 
    The meaning of the numeric typeId 

     baselineContent: string 
    The original XML source code of this adapter, when it is a baseline adapter shipped with the system 

     modifiedContent: string 
    The XML source code of this adapter when it is a new or modified adapter 

     previousBaselineContent: string 
    The original XML source code of this adapter prior to the last upgrade, when it is a baseline adapter shipped with the system; in order to accomplish a three-way merge after a software upgrade, you must decide if it is easier to edit the latest baseline content (to re-apply your changes) or if it is easier to edit your modified content (to apply the changes and fixes supplied in the latest baseline content); comparing baseline vs previous baseline and modified vs previous baseline gives you the information you need to decide how to accomplish the merge and what changes need to be applied to yield new and complete modified content 

     approvableFlag: boolean 
    Whether or not this sort of action can be subjected to job approval; null when the adapter is disabled and its details are not available 

     browserExecutableFlag: boolean 
    Whether or not the user can use the user interface to configure this sort of action into jobs, predefined jobs, policies, and rules; null when the adapter is disabled and its details are not available 

     classificationId: integer 
    What sort of action this is, broadly speaking; null when the adapter is disabled and its details are not available 

     classificationName: string 
    The meaning of the numeric classificationId; null when the adapter is disabled and its details are not available; can be null when the classificationId is not a recognized value 

     runtimeParameterDeclarations: [ 
      Parameters user can supply when configuring this sort of action; can be null when the adapter is disabled and its details are not available 

       RuntimeParameterDeclarationDTO
    ] 
}

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

ConfigurationTrailAdapterDTO


Click here to expand...


{ 
    id: string 
    The adapter's unique database key 

     name: string 
    The adapter's display name 

     annotation: string 
    Annotation with reasons for modification, formatted as HTML; applicable only to baseline adapters that have been modified; not applicable to baseline adapters nor to new adapters 

     enabledFlag: boolean 
    Whether or not this adapter is enabled; when disabled, the details derived from its XML cannot be determined and are left as null 

     guid: string 
    The adapter's GUID 

     lastModifiedTimestamp: date-time 
    When this adapter was last modified 
    Example: 2017-01-31T13:45:00.000+0000

     lastModifiedUsername: string 
    The name of the user who last modified this adapter 

     parent: string 
    Identifies the parent of this device adapter, to help organize the adapters; a device type has a parent containing the GUID of the vendor it belongs to; a custom action or an external script action has a parent containing the name of the menu group it belongs to (which can be null) 

     requiresMergeFlag: boolean 
    Whether or not the adapter requires a manual three-way merge, caused by a software upgrade 

     stateId: integer 
    Whether an adapter is currently in the new, modified, or baseline state 

     stateName: string 
    The meaning of the numeric stateId 

     typeId: integer 
    The type of device adapter 

     typeName: string 
    The meaning of the numeric typeId 

     baselineContent: string 
    The original XML source code of this adapter, when it is a baseline adapter shipped with the system 

     modifiedContent: string 
    The XML source code of this adapter when it is a new or modified adapter 

     previousBaselineContent: string 
    The original XML source code of this adapter prior to the last upgrade, when it is a baseline adapter shipped with the system; in order to accomplish a three-way merge after a software upgrade, you must decide if it is easier to edit the latest baseline content (to re-apply your changes) or if it is easier to edit your modified content (to apply the changes and fixes supplied in the latest baseline content); comparing baseline vs previous baseline and modified vs previous baseline gives you the information you need to decide how to accomplish the merge and what changes need to be applied to yield new and complete modified content 

     sortOrder: integer 
    Where this trail is sorted among other trails; null when the adapter is disabled and its details are not available 

     supportsTrustedFlag: boolean 
    Whether or not this trail supports the idea of a trusted configuration; this flag being set to true is supported only by the running and startup trails, so it is left false and ignored for all other trails; null when the adapter is disabled and its details are not available 
}

CustomActionAdapterDTO


Click here to expand...


{ 
    id: string 
    The adapter's unique database key 

     name: string 
    The adapter's display name 

     annotation: string 
    Annotation with reasons for modification, formatted as HTML; applicable only to baseline adapters that have been modified; not applicable to baseline adapters nor to new adapters 

     enabledFlag: boolean 
    Whether or not this adapter is enabled; when disabled, the details derived from its XML cannot be determined and are left as null 

     guid: string 
    The adapter's GUID 

     lastModifiedTimestamp: date-time 
    When this adapter was last modified 
    Example: 2017-01-31T13:45:00.000+0000

     lastModifiedUsername: string 
    The name of the user who last modified this adapter 

     parent: string 
    Identifies the parent of this device adapter, to help organize the adapters; a device type has a parent containing the GUID of the vendor it belongs to; a custom action or an external script action has a parent containing the name of the menu group it belongs to (which can be null) 

     requiresMergeFlag: boolean 
    Whether or not the adapter requires a manual three-way merge, caused by a software upgrade 

     stateId: integer 
    Whether an adapter is currently in the new, modified, or baseline state 

     stateName: string 
    The meaning of the numeric stateId 

     typeId: integer 
    The type of device adapter 

     typeName: string 
    The meaning of the numeric typeId 

     baselineContent: string 
    The original XML source code of this adapter, when it is a baseline adapter shipped with the system 

     modifiedContent: string 
    The XML source code of this adapter when it is a new or modified adapter 

     previousBaselineContent: string 
    The original XML source code of this adapter prior to the last upgrade, when it is a baseline adapter shipped with the system; in order to accomplish a three-way merge after a software upgrade, you must decide if it is easier to edit the latest baseline content (to re-apply your changes) or if it is easier to edit your modified content (to apply the changes and fixes supplied in the latest baseline content); comparing baseline vs previous baseline and modified vs previous baseline gives you the information you need to decide how to accomplish the merge and what changes need to be applied to yield new and complete modified content 

     approvableFlag: boolean 
    Whether or not this sort of action can be subjected to job approval; null when the adapter is disabled and its details are not available 

     browserExecutableFlag: boolean 
    Whether or not the user can use the user interface to configure this sort of action into jobs, predefined jobs, policies, and rules; null when the adapter is disabled and its details are not available 

     classificationId: integer 
    What sort of action this is, broadly speaking; null when the adapter is disabled and its details are not available 

     classificationName: string 
    The meaning of the numeric classificationId; null when the adapter is disabled and its details are not available; can be null when the classificationId is not a recognized value 

     runtimeParameterDeclarations: [ 
      Parameters user can supply when configuring this sort of action; can be null when the adapter is disabled and its details are not available 

       RuntimeParameterDeclarationDTO
    ] 

     description: string 
    Any warnings or special instructions to assist the user when configuring this type of action; can be null when the adapter is disabled and its details are not available 

     hideMarkAsTrustedOptionFlag: boolean 
    Whether or not the option to mark the results as trusted is hidden when configuring this type of action; null when the adapter is disabled and its details are not available 

     inspectionOnlyFlag: boolean 
    Whether or not this type of action only displays or looks at information on the device, without making any configuration changes; when false, changes can be made, necessitating a snapshot to retrieve the latest configuration; when true, information is only displayed for manual inspection and no trailing snapshot is done; null when the adapter is disabled and its details are not available 

     notes: string 
    HTML-formatted information for display in the device adapter capabilities report; can be null when the adapter is disabled and its details are not available 
}

DeviceAdapterDTO


Click here to expand...

Subclasses:
DeviceTypeAdapterDTO
ActionAdapterDTO
ConfigurationTrailAdapterDTO
VendorAdapterDTO

{ 
    id: string 
    The adapter's unique database key 

     name: string 
    The adapter's display name 

     annotation: string 
    Annotation with reasons for modification, formatted as HTML; applicable only to baseline adapters that have been modified; not applicable to baseline adapters nor to new adapters 

     enabledFlag: boolean 
    Whether or not this adapter is enabled; when disabled, the details derived from its XML cannot be determined and are left as null 

     guid: string 
    The adapter's GUID 

     lastModifiedTimestamp: date-time 
    When this adapter was last modified 
    Example: 2017-01-31T13:45:00.000+0000

     lastModifiedUsername: string 
    The name of the user who last modified this adapter 

     parent: string 
    Identifies the parent of this device adapter, to help organize the adapters; a device type has a parent containing the GUID of the vendor it belongs to; a custom action or an external script action has a parent containing the name of the menu group it belongs to (which can be null) 

     requiresMergeFlag: boolean 
    Whether or not the adapter requires a manual three-way merge, caused by a software upgrade 

     stateId: integer 
    Whether an adapter is currently in the new, modified, or baseline state 

     stateName: string 
    The meaning of the numeric stateId 

     typeId: integer 
    The type of device adapter 

     typeName: string 
    The meaning of the numeric typeId 

     baselineContent: string 
    The original XML source code of this adapter, when it is a baseline adapter shipped with the system 

     modifiedContent: string 
    The XML source code of this adapter when it is a new or modified adapter 

     previousBaselineContent: string 
    The original XML source code of this adapter prior to the last upgrade, when it is a baseline adapter shipped with the system; in order to accomplish a three-way merge after a software upgrade, you must decide if it is easier to edit the latest baseline content (to re-apply your changes) or if it is easier to edit your modified content (to apply the changes and fixes supplied in the latest baseline content); comparing baseline vs previous baseline and modified vs previous baseline gives you the information you need to decide how to accomplish the merge and what changes need to be applied to yield new and complete modified content 
}

DeviceAdapterFilterDTO


Click here to expand...


{ 
    enabledFlag: boolean 
    Search for adapters that are enabled (true) or disabled (false); null means do not filter on the enabled/disabled state 

     lastModifiedUsernameMatch: string 
    Search for adapters that were last modified by a user whose username matches this wildcard-enabled string 

     nameMatch: string 
    Search for adapters whose name matches this wildcard-enabled string 

     parentMatch: string 
    Search for adapters whose parent matches this wildcard-enabled string; for a device type, this matches on the device type's vendor GUID; for a custom action or external script action, this matches on the menu group name; for other types of adapters, this does not match any value 

     state: integer 
    Search for adapters that are in this state; null means do not filter on the current state 

     type: integer 
    Search for adapters of this type; null means do not filter on the type 
}

DeviceTypeAdapterDTO


Click here to expand...


{ 
    id: string 
    The adapter's unique database key 

     name: string 
    The adapter's display name 

     annotation: string 
    Annotation with reasons for modification, formatted as HTML; applicable only to baseline adapters that have been modified; not applicable to baseline adapters nor to new adapters 

     enabledFlag: boolean 
    Whether or not this adapter is enabled; when disabled, the details derived from its XML cannot be determined and are left as null 

     guid: string 
    The adapter's GUID 

     lastModifiedTimestamp: date-time 
    When this adapter was last modified 
    Example: 2017-01-31T13:45:00.000+0000

     lastModifiedUsername: string 
    The name of the user who last modified this adapter 

     parent: string 
    Identifies the parent of this device adapter, to help organize the adapters; a device type has a parent containing the GUID of the vendor it belongs to; a custom action or an external script action has a parent containing the name of the menu group it belongs to (which can be null) 

     requiresMergeFlag: boolean 
    Whether or not the adapter requires a manual three-way merge, caused by a software upgrade 

     stateId: integer 
    Whether an adapter is currently in the new, modified, or baseline state 

     stateName: string 
    The meaning of the numeric stateId 

     typeId: integer 
    The type of device adapter 

     typeName: string 
    The meaning of the numeric typeId 

     baselineContent: string 
    The original XML source code of this adapter, when it is a baseline adapter shipped with the system 

     modifiedContent: string 
    The XML source code of this adapter when it is a new or modified adapter 

     previousBaselineContent: string 
    The original XML source code of this adapter prior to the last upgrade, when it is a baseline adapter shipped with the system; in order to accomplish a three-way merge after a software upgrade, you must decide if it is easier to edit the latest baseline content (to re-apply your changes) or if it is easier to edit your modified content (to apply the changes and fixes supplied in the latest baseline content); comparing baseline vs previous baseline and modified vs previous baseline gives you the information you need to decide how to accomplish the merge and what changes need to be applied to yield new and complete modified content 

     allSupportedTrails: [ 
      The configuration trails supported by this type, which can currently be enabled or disabled 

       SupportedConfigurationTrailDTO
    ] 

     associatedDeviceCategoryIds: [ 
      Which device categories are supported by this type of device 

       integer 
    ] 

     enabledSupportedTrails: [ 
      The currently enabled configuration trails supported by this type of device 

       SupportedConfigurationTrailDTO
    ] 

     generalNotes: string 
    General information or notes about how to use or manage this type of device, formatted as HTML 

     managerDeviceTypeId: ComponentId 
    The device type that manages this type of device; that is, the type of device that performs various snapshot and/or deploy operations on behalf of this type of device 

     managerRequiredFlag: boolean 
    Whether or not this type of device is managed by a different device 

     osImageTypes: [ 
      The types of OS images that can be discovered in, retrieved from, and/or deployed to this type of device; the system ensures there is always at least one image type defined 

       OsImageTypeDTO
    ] 

     passwordEncryptionFunctionNotes: string 
    Information or instructions about how passwords can be encrypted to be accepted by this type of device when deploying password changes 

     snmpOids: [ 
      The SNMP OID(s) associated with this type of device, which can be used during device import to determine the device type of a new device 

       string 
    ] 

     supportedAccessModeIds: [ 
      The access modes supported by this type of device 

       integer 
    ] 

     supportedCannedActionGuids: [ 
      The standard or canned actions that can be executed on this type of device 

       string 
    ] 

     supportedCustomActionGuids: [ 
      The custom actions that can be executed on this type of device 

       string 
    ] 

     supportedFileSystems: [ 
      The file systems where OS images can be deployed 

       string 
    ] 

     supportedModelNotes: string 
    Which models are supported 

     supportedOsVersionNotes: string 
    Which operating system versions are supported 

     supportedTransferModeIds: [ 
      The file transfer modes supported by this type of device 

       integer 
    ] 

     supportsCommandLineAccessFlag: boolean 
    Whether or not you access this type of device via a command line interface, which controls use of the Telnet/SSH Session and access via the SSH proxy 

     supportsHardwareInventoryFlag: boolean 
    Whether or not this type of device can discover hardware inventory information 

     supportsMultipleSecurityContextsFlag: boolean 
    Whether or not this type of device supports multiple internal security contexts or virtual devices 

     supportsSerialTerminalServerManagementFlag: boolean 
    Whether or not this type of device can be accessed via a serial terminal server, which affects which device security profiles can be used 

     supportsSmartMergeFlag: boolean 
    Whether or not incremental merge or rollback scripts can be calculated 

     templateFormattingNotes: string 
    Information or instructions about how to write templates that will be acceptable to this type of device, formatted as HTML 

     vendorName: string 
    The name of the parent vendor device adapter 
}

ExternalScriptActionAdapterDTO


Click here to expand...


{ 
    id: string 
    The adapter's unique database key 

     name: string 
    The adapter's display name 

     annotation: string 
    Annotation with reasons for modification, formatted as HTML; applicable only to baseline adapters that have been modified; not applicable to baseline adapters nor to new adapters 

     enabledFlag: boolean 
    Whether or not this adapter is enabled; when disabled, the details derived from its XML cannot be determined and are left as null 

     guid: string 
    The adapter's GUID 

     lastModifiedTimestamp: date-time 
    When this adapter was last modified 
    Example: 2017-01-31T13:45:00.000+0000

     lastModifiedUsername: string 
    The name of the user who last modified this adapter 

     parent: string 
    Identifies the parent of this device adapter, to help organize the adapters; a device type has a parent containing the GUID of the vendor it belongs to; a custom action or an external script action has a parent containing the name of the menu group it belongs to (which can be null) 

     requiresMergeFlag: boolean 
    Whether or not the adapter requires a manual three-way merge, caused by a software upgrade 

     stateId: integer 
    Whether an adapter is currently in the new, modified, or baseline state 

     stateName: string 
    The meaning of the numeric stateId 

     typeId: integer 
    The type of device adapter 

     typeName: string 
    The meaning of the numeric typeId 

     baselineContent: string 
    The original XML source code of this adapter, when it is a baseline adapter shipped with the system 

     modifiedContent: string 
    The XML source code of this adapter when it is a new or modified adapter 

     previousBaselineContent: string 
    The original XML source code of this adapter prior to the last upgrade, when it is a baseline adapter shipped with the system; in order to accomplish a three-way merge after a software upgrade, you must decide if it is easier to edit the latest baseline content (to re-apply your changes) or if it is easier to edit your modified content (to apply the changes and fixes supplied in the latest baseline content); comparing baseline vs previous baseline and modified vs previous baseline gives you the information you need to decide how to accomplish the merge and what changes need to be applied to yield new and complete modified content 

     approvableFlag: boolean 
    Whether or not this sort of action can be subjected to job approval; null when the adapter is disabled and its details are not available 

     browserExecutableFlag: boolean 
    Whether or not the user can use the user interface to configure this sort of action into jobs, predefined jobs, policies, and rules; null when the adapter is disabled and its details are not available 

     classificationId: integer 
    What sort of action this is, broadly speaking; null when the adapter is disabled and its details are not available 

     classificationName: string 
    The meaning of the numeric classificationId; null when the adapter is disabled and its details are not available; can be null when the classificationId is not a recognized value 

     runtimeParameterDeclarations: [ 
      Parameters user can supply when configuring this sort of action; can be null when the adapter is disabled and its details are not available 

       RuntimeParameterDeclarationDTO
    ] 

     spanSelectionFlag: boolean 
    Whether or not a network span must be selected to execute this sort of action; null when the adapter is disabled and its details are not available 

     useAdhocTemplateFlag: boolean 
    Whether or not an ad-hoc template must be specified to execute this sort of action; null when the adapter is disabled and its details are not available 
}

IntegerRuntimeParameterDeclarationDTO


Click here to expand...

Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.DeviceAdapterService$IntegerRuntimeParameterDeclarationDTO"

{ 
    errorMessage: string 
    Message displayed to the user when the input value is invalid 

     name: string 
    The %keyword% that indicates where this parameter's value should be substituted in 

     prompt: string 
    The prompt displayed to the user 

     requiredFlag: boolean 
    Whether or not the user must enter a value for this runtime parameter 

     sortOrder: integer 
    Where this runtime parameter is sorted among the other runtime parameters 

     defaultValue: integer 
    The initial value to populate into the user interface 

     maxValue: integer 
    The maximum value user can enter for this numeric value; when null, the maximum is 2147483647 

     minValue: integer 
    The minimum value user can enter for this numeric value; when null, the minimum is -2147483648 
}

MenuRuntimeParameterDeclarationDTO


Click here to expand...

Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.DeviceAdapterService$MenuRuntimeParameterDeclarationDTO"

{ 
    errorMessage: string 
    Message displayed to the user when the input value is invalid 

     name: string 
    The %keyword% that indicates where this parameter's value should be substituted in 

     prompt: string 
    The prompt displayed to the user 

     requiredFlag: boolean 
    Whether or not the user must enter a value for this runtime parameter 

     sortOrder: integer 
    Where this runtime parameter is sorted among the other runtime parameters 

     currentMenuValues: [ 
      The legal menu options from which user must choose a value 

       string 
    ] 

     defaultValue: string 
    The initial value to populate into the user interface 
}

NewDeviceAdapterDTO


Click here to expand...


{ 
    annotation: string 
    Annotation with reasons for modification, formatted as HTML 

     enabledFlag: boolean 
    Whether or not this adapter is enabled 

     modifiedContent: string * 
    The XML source code of this adapter when it is a new or modified adapter 
}

OsImageTypeDTO


Click here to expand...


{ 
    displayName: string 
    A readable or displayable name of this type of OS image 

     name: string 
    Short name of the image type which is used internally to uniquely identify an image type within the device type, which may be the name the device itself uses when referring to this sort of image file; when only a single image is required, then the name is "system" 

     order: integer 
    Where this image type is sorted among other image types 

     primaryFlag: boolean 
    Whether or not this image type represents the primary or main type of OS image running on this type of device; one and only one image type can be the primary image type 
}

RuntimeParameterDeclarationDTO


Click here to expand...

Subclasses:
TextRuntimeParameterDeclarationDTO
IntegerRuntimeParameterDeclarationDTO
MenuRuntimeParameterDeclarationDTO

{ 
    errorMessage: string 
    Message displayed to the user when the input value is invalid 

     name: string 
    The %keyword% that indicates where this parameter's value should be substituted in 

     prompt: string 
    The prompt displayed to the user 

     requiredFlag: boolean 
    Whether or not the user must enter a value for this runtime parameter 

     sortOrder: integer 
    Where this runtime parameter is sorted among the other runtime parameters 
}

SupportedConfigurationTrailDTO


Click here to expand...


{ 
    guid: string 
    The GUID of the configuration trail, that refers to a configuration trail device adapter 

     name: string 
    The displayable name of this configuration trail; null when the associated configuration trail adapter is disabled and its details are not available 

     supportsAsciiDataFlag: boolean 
    Whether or not this type of configuration contains readable, displayable, and parseable ASCII data 

     supportsBinaryDataFlag: boolean 
    Whether or not this type of configuration contains unreadable binary data 

     supportsDeployToActiveFlag: boolean 
    Whether or not this type of configuration can be deployed to the device in a Deploy To Active action 

     supportsDeployToStoredFlag: boolean 
    Whether or not this type of configuration can be deployed to the device in a Deploy To Stored action 
}

TextRuntimeParameterDeclarationDTO


Click here to expand...

Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.DeviceAdapterService$TextRuntimeParameterDeclarationDTO"

{ 
    errorMessage: string 
    Message displayed to the user when the input value is invalid 

     name: string 
    The %keyword% that indicates where this parameter's value should be substituted in 

     prompt: string 
    The prompt displayed to the user 

     requiredFlag: boolean 
    Whether or not the user must enter a value for this runtime parameter 

     sortOrder: integer 
    Where this runtime parameter is sorted among the other runtime parameters 

     defaultValue: string 
    The initial value to populate into the user interface 

     mask: string 
    Regular expression that the value and the default value must match in order to be considered valid 

     maxLength: integer 
    The maximum number of characters the user can enter into the value; when set to zero, then this max defaults to 40 characters 

     isPasswordTypeFlag: boolean 
    Whether or not the value and the default value contain a password and thus should be treated as sensitive data 
}

UpdatedDeviceAdapterDTO


Click here to expand...


{ 
    annotation: string 
    Annotation with reasons for modification, formatted as HTML; applicable only to new adapters and to baseline adapters that have been modified 

     enabledFlag: boolean 
    Whether or not this adapter is enabled 
}

VendorAdapterDTO


Click here to expand...


{ 
    id: string 
    The adapter's unique database key 

     name: string 
    The adapter's display name 

     annotation: string 
    Annotation with reasons for modification, formatted as HTML; applicable only to baseline adapters that have been modified; not applicable to baseline adapters nor to new adapters 

     enabledFlag: boolean 
    Whether or not this adapter is enabled; when disabled, the details derived from its XML cannot be determined and are left as null 

     guid: string 
    The adapter's GUID 

     lastModifiedTimestamp: date-time 
    When this adapter was last modified 
    Example: 2017-01-31T13:45:00.000+0000

     lastModifiedUsername: string 
    The name of the user who last modified this adapter 

     parent: string 
    Identifies the parent of this device adapter, to help organize the adapters; a device type has a parent containing the GUID of the vendor it belongs to; a custom action or an external script action has a parent containing the name of the menu group it belongs to (which can be null) 

     requiresMergeFlag: boolean 
    Whether or not the adapter requires a manual three-way merge, caused by a software upgrade 

     stateId: integer 
    Whether an adapter is currently in the new, modified, or baseline state 

     stateName: string 
    The meaning of the numeric stateId 

     typeId: integer 
    The type of device adapter 

     typeName: string 
    The meaning of the numeric typeId 

     baselineContent: string 
    The original XML source code of this adapter, when it is a baseline adapter shipped with the system 

     modifiedContent: string 
    The XML source code of this adapter when it is a new or modified adapter 

     previousBaselineContent: string 
    The original XML source code of this adapter prior to the last upgrade, when it is a baseline adapter shipped with the system; in order to accomplish a three-way merge after a software upgrade, you must decide if it is easier to edit the latest baseline content (to re-apply your changes) or if it is easier to edit your modified content (to apply the changes and fixes supplied in the latest baseline content); comparing baseline vs previous baseline and modified vs previous baseline gives you the information you need to decide how to accomplish the merge and what changes need to be applied to yield new and complete modified content 
}

 

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

TrueSight Network Automation 25.1