Create Intent

Create Intent

Intent Creation

Request
URI
POST
https://{api_host}/api/ni/alert-configs/intents/
COPY
Request Body

Add a new Intent Configuration; Available values for highlighted field names: alertType: [ Intent, SdwanIntent ] enabled : [ true , false ] severity : [ Warning, Critical, Moderate, Info ] intentTypeId : [ MtuMismatch, HsrpStpColocation, PortModeMismatch, NativeVlanMismatch, TrunkPortVlanMismatch, DuplexMismatch, PortChannelMismatch, DuplicateMacAddress, DuplicateIPAddress, StpMetricInconsistency ]

Some of these intent types support additional paramters. Available parameters values for those intent types are as follows:

intentTypeId paramValues.id ValueType Values
DuplexMismatch CheckMgmtInterface BOOLEAN true , false
SkipWhenNoInfo BOOLEAN true , false
SkipAutoDuplex BOOLEAN true , false
HsrpConfiguration SkipDownInterfaces BOOLEAN true , false
CheckActiveStandby BOOLEAN true , false
CheckSingleActive BOOLEAN true , false
MtuMismatch CheckMgmtInterface BOOLEAN true , false
SkipWhenNoInfo BOOLEAN true , false
DuplicateMacAddress --
DuplicateIPAddress --
HsrpStpColocation --
NativeVlanMismatch --
NativeVlanTagMismatch --
PortChannelMismatch --
PortModeMismatch --
StpMetricInconsistency --
TrunkPortVlanMismatch --
AlertConfigIntentObject of type(s) application/json
Required 
{
    "name": "mtuCheck",
    "alertType": "Intent",
    "intentTypeId": "MtuMismatch",
    "filterRules": {
        "isValid": "string",
        "filterType": "string",
        "rules": [
            {
                "membership": {
                    "membershipType": "string",
                    "objectType": 0,
                    "entities": [
                        {
                            "modelKey": "string",
                            "name": "string"
                        }
                    ],
                    "query": "string"
                }
            }
        ]
    },
    "paramValues": [
        {
            "id": "min-violation-duration",
            "values": "VIOLATION_DURATION_FIVE_MINUTES",
            "valueType": "FIXED_MULTI_CHOICE_SINGLE_VALUE"
        }
    ],
    "selected_scope": "All Applications",
    "description": "Monitor traffic rate and total bandwidth for applications",
    "enabled": true,
    "severity": "Info",
    "notes": "Mtu check",
    "tags": [
        " [\"Device Health\", \"MTU\", \"dummy\"]"
    ],
    "notificationSettings": [
        {
            "type": "string",
            "frequency": "string",
            "enabled": true,
            "receivers": [
                "string"
            ],
            "schedule": [
                {
                    "type": "string",
                    "periodInMS": 0,
                    "startTimestamp": 0
                }
            ]
        }
    ]
}
string
name
Optional

Intent name

string
alertType
Optional

Intent type

string
intentTypeId
Optional

Intent type

Possible values are : MtuMismatch, HsrpStpColocation, PortModeMismatch, Reachability, Segmentation, NativeVlanMismatch, TrunkPortVlanMismatch, DuplexMismatch, PortChannelMismatch, DuplicateMacAddress, DuplicateIPAddress, StpMetricInconsistency, StigAccountPasswd, StigConsolePasswd, StigDefaultPasswd, StigMgmtPasswd, StigPlaintextPasswd, Loop,
object
filterRules
Optional

filterRules

array of IntentParam
paramValues
Optional

Intent parameters

string
selected_scope
Optional

Intent scope

string
description
Optional

Intent description

boolean
enabled
Optional

enabled

string
severity
Optional

Intent severity

Possible values are : Warning, Critical, Moderate, Info,
string
notes
Optional

Intent notes

array of string
tags
Optional

Intent tags

array of IntentNotification
notificationSettings
Optional

notificationSettings

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns AlertConfigIntentResponse of type(s) application/json 
{
    "alertType": "Intent",
    "categories": {
        "category": "APPLICATION_AWARE_NETWORK_ANALYTICS",
        "categoryName": "string"
    },
    "description": "Monitor traffic rate and total bandwidth for applications",
    "enabled": true,
    "exceptionParams": [
        {
            "id": "min-violation-duration",
            "values": "VIOLATION_DURATION_FIVE_MINUTES",
            "valueType": "FIXED_MULTI_CHOICE_SINGLE_VALUE"
        }
    ],
    "filterRules": {
        "isValid": "string",
        "filterType": "string",
        "rules": [
            {
                "membership": {
                    "membershipType": "string",
                    "objectType": 0,
                    "entities": [
                        {
                            "modelKey": "string",
                            "name": "string"
                        }
                    ],
                    "query": "string"
                }
            }
        ]
    },
    "intentTypeId": "MtuMismatch",
    "modelKey": "string",
    "name": "mtuCheck",
    "notes": "Mtu check",
    "notificationSettings": [
        {
            "type": "string",
            "frequency": "string",
            "enabled": true,
            "receivers": [
                "string"
            ],
            "schedule": [
                {
                    "type": "string",
                    "periodInMS": 0,
                    "startTimestamp": 0
                }
            ]
        }
    ],
    "paramValues": [
        {
            "id": "min-violation-duration",
            "values": "VIOLATION_DURATION_FIVE_MINUTES",
            "valueType": "FIXED_MULTI_CHOICE_SINGLE_VALUE"
        }
    ],
    "selected_scope": "All Applications",
    "severity": "Info",
    "tags": [
        "string"
    ]
}
string
alertType
Optional

Intent type

object
categories
Optional

categories

string
description
Optional

Intent description

boolean
enabled
Optional

enabled

array of IntentParam
exceptionParams
Optional

Exclusion parameters

object
filterRules
Optional

filterRules

string
intentTypeId
Optional

Intent type

Possible values are : APPLICATION_FLOW_HEALTH, APPLICATION_FLOW_UTILIZATION, DuplexMismatch, DuplicateIPAddress, DuplicateMacAddress, HSRPConfiguration, HsrpStpColocation, Loop, MtuMismatch, NativeVlanMismatch, NativeVlanTaggingMismatch, PortChannelMismatch, PortModeMismatch, Reachability, Segmentation, StigAccountPasswd, StigConsolePasswd, StigDefaultPasswd, StigMgmtPasswd, StigPlaintextPasswd, StpMetricInconsistency, TrunkPortVlanMismatch,
string
modelKey
Optional

Intent model key

string
name
Optional

Intent name

string
notes
Optional

Intent notes

array of IntentNotification
notificationSettings
Optional

notificationSettings

array of IntentParam
paramValues
Optional

Intent parameters

string
selected_scope
Optional

Intent scope

string
severity
Optional

Intent severity

Possible values are : Warning, Critical, Moderate, Info,
array of string
tags
Optional

Intent tags


400

Bad Request

Returns ApiError of type(s) application/json 
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


401

Un-authorized

Returns ApiError of type(s) application/json 
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


409

Name conflicts with already existing intent

Returns ApiError of type(s) application/json 
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


500

Internal Error

Operation doesn't return any data structure

On This Page
Intents Operations
POST
Create Intent
DELETE
Delete Intent
GET
Get Intent
POST
Intent Disable
POST
Intent Enable
PUT
Update Intent