f5networks.f5_modules.bigip_profile_analytics module – Manage HTTP analytics profiles on a BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.31.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_profile_analytics
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manage HTTP analytics profiles on a BIG-IP device.
Parameters
Parameter |
Comments |
---|---|
Enables or disables the collection of the names of the countries from where the traffic was sent. Choices:
|
|
Enables or disables the collection of client IPs statistics. Choices:
|
|
Enables or disables the collection of maximum TPS and throughput for all collected entities. Choices:
|
|
Enables or disables the collection of the page load time statistics. Choices:
|
|
Enables or disables the collection of requested URL statistics. Choices:
|
|
Enables or disables the collection of user agents. Choices:
|
|
Enables or disables the collection of the unique user sessions. Choices:
|
|
Enables or disables the external logging of the collected statistics. Choices:
|
|
Enables or disables the internal logging of the collected statistics. Choices:
|
|
Description of the profile. |
|
Specifies the external logging publisher used to send statistical data to one or more destinations. |
|
Specifies the name of the profile. |
|
Enables or disables sending the analytics alerts by email. Choices:
|
|
Enables or disables logging of the analytics alerts into the Syslog. Choices:
|
|
Specifies which email addresses receive alerts by email when |
|
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 |
|
Device partition to manage resources on. Default: |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
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 |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
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 |
|
If You may omit this option by setting the environment variable Choices:
|
|
When When Choices:
|
Notes
Note
For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
Requires BIG-IP software version >= 12.
The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.
Examples
- name: Create a profile
bigip_profile_analytics:
name: profile1
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The new param1 value of the resource. Returned: changed Sample: |
|
The new param2 value of the resource. Returned: changed Sample: |