fortinet.fortimanager.fmgr_system_snmp_sysinfo – SNMP configuration.

From Get docs
Ansible/docs/2.11/collections/fortinet/fortimanager/fmgr system snmp sysinfo module


fortinet.fortimanager.fmgr_system_snmp_sysinfo – SNMP configuration.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_snmp_sysinfo.


New in version 2.10: of fortinet.fortimanager


Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter Choices/Defaults Comments

bypass_validation

boolean

  • no

  • yes

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

  • present
  • absent

the directive to create, update or delete an object

system_snmp_sysinfo

dictionary

the top level parameters set

contact_info

string

Contact information.

description

string

System description.

engine-id

string

Local SNMP engineID string (maximum 24 characters).

location

string

System location.

status

string

  • disable

  • enable

Enable/disable SNMP.

disable - Disable setting.

enable - Enable setting.

trap-cpu-high-exclude-nice-threshold

integer

Default:

80

SNMP trap for CPU usage threshold (exclude NICE processes).

trap-high-cpu-threshold

integer

Default:

80

SNMP trap for CPU usage threshold.

trap-low-memory-threshold

integer

Default:

80

SNMP trap for memory usage threshold.

workspace_locking_adom

string

the adom to lock for FortiManager running in workspace mode, the value can be global and others including root

workspace_locking_timeout

integer

Default:

300

the maximum time in seconds to wait for other user to release the workspace lock



Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
  • To create or update an object, use state present directive.
  • To delete an object, use state absent directive.
  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded


Examples

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: SNMP configuration.
     fmgr_system_snmp_sysinfo:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        system_snmp_sysinfo:
           contact_info: <value of string>
           description: <value of string>
           engine-id: <value of string>
           location: <value of string>
           status: <value in [disable, enable]>
           trap-cpu-high-exclude-nice-threshold: <value of integer>
           trap-high-cpu-threshold: <value of integer>
           trap-low-memory-threshold: <value of integer>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

request_url

string

always

The full url requested


Sample:

/sys/login/user

response_code

integer

always

The status of api request


response_message

string

always

The descriptive message of the api response


Sample:

OK.




Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_snmp_sysinfo_module.html