Cisco DNA connector documentation reference
Cisco DNA Center connector allows you to connect the MuleSoft connector engine and Cisco DNA Center and configure multiple Cisco DNAC activities.
Configurations
Config
Default configuration
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Name | String | The name for this configuration. Connectors reference the configuration with this name. | x | |
Connection | The connection types that can be provided to this configuration. | x | ||
Expiration Policy | Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit. |
Connection Types
Connection
This class (as its name implies) provides connection instances and the functionality to disconnect and validate those connections.
All connection related parameters (values required in order to create a connection) must be declared in the connection providers.
This particular example is a PoolingConnectionProvider which declares that connections resolved by this provider will be pooled and reused. There are other implementations like CachedConnectionProvider which lazily creates and caches connections or simply ConnectionProvider if you want a new connection each time something requires one.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Host Name | String | x | ||
User Name | String | x | ||
Password | String | x | ||
Connection Timeout | Number | 10 | ||
Connection Timeout Unit | Enumeration, one of:
| Time unit to be used in the Connection Timeout | SECONDS | |
TLS Configuration | ||||
Reconnection | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy | |||
Host | String | |||
Port | Number | |||
User Name | String | |||
Password | String | |||
NTLM Domain | String |
Associated Operations
- Create Event Subscriptions
- Delete Event Subscriptions
- Get Event Subscriptions
- Get Events
- Get Issue Enrichment Details
- Get Issues
- Get Webhook Subscription Details
- Update Event Subscriptions
- Update Issues Status
Operations
Create Event Subscriptions
<cisco-dnac:create-event-subscription>
This method covers execution logic and I/O resolver of CreateEventSubscriptionOperation
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Create Event Subscription Payloads | Array of Any | Input payload for the request body | #[payload] | |
Target Variable | String | The name of a variable on which the operation's output will be placed | ||
Target Value | String | An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Output
Type | Any |
Attributes Type |
For Configurations.
Throws
- CISCO-DNAC:RETRY_EXHAUSTED
- CISCO-DNAC:VALIDATION_FAILED
- CISCO-DNAC:CONNECTIVITY
- CISCO-DNAC:EXECUTION
- CISCO-DNAC:CREATE_SUBSCRIPTION
- MULE:CONNECTIVITY
Delete Event Subscriptions
<cisco-dnac:delete-event-subscription>
Operation to delete event subscription
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Delete Event Subs Payload | Any | Input payload for the request body | #[payload] | |
Target Variable | String | The name of a variable on which the operation's output will be placed | ||
Target Value | String | An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Output
Type | Any |
Attributes Type |
For Configurations.
Throws
- CISCO-DNAC:RETRY_EXHAUSTED
- CISCO-DNAC:DELETE_SUBSCRIPTION
- CISCO-DNAC:VALIDATION_FAILED
- CISCO-DNAC:CONNECTIVITY
- CISCO-DNAC:EXECUTION
- MULE:CONNECTIVITY
Get Event Subscriptions
<cisco-dnac:get-event-subscription>
This method covers execution logic and I/O resolver of GetEventSubscriptionOperation
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Get Event Subscription Payload | Any | #[payload] | ||
Target Variable | String | The name of a variable on which the operation's output will be placed | ||
Target Value | String | An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Output
Type | Array of Any |
Attributes Type |
For Configurations.
Throws
- CISCO-DNAC:RETRY_EXHAUSTED
- CISCO-DNAC:GET_EVENT_SUBSCRIPTION
- CISCO-DNAC:VALIDATION_FAILED
- CISCO-DNAC:CONNECTIVITY
- CISCO-DNAC:EXECUTION
- MULE:CONNECTIVITY
Get Events
<cisco-dnac:get-events>
This method covers execution logic and I/O resolver of GetEventsOperation
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Get Events Payload | Any | #[payload] | ||
Target Variable | String | The name of a variable on which the operation's output will be placed | ||
Target Value | String | An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Output
Type | Array of Any |
Attributes Type |
For Configurations.
Throws
- CISCO-DNAC:RETRY_EXHAUSTED
- CISCO-DNAC:VALIDATION_FAILED
- CISCO-DNAC:GET_EVENTS
- CISCO-DNAC:CONNECTIVITY
- CISCO-DNAC:EXECUTION
- MULE:CONNECTIVITY
Get Issue Enrichment Details
<cisco-dnac:get-issue-enrichment-details>
This method covers execution logic and I/O resolver of GetIssueEnrichmentDetails
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Get Issue Enrichment Details Payload | Any | Input payload for the request body | #[payload] | |
Target Variable | String | The name of a variable on which the operation's output will be placed | ||
Target Value | String | An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Output
Type | Any |
Attributes Type |
For Configurations.
Throws
- CISCO-DNAC:RETRY_EXHAUSTED
- CISCO-DNAC:VALIDATION_FAILED
- CISCO-DNAC:CONNECTIVITY
- CISCO-DNAC:EXECUTION
- CISCO-DNAC:GET_ISSUE_ENRICHMENT_DETAILS
- MULE:CONNECTIVITY
Get Issues
<cisco-dnac:get-issues>
This method covers execution logic and I/O resolver of GetIssuesOperation
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Get Issues Payload | Any | #[payload] | ||
Target Variable | String | The name of a variable on which the operation's output will be placed | ||
Target Value | String | An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Output
Type | Array of Any |
Attributes Type |
For Configurations.
Throws
- CISCO-DNAC:RETRY_EXHAUSTED
- CISCO-DNAC:GET_ISSUES
- CISCO-DNAC:VALIDATION_FAILED
- CISCO-DNAC:CONNECTIVITY
- CISCO-DNAC:EXECUTION
- MULE:CONNECTIVITY
Get Webhook Subscription Details
<cisco-dnac:get-webhook-subscription-details>
This method covers execution logic and I/O resolver of GetWebhookSubscriptionOperation
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Get Webhook Subscription Payload | Any | #[payload] | ||
Target Variable | String | The name of a variable on which the operation's output will be placed | ||
Target Value | String | An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Output
Type | Array of Any |
Attributes Type |
For Configurations.
Throws
- CISCO-DNAC:GET_WEBHOOK_SUBSCRIPTION_DETAILS
- CISCO-DNAC:RETRY_EXHAUSTED
- CISCO-DNAC:VALIDATION_FAILED
- CISCO-DNAC:CONNECTIVITY
- CISCO-DNAC:EXECUTION
- MULE:CONNECTIVITY
Update Event Subscriptions
<cisco-dnac:update-event-subscription>
This method covers execution logic and I/O resolver of UpdateEventSubscriptionOperation
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Update Event Subscription Payloads | Array of Any | Input payload for the request body | #[payload] | |
Target Variable | String | The name of a variable on which the operation's output will be placed | ||
Target Value | String | An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Output
Type | Any |
Attributes Type |
For Configurations.
Throws
- CISCO-DNAC:RETRY_EXHAUSTED
- CISCO-DNAC:VALIDATION_FAILED
- CISCO-DNAC:CONNECTIVITY
- CISCO-DNAC:EXECUTION
- CISCO-DNAC:UPDATE_SUBSCRIPTION
- MULE:CONNECTIVITY
Update Issues Status
<cisco-dnac:update-issues-status>
This method covers execution logic and I/O resolver of UpdateIssuesStatusOperation
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration | String | The name of the configuration to use. | x | |
Update Issues Status Payload | Any | Input payload for the request body | #[payload] | |
Target Variable | String | The name of a variable on which the operation's output will be placed | ||
Target Value | String | An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable | #[payload] | |
Reconnection Strategy | A retry strategy in case of connectivity errors |
Output
Type | Any |
Attributes Type |
For Configurations.
Throws
- CISCO-DNAC:RETRY_EXHAUSTED
- CISCO-DNAC:VALIDATION_FAILED
- CISCO-DNAC:CONNECTIVITY
- CISCO-DNAC:EXECUTION
- CISCO-DNAC:UPDATE_ISSUES_STATUS
- MULE:CONNECTIVITY
Types
Tls
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Enabled Protocols | String | A comma separated list of protocols enabled for this context. | ||
Enabled Cipher Suites | String | A comma separated list of cipher suites enabled for this context. | ||
Trust Store | ||||
Key Store | ||||
Revocation Check |
Trust Store
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path | String | The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store. | ||
Password | String | The password used to protect the trust store. | ||
Type | String | The type of store used. | ||
Algorithm | String | The algorithm used by the trust store. | ||
Insecure | Boolean | If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk. |
Key Store
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path | String | The location (which will be resolved relative to the current classpath and file system, if possible) of the key store. | ||
Type | String | The type of store used. | ||
Alias | String | When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default. | ||
Key Password | String | The password used to protect the private key. | ||
Password | String | The password used to protect the key store. | ||
Algorithm | String | The algorithm used by the key store. |
Standard Revocation Check
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Only End Entities | Boolean | Only verify the last element of the certificate chain. | ||
Prefer Crls | Boolean | Try CRL instead of OCSP first. | ||
No Fallback | Boolean | Do not use the secondary checking method (the one not selected before). | ||
Soft Fail | Boolean | Avoid verification failure when the revocation server can not be reached or is busy. |
Custom Ocsp Responder
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Url | String | The URL of the OCSP responder. | ||
Cert Alias | String | Alias of the signing certificate for the OCSP response (must be in the trust store), if present. |
Crl File
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path | String | The path to the CRL file. |
Reconnection
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Fails Deployment | Boolean | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy | ||
Reconnection Strategy | The reconnection strategy to use |
Reconnect
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency | Number | How often (in ms) to reconnect | ||
Count | Number | How many reconnection attempts to make |
Reconnect Forever
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency | Number | How often (in ms) to reconnect |
Expiration Policy
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Idle Time | Number | A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it's considered eligible for expiration | ||
Time Unit | Enumeration, one of:
| A time unit that qualifies the maxIdleTime attribute |
Response Headers
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Headers | Object | |||
Status Code | Number |
Comments
Log in or register to comment.