fortinet.fortimanager.fmgr_switchcontroller_lldpprofile – Configure FortiSwitch LLDP profiles.
fortinet.fortimanager.fmgr_switchcontroller_lldpprofile – Configure FortiSwitch LLDP profiles.
Note
This plugin is part of the fortinet.fortimanager collection (version 2.0.1).
To install it use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_switchcontroller_lldpprofile
.
New in version 2.10: of fortinet.fortimanager
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 | Choices/Defaults | 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 | ||
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 | ||
switchcontroller_lldpprofile dictionary |
the top level parameters set | |||
802.1-tlvs list / elements=string |
|
no description | ||
802.3-tlvs list / elements=string |
|
no description | ||
auto-isl string |
|
Enable/disable auto inter-switch LAG. | ||
auto-isl-hello-timer integer |
Auto inter-switch LAG hello timer duration (1 - 30 sec, default = 3). | |||
auto-isl-port-group integer |
Auto inter-switch LAG port group ID (0 - 9). | |||
auto-isl-receive-timeout integer |
Auto inter-switch LAG timeout if no response is received (3 - 90 sec, default = 9). | |||
custom-tlvs list / elements=string |
no description | |||
information-string string |
Organizationally defined information string (0 - 507 hexadecimal bytes). | |||
name string |
TLV name (not sent). | |||
oui string |
Organizationally unique identifier (OUI), a 3-byte hexadecimal number, for this TLV. | |||
subtype integer |
Organizationally defined subtype (0 - 255). | |||
med-network-policy list / elements=string |
no description | |||
dscp integer |
Advertised Differentiated Services Code Point (DSCP) value, a packet header value indicating the level of service requ... | |||
name string |
Policy type name. | |||
priority integer |
Advertised Layer 2 priority (0 - 7; from lowest to highest priority). | |||
status string |
|
Enable or disable this TLV. | ||
vlan integer |
ID of VLAN to advertise, if configured on port (0 - 4094, 0 = priority tag). | |||
med-tlvs list / elements=string |
|
no description | ||
name string |
Profile name. | |||
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 |
Default: 300 |
the maximum time in seconds to wait for other user to release the workspace lock |
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: Configure FortiSwitch LLDP profiles.
fmgr_switchcontroller_lldpprofile:
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_lldpprofile:
802.1-tlvs:
- port-vlan-id
802.3-tlvs:
- max-frame-size
auto-isl: <value in [disable, enable]>
auto-isl-hello-timer: <value of integer>
auto-isl-port-group: <value of integer>
auto-isl-receive-timeout: <value of integer>
custom-tlvs:
-
information-string: <value of string>
name: <value of string>
oui: <value of string>
subtype: <value of integer>
med-network-policy:
-
dscp: <value of integer>
name: <value of string>
priority: <value of integer>
status: <value in [disable, enable]>
vlan: <value of integer>
med-tlvs:
- inventory-management
- network-policy
- power-management
- location-identification
name: <value of string>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
request_url string |
always |
The full url requested
Sample: /sys/login/user |
response_code integer |
always |
The status of api request
|
response_message string |
always |
The descriptive message of the api response
Sample: OK. |
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_switchcontroller_lldpprofile_module.html