fortinet.fortimanager.fmgr_user_azure module – User azure

Note

This module is part of the fortinet.fortimanager collection (version 2.15.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_user_azure.

New in fortinet.fortimanager 2.15.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.

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.

revision_note

string

The change note that can be specified when an object is created or updated.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

user_azure

dictionary

The top level parameters set.

alias

string

Alias.

kbconfig

string

Kbconfig.

name

string / required

Name.

page_size

integer

Page size.

password

list / elements=string

Password.

proxy_enable

string

Proxy enable.

Choices:

  • "disable"

  • "enable"

proxy_host

string

Proxy host.

proxy_passwd

list / elements=string

Proxy passwd.

proxy_scheme

string

Proxy scheme.

Choices:

  • "http"

  • "https"

proxy_user

string

Proxy user.

realm

string

Realm.

region

string

Region.

Choices:

  • "global"

  • "china"

  • "germany"

  • "usgov"

  • "local"

rule

list / elements=dictionary

Rule.

name

string

Name.

rule

string

Rule.

select_proxy

string

Select proxy.

Choices:

  • "basic"

  • "kerberos"

SPN

string

SPN.

status

string

Status.

Choices:

  • "disable"

  • "enable"

tenantid

string

Tenantid.

upd_interval

integer

Upd interval.

user

string

User.

verifycert

string

Verifycert.

Choices:

  • "disable"

  • "enable"

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.

  • 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

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

Examples

- name: Test Azure users
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Create an Azure user connector
      fortinet.fortimanager.fmgr_user_azure:
        enable_log: true
        adom: root
        state: present
        user_azure:
          name: test_azure

- name: Test Azure user rules
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Create the parent Azure user connector
      fortinet.fortimanager.fmgr_user_azure:
        enable_log: true
        adom: root
        state: present
        user_azure:
          name: test_azure

    - name: Create an Azure user rule
      fortinet.fortimanager.fmgr_user_azure_rule:
        enable_log: true
        adom: root
        azure: test_azure
        state: present
        user_azure_rule:
          name: test_rule

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)