fortinet.fortios.fortios_switch_controller_switch_group – Configure FortiSwitch switch groups in Fortinet’s FortiOS and FortiGate.  Note This plugin is part of the fortinet.fortios collection (version 2.1.2). You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list. To install it, use: ansible-galaxy collection install fortinet.fortios. To use it in a playbook, specify: fortinet.fortios.fortios_switch_controller_switch_group.   New in version 2.10: of fortinet.fortios   Synopsis Requirements Parameters Notes Examples Return Values  Synopsis  This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and switch_group category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0  Requirements The below requirements are needed on the host that executes this module.  ansible>=2.9.0  Parameters   Parameter Choices/Defaults Comments    access_token  string      Token-based authentication. Generated from GUI of Fortigate.     enable_log  boolean    
Choices: 
no ← yes    Enable/Disable logging for task.     state  string / required    
Choices: present absent    Indicates whether to create or remove the object.     switch_controller_switch_group  dictionary      Configure FortiSwitch switch groups.      description  string      Optional switch group description.      fortilink  string      FortiLink interface to which switch group members belong. Source system.interface.name.      members  list / elements=string      FortiSwitch members belonging to this switch group.       name  string / required      Managed device ID. Source switch-controller.managed-switch.switch-id.       switch_id  string      Managed device ID. Source switch-controller.managed-switch.switch-id.      name  string / required      Switch group name.     vdom  string    Default:"root"   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.     Notes  Note  Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks   Examples - 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 FortiSwitch switch groups.
    fortios_switch_controller_switch_group:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_switch_group:
        description: "<your_own_value>"
        fortilink: "<your_own_value> (source system.interface.name)"
        members:
         -
            name: "default_name_6 (source switch-controller.managed-switch.switch-id)"
            switch_id: "<your_own_value> (source switch-controller.managed-switch.switch-id)"
        name: "default_name_8"
 Return Values Common return values are documented here, the following are the fields unique to this module:   Key Returned Description    build  string   always  Build number of the fortigate image  Sample: 1547     http_method  string   always  Last method used to provision the content into FortiGate  Sample: PUT     http_status  string   always  Last result given by FortiGate on last operation applied  Sample: 200     mkey  string   success  Master key (id) used in the last call to FortiGate  Sample: id     name  string   always  Name of the table used to fulfill the request  Sample: urlfilter     path  string   always  Path of the table used to fulfill the request  Sample: webfilter     revision  string   always  Internal revision number  Sample: 30.455-91-61608     serial  string   always  Serial number of the unit  Sample: FGVMEVYYQT3AB5352     status  string   always  Indication of the operation's result  Sample: success     vdom  string   always  Virtual domain used  Sample: root     version  string   always  Version of the FortiGate  Sample: v5.6.3     Authors  Link Zheng (@chillancezen) Jie Xue (@JieX19) Hongbin Lu (@fgtdev-hblu) Frank Shen (@frankshen01) Miguel Angel Munoz (@mamunozgonzalez) Nicolas Thomas (@thomnico) 

    © 2012–2018 Michael DeHaan
{'path': 'public/docs/ansible/collections/fortinet/fortios/fortios_switch_controller_switch_group_module.html', 'source': 'DevDocs.IO'}