Module avi

AVI load balancer controler

• License: Inmanta EULA

• Version: 0.1.2

Entities

entity avi::ServiceEngineGroup

Parents: avi::base::Resource

attribute string? _last_modified=null

UNIX time since epoch in microseconds. Units(MICROSECONDS).

attribute bool? accelerated_networking=null

Enable accelerated networking option for Azure SE. Accelerated networking enables single root I/O virtualization (SR-IOV) to a SE VM. This improves networking performance. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? active_standby=null

Service Engines in active/standby mode for HA failover. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? aggressive_failure_detection=null

Enable aggressive failover configuration for ha. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- false), Basic (Allowed values- false) edition.

attribute string? algo=null

In compact placement, Virtual Services are placed on existing SEs until max_vs_per_se limit is reached. In distributed placement, Virtual Services are placed on new SEs until max_se limit is reached. Once this limit is reached, Virtual Services are placed on SEs with least load. Enum options - PLACEMENT_ALGO_PACKED, PLACEMENT_ALGO_DISTRIBUTED. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? allow_burst=null

Allow SEs to be created using burst license. Field introduced in 17.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? app_cache_percent=null

A percent value of total SE memory reserved for applicationcaching. This is an SE bootup property and requires SE restart.Requires SE Reboot. Allowed values are 0 - 100. Special values are 0- disable. Field introduced in 18.2.3. Unit is PERCENT. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- 0), Basic (Allowed values- 0) edition. Special default for Essentials edition is 0, Basic edition is 0, Enterprise edition is 10.

attribute int? app_cache_threshold=null

The max memory that can be allocated for the app cache. This value will act as an upper bound on the cache size specified in app_cache_percent. Special values are 0- disable. Field introduced in 20.1.1. Unit is GB. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? app_learning_memory_percent=null

A percent value of total SE memory reserved for Application learning. This is an SE bootup property and requires SE restart. Allowed values are 0 - 10. Field introduced in 18.2.3. Unit is PERCENT. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? archive_shm_limit=null

Amount of SE memory in GB until which shared memory is collected in core archive. Field introduced in 17.1.3. Unit is GB. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? arp_cache_timeout=null

Timeout in seconds for idle ARP entries. Allowed values are 0-86400. Field introduced in 31.2.1. Unit is SEC. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? async_ssl=null

SSL handshakes will be handled by dedicated SSL Threads.Requires SE Reboot. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- false), Basic (Allowed values- false) edition.

attribute int? async_ssl_threads=null

Number of Async SSL threads per se_dp.Requires SE Reboot. Allowed values are 1-16. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? auto_rebalance=null

If set, Virtual Services will be automatically migrated when load on an SE is less than minimum or more than maximum thresholds. Only Alerts are generated when the auto_rebalance is not set. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- false), Basic (Allowed values- false) edition.

attribute int[]? auto_rebalance_capacity_per_se=null

attribute int? auto_rebalance_cool_down_time=null

The time in minutes controller waits before rebalancing the Vs again after a scalein/scaleout. Field introduced in 31.2.1. Unit is MIN. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string[]? auto_rebalance_criteria=null

attribute bool? auto_rebalance_dry_run_enabled=null

If enabled, the controller will not perform the rebalance actions.It will only generate the actions and update that in the debug api.This is useful for testing the rebalance logic without actually performing the actions. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? auto_rebalance_interval=null

Frequency of rebalance, if ‘Auto rebalance’ is enabled. Unit is SEC. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? auto_rebalance_raise_events_for_actions=null

If enabled, the controller will raise events for rebalance actions. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? auto_redistribute_active_standby_load=null

Redistribution of virtual services from the takeover SE to the replacement SE can cause momentary traffic loss. If the auto-redistribute load option is left in its default off state, any desired rebalancing requires calls to REST API. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- false), Basic (Allowed values- false) edition.

attribute string[]? availability_zone_refs=null

attribute bool? baremetal_dispatcher_handles_flows=null

Control if dispatcher core also handles TCP flows in baremetal SE. Field introduced in 21.1.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? bgp_peer_monitor_failover_enabled=null

Enable BGP peer monitoring based failover. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? bgp_state_update_interval=null

BGP peer state update interval. Allowed values are 5-100. Field introduced in 17.2.14,18.1.5,18.2.1. Unit is SEC. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? buffer_se=null

Excess Service Engine capacity provisioned for HA failover. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? cloud_ref=null

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

attribute bool? compress_ip_rules_for_each_ns_subnet=null

Compress IP rules into a single subnet based IP rule for each north-south IPAM subnet configured in PCAP mode in OpenShift/Kubernetes node. Field introduced in 18.2.9, 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? config_debugs_on_all_cores=null

Enable config debugs on all cores of SE. Field introduced in 17.2.13,18.1.5,18.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? connection_memory_percentage=null

Percentage of memory for connection state. This will come at the expense of memory used for HTTP in-memory cache. Allowed values are 10-90. Unit is PERCENT. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? core_shm_app_cache=null

Include shared memory for app cache in core file.Requires SE Reboot. Field introduced in 18.2.8, 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? core_shm_app_learning=null

Include shared memory for app learning in core file.Requires SE Reboot. Field introduced in 18.2.8, 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? cpu_reserve=null

Set CPU shares for Service Engine Virtual Machines to High. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? cpu_socket_affinity=null

Allocate all the CPU cores for the Service Engine Virtual Machines on the same CPU socket. Applicable only for vCenter Cloud. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string[]? custom_securitygroups_data=null

attribute string[]? custom_securitygroups_mgmt=null

attribute string? data_network_id=null

Subnet used to spin up the data nic for Service Engines, used only for Azure cloud. Overrides the cloud level setting for Service Engine subnet. Field introduced in 18.2.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? datascript_timeout=null

Number of instructions before datascript times out. Allowed values are 0-100000000. Field introduced in 18.2.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? deactivate_ipv6_discovery=null

If activated, IPv6 address and route discovery are deactivated.Requires SE reboot. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? deactivate_kni_filtering_at_dispatcher=null

Deactivate filtering of packets to KNI interface. To be used under surveillance of Avi Support. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? dedicated_dispatcher_core=null

Dedicate the core that handles packet receive/transmit from the network to just the dispatching function. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? description=null

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

attribute bool? disable_avi_securitygroups=null

By default, Avi creates and manages security groups along with custom sg provided by user. Set this to True to disallow Avi to create and manage new security groups. Avi will only make use of custom security groups provided by user. This option is supported for AWS and OpenStack cloud types. Field introduced in 17.2.13,18.1.4,18.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? disable_csum_offloads=null

Stop using TCP/UDP and IP checksum offload features of NICs. Field introduced in 17.1.14, 17.2.5, 18.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? disable_flow_probes=null

Disable Flow Probes for Scaled out VS’es. Field introduced in 20.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? disable_gro=null

Disable Generic Receive Offload (GRO) in DPDK poll-mode driver packet receive path. GRO can be enabled on NICs that do not support LRO (Large Receive Offload) or do not gain performance boost from LRO. GRO is on by default on NICs in a system with 8 vCPUs or higher. Field introduced in 17.2.5, 18.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? disable_qat_bulk_crypto=null

This knob enables the QAT offloads for TLS application data. (if the host CPU is capable, and the QAT device is exposed). Requires SE Reboot. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? disable_se_memory_check=null

If set, disable the config memory check done in service engine. Field introduced in 18.1.2. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? disable_tso=null

Disable TCP Segmentation Offload (TSO) in DPDK poll-mode driver packet transmit path. TSO is on by default on NICs that support it. Field introduced in 17.2.5, 18.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? disk_per_se=null

Amount of disk space for each of the Service Engine virtual machines. Unit is GB. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? distribute_load_active_standby=null

Use both the active and standby Service Engines for Virtual Service placement in the legacy active standby HA mode. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- false), Basic (Allowed values- false) edition.

attribute bool? distribute_queues=null

Distributes queue ownership among cores so multiple cores handle dispatcher duties. Requires SE Reboot. Deprecated from 18.2.8, instead use max_queues_per_vnic. Field introduced in 17.2.8. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- false), Basic (Allowed values- false) edition.

attribute bool? distribute_vnics=null

Distributes vnic ownership among cores so multiple cores handle dispatcher duties.Requires SE Reboot. Field introduced in 18.2.5. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- false), Basic (Allowed values- false) edition.

attribute int? downstream_send_timeout=null

Timeout for downstream to become writable. Field introduced in 21.1.1. Unit is MILLISECONDS. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? dp_aggressive_deq_interval_msec=null

Dequeue interval for receive queue from se_dp in aggressive mode. Allowed values are 1-1000. Field introduced in 21.1.1. Unit is MILLISECONDS. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? dp_aggressive_enq_interval_msec=null

Enqueue interval for request queue to se_dp in aggressive mode. Allowed values are 1-1000. Field introduced in 21.1.1. Unit is MILLISECONDS. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? dp_aggressive_hb_frequency=null

Frequency of SE - SE HB messages when aggressive failure mode detection is enabled. Field introduced in 20.1.3. Unit is MILLISECONDS. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? dp_aggressive_hb_timeout_count=null

Consecutive HB failures after which failure is reported to controller,when aggressive failure mode detection is enabled. Field introduced in 20.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? dp_deq_interval_msec=null

Dequeue interval for receive queue from se_dp. Allowed values are 1-1000. Field introduced in 21.1.1. Unit is MILLISECONDS. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? dp_enq_interval_msec=null

Enqueue interval for request queue to se_dp. Allowed values are 1-1000. Field introduced in 21.1.1. Unit is MILLISECONDS. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? dp_hb_frequency=null

Frequency of SE - SE HB messages when aggressive failure mode detection is not enabled. Field introduced in 20.1.3. Unit is MILLISECONDS. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? dp_hb_timeout_count=null

Consecutive HB failures after which failure is reported to controller, when aggressive failure mode detection is not enabled. Field introduced in 20.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? dpdk_gro_timeout_interval=null

The timeout for GRO coalescing interval. 0 indicates non-timer based GRO. Allowed values are 0-900. Field introduced in 22.1.1. Unit is MICROSECONDS. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? enable_gratarp_permanent=null

Enable GratArp for VIP_IP. Field introduced in 18.2.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? enable_hsm_log=null

Enable HSM luna engine logs. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? enable_hsm_priming=null

(This is a beta feature). Enable HSM key priming. If enabled, key handles on the hsm will be synced to SE before processing client connections. Field introduced in 17.2.7, 18.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? enable_multi_lb=null

Applicable only for Azure cloud with Basic SKU LB. If set, additional Azure LBs will be automatically created if resources in existing LB are exhausted. Field introduced in 17.2.10, 18.1.2. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? enable_pcap_tx_ring=null

Enable TX ring support in pcap mode of operation. TSO feature is not supported with TX Ring enabled. Deprecated from 18.2.8, instead use pcap_tx_mode. Requires SE Reboot. Field introduced in 18.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? enable_qat=null

This knob enables the Service Engine to use QAT offloads (if the host CPU is capable, and the QAT device is exposed). Requires SE Reboot. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? ephemeral_portrange_end=null

End local ephemeral port number for outbound connections. Field introduced in 17.2.13, 18.1.5, 18.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? ephemeral_portrange_start=null

Start local ephemeral port number for outbound connections. Field introduced in 17.2.13, 18.1.5, 18.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute float? extra_config_multiplier=null

Multiplier for extra config to support large VS/Pool config. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? extra_shared_config_memory=null

Extra config memory to support large Geo DB configuration. Field introduced in 17.1.1. Unit is MB. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? flow_table_new_syn_max_entries=null

Maximum number of flow table entries that have not completed TCP three-way handshake yet. Field introduced in 17.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? free_list_size=null

Number of entries in the free list. Field introduced in 17.2.10, 18.1.2. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? gratarp_permanent_periodicity=null

GratArp periodicity for VIP-IP. Allowed values are 5-30. Field introduced in 18.2.3. Unit is MIN. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? grpc_channel_connect_timeout=null

Timeout in seconds that SE waits for a grpc channel to connect to server, before it retries. Allowed values are 5-45. Field introduced in 22.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? gve_enabled=null

Deploys Google Virtual Ethernet (gve) - gVNIC for all supported intances types in GCP. Applies only to newly created SE’s. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string? ha_mode=null

High Availability mode for all the Virtual Services using this Service Engine group. Enum options - HA_MODE_SHARED_PAIR, HA_MODE_SHARED, HA_MODE_LEGACY_ACTIVE_STANDBY. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- HA_MODE_LEGACY_ACTIVE_STANDBY), Basic (Allowed values- HA_MODE_LEGACY_ACTIVE_STANDBY) edition. Special default for Essentials edition is HA_MODE_LEGACY_ACTIVE_STANDBY, Basic edition is HA_MODE_LEGACY_ACTIVE_STANDBY, Enterprise edition is HA_MODE_SHARED.

attribute bool? handle_per_pkt_attack=null

Configuration to handle per packet attack handling.For example, DNS Reflection Attack is a type of attack where a response packet is sent to the DNS VS.This configuration tells if such packets should be dropped without further processing. Field introduced in 20.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string? hardwaresecuritymodulegroup_ref=null

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

