f5networks.f5_modules.bigip_profile_analytics (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 HTTP analytics profiles on a BIG-IP device.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create a profile
  bigip_profile_analytics:
    name: profile1
    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(analytics) profile.
    type: str

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

collect_ip:
    description:
    - Enables or disables the collection of client IPs statistics.
    type: bool

collect_geo:
    description:
    - Enables or disables the collection of the names of the countries from where the
      traffic was sent.
    type: bool

collect_url:
    description:
    - Enables or disables the collection of requested URL statistics.
    type: bool

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

collect_user_agent:
    description:
    - Enables or disables the collection of user agents.
    type: bool

collect_user_sessions:
    description:
    - Enables or disables the collection of the unique user sessions.
    type: bool

notification_by_email:
    description:
    - Enables or disables sending the analytics alerts by email.
    type: bool

collect_page_load_time:
    description:
    - Enables or disables the collection of the page load time statistics.
    type: bool

notification_by_syslog:
    description:
    - Enables or disables logging of the analytics alerts into the Syslog.
    type: bool

external_logging_publisher:
    description:
    - Specifies the external logging publisher used to send statistical data to one or
      more destinations.
    type: str

notification_email_addresses:
    description:
    - Specifies which email addresses receive alerts by email when C(notification_by_email)
      is enabled.
    elements: str
    type: list

collect_max_tps_and_throughput:
    description:
    - Enables or disables the collection of maximum TPS and throughput for all collected
      entities.
    type: bool

collected_stats_external_logging:
    description:
    - Enables or disables the external logging of the collected statistics.
    type: bool

collected_stats_internal_logging:
    description:
    - Enables or disables the internal logging of the collected statistics.
    type: bool

Outputs

param1:
  description: The new param1 value of the resource.
  returned: changed
  sample: true
  type: bool
param2:
  description: The new param2 value of the resource.
  returned: changed
  sample: Foo is bar
  type: str