fortinet.fortimanager.fmgr_firewall_shapingprofile (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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure shaping profiles.
      fortinet.fortimanager.fmgr_firewall_shapingprofile:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_shapingprofile:
          comment: "ansible-comment"
          profile-name: "ansible-test"

Scanned by Steampunk Spotter

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

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the shaping profiles
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_shapingprofile"
          params:
            adom: "ansible"
            shaping-profile: "your_value"

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

firewall_shapingprofile:
    description: The top level parameters set.
    required: false
    suboptions:
      comment:
        description: Comment.
        type: str
      default-class-id:
        description: (int or str) Deprecated, please rename it to default_class_id. Default
          class ID to handle unclassified packets
        type: raw
      profile-name:
        description: Deprecated, please rename it to profile_name. Shaping profile name.
        required: true
        type: str
      shaping-entries:
        description: Deprecated, please rename it to shaping_entries. Shaping-Entries.
        elements: dict
        suboptions:
          burst-in-msec:
            description: Deprecated, please rename it to burst_in_msec. Number of bytes
              that can be burst at maximum-bandwidth speed.
            type: int
          cburst-in-msec:
            description: Deprecated, please rename it to cburst_in_msec. Number of bytes
              that can be burst as fast as the interface can tra...
            type: int
          class-id:
            description: (int or str) Deprecated, please rename it to class_id. Class
              ID.
            type: raw
          guaranteed-bandwidth-percentage:
            description: Deprecated, please rename it to guaranteed_bandwidth_percentage.
              Guaranteed bandwith in percentage.
            type: int
          id:
            description: ID number.
            type: int
          limit:
            description: Hard limit on the real queue size in packets.
            type: int
          max:
            description: Average queue size in packets at which RED drop probability is
              maximal.
            type: int
          maximum-bandwidth-percentage:
            description: Deprecated, please rename it to maximum_bandwidth_percentage.
              Maximum bandwith in percentage.
            type: int
          min:
            description: Average queue size in packets at which RED drop becomes a possibility.
            type: int
          priority:
            choices:
            - low
            - medium
            - high
            - critical
            - top
            description: Priority.
            type: str
          red-probability:
            description: Deprecated, please rename it to red_probability. Maximum probability
            type: int
        type: list
      type:
        choices:
        - policing
        - queuing
        description: Select shaping profile type
        type: str
    type: dict

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

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