f5networks.f5_modules.bigip_snmp (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

Manipulate general SNMP settings on a BIG-IP system.

Usage examples

Scanned by Steampunk Spotter

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

- name: Set snmp contact
  bigip_snmp:
    contact: Joe User
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Scanned by Steampunk Spotter

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

- name: Set snmp location
  bigip_snmp:
    location: US West 1
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Inputs

    
contact:
    description:
    - Specifies the name of the person who administers the SNMP service for this system.
    type: str

location:
    description:
    - Specifies the description of this system's physical location.
    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

allowed_addresses:
    description:
    - Configures the IP addresses of the SNMP clients from which the snmpd daemon accepts
      requests.
    - This value can be hostnames, IP addresses, or IP networks.
    - You may specify a single list item of C(default) to set the value back to the system
      default of C(127.0.0.0/8).
    - You can remove all allowed addresses by either providing the word C(none), or by
      providing the empty string C("").
    type: raw

agent_status_traps:
    choices:
    - enabled
    - disabled
    description:
    - When C(enabled), ensures the system sends a trap whenever the SNMP agent starts
      running or stops running. This is usually enabled by default on a BIG-IP.
    type: str

device_warning_traps:
    choices:
    - enabled
    - disabled
    description:
    - When C(enabled), ensures the system sends device warning traps to the trap destinations.
      This is usually enabled by default on a BIG-IP.
    type: str

agent_authentication_traps:
    choices:
    - enabled
    - disabled
    description:
    - When C(enabled), ensures the system sends authentication warning traps to the trap
      destinations. This is usually disabled by default on a BIG-IP.
    type: str

Outputs

agent_authentication_traps:
  description: Value of the authentication status traps.
  returned: changed
  sample: enabled
  type: str
agent_status_traps:
  description: Value of the agent status traps.
  returned: changed
  sample: enabled
  type: str
allowed_addresses:
  description: The new allowed addresses for SNMP client connections.
  returned: changed
  sample:
  - 127.0.0.0/8
  - foo.bar.com
  - 10.10.10.10
  type: list
contact:
  description: The new value for the person who administers SNMP on the device.
  returned: changed
  sample: Joe User
  type: str
device_warning_traps:
  description: Value of the warning status traps.
  returned: changed
  sample: enabled
  type: str
location:
  description: The new value for the system's physical location.
  returned: changed
  sample: US West 1a
  type: str