Docs4dev
Docs
ansible / 2.11 / collections / fortinet / fortimanager / fmgr_devprof_system_ntp_module.html

fortinet.fortimanager.fmgr_devprof_system_ntp – Configure system NTP information.

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_devprof_system_ntp.

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
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
devprof
string / required
the parameter (devprof) in requested url
devprof_system_ntp
dictionary
the top level parameters set
ntpserver
list / elements=string
no description
authentication
string
    Choices:
  • disable
  • enable
Enable/disable MD5 authentication.
id
integer
NTP server ID.
key
string
no description
key-id
integer
Key ID for authentication.
ntpv3
string
    Choices:
  • disable
  • enable
Enable to use NTPv3 instead of NTPv4.
server
string
IP address or hostname of the NTP Server.
ntpsync
string
    Choices:
  • disable
  • enable
Enable/disable setting the FortiGate system time by synchronizing with an NTP Server.
source-ip6
string
Source IPv6 address for communication to the NTP server.
syncinterval
integer
NTP synchronization interval (1 - 1440 min).
type
string
    Choices:
  • fortiguard
  • custom
Use the FortiGuard NTP server or any other available NTP Server.
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
    Choices:
  • present
  • absent
the directive to create, update or delete an object
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: Configure system NTP information.
     fmgr_devprof_system_ntp:
        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>
        devprof: <your own value>
        devprof_system_ntp:
           ntpserver:
             -
                 authentication: <value in [disable, enable]>
                 id: <value of integer>
                 key: <value of string>
                 key-id: <value of integer>
                 ntpv3: <value in [disable, enable]>
                 server: <value of string>
           ntpsync: <value in [disable, enable]>
           source-ip6: <value of string>
           syncinterval: <value of integer>
           type: <value in [fortiguard, custom]>

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_devprof_system_ntp_module.html