paloaltonetworks.panos.panos_snmp_v3_server module – Manage SNMP v3 servers.

Note

This module is part of the paloaltonetworks.panos collection (version 2.19.1).

To install it, use: ansible-galaxy collection install paloaltonetworks.panos. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: paloaltonetworks.panos.panos_snmp_v3_server.

New in paloaltonetworks.panos 1.0.0

Synopsis

• Manages SNMP v3 servers.

Requirements

The below requirements are needed on the host that executes this module.

• pan-python

• pandevice >= 0.11.1

Parameters

Parameter	Comments
api_key string	Deprecated Use provider to specify PAN-OS connectivity instead. The API key to use instead of generating it using username / password.
auth_password string	Authentiation protocol password.
device_group string	(Panorama only) The device group the operation should target. Default: :ansible-option-default:`"shared"`
engine_id string	A hex number
gathered_filter string	When state=gathered. An advanced filtering option to filter results returned from PAN-OS. Refer to the guide discussing gathered_filter for more information.
ip_address string	Deprecated Use provider to specify PAN-OS connectivity instead. The IP address or hostname of the PAN-OS device being configured.
manager string	IP address or FQDN of SNMP manager to use.
name string	Name of the server.
password string	Deprecated Use provider to specify PAN-OS connectivity instead. The password to use for authentication. This is ignored if api_key is specified.
port integer	Deprecated Use provider to specify PAN-OS connectivity instead. The port number to connect to the PAN-OS device on. Default: :ansible-option-default:`443`
priv_password string	Privacy protocol password.
provider dictionary added in paloaltonetworks.panos 1.0.0	A dict object containing connection details.
api_key string	The API key to use instead of generating it using username / password.
ip_address string	The IP address or hostname of the PAN-OS device being configured.
password string	The password to use for authentication. This is ignored if api_key is specified.
port integer	The port number to connect to the PAN-OS device on. Default: :ansible-option-default:`443`
serial_number string	The serial number of a firewall to use for targeted commands. If ip_address is not a Panorama PAN-OS device, then this param is ignored.
username string	The username to use for authentication. This is ignored if api_key is specified. Default: :ansible-option-default:`"admin"`
snmp_profile string / required	Name of the SNMP server profile.
state string	The state. Choices: :ansible-option-choices-entry-default:`"present"` ← (default) :ansible-option-choices-entry:`"absent"` :ansible-option-choices-entry:`"replaced"` :ansible-option-choices-entry:`"merged"` :ansible-option-choices-entry:`"deleted"` :ansible-option-choices-entry:`"gathered"`
user string	User
username string	Deprecated Use provider to specify PAN-OS connectivity instead. The username to use for authentication. This is ignored if api_key is specified. Default: :ansible-option-default:`"admin"`
vsys string	The vsys this object belongs to. Default: :ansible-option-default:`"shared"`

Notes

Note

• Panorama is supported.

• Check mode is supported.

• PAN-OS connectivity should be specified using provider or the classic PAN-OS connectivity params (ip_address, username, password, api_key, and port). If both are present, then the classic params are ignored.

Examples

# Create snmp v3 server
- name: Create snmp v3 server
  paloaltonetworks.panos.panos_snmp_v3_server:
    provider: '{{ provider }}'
    snmp_profile: 'my-profile'
    name: 'my-v3-server'
    manager: '192.168.55.10'
    user: 'jdoe'
    auth_password: 'password'
    priv_password: 'drowssap'

Authors

• Garfield Lee Freeman (@shinmog)

Collection links

Issue Tracker Homepage Repository (Sources)