Skip to content

Latest commit

 

History

History
324 lines (280 loc) · 13.1 KB

fortios_credential_store_domain_controller.rst

File metadata and controls

324 lines (280 loc) · 13.1 KB
Raw
source:fortios_credential_store_domain_controller.py
orphan:

fortios_credential_store_domain_controller -- Define known domain controller servers in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify credential_store feature and domain_controller category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

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

  • ansible>=2.9

FortiOS Version Compatibility


v6.4.0 v6.4.1 v6.4.4
fortios_credential_store_domain_controller yes yes yes

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • credential_store_domain_controller - Define known domain controller servers. type: dict more...
    v6.4.0 v6.4.1 v6.4.4
    credential_store_domain_controller yes yes yes
    • domain_name - Fully qualified domain name (FQDN). type: str more...
      v6.4.0 v6.4.1 v6.4.4
      domain_name yes yes yes
    • hostname - Hostname of the server to connect to. type: str more...
      v6.4.0 v6.4.1 v6.4.4
      hostname yes no yes
    • ip - IPv4 server address. type: str more...
      v6.4.0 v6.4.1 v6.4.4
      ip yes yes yes
    • ip6 - IPv6 server address. type: str more...
      v6.4.0 v6.4.1 v6.4.4
      ip6 yes yes yes
    • password - Password for specified username. type: str more...
      v6.4.0 v6.4.1 v6.4.4
      password yes yes yes
    • port - Port number of service. Port number 0 indicates automatic discovery. type: int more...
      v6.4.0 v6.4.1 v6.4.4
      port yes yes yes
    • server_name - Name of the domain controller. type: str more...
      v6.4.0 v6.4.1 v6.4.4
      server_name yes yes yes
    • username - User name to sign in with. Must have proper permissions for service. type: str more...
      v6.4.0 v6.4.1 v6.4.4
      username yes yes yes

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Define known domain controller servers.
    fortios_credential_store_domain_controller:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      credential_store_domain_controller:
        domain_name: "<your_own_value>"
        hostname: "myhostname"
        ip: "<your_own_value>"
        ip6: "<your_own_value>"
        password: "<your_own_value>"
        port: "32767"
        server_name: "<your_own_value>"
        username: "<your_own_value>"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.