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 object

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