You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

fortinet.fortimanager.fmgr_switchcontroller_managedswitch module – no description

Note

This module is part of the fortinet.fortimanager collection (version 2.1.7).

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.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_switchcontroller_managedswitch.

New in fortinet.fortimanager 1.0.0

Synopsis

• This module is able to configure a FortiManager device.

• Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter	Comments
adom string / required	the parameter (adom) in requested url
bypass_validation boolean	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters Choices: false ← (default) true
enable_log boolean	Enable/Disable logging for task Choices: false ← (default) true
proposed_method string	The overridden method for the underlying Json RPC request Choices: "update" "set" "add"
rc_failed list / elements=string	the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string	the rc codes list with which the conditions to succeed will be overriden
state string / required	the directive to create, update or delete an object Choices: "present" "absent"
switchcontroller_managedswitch dictionary	the top level parameters set
_platform string	no description
custom-command list / elements=string	no description
command-entry string	no description
command-name string	no description
description string	no description
dhcp-server-access-list string	no description Choices: "disable" "enable" "global"
firmware-provision string	no description Choices: "disable" "enable"
firmware-provision-latest string	no description Choices: "disable" "once"
firmware-provision-version string	no description
ip-source-guard list / elements=string	description
binding-entry list / elements=string	description
entry-name string	no description
ip string	no description
mac string	no description
description string	no description
port string	no description
l3-discovered integer	no description
mclag-igmp-snooping-aware string	no description Choices: "disable" "enable"
name string	no description
override-snmp-community string	no description Choices: "disable" "enable"
override-snmp-sysinfo string	no description Choices: "disable" "enable"
override-snmp-trap-threshold string	no description Choices: "disable" "enable"
override-snmp-user string	no description Choices: "disable" "enable"
poe-detection-type integer	no description
ports list / elements=string	no description
access-mode string	no description Choices: "normal" "nac" "dynamic" "static"
aggregator-mode string	no description Choices: "bandwidth" "count"
allowed-vlans string	no description
allowed-vlans-all string	no description Choices: "disable" "enable"
arp-inspection-trust string	no description Choices: "untrusted" "trusted"
bundle string	no description Choices: "disable" "enable"
description string	no description
dhcp-snoop-option82-trust string	no description Choices: "disable" "enable"
dhcp-snooping string	no description Choices: "trusted" "untrusted"
discard-mode string	no description Choices: "none" "all-untagged" "all-tagged"
dsl-profile string	no description
edge-port string	no description Choices: "disable" "enable"
export-to-pool-flag integer	no description
fec-capable integer	no description
fec-state string	no description Choices: "disabled" "cl74" "cl91"
flap-duration integer	no description
flap-rate integer	no description
flap-timeout integer	no description
flapguard string	no description Choices: "disable" "enable"
flow-control string	no description Choices: "disable" "tx" "rx" "both"
igmp-snooping string	no description Choices: "disable" "enable"
igmps-flood-reports string	no description Choices: "disable" "enable"
igmps-flood-traffic string	no description Choices: "disable" "enable"
interface-tags string	description
ip-source-guard string	no description Choices: "disable" "enable"
lacp-speed string	no description Choices: "slow" "fast"
learning-limit integer	no description
lldp-profile string	no description
lldp-status string	no description Choices: "disable" "rx-only" "tx-only" "tx-rx"
loop-guard string	no description Choices: "disabled" "enabled"
loop-guard-timeout integer	no description
mac-addr string	no description
matched-dpp-intf-tags string	no description
matched-dpp-policy string	no description
max-bundle integer	no description
mclag string	no description Choices: "disable" "enable"
mclag-icl-port integer	no description
media-type string	no description
member-withdrawal-behavior string	no description Choices: "forward" "block"
members string	no description
min-bundle integer	no description
mode string	no description Choices: "static" "lacp-passive" "lacp-active"
p2p-port integer	no description
packet-sample-rate integer	no description
packet-sampler string	no description Choices: "disabled" "enabled"
pause-meter integer	no description
pause-meter-resume string	no description Choices: "25%" "50%" "75%"
poe-max-power string	no description
poe-pre-standard-detection string	no description Choices: "disable" "enable"
poe-standard string	no description
poe-status string	no description Choices: "disable" "enable"
port-name string	no description
port-owner string	no description
port-policy string	no description
port-security-policy string	no description
port-selection-criteria string	no description Choices: "src-mac" "dst-mac" "src-dst-mac" "src-ip" "dst-ip" "src-dst-ip"
qos-policy string	no description
rpvst-port string	no description Choices: "disabled" "enabled"
sample-direction string	no description Choices: "rx" "tx" "both"
sflow-counter-interval integer	no description
sflow-sample-rate integer	no description
sflow-sampler string	no description Choices: "disabled" "enabled"
status string	no description Choices: "down" "up"
sticky-mac string	no description Choices: "disable" "enable"
storm-control-policy string	no description
stp-bpdu-guard string	no description Choices: "disabled" "enabled"
stp-bpdu-guard-timeout integer	no description
stp-root-guard string	no description Choices: "disabled" "enabled"
stp-state string	no description Choices: "disabled" "enabled"
trunk-member integer	no description
type string	no description Choices: "physical" "trunk"
untagged-vlans string	no description
vlan string	no description
qos-drop-policy string	no description Choices: "taildrop" "random-early-detection"
qos-red-probability integer	no description
remote-log list / elements=string	description
csv string	no description Choices: "disable" "enable"
facility string	no description Choices: "kernel" "user" "mail" "daemon" "auth" "syslog" "lpr" "news" "uucp" "cron" "authpriv" "ftp" "ntp" "audit" "alert" "clock" "local0" "local1" "local2" "local3" "local4" "local5" "local6" "local7"
name string	no description
port integer	no description
server string	no description
severity string	no description Choices: "emergency" "alert" "critical" "error" "warning" "notification" "information" "debug"
status string	no description Choices: "disable" "enable"
snmp-community list / elements=string	description
events list / elements=string	description Choices: "cpu-high" "mem-low" "log-full" "intf-ip" "ent-conf-change"
hosts list / elements=string	description
id integer	no description
ip string	no description
id integer	no description
name string	no description
query-v1-port integer	no description
query-v1-status string	no description Choices: "disable" "enable"
query-v2c-port integer	no description
query-v2c-status string	no description Choices: "disable" "enable"
status string	no description Choices: "disable" "enable"
trap-v1-lport integer	no description
trap-v1-rport integer	no description
trap-v1-status string	no description Choices: "disable" "enable"
trap-v2c-lport integer	no description
trap-v2c-rport integer	no description
trap-v2c-status string	no description Choices: "disable" "enable"
snmp-user list / elements=string	description
auth-proto string	no description Choices: "md5" "sha"
auth-pwd string	description
name string	no description
priv-proto string	no description Choices: "des" "aes"
priv-pwd string	description
queries string	no description Choices: "disable" "enable"
query-port integer	no description
security-level string	no description Choices: "no-auth-no-priv" "auth-no-priv" "auth-priv"
switch-dhcp_opt43_key string	no description
switch-id string	no description
tdr-supported string	no description
workspace_locking_adom string	the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout integer	the maximum time in seconds to wait for other user to release the workspace lock Default: 300

