drmofu.fortimanager.fmgr_switchcontroller_dsl_policy (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: DSL policy.
      fmgr_switchcontroller_dsl_policy:
         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_dsl_policy:
            append_padding: <value in [disable, enable]>
            cpe-aele: <value in [disable, enable]>
            cpe-aele-mode: <value in [ELE_M0, ELE_DS, ELE_PB, ...]>
            cs:
              - A43
              - B43
              - A43C
              - V43
            ds-bitswap: <value in [disable, enable]>
            name: <value of string>
            pause-frame: <value in [disable, enable]>
            profile: <value in [auto-30a, auto-17a, auto-12ab]>
            type: <value in [Procend, Proscend]>
            us-bitswap: <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_dsl_policy:
    description: the top level parameters set
    required: false
    suboptions:
      append_padding:
        choices:
        - disable
        - enable
        description: device pause frame configuration.
        type: str
      cpe-aele:
        choices:
        - disable
        - enable
        description: cpe AELE.
        type: str
      cpe-aele-mode:
        choices:
        - ELE_M0
        - ELE_DS
        - ELE_PB
        - ELE_MIN
        description: cpe AELE-Mode with given string.
        type: str
      cs:
        choices:
        - A43
        - B43
        - A43C
        - V43
        description: description
        elements: str
        type: list
      ds-bitswap:
        choices:
        - disable
        - enable
        description: Enable/disable bitswap.
        type: str
      name:
        description: Policy name.
        type: str
      pause-frame:
        choices:
        - disable
        - enable
        description: device pause frame configuration.
        type: str
      profile:
        choices:
        - auto-30a
        - auto-17a
        - auto-12ab
        description: vdsl CPE profile.
        type: str
      type:
        choices:
        - Procend
        - Proscend
        description: Type.
        type: str
      us-bitswap:
        choices:
        - disable
        - enable
        description: Enable/disable bitswap.
        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