fortinet.fortimanager.fmgr_switchcontroller_lldpprofile (2.4.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

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.

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure FortiSwitch LLDP profiles.
      fortinet.fortimanager.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: present # <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: <integer>
          auto_isl_port_group: <integer>
          auto_isl_receive_timeout: <integer>
          custom_tlvs:
            -
              information_string: <string>
              name: <string>
              oui: <string>
              subtype: <integer>
          med_network_policy:
            -
              dscp: <integer>
              name: <string>
              priority: <integer>
              status: <value in [disable, enable]>
              vlan: <integer>
              vlan_intf: <string>
              assign_vlan: <value in [disable, enable]>
          med_tlvs:
            - inventory-management
            - network-policy
            - power-management
            - location-identification
          name: <string>
          med_location_service:
            -
              name: <string>
              status: <value in [disable, enable]>
              sys_location_id: <string>
          auto_mclag_icl: <value in [disable, enable]>
          auto_isl_auth: <value in [legacy, strict, relax]>
          auto_isl_auth_encrypt: <value in [none, mixed, must]>
          auto_isl_auth_identity: <string>
          auto_isl_auth_macsec_profile: <string>
          auto_isl_auth_reauth: <integer>
          auto_isl_auth_user: <string>

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
    type: list

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

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

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

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    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.
    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.
    type: str

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

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

switchcontroller_lldpprofile:
    description: The top level parameters set.
    required: false
    suboptions:
      802.1-tlvs:
        choices:
        - port-vlan-id
        description: Deprecated, please rename it to 802_1_tlvs. Transmitted IEEE 802.
        elements: str
        type: list
      802.3-tlvs:
        choices:
        - max-frame-size
        - power-negotiation
        description: Deprecated, please rename it to 802_3_tlvs. Transmitted IEEE 802.
        elements: str
        type: list
      auto-isl:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to auto_isl. Enable/disable auto inter-switch
          LAG.
        type: str
      auto-isl-auth:
        choices:
        - legacy
        - strict
        - relax
        description: Deprecated, please rename it to auto_isl_auth. Auto inter-switch
          LAG authentication mode.
        type: str
      auto-isl-auth-encrypt:
        choices:
        - none
        - mixed
        - must
        description: Deprecated, please rename it to auto_isl_auth_encrypt. Auto inter-switch
          LAG encryption mode.
        type: str
      auto-isl-auth-identity:
        description: Deprecated, please rename it to auto_isl_auth_identity. Auto inter-switch
          LAG authentication identity.
        type: str
      auto-isl-auth-macsec-profile:
        description: Deprecated, please rename it to auto_isl_auth_macsec_profile. Auto
          inter-switch LAG macsec profile for encryption.
        type: str
      auto-isl-auth-reauth:
        description: Deprecated, please rename it to auto_isl_auth_reauth. Auto inter-switch
          LAG authentication reauth period in seconds
        type: int
      auto-isl-auth-user:
        description: Deprecated, please rename it to auto_isl_auth_user. Auto inter-switch
          LAG authentication user certificate.
        type: str
      auto-isl-hello-timer:
        description: Deprecated, please rename it to auto_isl_hello_timer. Auto inter-switch
          LAG hello timer duration
        type: int
      auto-isl-port-group:
        description: Deprecated, please rename it to auto_isl_port_group. Auto inter-switch
          LAG port group ID
        type: int
      auto-isl-receive-timeout:
        description: Deprecated, please rename it to auto_isl_receive_timeout. Auto inter-switch
          LAG timeout if no response is received
        type: int
      auto-mclag-icl:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to auto_mclag_icl. Enable/disable MCLAG
          inter chassis link.
        type: str
      custom-tlvs:
        description: Deprecated, please rename it to custom_tlvs. Custom-Tlvs.
        elements: dict
        suboptions:
          information-string:
            description: Deprecated, please rename it to information_string. 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: Deprecated, please rename it to med_location_service. 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: Deprecated, please rename it to sys_location_id. Location service
              ID.
            type: str
        type: list
      med-network-policy:
        description: Deprecated, please rename it to med_network_policy. Med-Network-Policy.
        elements: dict
        suboptions:
          assign-vlan:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to assign_vlan. Enable/disable VLAN
              assignment when this profile is applied on manage...
            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: Deprecated, please rename it to vlan_intf. VLAN interface to
              advertise; if configured on port.
            type: str
        type: list
      med-tlvs:
        choices:
        - inventory-management
        - network-policy
        - power-management
        - location-identification
        description: Deprecated, please rename it to med_tlvs. Transmitted LLDP-MED TLVs
        elements: str
        type: list
      name:
        description: Profile name.
        required: true
        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