Create Application Definition Overrides for System Appdef (v2.3)
POST/sdwan/v2.3/api/appdefs/:appdef_id/overrides
Create an application definition overrides for system appdef.
Request
Path Parameters
Get the ID of the application definition.
- application/json
Body
Application definition Override
- Array [
- ]
- Array [
- ]
- Array [
- ]
The aggregate flows.
Application unreachability detection.
Possible values: [anonymity
, anti-virus
, auth
, backup
, cad
, collaboration
, conference
, crm
, db-mgmt
, email
, enterprise
, file-sharing
, file-system
, file-transfer
, gaming
, intercomm
, logging
, management
, messaging
, net-discovery
, net-mgmt
, net-monitor
, news-server
, notification
, p2p
, printing
, proxy
, recreational
, remote-desk
, remote-mgmt
, replication
, routing
, saas
, secure-browsing
, storage
, streaming
, tunnel
, utility
, voip
, wan-opt
, web-browsing
, wireless-mgmt
, ip-protocol
, multicast
, security
, i23v5
, printer
, default
]
The application category.
Connection Idle Timeout. Application connection timeout should be in between 0-44000.
Description for the application. Max size = 256.
Applicable for layer 7 applications. List of application domains. Maximum 16 valid domains are allowed and each domain should not exceed 253 characters.
Application ID.
The app def ingress traffic. Application ingress traffic percentage should be in between 1-99.
ip_rules IPRuleV2[]
Applicable for L3/L4 applications. These are IP Prefix rules used to identify the application viz protocol, dscp, source & destination prefixes and source & destination prefixes.
The app def destination filter list. Max size = 8.
Dest Prefixes: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 8, error = APPDEF_CONFIG_INVALID_PREFIX: Invalid prefix configured, noTrim = false, regex = , required = false) ListIPAddress(bcast = DENY, listMaxSize = 0, error = APPDEF_CONFIG_INVALID_PREFIX: Invalid prefix configured, required = false, type = APP_GATEWAYCIDR)
dscp DSCP
The DSP value.
The DSCP value.
Possible values: [ospf
, ipv6
, is-is-over-ipv4
, ipv6-nonxt
, etherip
, ipv6-icmp
, igmp
, udplite
, ipv6-opts
, icmp
, esp
, crtp
, ipip
, eigrp
, egp
, gre
, l2tpv3
, sctp
, ip-in-ip
, rsvp
, pim
, scps
, mpls-in-ip
, ah
, vrrp
, ipv6-route
, igp
, ipv6-frag
]
The app def protocols.
The app def src filters list. Max size = 8.
The default override IP rules.
The default override TCP rules.
The default override UDP rules.
List the override domains.
List the disabled overrides.
Possible values: [business-systems
, collaboration
, general-internet
, media
, networking
, saas
]
Parent App Category
Possible values: [none
, weak
, strict
]
This parameter defines the path affinity characteristics to consider during flow decision making. Allowed values: "none" "weak" "strict". If path affinity is none or weak and a better path is available, flows will be moved to a new path. If path affinity is strict, all application flows will continue on the same path.
Application session timeout should be in between 0-44000.
A information field that can be added to identify the application. Maximum 10 Unique tags of length 1024 each are allowed.
tcp_rules TcpRuleV2[]
For TCP applications, this dictionary will include information on client & server prefix filters, server & client ports, DCSP settings.
The app def config IP list. Max size = 8.
client_port Port
The start and end client port ranges.
The end port range must be between 1 and 65535.
The start port range must be between 1 and 65535.
dscp DSCP
The DSP value.
The DSCP value.
The app def config IP list. Max size = 8.
server_port Port
The start and end server port ranges.
The end port range must be between 1 and 65535.
The start port range must be between 1 and 65535.
Server Prefixes: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 8, error = APPDEF_CONFIG_INVALID_PREFIX: Invalid prefix configured, noTrim = false, regex = , required = false) ListIPAddress(bcast = DENY, listMaxSize = 0, error = APPDEF_CONFIG_INVALID_PREFIX: Invalid prefix configured, required = false, type = APP_GATEWAYCIDR)
Application transfer type. Allowed values: transactional, bulk, rt-audio, rt-video.
udp_rules UdpRuleV2[]
For UDP applications, this dictionary will include information on UDP port, DCSP settings, UDP Filters and destination prefixes.
Dest Prefixes: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 8, error = APPDEF_CONFIG_INVALID_PREFIX: Invalid prefix configured, noTrim = false, regex = , required = false) ListIPAddress(bcast = DENY, listMaxSize = 0, error = APPDEF_CONFIG_INVALID_PREFIX: Invalid prefix configured, required = false, type = APP_GATEWAYCIDR)
dscp DSCP
The DSP value.
The DSCP value.
The app def config IP list. Max size = 8.
udp_port Port
The start and end UDP port ranges.
The end port range must be between 1 and 65535.
The start port range must be between 1 and 65535.
If enabled, policy rule defined for the parent application will be used to make routing decisions for this app.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
- Array [
- ]
Aggregate Flows
App Unreachability Detection
Possible values: [anonymity
, anti-virus
, auth
, backup
, cad
, collaboration
, conference
, crm
, db-mgmt
, email
, enterprise
, file-sharing
, file-system
, file-transfer
, gaming
, intercomm
, logging
, management
, messaging
, net-discovery
, net-mgmt
, net-monitor
, news-server
, notification
, p2p
, printing
, proxy
, recreational
, remote-desk
, remote-mgmt
, replication
, routing
, saas
, secure-browsing
, storage
, streaming
, tunnel
, utility
, voip
, wan-opt
, web-browsing
, wireless-mgmt
, ip-protocol
, multicast
, security
, i23v5
, printer
, default
]
The application category.
Connection Idle Timeout. Application connection timeout should be in between 0-44000.
Description for the application. Max size = 256.
Applicable for layer 7 applications. List of application domains. Maximum 16 valid domains are allowed and each domain should not exceed 253 characters.
Application ID.
Ingress Traffic Pct: Range(max = 99L, error = APPDEF_CONFIG_INVALID_INGRESS: Application ingress traffic percentage should be in between 1-99, min = 1L)
ip_rules IPRuleV2[]
Applicable for L3/L4 applications. These are IP Prefix rules used to identify the application viz protocol, dscp, source & destination prefixes and source & destination prefixes.
The app def destination filter list. Max size = 8.
Dest Prefixes: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 8, error = APPDEF_CONFIG_INVALID_PREFIX: Invalid prefix configured, noTrim = false, regex = , required = false) ListIPAddress(bcast = DENY, listMaxSize = 0, error = APPDEF_CONFIG_INVALID_PREFIX: Invalid prefix configured, required = false, type = APP_GATEWAYCIDR)
dscp DSCP
The DSP value.
The DSCP value.
Possible values: [ospf
, ipv6
, is-is-over-ipv4
, ipv6-nonxt
, etherip
, ipv6-icmp
, igmp
, udplite
, ipv6-opts
, icmp
, esp
, crtp
, ipip
, eigrp
, egp
, gre
, l2tpv3
, sctp
, ip-in-ip
, rsvp
, pim
, scps
, mpls-in-ip
, ah
, vrrp
, ipv6-route
, igp
, ipv6-frag
]
The app def protocols.
The app def src filters list. Max size = 8.
The default override IP rules.
The default override TCP rules.
The default override UDP rules.
List the override domains.
List the disabled overrides.
Possible values: [business-systems
, collaboration
, general-internet
, media
, networking
, saas
]
Parent App Category
Possible values: [none
, weak
, strict
]
This parameter defines the path affinity characteristics to consider during flow decision making. Allowed values: "none" "weak" "strict". If path affinity is none or weak and a better path is available, flows will be moved to a new path. If path affinity is strict, all application flows will continue on the same path.
Application session timeout should be in between 0-44000.
A information field that can be added to identify the application. Maximum 10 Unique tags of length 1024 each are allowed.
tcp_rules TcpRuleV2[]
For TCP applications, this dictionary will include information on client & server prefix filters, server & client ports, DCSP settings.
The app def config IP list. Max size = 8.
client_port Port
The start and end client port ranges.
The end port range must be between 1 and 65535.
The start port range must be between 1 and 65535.
dscp DSCP
The DSP value.
The DSCP value.
The app def config IP list. Max size = 8.
server_port Port
The start and end server port ranges.
The end port range must be between 1 and 65535.
The start port range must be between 1 and 65535.
Server Prefixes: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 8, error = APPDEF_CONFIG_INVALID_PREFIX: Invalid prefix configured, noTrim = false, regex = , required = false) ListIPAddress(bcast = DENY, listMaxSize = 0, error = APPDEF_CONFIG_INVALID_PREFIX: Invalid prefix configured, required = false, type = APP_GATEWAYCIDR)
Application transfer type. Allowed values: transactional, bulk, rt-audio, rt-video.
udp_rules UdpRuleV2[]
For UDP applications, this dictionary will include information on UDP port, DCSP settings, UDP Filters and destination prefixes.
Dest Prefixes: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 0, listMaxSize = 8, error = APPDEF_CONFIG_INVALID_PREFIX: Invalid prefix configured, noTrim = false, regex = , required = false) ListIPAddress(bcast = DENY, listMaxSize = 0, error = APPDEF_CONFIG_INVALID_PREFIX: Invalid prefix configured, required = false, type = APP_GATEWAYCIDR)
dscp DSCP
The DSP value.
The DSCP value.
The app def config IP list. Max size = 8.
udp_port Port
The start and end UDP port ranges.
The end port range must be between 1 and 65535.
The start port range must be between 1 and 65535.
If enabled, policy rule defined for the parent application will be used to make routing decisions for this app.
{
"aggregate_flows": true,
"app_unreachability_detection": true,
"category": "anonymity",
"conn_idle_timeout": 0,
"domains": [
"string"
],
"id": "string",
"ingress_traffic_pct": 0,
"ip_rules": [
{
"dest_filters": [
"string"
],
"dest_prefixes": [
"string"
],
"dscp": {
"value": 0
},
"protocol": "ospf",
"src_filters": [
"string"
]
}
],
"override_default_ip_rules": true,
"override_default_tcp_rules": true,
"override_default_udp_rules": true,
"override_domains": true,
"overrides_disable": true,
"p_category": "business-systems",
"path_affinity": "none",
"session_timeout": 0,
"tags": [
"string"
],
"tcp_rules": [
{
"client_filters": [
"string"
],
"client_port": {
"end": "string",
"start": "string"
},
"dscp": {
"value": 0
},
"server_filters": [
"string"
],
"server_port": {
"end": "string",
"start": "string"
},
"server_prefixes": [
"string"
]
}
],
"transfer_type": "string",
"udp_rules": [
{
"dest_prefixes": [
"string"
],
"dscp": {
"value": 0
},
"udp_filters": [
"string"
],
"udp_port": {
"end": "string",
"start": "string"
}
}
],
"use_parentapp_network_policy": true
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
The error code.
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "APPDEF_CONFIG_NO_SYSTEM_APPS"
},
{
"code": "APPDEF_CONFIG_INVALID_SYSTEM_APPS"
},
{
"code": "APPDEF_CONFIG_APP_NOT_EXISTS"
},
{
"code": "APPDEF_CONFIG_INVALID_PROTOCOL"
},
{
"code": "APPDEF_CONFIG_INVALID_SESSION_TIMEOUT"
},
{
"code": "APPDEF_CONFIG_INVALID_RULE_CONFIG"
},
{
"code": "APPDEF_CONFIG_INVALID_DSCP"
},
{
"code": "APPDEF_CONFIG_INVALID_TIMEOUT"
},
{
"code": "APPDEF_CONFIG_INVALID_INGRESS"
},
{
"code": "APPDEF_CONFIG_INVALID_PATHAFFINITY"
},
{
"code": "APPDEF_CONFIG_INVALID_TRANSFER_TYPE"
},
{
"code": "APPDEF_CONFIG_INVALID_TCP_PORTS"
},
{
"code": "APPDEF_CONFIG_DEPRECATED_APP"
},
{
"code": "APPDEF_CONFIG_INVALID_OVERRIDE_DOMAIN_FLAG"
},
{
"code": "APPDEF_CONFIG_INVALID_OVERRIDE_TCP_FLAG"
},
{
"code": "APPDEF_CONFIG_INVALID_OVERRIDE_UDP_FLAG"
},
{
"code": "APPDEF_CONFIG_INVALID_OVERRIDE_IP_FLAG"
},
{
"code": "APPDEF_CONFIG_NOT_ALLOWED_V1"
},
{
"code": "APPDEF_CONFIG_INVALID_DOMAIN_RULE_CONFIG_V1"
},
{
"code": "APPDEF_CONFIG_MISSING_UDP_PORTS"
},
{
"code": "APPDEF_CONFIG_MISSING_TCP_PORTS"
},
{
"code": "APPDEF_CONFIG_INVALID_UDP_PORTS"
},
{
"code": "APPDEF_CONFIG_READ_ONLY_USE_PARENTAPP_NETWORK_POLICY"
},
{
"code": "APPDEF_CONFIG_READ_ONLY_APP_UNREACHABILITY_DETECTION"
}
]
}
}