Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ provider "bigip" {
- `login_ref` - (Optional,Default `tmos`) Login reference for token authentication (see BIG-IP REST docs for details). May be set via the `BIGIP_LOGIN_REF` environment variable.
- `port` - (Optional) Management Port to connect to BIG-IP,this is mainly required if we have single nic BIG-IP in AWS/Azure/GCP (or) Management port other than `443`. Can be set via `BIGIP_PORT` environment variable.
- `validate_certs_disable` - (Optional, Default `true`) If set to true, Disables TLS certificate check on BIG-IP. Can be set via the `BIGIP_VERIFY_CERT_DISABLE` environment variable.
- `trusted_cert_path` - (type `string`) Provides Certificate Path to be used TLS Validate.It will be required only if `validate_certs_disable` set to `false`.Can be set via the `BIGIP_TRUSTED_CERT_PATH` environment variable.
- `trusted_cert_path` - (type `string`) Provides Certificate Path to be used TLS Validate. It will be required only if `validate_certs_disable` set to `false`. Can be set via the `BIGIP_TRUSTED_CERT_PATH` environment variable.

~> **Note** For BIG-IQ resources these provider credentials `address`,`username`,`password` can be set to BIG-IQ credentials.

Expand Down
10 changes: 5 additions & 5 deletions docs/resources/bigip_as3.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,19 +127,19 @@ resource "bigip_as3" "as3-example1" {

* `controls` - (Optional) - A map that allows you to configure specific behavior controls for the AS3 declaration. Each key represents a particular control setting, and the corresponding value defines its configuration.

* `dry_run` (Optional) - Enables or disables dry-run mode.
* `dry_run` - (Optional) - Enables or disables dry-run mode.
* Allowed values: "yes", "no"

* `trace` (Optional) - Enables or disables detailed trace of the configuration process.
* `trace` - (Optional) - Enables or disables detailed trace of the configuration process.
* Allowed values: "yes", "no"

* `trace_response` (Optional) - If set to "yes" the response will contain the trace files.
* `trace_response` - (Optional) - If set to "yes" the response will contain the trace files.
* Allowed values: "yes", "no"

* `log_level` (Optional) - Controls the amount of detail in logs produced while configuring the Tenant.
* `log_level` - (Optional) - Controls the amount of detail in logs produced while configuring the Tenant.
* Allowed values: "emergency", "alert", "critical", "error", "warning", "notice", "info", "debug"

* `user_agent` (Optional) - Controls the User Agent information to include in TEEM report.
* `user_agent` - (Optional) - Controls the User Agent information to include in TEEM report.


* `application_list` - (Optional) - List of applications currently deployed on the Big-Ip
Expand Down
10 changes: 5 additions & 5 deletions docs/resources/bigip_do.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,19 @@ resource "bigip_do" "do-example" {

* `do_json` - (Required) Name of the of the Declarative DO JSON file

* `bigip_address` - (optional) IP Address of BIGIP Host to be used for this resource,this is optional parameter.
* `bigip_address` - (Optional) IP Address of BIGIP Host to be used for this resource,this is optional parameter.
whenever we specify this parameter it gets overwrite provider configuration

* `bigip_user` - (optional) UserName of BIGIP host to be used for this resource,this is optional parameter.
* `bigip_user` - (Optional) UserName of BIGIP host to be used for this resource,this is optional parameter.
whenever we specify this parameter it gets overwrite provider configuration

* `bigip_port` - (optional) Port number of BIGIP host to be used for this resource,this is optional parameter.
* `bigip_port` - (Optional) Port number of BIGIP host to be used for this resource,this is optional parameter.
whenever we specify this parameter it gets overwrite provider configuration

* `bigip_password` - (optional) Password of BIGIP host to be used for this resource,this is optional parameter.
* `bigip_password` - (Optional) Password of BIGIP host to be used for this resource,this is optional parameter.
whenever we specify this parameter it gets overwrite provider configuration

* `timeout(minutes)` - (optional) timeout to keep polling DO endpoint until Bigip is provisioned by DO.( Default timeout is 20 minutes )
* `timeout(minutes)` - (Optional) timeout to keep polling DO endpoint until Bigip is provisioned by DO.( Default timeout is 20 minutes )

~> **Note:** If we want to replace provider BIGIP with other BIGIPs details we can specify with `bigip_address`,
`bigip_user`,`bigip_port` and `bigip_password`. All Must be specified in such scenario.
Expand Down
28 changes: 14 additions & 14 deletions docs/resources/bigip_fast_http_app.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,25 +107,25 @@ This IP address, combined with the port you specify below, becomes the BIG-IP vi

The `virtual_server` block supports the following:

* `ip` - (Optional , `string`) IP4/IPv6 address to be used for virtual server ex: `10.1.1.1`
* `ip` - (Optional, `string`) IP4/IPv6 address to be used for virtual server ex: `10.1.1.1`

* `port` -(Optional , `int`) Port number to used for accessing virtual server/application
* `port` -(Optional, `int`) Port number to used for accessing virtual server/application

### Pool Members

Using this block will `enable` for FAST-Generated Pool.

The `pool_members` block supports the following:

* `addresses` - (Optional , `list`) List of server address to be used for FAST-Generated Pool.
* `addresses` - (Optional, `list`) List of server address to be used for FAST-Generated Pool.

* `port` - (Optional , `int`) port number of serviceport to be used for FAST-Generated Pool.
* `port` - (Optional, `int`) port number of serviceport to be used for FAST-Generated Pool.

* `connection_limit` - (Optional , `int`) connectionLimit value to be used for FAST-Generated Pool.
* `connection_limit` - (Optional, `int`) connectionLimit value to be used for FAST-Generated Pool.

* `priority_group` - (Optional , `int`) priorityGroup value to be used for FAST-Generated Pool.
* `priority_group` - (Optional, `int`) priorityGroup value to be used for FAST-Generated Pool.

* `share_nodes` - (Optional , `bool`) shareNodes value to be used for FAST-Generated Pool.
* `share_nodes` - (Optional, `bool`) shareNodes value to be used for FAST-Generated Pool.


### Pool Monitor
Expand All @@ -134,21 +134,21 @@ Using this block will `enable` for FAST-Generated Pool Monitor.

The `monitor` block supports the following:

* `monitor_auth` - (Optional , `bool`) set `true` if the servers require login credentials for web access on FAST-Generated Pool Monitor. default is `false`.
* `monitor_auth` - (Optional, `bool`) set `true` if the servers require login credentials for web access on FAST-Generated Pool Monitor. default is `false`.

* `username` - (Optional , `string`) username for web access on FAST-Generated Pool Monitor.
* `username` - (Optional, `string`) username for web access on FAST-Generated Pool Monitor.

* `password` - (Optional , `string`) password for web access on FAST-Generated Pool Monitor.
* `password` - (Optional, `string`) password for web access on FAST-Generated Pool Monitor.

* `interval` - (Optional , `int`) Set the time between health checks,in seconds for FAST-Generated Pool Monitor.
* `interval` - (Optional, `int`) Set the time between health checks,in seconds for FAST-Generated Pool Monitor.

* `send_string` - (Optional , `string`) Specify data to be sent during each health check for FAST-Generated Pool Monitor.
* `send_string` - (Optional, `string`) Specify data to be sent during each health check for FAST-Generated Pool Monitor.

* `response` - (Optional , `string`) The presence of this string anywhere in the HTTP response implies availability.
* `response` - (Optional, `string`) The presence of this string anywhere in the HTTP response implies availability.

### WAF Security policy
Using this block will `enable` for FAST-Generated WAF Security Policy

The `waf_security_policy` block supports the following:

* `enable` - (Optional , `bool`) Setting `true` will enable FAST to create WAF Security Policy.
* `enable` - (Optional, `bool`) Setting `true` will enable FAST to create WAF Security Policy.
26 changes: 13 additions & 13 deletions docs/resources/bigip_fast_https_app.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,9 @@ This IP address, combined with the port you specify below, becomes the BIG-IP vi

The `virtual_server` block supports the following:

* `ip` - (Optional , `string`) IP4/IPv6 address to be used for virtual server ex: `10.1.1.1`
* `ip` - (Optional, `string`) IP4/IPv6 address to be used for virtual server ex: `10.1.1.1`

* `port` -(Optional , `int`) Port number to used for accessing virtual server/application
* `port` -(Optional, `int`) Port number to used for accessing virtual server/application


### TLS Server Profile
Expand Down Expand Up @@ -158,15 +158,15 @@ Using this block will `enable` for FAST-Generated Pool.

The `pool_members` block supports the following:

* `addresses` - (Optional , `list`) List of server address to be used for FAST-Generated Pool.
* `addresses` - (Optional, `list`) List of server address to be used for FAST-Generated Pool.

* `port` - (Optional , `int`) port number of serviceport to be used for FAST-Generated Pool.
* `port` - (Optional, `int`) port number of serviceport to be used for FAST-Generated Pool.

* `connection_limit` - (Optional , `int`) connectionLimit value to be used for FAST-Generated Pool.
* `connection_limit` - (Optional, `int`) connectionLimit value to be used for FAST-Generated Pool.

* `priority_group` - (Optional , `int`) priorityGroup value to be used for FAST-Generated Pool.
* `priority_group` - (Optional, `int`) priorityGroup value to be used for FAST-Generated Pool.

* `share_nodes` - (Optional , `bool`) shareNodes value to be used for FAST-Generated Pool.
* `share_nodes` - (Optional, `bool`) shareNodes value to be used for FAST-Generated Pool.


### Pool Monitor
Expand All @@ -175,14 +175,14 @@ Using this block will `enable` for FAST-Generated Pool Monitor.

The `monitor` block supports the following:

* `monitor_auth` - (Optional , `bool`) set `true` if the servers require login credentials for web access on FAST-Generated Pool Monitor. default is `false`.
* `monitor_auth` - (Optional, `bool`) set `true` if the servers require login credentials for web access on FAST-Generated Pool Monitor. default is `false`.

* `username` - (Optional , `string`) username for web access on FAST-Generated Pool Monitor.
* `username` - (Optional, `string`) username for web access on FAST-Generated Pool Monitor.

* `password` - (Optional , `string`) password for web access on FAST-Generated Pool Monitor.
* `password` - (Optional, `string`) password for web access on FAST-Generated Pool Monitor.

* `interval` - (Optional , `int`) Set the time between health checks,in seconds for FAST-Generated Pool Monitor.
* `interval` - (Optional, `int`) Set the time between health checks,in seconds for FAST-Generated Pool Monitor.

* `send_string` - (Optional , `string`) Specify data to be sent during each health check for FAST-Generated Pool Monitor.
* `send_string` - (Optional, `string`) Specify data to be sent during each health check for FAST-Generated Pool Monitor.

* `response` - (Optional , `string`) The presence of this string anywhere in the HTTP response implies availability.
* `response` - (Optional, `string`) The presence of this string anywhere in the HTTP response implies availability.
4 changes: 2 additions & 2 deletions docs/resources/bigip_ipsec_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ resource "bigip_ipsec_policy" "test-policy" {
```

## Argument Reference
* `name` - (Required) Name of the IPSec policy,it should be "full path".The full path is the combination of the partition + name of the IPSec policy.(For example `/Common/test-policy`)
* `name` - (Required) Name of the IPSec policy, it should be "full path". The full path is the combination of the partition + name of the IPSec policy (For example `/Common/test-policy`).

* `description` - (Optional,type `string`) Description of the IPSec policy.

Expand All @@ -56,4 +56,4 @@ resource "bigip_ipsec_policy" "test-policy" {
* `perfect_forward_secrecy` - (Optional, type `string`) Specifies the Diffie-Hellman group to use for IKE Phase 2 negotiation. Valid choices are: `none, modp768, modp1024, modp1536, modp2048, modp3072,
modp4096, modp6144, modp8192`

* `ipcomp` - (Optional, type `string`) Specifies whether to use IPComp encapsulation. Valid choices are: `none", null", deflate`
* `ipcomp` - (Optional, type `string`) Specifies whether to use IPComp encapsulation. Valid choices are: `none, null, deflate`
2 changes: 1 addition & 1 deletion docs/resources/bigip_ipsec_profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ resource "bigip_ipsec_profile" "azurevWAN_profile" {

## Argument Reference

* `name` - (Required) Displays the name of the IPsec interface tunnel profile,it should be "full path".The full path is the combination of the partition + name of the IPSec profile.(For example `/Common/test-profile`)
* `name` - (Required) Displays the name of the IPsec interface tunnel profile, it should be "full path". The full path is the combination of the partition + name of the IPSec profile (For example `/Common/test-profile`).

* `description` - (Optional,type `string`) Specifies descriptive text that identifies the IPsec interface tunnel profile.

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/bigip_ltm_monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ resource "bigip_ltm_monitor" "test-postgresql-monitor" {

## Argument Reference

* `name` ((Required,type `string`) Specifies the Name of the LTM Monitor.Name of Monitor should be full path,full path is the combination of the `partition + monitor name`,For ex:`/Common/test-ltm-monitor`.
* `name` ((Required,type `string`) Specifies the Name of the LTM Monitor. Name of Monitor should be full path, full path is the combination of the `partition + monitor name`, for ex:`/Common/test-ltm-monitor`.

* `parent` - (Required,type `string`) Parent monitor for the system to use for setting initial values for the new monitor.

Expand Down
32 changes: 16 additions & 16 deletions docs/resources/bigip_ltm_persistence_profile_cookie.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,38 +39,38 @@ resource "bigip_ltm_persistence_profile_cookie" "test_ppcookie" {

`name` - (Required) Name of the virtual address

`defaults_from` - (Required) Parent cookie persistence profile
`defaults_from` - (Required) Specifies the existing profile from which the system imports settings for the new profile

`match_across_pools` (Optional) (enabled or disabled) match across pools with given persistence record
`match_across_pools` - (Optional) (enabled or disabled) match across pools with given persistence record

`match_across_services` (Optional) (enabled or disabled) match across services with given persistence record
`match_across_services` - (Optional) (enabled or disabled) match across services with given persistence record

`match_across_virtuals` (Optional) (enabled or disabled) match across virtual servers with given persistence record
`match_across_virtuals` - (Optional) (enabled or disabled) match across virtual servers with given persistence record

`method` (Optional) Specifies the type of cookie processing that the system uses. The default value is insert
`method` - (Optional) Specifies the type of cookie processing that the system uses. The default value is insert

`mirror` (Optional) (enabled or disabled) mirror persistence record
`mirror` - (Optional) (enabled or disabled) mirror persistence record

`timeout` (Optional) (enabled or disabled) Timeout for persistence of the session in seconds
`timeout` - (Optional) (enabled or disabled) Timeout for persistence of the session in seconds

`override_conn_limit` (Optional) (enabled or disabled) Enable or dissable pool member connection limits are overridden for persisted clients. Per-virtual connection limits remain hard limits and are not overridden.
`override_conn_limit` - (Optional) (enabled or disabled) Enable or dissable pool member connection limits are overridden for persisted clients. Per-virtual connection limits remain hard limits and are not overridden.

`always_send` (Optional) (enabled or disabled) always send cookies
`always_send` - (Optional) (enabled or disabled) always send cookies

`cookie_encryption` (Optional) (required, preferred, or disabled) To required, preferred, or disabled policy for cookie encryption
`cookie_encryption` - (Optional) (required, preferred, or disabled) To required, preferred, or disabled policy for cookie encryption

`cookie_encryption_passphrase` (Optional) (required, preferred, or disabled) Passphrase for encrypted cookies. The field is encrypted on the server and will always return differently then set.
`cookie_encryption_passphrase` - (Optional) (required, preferred, or disabled) Passphrase for encrypted cookies. The field is encrypted on the server and will always return differently then set.
If this is configured specify `ignore_changes` under the `lifecycle` block to ignore returned encrypted value.

`cookie_name` (Optional) Name of the cookie to track persistence
`cookie_name` - (Optional) Name of the cookie to track persistence

`expiration` (Optional) Expiration TTL for cookie specified in DAY:HOUR:MIN:SECONDS (Examples: 1:0:0:0 one day, 1:0:0 one hour, 30:0 thirty minutes)
`expiration` - (Optional) Expiration TTL for cookie specified in DAY:HOUR:MIN:SECONDS (Examples: 1:0:0:0 one day, 1:0:0 one hour, 30:0 thirty minutes)

`hash_length` (Optional) (Integer) Length of hash to apply to cookie
`hash_length` - (Optional) (Integer) Length of hash to apply to cookie

`hash_offset` (Optional) (Integer) Number of characters to skip in the cookie for the hash
`hash_offset` - (Optional) (Integer) Number of characters to skip in the cookie for the hash

`httponly` (Optional) (enabled or disabled) Sending only over http
`httponly` - (Optional) (enabled or disabled) Sending only over http

## Importing
An cookie persistence profile can be imported into this resource by supplying the Name in `full path` as `id`.
Expand Down
20 changes: 10 additions & 10 deletions docs/resources/bigip_ltm_persistence_profile_srcaddr.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,25 +32,25 @@ resource "bigip_ltm_persistence_profile_srcaddr" "srcaddr" {

`name` - (Required) Name of the virtual address

`defaults_from` - (Required) Parent cookie persistence profile
`defaults_from` - (Required) Specifies the existing profile from which the system imports settings for the new profile

`match_across_pools` (Optional) (enabled or disabled) match across pools with given persistence record
`match_across_pools` - (Optional) (enabled or disabled) match across pools with given persistence record

`match_across_services` (Optional) (enabled or disabled) match across services with given persistence record
`match_across_services` - (Optional) (enabled or disabled) match across services with given persistence record

`match_across_virtuals` (Optional) (enabled or disabled) match across virtual servers with given persistence record
`match_across_virtuals` - (Optional) (enabled or disabled) match across virtual servers with given persistence record

`mirror` (Optional) (enabled or disabled) mirror persistence record
`mirror` - (Optional) (enabled or disabled) mirror persistence record

`timeout` (Optional) (enabled or disabled) Timeout for persistence of the session in seconds
`timeout` - (Optional) (enabled or disabled) Timeout for persistence of the session in seconds

`override_conn_limit` (Optional) (enabled or disabled) Enable or dissable pool member connection limits are overridden for persisted clients. Per-virtual connection limits remain hard limits and are not overridden.
`override_conn_limit` - (Optional) (enabled or disabled) Enable or dissable pool member connection limits are overridden for persisted clients. Per-virtual connection limits remain hard limits and are not overridden.

`hash_algorithm` (Optional) Specify the hash algorithm
`hash_algorithm` - (Optional) Specify the hash algorithm

`mask` (Optional) Identify a range of source IP addresses to manage together as a single source address affinity persistent connection when connecting to the pool. Must be a valid IPv4 or IPv6 mask.
`mask` - (Optional) Identify a range of source IP addresses to manage together as a single source address affinity persistent connection when connecting to the pool. Must be a valid IPv4 or IPv6 mask.

`map_proxies` (Optional) (enabled or disabled) Directs all to the same single pool member
`map_proxies` - (Optional) (enabled or disabled) Directs all to the same single pool member

## Importing
An source-addr persistence profile can be imported into this resource by supplying the Name in `full path` as `id`.
Expand Down
Loading