Steampunk Ansible Documentation - f5networks.f5_modules.bigip_profile_http2 (1.28.0) - module

Install collection

Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0

Add to requirements.yml

  collections:
    - name: f5networks.f5_modules
      version: 1.28.0

Description

Manage HTTP2 profiles on a BIG-IP system.

Usage examples

Scanned by Steampunk Spotter

- name: Create HTTP2 profile
  bigip_profile_http2:
    name: my_profile
    insert_header: true
    insert_header_name: FOO
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

Scanned by Steampunk Spotter

- name: Remove HTTP profile
  bigip_profile_http2:
    name: my_profile
    state: absent
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Scanned by Steampunk Spotter

- name: Add HTTP profile set activation modes
  bigip_profile_http:
    name: my_profile
    activation_modes:
      - always
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Inputs

name:
description:
- Specifies the name of the profile.
required: true
type: str

state:
choices:
- present
- absent
default: present
description:
- When C(present), ensures the profile exists.
- When C(absent), ensures the profile is removed.
type: str

parent:
description:
- Specifies the profile from which this profile inherits settings.
- When creating a new profile, if this parameter is not specified, the default is
the system-supplied C(http2) profile.
type: str

streams:
description:
- Specifies the number of outstanding concurrent requests allowed on a single HTTP/2
connection.
- When creating a new profile, if this parameter is not specified, the default is
provided by the parent profile.
- The valid value range is C(1 - 256).
type: int

provider:
description:
- A dict object containing connection details.
suboptions:
auth_provider:
description:
- Configures the auth provider for to obtain authentication tokens from the remote
device.
- This option is really used when working with BIG-IQ devices.
type: str
no_f5_teem:
default: false
description:
- If C(yes), TEEM telemetry data is not sent to F5.
- You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
- Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
type: bool
password:
aliases:
- pass
- pwd
description:
- The password for the user account used to connect to the BIG-IP or the BIG-IQ.
- You may omit this option by setting the environment variable C(F5_PASSWORD).
required: true
type: str
server:
description:
- The BIG-IP host or the BIG-IQ host.
- You may omit this option by setting the environment variable C(F5_SERVER).
required: true
type: str
server_port:
default: 443
description:
- The BIG-IP server port.
- You may omit this option by setting the environment variable C(F5_SERVER_PORT).
type: int
timeout:
description:
- Specifies the timeout in seconds for communicating with the network device for
either connecting or sending commands. If the timeout is exceeded before the
operation is completed, the module will error.
type: int
transport:
choices:
- rest
default: rest
description:
- Configures the transport connection to use when connecting to the remote device.
type: str
user:
description:
- The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative
privileges on the device.
- You may omit this option by setting the environment variable C(F5_USER).
required: true
type: str
validate_certs:
default: true
description:
- If C(no), SSL certificates are not validated. Use this only on personally controlled
sites using self-signed certificates.
- You may omit this option by setting the environment variable C(F5_VALIDATE_CERTS).
type: bool
type: dict
version_added: 1.0.0
version_added_collection: f5networks.f5_modules

partition:
default: Common
description:
- Device partition to manage resources on.
type: str

frame_size:
description:
- Specifies the size of data frames, in bytes, that HTTP/2 sends to the client.
- When creating a new profile, if this parameter is not specified, the default is
provided by the parent profile.
- The valid value range in bytes is C(1024 - 16384).
type: int

write_size:
description:
- Specifies the total size of combined data frames, in bytes, that HTTP/2 sends in
a single write.
- When creating a new profile, if this parameter is not specified, the default is
provided by the parent profile.
- The valid value range in bytes is C(2048 - 32768).
type: int

description:
description:
- Description of the profile.
type: str

idle_timeout:
description:
- Specifies the number of seconds an HTTP/2 connection is idly left open before being
shut down.
- When creating a new profile, if this parameter is not specified, the default is
provided by the parent profile.
type: int

insert_header:
description:
- Specifies whether an HTTP header indicating the use of HTTP/2 should be inserted
into the request that goes to the server.
- When creating a new profile, if this parameter is not specified, the default is
provided by the parent profile.
type: bool

receive_window:
description:
- Specifies the way the HTTP/2 profile performs flow control.
- When creating a new profile, if this parameter is not specified, the default is
provided by the parent profile.
- The valid value range in kilobytes is C(16 - 128).
type: int

activation_modes:
choices:
- alpn
- always
description:
- Specifies what will cause an incoming connection to be handled as a HTTP/2 connection.
- The C(alpn) and C(always) are mutually exclusive.
- When creating a new profile, if this parameter is not specified, the default is
provided by the parent profile.
elements: str
type: list

header_table_size:
description:
- Specifies the size of the header table, in bytes.
- When creating a new profile, if this parameter is not specified, the default is
provided by the parent profile.
- The valid value range in bytes is C(0 - 65535).
type: int

insert_header_name:
description:
- Specifies the name of the HTTP header controlled by C(insert_header) parameter.
- When creating a new profile, if this parameter is not specified, the default is
provided by the parent profile.
type: str

enforce_tls_requirements:
description:
- Specifies whether the system requires TLS for communications between specified senders
and recipients.
- When creating a new profile, if this parameter is not specified, the default is
provided by the parent profile.
type: bool

Outputs

activation_modes:
  description: Specifies HTTP/2 connection handling modes.
  returned: changed
  sample:
  - always
  type: list
description:
  description: Description of the profile.
  returned: changed
  sample: My profile
  type: str
enforce_tls_requirements:
  description: Specifies whether the system requires TLS for communications.
  returned: changed
  sample: true
  type: bool
frame_size:
  description: The size of the data frames.
  returned: changed
  sample: 30
  type: int
insert_header_name:
  description: Specifies the name of the HTTP2 header.
  returned: changed
  sample: X-HTTP2
  type: str
streams:
  description: The number of outstanding concurrent requests allowed on a single HTTP/2
    connection.
  returned: changed
  sample: 30
  type: int