Avi NetworkSecurityPolicy Object API

CLI ``` - configure networksecuritypolicy - show networksecuritypolicy ```

More information: https://avinetworks.com/contact-us

Contact Info: support@avinetworks.com

Version: 22.1.5

BasePath:/api

http://apache.org/licenses/LICENSE-2.0.html

Access

HTTP Basic Authentication

Methods

[ Jump to Models ]

get /networksecuritypolicy
post /networksecuritypolicy
delete /networksecuritypolicy/{uuid}
get /networksecuritypolicy/{uuid}
patch /networksecuritypolicy/{uuid}
put /networksecuritypolicy/{uuid}

get /networksecuritypolicy

(networksecuritypolicyGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

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

NetworkSecurityPolicyApiResponse

Example data

Content-Type: application/json

{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "internal" : true,
    "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" : [ "" ]
        },
        "geo_matches" : [ {
          "match_operation" : "aeiou",
          "values" : [ "aeiou" ],
          "attribute" : "aeiou"
        } ],
        "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
    } ],
    "created_by" : "aeiou",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "geo_db_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "configpb_attributes" : {
      "version" : 123
    },
    "cloud_config_cksum" : "aeiou",
    "markers" : [ {
      "values" : [ "aeiou" ],
      "key" : "aeiou"
    } ],
    "ip_reputation_db_ref" : "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.

application/json

Responses

200

OK NetworkSecurityPolicyApiResponse

401

post /networksecuritypolicy

(networksecuritypolicyPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — NetworkSecurityPolicy object creation

Return type

NetworkSecurityPolicy

Example data

Content-Type: application/json

{
  "internal" : true,
  "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" : [ "" ]
      },
      "geo_matches" : [ {
        "match_operation" : "aeiou",
        "values" : [ "aeiou" ],
        "attribute" : "aeiou"
      } ],
      "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
  } ],
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "geo_db_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "cloud_config_cksum" : "aeiou",
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "ip_reputation_db_ref" : "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.

application/json

Responses

200

OK NetworkSecurityPolicy

401

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:

application/json

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.

application/json

Responses

204

object deleted String

404

not found

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:

application/json

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

NetworkSecurityPolicy

Example data

Content-Type: application/json

{
  "internal" : true,
  "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" : [ "" ]
      },
      "geo_matches" : [ {
        "match_operation" : "aeiou",
        "values" : [ "aeiou" ],
        "attribute" : "aeiou"
      } ],
      "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
  } ],
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "geo_db_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "cloud_config_cksum" : "aeiou",
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "ip_reputation_db_ref" : "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.

application/json

Responses

200

OK NetworkSecurityPolicy

401

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:

application/json

Request body

body (required)

Body Parameter — NetworkSecurityPolicy object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

NetworkSecurityPolicy

Example data

Content-Type: application/json

{
  "internal" : true,
  "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" : [ "" ]
      },
      "geo_matches" : [ {
        "match_operation" : "aeiou",
        "values" : [ "aeiou" ],
        "attribute" : "aeiou"
      } ],
      "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
  } ],
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "geo_db_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "cloud_config_cksum" : "aeiou",
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "ip_reputation_db_ref" : "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.

application/json

Responses

200

OK NetworkSecurityPolicy

401

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:

application/json

Request body

body (required)

Body Parameter — NetworkSecurityPolicy object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

NetworkSecurityPolicy

Example data

Content-Type: application/json

{
  "internal" : true,
  "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" : [ "" ]
      },
      "geo_matches" : [ {
        "match_operation" : "aeiou",
        "values" : [ "aeiou" ],
        "attribute" : "aeiou"
      } ],
      "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
  } ],
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "geo_db_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "cloud_config_cksum" : "aeiou",
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "ip_reputation_db_ref" : "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.

application/json

Responses

200

OK NetworkSecurityPolicy

401

Models

[ Jump to Methods ]

ConfigPbAttributes
GeoMatch
IPReputationTypeMatch
IpAddr
IpAddrMatch
IpAddrPrefix
IpAddrRange
KeyValue
MicroServiceMatch
NetworkSecurityMatchTarget
NetworkSecurityPolicy
NetworkSecurityPolicyActionRLParam
NetworkSecurityPolicyApiResponse
NetworkSecurityRule
PortMatch
PortMatchGeneric
PortRange
RoleFilterMatchLabel

ConfigPbAttributes Up

version (optional)

Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32

GeoMatch Up

attribute