attribute int? heap_minimum_config_memory=null

Minimum required heap memory to apply any configuration. Allowed values are 0-100. Field introduced in 18.1.2. Unit is MB. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? hm_on_standby=null

Enable active health monitoring from the standby SE for all placed virtual services. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- false), Basic (Allowed values- false) edition. Special default for Essentials edition is false, Basic edition is false, Enterprise edition is True.

attribute string? host_attribute_key=null

Key of a (Key, Value) pair identifying a label for a set of Nodes usually in Container Clouds. Needs to be specified together with host_attribute_value. SEs can be configured differently including HA modes across different SE Groups. May also be used for isolation between different classes of VirtualServices. VirtualServices’ SE Group may be specified via annotations/labels. A OpenShift/Kubernetes namespace maybe annotated with a matching SE Group label as openshift.io/node-selector apptype=prod. When multiple SE Groups are used in a Cloud with host attributes specified,just a single SE Group can exist as a match-all SE Group without a host_attribute_key. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? host_attribute_value=null

Value of a (Key, Value) pair identifying a label for a set of Nodes usually in Container Clouds. Needs to be specified together with host_attribute_key. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? host_gateway_monitor=null

Enable the host gateway monitor when service engine is deployed as docker container. Disabled by default. Field introduced in 17.2.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? http_rum_console_log=null

Enable Javascript console logs on the client browser when collecting client insights. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- false), Basic (Allowed values- false) edition.

attribute int? http_rum_min_content_length=null

Minimum response size content length to sample for client insights. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- 64), Basic (Allowed values- 64) edition.

attribute bool? hybrid_rss_mode=null

Toggles SE hybrid only mode of operation in DPDK mode with RSS configured;where-in each SE datapath instance operates as a standalone hybrid instance performing both dispatcher and proxy function. Requires reboot. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string? hypervisor=null

Override default hypervisor. Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? ignore_docker_mac_change=null

Ignore docker mac change. Field introduced in 21.1.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? ignore_rtt_threshold=null

Ignore RTT samples if it is above threshold. Field introduced in 17.1.6,17.2.2. Unit is MILLISECONDS. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? ingress_access_data=null

Program SE security group ingress rules to allow VIP data access from remote CIDR type. Enum options - SG_INGRESS_ACCESS_NONE, SG_INGRESS_ACCESS_ALL, SG_INGRESS_ACCESS_VPC. Field introduced in 17.1.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? ingress_access_mgmt=null

Program SE security group ingress rules to allow SSH/ICMP management access from remote CIDR type. Enum options - SG_INGRESS_ACCESS_NONE, SG_INGRESS_ACCESS_ALL, SG_INGRESS_ACCESS_VPC. Field introduced in 17.1.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? instance_flavor=null

Instance/Flavor name for SE instance. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? kv_val_max_len=null

Max length allowed for the value in a KV pair. Allowed values are 128,256,512,1024,2048,4096,8192. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? l7_conns_per_core=null

Number of L7 connections that can be cached per core. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? l7_resvd_listen_conns_per_core=null

Number of reserved L7 listener connections per core. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? lbaction_num_requests_to_dispatch=null

Number of requests to dispatch from the request. queue at a regular interval. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? lbaction_rq_per_request_max_retries=null

Maximum retries per request in the request queue. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? least_load_core_selection=null

Select core with least load for new flow. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? license_tier=null

Specifies the license tier which would be used. This field by default inherits the value from cloud. Enum options - ENTERPRISE_16, ENTERPRISE, ENTERPRISE_18, BASIC, ESSENTIALS, ENTERPRISE_WITH_CLOUD_SERVICES. Field introduced in 17.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? license_type=null

If no license type is specified then default license enforcement for the cloud type is chosen. Enum options - LIC_BACKEND_SERVERS, LIC_SOCKETS, LIC_CORES, LIC_HOSTS, LIC_SE_BANDWIDTH, LIC_METERED_SE_BANDWIDTH. Field introduced in 17.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? log_agent_compress_logs=null

Flag to indicate if log files are compressed upon full on the Service Engine. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? log_agent_debug_enabled=null

Enable debug logs by default on Service Engine. This includes all other debugging logs. Debug logs can also be explcitly enabled from the CLI shell. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? log_agent_file_sz_appl=null

Maximum application log file size before rollover. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? log_agent_file_sz_conn=null

Maximum connection log file size before rollover. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? log_agent_file_sz_debug=null

Maximum debug log file size before rollover. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? log_agent_file_sz_event=null

Maximum event log file size before rollover. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? log_agent_log_storage_min_sz=null

Minimum storage allocated for logs irrespective of memory and cores. Field introduced in 21.1.1. Unit is MB. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? log_agent_max_concurrent_rsync=null

Maximum concurrent rsync requests initiated from log-agent to the Controller. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? log_agent_max_storage_excess_percent=null

Excess percentage threshold of disk size to trigger cleanup of logs on the Service Engine. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute float? log_agent_max_storage_ignore_percent=null

Maximum storage on the disk not allocated for logs on the Service Engine. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? log_agent_min_storage_per_vs=null

Minimum storage allocated to any given VirtualService on the Service Engine. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? log_agent_sleep_interval=null

Internal timer to stall log-agent and prevent it from hogging CPU cycles on the Service Engine. Field introduced in 21.1.1. Unit is MILLISECONDS. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? log_agent_trace_enabled=null

Enable trace logs by default on Service Engine. Configuration operations are logged along with other important logs by Service Engine. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? log_agent_unknown_vs_timer=null

Timeout to purge unknown Virtual Service logs from the Service Engine. Field introduced in 21.1.1. Unit is SEC. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? log_disksz=null

Maximum disk capacity (in MB) to be allocated to an SE. This is exclusively used for debug and log data. Unit is MB. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? log_malloc_failure=null

SE will log memory allocation related failure to the se_trace file, wherever available. Field introduced in 20.1.2. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- true), Basic (Allowed values- true) edition.

attribute int? log_message_max_file_list_size=null

Maximum number of file names in a log message. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? max_concurrent_external_hm=null

Maximum number of external health monitors that can run concurrently in a service engine. This helps control the CPU and memory use by external health monitors. Special values are 0- Value will be internally calculated based on cpu and memory. Field introduced in 18.2.7. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? max_cpu_load_adaptive_sampling=null

When adaptive sampling is enabled, specifies the max CPU load allowed for adaptive sampling. If the CPU load exceeds this value, no requests will be sampled. Allowed values are 1-100. Field introduced in 31.2.1. Unit is PERCENT. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? max_cpu_usage=null

When CPU usage on an SE exceeds this threshold, Virtual Services hosted on this SE may be rebalanced to other SEs to reduce load. A new SE may be created as part of this process. Allowed values are 40-90. Unit is PERCENT. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? max_memory_per_mempool=null

Max bytes that can be allocated in a single mempool. Field introduced in 18.1.5. Unit is MB. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? max_num_http_sessions_to_store=null

Maximum number of HTTP session that will be created. Each session uses about 1kB in the key-value storage in shared memory. Setting this value too high can lead to exhaustion of shared memory and affect services. Allowed values are 1-2000000. Field introduced in 30.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? max_num_se_dps=null

Configures the maximum number of se_dp processes that handles traffic. If not configured, defaults to the number of CPUs on the SE. If decreased, it will only take effect after SE reboot. Allowed values are 1-128. Field introduced in 20.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- 0), Basic (Allowed values- 0) edition.

attribute int? max_public_ips_per_lb=null

Applicable to Azure platform only. Maximum number of public IPs per Azure LB. . Field introduced in 17.2.12, 18.1.2. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? max_queues_per_vnic=null

Maximum number of queues per vnic Setting to ‘0’ utilises all queues that are distributed across dispatcher cores. Allowed values are 0,1,2,4,8,16. Field introduced in 18.2.7, 20.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- 1), Basic (Allowed values- 1) edition.

attribute int? max_rules_per_lb=null

Applicable to Azure platform only. Maximum number of rules per Azure LB. . Field introduced in 17.2.12, 18.1.2. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? max_scaleout_per_vs=null

Maximum number of active Service Engines for the Virtual Service. Allowed values are 1-64. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? max_se=null

Maximum number of Services Engines in this group. Allowed values are 0-1000. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? max_skb_frags=null

Maximum of number of 4 KB pages allocated to the Linux kernel GRO subsystem for packet coalescing. This parameter is limited to supported kernels only. Requires SE Reboot. Allowed values are 1-17. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? max_vs_per_se=null

Maximum number of Virtual Services that can be placed on a single Service Engine. Allowed values are 1-1000. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? mem_reserve=null

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

attribute int? memory_for_config_update=null

Indicates the percent of memory reserved for config updates. Allowed values are 0-100. Field introduced in 18.1.2. Unit is PERCENT. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? memory_per_se=null

Amount of memory for each of the Service Engine virtual machines. Changes to this setting do not affect existing SEs. Allowed values are 2048-262144. Unit is MB. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? metrics_collection_mode=null

Metrics collection mode, 0 = Pull mode. se_agent pulls metrics from se_dp, 1 = Push mode. se_dp pushes metrics to se_agent. 9 = special value to reset collection state in push mode. . Allowed values are 0-1. Special values are 9- Reset metrics collection state. Field introduced in 30.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string? mgmt_network_ref=null

Management network to use for Avi Service Engines. It is a reference to an object of type Network. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? min_cpu_usage=null

When CPU usage on an SE falls below the minimum threshold, Virtual Services hosted on the SE may be consolidated onto other underutilized SEs. After consolidation, unused Service Engines may then be eligible for deletion. . Allowed values are 20-60. Unit is PERCENT. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? min_scaleout_per_vs=null

Minimum number of active Service Engines for the Virtual Service. Allowed values are 1-64. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? min_se=null

Minimum number of Services Engines in this group (relevant for SE AutoRebalance only). Allowed values are 0-1000. Field introduced in 17.2.13,18.1.3,18.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? minimum_connection_memory=null

Indicates the percent of memory reserved for connections. Allowed values are 0-100. Field introduced in 18.1.2. Unit is PERCENT. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? multicast_enable=null

This knob enables the Service Engine to process multicast traffic(For VMware Hypervisor). Field introduced in 30.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? n_log_streaming_threads=null

Number of threads to use for log streaming. Allowed values are 1-100. Field introduced in 17.2.12, 18.1.2. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string name

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

attribute int? nd6_cache_timeout=null

Timeout in seconds for idle ND6 entries. Allowed values are 0-86400. Field introduced in 31.2.1. Unit is SEC. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? netlink_poller_threads=null

Number of threads to poll for netlink messages excluding the thread for default namespace. Requires SE Reboot. Allowed values are 1-32. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? netlink_sock_buf_size=null

Socket buffer size for the netlink sockets. Requires SE Reboot. Allowed values are 1-128. Field introduced in 21.1.1. Unit is MEGA_BYTES. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? ngx_free_connection_stack=null

Free the connection stack. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? non_significant_log_throttle=null

This setting limits the number of non-significant logs generated per second per core on this SE. Default is 100 logs per second. Set it to zero (0) to deactivate throttling. Field introduced in 17.1.3. Unit is PER_SECOND. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? ns_helper_deq_interval_msec=null

Dequeue interval for receive queue from NS HELPER. Allowed values are 1-1000. Field introduced in 21.1.1. Unit is MILLISECONDS. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? ntp_sync_fail_event=null

Toggle SE NTP synchronization failure events generation. Disabled by default. Field introduced in 22.1.2. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? ntp_sync_status_interval=null

Configures the interval at which SE synchronization status with NTP server(s) is verified. A value of zero disables SE NTP synchronization status validation. Allowed values are 120-900. Special values are 0- disable. Field introduced in 22.1.2. Unit is SEC. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? num_dispatcher_cores=null

Number of dispatcher cores (0,1,2,4,8 or 16). If set to 0, then number of dispatcher cores is deduced automatically.Requires SE Reboot. Allowed values are 0,1,2,4,8,16. Field introduced in 17.2.12, 18.1.3, 18.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- 0), Basic (Allowed values- 0) edition.

attribute int? num_dispatcher_queues=null

Number of queues to each dispatcher. Allowed values are 1-2. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? num_flow_cores_sum_changes_to_ignore=null

Number of changes in num flow cores sum to ignore. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? objsync_mode=null

Enables SE-SE object syncing. Enum options - OBJSYNC_DISABLED, OBJSYNC_ENABLED, OBJSYNC_AUTO. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? objsync_port=null

TCP port on SE management interface for InterSE Object Distribution. Supported only for externally managed security groups. Not supported on full access deployments. Requires SE reboot. Allowed values are 1024-65535. Field introduced in 20.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string[]? openstack_availability_zones=null

attribute string? openstack_mgmt_network_name=null

Avi Management network name. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? openstack_mgmt_network_uuid=null

Management network UUID. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? os_reserved_memory=null

Amount of extra memory to be reserved for use by the Operating System on a Service Engine. Unit is MB. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? path_mtu_discovery_v4=null

Enable Path MTU Discovery feature for IPv4. Field introduced in 30.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? path_mtu_discovery_v6=null

Enable Path MTU Discovery feature for IPv6. Field introduced in 30.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string? pcap_tx_mode=null

