fortiswitch_switch_macsec_profile – MACsec configuration profiles 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 switch_macsec feature and profile 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.11

FortiSW Version Compatibility


v7.0.0 v7.0.1 v7.0.2 v7.0.3
fortiswitch_switch_macsec_profile yes yes yes yes

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
  • switch_macsec_profile - MACsec configuration profiles. type: dict
    • cipher_suite - MACsec cipher suite. type: str choices: GCM_AES_128
    • confident_offset - Choose different confident offset bytes. type: str choices: 0, 30, 50
    • encrypt_traffic - Enable/disable Encryption of MACsec traffic. type: str choices: enable, disable
    • include_macsec_sci - Include MACsec TX SCI. type: str choices: enable, disable
    • include_mka_icv_ind - Include MKA ICV indicator. type: str choices: enable
    • macsec_mode - Set mode of the MACsec Profile. type: str choices: static-cak
    • macsec_validate - Choose different MACsec validate mode. type: str choices: strict
    • mka_priority - MACsec MKA priority. type: int
    • mka_psk - MACsec MKA pre-shared key configuration. type: list member_path: mka_psk:name
      • crypto_alg - PSK crypto algorithm. type: str choices: AES_128_CMAC
      • mka_cak - MKA CAK pre-shared key hex string. type: str
      • mka_ckn - MKA CKN pre-shared key hex string. type: str
      • name - pre-shared-key name. type: str required: true
      • status - Status of this PSK. type: str choices: active
    • name - Profile name. type: str required: true
    • replay_protect - Enable/disable MACsec replay protection. type: str choices: enable, disable
    • replay_window - MACsec replay window size. type: int
    • status - Enable/disable this Profile. type: str choices: enable, disable
    • traffic_policy - MACsec traffic policy configuration. type: list member_path: traffic_policy:name
      • name - Traffic policy type name. type: str required: true
      • security_policy - Must/Should secure the traffic. type: str choices: must-secure
      • status - Enable/disable this Traffic policy. type: str choices: enable

Examples

- hosts: fortiswitch01
  collections:
    - fortinet.fortiswitch
  connection: httpapi
  vars:
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: MACsec configuration profiles.
    fortiswitch_switch_macsec_profile:
      state: "present"
      switch_macsec_profile:
        cipher_suite: "GCM_AES_128"
        confident_offset: "0"
        encrypt_traffic: "enable"
        include_macsec_sci: "enable"
        include_mka_icv_ind: "enable"
        macsec_mode: "static-cak"
        macsec_validate: "strict"
        mka_priority: "10"
        mka_psk:
         -
            crypto_alg: "AES_128_CMAC"
            mka_cak: "<your_own_value>"
            mka_ckn: "<your_own_value>"
            name: "default_name_15"
            status: "active"
        name: "default_name_17"
        replay_protect: "enable"
        replay_window: "19"
        status: "enable"
        traffic_policy:
         -
            name: "default_name_22"
            security_policy: "must-secure"
            status: "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.

Authors

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

Hint

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