drmofu.fortimanager.fmgr_switchcontroller_lldpprofile (2.2.2) — module

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

Description

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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

 - 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
              - power-negotiation
            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>
                  vlan-intf: <value of string>
                  assign-vlan: <value in [disable, enable]>
            med-tlvs:
              - inventory-management
              - network-policy
              - power-management
              - location-identification
            name: <value of string>
            med-location-service:
              -
                  name: <value of string>
                  status: <value in [disable, enable]>
                  sys-location-id: <value of string>
            auto-mclag-icl: <value in [disable, enable]>

Inputs

    
adom:
    description: the parameter (adom) in requested url
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    required: false
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    required: false
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    required: false
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    required: false
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    required: false
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    required: false
    type: bool

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    required: false
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    required: false
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    required: false
    type: int

switchcontroller_lldpprofile:
    description: the top level parameters set
    required: false
    suboptions:
      802.1-tlvs:
        choices:
        - port-vlan-id
        description: Transmitted IEEE 802.
        elements: str
        type: list
      802.3-tlvs:
        choices:
        - max-frame-size
        - power-negotiation
        description: Transmitted IEEE 802.
        elements: str
        type: list
      auto-isl:
        choices:
        - disable
        - enable
        description: Enable/disable auto inter-switch LAG.
        type: str
      auto-isl-hello-timer:
        description: Auto inter-switch LAG hello timer duration
        type: int
      auto-isl-port-group:
        description: Auto inter-switch LAG port group ID
        type: int
      auto-isl-receive-timeout:
        description: Auto inter-switch LAG timeout if no response is received
        type: int
      auto-mclag-icl:
        choices:
        - disable
        - enable
        description: Enable/disable MCLAG inter chassis link.
        type: str
      custom-tlvs:
        description: Custom-Tlvs.
        elements: dict
        suboptions:
          information-string:
            description: Organizationally defined information string
            type: str
          name:
            description: TLV name
            type: str
          oui:
            description: Organizationally unique identifier
            type: str
          subtype:
            description: Organizationally defined subtype
            type: int
        type: list
      med-location-service:
        description: Med-Location-Service.
        elements: dict
        suboptions:
          name:
            description: Location service type name.
            type: str
          status:
            choices:
            - disable
            - enable
            description: Enable or disable this TLV.
            type: str
          sys-location-id:
            description: Location service ID.
            type: str
        type: list
      med-network-policy:
        description: Med-Network-Policy.
        elements: dict
        suboptions:
          assign-vlan:
            choices:
            - disable
            - enable
            description: Enable/disable VLAN assignment when this profile is applied on
              managed FortiSwitch port.
            type: str
          dscp:
            description: Advertised Differentiated Services Code Point
            type: int
          name:
            description: Policy type name.
            type: str
          priority:
            description: Advertised Layer 2 priority
            type: int
          status:
            choices:
            - disable
            - enable
            description: Enable or disable this TLV.
            type: str
          vlan:
            description: ID of VLAN to advertise, if configured on port
            type: int
          vlan-intf:
            description: VLAN interface to advertise; if configured on port.
            type: str
        type: list
      med-tlvs:
        choices:
        - inventory-management
        - network-policy
        - power-management
        - location-identification
        description: Transmitted LLDP-MED TLVs
        elements: str
        type: list
      name:
        description: Profile name.
        type: str
    type: dict

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list