Determines the PCAP transmit mode of operation. Requires SE Reboot. Enum options - PCAP_TX_AUTO, PCAP_TX_SOCKET, PCAP_TX_RING. Field introduced in 18.2.8, 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? pcap_tx_ring_rd_balancing_factor=null

In PCAP mode, reserve a configured portion of TX ring resources for itself and the remaining portion for the RX ring to achieve better balance in terms of queue depth. Requires SE Reboot. Allowed values are 10-100. Field introduced in 20.1.3. Unit is PERCENT. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? per_app=null

Per-app SE mode is designed for deploying dedicated load balancers per app (VS). In this mode, each SE is limited to a max of 2 VSs. vCPUs in per-app SEs count towards licensing usage at 25% rate. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- false), Basic (Allowed values- false) edition.

attribute bool? per_vs_admission_control=null

Enable/Disable per VS level admission control.Enabling this feature will cause the connection and packet throttling on a particular VS that has high packet buffer consumption. Field introduced in 20.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string? placement_mode=null

If placement mode is ‘Auto’, Virtual Services are automatically placed on Service Engines. Enum options - PLACEMENT_MODE_AUTO. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? pre_upgrade_se_available_mem_threshold=null

Available memory threshold on SE in MB, to get qualified for upgrade operation. Adjusting this knob will override the internal value of available memory threshold for SE, thereby qualifying it for upgrade operation. ‘0’ is a special auto value, which will indicate that memory threshold is calculated based on total memory size of the SE. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? reboot_on_panic=null

Reboot the VM or host on kernel panic. Field introduced in 18.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? replay_vrf_routes_interval=null

Routes in VRF are replayed at the specified interval. This should be increased if there are large number of routes. Allowed values are 0-3000. Field introduced in 22.1.3. Unit is MILLISECONDS. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? resync_time_interval=null

Time interval to re-sync SE’s time with wall clock time. Allowed values are 8-600000. Field introduced in 20.1.1. Unit is MILLISECONDS. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? sdb_flush_interval=null

SDB pipeline flush interval. Allowed values are 1-10000. Field introduced in 21.1.1. Unit is MILLISECONDS. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? sdb_key_timeout=null

The time in seconds controller redis server persists the key. Allowed values are 60-600. Field introduced in 30.2.4. Unit is SECONDS. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? sdb_pipeline_size=null

SDB pipeline size. Allowed values are 1-10000. Field introduced in 21.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? sdb_scan_count=null

SDB scan count. Allowed values are 1-1000. Field introduced in 21.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? se_bandwidth_type=null

Select the SE bandwidth for the bandwidth license. Enum options - SE_BANDWIDTH_UNLIMITED, SE_BANDWIDTH_25M, SE_BANDWIDTH_200M, SE_BANDWIDTH_1000M, SE_BANDWIDTH_10000M. Field introduced in 17.2.5. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- SE_BANDWIDTH_UNLIMITED), Basic (Allowed values- SE_BANDWIDTH_UNLIMITED) edition.

attribute int? se_debug_trace_sz=null

Use to cap the size of debug ring min(se_debug_trace_sz, num_dispatcher_cores). Only applicable to > 8G systems. Requires SE Reboot. Allowed values are 1,2,4,8,255. Field introduced in 22.1.6. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? se_delayed_flow_delete=null

Delay the cleanup of flowtable entry. To be used under surveillance of Avi Support. Field introduced in 20.1.2. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- true), Basic (Allowed values- true) edition.

attribute int? se_deprovision_delay=null

Duration to preserve unused Service Engine virtual machines before deleting them. If traffic to a Virtual Service were to spike up abruptly, this SE would still be available to be utilized again rather than creating a new SE. If this value is set to 0, Controller will never delete any SEs and administrator has to manually cleanup unused SEs. Allowed values are 0-525600. Unit is MIN. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_dp_hm_drops=null

Internal only. Used to simulate SE - SE HB failure. Field introduced in 20.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? se_dp_if_state_poll_interval=null

Number of jiffies between polling interface state. Field introduced in 21.1.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? se_dp_isolation=null

Toggle support to run SE datapath instances in isolation on exclusive CPUs. This improves latency and performance. However, this could reduce the total number of se_dp instances created on that SE instance. Supported for >= 8 CPUs. Requires SE reboot. Field introduced in 20.1.4. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? se_dp_isolation_num_non_dp_cpus=null

Number of CPUs for non se-dp tasks in SE datapath isolation mode. Translates Total cpus minus ‘num_non_dp_cpus’ for datapath use. It is recommended to reserve an even number of CPUs for hyper-threaded processors. Requires SE reboot. Allowed values are 1-8. Special values are 0- auto. Field introduced in 20.1.4. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? se_dp_log_nf_enqueue_percent=null

Internal buffer full indicator on the Service Engine beyond which the unfiltered logs are abandoned. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? se_dp_log_udf_enqueue_percent=null

Internal buffer full indicator on the Service Engine beyond which the user filtered logs are abandoned. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? se_dp_max_hb_version=null

The highest supported SE-SE Heartbeat protocol version. This version is reported by Secondary SE to Primary SE in Heartbeat response messages. Allowed values are 1-3. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_dp_vnic_queue_stall_event_sleep=null

Time (in seconds) service engine waits for after generating a Vnic transmit queue stall event before resetting theNIC. Field introduced in 18.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_dp_vnic_queue_stall_threshold=null

Number of consecutive transmit failures to look for before generating a Vnic transmit queue stall event. Field introduced in 18.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_dp_vnic_queue_stall_timeout=null

Time (in milliseconds) to wait for network/NIC recovery on detecting a transmit queue stall after which service engine resets the NIC. Field introduced in 18.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_dp_vnic_restart_on_queue_stall_count=null

Number of consecutive transmit queue stall events in se_dp_vnic_stall_se_restart_window to look for before restarting SE. Field introduced in 18.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_dp_vnic_stall_se_restart_window=null

Window of time (in seconds) during which se_dp_vnic_restart_on_queue_stall_count number of consecutive stalls results in a SE restart. Field introduced in 18.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_dpdk_pmd=null

Determines if DPDK pool mode driver should be used or not 0 Automatically determine based on hypervisor/NIC type 1 Unconditionally use DPDK poll mode driver 2 Don’t use DPDK poll mode driver.Requires SE Reboot. Allowed values are 0-2. Field introduced in 18.1.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? se_dump_core_on_assert=null

Enable core dump on assert. Field introduced in 21.1.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_emulated_cores=null

Use this to emulate more/less cpus than is actually available. One datapath process is started for each core. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- 0), Basic (Allowed values- 0) edition.

attribute int? se_flow_probe_retries=null

Flow probe retry count if no replies are received.Requires SE Reboot. Allowed values are 0-5. Field introduced in 18.1.4, 18.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_flow_probe_retry_timer=null

Timeout in milliseconds for flow probe retries.Requires SE Reboot. Allowed values are 20-50. Field introduced in 18.2.5. Unit is MILLISECONDS. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? se_hyperthreaded_mode=null

Controls the distribution of SE data path processes on CPUs which support hyper-threading. Requires hyper-threading to be enabled at host level. Requires SE Reboot. For more details please refer to SE placement KB. Enum options - SE_CPU_HT_AUTO, SE_CPU_HT_SPARSE_DISPATCHER_PRIORITY, SE_CPU_HT_SPARSE_PROXY_PRIORITY, SE_CPU_HT_PACKED_CORES. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_ip_encap_ipc=null

Determines if SE-SE IPC messages are encapsulated in an IP header 0 Automatically determine based on hypervisor type 1 Use IP encap unconditionally ~[0,1] Don’t use IP encapRequires SE Reboot. Field introduced in 20.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? se_kernel_rss=null

This knob enables kernel RSS. When enabled flowtable entry is added to every disp cpu. Should be used under supervision. Requires SE reboot. . Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? se_kni_burst_factor=null

This knob controls the resource availability and burst size used between SE datapath and KNI. This helps in minimising packet drops when there is higher KNI traffic (non-VIP traffic from and to Linux). The factor takes the following values 0-default. 1-doubles the burst size and KNI resources. 2-quadruples the burst size and KNI resources. 3-Increases the burst size and KNI resources by a factor of eight. Allowed values are 0-3. Field introduced in 18.2.6. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_l3_encap_ipc=null

Determines if SE-SE IPC messages use SE interface IP instead of VIP 0 Automatically determine based on hypervisor type 1 Use SE interface IP unconditionally ~[0,1] Don’t use SE interface IPRequires SE Reboot. Field introduced in 20.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? se_log_buffer_app_blocking_dequeue=null

Internal flag that blocks dataplane until all application logs are flushed to log-agent process. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? se_log_buffer_conn_blocking_dequeue=null

Internal flag that blocks dataplane until all connection logs are flushed to log-agent process. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? se_log_buffer_events_blocking_dequeue=null

Internal flag that blocks dataplane until all outstanding events are flushed to log-agent process. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? se_lro=null

Enable or disable Large Receive Optimization for vnics.Supported on VMXnet3.Requires SE Reboot. Field introduced in 18.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_mp_ring_retry_count=null

The retry count for the multi-producer enqueue before yielding the CPU. To be used under surveillance of Avi Support. Field introduced in 20.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- 500), Basic (Allowed values- 500) edition.

attribute int? se_mtu=null

MTU for the VNICs of SEs in the SE group. Allowed values are 512-9000. Field introduced in 18.2.8, 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? se_name_prefix=null

Prefix to use for virtual machine name of Service Engines. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_packet_buffer_max=null

Internal use only. Used to artificially reduce the available number of packet buffers. Field introduced in 21.1.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? se_pcap_lookahead=null

Enables lookahead mode of packet receive in PCAP mode. Introduced to overcome an issue with hv_netvsc driver. Lookahead mode attempts to ensure that application and kernel’s view of the receive rings are consistent. Field introduced in 18.2.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_pcap_pkt_count=null

Max number of packets the pcap interface can hold and if the value is 0 the optimum value will be chosen. The optimum value will be chosen based on SE-memory, Cloud Type and Number of Interfaces.Requires SE Reboot. Field introduced in 18.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_pcap_pkt_sz=null

Max size of each packet in the pcap interface. Requires SE Reboot. Field introduced in 18.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? se_pcap_qdisc_bypass=null

Bypass the kernel’s traffic control layer, to deliver packets directly to the driver. Enabling this feature results in egress packets not being captured in host tcpdump. Note brief packet reordering or loss may occur upon toggle. Field introduced in 18.2.6. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_pcap_reinit_frequency=null

Frequency in seconds at which periodically a PCAP reinit check is triggered. May be used in conjunction with the configuration pcap_reinit_threshold. (Valid range 15 mins - 12 hours, 0 - disables). Allowed values are 900-43200. Special values are 0- disable. Field introduced in 17.2.13, 18.1.3, 18.2.1. Unit is SEC. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_pcap_reinit_threshold=null

Threshold for input packet receive errors in PCAP mode exceeding which a PCAP reinit is triggered. If not set, an unconditional reinit is performed. This value is checked every pcap_reinit_frequency interval. Field introduced in 17.2.13, 18.1.3, 18.2.1. Unit is METRIC_COUNT. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_probe_port=null

TCP port on SE where echo service will be run. Field introduced in 17.2.2. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_rum_sampling_nav_interval=null

Minimum time to wait on server between taking sampleswhen sampling the navigation timing data from the end user client. Field introduced in 18.2.6. Unit is SEC. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_rum_sampling_nav_percent=null

Percentage of navigation timing data from the end user client, used for sampling to get client insights. Field introduced in 18.2.6. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_rum_sampling_res_interval=null

Minimum time to wait on server between taking sampleswhen sampling the resource timing data from the end user client. Field introduced in 18.2.6. Unit is SEC. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_rum_sampling_res_percent=null

Percentage of resource timing data from the end user client used for sampling to get client insight. Field introduced in 18.2.6. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? se_sb_dedicated_core=null

Sideband traffic will be handled by a dedicated core.Requires SE Reboot. Field introduced in 16.5.2, 17.1.9, 17.2.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_sb_threads=null

Number of Sideband threads per SE.Requires SE Reboot. Allowed values are 1-128. Field introduced in 16.5.2, 17.1.9, 17.2.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_thread_multiplier=null

Multiplier for SE threads based on vCPU. Allowed values are 1-10. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- 1), Basic (Allowed values- 1) edition.

attribute int? se_tunnel_mode=null

Determines if Direct Secondary Return (DSR) from secondary SE is active or not 0 Automatically determine based on hypervisor type. 1 Enable tunnel mode - DSR is unconditionally disabled. 2 Disable tunnel mode - DSR is unconditionally enabled. Tunnel mode can be enabled or disabled at run-time. Allowed values are 0-2. Field introduced in 17.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- 0), Basic (Allowed values- 0) edition.

attribute int? se_tunnel_udp_port=null

UDP Port for tunneled packets from secondary to primary SE in Docker bridge mode.Requires SE Reboot. Field introduced in 17.1.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_tx_batch_size=null

Number of packets to batch for transmit to the nic. Requires SE Reboot. Field introduced in 18.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_txq_threshold=null

