lix_fortinet.fortios.fortios_system_virtual_switch (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 system feature and virtual_switch 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 virtual hardware switch interfaces.
    fortios_system_virtual_switch:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_virtual_switch:
        name: "default_name_3"
        physical_switch: "<your_own_value> (source system.physical-switch.name)"
        port:
         -
            alias: "<your_own_value>"
            mediatype: "cfp2-sr10"
            name: "default_name_8 (source system.interface.name)"
            speed: "auto"
            status: "up"
        span: "disable"
        span_dest_port: "<your_own_value>"
        span_direction: "rx"
        span_source_port: "<your_own_value>"

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

system_virtual_switch:
    default: null
    description:
    - Configure virtual hardware switch interfaces.
    suboptions:
      name:
        description:
        - Name of the virtual switch.
        required: true
        type: str
      physical_switch:
        description:
        - Physical switch parent. Source system.physical-switch.name.
        type: str
      port:
        description:
        - Configure member ports.
        elements: dict
        suboptions:
          alias:
            description:
            - Alias.
            type: str
          mediatype:
            choices:
            - cfp2-sr10
            - cfp2-lr4
            description:
            - Select SFP media interface type.
            type: str
          name:
            description:
            - Physical interface name. Source system.interface.name.
            type: str
          speed:
            choices:
            - auto
            - 10full
            - 10half
            - 100full
            - 100half
            - 1000full
            - 1000half
            - 1000auto
            - 10000full
            - 10000auto
            - 40000full
            - 100Gfull
            description:
            - Interface speed.
            type: str
          status:
            choices:
            - up
            - down
            description:
            - Interface status.
            type: str
        type: list
      span:
        choices:
        - disable
        - enable
        description:
        - Enable/disable SPAN.
        type: str
      span_dest_port:
        description:
        - SPAN destination port.
        type: str
      span_direction:
        choices:
        - rx
        - tx
        - both
        description:
        - SPAN direction.
        type: str
      span_source_port:
        description:
        - SPAN source port.
        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