fortiswitch_user_peer – config peer use in Fortinet’s FortiSwitch
New in version 1.0.0.
Synopsis
This module is able to configure a FortiSwitch device by allowing the user to set and modify user feature and peer category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v7.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.14
FortiSW Version Compatibility
| Supported Version Ranges | |
| fortiswitch_user_peer | v7.0.0 -> latest |
Parameters
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- 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
- user_peer - config peer user type: dict
- ca - peer certificate CA (CA name in local) type: str
- cn - peer certificate common name type: str
- cn_type - peer certificate common name type type: str choices: string, email, FQDN, ipv4, ipv6
- ldap_mode - peer ldap mode type: str choices: password, principal-name
- ldap_password - password for LDAP server bind type: str
- ldap_server - LDAP server for access rights check type: str
- ldap_username - username for LDAP server bind type: str
- mandatory_ca_verify - mandatory CA verify type: str choices: enable, disable
- name - peer name type: str required: true
- passwd - Config user password type: str
- subject - peer certificate name constraints type: str
- two_factor - Enable 2-factor authentication (certificate + password) type: str choices: enable, disable
Examples
- name: config peer user
fortinet.fortiswitch.fortiswitch_user_peer:
state: "present"
user_peer:
ca: "<your_own_value> (source system.certificate.ca.name)"
cn: "<your_own_value>"
cn_type: "string"
ldap_mode: "password"
ldap_password: "<your_own_value>"
ldap_server: "<your_own_value> (source user.ldap.name)"
ldap_username: "<your_own_value>"
mandatory_ca_verify: "enable"
name: "default_name_11"
passwd: "<your_own_value>"
subject: "<your_own_value>"
two_factor: "enable"
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 fortiSwitch image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
- http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiSwitch 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
- serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
- status - Indication of the operation's result returned: always type: str sample: success
- version - Version of the FortiSwitch returned: always type: str sample: v7.0.0
Status
This module is not guaranteed to have a backwards compatible interface.