Steampunk Ansible Documentation - f5networks.f5_modules.bigip_snmp_trap (1.28.0) - module - Manipulate SNMP trap information on a BIG-IP

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

Manipulate SNMP trap information on a BIG-IP system.

Usage examples

Scanned by Steampunk Spotter

- name: Create snmp v1 trap
  bigip_snmp_trap:
    community: general
    destination: 1.2.3.4
    name: my-trap1
    network: management
    port: 9000
    snmp_version: 1
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Scanned by Steampunk Spotter

- name: Create snmp v2 trap
  bigip_snmp_trap:
    community: general
    destination: 5.6.7.8
    name: my-trap2
    network: default
    port: 7000
    snmp_version: 2c
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Scanned by Steampunk Spotter

- name: Create snmp v3 trap
  bigip_snmp_trap:
    community: general
    destination: 5.6.7.9
    name: my-trap3
    network: management
    port: 7001
    snmp_version: 3
    auth_protocol: 'sha'
    auth_password: 'test12345'
    security_name: "testsec2"
    security_level: "auth-no-privacy"
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
    state: absent
  delegate_to: localhost

Scanned by Steampunk Spotter

- name: Create snmp v3 trap-2
  bigip_snmp_trap:
    community: general
    destination: 5.6.7.10
    name: my-trap4
    network: management
    port: 7002
    snmp_version: 3
    auth_protocol: 'sha'
    auth_password: 'test123456'
    security_name: "testsec3"
    security_level: "auth-privacy"
    privacy_protocol: "des"
    privacy_password: 'test@12345'
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
    state: absent
  delegate_to: localhost

Inputs

name:
description:
- Name of the SNMP configuration endpoint.
required: true
type: str

port:
description:
- Specifies the port for the trap destination.
type: str

state:
choices:
- present
- absent
default: present
description:
- When C(present), ensures the resource exists.
- When C(absent), ensures the resource does not exist.
type: str

network:
choices:
- other
- management
- default
description:
- Specifies the name of the trap network. This option is not supported in versions
of BIG-IP prior to 12.1.0, and is simply ignored on those versions.
- The value C(default) was removed in BIG-IP version 13.1.0. Specifying this value
when configuring a BIG-IP causes the module to stop and report an error. In this
case, choose one of the other options, such as C(management).
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

community:
description:
- Specifies the community name for the trap destination.
type: str

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

destination:
description:
- Specifies the address for the trap destination. This can be either an IP address
or a hostname.
type: str

snmp_version:
choices:
- '1'
- 2c
- '3'
description:
- Specifies to which Simple Network Management Protocol (SNMP) version the trap destination
applies.
type: str

auth_password:
description:
- Specifies the Authentication protocol password to be used for snmp v3 traps
- Required for the C(snmp_version) matches C(v3) and for the C(security_level)
type: str
version_added: 1.16.0
version_added_collection: f5networks.f5_modules

auth_protocol:
choices:
- sha
- md5
description:
- Specifies the Authentication protocol to be used for snmp v3 traps
- Required for the C(security_level)
type: str
version_added: 1.16.0
version_added_collection: f5networks.f5_modules

security_name:
description:
- Specifies the security name to used for v3 snmp trap
- Required for the C(snmp_version) matches C(v3).
type: str
version_added: 1.16.0
version_added_collection: f5networks.f5_modules

security_level:
choices:
- auth-no-privacy
- auth-privacy
description:
- Specifies the port for the trap destination.
- Required for the C(snmp_version) matches C(v3).
type: str
version_added: 1.16.0
version_added_collection: f5networks.f5_modules

privacy_password:
description:
- Specifies the Privacy protocol password to be used for snmp v3 traps
- Required for the C(security_level) matches c(auth-privacy)
type: str
version_added: 1.16.0
version_added_collection: f5networks.f5_modules

privacy_protocol:
choices:
- aes
- des
description:
- Specifies the Privacy protocol to be used for snmp v3 traps
- Required for the C(security_level) matches c(auth-privacy)
type: str
version_added: 1.16.0
version_added_collection: f5networks.f5_modules

Outputs

community:
  description: The new C(community) name for the trap destination.
  returned: changed and success
  sample: secret
  type: list
destination:
  description: The new address for the trap destination in either IP or hostname form.
  returned: changed and success
  sample: 1.2.3.4
  type: str
network:
  description: The new name of the network the SNMP trap is on.
  returned: changed and success
  sample: management
  type: str
port:
  description: The new C(port) of the trap destination.
  returned: changed and success
  sample: 900
  type: str
snmp_version:
  description: The new C(snmp_version) configured on the remote device.
  returned: changed and success
  sample: 2c
  type: str