lix_fortinet.fortios.fortios_switch_controller_nac_device (102.2.120) — module

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120

Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

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

Requirements

• ansible>=2.9

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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: Configure/list NAC devices learned on the managed FortiSwitch ports which matches NAC policy.
    fortios_switch_controller_nac_device:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_nac_device:
        description: "<your_own_value>"
        id:  "4"
        last_known_port: "<your_own_value>"
        last_known_switch: "<your_own_value> (source switch-controller.managed-switch.switch-id)"
        last_seen: "2147483647"
        mac: "<your_own_value>"
        mac_policy: "<your_own_value> (source switch-controller.mac-policy.name)"
        matched_nac_policy: "<your_own_value> (source user.nac-policy.name)"
        port_policy: "<your_own_value> (source switch-controller.port-policy.name)"
        status: "enable"

Inputs

    
vdom:
    default: root
    description:
    - 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

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

switch_controller_nac_device:
    default: null
    description:
    - Configure/list NAC devices learned on the managed FortiSwitch ports which matches
      NAC policy.
    suboptions:
      description:
        description:
        - Description for the learned NAC device.
        type: str
      id:
        description:
        - Device ID.
        required: true
        type: int
      last_known_port:
        description:
        - Managed FortiSwitch port where NAC device is last learned.
        type: str
      last_known_switch:
        description:
        - Managed FortiSwitch where NAC device is last learned. Source switch-controller.managed-switch.switch-id.
        type: str
      last_seen:
        description:
        - Device last seen.
        type: int
      mac:
        description:
        - MAC address of the learned NAC device.
        type: str
      mac_policy:
        description:
        - MAC policy to be applied on this learned NAC device. Source switch-controller.mac-policy.name.
        type: str
      matched_nac_policy:
        description:
        - Matched NAC policy for the learned NAC device. Source user.nac-policy.name.
        type: str
      port_policy:
        description:
        - Port policy to be applied on this learned NAC device. Source switch-controller.port-policy.name.
        type: str
      status:
        choices:
        - enable
        - disable
        description:
        - Status of the learned NAC device. Set enable to authorize the NAC device.
        type: str
    type: dict

Outputs

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