Avi L4PolicySet Object API

CLI ``` - configure l4policyset - show l4policyset ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 20.1.2
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 /l4policyset
  2. post /l4policyset
  3. delete /l4policyset/{uuid}
  4. get /l4policyset/{uuid}
  5. patch /l4policyset/{uuid}
  6. put /l4policyset/{uuid}
Up
get /l4policyset
(l4policysetGet)

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

L4PolicySetApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "l4_connection_policy" : {
      "rules" : [ {
        "enable" : true,
        "match" : {
          "protocol" : {
            "match_criteria" : "aeiou",
            "protocol" : "aeiou"
          },
          "port" : {
            "match_criteria" : "aeiou",
            "ports" : [ "" ],
            "port_ranges" : [ {
              "start" : 123,
              "end" : 123
            } ]
          },
          "client_ip" : {
            "group_refs" : [ "aeiou" ],
            "match_criteria" : "aeiou",
            "prefixes" : [ {
              "ip_addr" : "",
              "mask" : 123
            } ],
            "ranges" : [ {
              "end" : "",
              "begin" : ""
            } ],
            "addrs" : [ {
              "addr" : "aeiou",
              "type" : "aeiou"
            } ]
          }
        },
        "name" : "aeiou",
        "action" : {
          "select_pool" : {
            "pool_ref" : "aeiou",
            "action_type" : "aeiou",
            "pool_group_ref" : "aeiou"
          }
        },
        "index" : 123
      } ]
    },
    "tenant_ref" : "aeiou",
    "is_internal_policy" : true,
    "name" : "aeiou",
    "description" : "aeiou",
    "created_by" : "aeiou",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "labels" : [ {
      "value" : "aeiou",
      "key" : "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 L4PolicySetApiResponse

401

log in failed

Up
post /l4policyset
(l4policysetPost)

Consumes

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

Request body

body (required)
Body Parameter — L4PolicySet object creation

Return type

L4PolicySet

Example data

Content-Type: application/json
{
  "l4_connection_policy" : {
    "rules" : [ {
      "enable" : true,
      "match" : {
        "protocol" : {
          "match_criteria" : "aeiou",
          "protocol" : "aeiou"
        },
        "port" : {
          "match_criteria" : "aeiou",
          "ports" : [ "" ],
          "port_ranges" : [ {
            "start" : 123,
            "end" : 123
          } ]
        },
        "client_ip" : {
          "group_refs" : [ "aeiou" ],
          "match_criteria" : "aeiou",
          "prefixes" : [ {
            "ip_addr" : "",
            "mask" : 123
          } ],
          "ranges" : [ {
            "end" : "",
            "begin" : ""
          } ],
          "addrs" : [ {
            "addr" : "aeiou",
            "type" : "aeiou"
          } ]
        }
      },
      "name" : "aeiou",
      "action" : {
        "select_pool" : {
          "pool_ref" : "aeiou",
          "action_type" : "aeiou",
          "pool_group_ref" : "aeiou"
        }
      },
      "index" : 123
    } ]
  },
  "tenant_ref" : "aeiou",
  "is_internal_policy" : true,
  "name" : "aeiou",
  "description" : "aeiou",
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "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 L4PolicySet

401

log in failed

Up
delete /l4policyset/{uuid}
(l4policysetUuidDelete)

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 /l4policyset/{uuid}
(l4policysetUuidGet)

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

L4PolicySet

Example data

Content-Type: application/json
{
  "l4_connection_policy" : {
    "rules" : [ {
      "enable" : true,
      "match" : {
        "protocol" : {
          "match_criteria" : "aeiou",
          "protocol" : "aeiou"
        },
        "port" : {
          "match_criteria" : "aeiou",
          "ports" : [ "" ],
          "port_ranges" : [ {
            "start" : 123,
            "end" : 123
          } ]
        },
        "client_ip" : {
          "group_refs" : [ "aeiou" ],
          "match_criteria" : "aeiou",
          "prefixes" : [ {
            "ip_addr" : "",
            "mask" : 123
          } ],
          "ranges" : [ {
            "end" : "",
            "begin" : ""
          } ],
          "addrs" : [ {
            "addr" : "aeiou",
            "type" : "aeiou"
          } ]
        }
      },
      "name" : "aeiou",
      "action" : {
        "select_pool" : {
          "pool_ref" : "aeiou",
          "action_type" : "aeiou",
          "pool_group_ref" : "aeiou"
        }
      },
      "index" : 123
    } ]
  },
  "tenant_ref" : "aeiou",
  "is_internal_policy" : true,
  "name" : "aeiou",
  "description" : "aeiou",
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "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 L4PolicySet

401

log in failed

Up
patch /l4policyset/{uuid}
(l4policysetUuidPatch)

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 — L4PolicySet object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

L4PolicySet

Example data

Content-Type: application/json
{
  "l4_connection_policy" : {
    "rules" : [ {
      "enable" : true,
      "match" : {
        "protocol" : {
          "match_criteria" : "aeiou",
          "protocol" : "aeiou"
        },
        "port" : {
          "match_criteria" : "aeiou",
          "ports" : [ "" ],
          "port_ranges" : [ {
            "start" : 123,
            "end" : 123
          } ]
        },
        "client_ip" : {
          "group_refs" : [ "aeiou" ],
          "match_criteria" : "aeiou",
          "prefixes" : [ {
            "ip_addr" : "",
            "mask" : 123
          } ],
          "ranges" : [ {
            "end" : "",
            "begin" : ""
          } ],
          "addrs" : [ {
            "addr" : "aeiou",
            "type" : "aeiou"
          } ]
        }
      },
      "name" : "aeiou",
      "action" : {
        "select_pool" : {
          "pool_ref" : "aeiou",
          "action_type" : "aeiou",
          "pool_group_ref" : "aeiou"
        }
      },
      "index" : 123
    } ]
  },
  "tenant_ref" : "aeiou",
  "is_internal_policy" : true,
  "name" : "aeiou",
  "description" : "aeiou",
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "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 L4PolicySet

401

log in failed

Up
put /l4policyset/{uuid}
(l4policysetUuidPut)

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 — L4PolicySet object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

L4PolicySet

Example data

Content-Type: application/json
{
  "l4_connection_policy" : {
    "rules" : [ {
      "enable" : true,
      "match" : {
        "protocol" : {
          "match_criteria" : "aeiou",
          "protocol" : "aeiou"
        },
        "port" : {
          "match_criteria" : "aeiou",
          "ports" : [ "" ],
          "port_ranges" : [ {
            "start" : 123,
            "end" : 123
          } ]
        },
        "client_ip" : {
          "group_refs" : [ "aeiou" ],
          "match_criteria" : "aeiou",
          "prefixes" : [ {
            "ip_addr" : "",
            "mask" : 123
          } ],
          "ranges" : [ {
            "end" : "",
            "begin" : ""
          } ],
          "addrs" : [ {
            "addr" : "aeiou",
            "type" : "aeiou"
          } ]
        }
      },
      "name" : "aeiou",
      "action" : {
        "select_pool" : {
          "pool_ref" : "aeiou",
          "action_type" : "aeiou",
          "pool_group_ref" : "aeiou"
        }
      },
      "index" : 123
    } ]
  },
  "tenant_ref" : "aeiou",
  "is_internal_policy" : true,
  "name" : "aeiou",
  "description" : "aeiou",
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "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 L4PolicySet

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. IpAddr
  2. IpAddrMatch
  3. IpAddrPrefix
  4. IpAddrRange
  5. KeyValue
  6. L4ConnectionPolicy
  7. L4PolicySet
  8. L4PolicySetApiResponse
  9. L4Rule
  10. L4RuleAction
  11. L4RuleActionSelectPool
  12. L4RuleMatchTarget
  13. L4RulePortMatch
  14. L4RuleProtocolMatch
  15. PortRange

IpAddr Up

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

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.

KeyValue Up

key
String Key.
value (optional)
String Value.

L4ConnectionPolicy Up

rules (optional)
array[L4Rule] Rules to apply when a new transport connection is setup. Field introduced in 17.2.7.

L4PolicySet Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
created_by (optional)
String Creator name. Field introduced in 17.2.7.
description (optional)
String Field introduced in 17.2.7.
is_internal_policy (optional)
Boolean Field introduced in 17.2.7.
l4_connection_policy (optional)
L4ConnectionPolicy Policy to apply when a new transport connection is setup. Field introduced in 17.2.7.
labels (optional)
array[KeyValue] Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2.
name
String Name of the L4 Policy Set. Field introduced in 17.2.7.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Field introduced in 17.2.7.
url (optional)
String url
uuid (optional)
String ID of the L4 Policy Set. Field introduced in 17.2.7.

L4PolicySetApiResponse Up

count
Integer format: int32
results
next (optional)

L4Rule Up

action (optional)
L4RuleAction Action to be performed upon successful rule match. Field introduced in 17.2.7.
enable (optional)
Boolean Enable or disable the rule. Field introduced in 17.2.7.
index
Integer Index of the rule. Field introduced in 17.2.7. format: int32
match (optional)
L4RuleMatchTarget Match criteria of the rule. Field introduced in 17.2.7.
name
String Name of the rule. Field introduced in 17.2.7.

L4RuleAction Up

select_pool (optional)
L4RuleActionSelectPool Indicates pool or pool-group selection on rule match. Field introduced in 17.2.7.

L4RuleActionSelectPool Up

action_type
String Indicates action to take on rule match. Enum options - L4_RULE_ACTION_SELECT_POOL, L4_RULE_ACTION_SELECT_POOLGROUP. Field introduced in 17.2.7.
pool_group_ref (optional)
String ID of the pool group to serve the request. It is a reference to an object of type PoolGroup. Field introduced in 17.2.7.
pool_ref (optional)
String ID of the pool of servers to serve the request. It is a reference to an object of type Pool. Field introduced in 17.2.7.

L4RuleMatchTarget Up

client_ip (optional)
IpAddrMatch IP addresses to match against client IP. Field introduced in 17.2.7.
port (optional)
L4RulePortMatch Port number to match against Virtual Service listner port. Field introduced in 17.2.7.
protocol (optional)
L4RuleProtocolMatch TCP/UDP/ICMP protocol to match against transport protocol. Field introduced in 17.2.7.

L4RulePortMatch Up

match_criteria
String Criterion to use for Virtual Service port matching. Enum options - IS_IN, IS_NOT_IN. Field introduced in 17.2.7.
port_ranges (optional)
array[PortRange] Range of TCP/UDP port numbers of the Virtual Service. Field introduced in 17.2.7.
ports (optional)
array[Integer] Virtual Service's listening port(s). Allowed values are 1-65535. Field introduced in 17.2.7.

L4RuleProtocolMatch Up

match_criteria
String Criterion to use for transport protocol matching. Enum options - IS_IN, IS_NOT_IN. Field introduced in 17.2.7.
protocol
String Transport protocol to match. Enum options - PROTOCOL_ICMP, PROTOCOL_TCP, PROTOCOL_UDP. Field introduced in 17.2.7.

PortRange Up

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