Once the TX queue of the dispatcher reaches this threshold, hardware queues are not polled for further packets. To be used under surveillance of Avi Support. Allowed values are 512-32768. Field introduced in 20.1.2. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- 2048), Basic (Allowed values- 2048) edition.

attribute int? se_udp_encap_ipc=null

Determines if SE-SE IPC messages are encapsulated in a UDP header 0 Automatically determine based on hypervisor type. 1 Use UDP encap unconditionally.Requires SE Reboot. Allowed values are 0-1. Field introduced in 17.1.2. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_use_dpdk=null

Determines if DPDK library should be used or not 0 Automatically determine based on hypervisor type 1 Use DPDK if PCAP is not enabled 2 Don’t use DPDK. Allowed values are 0-2. Field introduced in 18.1.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_vnic_tx_sw_queue_flush_frequency=null

Configure the frequency in milliseconds of software transmit spillover queue flush when enabled. This is necessary to flush any packets in the spillover queue in the absence of a packet transmit in the normal course of operation. Allowed values are 50-500. Special values are 0- disable. Field introduced in 20.1.1. Unit is MILLISECONDS. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_vnic_tx_sw_queue_size=null

Configure the size of software transmit spillover queue when enabled. Requires SE Reboot. Allowed values are 128-2048. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_vs_hb_max_pkts_in_batch=null

Maximum number of aggregated vs heartbeat packets to send in a batch. Allowed values are 1-256. Field introduced in 17.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? se_vs_hb_max_vs_in_pkt=null

Maximum number of virtualservices for which heartbeat messages are aggregated in one packet. Allowed values are 1-1024. Field introduced in 17.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? self_se_election=null

Enable SEs to elect a primary amongst themselves in the absence of a connectivity to controller. Field introduced in 18.1.2. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- false), Basic (Allowed values- false) edition.

attribute int? send_se_ready_timeout=null

Timeout for sending SE_READY without NS HELPER registration completion. Allowed values are 10-600. Field introduced in 21.1.1. Unit is SECONDS. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? shm_minimum_config_memory=null

Minimum required shared memory to apply any configuration. Allowed values are 0-100. Field introduced in 18.1.2. Unit is MB. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? significant_log_throttle=null

This setting limits the number of significant logs generated per second per core on this SE. Default is 100 logs per second. Set it to zero (0) to deactivate throttling. Field introduced in 17.1.3. Unit is PER_SECOND. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? ssl_preprocess_sni_hostname=null

(Beta) Preprocess SSL Client Hello for SNI hostname extension.If set to True, this will apply SNI child’s SSL protocol(s), if they are different from SNI Parent’s allowed SSL protocol(s). Field introduced in 17.2.12, 18.1.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? ssl_sess_cache_per_vs=null

Number of SSL sessions that can be cached per VS. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string? tenant_ref=null

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

attribute int? transient_shared_memory_max=null

The threshold for the transient shared config memory in the SE. Allowed values are 0-100. Field introduced in 20.1.1. Unit is PERCENT. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? udf_log_throttle=null

This setting limits the number of UDF logs generated per second per core on this SE. UDF logs are generated due to the configured client log filters or the rules with logging enabled. Default is 100 logs per second. Set it to zero (0) to deactivate throttling. Field introduced in 17.1.3. Unit is PER_SECOND. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? upstream_connect_timeout=null

Timeout for backend connection. Field introduced in 21.1.1. Unit is MILLISECONDS. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? upstream_connpool_enable=null

Enable upstream connection pool,. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? upstream_read_timeout=null

Timeout for data to be received from backend. Field introduced in 21.1.1. Unit is MILLISECONDS. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? upstream_send_timeout=null

Timeout for upstream to become writable. Field introduced in 21.1.1. Unit is MILLISECONDS. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- 3600000), Basic (Allowed values- 3600000) edition.

attribute string? url=null

url

attribute bool? use_dp_util_for_scaleout=null

If enabled, the datapath CPU utilization is consulted by the auto scale-out logic. Field introduced in 22.1.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? use_hyperthreaded_cores=null

Enables the use of hyper-threaded cores on SE. Requires SE Reboot. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? use_legacy_netlink=null

Enable legacy model of netlink notifications. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? use_objsync=null

Enable InterSE Objsyc distribution framework. Deprecated, use objsync_mode instead. Field deprecated in 31.2.1. Field introduced in 20.1.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? use_standard_alb=null

Use Standard SKU Azure Load Balancer. By default cloud level flag is set. If not set, it inherits/uses the use_standard_alb flag from the cloud. Field introduced in 18.2.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? user_defined_metric_age=null

Defines in seconds how long before an unused user-defined-metric is garbage collected. Field introduced in 21.1.1. Unit is SEC. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string? uuid=null

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

attribute string? vcenter_datastore_mode=null

Enum options - VCENTER_DATASTORE_ANY, VCENTER_DATASTORE_LOCAL, VCENTER_DATASTORE_SHARED. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? vcenter_datastores_include=null

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

attribute string? vcenter_folder=null

Folder to place all the Service Engine virtual machines in vCenter. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? vcenter_parking_vnic_pg=null

Parking port group to be used by 9 vnics at the time of SE creation. Field introduced in 22.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? vcpus_per_se=null

Number of vcpus for each of the Service Engine virtual machines. Changes to this setting do not affect existing SEs. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? vnic_dhcp_ip_check_interval=null

DHCP ip check interval. Allowed values are 1-1000. Field introduced in 21.1.1. Unit is SEC. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? vnic_dhcp_ip_max_retries=null

DHCP ip max retries. Field introduced in 21.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? vnic_ip_delete_interval=null

wait interval before deleting IP. . Field introduced in 21.1.1. Unit is SEC. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? vnic_probe_interval=null

Probe vnic interval. Field introduced in 21.1.1. Unit is SEC. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? vnic_rpc_retry_interval=null

Time interval for retrying the failed VNIC RPC requests. Field introduced in 21.1.1. Unit is SEC. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? vnicdb_cmd_history_size=null

Size of vnicdb command history. Allowed values are 0-65535. Field introduced in 21.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? vs_host_redundancy=null

Ensure primary and secondary Service Engines are deployed on different physical hosts. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- true), Basic (Allowed values- true) edition. Special default for Essentials edition is true, Basic edition is true, Enterprise edition is True.

attribute int? vs_scalein_timeout=null

Time to wait for the scaled in SE to drain existing flows before marking the scalein done. Unit is SEC. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? vs_scalein_timeout_for_upgrade=null

During SE upgrade, Time to wait for the scaled-in SE to drain existing flows before marking the scalein done. Unit is SEC. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? vs_scaleout_timeout=null

Time to wait for the scaled out SE to become ready before marking the scaleout done. Unit is SEC. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? vs_se_primary_switchover_additional_wait_time=null

Wait time for primary switchover ready notification after flows are completed. In certain deployments, there may be an additional delay to accept traffic. For example, for BGP, some time is needed for route advertisement. Allowed values are 0-300. Field introduced in 30.2.1. Unit is SEC. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? vs_se_scalein_additional_wait_time=null

Wait time for sending scalein ready notification after flows are completed. In certain deployments, there may be an additional delay to accept traffic. For example, for BGP, some time is needed for route advertisement. Allowed values are 0-300. Field introduced in 30.2.1. Unit is SEC. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? vs_se_scaleout_additional_wait_time=null

Wait time for sending scaleout ready notification after Virtual Service is marked UP. In certain deployments, there may be an additional delay to accept traffic. For example, for BGP, some time is needed for route advertisement. Allowed values are 0-300. Field introduced in 18.1.5,18.2.1. Unit is SEC. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? vs_se_scaleout_ready_timeout=null

Timeout in seconds for Service Engine to sendScaleout Ready notification of a Virtual Service. Allowed values are 0-90. Field introduced in 18.1.5,18.2.1. Unit is SEC. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? vs_switchover_timeout=null

During SE upgrade in a legacy active/standby segroup, Time to wait for the new primary SE to accept flows before marking the switchover done. Field introduced in 17.2.13,18.1.4,18.2.1. Unit is SEC. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? vss_placement_enabled=null

If set, Virtual Services will be placed on only a subset of the cores of an SE. Field introduced in 18.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? waf_mempool=null

Enable memory pool for WAF.Requires SE Reboot. Field introduced in 17.2.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? waf_mempool_size=null

Memory pool size used for WAF.Requires SE Reboot. Field introduced in 17.2.3. Unit is KB. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? waf_use_jit_for_pcre=null

Use the JIT compiler for PCRE regular expressions in WAF. Setting this to false will impact performance. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. :rel custom_tag: :rel gcp_config: :rel iptables: :rel kni_allowed_server_ports: :rel labels: :rel license_quota: :rel markers: :rel mgmt_subnet: :rel objsync_config: :rel realtime_se_metrics: :rel reserved_configuration: :rel se_dos_profile: :rel se_group_analytics_policy: :rel se_rl_prop: :rel se_time_tracker_props: :rel se_tracert_port_range: :rel service_ip6_subnets: :rel service_ip_subnets: :rel user_agent_cache_config: :rel vcenter_clusters: :rel vcenter_datastores: :rel vcenter_hosts: :rel vcenters: :rel vip_asg: :rel vsphere_storage_policies: :rel vss_placement:

relation avi::service_engine_group::definitions::CustomTag custom_tag [0:*]

relation avi::service_engine_group::definitions::GcpSeGroupConfig gcp_config [0:1]

relation avi::service_engine_group::definitions::IptableRuleSet iptables [0:*]

relation avi::service_engine_group::definitions::KniPortRange kni_allowed_server_ports [0:*]

relation avi::service_engine_group::definitions::KeyValue labels [0:*]

relation avi::service_engine_group::definitions::QuotaConfig license_quota [0:1]

relation avi::service_engine_group::definitions::RoleFilterMatchLabel markers [0:*]

relation avi::service_engine_group::definitions::IpAddrPrefix mgmt_subnet [0:1]

relation avi::service_engine_group::definitions::ObjSyncConfig objsync_config [0:1]

relation avi::service_engine_group::definitions::MetricsRealTimeUpdate realtime_se_metrics [0:1]

relation avi::service_engine_group::definitions::ReservedConfiguration reserved_configuration [0:1]

relation avi::service_engine_group::definitions::DosThresholdProfile se_dos_profile [0:1]

relation avi::service_engine_group::definitions::SeGroupAnalyticsPolicy se_group_analytics_policy [0:1]

relation avi::service_engine_group::definitions::RateLimiterProperties se_rl_prop [0:1]

relation avi::service_engine_group::definitions::SeTimeTrackerProperties se_time_tracker_props [0:1]

relation avi::service_engine_group::definitions::PortRange se_tracert_port_range [0:1]

relation avi::service_engine_group::definitions::IpAddrPrefix service_ip6_subnets [0:*]

relation avi::service_engine_group::definitions::IpAddrPrefix service_ip_subnets [0:*]

relation avi::service_engine_group::definitions::UserAgentCacheConfig user_agent_cache_config [0:1]

relation avi::service_engine_group::definitions::VcenterClusters vcenter_clusters [0:1]

relation avi::service_engine_group::definitions::VcenterDatastore vcenter_datastores [0:*]

relation avi::service_engine_group::definitions::VcenterHosts vcenter_hosts [0:1]

relation avi::service_engine_group::definitions::PlacementScopeConfig vcenters [0:*]

relation avi::service_engine_group::definitions::VipAutoscaleGroup vip_asg [0:1]

relation avi::service_engine_group::definitions::VsphereStoragePolicy vsphere_storage_policies [0:*]

relation avi::service_engine_group::definitions::VssPlacement vss_placement [0:1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::Tenant

Parents: avi::base::Resource

attribute string? _last_modified=null

UNIX time since epoch in microseconds. Units(MICROSECONDS).

attribute string? created_by=null

Creator of this tenant. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? description=null

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

attribute bool? enforce_label_group=null

The referred label groups are enforced on the tenant if this is set to true.If this is set to false, the label groups are suggested for the tenant. Field introduced in 20.1.5. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string[]? label_group_refs=null

attribute bool? local=null

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

attribute string name

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

attribute string? url=null

url

attribute string? uuid=null

Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel attrs: :rel config_settings:

relation avi::tenant::definitions::KeyValue attrs [0:*]

relation avi::tenant::definitions::TenantConfiguration config_settings [0:1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::VrfContext

Parents: avi::base::Resource, avi::vrf_context::base::CloudScope

attribute string? _last_modified=null

UNIX time since epoch in microseconds. Units(MICROSECONDS).

attribute string? cloud_ref=null

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

attribute string? description=null

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

attribute bool? lldp_enable=null

Enable LLDP. Field introduced in 18.2.10, 20.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- true), Basic (Allowed values- true) edition.

attribute string name

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

attribute bool? system_default=null

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

attribute string? tenant_ref=null

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

attribute string? url=null

url

attribute string? uuid=null

Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel attrs: :rel bfd_profile: :rel bgp_profile: :rel debugvrfcontext: :rel gateway_mon: :rel internal_gateway_monitor: :rel markers: :rel static_routes:

relation avi::vrf_context::definitions::KeyValue attrs [0:*]

relation avi::vrf_context::definitions::BfdProfile bfd_profile [0:1]

relation avi::vrf_context::definitions::BgpProfile bgp_profile [0:1]

relation avi::vrf_context::definitions::DebugVrfContext debugvrfcontext [0:1]

relation avi::vrf_context::definitions::GatewayMonitor gateway_mon [0:*]

relation avi::vrf_context::definitions::InternalGatewayMonitor internal_gateway_monitor [0:1]

relation avi::vrf_context::definitions::RoleFilterMatchLabel markers [0:*]

relation avi::vrf_context::definitions::StaticRoute static_routes [0:*]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::VsVip

Parents: avi::base::Resource

attribute string? _last_modified=null

UNIX time since epoch in microseconds. Units(MICROSECONDS).

attribute int? bgp_local_preference=null

LOCAL_PREF to be used for VsVip advertised. Applicable only over iBGP. Field introduced in 30.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? bgp_num_as_path_prepend=null

Number of times the local AS should be prepended additionally to VsVip. Applicable only over eBGP. Allowed values are 1-10. Field introduced in 30.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string[]? bgp_peer_labels=null

attribute string? cloud_ref=null

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

attribute bool? east_west_placement=null

Force placement on all Service Engines in the Service Engine Group (Container clouds only). Field introduced in 17.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- false), Basic (Allowed values- false) edition.

