fortinet.fortimanager.fmgr_hotspot20_hsprofile (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 hotspot profile.
      fortinet.fortimanager.fmgr_hotspot20_hsprofile:
        # 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]>
        hotspot20_hsprofile:
          3gpp_plmn: <string>
          access_network_asra: <value in [disable, enable]>
          access_network_esr: <value in [disable, enable]>
          access_network_internet: <value in [disable, enable]>
          access_network_type: <value in [private-network, private-network-with-guest-access, chargeable-public-network, ...]>
          access_network_uesa: <value in [disable, enable]>
          anqp_domain_id: <integer>
          bss_transition: <value in [disable, enable]>
          conn_cap: <string>
          deauth_request_timeout: <integer>
          dgaf: <value in [disable, enable]>
          domain_name: <string>
          gas_comeback_delay: <integer>
          gas_fragmentation_limit: <integer>
          hessid: <string>
          ip_addr_type: <string>
          l2tif: <value in [disable, enable]>
          nai_realm: <string>
          name: <string>
          network_auth: <string>
          oper_friendly_name: <string>
          osu_provider: <list or string>
          osu_ssid: <string>
          pame_bi: <value in [disable, enable]>
          proxy_arp: <value in [disable, enable]>
          qos_map: <string>
          roaming_consortium: <string>
          venue_group: <value in [unspecified, assembly, business, ...]>
          venue_name: <string>
          venue_type: <value in [unspecified, arena, stadium, ...]>
          wan_metrics: <string>
          wnm_sleep_mode: <value in [disable, enable]>
          advice_of_charge: <string>
          oper_icon: <string>
          osu_provider_nai: <string>
          release: <integer>
          terms_and_conditions: <string>
          venue_url: <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

hotspot20_hsprofile:
    description: The top level parameters set.
    required: false
    suboptions:
      3gpp-plmn:
        description: Deprecated, please rename it to 3gpp_plmn. 3GPP PLMN name.
        type: str
      access-network-asra:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to access_network_asra. Enable/disable
          additional step required for access
        type: str
      access-network-esr:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to access_network_esr. Enable/disable
          emergency services reachable
        type: str
      access-network-internet:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to access_network_internet. Enable/disable
          connectivity to the Internet.
        type: str
      access-network-type:
        choices:
        - private-network
        - private-network-with-guest-access
        - chargeable-public-network
        - free-public-network
        - personal-device-network
        - emergency-services-only-network
        - test-or-experimental
        - wildcard
        description: Deprecated, please rename it to access_network_type. Access network
          type.
        type: str
      access-network-uesa:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to access_network_uesa. Enable/disable
          unauthenticated emergency service accessible
        type: str
      advice-of-charge:
        description: Deprecated, please rename it to advice_of_charge. Advice of charge.
        type: str
      anqp-domain-id:
        description: Deprecated, please rename it to anqp_domain_id. ANQP Domain ID
        type: int
      bss-transition:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to bss_transition. Enable/disable basic
          service set
        type: str
      conn-cap:
        description: Deprecated, please rename it to conn_cap. Connection capability name.
        type: str
      deauth-request-timeout:
        description: Deprecated, please rename it to deauth_request_timeout. Deauthentication
          request timeout
        type: int
      dgaf:
        choices:
        - disable
        - enable
        description: Enable/disable downstream group-addressed forwarding
        type: str
      domain-name:
        description: Deprecated, please rename it to domain_name. Domain name.
        type: str
      gas-comeback-delay:
        description: Deprecated, please rename it to gas_comeback_delay. GAS comeback
          delay
        type: int
      gas-fragmentation-limit:
        description: Deprecated, please rename it to gas_fragmentation_limit. GAS fragmentation
          limit
        type: int
      hessid:
        description: Homogeneous extended service set identifier
        type: str
      ip-addr-type:
        description: Deprecated, please rename it to ip_addr_type. IP address type name.
        type: str
      l2tif:
        choices:
        - disable
        - enable
        description: Enable/disable Layer 2 traffic inspection and filtering.
        type: str
      nai-realm:
        description: Deprecated, please rename it to nai_realm. NAI realm list name.
        type: str
      name:
        description: Hotspot profile name.
        required: true
        type: str
      network-auth:
        description: Deprecated, please rename it to network_auth. Network authentication
          name.
        type: str
      oper-friendly-name:
        description: Deprecated, please rename it to oper_friendly_name. Operator friendly
          name.
        type: str
      oper-icon:
        description: Deprecated, please rename it to oper_icon. Operator icon.
        type: str
      osu-provider:
        description: (list or str) Deprecated, please rename it to osu_provider. Manually
          selected list of OSU provider
        type: raw
      osu-provider-nai:
        description: Deprecated, please rename it to osu_provider_nai. OSU Provider NAI.
        type: str
      osu-ssid:
        description: Deprecated, please rename it to osu_ssid. Online sign up
        type: str
      pame-bi:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to pame_bi. Enable/disable Pre-Association
          Message Exchange BSSID Independent
        type: str
      proxy-arp:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to proxy_arp. Enable/disable Proxy ARP.
        type: str
      qos-map:
        description: Deprecated, please rename it to qos_map. QoS MAP set ID.
        type: str
      release:
        description: Hotspot 2.
        type: int
      roaming-consortium:
        description: Deprecated, please rename it to roaming_consortium. Roaming consortium
          list name.
        type: str
      terms-and-conditions:
        description: Deprecated, please rename it to terms_and_conditions. Terms and conditions.
        type: str
      venue-group:
        choices:
        - unspecified
        - assembly
        - business
        - educational
        - factory
        - institutional
        - mercantile
        - residential
        - storage
        - utility
        - vehicular
        - outdoor
        description: Deprecated, please rename it to venue_group. Venue group.
        type: str
      venue-name:
        description: Deprecated, please rename it to venue_name. Venue name.
        type: str
      venue-type:
        choices:
        - unspecified
        - arena
        - stadium
        - passenger-terminal
        - amphitheater
        - amusement-park
        - place-of-worship
        - convention-center
        - library
        - museum
        - restaurant
        - theater
        - bar
        - coffee-shop
        - zoo-or-aquarium
        - emergency-center
        - doctor-office
        - bank
        - fire-station
        - police-station
        - post-office
        - professional-office
        - research-facility
        - attorney-office
        - primary-school
        - secondary-school
        - university-or-college
        - factory
        - hospital
        - long-term-care-facility
        - rehab-center
        - group-home
        - prison-or-jail
        - retail-store
        - grocery-market
        - auto-service-station
        - shopping-mall
        - gas-station
        - private
        - hotel-or-motel
        - dormitory
        - boarding-house
        - automobile
        - airplane
        - bus
        - ferry
        - ship-or-boat
        - train
        - motor-bike
        - muni-mesh-network
        - city-park
        - rest-area
        - traffic-control
        - bus-stop
        - kiosk
        description: Deprecated, please rename it to venue_type. Venue type.
        type: str
      venue-url:
        description: Deprecated, please rename it to venue_url. Venue name.
        type: str
      wan-metrics:
        description: Deprecated, please rename it to wan_metrics. WAN metric name.
        type: str
      wnm-sleep-mode:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to wnm_sleep_mode. Enable/disable wireless
          network management
        type: str
    type: dict

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

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