Avi L4PolicySet Object API
CLI ``` - configure l4policyset - show l4policyset ```
Version: 22.1.5
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /l4policysetpost /l4policysetdelete /l4policyset/{uuid}get /l4policyset/{uuid}patch /l4policyset/{uuid}put /l4policyset/{uuid}
(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
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",
"configpb_attributes" : {
"version" : 123
},
"description" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"created_by" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
L4PolicySetApiResponse
401
log in failed
(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
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",
"configpb_attributes" : {
"version" : 123
},
"description" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"created_by" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
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 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
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",
"configpb_attributes" : {
"version" : 123
},
"description" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"created_by" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
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
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",
"configpb_attributes" : {
"version" : 123
},
"description" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"created_by" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
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
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",
"configpb_attributes" : {
"version" : 123
},
"description" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"created_by" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
L4PolicySet
401
log in failed
[ Jump to Methods ]
Table of Contents
ConfigPbAttributesIpAddrIpAddrMatchIpAddrPrefixIpAddrRangeKeyValueL4ConnectionPolicyL4PolicySetL4PolicySetApiResponseL4RuleL4RuleActionL4RuleActionSelectPoolL4RuleMatchTargetL4RulePortMatchL4RuleProtocolMatchPortRangeRoleFilterMatchLabel
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
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.
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.
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
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.
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.
rules (optional)
array[L4Rule] Rules to apply when a new transport connection is setup. Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
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. Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
description (optional)
String Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
is_internal_policy (optional)
Boolean Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
l4_connection_policy (optional)
L4ConnectionPolicy Policy to apply when a new transport connection is setup. Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, 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
String Name of the L4 Policy Set. Field introduced in 17.2.7. 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. Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
uuid (optional)
String ID of the L4 Policy Set. Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
count
results
next (optional)
action (optional)
L4RuleAction Action to be performed upon successful rule match. Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enable (optional)
Boolean Enable or disable the rule. Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
index
Integer Index of the rule. Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
match (optional)
L4RuleMatchTarget Match criteria of the rule. Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name
String Name of the rule. Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
select_pool (optional)
L4RuleActionSelectPool Indicates pool or pool-group selection on rule match. Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- L4_RULE_ACTION_SELECT_POOL), Basic edition(Allowed values- L4_RULE_ACTION_SELECT_POOL), Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
client_ip (optional)
IpAddrMatch IP addresses to match against client IP. Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
port (optional)
L4RulePortMatch Port number to match against Virtual Service listner port. Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
protocol (optional)
L4RuleProtocolMatch TCP/UDP/ICMP protocol to match against transport protocol. Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
match_criteria
String Criterion to use for Virtual Service port matching. Enum options - IS_IN, IS_NOT_IN. Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
port_ranges (optional)
array[PortRange] Range of TCP/UDP port numbers of the Virtual Service. Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ports (optional)
array[Integer] Virtual Service's listening port(s). Allowed values are 1-65535. Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
match_criteria
String Criterion to use for transport protocol matching. Enum options - IS_IN, IS_NOT_IN. Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
protocol
String Transport protocol to match. Enum options - PROTOCOL_ICMP, PROTOCOL_TCP, PROTOCOL_UDP, PROTOCOL_SCTP. Field introduced in 17.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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
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.