attribute string name

Name for the VsVip object. Field introduced in 17.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? tenant_ref=null

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

attribute string? tier1_lr=null

This sets the placement scope of virtualservice to given tier1 logical router in Nsx-t. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? url=null

url

attribute bool? use_standard_alb=null

This overrides the cloud level default and needs to match the SE Group value in which it will be used if the SE Group use_standard_alb value is set. This is only used when FIP is used for VS on Azure Cloud. Field deprecated in 31.1.1. Field introduced in 18.2.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string? uuid=null

UUID of the VsVip object. Field introduced in 17.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? vrf_context_ref=null

Virtual Routing Context that the Virtual Service is bound to. This is used to provide the isolation of the set of networks the application is attached to. It is a reference to an object of type VrfContext. Field introduced in 17.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? vsvip_cloud_config_cksum=null

Checksum of cloud configuration for VsVip. Internally set by cloud connector. Field introduced in 17.2.9, 18.1.2. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel dns_info: :rel ipam_selector: :rel markers: :rel vip:

relation avi::vs_vip::definitions::DnsInfo dns_info [0:*]

relation avi::vs_vip::definitions::Selector ipam_selector [0:1]

relation avi::vs_vip::definitions::RoleFilterMatchLabel markers [0:*]

relation avi::vs_vip::definitions::Vip vip [0:*]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::base::Credentials

Parents: std::Entity

Connection and authentication details for an AVI (VMware NSX ALB) controller.

AVI uses session based authentication: the handlers log in once (POST /login) and reuse the resulting session cookie. Every request carries the mandatory X-Avi-Version header, writes additionally carry X-CSRFToken/Referer and requests are scoped to a tenant through the X-Avi-Tenant header.

attribute string host

Base URL of the AVI controller, e.g. https://172.25.223.252.

attribute string username

Username used to authenticate against the controller.

attribute string password

Password used to authenticate against the controller.

attribute string version='31.2.2'

Value sent in the mandatory X-Avi-Version header.

attribute string tenant='admin'

Default tenant the requests are scoped to (X-Avi-Tenant).

attribute std::positive_int timeout=30

Maximum duration, in seconds, of a single request.

attribute bool verify=false

Whether the controller TLS certificate should be verified.

attribute bool trust_env=true

Whether the environment of the agent process may configure the connection: the proxies from HTTP_PROXY/HTTPS_PROXY/ NO_PROXY, the credentials from .netrc and the CA bundle from REQUESTS_CA_BUNDLE. Set this to false to reach a controller that a proxy configured in that environment would otherwise intercept.

attribute string? agent_name=null

Optional explicit agent name (defaults to host). The scheduler manages this agent automatically; no std::AgentConfig is required (from ISO8 on the autostart agent map no longer exists).

attribute string resolved_agent_name

The following implementations are defined for this entity:

• avi::base::resolve_agent_name

The following implements statements select implementations for this entity:

• avi::base::resolve_agent_name constraint true

entity avi::base::Resource

Parents: std::PurgeableResource

Base entity for every resource managed on an AVI controller.

All generated AVI resource entities (avi::Tenant, avi::ServiceEngineGroup, …) extend this entity.

attribute bool send_event=true

attribute string tenant_scope='admin'

Tenant the requests for this resource should be scoped to (the X-Avi-Tenant header). Defaults to the admin tenant. Set this - together with a requires edge on the managing avi::Tenant - to manage an object inside a tenant other than the default one.

relation avi::base::Credentials credentials [1]

The following implements statements select implementations for this entity:

• constraint true

entity avi::se_image::ServiceEngineImage

Parents: avi::base::Resource

attribute string file_format='qcow2'

attribute string path

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine::Interface

Parents: avi::base::Resource, avi::service_engine::base::InterfaceScope

attribute string? adapter=null

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

attribute bool? aggregator_chgd=null

Field introduced in 17.2.7. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? can_se_dp_takeover=null

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

attribute bool? connected=null

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

attribute bool? del_pending=null

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

attribute bool? delete_vnic=null

Delete this VNIC. Please confirm dp_deletion_done before removing the VNIC from the cloud. Field introduced in 18.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? dhcp_enabled=null

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

attribute bool? dp_deletion_done=null

The VNIC has been cleaned up in the datapath. Field introduced in 18.2.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? enabled=null

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

attribute string? if_name=null

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

attribute bool? ip6_autocfg_enabled=null

Enable IPv6 auto configuration. Field introduced in 18.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? is_asm=null

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

attribute bool? is_avi_internal_network=null

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

attribute bool? is_hsm=null

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

attribute bool? is_mgmt=null

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

attribute bool? is_portchannel=null

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

attribute bool? link_up=null

The link is operationally up. Field introduced in 18.2.8, 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? linux_name=null

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

attribute string mac_address

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

attribute int? mtu=null

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

attribute string? network_name=null

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

attribute string? network_ref=null

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

attribute int? num_rx_descriptors=null

User defined value for RX descriptor ring size, expressed as power of 2. Setting a value of 0 implies the default value for that environment. (Tech-Preview, vCenter only). Field introduced in 30.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? num_tx_descriptors=null

User defined value for TX descriptor ring size, expressed as power of 2. Setting a value of 0 implies the default value for that environment. (Tech-Preview, vCenter only). Field introduced in 30.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string? pci_id=null

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

attribute string? port_uuid=null

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

attribute int? vlan_id=null

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

attribute int? vrf_id=null

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

attribute string? vrf_ref=null

It is a reference to an object of type VrfContext. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel members: :rel vlan_interfaces: :rel vnic_networks:

relation avi::service_engine::interface::definitions::MemberInterface members [0:*]

relation avi::service_engine::interface::definitions::VlanInterface vlan_interfaces [0:*]

relation avi::service_engine::interface::definitions::VnicNetwork vnic_networks [0:*]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine::ServiceEngine

Parents: avi::base::Resource, avi::service_engine::base::Registration

attribute string? _last_modified=null

UNIX time since epoch in microseconds. Units(MICROSECONDS).

attribute string? availability_zone=null

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

attribute string? cloud_ref=null

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

attribute bool? container_mode=null

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

attribute string? container_type=null

Enum options - CONTAINER_TYPE_BRIDGE, CONTAINER_TYPE_HOST, CONTAINER_TYPE_HOST_DPDK. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? controller_created=null

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

attribute string? controller_ip=null

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

attribute string? enable_state=null

inorder to disable SE set this field appropriately. Enum options - SE_STATE_ENABLED, SE_STATE_DISABLED_FOR_PLACEMENT, SE_STATE_DISABLED, SE_STATE_DISABLED_FORCE, SE_STATE_DISABLED_WITH_SCALEIN, SE_STATE_DISABLED_NO_TRAFFIC, SE_STATE_DISABLED_FORCE_WITH_MIGRATE. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? flavor=null

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

attribute string? host_ref=null

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

attribute string? hypervisor=null

Enum options - DEFAULT, VMWARE_ESX, KVM, VMWARE_VSAN, XEN. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string name

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

attribute bool? nsxt_no_hotplug=null

If set to true, controller does not hotplugg the vNICs. Field introduced in 30.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string? se_group_ref=null

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

attribute string? tenant_ref=null

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

attribute string? url=null

url

attribute string? uuid=null

Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel data_vnics: :rel mgmt_vnic: :rel resources:

relation avi::service_engine::definitions::Vnic data_vnics [0:*]

relation avi::service_engine::definitions::Vnic mgmt_vnic [0:1]

