fortinet.fortimanager.fmgr_log_npuserver_servergroup module – create server group.

Note

This module is part of the fortinet.fortimanager collection (version 2.7.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

New in fortinet.fortimanager 2.2.0

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

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

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

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

log_npuserver_servergroup

dictionary

The top level parameters set.

group-name

string

Deprecated, please rename it to group_name. Server group name.

log-format

string

Deprecated, please rename it to log_format. Set the log format

Choices:

  • "syslog"

  • "netflow"

log-gen-event

string

Deprecated, please rename it to log_gen_event. Enable/disbale generating event for Per-Mapping log

Choices:

  • "disable"

  • "enable"

log-mode

string

Deprecated, please rename it to log_mode. Set the log mode

Choices:

  • "per-session"

  • "per-nat-mapping"

  • "per-session-ending"

log-tx-mode

string

Deprecated, please rename it to log_tx_mode. Configure log transmit mode.

Choices:

  • "multicast"

  • "roundrobin"

log-user-info

string

Deprecated, please rename it to log_user_info. Enable/disbale logging user information.

Choices:

  • "disable"

  • "enable"

server-number

integer

Deprecated, please rename it to server_number. Server number in this group.

server-start-id

integer

Deprecated, please rename it to server_start_id. The start id of the continuous server series in this group,[1,16].

sw-log-flags

any

(int or str) Deprecated, please rename it to sw_log_flags. Set flags for software logging via driver.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

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

rc_succeeded

list / elements=integer

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

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

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

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

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Create server group.
      fortinet.fortimanager.fmgr_log_npuserver_servergroup:
        # 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, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        log_npuserver_servergroup:
          group_name: <string>
          log_format: <value in [syslog, netflow]>
          log_mode: <value in [per-session, per-nat-mapping, per-session-ending]>
          log_tx_mode: <value in [multicast, roundrobin]>
          server_number: <integer>
          server_start_id: <integer>
          sw_log_flags: <integer or string> <value in [tcp-udp-only, enable-all-log, disable-all-log]>
          log_gen_event: <value in [disable, enable]>
          log_user_info: <value in [disable, enable]>

Return Values

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

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)