String The Geo data type to match on. Enum options - ATTRIBUTE_IP_PREFIX, ATTRIBUTE_COUNTRY_CODE, ATTRIBUTE_COUNTRY_NAME, ATTRIBUTE_CONTINENT_CODE, ATTRIBUTE_CONTINENT_NAME, ATTRIBUTE_REGION_NAME, ATTRIBUTE_CITY_NAME, ATTRIBUTE_ISP_NAME, ATTRIBUTE_ORGANIZATION_NAME, ATTRIBUTE_AS_NUMBER, ATTRIBUTE_AS_NAME, ATTRIBUTE_LONGITUDE, ATTRIBUTE_LATITUDE, ATTRIBUTE_CUSTOM_1, ATTRIBUTE_CUSTOM_2, ATTRIBUTE_CUSTOM_3, ATTRIBUTE_CUSTOM_4, ATTRIBUTE_CUSTOM_5, ATTRIBUTE_CUSTOM_6, ATTRIBUTE_CUSTOM_7, ATTRIBUTE_CUSTOM_8, ATTRIBUTE_CUSTOM_9, ATTRIBUTE_USER_DEFINED_MAPPING. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

match_operation

String Match criteria. Enum options - IS_IN, IS_NOT_IN. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

values

array[String] The values to match. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

IPReputationTypeMatch Up

match_operation

String Match criteria. Enum options - IS_IN, IS_NOT_IN. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

IpAddr Up

addr

String IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

type

String Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

IpAddrMatch Up

addrs (optional)

array[IpAddr] IP address(es). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

group_refs (optional)

array[String] UUID of IP address group(s). It is a reference to an object of type IpAddrGroup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

match_criteria

String Criterion to use for IP address matching the HTTP request. Enum options - IS_IN, IS_NOT_IN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

prefixes (optional)

array[IpAddrPrefix] IP address prefix(es). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ranges (optional)

array[IpAddrRange] IP address range(s). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

IpAddrPrefix Up

ip_addr

IpAddr Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

mask

Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

IpAddrRange Up

begin

IpAddr Starting IP address of the range. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

end

IpAddr Ending IP address of the range. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

KeyValue Up

key

String Key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

value (optional)

String Value. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

MicroServiceMatch Up

group_ref

String UUID of Micro Service group(s). It is a reference to an object of type MicroServiceGroup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

match_criteria

String Criterion to use for Micro Service matching the HTTP request. Enum options - IS_IN, IS_NOT_IN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

NetworkSecurityMatchTarget Up

client_ip (optional)

IpAddrMatch Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

client_port (optional)

PortMatchGeneric Matches the source port of incoming packets in the client side traffic. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

geo_matches (optional)

array[GeoMatch] Matches the geo information of incoming packets in the client side traffic. Field introduced in 21.1.1. Maximum of 1 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

ip_reputation_type (optional)

IPReputationTypeMatch Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

microservice (optional)

MicroServiceMatch Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

vs_port (optional)

PortMatch Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

NetworkSecurityPolicy Up

_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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

configpb_attributes (optional)

ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

created_by (optional)

String Creator name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

description (optional)

String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

geo_db_ref (optional)

String Geo database. It is a reference to an object of type GeoDB. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

internal (optional)

Boolean Network Security Policy is created and modified by internal modules only. Should not be modified by users. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

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 Enterprise edition with any value, Enterprise with Cloud Services edition.

markers (optional)

array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

name (optional)

String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

rules (optional)

array[NetworkSecurityRule] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

tenant_ref (optional)

String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

url (optional)

String url

uuid (optional)

String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

NetworkSecurityPolicyActionRLParam Up

burst_size

Integer Maximum number of connections or requests or packets to be rate limited instantaneously. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

max_rate

Integer Maximum number of connections or requests or packets per second. Allowed values are 1-4294967295. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

NetworkSecurityPolicyApiResponse Up

count

Integer format: int32

results

array[NetworkSecurityPolicy]

next (optional)

String

NetworkSecurityRule Up

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 Enterprise edition with any value, Essentials edition(Allowed values- NETWORK_SECURITY_POLICY_ACTION_TYPE_DENY), Basic edition(Allowed values- NETWORK_SECURITY_POLICY_ACTION_TYPE_DENY), Enterprise with Cloud Services 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 Enterprise edition with any value, Essentials edition(Allowed values- 0), Basic edition(Allowed values- 0), Enterprise with Cloud Services edition. format: int32

created_by (optional)

String Creator name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

enable

Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

index

Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

log (optional)

Boolean Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

match

NetworkSecurityMatchTarget Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

name

String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

rl_param (optional)

NetworkSecurityPolicyActionRLParam Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

PortMatch Up

match_criteria

String Criterion to use for port matching the HTTP request. Enum options - IS_IN, IS_NOT_IN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ports (optional)

array[Integer] Listening TCP port(s). Allowed values are 1-65535. Minimum of 1 items required. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

PortMatchGeneric Up

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. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

ports (optional)

array[Integer] Listening TCP port(s). Allowed values are 1-65535. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

ranges (optional)

array[PortRange] A port range defined by a start and end, including both. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

PortRange Up

end

Integer TCP/UDP port range end (inclusive). Allowed values are 1-65535. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

start

Integer TCP/UDP port range start (inclusive). Allowed values are 1-65535. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

RoleFilterMatchLabel Up

key

String Key for filter match. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

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. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

Avi NetworkSecurityPolicy Object API

Access

Table of Contents

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Request body

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

204

404

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Table of Contents