relation avi::service_engine::definitions::SeResources resources [0:1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine::base::EngineLookup

Parents: avi::base::Resource

attribute string? cloud=null

attribute string? engine_name=null

attribute std::positive_int poll_interval=30

attribute bool skip_if_not_found=false

attribute std::positive_int wait_timeout=1800

The following implements statements select implementations for this entity:

• constraint true

entity avi::service_engine::base::InterfaceScope

Parents: avi::service_engine::base::EngineLookup

attribute string engine

attribute string name

attribute string? vrf=null

The following implements statements select implementations for this entity:

• constraint true

entity avi::service_engine::base::Registration

Parents: avi::service_engine::base::EngineLookup

The following implements statements select implementations for this entity:

• constraint true

entity avi::service_engine::definitions::IpAddr

Parents: std::Entity

attribute string addr

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

attribute string type

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

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine::definitions::IpAddrPrefix

Parents: std::Entity

attribute int mask

Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel ip_addr:

relation avi::service_engine::definitions::IpAddr ip_addr [1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine::definitions::MemberInterface

Parents: std::Entity

attribute bool? active=null

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

attribute string if_name

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

attribute string? mac_address=null

Field introduced in 17.1.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine::definitions::SeResources

Parents: std::Entity

attribute int? cores_per_socket=null

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

attribute int disk

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

attribute bool? hyper_threading=null

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

attribute bool? hypervisor_mode=null

Indicates that the SE is running on a Virtual Machine. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int memory

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

attribute int? num_datapath_processes=null

Indicates the number of active datapath processes. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int num_vcpus

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

attribute string? qat_mode=null

Usage of Intel QAT for crypto offloads. Enum options - QAT_OFF, QAT_SW_ACCELERATION, QAT_HW_OFFLOAD. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? sockets=null

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

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine::definitions::VlanInterface

Parents: std::Entity

attribute bool? dhcp_enabled=null

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

attribute bool? enabled=null

Enable the interface. Field introduced in 18.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string if_name

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

attribute bool? ip6_autocfg_enabled=null

Enable IPv6 auto configuration. Field introduced in 18.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? is_mgmt=null

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

attribute int? vlan_id=null

VLAN ID. Allowed values are 0-4096. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? vrf_ref=null

It is a reference to an object of type VrfContext. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel vnic_networks:

relation avi::service_engine::definitions::VnicNetwork vnic_networks [0:*]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine::definitions::Vnic

Parents: std::Entity

attribute string? adapter=null

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

attribute bool? aggregator_chgd=null

Field introduced in 17.2.7. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? can_se_dp_takeover=null

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

attribute bool? connected=null

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

attribute bool? del_pending=null

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

attribute bool? delete_vnic=null

Delete this VNIC. Please confirm dp_deletion_done before removing the VNIC from the cloud. Field introduced in 18.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? dhcp_enabled=null

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

attribute bool? dp_deletion_done=null

The VNIC has been cleaned up in the datapath. Field introduced in 18.2.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? enabled=null

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

attribute string? if_name=null

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

attribute bool? ip6_autocfg_enabled=null

Enable IPv6 auto configuration. Field introduced in 18.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? is_asm=null

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

attribute bool? is_avi_internal_network=null

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

attribute bool? is_hsm=null

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

attribute bool? is_mgmt=null

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

attribute bool? is_portchannel=null

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

attribute bool? link_up=null

The link is operationally up. Field introduced in 18.2.8, 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? linux_name=null

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

attribute string mac_address

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

attribute int? mtu=null

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

attribute string? network_name=null

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

attribute string? network_ref=null

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

attribute int? num_rx_descriptors=null

User defined value for RX descriptor ring size, expressed as power of 2. Setting a value of 0 implies the default value for that environment. (Tech-Preview, vCenter only). Field introduced in 30.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? num_tx_descriptors=null

User defined value for TX descriptor ring size, expressed as power of 2. Setting a value of 0 implies the default value for that environment. (Tech-Preview, vCenter only). Field introduced in 30.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string? pci_id=null

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

attribute string? port_uuid=null

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

attribute int? vlan_id=null

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

attribute int? vrf_id=null

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

attribute string? vrf_ref=null

It is a reference to an object of type VrfContext. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel members: :rel vlan_interfaces: :rel vnic_networks:

relation avi::service_engine::definitions::MemberInterface members [0:*]

relation avi::service_engine::definitions::VlanInterface vlan_interfaces [0:*]

relation avi::service_engine::definitions::VnicNetwork vnic_networks [0:*]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine::definitions::VnicNetwork

Parents: std::Entity

attribute bool? ctlr_alloc=null

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

attribute string mode

Enum options - DHCP, STATIC, VIP, DOCKER_HOST, MODE_MANUAL. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel ip:

relation avi::service_engine::definitions::IpAddrPrefix ip [1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine::interface::definitions::IpAddr

Parents: std::Entity

attribute string addr

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

attribute string type

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

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine::interface::definitions::IpAddrPrefix

Parents: std::Entity

attribute int mask

Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel ip_addr:

relation avi::service_engine::interface::definitions::IpAddr ip_addr [1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine::interface::definitions::MemberInterface

Parents: std::Entity

attribute bool? active=null

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

attribute string if_name

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

attribute string? mac_address=null

Field introduced in 17.1.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine::interface::definitions::VlanInterface

Parents: std::Entity

attribute bool? dhcp_enabled=null

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

attribute bool? enabled=null

Enable the interface. Field introduced in 18.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string if_name

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

attribute bool? ip6_autocfg_enabled=null

Enable IPv6 auto configuration. Field introduced in 18.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? is_mgmt=null

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

attribute int? vlan_id=null

VLAN ID. Allowed values are 0-4096. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? vrf_ref=null

It is a reference to an object of type VrfContext. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel vnic_networks:

relation avi::service_engine::interface::definitions::VnicNetwork vnic_networks [0:*]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine::interface::definitions::VnicNetwork

Parents: std::Entity

attribute bool? ctlr_alloc=null

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

attribute string mode

Enum options - DHCP, STATIC, VIP, DOCKER_HOST, MODE_MANUAL. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel ip:

relation avi::service_engine::interface::definitions::IpAddrPrefix ip [1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::ClusterhaConfig

Parents: std::Entity

attribute string? cluster_id=null

Transport node cluster. Avi derives vSphere HA property from vCenter cluster.If vSphere HA enabled on vCenter cluster, vSphere will handle HA of ServiceEngine VMs in case of underlying ESX failure.Ex MOB domain-c23. Field introduced in 20.1.7, 21.1.3. Allowed with any value in Enterprise, Basic, Enterprise with Cloud Services edition.

attribute bool? override_vsphere_ha=null

If this flag set to True, Avi handles ServiceEngine failure irrespective of vSphere HA enabled on vCenter cluster or not. Field introduced in 20.1.7, 21.1.3. Allowed with any value in Enterprise, Basic, Enterprise with Cloud Services edition.

attribute string? vmg_name=null

Cluster VM Group name.VM Group name is unique inside cluster. Field introduced in 20.1.7, 21.1.3. Allowed with any value in Enterprise, Basic, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::CustomTag

Parents: std::Entity

attribute string tag_key

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

attribute string? tag_val=null

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

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::DosThreshold

Parents: std::Entity

attribute string attack

Attack type. Enum options - LAND, SMURF, ICMP_PING_FLOOD, UNKOWN_PROTOCOL, TEARDROP, IP_FRAG_OVERRUN, IP_FRAG_TOOSMALL, IP_FRAG_FULL, IP_FRAG_INCOMPLETE, PORT_SCAN, TCP_NON_SYN_FLOOD_OLD, SYN_FLOOD, BAD_RST_FLOOD, MALFORMED_FLOOD, FAKE_SESSION, ZERO_WINDOW_STRESS, SMALL_WINDOW_STRESS, DOS_HTTP_TIMEOUT, DOS_HTTP_ERROR, DOS_HTTP_ABORT, DOS_SSL_ERROR, DOS_APP_ERROR, DOS_REQ_IP_RL_DROP, DOS_REQ_URI_RL_DROP, DOS_REQ_URI_SCAN_BAD_RL_DROP, DOS_REQ_URI_SCAN_UNKNOWN_RL_DROP, DOS_REQ_IP_URI_RL_DROP, DOS_CONN_IP_RL_DROP, DOS_SLOW_URL, TCP_NON_SYN_FLOOD, DOS_REQ_CIP_SCAN_BAD_RL_DROP, DOS_REQ_CIP_SCAN_UNKNOWN_RL_DROP, DOS_REQ_IP_RL_DROP_BAD, DOS_REQ_URI_RL_DROP_BAD, DOS_REQ_IP_URI_RL_DROP_BAD, POLICY_DROPS, DOS_CONN_RL_DROP, DOS_REQ_RL_DROP, DOS_REQ_HDR_RL_DROP, DOS_REQ_CUSTOM_RL_DROP, DNS_ATTACK_REFLECTION, DNS_ATTACK_AMPLIFICATION_EGRESS, TCP_SLOW_AND_LOW, DNS_ATTACK_NXDOMAIN. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int max_value

Maximum number of packets or connections or requests in a given interval of time to be deemed as attack. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int min_value

Minimum number of packets or connections or requests in a given interval of time to be deemed as attack. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::DosThresholdProfile

Parents: std::Entity

attribute int thresh_period

Timer value in seconds to collect DoS attack metrics based on threshold on the Service Engine for this Virtual Service. Unit is SEC. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel thresh_info:

relation avi::service_engine_group::definitions::DosThreshold thresh_info [0:*]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::GcpSeGroupConfig

Parents: std::Entity

attribute string? backend_data_vpc_network_name=null

Service Engine Backend Data Network Name, used only for GCP cloud.Overrides the cloud level setting for Backend Data Network in GCP Two Arm Mode. Field introduced in 20.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string? backend_data_vpc_project_id=null

Project ID of the Service Engine Backend Data Network. By default, Service Engine Project ID will be used. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string? backend_data_vpc_subnet_name=null

Service Engine Backend Data Subnet Name, used only for GCP cloud.Overrides the cloud level setting for Backend Data Subnet in GCP Two Arm Mode. Field introduced in 20.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::IpAddr

Parents: std::Entity

attribute string addr

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

attribute string type

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

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::IpAddrPrefix

Parents: std::Entity

attribute int mask

Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel ip_addr:

relation avi::service_engine_group::definitions::IpAddr ip_addr [1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::IptableRule

Parents: std::Entity

attribute string action

Enum options - ACCEPT, DROP, REJECT, DNAT, MASQUERADE. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? input_interface=null

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

attribute string? output_interface=null

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

attribute string? proto=null

Enum options - PROTO_TCP, PROTO_UDP, PROTO_ICMP, PROTO_ALL. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? tag=null

Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel dnat_ip: :rel dst_ip: :rel dst_port: :rel src_ip: :rel src_port:

relation avi::service_engine_group::definitions::IpAddr dnat_ip [0:1]

relation avi::service_engine_group::definitions::IpAddrPrefix dst_ip [0:1]

relation avi::service_engine_group::definitions::PortRange dst_port [0:1]

relation avi::service_engine_group::definitions::IpAddrPrefix src_ip [0:1]

relation avi::service_engine_group::definitions::PortRange src_port [0:1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::IptableRuleSet

Parents: std::Entity

attribute string chain

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

attribute string table

Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel rules:

relation avi::service_engine_group::definitions::IptableRule rules [0:*]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::KeyValue

Parents: std::Entity

attribute string key

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

attribute string? value=null

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

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::KeyValueConfiguration

Parents: std::Entity

attribute string key

Reserved key string to be used for internal configuration. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int value

Value corresponding to the key. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::KniPortRange

Parents: std::Entity

attribute string protocol

Protocol associated with port range. Enum options - KNI_PROTO_TCP, KNI_PROTO_UDP. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. :rel range:

relation avi::service_engine_group::definitions::PortRange range [1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::MetricsEventThreshold

Parents: std::Entity

attribute string metrics_event_threshold_type

Type of the metrics event threshold. This value will decide which metric rule (or rules) use configured thresholds. Enum options - THRESHOLD_TYPE_STATIC, SE_CPU_THRESHOLD, SE_MEM_THRESHOLD, SE_DISK_THRESHOLD, CONTROLLER_CPU_THRESHOLD, CONTROLLER_MEM_THRESHOLD, CONTROLLER_DISK_THRESHOLD. Field introduced in 20.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute float? reset_threshold=null

This value is used to reset the event state machine. Allowed values are 1-100. Field introduced in 20.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int[]? watermark_thresholds=null

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::MetricsRealTimeUpdate

Parents: std::Entity

attribute int? duration=null

Real time metrics collection duration in minutes. 0 for infinite. Special values are 0 - infinite. Unit is MIN. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool enabled

Enables real time metrics collection. When deactivated, 6 hour view is the most granular the system will track. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::NsxtClusters

Parents: std::Entity

attribute string[]? cluster_ids=null

attribute bool? include=null

Include or Exclude. Field introduced in 20.1.6. Allowed with any value in Enterprise, Basic, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::NsxtDatastores

Parents: std::Entity

attribute string[]? ds_ids=null

attribute bool? include=null

Include or Exclude. Field introduced in 20.1.2. Allowed with any value in Enterprise, Basic, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::NsxtHosts

Parents: std::Entity

attribute string[]? host_ids=null

attribute bool? include=null

Include or Exclude. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::ObjSyncConfig

Parents: std::Entity

attribute int? objsync_cpu_limit=null

SE CPU limit for InterSE Object Distribution. Allowed values are 0-100. Special values are 0- No Restriction.. Field introduced in 20.1.3. Unit is PERCENT. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? objsync_hub_elect_interval=null

Hub election interval for InterSE Object Distribution. Allowed values are 30-300. Field introduced in 20.1.3. Unit is SEC. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? objsync_reconcile_interval=null

Reconcile interval for InterSE Object Distribution. Allowed values are 1-120. Field introduced in 20.1.3. Unit is SEC. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::PlacementScopeConfig

Parents: std::Entity

attribute string? vcenter_folder=null

Folder to place all the Service Engine virtual machines in vCenter. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string vcenter_ref

VCenter server configuration. It is a reference to an object of type VCenterServer. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel clusters: :rel nsxt_clusters: :rel nsxt_datastores: :rel nsxt_hosts:

relation avi::service_engine_group::definitions::ClusterhaConfig clusters [0:*]

relation avi::service_engine_group::definitions::NsxtClusters nsxt_clusters [0:1]

relation avi::service_engine_group::definitions::NsxtDatastores nsxt_datastores [0:1]

relation avi::service_engine_group::definitions::NsxtHosts nsxt_hosts [0:1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::PortRange

Parents: std::Entity

attribute int start

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

attribute int x_end

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

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::QuotaConfig

Parents: std::Entity

attribute int? limit=null

Maximum license service units allowed for consumption. -1 as Default is maximum value. Allowed values are -1-+65535. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? reservation=null

Minimum license service units reserved for consumption. Reservation is not enforced for Tenant/SE Group. Allowed values are 0-65535. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::RateLimiterProperties

Parents: std::Entity

attribute int? msf_num_stages=null

Number of stages in msf rate limiter. Allowed values are 1-2. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? msf_stage_size=null

Each stage size in msf rate limiter. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::ReservedConfiguration

Parents: std::Entity

Rel key_value_configurations:

relation avi::service_engine_group::definitions::KeyValueConfiguration key_value_configurations [0:*]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::RoleFilterMatchLabel

Parents: std::Entity

attribute string key

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

attribute string[]? values=null

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::SeGroupAnalyticsPolicy

Parents: std::Entity

Rel metrics_event_thresholds:

relation avi::service_engine_group::definitions::MetricsEventThreshold metrics_event_thresholds [0:*]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::SeTimeTrackerProperties

Parents: std::Entity

attribute string? egress_audit_mode=null

Audit queueing latency from proxy to dispatcher. Enum options - SE_TT_AUDIT_OFF, SE_TT_AUDIT_ON, SE_TT_AUDIT_ON_WITH_EVENT. Field introduced in 22.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? egress_threshold=null

Maximum egress latency threshold between dispatcher and proxy. Field introduced in 22.1.1. Unit is MILLISECONDS. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? event_gen_window=null

Window for cumulative event generation. Field introduced in 22.1.1. Unit is SECONDS. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string? ingress_audit_mode=null

Audit queueing latency from dispatcher to proxy. Enum options - SE_TT_AUDIT_OFF, SE_TT_AUDIT_ON, SE_TT_AUDIT_ON_WITH_EVENT. Field introduced in 22.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? ingress_threshold=null

Maximum ingress latency threshold between dispatcher and proxy. Field introduced in 22.1.1. Unit is MILLISECONDS. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::UserAgentCacheConfig

Parents: std::Entity

attribute int? batch_size=null

How many unknown User-Agents to batch up before querying Controller - unless max_wait_time is reached first. Allowed values are 1-500. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? controller_cache_size=null

The number of User-Agent entries to cache on the Controller. Allowed values are 500-10000000. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? max_age=null

Time interval in seconds after which an existing entry is refreshed from upstream if it has been accessed during max_last_hit_time. Allowed values are 60-604800. Field introduced in 22.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? max_last_hit_time=null

Time interval in seconds backwards from now during which an existing entry must have been hit for refresh from upstream. Entries that have last been accessed further in the past than max_last_hit time are not included in upstream refresh requests even if they are older than ‘max_age’. Allowed values are 60-604800. Field introduced in 22.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? max_upstream_queries=null

How often at most to query controller for a given User-Agent. Allowed values are 2-100. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? max_wait_time=null

The time interval in seconds after which to make a request to the Controller, even if the ‘batch_size’ hasn’t been reached yet. Allowed values are 20-100000. Field introduced in 21.1.1. Unit is SEC. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? num_entries_upstream_update=null

How many BotUACacheResult elements to include in an upstream update message. Allowed values are 1-10000. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? percent_reserved_for_bad_bots=null

How much space to reserve in percent for known bad bots. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? percent_reserved_for_browsers=null

How much space to reserve in percent for browsers. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? percent_reserved_for_good_bots=null

How much space to reserve in percent for known good bots. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? percent_reserved_for_outstanding=null

How much space to reserve in percent for outstanding upstream requests. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? se_cache_size=null

The number of User-Agent entries to cache on each Service Engine. Allowed values are 500-10000000. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? upstream_update_interval=null

How often in seconds to send updates about User-Agent cache entries to the next upstream cache. Field introduced in 21.1.1. Unit is SEC. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::VcenterClusters

Parents: std::Entity

attribute string[]? cluster_refs=null

attribute bool? include=null

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

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::VcenterDatastore

Parents: std::Entity

attribute string? datastore_name=null

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

attribute string? managed_object_id=null

Will be used by default, if not set fallback to datastore_name. Field introduced in 22.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::VcenterHosts

Parents: std::Entity

attribute string[]? host_refs=null

attribute bool? include=null

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

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::VipAutoscaleConfiguration

Parents: std::Entity

Rel zones:

relation avi::service_engine_group::definitions::VipAutoscaleZones zones [0:*]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::VipAutoscaleGroup

Parents: std::Entity

Rel configuration:

Rel policy:

relation avi::service_engine_group::definitions::VipAutoscaleConfiguration configuration [0:1]

relation avi::service_engine_group::definitions::VipAutoscalePolicy policy [0:1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::VipAutoscalePolicy

Parents: std::Entity

attribute int? dns_cooldown=null

The amount of time, in seconds, when a Vip is withdrawn before a scaling activity starts. Field introduced in 17.2.12, 18.1.2. Unit is SECONDS. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? max_size=null

The maximum size of the group. Field introduced in 17.2.12, 18.1.2. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? min_size=null

The minimum size of the group. Field introduced in 17.2.12, 18.1.2. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? suspend=null

When set, scaling is suspended. Field introduced in 17.2.12, 18.1.2. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::VipAutoscaleZones

Parents: std::Entity

attribute string? availability_zone=null

Availability zone associated with the subnet. Field introduced in 17.2.12, 18.1.2. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? fip_capable=null

Determines if the subnet is capable of hosting publicly accessible IP. Field introduced in 17.2.12, 18.1.2. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? subnet_uuid=null

UUID of the subnet for new IP address allocation. Field introduced in 17.2.12, 18.1.2. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::VsphereStoragePolicy

Parents: std::Entity

attribute string? vcenter_ref=null

VCenter server configuration , applicable only for Nsxt-Cloud. It is a reference to an object of type VCenterServer. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string? vsphere_storage_policy_id=null

vSphere VM Storage Policy UUID to be associated to the Service Engine. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::service_engine_group::definitions::VssPlacement

Parents: std::Entity

attribute int? core_nonaffinity=null

Degree of core non-affinity for VS placement. Allowed values are 1-256. Field introduced in 17.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? num_subcores=null

Number of sub-cores that comprise a CPU core. Allowed values are 1-128. Field introduced in 17.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::tenant::definitions::KeyValue

Parents: std::Entity

attribute string key

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

attribute string? value=null

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

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::tenant::definitions::QuotaConfig

Parents: std::Entity

attribute int? limit=null

Maximum license service units allowed for consumption. -1 as Default is maximum value. Allowed values are -1-+65535. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? reservation=null

Minimum license service units reserved for consumption. Reservation is not enforced for Tenant/SE Group. Allowed values are 0-65535. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::tenant::definitions::TenantConfiguration

Parents: std::Entity

attribute bool? se_in_provider_context=null

Controls the ownership of ServiceEngines. Service Engines can either be exclusively owned by each tenant or owned by the administrator and shared by all tenants. When ServiceEngines are owned by the administrator, each tenant can have either read access or no access to their Service Engines. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? tenant_access_to_provider_se=null

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

attribute bool? tenant_vrf=null

When ‘Per Tenant IP Domain’ is selected, each tenant gets its own routing domain that is not shared with any other tenant. When ‘Share IP Domain across all tenants’ is selected, all tenants share the same routing domain. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel license_quota:

relation avi::tenant::definitions::QuotaConfig license_quota [0:1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vrf_context::base::CloudScope

Parents: avi::base::Resource

attribute string cloud

The following implements statements select implementations for this entity:

• constraint true

entity avi::vrf_context::definitions::BfdProfile

Parents: std::Entity

attribute int? minrx=null

Default required minimum receive interval (in ms) used in BFD. Allowed values are 500-4000000. Field introduced in 20.1.1. Unit is MILLISECONDS. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? mintx=null

Default desired minimum transmit interval (in ms) used in BFD. Allowed values are 500-4000000. Field introduced in 20.1.1. Unit is MILLISECONDS. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? multi=null

Default detection multiplier used in BFD. Allowed values are 3-255. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vrf_context::definitions::BgpPeer

Parents: std::Entity

attribute bool? advertise_snat_ip=null

Advertise SNAT IP to this Peer. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? advertise_vip=null

Advertise VIP to this Peer. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? advertisement_interval=null

Advertisement interval for this Peer. Allowed values are 1-60. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? bfd=null

Enable Bi-Directional Forward Detection. Only async mode supported. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? connect_timer=null

Connect timer for this Peer. Allowed values are 1-120. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? ebgp_multihop=null

TTL for multihop ebgp Peer. Allowed values are 0-255. Field introduced in 17.1.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? hold_time=null

Hold time for this Peer. Allowed values are 3-7200. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? ibgp_local_as_override=null

Override the profile level local_as with the peer level remote_as. Field introduced in 21.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute int? keepalive_interval=null

Keepalive interval for this Peer. Allowed values are 0-3600. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? label=null

Label used to enable learning and/or advertisement of routes to this peer. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? local_as=null

Local AS to use for this ebgp peer. If specified, this will override the local AS configured at the VRF level. Allowed values are 1-4294967295. Field introduced in 17.1.6,17.2.2. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? md5_secret=null

Peer Autonomous System Md5 Digest Secret Key. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? network_ref=null

Network providing reachability for Peer. It is a reference to an object of type Network. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? remote_as=null

Peer Autonomous System ID. Allowed values are 1-4294967295. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? shutdown=null

Shutdown the BGP peer. Field introduced in 17.2.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel peer_ip: :rel peer_ip6: :rel subnet: :rel subnet6:

relation avi::vrf_context::definitions::IpAddr peer_ip [0:1]

relation avi::vrf_context::definitions::IpAddr peer_ip6 [0:1]

relation avi::vrf_context::definitions::IpAddrPrefix subnet [0:1]

relation avi::vrf_context::definitions::IpAddrPrefix subnet6 [0:1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vrf_context::definitions::BgpProfile

Parents: std::Entity

attribute string[]? community=null

attribute int? hold_time=null

Hold time for Peers. Allowed values are 3-7200. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool ibgp

BGP peer type. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? keepalive_interval=null

Keepalive interval for Peers. Allowed values are 0-3600. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int local_as

Local Autonomous System ID. Allowed values are 1-4294967295. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? local_preference=null

LOCAL_PREF to be used for routes advertised. Applicable only over iBGP. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? num_as_path_prepend=null

Number of times the local AS should be prepended additionally. Allowed values are 1-10. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? send_community=null

Send community attribute to all peers. Field introduced in 17.1.2. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? shutdown=null

Shutdown the bgp. Field introduced in 17.2.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel ip_communities: :rel peers: :rel routing_options:

relation avi::vrf_context::definitions::IpCommunity ip_communities [0:*]

relation avi::vrf_context::definitions::BgpPeer peers [0:*]

relation avi::vrf_context::definitions::BgpRoutingOptions routing_options [0:*]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vrf_context::definitions::BgpRoutingOptions

Parents: std::Entity

attribute bool? advertise_default_route=null

Advertise self as default router to the BGP peer. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? advertise_learned_routes=null

Advertise the learned routes to the BGP peer. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string label

Features are applied to peers matching this label. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? learn_only_default_route=null

Learn only default route from the BGP peer. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute bool? learn_routes=null

Learn routes from the BGP peer. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? max_learn_limit=null

Maximum number of routes that can be learned from a BGP peer. Allowed values are 50-250. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vrf_context::definitions::DebugVrf

Parents: std::Entity

attribute string flag

Enum options - DEBUG_VRF_BGP, DEBUG_VRF_QUAGGA, DEBUG_VRF_ALL, DEBUG_VRF_NONE. Field introduced in 17.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vrf_context::definitions::DebugVrfContext

Parents: std::Entity

attribute int? command_buffer_interval=null

Vrf config command buffer process interval. Allowed values are 1-4. Field introduced in 17.2.13,18.1.5,18.2.1. Unit is SECONDS. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? command_buffer_size=null

Vrf config command buffer size. Allowed values are 1-32768. Field introduced in 17.2.13,18.1.5,18.2.1. Unit is BYTES. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel flags:

relation avi::vrf_context::definitions::DebugVrf flags [0:*]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vrf_context::definitions::GatewayMonitor

Parents: std::Entity

attribute int? gateway_monitor_fail_threshold=null

The number of consecutive failed gateway health checks before a gateway is marked down. Allowed values are 3-50. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? gateway_monitor_interval=null

The interval between two ping requests sent by the gateway monitor in milliseconds. If a value is not specified, requests are sent every second. Allowed values are 100-60000. Unit is MILLISECONDS. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? gateway_monitor_success_threshold=null

The number of consecutive successful gateway health checks before a gateway that was marked down by the gateway monitor is marked up. Allowed values are 3-50. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel gateway_ip: :rel subnet:

relation avi::vrf_context::definitions::IpAddr gateway_ip [1]

relation avi::vrf_context::definitions::IpAddrPrefix subnet [0:1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vrf_context::definitions::InternalGatewayMonitor

Parents: std::Entity

attribute bool? disable_gateway_monitor=null

Disable the gateway monitor for default gateway. They are monitored by default. Field introduced in 17.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? gateway_monitor_failure_threshold=null

The number of consecutive failed gateway health checks before a gateway is marked down. Allowed values are 3-50. Field introduced in 17.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? gateway_monitor_interval=null

The interval between two ping requests sent by the gateway monitor in milliseconds. If a value is not specified, requests are sent every second. Allowed values are 100-60000. Field introduced in 17.1.1. Unit is MILLISECONDS. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? gateway_monitor_success_threshold=null

The number of consecutive successful gateway health checks before a gateway that was marked down by the gateway monitor is marked up. Allowed values are 3-50. Field introduced in 17.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vrf_context::definitions::IpAddr

Parents: std::Entity

attribute string addr

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

attribute string type

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

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vrf_context::definitions::IpAddrPrefix

Parents: std::Entity

attribute int mask

Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel ip_addr:

relation avi::vrf_context::definitions::IpAddr ip_addr [1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vrf_context::definitions::IpCommunity

Parents: std::Entity

attribute string[]? community=null

Rel ip_begin:

rel ip_end:

relation avi::vrf_context::definitions::IpAddr ip_begin [1]

relation avi::vrf_context::definitions::IpAddr ip_end [0:1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vrf_context::definitions::KeyValue

Parents: std::Entity

attribute string key

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

attribute string? value=null

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

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vrf_context::definitions::RoleFilterMatchLabel

Parents: std::Entity

attribute string key

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

attribute string[]? values=null

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vrf_context::definitions::StaticRoute

Parents: std::Entity

attribute bool? disable_gateway_monitor=null

Disable the gateway monitor for default gateway. They are monitored by default. Field introduced in 17.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? if_name=null

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

attribute string route_id

Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel labels: :rel next_hop: :rel prefix:

relation avi::vrf_context::definitions::KeyValue labels [0:*]

relation avi::vrf_context::definitions::IpAddr next_hop [1]

relation avi::vrf_context::definitions::IpAddrPrefix prefix [1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vs_vip::definitions::DiscoveredNetwork

Parents: std::Entity

attribute string network_ref

Discovered network for this IP. It is a reference to an object of type Network. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel subnet: :rel subnet6:

relation avi::vs_vip::definitions::IpAddrPrefix subnet [0:*]

relation avi::vs_vip::definitions::IpAddrPrefix subnet6 [0:*]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vs_vip::definitions::DnsCnameRdata

Parents: std::Entity

attribute string cname

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

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vs_vip::definitions::DnsInfo

Parents: std::Entity

attribute string? algorithm=null

Specifies the algorithm to pick the IP address(es) to be returned, when multiple entries are configured. This does not apply if num_records_in_response is 0. Default is consistent hash. Enum options - DNS_RECORD_RESPONSE_ROUND_ROBIN, DNS_RECORD_RESPONSE_CONSISTENT_HASH. Field introduced in 17.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? fqdn=null

Fully qualified domain name. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? metadata=null

Any metadata associated with this record. Field introduced in 17.2.2. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? num_records_in_response=null

Specifies the number of records returned for this FQDN. Enter 0 to return all records. Default is 0. Allowed values are 0-20. Special values are 0- Return all records. Field introduced in 17.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? ttl=null

Time to live for fqdn record. Default value is chosen from DNS profile for this cloud if no value provided. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? type=null

DNS record type. Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel cname:

relation avi::vs_vip::definitions::DnsCnameRdata cname [0:1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vs_vip::definitions::IpAddr

Parents: std::Entity

attribute string addr

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

attribute string type

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

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vs_vip::definitions::IpAddrPrefix

Parents: std::Entity

attribute int mask

Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel ip_addr:

relation avi::vs_vip::definitions::IpAddr ip_addr [1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vs_vip::definitions::IpAddrRange

Parents: std::Entity

Rel begin:

Rel x_end:

relation avi::vs_vip::definitions::IpAddr begin [1]

relation avi::vs_vip::definitions::IpAddr x_end [1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vs_vip::definitions::IpNetworkSubnet

Parents: std::Entity

attribute string? network_ref=null

Network for VirtualService IP allocation with Vantage as the IPAM provider. Network should be created before this is configured. It is a reference to an object of type Network. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? subnet6_uuid=null

Subnet UUID or Name or Prefix for VirtualService IPv6 allocation with AWS or OpenStack as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed. Field introduced in 18.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string? subnet_uuid=null

Subnet UUID or Name or Prefix for VirtualService IP allocation with AWS or OpenStack as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. :rel ipv6_range: :rel range: :rel subnet: :rel subnet6:

relation avi::vs_vip::definitions::IpAddrRange ipv6_range [0:1]

relation avi::vs_vip::definitions::IpAddrRange range [0:1]

relation avi::vs_vip::definitions::IpAddrPrefix subnet [0:1]

relation avi::vs_vip::definitions::IpAddrPrefix subnet6 [0:1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vs_vip::definitions::KeyValueTuple

Parents: std::Entity

attribute string key

Key. Field introduced in 20.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string? value=null

Value. Field introduced in 20.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vs_vip::definitions::RoleFilterMatchLabel

Parents: std::Entity

attribute string key

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

attribute string[]? values=null

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vs_vip::definitions::Selector

Parents: std::Entity

attribute string type

Selector type. Enum options - SELECTOR_IPAM. Field introduced in 20.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. :rel labels:

relation avi::vs_vip::definitions::KeyValueTuple labels [0:*]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vs_vip::definitions::Vip

Parents: std::Entity

attribute bool? auto_allocate_floating_ip=null

Auto-allocate floating/elastic IP from the Cloud infrastructure. Field introduced in 17.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- false), Basic (Allowed values- false) edition.

attribute bool? auto_allocate_ip=null

Auto-allocate VIP from the provided subnet. Field introduced in 17.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? auto_allocate_ip_type=null

Specifies whether to auto-allocate only a V4 address, only a V6 address, or one of each type. Enum options - V4_ONLY, V6_ONLY, V4_V6. Field introduced in 18.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- V4_ONLY), Basic (Allowed values- V4_ONLY) edition.

attribute string? availability_zone=null

Availability-zone to place the Virtual Service. Field introduced in 17.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute bool? avi_allocated_fip=null

(internal-use) FIP allocated by Avi in the Cloud infrastructure. Field introduced in 17.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- false), Basic (Allowed values- false) edition.

attribute bool? avi_allocated_vip=null

(internal-use) VIP allocated by Avi in the Cloud infrastructure. Field introduced in 17.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- false), Basic (Allowed values- false) edition.

attribute bool? enabled=null

Enable or disable the Vip. Field introduced in 17.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? floating_subnet6_uuid=null

If auto_allocate_floating_ip is True and more than one floating-ip subnets exist, then the subnet for the floating IPv6 address allocation. Field introduced in 18.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string? floating_subnet_uuid=null

If auto_allocate_floating_ip is True and more than one floating-ip subnets exist, then the subnet for the floating IP address allocation. Field introduced in 17.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

attribute string? network_ref=null

Manually override the network on which the Vip is placed. It is a reference to an object of type Network. Field introduced in 17.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string? port_uuid=null

(internal-use) Network port assigned to the Vip IP address. Field introduced in 17.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute int? prefix_length=null

Mask applied for the Vip, non-default mask supported only for wildcard Vip. Allowed values are 0-32. Field introduced in 20.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- 32), Basic (Allowed values- 32) edition.

attribute string? subnet6_uuid=null

If auto_allocate_ip is True, then the subnet for the Vip IPv6 address allocation. This field is applicable only if the VirtualService belongs to an Openstack or AWS cloud, in which case it is mandatory, if auto_allocate is selected. Field introduced in 18.1.1. Allowed with any value in Enterprise, Basic, Enterprise with Cloud Services edition.

attribute string? subnet_uuid=null

If auto_allocate_ip is True, then the subnet for the Vip IP address allocation. This field is applicable only if the VirtualService belongs to an Openstack or AWS cloud, in which case it is mandatory, if auto_allocate is selected. Field introduced in 17.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

attribute string vip_id

Unique ID associated with the vip. Field introduced in 17.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel discovered_networks: :rel floating_ip: :rel floating_ip6: :rel ip6_address: :rel ip_address: :rel ipam_network_subnet: :rel placement_networks: :rel subnet: :rel subnet6:

relation avi::vs_vip::definitions::DiscoveredNetwork discovered_networks [0:*]

relation avi::vs_vip::definitions::IpAddr floating_ip [0:1]

relation avi::vs_vip::definitions::IpAddr floating_ip6 [0:1]

relation avi::vs_vip::definitions::IpAddr ip6_address [0:1]

relation avi::vs_vip::definitions::IpAddr ip_address [0:1]

relation avi::vs_vip::definitions::IpNetworkSubnet ipam_network_subnet [0:1]

relation avi::vs_vip::definitions::VipPlacementNetwork placement_networks [0:*]

relation avi::vs_vip::definitions::IpAddrPrefix subnet [0:1]

relation avi::vs_vip::definitions::IpAddrPrefix subnet6 [0:1]

The following implements statements select implementations for this entity:

• std::none constraint true

entity avi::vs_vip::definitions::VipPlacementNetwork

Parents: std::Entity

attribute string? network_ref=null

Network to use for vip placement. It is a reference to an object of type Network. Field introduced in 18.2.5. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition. :rel subnet: :rel subnet6:

relation avi::vs_vip::definitions::IpAddrPrefix subnet [0:1]

relation avi::vs_vip::definitions::IpAddrPrefix subnet6 [0:1]

The following implements statements select implementations for this entity:

• std::none constraint true

Implementations

implementation avi::base::resolve_agent_name

Plugins

avi.create_token_reference(credentials: 'avi::base::Credentials', tenant: <class 'str'>, cloud: <class 'str'>) → <class 'inmanta_plugins.avi.AuthTokenReference'>

Build a reference to a single use service engine registration token.

The token must be generated within the tenant that will host the service engine and for the cloud it registers into, and every service engine needs its own token (single use, valid for one hour). Assign the returned reference to the attribute carrying the AVICNTRL_AUTHTOKEN VM metadata of one engine; it is resolved on the agent when that resource is deployed.

avi.generate_token(credentials: 'avi::base::Credentials', tenant: <class 'str'> = admin) → <class 'str'>

Generate an AVI authentication token at compile time.

Prefer :inmanta:plugin:`avi::create_token_reference` when the token only needs to be available at deploy time; this plugin is a convenience for the cases where the value is needed during compilation.

Resources

class avi.resources.ServiceEngineGroupResource

• Resource for entity avi::ServiceEngineGroup

• Id attribute uri

• Agent name credentials.resolved_agent_name

• Handlers avi.resources.AviHandler

class avi.resources.TenantResource

• Resource for entity avi::Tenant

• Id attribute uri

• Agent name credentials.resolved_agent_name

• Handlers avi.resources.TenantHandler

class avi.resources.VrfContextResource

A VRF context (route domain) on the controller.

Unlike the other AVI objects this module manages, a VRF context is identified by its name within a cloud rather than within its tenant: every cloud of a tenant carries its own global and management VRF, and two managed VRFs of the same name can live in two clouds at once. The cloud is therefore part of the resource id and of the lookup on the controller.

• Resource for entity avi::VrfContext

• Id attribute uri

• Agent name credentials.resolved_agent_name

• Handlers avi.resources.AviHandler

class avi.resources.VsVipResource

• Resource for entity avi::VsVip

• Id attribute uri

• Agent name credentials.resolved_agent_name

• Handlers avi.resources.AviHandler

class avi.resources.ServiceEngineImageResource

The image a service engine boots from, downloaded onto the agent.

Unlike the other resources in this module this one is not an object on the controller: the image is a file the controller serves (GET /api/fileservice/seova) and this brings it to the machine running the agent, for whatever uploads it to the hypervisor - an OpenStack Glance image, for instance - to read.

• Resource for entity avi::se_image::ServiceEngineImage

• Id attribute uri

• Agent name credentials.resolved_agent_name

• Handlers avi.resources.ServiceEngineImageHandler

class avi.resources.InterfaceResource

One data interface of a service engine, and the VRF context it belongs to.

An interface is not an object of its own on the controller: it is a member of its engine (data_vnics), which is also why it is not created here - the cloud attaches a port to the engine’s VM and the controller discovers the resulting interface. This resource waits for that to happen and configures the interface, first of all the VRF context (route domain) it belongs to.

• Resource for entity avi::service_engine::Interface

• Id attribute uri

• Agent name credentials.resolved_agent_name

• Handlers avi.resources.InterfaceHandler

class avi.resources.ServiceEngineResource

A service engine on the controller.

Service engines are not created through the API - the engine VM registers itself using a registration token - so this resource acts on the two ends of that lifecycle: it waits for the engine to be there (not purged) or removes it from the controller (purged). What the model sets on a registered engine is written to it in between - the service engine group (se_group_ref) being what the load balancer creation needs - and an engine is replaced as a whole, so everything that is not part of the desired state is left as the controller reports it.

• Resource for entity avi::service_engine::ServiceEngine

• Id attribute uri

• Agent name credentials.resolved_agent_name

• Handlers avi.resources.ServiceEngineHandler

Handlers

class avi.resources.AviHandler

Generic CRUD handler for AVI objects.

Reads happen by name (GET /api/<type>?name=<name>), while create, update and delete operate on the object uuid. Updates are full object replacements, so the desired (managed) fields are overlaid on top of the object currently on the controller.

• Handler for entity avi::ServiceEngineGroup

• Handler for entity avi::VrfContext

• Handler for entity avi::VsVip

class avi.resources.TenantHandler

A tenant, which the controller only removes once nothing refers to it.

What commonly still does is a service engine: an engine registers itself into the tenant whose token it was given, it is never created through the API, and nothing forces a model to hold one for every engine that ended up there. The controller then refuses the delete with 400 Cannot delete Tenant ... is referred by:  <engine>, and a later deploy fails the same way - the engines are still there. So the engines registered in a tenant are removed along with it, once the controller no longer sees them connected: in a cloud in no access mode it can not remove the VM behind an engine, so it refuses to delete an engine that is still connected.

• Handler for entity avi::Tenant

class avi.resources.ServiceEngineHandler

A service engine, in the only two directions the API allows.

An engine that is not there reads as purged, which makes both directions fall out of the CRUD contract: with purged=false the engine has to show up, so the controller is polled until it does (create_resource, and note that a dry run only reads, it never waits); with purged=true the engine is deleted (delete_resource), and one that never registered - or was already removed - leaves nothing to do.

In between, the fields of the engine the model sets are written to it - the service engine group (se_group_ref) first of all, the last step of the load balancer creation. An engine has no endpoint for a single one of its fields, so such a write replaces the engine as a whole: it re-reads the engine under the lock of that engine and overlays the desired fields on it, the way the interfaces of the same engine - resources of their own - are written.

• Handler for entity avi::service_engine::ServiceEngine

class avi.resources.InterfaceHandler

One data interface of a service engine, and the VRF context it is in.

The interface is found on its engine by mac address, and reads as purged until it is there: with purged=false the controller is polled until the cloud attached the port and the interface shows up (create_resource, a dry run only reads), and it is configured from then on (update_resource). With purged=true the interface goes back to the tenant’s default VRF - it is not ours to remove, the cloud detaches it - and an interface that is already gone leaves nothing to do.

The interface is written by replacing the whole engine, so a write re-reads it while holding the lock of that engine: two interfaces of one engine deploying at once would otherwise drop each other’s change.

• Handler for entity avi::service_engine::Interface

class avi.resources.ServiceEngineImageHandler

The service engine image, on the agent’s file system.

The file is the resource: it is absent (purged) until it is downloaded, and it is stale - and downloaded again - when the controller serves an image of another size or another age than the one on disk. There is nothing to send to the controller in either direction.

Nothing is kept between deploys to know which image the file holds: the downloaded image is stamped with the modification time the controller reported for it, which is what a later deploy compares against.

• Handler for entity avi::se_image::ServiceEngineImage