| Generated from JSON v1.0_001 | ||||||
|---|---|---|---|---|---|---|
| Display Name | Var Name | Description | Supported Modes | Type | Options | Min. Version |
| Section: iapp | ||||||
| iapp.strictUpdates | $iapp__strictUpdates | Control Strict Updates mode (https://support.f5.com/kb/en-us/products/big-ip_ltm/manuals/product/bigip-iapps-developer-11-4-0/2.html#unique_1198712211) | [1, 2, 3, 4] | boolean | 0.3_001 | |
| iapp.appStats | $iapp__appStats | Control whether Virtual Server/Pool statistics handlers are created in Standalone or BIG-IQ Cloud mode | [1, 2] | boolean | 0.3_001 | |
| iapp.mode | $iapp__mode | The mode to use during deployment. The default setting of auto determines the mode automatically. | [1, 2, 3, 4] | string | 0.3_013 | |
| iapp.routeDomain | $iapp__routeDomain | The route domain to use during deployment. Setting to 'auto' determines the Route Domain automatically using the partition default-route-domain. In APIC mode we determine the RD from the config since it doesn't set default-route-domain | [1, 2, 3, 4] | string | 0.3_013 | |
| Section: pool | ||||||
| pool.addr | $pool__addr | The destination address of the Virtual Server | [1, 2, 3, 4] | ipaddr | 0.3_001 | |
| pool.mask | $pool__mask | The destination network mask of the Virtual Server | [1, 2, 3, 4] | ipaddr | 0.3_001 | |
| pool.port | $pool__port | The L4 port the Virtual Server listens on. '*' is supported | [1, 2, 3, 4] | port | 0.3_001 | |
| pool.Name | $pool__Name | The name of the Pool. Is no value is specified the name will be set to _pool | [1, 2, 3, 4] | string | 0.3_001 | |
| pool.Description | $pool__Description | The description string configured in the Pool | [1, 2, 3, 4] | string | 0.3_001 | |
| pool.Monitor | $pool__Monitor | The path to a preconfigured Pool Health Monitor | [1, 2, 3, 4] | string | 0.3_001 | |
| pool.LbMethod | $pool__LbMethod | The pool Load Balancing Method (https://support.f5.com/kb/en-us/products/big-ip_ltm/manuals/product/ltm_configuration_guide_10_0_0/ltm_pools.html#1215305) | [1, 2, 3, 4] | choice | dynamic-ratio-member, dynamic-ratio-node, fastest-app-response, fastest-node, least-connections-member, least-connections-node, least-sessions, observed-member, observed-node, predictive-member, predictive-node, round-robin, ratio-member, ratio-node, ratio-session, ratio-least-connections-member, ratio-least-connections-node, weighted-least-connections-member | 0.3_001 |
| pool.MemberDefaultPort | $pool__MemberDefaultPort | The L4 port to used when a pool member is added via a Dynamic Endpoint Insertion notication from Cisco APIC | [3] | string | 0.3_001 | |
| Table: Members | ||||||
| pool.Members.IPAddress | $pool.Members__IPAddress | IP Address OR Node Name of the Pool Member | [1, 2, 3, 4] | string | 0.3_001 | |
| pool.Members.Port | $pool.Members__Port | L4 port of the Pool Member | [1, 2, 3, 4] | string | 0.3_001 | |
| pool.Members.ConnectionLimit | $pool.Members__ConnectionLimit | The Connection Limit for the Pool Member. '0' denotes unlimited connections | [1, 2, 3, 4] | string | 0.3_001 | |
| pool.Members.Ratio | $pool.Members__Ratio | The Ratio weight for the Pool Member. Used with 'ratio' based Load Balancing Methods | [1, 2, 3, 4] | string | 0.3_001 | |
| pool.Members.State | $pool.Members__State | The administrative state of the Pool Member upon creation | [1, 2, 3, 4] | choice | enabled, drain-disabled, disabled | 0.3_001 |
| pool.AdvOptions | $pool__AdvOptions | The options to set in the created Pool. Options can be specified using the format: =[,=] | [1, 2, 3, 4] | string | 0.3_012 | |
| Section: vs | ||||||
| vs.Name | $vs__Name | The name of the Virtual Server. If no value is specified the name will be set to _vs | [1, 2, 3, 4] | string | 0.3_001 | |
| vs.Description | $vs__Description | The description string configured in the Virtual Server | [1, 2, 3, 4] | string | 0.3_001 | |
| vs.SourceAddress | $vs__SourceAddress | The source address filter for the Virtual Server | [1, 2, 3, 4] | string | 0.3_001 | |
| vs.IpProtocol | $vs__IpProtocol | The IP Protocol of the Virtual Server (e.g. tcp, udp) | [1, 2, 3, 4] | string | 0.3_001 | |
| vs.ConnectionLimit | $vs__ConnectionLimit | The connection limit for the virtual server. A value of '0' means no limit | [1, 2, 3, 4] | string | 0.3_001 | |
| vs.ProfileClientProtocol | $vs__ProfileClientProtocol | The client-side protocol profile. This field supports the 'create:' format for customization | [1, 2, 3, 4] | string | 0.3_001 | |
| vs.ProfileServerProtocol | $vs__ProfileServerProtocol | The server-side protocol profile. This field supports the 'create:' format for customization | [1, 2, 3, 4] | string | 0.3_001 | |
| vs.ProfileHTTP | $vs__ProfileHTTP | The HTTP protocol profile. This field supports the 'create:' format for customization | [1, 2, 3, 4] | string | 0.3_001 | |
| vs.ProfileOneConnect | $vs__ProfileOneConnect | The oneconnect profile. This field supports the 'create:' format for customization | [1, 2, 3, 4] | string | 0.3_001 | |
| vs.ProfileCompression | $vs__ProfileCompression | The compression profile. This field supports the 'create:' format for customization | [1, 2, 3, 4] | string | 0.3_005 | |
| vs.ProfileAnalytics | $vs__ProfileAnalytics | The analytics profile | [1, 2, 3, 4] | string | 0.3_005 | |
| vs.ProfileRequestLogging | $vs__ProfileRequestLogging | The request logging profile. This field supports the 'create:' format for customization | [1, 2, 3, 4] | string | 0.3_005 | |
| vs.ProfileDefaultPersist | $vs__ProfileDefaultPersist | The default persistence profile | [1, 2, 3, 4] | string | 0.3_001 | |
| vs.ProfileFallbackPersist | $vs__ProfileFallbackPersist | The fallback persistence profile | [1, 2, 3, 4] | string | 0.3_001 | |
| vs.SNATConfig | $vs__SNATConfig | The SNAT option to use. Specifiy 'automap','/Common/','partition-default','create:....'. The partition-default option references a SNAT pool created by Cisco APIC as part of the APIC partition | [1, 2, 3, 4] | string | 0.3_001 | |
| vs.ProfileServerSSL | $vs__ProfileServerSSL | The server-ssl profile. This field supports the 'create:' format for customization | [1, 2, 3, 4] | string | 0.3_005 | |
| vs.ProfileClientSSL | $vs__ProfileClientSSL | The path to an existing Client-SSL profile. If specified this value overrides Client-SSL profile creation | [1, 2, 3, 4] | string | 0.3_001 | |
| vs.ProfileClientSSLCert | $vs__ProfileClientSSLCert | The path to an existing SSL Certificate. If the work 'auto' is specfied the value /Common/.crt will be substituted | [1, 2, 3, 4] | string | 0.3_001 | |
| vs.ProfileClientSSLKey | $vs__ProfileClientSSLKey | The path to an existing SSL Key. If the work 'auto' is specfied the value /Common/.key will be substituted | [1, 2, 3, 4] | string | 0.3_001 | |
| vs.ProfileClientSSLChain | $vs__ProfileClientSSLChain | The path to the SSL Certicate Chain bundle | [1, 2, 3, 4] | string | 0.3_001 | |
| vs.ProfileClientSSLCipherString | $vs__ProfileClientSSLCipherString | The SSL Cipher String (https://support.f5.com/kb/en-us/solutions/public/13000/100/sol13171.html) | [1, 2, 3, 4] | string | 0.3_001 | |
| vs.ProfileClientSSLAdvOptions | $vs__ProfileClientSSLAdvOptions | The options to set in the created Client-SSL profile. Options can be specified using the format: =[,=] | [1, 2, 3, 4] | string | 0.3_010 | |
| vs.ProfileSecurityLogProfiles | $vs__ProfileSecurityLogProfiles | A comma seperated list of existing security logging profiles | [1, 2, 3, 4] | string | 0.3_008 | |
| vs.ProfileSecurityIPBlacklist | $vs__ProfileSecurityIPBlacklist | Configuration for the IP Intelligence Dynamic IP Blacklist. An existing subscription is required for this feature. A pre-exsiting policy may be specified by entering it's full path (ex: /Common/my_ipi_policy) | [1, 2, 3, 4] | editchoice | 0.3_015 | |
| vs.ProfileSecurityDoS | $vs__ProfileSecurityDoS | The DoS Protection Policy to configure | [1, 2, 3, 4] | string | 0.3_016 | |
| vs.ProfileAccess | $vs__ProfileAccess | The APM Access Policy to configure | [1, 2, 3, 4] | string | 0.3_011 | |
| vs.ProfileConnectivity | $vs__ProfileConnectivity | The APM Connectivity Policy to configure | [1, 2, 3, 4] | string | 0.3_011 | |
| vs.ProfilePerRequest | $vs__ProfilePerRequest | The APM Per-Request Policy to configure | [1, 2, 3, 4] | string | 0.3_011 | |
| vs.OptionSourcePort | $vs__OptionSourcePort | The source port translation behavior | [1, 2, 3, 4] | choice | preserve, preserve-strict, change | 0.3_001 |
| vs.OptionConnectionMirroring | $vs__OptionConnectionMirroring | The connection mirroring behavior | [1, 2, 3, 4] | boolean | 0.3_001 | |
| vs.Irules | $vs__Irules | A comma seperated list of existing iRules to attach to the virtual server. Ordering is preserved. | [1, 2, 3, 4] | string | 0.3_001 | |
| vs.BundledIrules | $vs__BundledIrules | The bundled iRules to deploy. Ordering is preserved. See irules/README for more info. | [1, 2, 3, 4] | dynamic_filelist_multi | 0.3_014 | |
| vs.AdvOptions | $vs__AdvOptions | The options to set in the created Virtual Server. Options can be specified using the format: =[,=] | [1, 2, 3, 4] | string | 0.3_010 | |
| vs.AdvProfiles | $vs__AdvProfiles | A comma-seperated list of profiles to link to the Virtual Server: [,] | [1, 2, 3, 4] | string | 0.3_010 | |
| Section: feature | ||||||
| feature.statsTLS | $feature__statsTLS | TLS/SSL Statistics reporting. The auto option will enable this feature if a client-ssl profile is attached, otherwise disable | [1, 2, 3, 4] | choice | auto, enabled, disabled | 0.3_006 |
| feature.statsHTTP | $feature__statsHTTP | HTTP Statistics reporting. The auto option will enable this feature if a http profile is attached, otherwise disable | [1, 2, 3, 4] | choice | auto, enabled, disabled | 0.3_006 |
| feature.insertXForwardedFor | $feature__insertXForwardedFor | Insert the X-Forwarded-For header. The auto option will enable this feature if a http profile is attached, otherwise disable | [1, 2, 3, 4] | choice | auto, enabled, disabled | 0.3_005 |
| feature.redirectToHTTPS | $feature__redirectToHTTPS | Create a virtual service on TCP/80 that performs a 302 HTTP redirect to TCP/443 on the same IP address. The auto option will enable this feature if a client-ssl profile is configured, otherwise disable | [1, 2, 3, 4] | choice | auto, enabled, disabled | 0.3_001 |
| feature.sslEasyCipher | $feature__sslEasyCipher | Easily configure TLS/SSL Cipher Strings. This setting overrides the value in the Virtual Server section | [1, 2, 3, 4] | choice | compatible, medium, high, tls_1.2, tls_1.1+1.2, disabled | 0.3_007 |
| feature.securityEnableHSTS | $feature__securityEnableHSTS | Enabled insertion of the Strict-Transport-Security HTTP header. The preload and subdomain options can be omitted or included based on this selection. This setting also modifies creation of the HTTP->HTTPS redirect option to perform a 301 HTTP redirect | [1, 2, 3, 4] | choice | disabled, enabled, enabled-preload, enabled-subdomain, enabled-preload-subdomain | 0.3_001 |
| feature.easyL4Firewall | $feature__easyL4Firewall | Configure a AFM L4 Firewall policy. The 'base' option creates a policy that allows traffic to the Virtual Server with optional Blacklist and Source addresses specified in the following fields. The base+ip_blacklist options also configure an IP Intelligence Blacklist policy in either blocking or logging mode. The auto mode is equivalent to the base+ip_blacklist_block option with the exception that if a user-specfic IPI policy is specified it will be preserved | [1, 2, 3, 4] | choice | auto, base, base+ip_blacklist_block, base+ip_blacklist_log, disabled | 0.3_008 |
| Table: easyL4FirewallBlacklist | ||||||
| feature.easyL4FirewallBlacklist.CIDRRange | $feature.easyL4FirewallBlacklist__CIDRRange | CIDR Range | [1, 2, 3, 4] | string | 0.3_008 | |
| Table: easyL4FirewallSourceList | ||||||
| feature.easyL4FirewallSourceList.CIDRRange | $feature.easyL4FirewallSourceList__CIDRRange | CIDR Range | [1, 2, 3, 4] | string | 0.3_008 | |
| feature.easyASMPolicy | $feature__easyASMPolicy | The bundled ASM policy name to deploy. See asm_policies/README for more info. | [1, 2, 3, 4] | dynamic_filelist | 0.3_009 | |
| Section: extensions | ||||||
| extensions.Field1 | $extensions__Field1 | Extensions: Field 1 | [1, 2, 3, 4] | string | 0.3_001 | |
| extensions.Field2 | $extensions__Field2 | Extensions: Field 2 | [1, 2, 3, 4] | string | 0.3_001 | |
| extensions.Field3 | $extensions__Field3 | Extensions: Field 3 | [1, 2, 3, 4] | string | 0.3_001 | |