Notes

Note

• Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

• To create or update an object, use state present directive.

• To delete an object, use state absent directive.

• Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: no description
     fmgr_switchcontroller_managedswitch:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        switchcontroller_managedswitch:
           _platform: <value of string>
           description: <value of string>
           name: <value of string>
           ports:
             -
                 allowed-vlans: <value of string>
                 allowed-vlans-all: <value in [disable, enable]>
                 arp-inspection-trust: <value in [untrusted, trusted]>
                 bundle: <value in [disable, enable]>
                 description: <value of string>
                 dhcp-snoop-option82-trust: <value in [disable, enable]>
                 dhcp-snooping: <value in [trusted, untrusted]>
                 discard-mode: <value in [none, all-untagged, all-tagged]>
                 edge-port: <value in [disable, enable]>
                 igmp-snooping: <value in [disable, enable]>
                 igmps-flood-reports: <value in [disable, enable]>
                 igmps-flood-traffic: <value in [disable, enable]>
                 lacp-speed: <value in [slow, fast]>
                 learning-limit: <value of integer>
                 lldp-profile: <value of string>
                 lldp-status: <value in [disable, rx-only, tx-only, ...]>
                 loop-guard: <value in [disabled, enabled]>
                 loop-guard-timeout: <value of integer>
                 max-bundle: <value of integer>
                 mclag: <value in [disable, enable]>
                 member-withdrawal-behavior: <value in [forward, block]>
                 members: <value of string>
                 min-bundle: <value of integer>
                 mode: <value in [static, lacp-passive, lacp-active]>
                 poe-pre-standard-detection: <value in [disable, enable]>
                 poe-status: <value in [disable, enable]>
                 port-name: <value of string>
                 port-owner: <value of string>
                 port-security-policy: <value of string>
                 port-selection-criteria: <value in [src-mac, dst-mac, src-dst-mac, ...]>
                 qos-policy: <value of string>
                 sample-direction: <value in [rx, tx, both]>
                 sflow-counter-interval: <value of integer>
                 sflow-sample-rate: <value of integer>
                 sflow-sampler: <value in [disabled, enabled]>
                 stp-bpdu-guard: <value in [disabled, enabled]>
                 stp-bpdu-guard-timeout: <value of integer>
                 stp-root-guard: <value in [disabled, enabled]>
                 stp-state: <value in [disabled, enabled]>
                 type: <value in [physical, trunk]>
                 untagged-vlans: <value of string>
                 vlan: <value of string>
                 export-to-pool-flag: <value of integer>
                 mac-addr: <value of string>
                 packet-sample-rate: <value of integer>
                 packet-sampler: <value in [disabled, enabled]>
                 sticky-mac: <value in [disable, enable]>
                 storm-control-policy: <value of string>
                 access-mode: <value in [normal, nac, dynamic, ...]>
                 ip-source-guard: <value in [disable, enable]>
                 mclag-icl-port: <value of integer>
                 p2p-port: <value of integer>
                 aggregator-mode: <value in [bandwidth, count]>
                 rpvst-port: <value in [disabled, enabled]>
                 flow-control: <value in [disable, tx, rx, ...]>
                 media-type: <value of string>
                 pause-meter: <value of integer>
                 pause-meter-resume: <value in [25%, 50%, 75%]>
                 trunk-member: <value of integer>
                 fec-capable: <value of integer>
                 fec-state: <value in [disabled, cl74, cl91]>
                 matched-dpp-intf-tags: <value of string>
                 matched-dpp-policy: <value of string>
                 port-policy: <value of string>
                 status: <value in [down, up]>
                 dsl-profile: <value of string>
                 flap-duration: <value of integer>
                 flap-rate: <value of integer>
                 flap-timeout: <value of integer>
                 flapguard: <value in [disable, enable]>
                 interface-tags: <value of string>
                 poe-max-power: <value of string>
                 poe-standard: <value of string>
           switch-id: <value of string>
           override-snmp-community: <value in [disable, enable]>
           override-snmp-sysinfo: <value in [disable, enable]>
           override-snmp-trap-threshold: <value in [disable, enable]>
           override-snmp-user: <value in [disable, enable]>
           poe-detection-type: <value of integer>
           remote-log:
             -
                 csv: <value in [disable, enable]>
                 facility: <value in [kernel, user, mail, ...]>
                 name: <value of string>
                 port: <value of integer>
                 server: <value of string>
                 severity: <value in [emergency, alert, critical, ...]>
                 status: <value in [disable, enable]>
           snmp-community:
             -
                 events:
                   - cpu-high
                   - mem-low
                   - log-full
                   - intf-ip
                   - ent-conf-change
                 hosts:
                   -
                       id: <value of integer>
                       ip: <value of string>
                 id: <value of integer>
                 name: <value of string>
                 query-v1-port: <value of integer>
                 query-v1-status: <value in [disable, enable]>
                 query-v2c-port: <value of integer>
                 query-v2c-status: <value in [disable, enable]>
                 status: <value in [disable, enable]>
                 trap-v1-lport: <value of integer>
                 trap-v1-rport: <value of integer>
                 trap-v1-status: <value in [disable, enable]>
                 trap-v2c-lport: <value of integer>
                 trap-v2c-rport: <value of integer>
                 trap-v2c-status: <value in [disable, enable]>
           snmp-user:
             -
                 auth-proto: <value in [md5, sha]>
                 auth-pwd: <value of string>
                 name: <value of string>
                 priv-proto: <value in [des, aes]>
                 priv-pwd: <value of string>
                 queries: <value in [disable, enable]>
                 query-port: <value of integer>
                 security-level: <value in [no-auth-no-priv, auth-no-priv, auth-priv]>
           mclag-igmp-snooping-aware: <value in [disable, enable]>
           ip-source-guard:
             -
                 binding-entry:
                   -
                       entry-name: <value of string>
                       ip: <value of string>
                       mac: <value of string>
                 description: <value of string>
                 port: <value of string>
           l3-discovered: <value of integer>
           qos-drop-policy: <value in [taildrop, random-early-detection]>
           qos-red-probability: <value of integer>
           switch-dhcp_opt43_key: <value of string>
           tdr-supported: <value of string>
           custom-command:
             -
                 command-entry: <value of string>
                 command-name: <value of string>
           firmware-provision: <value in [disable, enable]>
           firmware-provision-version: <value of string>
           dhcp-server-access-list: <value in [disable, enable, global]>
           firmware-provision-latest: <value in [disable, once]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
request_url string	The full url requested Returned: always Sample: "/sys/login/user"
response_code integer	The status of api request Returned: always Sample: 0
response_message string	The descriptive message of the api response Returned: always Sample: "OK."

Authors

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

Collection links

Issue Tracker Homepage Repository (Sources)