source: | fortios_wireless_controller_apcfg_profile.py |
---|---|
orphan: |
fortios_wireless_controller_apcfg_profile -- Configure AP local configuration profiles in Fortinet's FortiOS and FortiGate.
.. versionadded:: 2.0.0
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and apcfg_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
The below requirements are needed on the host that executes this module.
- ansible>=2.14
Using member operation to add an element to an existing object.
Supported Version Ranges | |
fortios_wireless_controller_apcfg_profile | v6.4.0 -> latest |
- 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
- wireless_controller_apcfg_profile - Configure AP local configuration profiles. type: dict
more...
Supported Version Ranges wireless_controller_apcfg_profile v6.4.0 -> latest
- ac_ip - IP address of the validation controller that AP must be able to join after applying AP local configuration. type: str
more...
Supported Version Ranges ac_ip v6.4.0 -> latest
- ac_port - Port of the validation controller that AP must be able to join after applying AP local configuration (1024 - 49150). type: int
more...
Supported Version Ranges ac_port v6.4.0 -> latest
- ac_timer - Maximum waiting time for the AP to join the validation controller after applying AP local configuration (3 - 30 min). type: int
more...
Supported Version Ranges ac_timer v6.4.0 -> latest
- ac_type - Validation controller type . type: str choices: default, specify, apcfg
more...
Supported Version Ranges ac_type v6.4.0 -> latest
[default] v6.0.0 -> latest
[specify] v6.0.0 -> latest
[apcfg] v6.0.0 -> latest
- ap_family - FortiAP family type . type: str choices: fap, fap-u, fap-c
more...
Supported Version Ranges ap_family v7.0.2 -> latest
[fap] v6.0.0 -> latest
[fap-u] v6.0.0 -> latest
[fap-c] v6.0.0 -> latest
- command_list - AP local configuration command list. type: list member_path: command_list:id
more...
Supported Version Ranges command_list v6.4.0 -> latest
- id - Command ID. see Notes. type: int required: true
more...
Supported Version Ranges id v6.4.0 -> latest
- name - AP local configuration command name. type: str
more...
Supported Version Ranges name v6.4.0 -> latest
- passwd_value - AP local configuration command password value. type: str
more...
Supported Version Ranges passwd_value v6.4.0 -> latest
- type - The command type . type: str choices: non-password, password
more...
Supported Version Ranges type v6.4.0 -> latest
[non-password] v6.0.0 -> latest
[password] v6.0.0 -> latest
- value - AP local configuration command value. type: str
more...
Supported Version Ranges value v6.4.0 -> latest
- comment - Comment. type: str
more...
Supported Version Ranges comment v6.4.0 -> latest
- name - AP local configuration profile name. type: str required: true
more...
Supported Version Ranges name v6.4.0 -> latest
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- name: Configure AP local configuration profiles.
fortinet.fortios.fortios_wireless_controller_apcfg_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_apcfg_profile:
ac_ip: "<your_own_value>"
ac_port: "0"
ac_timer: "10"
ac_type: "default"
ap_family: "fap"
command_list:
-
id: "9"
name: "default_name_10"
passwd_value: "<your_own_value>"
type: "non-password"
value: "<your_own_value>"
comment: "Comment."
name: "default_name_15"
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
- This module is not guaranteed to have a backwards compatible interface.
- 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.