Avi NetworkSecurityPolicy Object API

##CLI## ``` - configure networksecuritypolicy - show networksecuritypolicy ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /networksecuritypolicy
  2. post /networksecuritypolicy
  3. delete /networksecuritypolicy/{uuid}
  4. get /networksecuritypolicy/{uuid}
  5. patch /networksecuritypolicy/{uuid}
  6. 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.
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
{
  "count" : 123,
  "results" : [ {
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "description" : "aeiou",
    "rules" : [ {
      "rl_param" : {
        "burst_size" : 123,
        "max_rate" : 123
      },
      "log" : true,
      "enable" : true,
      "match" : {
        "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",
    "created_by" : "aeiou",
    "uuid" : "aeiou",
    "url" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept 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

NetworkSecurityPolicy

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" : {
      "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",
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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 Accept 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.
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
{
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "rules" : [ {
    "rl_param" : {
      "burst_size" : 123,
      "max_rate" : 123
    },
    "log" : true,
    "enable" : true,
    "match" : {
      "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",
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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

NetworkSecurityPolicy

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" : {
      "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",
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept 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

NetworkSecurityPolicy

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" : {
      "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",
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK NetworkSecurityPolicy

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. IpAddr
  2. IpAddrMatch
  3. IpAddrPrefix
  4. IpAddrRange
  5. MicroServiceMatch
  6. NetworkSecurityMatchTarget
  7. NetworkSecurityPolicy
  8. NetworkSecurityPolicyActionRLParam
  9. NetworkSecurityPolicyApiResponse
  10. NetworkSecurityRule
  11. PortMatch

IpAddr Up

addr
String IP address.
type
String Enum options - V4, DNS.

IpAddrMatch Up

addrs (optional)
array[IpAddr] IP address(es).
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)
array[IpAddrPrefix] IP address prefix(es).
ranges (optional)
array[IpAddrRange] IP address range(s).

IpAddrPrefix Up

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

IpAddrRange Up

begin
IpAddr Starting IP address of the range.
end
IpAddr Ending IP address of the range.

MicroServiceMatch Up

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.

NetworkSecurityMatchTarget Up

client_ip (optional)
IpAddrMatch Placeholder for description of property client_ip of obj type NetworkSecurityMatchTarget field type str type object
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

NetworkSecurityPolicy Up

cloud_config_cksum (optional)
String Checksum of cloud configuration for Network Sec Policy. Internally set by cloud connector.
created_by (optional)
String Creator name.
description (optional)
String User defined description for the object.
name (optional)
String Name of the object.
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)
String url
uuid (optional)
String Unique object identifier of the object.

NetworkSecurityPolicyActionRLParam Up

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

NetworkSecurityPolicyApiResponse Up

count
Integer format: int32
results

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.
age (optional)
Integer Time in minutes after which rule will be deleted. Allowed values are 1-4294967295. Special values are 0- 'blocked for ever'. format: int32
created_by (optional)
String Creator name.
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 Placeholder for description of property log of obj type NetworkSecurityRule field type str type boolean
match
NetworkSecurityMatchTarget Placeholder for description of property match of obj type NetworkSecurityRule field type str type object
name
String Name of the object.
rl_param (optional)
NetworkSecurityPolicyActionRLParam Placeholder for description of property rl_param of obj type NetworkSecurityRule field type str type object

PortMatch Up

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.