Avi NetworkSecurityPolicy Object API
CLI ``` - configure networksecuritypolicy - show networksecuritypolicy ```
Contact Info: support@avinetworks.com
Version: 20.1.9
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /networksecuritypolicypost /networksecuritypolicydelete /networksecuritypolicy/{uuid}get /networksecuritypolicy/{uuid}patch /networksecuritypolicy/{uuid}put /networksecuritypolicy/{uuid}
Up
get /networksecuritypolicy
(networksecuritypolicyGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"tenant_ref" : "aeiou",
"name" : "aeiou",
"description" : "aeiou",
"rules" : [ {
"rl_param" : {
"burst_size" : 123,
"max_rate" : 123
},
"log" : true,
"enable" : true,
"match" : {
"client_port" : {
"match_criteria" : "aeiou",
"ranges" : [ {
"start" : 123,
"end" : 123
} ],
"ports" : [ "" ]
},
"ip_reputation_type" : {
"reputation_types" : [ "aeiou" ],
"match_operation" : "aeiou"
},
"microservice" : {
"match_criteria" : "aeiou",
"group_ref" : "aeiou"
},
"vs_port" : {
"match_criteria" : "aeiou",
"ports" : [ "" ]
},
"client_ip" : {
"group_refs" : [ "aeiou" ],
"match_criteria" : "aeiou",
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
}
},
"name" : "aeiou",
"action" : "aeiou",
"index" : 123,
"created_by" : "aeiou",
"age" : 123
} ],
"cloud_config_cksum" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"created_by" : "aeiou",
"uuid" : "aeiou",
"ip_reputation_db_ref" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ]
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
NetworkSecurityPolicyApiResponse
401
log in failed
Up
post /networksecuritypolicy
(networksecuritypolicyPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — NetworkSecurityPolicy object creation
Return type
Example data
Content-Type: application/json
{
"tenant_ref" : "aeiou",
"name" : "aeiou",
"description" : "aeiou",
"rules" : [ {
"rl_param" : {
"burst_size" : 123,
"max_rate" : 123
},
"log" : true,
"enable" : true,
"match" : {
"client_port" : {
"match_criteria" : "aeiou",
"ranges" : [ {
"start" : 123,
"end" : 123
} ],
"ports" : [ "" ]
},
"ip_reputation_type" : {
"reputation_types" : [ "aeiou" ],
"match_operation" : "aeiou"
},
"microservice" : {
"match_criteria" : "aeiou",
"group_ref" : "aeiou"
},
"vs_port" : {
"match_criteria" : "aeiou",
"ports" : [ "" ]
},
"client_ip" : {
"group_refs" : [ "aeiou" ],
"match_criteria" : "aeiou",
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
}
},
"name" : "aeiou",
"action" : "aeiou",
"index" : 123,
"created_by" : "aeiou",
"age" : 123
} ],
"cloud_config_cksum" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"created_by" : "aeiou",
"uuid" : "aeiou",
"ip_reputation_db_ref" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
NetworkSecurityPolicy
401
log in failed
Up
delete /networksecuritypolicy/{uuid}
(networksecuritypolicyUuidDelete)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
object deleted
String
404
not found
Up
get /networksecuritypolicy/{uuid}
(networksecuritypolicyUuidGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"tenant_ref" : "aeiou",
"name" : "aeiou",
"description" : "aeiou",
"rules" : [ {
"rl_param" : {
"burst_size" : 123,
"max_rate" : 123
},
"log" : true,
"enable" : true,
"match" : {
"client_port" : {
"match_criteria" : "aeiou",
"ranges" : [ {
"start" : 123,
"end" : 123
} ],
"ports" : [ "" ]
},
"ip_reputation_type" : {
"reputation_types" : [ "aeiou" ],
"match_operation" : "aeiou"
},
"microservice" : {
"match_criteria" : "aeiou",
"group_ref" : "aeiou"
},
"vs_port" : {
"match_criteria" : "aeiou",
"ports" : [ "" ]
},
"client_ip" : {
"group_refs" : [ "aeiou" ],
"match_criteria" : "aeiou",
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
}
},
"name" : "aeiou",
"action" : "aeiou",
"index" : 123,
"created_by" : "aeiou",
"age" : 123
} ],
"cloud_config_cksum" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"created_by" : "aeiou",
"uuid" : "aeiou",
"ip_reputation_db_ref" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
NetworkSecurityPolicy
401
log in failed
Up
patch /networksecuritypolicy/{uuid}
(networksecuritypolicyUuidPatch)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — NetworkSecurityPolicy object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"tenant_ref" : "aeiou",
"name" : "aeiou",
"description" : "aeiou",
"rules" : [ {
"rl_param" : {
"burst_size" : 123,
"max_rate" : 123
},
"log" : true,
"enable" : true,
"match" : {
"client_port" : {
"match_criteria" : "aeiou",
"ranges" : [ {
"start" : 123,
"end" : 123
} ],
"ports" : [ "" ]
},
"ip_reputation_type" : {
"reputation_types" : [ "aeiou" ],
"match_operation" : "aeiou"
},
"microservice" : {
"match_criteria" : "aeiou",
"group_ref" : "aeiou"
},
"vs_port" : {
"match_criteria" : "aeiou",
"ports" : [ "" ]
},
"client_ip" : {
"group_refs" : [ "aeiou" ],
"match_criteria" : "aeiou",
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
}
},
"name" : "aeiou",
"action" : "aeiou",
"index" : 123,
"created_by" : "aeiou",
"age" : 123
} ],
"cloud_config_cksum" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"created_by" : "aeiou",
"uuid" : "aeiou",
"ip_reputation_db_ref" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
NetworkSecurityPolicy
401
log in failed
Up
put /networksecuritypolicy/{uuid}
(networksecuritypolicyUuidPut)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — NetworkSecurityPolicy object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"tenant_ref" : "aeiou",
"name" : "aeiou",
"description" : "aeiou",
"rules" : [ {
"rl_param" : {
"burst_size" : 123,
"max_rate" : 123
},
"log" : true,
"enable" : true,
"match" : {
"client_port" : {
"match_criteria" : "aeiou",
"ranges" : [ {
"start" : 123,
"end" : 123
} ],
"ports" : [ "" ]
},
"ip_reputation_type" : {
"reputation_types" : [ "aeiou" ],
"match_operation" : "aeiou"
},
"microservice" : {
"match_criteria" : "aeiou",
"group_ref" : "aeiou"
},
"vs_port" : {
"match_criteria" : "aeiou",
"ports" : [ "" ]
},
"client_ip" : {
"group_refs" : [ "aeiou" ],
"match_criteria" : "aeiou",
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
}
},
"name" : "aeiou",
"action" : "aeiou",
"index" : 123,
"created_by" : "aeiou",
"age" : 123
} ],
"cloud_config_cksum" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"created_by" : "aeiou",
"uuid" : "aeiou",
"ip_reputation_db_ref" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
NetworkSecurityPolicy
401
log in failed
[ Jump to Methods ]
Table of Contents
IPReputationTypeMatchIpAddrIpAddrMatchIpAddrPrefixIpAddrRangeKeyValueMicroServiceMatchNetworkSecurityMatchTargetNetworkSecurityPolicyNetworkSecurityPolicyActionRLParamNetworkSecurityPolicyApiResponseNetworkSecurityRulePortMatchPortMatchGenericPortRangeRoleFilterMatchLabel
match_operation
String Match criteria. Enum options - IS_IN, IS_NOT_IN. Field introduced in 20.1.1.
reputation_types (optional)
array[String] IP reputation type. Enum options - IP_REPUTATION_TYPE_SPAM_SOURCE, IP_REPUTATION_TYPE_WINDOWS_EXPLOITS, IP_REPUTATION_TYPE_WEB_ATTACKS, IP_REPUTATION_TYPE_BOTNETS, IP_REPUTATION_TYPE_SCANNERS, IP_REPUTATION_TYPE_DOS, IP_REPUTATION_TYPE_REPUTATION, IP_REPUTATION_TYPE_PHISHING, IP_REPUTATION_TYPE_PROXY, IP_REPUTATION_TYPE_NETWORK, IP_REPUTATION_TYPE_CLOUD, IP_REPUTATION_TYPE_MOBILE_THREATS, IP_REPUTATION_TYPE_TOR, IP_REPUTATION_TYPE_ALL. Field introduced in 20.1.1. Minimum of 1 items required.
addr
type
String Enum options - V4, DNS, V6.
addrs (optional)
group_refs (optional)
array[String] UUID of IP address group(s). It is a reference to an object of type IpAddrGroup.
match_criteria
String Criterion to use for IP address matching the HTTP request. Enum options - IS_IN, IS_NOT_IN.
prefixes (optional)
ranges (optional)
ip_addr
IpAddr Placeholder for description of property ip_addr of obj type IpAddrPrefix field type str type object
mask
Integer Number of mask. format: int32
begin
IpAddr Starting IP address of the range.
end
IpAddr Ending IP address of the range.
group_ref
String UUID of Micro Service group(s). It is a reference to an object of type MicroServiceGroup.
match_criteria
String Criterion to use for Micro Service matching the HTTP request. Enum options - IS_IN, IS_NOT_IN.
client_ip (optional)
IpAddrMatch Placeholder for description of property client_ip of obj type NetworkSecurityMatchTarget field type str type object
client_port (optional)
PortMatchGeneric Matches the source port of incoming packets in the client side traffic. Field introduced in 20.1.3.
ip_reputation_type (optional)
IPReputationTypeMatch Field introduced in 20.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition.
microservice (optional)
MicroServiceMatch Placeholder for description of property microservice of obj type NetworkSecurityMatchTarget field type str type object
vs_port (optional)
PortMatch Placeholder for description of property vs_port of obj type NetworkSecurityMatchTarget field type str type object
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
cloud_config_cksum (optional)
String Checksum of cloud configuration for Network Sec Policy. Internally set by cloud connector.
created_by (optional)
description (optional)
String User defined description for the object.
ip_reputation_db_ref (optional)
String IP reputation database. It is a reference to an object of type IPReputationDB. Field introduced in 20.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition.
labels (optional)
array[KeyValue] Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field deprecated in 20.1.5. Field introduced in 20.1.2. Maximum of 4 items allowed.
markers (optional)
array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Basic edition, Essentials edition, Enterprise edition.
name (optional)
rules (optional)
array[NetworkSecurityRule] Placeholder for description of property rules of obj type NetworkSecurityPolicy field type str type object
tenant_ref (optional)
String It is a reference to an object of type Tenant.
url (optional)
uuid (optional)
String Unique object identifier of the object.
burst_size
Integer Maximum number of connections or requests or packets to be rate limited instantaneously. format: int32
max_rate
Integer Maximum number of connections or requests or packets per second. Allowed values are 1-4294967295. format: int32
count
results
next (optional)
action
String Enum options - NETWORK_SECURITY_POLICY_ACTION_TYPE_ALLOW, NETWORK_SECURITY_POLICY_ACTION_TYPE_DENY, NETWORK_SECURITY_POLICY_ACTION_TYPE_RATE_LIMIT. Allowed in Basic(Allowed values- NETWORK_SECURITY_POLICY_ACTION_TYPE_DENY) edition, Essentials(Allowed values- NETWORK_SECURITY_POLICY_ACTION_TYPE_DENY) edition, Enterprise edition.
age (optional)
Integer Time in minutes after which rule will be deleted. Allowed values are 1-4294967295. Special values are 0- 'blocked for ever'. Unit is MIN. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. format: int32
created_by (optional)
enable
Boolean Placeholder for description of property enable of obj type NetworkSecurityRule field type str type boolean
index
Integer Number of index. format: int32
log (optional)
Boolean Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
match
NetworkSecurityMatchTarget Placeholder for description of property match of obj type NetworkSecurityRule field type str type object
name
rl_param (optional)
match_criteria
String Criterion to use for port matching the HTTP request. Enum options - IS_IN, IS_NOT_IN.
ports (optional)
array[Integer] Listening TCP port(s). Allowed values are 1-65535. Minimum of 1 items required.
match_criteria
String Criterion to use for src/dest port in a TCP/UDP packet. Enum options - IS_IN, IS_NOT_IN. Field introduced in 20.1.3.
ports (optional)
array[Integer] Listening TCP port(s). Allowed values are 1-65535. Field introduced in 20.1.3.
ranges (optional)
array[PortRange] A port range defined by a start and end, including both. Field introduced in 20.1.3.
end
Integer TCP/UDP port range end (inclusive). Allowed values are 1-65535. format: int32
start
Integer TCP/UDP port range start (inclusive). Allowed values are 1-65535. format: int32
key
String Key for filter match. Field introduced in 20.1.3.
values (optional)
array[String] Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3.